google-api-client-0.19.8/0000755000004100000410000000000013252673044015146 5ustar www-datawww-datagoogle-api-client-0.19.8/Rakefile0000644000004100000410000000006113252673043016607 0ustar www-datawww-datarequire "bundler/gem_tasks" task default: :spec google-api-client-0.19.8/bin/0000755000004100000410000000000013252673043015715 5ustar www-datawww-datagoogle-api-client-0.19.8/bin/generate-api0000755000004100000410000000764213252673043020215 0ustar www-datawww-data#!/usr/bin/env ruby begin require 'thor' rescue LoadError => e puts "Thor is required. Please install the gem with development dependencies." exit 1 end require 'open-uri' require 'google/apis/discovery_v1' require 'logger' module Google class ApiGenerator < Thor def self.exit_on_failure? true end include Thor::Actions Google::Apis::ClientOptions.default.application_name = "generate-api" Google::Apis::ClientOptions.default.application_version = Google::Apis::VERSION Discovery = Google::Apis::DiscoveryV1 desc 'gen OUTDIR', 'Generate ruby API from an API description' method_options url: :array, file: :array, from_discovery: :boolean, preferred_only: :boolean, verbose: :boolean, names: :string, names_out: :string def gen(dir) ensure_active_support require 'google/apis/generator' self.destination_root = dir Google::Apis.logger.level = Logger::DEBUG if options[:verbose] generate_from_url(options[:url]) if options[:url] generate_from_file(options[:file]) if options[:file] generate_from_discovery(preferred_only: options[:preferred_only]) if options[:from_discovery] create_file(options[:names_out]) { |*| generator.dump_api_names } if options[:names_out] end desc 'list', 'List public APIs' method_options verbose: :boolean, preferred_only: :boolean def list Google::Apis.logger.level = Logger::DEBUG if options[:verbose] discovery = Discovery::DiscoveryService.new apis = discovery.list_apis apis.items.each do |api| say sprintf('%s - %s', api.id, api.description).strip unless options[:preferred_only] && !api.preferred? end end no_commands do def generate_from_url(urls) Array(urls).each do |url| begin json = discovery.http(:get, url) rescue Google::Apis::ClientError warn sprintf('Failed request, skipping %s', url) next end generate_api(json) end end def generate_from_file(files) Array(files).each do |file| File.open(file) do |f| generate_api(f.read) end end end def generate_from_discovery(preferred_only: false) say 'Fetching API list' apis = discovery.list_apis apis.items.each do |api| if (preferred_only && !api.preferred?) say sprintf('Ignoring disoverable API %s', api.id) else # The Discovery service may returned cached versions of a Discovery document that are # not the most recent revision. That means that subsequent requests to the same # Discovery document URL can return different documents. The # `discovery-artifact-manager` repo always holds the most recent revision, so it's # easier to use that document than to force revision checking against the URL returned # by the Discovery index. discovery_rest_url = "https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/#{api.name}.#{api.version}.json" say sprintf('Loading %s, version %s from %s', api.name, api.version, discovery_rest_url) generate_from_url(discovery_rest_url) end end end def generate_api(json) files = generator.render(json) files.each do |file, content| create_file(file) { |*| content } end end def discovery @discovery ||= Discovery::DiscoveryService.new end def generator @generator ||= Google::Apis::Generator.new(api_names: options[:names]) end def ensure_active_support begin require 'active_support/inflector' rescue LoadError => e error 'ActiveSupport is required, please run:' error 'gem install activesupport' exit 1 end end end end end Google::ApiGenerator.start(ARGV) google-api-client-0.19.8/Gemfile0000644000004100000410000000200713252673043016437 0ustar www-datawww-datasource 'https://rubygems.org' # Specify your gem's dependencies in google-apis.gemspec gemspec group :development do gem 'bundler', '~> 1.7' gem 'rake', '~> 11.2' gem 'rspec', '~> 3.1' gem 'json_spec', '~> 1.1' gem 'webmock', '~> 2.1' gem 'simplecov', '~> 0.12' gem 'coveralls', '~> 0.8' gem 'rubocop', '~> 0.42.0' gem 'launchy', '~> 2.4' gem 'dotenv', '~> 2.0' gem 'fakefs', '~> 0.6', require: "fakefs/safe" gem 'google-id-token', '~> 1.3' gem 'os', '~> 0.9' gem 'rmail', '~> 1.1' gem 'redis', '~> 3.2' end platforms :jruby do group :development do gem 'jruby-openssl' end end platforms :ruby do group :development do gem 'yard', '~> 0.8' gem 'redcarpet', '~> 3.2' gem 'github-markup', '~> 1.3' gem 'pry-doc', '~> 0.8' gem 'pry-byebug', '~> 3.2' end end platforms :mri_21, :mri_22, :mri_23 do group :development do gem 'derailed_benchmarks' gem 'stackprof' gem 'rack-test' end end if ENV['RAILS_VERSION'] gem 'rails', ENV['RAILS_VERSION'] end google-api-client-0.19.8/.rubocop_todo.yml0000644000004100000410000000267213252673043020453 0ustar www-datawww-data# This configuration was generated by `rubocop --auto-gen-config` # on 2015-03-25 23:30:36 -0700 using RuboCop version 0.29.1. # The point is for the user to remove these configuration records # one by one as the offenses are removed from the code base. # Note that changes in the inspected code, or installation of new # versions of RuboCop, may require this file to be generated again. # Offense count: 19 Metrics/AbcSize: Max: 79 # Offense count: 2 # Configuration parameters: CountComments. Metrics/ClassLength: Max: 220 # Offense count: 5 Metrics/CyclomaticComplexity: Max: 10 # Offense count: 99 # Configuration parameters: AllowURI, URISchemes. Metrics/LineLength: Max: 127 # Offense count: 18 # Configuration parameters: CountComments. Metrics/MethodLength: Max: 43 # Offense count: 1 # Configuration parameters: CountKeywordArgs. Metrics/ParameterLists: Max: 6 # Offense count: 4 Metrics/PerceivedComplexity: Max: 11 # Offense count: 14 Style/Documentation: Enabled: false # Offense count: 1 # Cop supports --auto-correct. Style/EmptyLines: Enabled: false # Offense count: 3 # Cop supports --auto-correct. # Configuration parameters: EnforcedStyle, SupportedStyles. Style/EmptyLinesAroundClassBody: Enabled: false # Offense count: 2 # Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles. Style/Next: Enabled: false # Offense count: 3 # Cop supports --auto-correct. Style/RedundantSelf: Enabled: false google-api-client-0.19.8/.rspec0000644000004100000410000000003713252673043016262 0ustar www-datawww-data--color --format documentation google-api-client-0.19.8/generated/0000755000004100000410000000000013252673043017103 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/0000755000004100000410000000000013252673043020357 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/0000755000004100000410000000000013252673044021314 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/safebrowsing_v4/0000755000004100000410000000000013252673044024416 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/safebrowsing_v4/representations.rb0000644000004100000410000004140213252673044030171 0ustar www-datawww-data# 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 SafebrowsingV4 class Checksum class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClientInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Constraints 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 FetchThreatListUpdatesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FetchThreatListUpdatesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FindFullHashesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FindFullHashesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FindThreatMatchesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FindThreatMatchesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListThreatListsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListUpdateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListUpdateResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetadataEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RawHashes class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RawIndices class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RiceDeltaEncoding class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThreatEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThreatEntryMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThreatEntrySet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThreatHit class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThreatInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThreatListDescriptor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThreatMatch class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThreatSource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Checksum # @private class Representation < Google::Apis::Core::JsonRepresentation property :sha256, :base64 => true, as: 'sha256' end end class ClientInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_id, as: 'clientId' property :client_version, as: 'clientVersion' end end class Constraints # @private class Representation < Google::Apis::Core::JsonRepresentation property :device_location, as: 'deviceLocation' property :language, as: 'language' property :max_database_entries, as: 'maxDatabaseEntries' property :max_update_entries, as: 'maxUpdateEntries' property :region, as: 'region' collection :supported_compressions, as: 'supportedCompressions' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class FetchThreatListUpdatesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :client, as: 'client', class: Google::Apis::SafebrowsingV4::ClientInfo, decorator: Google::Apis::SafebrowsingV4::ClientInfo::Representation collection :list_update_requests, as: 'listUpdateRequests', class: Google::Apis::SafebrowsingV4::ListUpdateRequest, decorator: Google::Apis::SafebrowsingV4::ListUpdateRequest::Representation end end class FetchThreatListUpdatesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :list_update_responses, as: 'listUpdateResponses', class: Google::Apis::SafebrowsingV4::ListUpdateResponse, decorator: Google::Apis::SafebrowsingV4::ListUpdateResponse::Representation property :minimum_wait_duration, as: 'minimumWaitDuration' end end class FindFullHashesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_client, as: 'apiClient', class: Google::Apis::SafebrowsingV4::ClientInfo, decorator: Google::Apis::SafebrowsingV4::ClientInfo::Representation property :client, as: 'client', class: Google::Apis::SafebrowsingV4::ClientInfo, decorator: Google::Apis::SafebrowsingV4::ClientInfo::Representation collection :client_states, as: 'clientStates' property :threat_info, as: 'threatInfo', class: Google::Apis::SafebrowsingV4::ThreatInfo, decorator: Google::Apis::SafebrowsingV4::ThreatInfo::Representation end end class FindFullHashesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :matches, as: 'matches', class: Google::Apis::SafebrowsingV4::ThreatMatch, decorator: Google::Apis::SafebrowsingV4::ThreatMatch::Representation property :minimum_wait_duration, as: 'minimumWaitDuration' property :negative_cache_duration, as: 'negativeCacheDuration' end end class FindThreatMatchesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :client, as: 'client', class: Google::Apis::SafebrowsingV4::ClientInfo, decorator: Google::Apis::SafebrowsingV4::ClientInfo::Representation property :threat_info, as: 'threatInfo', class: Google::Apis::SafebrowsingV4::ThreatInfo, decorator: Google::Apis::SafebrowsingV4::ThreatInfo::Representation end end class FindThreatMatchesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :matches, as: 'matches', class: Google::Apis::SafebrowsingV4::ThreatMatch, decorator: Google::Apis::SafebrowsingV4::ThreatMatch::Representation end end class ListThreatListsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :threat_lists, as: 'threatLists', class: Google::Apis::SafebrowsingV4::ThreatListDescriptor, decorator: Google::Apis::SafebrowsingV4::ThreatListDescriptor::Representation end end class ListUpdateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :constraints, as: 'constraints', class: Google::Apis::SafebrowsingV4::Constraints, decorator: Google::Apis::SafebrowsingV4::Constraints::Representation property :platform_type, as: 'platformType' property :state, :base64 => true, as: 'state' property :threat_entry_type, as: 'threatEntryType' property :threat_type, as: 'threatType' end end class ListUpdateResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :additions, as: 'additions', class: Google::Apis::SafebrowsingV4::ThreatEntrySet, decorator: Google::Apis::SafebrowsingV4::ThreatEntrySet::Representation property :checksum, as: 'checksum', class: Google::Apis::SafebrowsingV4::Checksum, decorator: Google::Apis::SafebrowsingV4::Checksum::Representation property :new_client_state, :base64 => true, as: 'newClientState' property :platform_type, as: 'platformType' collection :removals, as: 'removals', class: Google::Apis::SafebrowsingV4::ThreatEntrySet, decorator: Google::Apis::SafebrowsingV4::ThreatEntrySet::Representation property :response_type, as: 'responseType' property :threat_entry_type, as: 'threatEntryType' property :threat_type, as: 'threatType' end end class MetadataEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, :base64 => true, as: 'key' property :value, :base64 => true, as: 'value' end end class RawHashes # @private class Representation < Google::Apis::Core::JsonRepresentation property :prefix_size, as: 'prefixSize' property :raw_hashes, :base64 => true, as: 'rawHashes' end end class RawIndices # @private class Representation < Google::Apis::Core::JsonRepresentation collection :indices, as: 'indices' end end class RiceDeltaEncoding # @private class Representation < Google::Apis::Core::JsonRepresentation property :encoded_data, :base64 => true, as: 'encodedData' property :first_value, :numeric_string => true, as: 'firstValue' property :num_entries, as: 'numEntries' property :rice_parameter, as: 'riceParameter' end end class ThreatEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :digest, :base64 => true, as: 'digest' property :hash_prop, :base64 => true, as: 'hash' property :url, as: 'url' end end class ThreatEntryMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::SafebrowsingV4::MetadataEntry, decorator: Google::Apis::SafebrowsingV4::MetadataEntry::Representation end end class ThreatEntrySet # @private class Representation < Google::Apis::Core::JsonRepresentation property :compression_type, as: 'compressionType' property :raw_hashes, as: 'rawHashes', class: Google::Apis::SafebrowsingV4::RawHashes, decorator: Google::Apis::SafebrowsingV4::RawHashes::Representation property :raw_indices, as: 'rawIndices', class: Google::Apis::SafebrowsingV4::RawIndices, decorator: Google::Apis::SafebrowsingV4::RawIndices::Representation property :rice_hashes, as: 'riceHashes', class: Google::Apis::SafebrowsingV4::RiceDeltaEncoding, decorator: Google::Apis::SafebrowsingV4::RiceDeltaEncoding::Representation property :rice_indices, as: 'riceIndices', class: Google::Apis::SafebrowsingV4::RiceDeltaEncoding, decorator: Google::Apis::SafebrowsingV4::RiceDeltaEncoding::Representation end end class ThreatHit # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_info, as: 'clientInfo', class: Google::Apis::SafebrowsingV4::ClientInfo, decorator: Google::Apis::SafebrowsingV4::ClientInfo::Representation property :entry, as: 'entry', class: Google::Apis::SafebrowsingV4::ThreatEntry, decorator: Google::Apis::SafebrowsingV4::ThreatEntry::Representation property :platform_type, as: 'platformType' collection :resources, as: 'resources', class: Google::Apis::SafebrowsingV4::ThreatSource, decorator: Google::Apis::SafebrowsingV4::ThreatSource::Representation property :threat_type, as: 'threatType' property :user_info, as: 'userInfo', class: Google::Apis::SafebrowsingV4::UserInfo, decorator: Google::Apis::SafebrowsingV4::UserInfo::Representation end end class ThreatInfo # @private class Representation < Google::Apis::Core::JsonRepresentation collection :platform_types, as: 'platformTypes' collection :threat_entries, as: 'threatEntries', class: Google::Apis::SafebrowsingV4::ThreatEntry, decorator: Google::Apis::SafebrowsingV4::ThreatEntry::Representation collection :threat_entry_types, as: 'threatEntryTypes' collection :threat_types, as: 'threatTypes' end end class ThreatListDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation property :platform_type, as: 'platformType' property :threat_entry_type, as: 'threatEntryType' property :threat_type, as: 'threatType' end end class ThreatMatch # @private class Representation < Google::Apis::Core::JsonRepresentation property :cache_duration, as: 'cacheDuration' property :platform_type, as: 'platformType' property :threat, as: 'threat', class: Google::Apis::SafebrowsingV4::ThreatEntry, decorator: Google::Apis::SafebrowsingV4::ThreatEntry::Representation property :threat_entry_metadata, as: 'threatEntryMetadata', class: Google::Apis::SafebrowsingV4::ThreatEntryMetadata, decorator: Google::Apis::SafebrowsingV4::ThreatEntryMetadata::Representation property :threat_entry_type, as: 'threatEntryType' property :threat_type, as: 'threatType' end end class ThreatSource # @private class Representation < Google::Apis::Core::JsonRepresentation property :referrer, as: 'referrer' property :remote_ip, as: 'remoteIp' property :type, as: 'type' property :url, as: 'url' end end class UserInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :region_code, as: 'regionCode' property :user_id, :base64 => true, as: 'userId' end end end end end google-api-client-0.19.8/generated/google/apis/safebrowsing_v4/classes.rb0000644000004100000410000010555413252673044026412 0ustar www-datawww-data# 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 SafebrowsingV4 # The expected state of a client's local database. class Checksum include Google::Apis::Core::Hashable # The SHA256 hash of the client state; that is, of the sorted list of all # hashes present in the database. # Corresponds to the JSON property `sha256` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @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 # The client metadata associated with Safe Browsing API requests. class ClientInfo include Google::Apis::Core::Hashable # A client ID that (hopefully) uniquely identifies the client implementation # of the Safe Browsing API. # Corresponds to the JSON property `clientId` # @return [String] attr_accessor :client_id # The version of the client implementation. # Corresponds to the JSON property `clientVersion` # @return [String] attr_accessor :client_version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_id = args[:client_id] if args.key?(:client_id) @client_version = args[:client_version] if args.key?(:client_version) end end # The constraints for this update. class Constraints include Google::Apis::Core::Hashable # A client's physical location, expressed as a ISO 31166-1 alpha-2 # region code. # Corresponds to the JSON property `deviceLocation` # @return [String] attr_accessor :device_location # Requests the lists for a specific language. Expects ISO 639 alpha-2 # format. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # Sets the maximum number of entries that the client is willing to have # in the local database. This should be a power of 2 between 2**10 and # 2**20. If zero, no database size limit is set. # Corresponds to the JSON property `maxDatabaseEntries` # @return [Fixnum] attr_accessor :max_database_entries # The maximum size in number of entries. The update will not contain more # entries than this value. This should be a power of 2 between 2**10 and # 2**20. If zero, no update size limit is set. # Corresponds to the JSON property `maxUpdateEntries` # @return [Fixnum] attr_accessor :max_update_entries # Requests the list for a specific geographic location. If not set the # server may pick that value based on the user's IP address. Expects ISO # 3166-1 alpha-2 format. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # The compression types supported by the client. # Corresponds to the JSON property `supportedCompressions` # @return [Array] attr_accessor :supported_compressions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @device_location = args[:device_location] if args.key?(:device_location) @language = args[:language] if args.key?(:language) @max_database_entries = args[:max_database_entries] if args.key?(:max_database_entries) @max_update_entries = args[:max_update_entries] if args.key?(:max_update_entries) @region = args[:region] if args.key?(:region) @supported_compressions = args[:supported_compressions] if args.key?(:supported_compressions) 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 # Describes a Safe Browsing API update request. Clients can request updates for # multiple lists in a single request. # NOTE: Field index 2 is unused. # NEXT: 5 class FetchThreatListUpdatesRequest include Google::Apis::Core::Hashable # The client metadata associated with Safe Browsing API requests. # Corresponds to the JSON property `client` # @return [Google::Apis::SafebrowsingV4::ClientInfo] attr_accessor :client # The requested threat list updates. # Corresponds to the JSON property `listUpdateRequests` # @return [Array] attr_accessor :list_update_requests def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client = args[:client] if args.key?(:client) @list_update_requests = args[:list_update_requests] if args.key?(:list_update_requests) end end # class FetchThreatListUpdatesResponse include Google::Apis::Core::Hashable # The list updates requested by the clients. # Corresponds to the JSON property `listUpdateResponses` # @return [Array] attr_accessor :list_update_responses # The minimum duration the client must wait before issuing any update # request. If this field is not set clients may update as soon as they want. # Corresponds to the JSON property `minimumWaitDuration` # @return [String] attr_accessor :minimum_wait_duration def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @list_update_responses = args[:list_update_responses] if args.key?(:list_update_responses) @minimum_wait_duration = args[:minimum_wait_duration] if args.key?(:minimum_wait_duration) end end # Request to return full hashes matched by the provided hash prefixes. class FindFullHashesRequest include Google::Apis::Core::Hashable # The client metadata associated with Safe Browsing API requests. # Corresponds to the JSON property `apiClient` # @return [Google::Apis::SafebrowsingV4::ClientInfo] attr_accessor :api_client # The client metadata associated with Safe Browsing API requests. # Corresponds to the JSON property `client` # @return [Google::Apis::SafebrowsingV4::ClientInfo] attr_accessor :client # The current client states for each of the client's local threat lists. # Corresponds to the JSON property `clientStates` # @return [Array] attr_accessor :client_states # The information regarding one or more threats that a client submits when # checking for matches in threat lists. # Corresponds to the JSON property `threatInfo` # @return [Google::Apis::SafebrowsingV4::ThreatInfo] attr_accessor :threat_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @api_client = args[:api_client] if args.key?(:api_client) @client = args[:client] if args.key?(:client) @client_states = args[:client_states] if args.key?(:client_states) @threat_info = args[:threat_info] if args.key?(:threat_info) end end # class FindFullHashesResponse include Google::Apis::Core::Hashable # The full hashes that matched the requested prefixes. # Corresponds to the JSON property `matches` # @return [Array] attr_accessor :matches # The minimum duration the client must wait before issuing any find hashes # request. If this field is not set, clients can issue a request as soon as # they want. # Corresponds to the JSON property `minimumWaitDuration` # @return [String] attr_accessor :minimum_wait_duration # For requested entities that did not match the threat list, how long to # cache the response. # Corresponds to the JSON property `negativeCacheDuration` # @return [String] attr_accessor :negative_cache_duration def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @matches = args[:matches] if args.key?(:matches) @minimum_wait_duration = args[:minimum_wait_duration] if args.key?(:minimum_wait_duration) @negative_cache_duration = args[:negative_cache_duration] if args.key?(:negative_cache_duration) end end # Request to check entries against lists. class FindThreatMatchesRequest include Google::Apis::Core::Hashable # The client metadata associated with Safe Browsing API requests. # Corresponds to the JSON property `client` # @return [Google::Apis::SafebrowsingV4::ClientInfo] attr_accessor :client # The information regarding one or more threats that a client submits when # checking for matches in threat lists. # Corresponds to the JSON property `threatInfo` # @return [Google::Apis::SafebrowsingV4::ThreatInfo] attr_accessor :threat_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client = args[:client] if args.key?(:client) @threat_info = args[:threat_info] if args.key?(:threat_info) end end # class FindThreatMatchesResponse include Google::Apis::Core::Hashable # The threat list matches. # Corresponds to the JSON property `matches` # @return [Array] attr_accessor :matches def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @matches = args[:matches] if args.key?(:matches) end end # class ListThreatListsResponse include Google::Apis::Core::Hashable # The lists available for download by the client. # Corresponds to the JSON property `threatLists` # @return [Array] attr_accessor :threat_lists def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @threat_lists = args[:threat_lists] if args.key?(:threat_lists) end end # A single list update request. class ListUpdateRequest include Google::Apis::Core::Hashable # The constraints for this update. # Corresponds to the JSON property `constraints` # @return [Google::Apis::SafebrowsingV4::Constraints] attr_accessor :constraints # The type of platform at risk by entries present in the list. # Corresponds to the JSON property `platformType` # @return [String] attr_accessor :platform_type # The current state of the client for the requested list (the encrypted # client state that was received from the last successful list update). # Corresponds to the JSON property `state` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :state # The types of entries present in the list. # Corresponds to the JSON property `threatEntryType` # @return [String] attr_accessor :threat_entry_type # The type of threat posed by entries present in the list. # Corresponds to the JSON property `threatType` # @return [String] attr_accessor :threat_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @constraints = args[:constraints] if args.key?(:constraints) @platform_type = args[:platform_type] if args.key?(:platform_type) @state = args[:state] if args.key?(:state) @threat_entry_type = args[:threat_entry_type] if args.key?(:threat_entry_type) @threat_type = args[:threat_type] if args.key?(:threat_type) end end # An update to an individual list. class ListUpdateResponse include Google::Apis::Core::Hashable # A set of entries to add to a local threat type's list. Repeated to allow # for a combination of compressed and raw data to be sent in a single # response. # Corresponds to the JSON property `additions` # @return [Array] attr_accessor :additions # The expected state of a client's local database. # Corresponds to the JSON property `checksum` # @return [Google::Apis::SafebrowsingV4::Checksum] attr_accessor :checksum # The new client state, in encrypted format. Opaque to clients. # Corresponds to the JSON property `newClientState` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :new_client_state # The platform type for which data is returned. # Corresponds to the JSON property `platformType` # @return [String] attr_accessor :platform_type # A set of entries to remove from a local threat type's list. In practice, # this field is empty or contains exactly one ThreatEntrySet. # Corresponds to the JSON property `removals` # @return [Array] attr_accessor :removals # The type of response. This may indicate that an action is required by the # client when the response is received. # Corresponds to the JSON property `responseType` # @return [String] attr_accessor :response_type # The format of the threats. # Corresponds to the JSON property `threatEntryType` # @return [String] attr_accessor :threat_entry_type # The threat type for which data is returned. # Corresponds to the JSON property `threatType` # @return [String] attr_accessor :threat_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @additions = args[:additions] if args.key?(:additions) @checksum = args[:checksum] if args.key?(:checksum) @new_client_state = args[:new_client_state] if args.key?(:new_client_state) @platform_type = args[:platform_type] if args.key?(:platform_type) @removals = args[:removals] if args.key?(:removals) @response_type = args[:response_type] if args.key?(:response_type) @threat_entry_type = args[:threat_entry_type] if args.key?(:threat_entry_type) @threat_type = args[:threat_type] if args.key?(:threat_type) end end # A single metadata entry. class MetadataEntry include Google::Apis::Core::Hashable # The metadata entry key. For JSON requests, the key is base64-encoded. # Corresponds to the JSON property `key` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :key # The metadata entry value. For JSON requests, the value is base64-encoded. # Corresponds to the JSON property `value` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @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 # The uncompressed threat entries in hash format of a particular prefix length. # Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 # bytes, but some hashes are lengthened if they collide with the hash of a # popular URL. # Used for sending ThreatEntrySet to clients that do not support compression, # or when sending non-4-byte hashes to clients that do support compression. class RawHashes include Google::Apis::Core::Hashable # The number of bytes for each prefix encoded below. This field can be # anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). # Corresponds to the JSON property `prefixSize` # @return [Fixnum] attr_accessor :prefix_size # The hashes, in binary format, concatenated into one long string. Hashes are # sorted in lexicographic order. For JSON API users, hashes are # base64-encoded. # Corresponds to the JSON property `rawHashes` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :raw_hashes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @prefix_size = args[:prefix_size] if args.key?(:prefix_size) @raw_hashes = args[:raw_hashes] if args.key?(:raw_hashes) end end # A set of raw indices to remove from a local list. class RawIndices include Google::Apis::Core::Hashable # The indices to remove from a lexicographically-sorted local list. # Corresponds to the JSON property `indices` # @return [Array] attr_accessor :indices def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @indices = args[:indices] if args.key?(:indices) end end # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # compressed removal indices. class RiceDeltaEncoding include Google::Apis::Core::Hashable # The encoded deltas that are encoded using the Golomb-Rice coder. # Corresponds to the JSON property `encodedData` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :encoded_data # The offset of the first entry in the encoded data, or, if only a single # integer was encoded, that single integer's value. If the field is empty or # missing, assume zero. # Corresponds to the JSON property `firstValue` # @return [Fixnum] attr_accessor :first_value # The number of entries that are delta encoded in the encoded data. If only a # single integer was encoded, this will be zero and the single value will be # stored in `first_value`. # Corresponds to the JSON property `numEntries` # @return [Fixnum] attr_accessor :num_entries # The Golomb-Rice parameter, which is a number between 2 and 28. This field # is missing (that is, zero) if `num_entries` is zero. # Corresponds to the JSON property `riceParameter` # @return [Fixnum] attr_accessor :rice_parameter def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @encoded_data = args[:encoded_data] if args.key?(:encoded_data) @first_value = args[:first_value] if args.key?(:first_value) @num_entries = args[:num_entries] if args.key?(:num_entries) @rice_parameter = args[:rice_parameter] if args.key?(:rice_parameter) end end # An individual threat; for example, a malicious URL or its hash # representation. Only one of these fields should be set. class ThreatEntry include Google::Apis::Core::Hashable # The digest of an executable in SHA256 format. The API supports both # binary and hex digests. For JSON requests, digests are base64-encoded. # Corresponds to the JSON property `digest` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :digest # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 # hash. This field is in binary format. For JSON requests, hashes are # base64-encoded. # Corresponds to the JSON property `hash` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :hash_prop # A URL. # 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) @digest = args[:digest] if args.key?(:digest) @hash_prop = args[:hash_prop] if args.key?(:hash_prop) @url = args[:url] if args.key?(:url) end end # The metadata associated with a specific threat entry. The client is expected # to know the metadata key/value pairs associated with each threat type. class ThreatEntryMetadata include Google::Apis::Core::Hashable # The metadata entries. # 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) @entries = args[:entries] if args.key?(:entries) end end # A set of threats that should be added or removed from a client's local # database. class ThreatEntrySet include Google::Apis::Core::Hashable # The compression type for the entries in this set. # Corresponds to the JSON property `compressionType` # @return [String] attr_accessor :compression_type # The uncompressed threat entries in hash format of a particular prefix length. # Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 # bytes, but some hashes are lengthened if they collide with the hash of a # popular URL. # Used for sending ThreatEntrySet to clients that do not support compression, # or when sending non-4-byte hashes to clients that do support compression. # Corresponds to the JSON property `rawHashes` # @return [Google::Apis::SafebrowsingV4::RawHashes] attr_accessor :raw_hashes # A set of raw indices to remove from a local list. # Corresponds to the JSON property `rawIndices` # @return [Google::Apis::SafebrowsingV4::RawIndices] attr_accessor :raw_indices # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # compressed removal indices. # Corresponds to the JSON property `riceHashes` # @return [Google::Apis::SafebrowsingV4::RiceDeltaEncoding] attr_accessor :rice_hashes # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # compressed removal indices. # Corresponds to the JSON property `riceIndices` # @return [Google::Apis::SafebrowsingV4::RiceDeltaEncoding] attr_accessor :rice_indices def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @compression_type = args[:compression_type] if args.key?(:compression_type) @raw_hashes = args[:raw_hashes] if args.key?(:raw_hashes) @raw_indices = args[:raw_indices] if args.key?(:raw_indices) @rice_hashes = args[:rice_hashes] if args.key?(:rice_hashes) @rice_indices = args[:rice_indices] if args.key?(:rice_indices) end end # class ThreatHit include Google::Apis::Core::Hashable # The client metadata associated with Safe Browsing API requests. # Corresponds to the JSON property `clientInfo` # @return [Google::Apis::SafebrowsingV4::ClientInfo] attr_accessor :client_info # An individual threat; for example, a malicious URL or its hash # representation. Only one of these fields should be set. # Corresponds to the JSON property `entry` # @return [Google::Apis::SafebrowsingV4::ThreatEntry] attr_accessor :entry # The platform type reported. # Corresponds to the JSON property `platformType` # @return [String] attr_accessor :platform_type # The resources related to the threat hit. # Corresponds to the JSON property `resources` # @return [Array] attr_accessor :resources # The threat type reported. # Corresponds to the JSON property `threatType` # @return [String] attr_accessor :threat_type # Details about the user that encountered the threat. # Corresponds to the JSON property `userInfo` # @return [Google::Apis::SafebrowsingV4::UserInfo] attr_accessor :user_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_info = args[:client_info] if args.key?(:client_info) @entry = args[:entry] if args.key?(:entry) @platform_type = args[:platform_type] if args.key?(:platform_type) @resources = args[:resources] if args.key?(:resources) @threat_type = args[:threat_type] if args.key?(:threat_type) @user_info = args[:user_info] if args.key?(:user_info) end end # The information regarding one or more threats that a client submits when # checking for matches in threat lists. class ThreatInfo include Google::Apis::Core::Hashable # The platform types to be checked. # Corresponds to the JSON property `platformTypes` # @return [Array] attr_accessor :platform_types # The threat entries to be checked. # Corresponds to the JSON property `threatEntries` # @return [Array] attr_accessor :threat_entries # The entry types to be checked. # Corresponds to the JSON property `threatEntryTypes` # @return [Array] attr_accessor :threat_entry_types # The threat types to be checked. # Corresponds to the JSON property `threatTypes` # @return [Array] attr_accessor :threat_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @platform_types = args[:platform_types] if args.key?(:platform_types) @threat_entries = args[:threat_entries] if args.key?(:threat_entries) @threat_entry_types = args[:threat_entry_types] if args.key?(:threat_entry_types) @threat_types = args[:threat_types] if args.key?(:threat_types) end end # Describes an individual threat list. A list is defined by three parameters: # the type of threat posed, the type of platform targeted by the threat, and # the type of entries in the list. class ThreatListDescriptor include Google::Apis::Core::Hashable # The platform type targeted by the list's entries. # Corresponds to the JSON property `platformType` # @return [String] attr_accessor :platform_type # The entry types contained in the list. # Corresponds to the JSON property `threatEntryType` # @return [String] attr_accessor :threat_entry_type # The threat type posed by the list's entries. # Corresponds to the JSON property `threatType` # @return [String] attr_accessor :threat_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @platform_type = args[:platform_type] if args.key?(:platform_type) @threat_entry_type = args[:threat_entry_type] if args.key?(:threat_entry_type) @threat_type = args[:threat_type] if args.key?(:threat_type) end end # A match when checking a threat entry in the Safe Browsing threat lists. class ThreatMatch include Google::Apis::Core::Hashable # The cache lifetime for the returned match. Clients must not cache this # response for more than this duration to avoid false positives. # Corresponds to the JSON property `cacheDuration` # @return [String] attr_accessor :cache_duration # The platform type matching this threat. # Corresponds to the JSON property `platformType` # @return [String] attr_accessor :platform_type # An individual threat; for example, a malicious URL or its hash # representation. Only one of these fields should be set. # Corresponds to the JSON property `threat` # @return [Google::Apis::SafebrowsingV4::ThreatEntry] attr_accessor :threat # The metadata associated with a specific threat entry. The client is expected # to know the metadata key/value pairs associated with each threat type. # Corresponds to the JSON property `threatEntryMetadata` # @return [Google::Apis::SafebrowsingV4::ThreatEntryMetadata] attr_accessor :threat_entry_metadata # The threat entry type matching this threat. # Corresponds to the JSON property `threatEntryType` # @return [String] attr_accessor :threat_entry_type # The threat type matching this threat. # Corresponds to the JSON property `threatType` # @return [String] attr_accessor :threat_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cache_duration = args[:cache_duration] if args.key?(:cache_duration) @platform_type = args[:platform_type] if args.key?(:platform_type) @threat = args[:threat] if args.key?(:threat) @threat_entry_metadata = args[:threat_entry_metadata] if args.key?(:threat_entry_metadata) @threat_entry_type = args[:threat_entry_type] if args.key?(:threat_entry_type) @threat_type = args[:threat_type] if args.key?(:threat_type) end end # A single resource related to a threat hit. class ThreatSource include Google::Apis::Core::Hashable # Referrer of the resource. Only set if the referrer is available. # Corresponds to the JSON property `referrer` # @return [String] attr_accessor :referrer # The remote IP of the resource in ASCII format. Either IPv4 or IPv6. # Corresponds to the JSON property `remoteIp` # @return [String] attr_accessor :remote_ip # The type of source reported. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The URL of the resource. # 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) @referrer = args[:referrer] if args.key?(:referrer) @remote_ip = args[:remote_ip] if args.key?(:remote_ip) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) end end # Details about the user that encountered the threat. class UserInfo include Google::Apis::Core::Hashable # The UN M.49 region code associated with the user's location. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code # Unique user identifier defined by the client. # Corresponds to the JSON property `userId` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @region_code = args[:region_code] if args.key?(:region_code) @user_id = args[:user_id] if args.key?(:user_id) end end end end end google-api-client-0.19.8/generated/google/apis/safebrowsing_v4/service.rb0000644000004100000410000004046213252673044026411 0ustar www-datawww-data# 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 SafebrowsingV4 # Google Safe Browsing API # # Enables client applications to check web resources (most commonly URLs) # against Google-generated lists of unsafe web resources. # # @example # require 'google/apis/safebrowsing_v4' # # Safebrowsing = Google::Apis::SafebrowsingV4 # Alias the module # service = Safebrowsing::SafebrowsingService.new # # @see https://developers.google.com/safe-browsing/ class SafebrowsingService < 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://safebrowsing.googleapis.com/', '') @batch_path = 'batch' end # # @param [String] encoded_request # A serialized FindFullHashesRequest proto. # @param [String] client_id # A client ID that (hopefully) uniquely identifies the client implementation # of the Safe Browsing API. # @param [String] client_version # The version of the client implementation. # @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::SafebrowsingV4::FindFullHashesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SafebrowsingV4::FindFullHashesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_encoded_full_hash(encoded_request, client_id: nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v4/encodedFullHashes/{encodedRequest}', options) command.response_representation = Google::Apis::SafebrowsingV4::FindFullHashesResponse::Representation command.response_class = Google::Apis::SafebrowsingV4::FindFullHashesResponse command.params['encodedRequest'] = encoded_request unless encoded_request.nil? command.query['clientId'] = client_id unless client_id.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? execute_or_queue_command(command, &block) end # # @param [String] encoded_request # A serialized FetchThreatListUpdatesRequest proto. # @param [String] client_id # A client ID that uniquely identifies the client implementation of the Safe # Browsing API. # @param [String] client_version # The version of the client implementation. # @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::SafebrowsingV4::FetchThreatListUpdatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_encoded_update(encoded_request, client_id: nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v4/encodedUpdates/{encodedRequest}', options) command.response_representation = Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse::Representation command.response_class = Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse command.params['encodedRequest'] = encoded_request unless encoded_request.nil? command.query['clientId'] = client_id unless client_id.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? execute_or_queue_command(command, &block) end # Finds the full hashes that match the requested hash prefixes. # @param [Google::Apis::SafebrowsingV4::FindFullHashesRequest] find_full_hashes_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::SafebrowsingV4::FindFullHashesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SafebrowsingV4::FindFullHashesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def find_full_hashes(find_full_hashes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/fullHashes:find', options) command.request_representation = Google::Apis::SafebrowsingV4::FindFullHashesRequest::Representation command.request_object = find_full_hashes_request_object command.response_representation = Google::Apis::SafebrowsingV4::FindFullHashesResponse::Representation command.response_class = Google::Apis::SafebrowsingV4::FindFullHashesResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Reports a Safe Browsing threat list hit to Google. Only projects with # TRUSTED_REPORTER visibility can use this method. # @param [Google::Apis::SafebrowsingV4::ThreatHit] threat_hit_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::SafebrowsingV4::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SafebrowsingV4::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 create_threat_hit(threat_hit_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/threatHits', options) command.request_representation = Google::Apis::SafebrowsingV4::ThreatHit::Representation command.request_object = threat_hit_object command.response_representation = Google::Apis::SafebrowsingV4::Empty::Representation command.response_class = Google::Apis::SafebrowsingV4::Empty command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Fetches the most recent threat list updates. A client can request updates # for multiple lists at once. # @param [Google::Apis::SafebrowsingV4::FetchThreatListUpdatesRequest] fetch_threat_list_updates_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::SafebrowsingV4::FetchThreatListUpdatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def fetch_threat_list_updates(fetch_threat_list_updates_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/threatListUpdates:fetch', options) command.request_representation = Google::Apis::SafebrowsingV4::FetchThreatListUpdatesRequest::Representation command.request_object = fetch_threat_list_updates_request_object command.response_representation = Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse::Representation command.response_class = Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse 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 Safe Browsing threat lists available for download. # @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::SafebrowsingV4::ListThreatListsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SafebrowsingV4::ListThreatListsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_threat_lists(fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v4/threatLists', options) command.response_representation = Google::Apis::SafebrowsingV4::ListThreatListsResponse::Representation command.response_class = Google::Apis::SafebrowsingV4::ListThreatListsResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Finds the threat entries that match the Safe Browsing lists. # @param [Google::Apis::SafebrowsingV4::FindThreatMatchesRequest] find_threat_matches_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::SafebrowsingV4::FindThreatMatchesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SafebrowsingV4::FindThreatMatchesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def find_threat_matches(find_threat_matches_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/threatMatches:find', options) command.request_representation = Google::Apis::SafebrowsingV4::FindThreatMatchesRequest::Representation command.request_object = find_threat_matches_request_object command.response_representation = Google::Apis::SafebrowsingV4::FindThreatMatchesResponse::Representation command.response_class = Google::Apis::SafebrowsingV4::FindThreatMatchesResponse 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 google-api-client-0.19.8/generated/google/apis/admin_reports_v1/0000755000004100000410000000000013252673043024567 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/admin_reports_v1/representations.rb0000644000004100000410000002253213252673043030345 0ustar www-datawww-data# 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 AdminReportsV1 class Activities class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Activity class Representation < Google::Apis::Core::JsonRepresentation; end class Actor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Event class Representation < Google::Apis::Core::JsonRepresentation; end class Parameter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Id class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Channel class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UsageReport class Representation < Google::Apis::Core::JsonRepresentation; end class Entity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Parameter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class UsageReports 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 Activities # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdminReportsV1::Activity, decorator: Google::Apis::AdminReportsV1::Activity::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Activity # @private class Representation < Google::Apis::Core::JsonRepresentation property :actor, as: 'actor', class: Google::Apis::AdminReportsV1::Activity::Actor, decorator: Google::Apis::AdminReportsV1::Activity::Actor::Representation property :etag, as: 'etag' collection :events, as: 'events', class: Google::Apis::AdminReportsV1::Activity::Event, decorator: Google::Apis::AdminReportsV1::Activity::Event::Representation property :id, as: 'id', class: Google::Apis::AdminReportsV1::Activity::Id, decorator: Google::Apis::AdminReportsV1::Activity::Id::Representation property :ip_address, as: 'ipAddress' property :kind, as: 'kind' property :owner_domain, as: 'ownerDomain' end class Actor # @private class Representation < Google::Apis::Core::JsonRepresentation property :caller_type, as: 'callerType' property :email, as: 'email' property :key, as: 'key' property :profile_id, as: 'profileId' end end class Event # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' collection :parameters, as: 'parameters', class: Google::Apis::AdminReportsV1::Activity::Event::Parameter, decorator: Google::Apis::AdminReportsV1::Activity::Event::Parameter::Representation property :type, as: 'type' end class Parameter # @private class Representation < Google::Apis::Core::JsonRepresentation property :bool_value, as: 'boolValue' property :int_value, :numeric_string => true, as: 'intValue' collection :multi_int_value, as: 'multiIntValue' collection :multi_value, as: 'multiValue' property :name, as: 'name' property :value, as: 'value' end end end class Id # @private class Representation < Google::Apis::Core::JsonRepresentation property :application_name, as: 'applicationName' property :customer_id, as: 'customerId' property :time, as: 'time', type: DateTime property :unique_qualifier, :numeric_string => true, as: 'uniqueQualifier' end end end class Channel # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address' property :expiration, :numeric_string => true, as: 'expiration' property :id, as: 'id' property :kind, as: 'kind' hash :params, as: 'params' property :payload, as: 'payload' property :resource_id, as: 'resourceId' property :resource_uri, as: 'resourceUri' property :token, as: 'token' property :type, as: 'type' end end class UsageReport # @private class Representation < Google::Apis::Core::JsonRepresentation property :date, as: 'date' property :entity, as: 'entity', class: Google::Apis::AdminReportsV1::UsageReport::Entity, decorator: Google::Apis::AdminReportsV1::UsageReport::Entity::Representation property :etag, as: 'etag' property :kind, as: 'kind' collection :parameters, as: 'parameters', class: Google::Apis::AdminReportsV1::UsageReport::Parameter, decorator: Google::Apis::AdminReportsV1::UsageReport::Parameter::Representation end class Entity # @private class Representation < Google::Apis::Core::JsonRepresentation property :customer_id, as: 'customerId' property :entity_id, as: 'entityId' property :profile_id, as: 'profileId' property :type, as: 'type' property :user_email, as: 'userEmail' end end class Parameter # @private class Representation < Google::Apis::Core::JsonRepresentation property :bool_value, as: 'boolValue' property :datetime_value, as: 'datetimeValue', type: DateTime property :int_value, :numeric_string => true, as: 'intValue' collection :msg_value, as: 'msgValue' property :name, as: 'name' property :string_value, as: 'stringValue' end end end class UsageReports # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :usage_reports, as: 'usageReports', class: Google::Apis::AdminReportsV1::UsageReport, decorator: Google::Apis::AdminReportsV1::UsageReport::Representation collection :warnings, as: 'warnings', class: Google::Apis::AdminReportsV1::UsageReports::Warning, decorator: Google::Apis::AdminReportsV1::UsageReports::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::AdminReportsV1::UsageReports::Warning::Datum, decorator: Google::Apis::AdminReportsV1::UsageReports::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 end end end google-api-client-0.19.8/generated/google/apis/admin_reports_v1/classes.rb0000644000004100000410000005077513252673043026567 0ustar www-datawww-data# 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 AdminReportsV1 # JSON template for a collection of activites. class Activities include Google::Apis::Core::Hashable # ETag of the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Each record in read response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list response this is. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token for retrieving the next 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) @etag = args[:etag] if args.key?(:etag) @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) end end # JSON template for the activity resource. class Activity include Google::Apis::Core::Hashable # User doing the action. # Corresponds to the JSON property `actor` # @return [Google::Apis::AdminReportsV1::Activity::Actor] attr_accessor :actor # ETag of the entry. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Activity events. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events # Unique identifier for each activity record. # Corresponds to the JSON property `id` # @return [Google::Apis::AdminReportsV1::Activity::Id] attr_accessor :id # IP Address of the user doing the action. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address # Kind of resource this is. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Domain of source customer. # Corresponds to the JSON property `ownerDomain` # @return [String] attr_accessor :owner_domain def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @actor = args[:actor] if args.key?(:actor) @etag = args[:etag] if args.key?(:etag) @events = args[:events] if args.key?(:events) @id = args[:id] if args.key?(:id) @ip_address = args[:ip_address] if args.key?(:ip_address) @kind = args[:kind] if args.key?(:kind) @owner_domain = args[:owner_domain] if args.key?(:owner_domain) end # User doing the action. class Actor include Google::Apis::Core::Hashable # User or OAuth 2LO request. # Corresponds to the JSON property `callerType` # @return [String] attr_accessor :caller_type # Email address of the user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # For OAuth 2LO API requests, consumer_key of the requestor. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # Obfuscated user id of the user. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @caller_type = args[:caller_type] if args.key?(:caller_type) @email = args[:email] if args.key?(:email) @key = args[:key] if args.key?(:key) @profile_id = args[:profile_id] if args.key?(:profile_id) end end # class Event include Google::Apis::Core::Hashable # Name of event. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parameter value pairs for various applications. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Type of event. # 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) @parameters = args[:parameters] if args.key?(:parameters) @type = args[:type] if args.key?(:type) end # class Parameter include Google::Apis::Core::Hashable # Boolean value of the parameter. # Corresponds to the JSON property `boolValue` # @return [Boolean] attr_accessor :bool_value alias_method :bool_value?, :bool_value # Integral value of the parameter. # Corresponds to the JSON property `intValue` # @return [Fixnum] attr_accessor :int_value # Multi-int value of the parameter. # Corresponds to the JSON property `multiIntValue` # @return [Array] attr_accessor :multi_int_value # Multi-string value of the parameter. # Corresponds to the JSON property `multiValue` # @return [Array] attr_accessor :multi_value # The name of the parameter. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # String value of the parameter. # 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) @bool_value = args[:bool_value] if args.key?(:bool_value) @int_value = args[:int_value] if args.key?(:int_value) @multi_int_value = args[:multi_int_value] if args.key?(:multi_int_value) @multi_value = args[:multi_value] if args.key?(:multi_value) @name = args[:name] if args.key?(:name) @value = args[:value] if args.key?(:value) end end end # Unique identifier for each activity record. class Id include Google::Apis::Core::Hashable # Application name to which the event belongs. # Corresponds to the JSON property `applicationName` # @return [String] attr_accessor :application_name # Obfuscated customer ID of the source customer. # Corresponds to the JSON property `customerId` # @return [String] attr_accessor :customer_id # Time of occurrence of the activity. # Corresponds to the JSON property `time` # @return [DateTime] attr_accessor :time # Unique qualifier if multiple events have the same time. # Corresponds to the JSON property `uniqueQualifier` # @return [Fixnum] attr_accessor :unique_qualifier def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @application_name = args[:application_name] if args.key?(:application_name) @customer_id = args[:customer_id] if args.key?(:customer_id) @time = args[:time] if args.key?(:time) @unique_qualifier = args[:unique_qualifier] if args.key?(:unique_qualifier) end end end # An notification channel used to watch for resource changes. class Channel include Google::Apis::Core::Hashable # The address where notifications are delivered for this channel. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Date and time of notification channel expiration, expressed as a Unix # timestamp, in milliseconds. Optional. # Corresponds to the JSON property `expiration` # @return [Fixnum] attr_accessor :expiration # A UUID or similar unique string that identifies this channel. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies this as a notification channel used to watch for changes to a # resource. Value: the fixed string "api#channel". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Additional parameters controlling delivery channel behavior. Optional. # Corresponds to the JSON property `params` # @return [Hash] attr_accessor :params # A Boolean value to indicate whether payload is wanted. Optional. # Corresponds to the JSON property `payload` # @return [Boolean] attr_accessor :payload alias_method :payload?, :payload # An opaque ID that identifies the resource being watched on this channel. # Stable across different API versions. # Corresponds to the JSON property `resourceId` # @return [String] attr_accessor :resource_id # A version-specific identifier for the watched resource. # Corresponds to the JSON property `resourceUri` # @return [String] attr_accessor :resource_uri # An arbitrary string delivered to the target address with each notification # delivered over this channel. Optional. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token # The type of delivery mechanism used for this channel. # 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) @address = args[:address] if args.key?(:address) @expiration = args[:expiration] if args.key?(:expiration) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @params = args[:params] if args.key?(:params) @payload = args[:payload] if args.key?(:payload) @resource_id = args[:resource_id] if args.key?(:resource_id) @resource_uri = args[:resource_uri] if args.key?(:resource_uri) @token = args[:token] if args.key?(:token) @type = args[:type] if args.key?(:type) end end # JSON template for a usage report. class UsageReport include Google::Apis::Core::Hashable # The date to which the record belongs. # Corresponds to the JSON property `date` # @return [String] attr_accessor :date # Information about the type of the item. # Corresponds to the JSON property `entity` # @return [Google::Apis::AdminReportsV1::UsageReport::Entity] attr_accessor :entity # ETag of the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The kind of object. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Parameter value pairs for various applications. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @date = args[:date] if args.key?(:date) @entity = args[:entity] if args.key?(:entity) @etag = args[:etag] if args.key?(:etag) @kind = args[:kind] if args.key?(:kind) @parameters = args[:parameters] if args.key?(:parameters) end # Information about the type of the item. class Entity include Google::Apis::Core::Hashable # Obfuscated customer id for the record. # Corresponds to the JSON property `customerId` # @return [String] attr_accessor :customer_id # Object key. Only relevant if entity.type = "OBJECT" Note: external-facing name # of report is "Entities" rather than "Objects". # Corresponds to the JSON property `entityId` # @return [String] attr_accessor :entity_id # Obfuscated user id for the record. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id # The type of item, can be customer, user, or entity (aka. object). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # user's email. Only relevant if entity.type = "USER" # Corresponds to the JSON property `userEmail` # @return [String] attr_accessor :user_email def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @customer_id = args[:customer_id] if args.key?(:customer_id) @entity_id = args[:entity_id] if args.key?(:entity_id) @profile_id = args[:profile_id] if args.key?(:profile_id) @type = args[:type] if args.key?(:type) @user_email = args[:user_email] if args.key?(:user_email) end end # class Parameter include Google::Apis::Core::Hashable # Boolean value of the parameter. # Corresponds to the JSON property `boolValue` # @return [Boolean] attr_accessor :bool_value alias_method :bool_value?, :bool_value # RFC 3339 formatted value of the parameter. # Corresponds to the JSON property `datetimeValue` # @return [DateTime] attr_accessor :datetime_value # Integral value of the parameter. # Corresponds to the JSON property `intValue` # @return [Fixnum] attr_accessor :int_value # Nested message value of the parameter. # Corresponds to the JSON property `msgValue` # @return [Array>] attr_accessor :msg_value # The name of the parameter. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # String value of the parameter. # 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) @datetime_value = args[:datetime_value] if args.key?(:datetime_value) @int_value = args[:int_value] if args.key?(:int_value) @msg_value = args[:msg_value] if args.key?(:msg_value) @name = args[:name] if args.key?(:name) @string_value = args[:string_value] if args.key?(:string_value) end end end # JSON template for a collection of usage reports. class UsageReports include Google::Apis::Core::Hashable # ETag of the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The kind of object. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token for retrieving the next page # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Various application parameter records. # Corresponds to the JSON property `usageReports` # @return [Array] attr_accessor :usage_reports # Warnings if any. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @usage_reports = args[:usage_reports] if args.key?(:usage_reports) @warnings = args[:warnings] if args.key?(:warnings) end # class Warning include Google::Apis::Core::Hashable # Machine readable code / warning type. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # Key-Value pairs to give detailed information on the warning. # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data # Human readable message for the warning. # 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 # Key associated with a key-value pair to give detailed information on the # warning. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # Value associated with a key-value pair to give detailed information on the # warning. # 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 end end end google-api-client-0.19.8/generated/google/apis/admin_reports_v1/service.rb0000644000004100000410000005446013252673043026565 0ustar www-datawww-data# 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 AdminReportsV1 # Admin Reports API # # Fetches reports for the administrators of G Suite customers about the usage, # collaboration, security, and risk for their users. # # @example # require 'google/apis/admin_reports_v1' # # Admin = Google::Apis::AdminReportsV1 # Alias the module # service = Admin::ReportsService.new # # @see https://developers.google.com/admin-sdk/reports/ class ReportsService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'admin/reports/v1/') @batch_path = 'batch/admin/reports_v1' end # Retrieves a list of activities for a specific customer and application. # @param [String] user_key # Represents the profile id or the user email for which the data should be # filtered. When 'all' is specified as the userKey, it returns usageReports for # all users. # @param [String] application_name # Application name for which the events are to be retrieved. # @param [String] actor_ip_address # IP Address of host where the event was performed. Supports both IPv4 and IPv6 # addresses. # @param [String] customer_id # Represents the customer for which the data is to be fetched. # @param [String] end_time # Return events which occurred at or before this time. # @param [String] event_name # Name of the event being queried. # @param [String] filters # Event parameters in the form [parameter1 name][operator][parameter1 value],[ # parameter2 name][operator][parameter2 value],... # @param [Fixnum] max_results # Number of activity records to be shown in each page. # @param [String] page_token # Token to specify next page. # @param [String] start_time # Return events which occurred at or after this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdminReportsV1::Activities] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdminReportsV1::Activities] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activities(user_key, application_name, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activity/users/{userKey}/applications/{applicationName}', options) command.response_representation = Google::Apis::AdminReportsV1::Activities::Representation command.response_class = Google::Apis::AdminReportsV1::Activities command.params['userKey'] = user_key unless user_key.nil? command.params['applicationName'] = application_name unless application_name.nil? command.query['actorIpAddress'] = actor_ip_address unless actor_ip_address.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['endTime'] = end_time unless end_time.nil? command.query['eventName'] = event_name unless event_name.nil? command.query['filters'] = filters unless filters.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['startTime'] = start_time unless start_time.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 # Push changes to activities # @param [String] user_key # Represents the profile id or the user email for which the data should be # filtered. When 'all' is specified as the userKey, it returns usageReports for # all users. # @param [String] application_name # Application name for which the events are to be retrieved. # @param [Google::Apis::AdminReportsV1::Channel] channel_object # @param [String] actor_ip_address # IP Address of host where the event was performed. Supports both IPv4 and IPv6 # addresses. # @param [String] customer_id # Represents the customer for which the data is to be fetched. # @param [String] end_time # Return events which occurred at or before this time. # @param [String] event_name # Name of the event being queried. # @param [String] filters # Event parameters in the form [parameter1 name][operator][parameter1 value],[ # parameter2 name][operator][parameter2 value],... # @param [Fixnum] max_results # Number of activity records to be shown in each page. # @param [String] page_token # Token to specify next page. # @param [String] start_time # Return events which occurred at or after this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdminReportsV1::Channel] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdminReportsV1::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 watch_activity(user_key, application_name, channel_object = nil, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'activity/users/{userKey}/applications/{applicationName}/watch', options) command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation command.request_object = channel_object command.response_representation = Google::Apis::AdminReportsV1::Channel::Representation command.response_class = Google::Apis::AdminReportsV1::Channel command.params['userKey'] = user_key unless user_key.nil? command.params['applicationName'] = application_name unless application_name.nil? command.query['actorIpAddress'] = actor_ip_address unless actor_ip_address.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['endTime'] = end_time unless end_time.nil? command.query['eventName'] = event_name unless event_name.nil? command.query['filters'] = filters unless filters.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['startTime'] = start_time unless start_time.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 # Stop watching resources through this channel # @param [Google::Apis::AdminReportsV1::Channel] channel_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '/admin/reports_v1/channels/stop', options) command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation command.request_object = channel_object 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 report which is a collection of properties / statistics for a # specific customer. # @param [String] date # Represents the date in yyyy-mm-dd format for which the data is to be fetched. # @param [String] customer_id # Represents the customer for which the data is to be fetched. # @param [String] page_token # Token to specify next page. # @param [String] parameters # Represents the application name, parameter name pairs to fetch in csv as # app_name1:param_name1, app_name2:param_name2. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdminReportsV1::UsageReports] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdminReportsV1::UsageReports] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_customer_usage_report(date, customer_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'usage/dates/{date}', options) command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation command.response_class = Google::Apis::AdminReportsV1::UsageReports command.params['date'] = date unless date.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parameters'] = parameters unless parameters.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 report which is a collection of properties / statistics for a set # of objects. # @param [String] entity_type # Type of object. Should be one of - gplus_communities. # @param [String] entity_key # Represents the key of object for which the data should be filtered. # @param [String] date # Represents the date in yyyy-mm-dd format for which the data is to be fetched. # @param [String] customer_id # Represents the customer for which the data is to be fetched. # @param [String] filters # Represents the set of filters including parameter operator value. # @param [Fixnum] max_results # Maximum number of results to return. Maximum allowed is 1000 # @param [String] page_token # Token to specify next page. # @param [String] parameters # Represents the application name, parameter name pairs to fetch in csv as # app_name1:param_name1, app_name2:param_name2. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdminReportsV1::UsageReports] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdminReportsV1::UsageReports] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_entity_usage_report(entity_type, entity_key, date, customer_id: nil, filters: nil, max_results: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'usage/{entityType}/{entityKey}/dates/{date}', options) command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation command.response_class = Google::Apis::AdminReportsV1::UsageReports command.params['entityType'] = entity_type unless entity_type.nil? command.params['entityKey'] = entity_key unless entity_key.nil? command.params['date'] = date unless date.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['filters'] = filters unless filters.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parameters'] = parameters unless parameters.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 report which is a collection of properties / statistics for a set # of users. # @param [String] user_key # Represents the profile id or the user email for which the data should be # filtered. # @param [String] date # Represents the date in yyyy-mm-dd format for which the data is to be fetched. # @param [String] customer_id # Represents the customer for which the data is to be fetched. # @param [String] filters # Represents the set of filters including parameter operator value. # @param [Fixnum] max_results # Maximum number of results to return. Maximum allowed is 1000 # @param [String] page_token # Token to specify next page. # @param [String] parameters # Represents the application name, parameter name pairs to fetch in csv as # app_name1:param_name1, app_name2:param_name2. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdminReportsV1::UsageReports] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdminReportsV1::UsageReports] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_usage_report(user_key, date, customer_id: nil, filters: nil, max_results: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'usage/users/{userKey}/dates/{date}', options) command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation command.response_class = Google::Apis::AdminReportsV1::UsageReports command.params['userKey'] = user_key unless user_key.nil? command.params['date'] = date unless date.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['filters'] = filters unless filters.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parameters'] = parameters unless parameters.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 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 end end google-api-client-0.19.8/generated/google/apis/oslogin_v1.rb0000644000004100000410000000237713252673044023732 0ustar www-datawww-data# 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/oslogin_v1/service.rb' require 'google/apis/oslogin_v1/classes.rb' require 'google/apis/oslogin_v1/representations.rb' module Google module Apis # Google Cloud OS Login API # # Manages OS login configuration for Google account users. # # @see https://cloud.google.com/compute/docs/oslogin/rest/ module OsloginV1 VERSION = 'V1' REVISION = '20180117' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View and manage your Google Compute Engine resources AUTH_COMPUTE = 'https://www.googleapis.com/auth/compute' end end end google-api-client-0.19.8/generated/google/apis/analytics_v3/0000755000004100000410000000000013252673043023712 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/analytics_v3/representations.rb0000644000004100000410000023747613252673043027507 0ustar www-datawww-data# 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 AnalyticsV3 class Account class Representation < Google::Apis::Core::JsonRepresentation; end class ChildLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Permissions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class AccountRef class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountSummaries class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountSummary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountTicket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountTreeRequest class Representation < Google::Apis::Core::JsonRepresentation; end class AccountSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class AccountTreeResponse class Representation < Google::Apis::Core::JsonRepresentation; end class AccountSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Accounts class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdWordsAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteUploadDataRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Column class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Columns class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomDataSource class Representation < Google::Apis::Core::JsonRepresentation; end class ChildLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ParentLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class CustomDataSources class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomDimension class Representation < Google::Apis::Core::JsonRepresentation; end class ParentLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class CustomDimensions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomMetric class Representation < Google::Apis::Core::JsonRepresentation; end class ParentLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class CustomMetrics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EntityAdWordsLink class Representation < Google::Apis::Core::JsonRepresentation; end class Entity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class EntityAdWordsLinks class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EntityUserLink class Representation < Google::Apis::Core::JsonRepresentation; end class Entity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Permissions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class EntityUserLinks class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Experiment class Representation < Google::Apis::Core::JsonRepresentation; end class ParentLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Variation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Experiments class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Filter class Representation < Google::Apis::Core::JsonRepresentation; end class AdvancedDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LowercaseDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ParentLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchAndReplaceDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UppercaseDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class FilterExpression class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FilterRef class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Filters class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GaData class Representation < Google::Apis::Core::JsonRepresentation; end class ColumnHeader class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DataTable class Representation < Google::Apis::Core::JsonRepresentation; end class Col class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Row class Representation < Google::Apis::Core::JsonRepresentation; end class C 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 ProfileInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Query class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Goal class Representation < Google::Apis::Core::JsonRepresentation; end class EventDetails class Representation < Google::Apis::Core::JsonRepresentation; end class EventCondition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ParentLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlDestinationDetails class Representation < Google::Apis::Core::JsonRepresentation; end class Step class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class VisitNumPagesDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VisitTimeOnSiteDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Goals class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IncludeConditions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinkedForeignAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class McfData class Representation < Google::Apis::Core::JsonRepresentation; end class ColumnHeader class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProfileInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Query class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Row class Representation < Google::Apis::Core::JsonRepresentation; end class ConversionPathValue 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 Profile class Representation < Google::Apis::Core::JsonRepresentation; end class ChildLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ParentLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Permissions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ProfileFilterLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProfileFilterLinks class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProfileRef class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProfileSummary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Profiles class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RealtimeData class Representation < Google::Apis::Core::JsonRepresentation; end class ColumnHeader class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProfileInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Query class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class RemarketingAudience class Representation < Google::Apis::Core::JsonRepresentation; end class AudienceDefinition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StateBasedAudienceDefinition class Representation < Google::Apis::Core::JsonRepresentation; end class ExcludeConditions 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 RemarketingAudiences class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Segment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Segments class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UnsampledReport class Representation < Google::Apis::Core::JsonRepresentation; end class CloudStorageDownloadDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DriveDownloadDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class UnsampledReports class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Upload class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Uploads class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRef class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WebPropertyRef class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WebPropertySummary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Webproperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Webproperty class Representation < Google::Apis::Core::JsonRepresentation; end class ChildLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ParentLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Permissions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Account # @private class Representation < Google::Apis::Core::JsonRepresentation property :child_link, as: 'childLink', class: Google::Apis::AnalyticsV3::Account::ChildLink, decorator: Google::Apis::AnalyticsV3::Account::ChildLink::Representation property :created, as: 'created', type: DateTime property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :permissions, as: 'permissions', class: Google::Apis::AnalyticsV3::Account::Permissions, decorator: Google::Apis::AnalyticsV3::Account::Permissions::Representation property :self_link, as: 'selfLink' property :starred, as: 'starred' property :updated, as: 'updated', type: DateTime end class ChildLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end class Permissions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :effective, as: 'effective' end end end class AccountRef # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class AccountSummaries # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::AccountSummary, decorator: Google::Apis::AnalyticsV3::AccountSummary::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class AccountSummary # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :starred, as: 'starred' collection :web_properties, as: 'webProperties', class: Google::Apis::AnalyticsV3::WebPropertySummary, decorator: Google::Apis::AnalyticsV3::WebPropertySummary::Representation end end class AccountTicket # @private class Representation < Google::Apis::Core::JsonRepresentation property :account, as: 'account', class: Google::Apis::AnalyticsV3::Account, decorator: Google::Apis::AnalyticsV3::Account::Representation property :id, as: 'id' property :kind, as: 'kind' property :profile, as: 'profile', class: Google::Apis::AnalyticsV3::Profile, decorator: Google::Apis::AnalyticsV3::Profile::Representation property :redirect_uri, as: 'redirectUri' property :webproperty, as: 'webproperty', class: Google::Apis::AnalyticsV3::Webproperty, decorator: Google::Apis::AnalyticsV3::Webproperty::Representation end end class AccountTreeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_name, as: 'accountName' property :account_settings, as: 'accountSettings', class: Google::Apis::AnalyticsV3::AccountTreeRequest::AccountSettings, decorator: Google::Apis::AnalyticsV3::AccountTreeRequest::AccountSettings::Representation property :kind, as: 'kind' property :profile_name, as: 'profileName' property :timezone, as: 'timezone' property :webproperty_name, as: 'webpropertyName' property :website_url, as: 'websiteUrl' end class AccountSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :admob_reporting, as: 'admobReporting' property :sharing_with_google_any_sales, as: 'sharingWithGoogleAnySales' property :sharing_with_google_products, as: 'sharingWithGoogleProducts' property :sharing_with_google_sales, as: 'sharingWithGoogleSales' property :sharing_with_google_support, as: 'sharingWithGoogleSupport' property :sharing_with_others, as: 'sharingWithOthers' end end end class AccountTreeResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :account, as: 'account', class: Google::Apis::AnalyticsV3::Account, decorator: Google::Apis::AnalyticsV3::Account::Representation property :account_settings, as: 'accountSettings', class: Google::Apis::AnalyticsV3::AccountTreeResponse::AccountSettings, decorator: Google::Apis::AnalyticsV3::AccountTreeResponse::AccountSettings::Representation property :kind, as: 'kind' property :profile, as: 'profile', class: Google::Apis::AnalyticsV3::Profile, decorator: Google::Apis::AnalyticsV3::Profile::Representation property :webproperty, as: 'webproperty', class: Google::Apis::AnalyticsV3::Webproperty, decorator: Google::Apis::AnalyticsV3::Webproperty::Representation end class AccountSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :admob_reporting, as: 'admobReporting' property :sharing_with_google_any_sales, as: 'sharingWithGoogleAnySales' property :sharing_with_google_products, as: 'sharingWithGoogleProducts' property :sharing_with_google_sales, as: 'sharingWithGoogleSales' property :sharing_with_google_support, as: 'sharingWithGoogleSupport' property :sharing_with_others, as: 'sharingWithOthers' end end end class Accounts # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::Account, decorator: Google::Apis::AnalyticsV3::Account::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class AdWordsAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_tagging_enabled, as: 'autoTaggingEnabled' property :customer_id, as: 'customerId' property :kind, as: 'kind' end end class DeleteUploadDataRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :custom_data_import_uids, as: 'customDataImportUids' end end class Column # @private class Representation < Google::Apis::Core::JsonRepresentation hash :attributes, as: 'attributes' property :id, as: 'id' property :kind, as: 'kind' end end class Columns # @private class Representation < Google::Apis::Core::JsonRepresentation collection :attribute_names, as: 'attributeNames' property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AnalyticsV3::Column, decorator: Google::Apis::AnalyticsV3::Column::Representation property :kind, as: 'kind' property :total_results, as: 'totalResults' end end class CustomDataSource # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :child_link, as: 'childLink', class: Google::Apis::AnalyticsV3::CustomDataSource::ChildLink, decorator: Google::Apis::AnalyticsV3::CustomDataSource::ChildLink::Representation property :created, as: 'created', type: DateTime property :description, as: 'description' property :id, as: 'id' property :import_behavior, as: 'importBehavior' property :kind, as: 'kind' property :name, as: 'name' property :parent_link, as: 'parentLink', class: Google::Apis::AnalyticsV3::CustomDataSource::ParentLink, decorator: Google::Apis::AnalyticsV3::CustomDataSource::ParentLink::Representation collection :profiles_linked, as: 'profilesLinked' collection :schema, as: 'schema' property :self_link, as: 'selfLink' property :type, as: 'type' property :updated, as: 'updated', type: DateTime property :upload_type, as: 'uploadType' property :web_property_id, as: 'webPropertyId' end class ChildLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end class ParentLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end end class CustomDataSources # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::CustomDataSource, decorator: Google::Apis::AnalyticsV3::CustomDataSource::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class CustomDimension # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :active, as: 'active' property :created, as: 'created', type: DateTime property :id, as: 'id' property :index, as: 'index' property :kind, as: 'kind' property :name, as: 'name' property :parent_link, as: 'parentLink', class: Google::Apis::AnalyticsV3::CustomDimension::ParentLink, decorator: Google::Apis::AnalyticsV3::CustomDimension::ParentLink::Representation property :scope, as: 'scope' property :self_link, as: 'selfLink' property :updated, as: 'updated', type: DateTime property :web_property_id, as: 'webPropertyId' end class ParentLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end end class CustomDimensions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::CustomDimension, decorator: Google::Apis::AnalyticsV3::CustomDimension::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class CustomMetric # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :active, as: 'active' property :created, as: 'created', type: DateTime property :id, as: 'id' property :index, as: 'index' property :kind, as: 'kind' property :max_value, as: 'max_value' property :min_value, as: 'min_value' property :name, as: 'name' property :parent_link, as: 'parentLink', class: Google::Apis::AnalyticsV3::CustomMetric::ParentLink, decorator: Google::Apis::AnalyticsV3::CustomMetric::ParentLink::Representation property :scope, as: 'scope' property :self_link, as: 'selfLink' property :type, as: 'type' property :updated, as: 'updated', type: DateTime property :web_property_id, as: 'webPropertyId' end class ParentLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end end class CustomMetrics # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::CustomMetric, decorator: Google::Apis::AnalyticsV3::CustomMetric::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class EntityAdWordsLink # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ad_words_accounts, as: 'adWordsAccounts', class: Google::Apis::AnalyticsV3::AdWordsAccount, decorator: Google::Apis::AnalyticsV3::AdWordsAccount::Representation property :entity, as: 'entity', class: Google::Apis::AnalyticsV3::EntityAdWordsLink::Entity, decorator: Google::Apis::AnalyticsV3::EntityAdWordsLink::Entity::Representation property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' collection :profile_ids, as: 'profileIds' property :self_link, as: 'selfLink' end class Entity # @private class Representation < Google::Apis::Core::JsonRepresentation property :web_property_ref, as: 'webPropertyRef', class: Google::Apis::AnalyticsV3::WebPropertyRef, decorator: Google::Apis::AnalyticsV3::WebPropertyRef::Representation end end end class EntityAdWordsLinks # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::EntityAdWordsLink, decorator: Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' end end class EntityUserLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :entity, as: 'entity', class: Google::Apis::AnalyticsV3::EntityUserLink::Entity, decorator: Google::Apis::AnalyticsV3::EntityUserLink::Entity::Representation property :id, as: 'id' property :kind, as: 'kind' property :permissions, as: 'permissions', class: Google::Apis::AnalyticsV3::EntityUserLink::Permissions, decorator: Google::Apis::AnalyticsV3::EntityUserLink::Permissions::Representation property :self_link, as: 'selfLink' property :user_ref, as: 'userRef', class: Google::Apis::AnalyticsV3::UserRef, decorator: Google::Apis::AnalyticsV3::UserRef::Representation end class Entity # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_ref, as: 'accountRef', class: Google::Apis::AnalyticsV3::AccountRef, decorator: Google::Apis::AnalyticsV3::AccountRef::Representation property :profile_ref, as: 'profileRef', class: Google::Apis::AnalyticsV3::ProfileRef, decorator: Google::Apis::AnalyticsV3::ProfileRef::Representation property :web_property_ref, as: 'webPropertyRef', class: Google::Apis::AnalyticsV3::WebPropertyRef, decorator: Google::Apis::AnalyticsV3::WebPropertyRef::Representation end end class Permissions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :effective, as: 'effective' collection :local, as: 'local' end end end class EntityUserLinks # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::EntityUserLink, decorator: Google::Apis::AnalyticsV3::EntityUserLink::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' end end class Experiment # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :created, as: 'created', type: DateTime property :description, as: 'description' property :editable_in_ga_ui, as: 'editableInGaUi' property :end_time, as: 'endTime', type: DateTime property :equal_weighting, as: 'equalWeighting' property :id, as: 'id' property :internal_web_property_id, as: 'internalWebPropertyId' property :kind, as: 'kind' property :minimum_experiment_length_in_days, as: 'minimumExperimentLengthInDays' property :name, as: 'name' property :objective_metric, as: 'objectiveMetric' property :optimization_type, as: 'optimizationType' property :parent_link, as: 'parentLink', class: Google::Apis::AnalyticsV3::Experiment::ParentLink, decorator: Google::Apis::AnalyticsV3::Experiment::ParentLink::Representation property :profile_id, as: 'profileId' property :reason_experiment_ended, as: 'reasonExperimentEnded' property :rewrite_variation_urls_as_original, as: 'rewriteVariationUrlsAsOriginal' property :self_link, as: 'selfLink' property :serving_framework, as: 'servingFramework' property :snippet, as: 'snippet' property :start_time, as: 'startTime', type: DateTime property :status, as: 'status' property :traffic_coverage, as: 'trafficCoverage' property :updated, as: 'updated', type: DateTime collection :variations, as: 'variations', class: Google::Apis::AnalyticsV3::Experiment::Variation, decorator: Google::Apis::AnalyticsV3::Experiment::Variation::Representation property :web_property_id, as: 'webPropertyId' property :winner_confidence_level, as: 'winnerConfidenceLevel' property :winner_found, as: 'winnerFound' end class ParentLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end class Variation # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :status, as: 'status' property :url, as: 'url' property :weight, as: 'weight' property :won, as: 'won' end end end class Experiments # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::Experiment, decorator: Google::Apis::AnalyticsV3::Experiment::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class Filter # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :advanced_details, as: 'advancedDetails', class: Google::Apis::AnalyticsV3::Filter::AdvancedDetails, decorator: Google::Apis::AnalyticsV3::Filter::AdvancedDetails::Representation property :created, as: 'created', type: DateTime property :exclude_details, as: 'excludeDetails', class: Google::Apis::AnalyticsV3::FilterExpression, decorator: Google::Apis::AnalyticsV3::FilterExpression::Representation property :id, as: 'id' property :include_details, as: 'includeDetails', class: Google::Apis::AnalyticsV3::FilterExpression, decorator: Google::Apis::AnalyticsV3::FilterExpression::Representation property :kind, as: 'kind' property :lowercase_details, as: 'lowercaseDetails', class: Google::Apis::AnalyticsV3::Filter::LowercaseDetails, decorator: Google::Apis::AnalyticsV3::Filter::LowercaseDetails::Representation property :name, as: 'name' property :parent_link, as: 'parentLink', class: Google::Apis::AnalyticsV3::Filter::ParentLink, decorator: Google::Apis::AnalyticsV3::Filter::ParentLink::Representation property :search_and_replace_details, as: 'searchAndReplaceDetails', class: Google::Apis::AnalyticsV3::Filter::SearchAndReplaceDetails, decorator: Google::Apis::AnalyticsV3::Filter::SearchAndReplaceDetails::Representation property :self_link, as: 'selfLink' property :type, as: 'type' property :updated, as: 'updated', type: DateTime property :uppercase_details, as: 'uppercaseDetails', class: Google::Apis::AnalyticsV3::Filter::UppercaseDetails, decorator: Google::Apis::AnalyticsV3::Filter::UppercaseDetails::Representation end class AdvancedDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :case_sensitive, as: 'caseSensitive' property :extract_a, as: 'extractA' property :extract_b, as: 'extractB' property :field_a, as: 'fieldA' property :field_a_index, as: 'fieldAIndex' property :field_a_required, as: 'fieldARequired' property :field_b, as: 'fieldB' property :field_b_index, as: 'fieldBIndex' property :field_b_required, as: 'fieldBRequired' property :output_constructor, as: 'outputConstructor' property :output_to_field, as: 'outputToField' property :output_to_field_index, as: 'outputToFieldIndex' property :override_output_field, as: 'overrideOutputField' end end class LowercaseDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field' property :field_index, as: 'fieldIndex' end end class ParentLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end class SearchAndReplaceDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :case_sensitive, as: 'caseSensitive' property :field, as: 'field' property :field_index, as: 'fieldIndex' property :replace_string, as: 'replaceString' property :search_string, as: 'searchString' end end class UppercaseDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field' property :field_index, as: 'fieldIndex' end end end class FilterExpression # @private class Representation < Google::Apis::Core::JsonRepresentation property :case_sensitive, as: 'caseSensitive' property :expression_value, as: 'expressionValue' property :field, as: 'field' property :field_index, as: 'fieldIndex' property :kind, as: 'kind' property :match_type, as: 'matchType' end end class FilterRef # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :href, as: 'href' property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class Filters # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::Filter, decorator: Google::Apis::AnalyticsV3::Filter::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class GaData # @private class Representation < Google::Apis::Core::JsonRepresentation collection :column_headers, as: 'columnHeaders', class: Google::Apis::AnalyticsV3::GaData::ColumnHeader, decorator: Google::Apis::AnalyticsV3::GaData::ColumnHeader::Representation property :contains_sampled_data, as: 'containsSampledData' property :data_last_refreshed, :numeric_string => true, as: 'dataLastRefreshed' property :data_table, as: 'dataTable', class: Google::Apis::AnalyticsV3::GaData::DataTable, decorator: Google::Apis::AnalyticsV3::GaData::DataTable::Representation property :id, as: 'id' property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :profile_info, as: 'profileInfo', class: Google::Apis::AnalyticsV3::GaData::ProfileInfo, decorator: Google::Apis::AnalyticsV3::GaData::ProfileInfo::Representation property :query, as: 'query', class: Google::Apis::AnalyticsV3::GaData::Query, decorator: Google::Apis::AnalyticsV3::GaData::Query::Representation collection :rows, as: 'rows', :class => Array do include Representable::JSON::Collection items end property :sample_size, :numeric_string => true, as: 'sampleSize' property :sample_space, :numeric_string => true, as: 'sampleSpace' property :self_link, as: 'selfLink' property :total_results, as: 'totalResults' hash :totals_for_all_results, as: 'totalsForAllResults' end class ColumnHeader # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_type, as: 'columnType' property :data_type, as: 'dataType' property :name, as: 'name' end end class DataTable # @private class Representation < Google::Apis::Core::JsonRepresentation collection :cols, as: 'cols', class: Google::Apis::AnalyticsV3::GaData::DataTable::Col, decorator: Google::Apis::AnalyticsV3::GaData::DataTable::Col::Representation collection :rows, as: 'rows', class: Google::Apis::AnalyticsV3::GaData::DataTable::Row, decorator: Google::Apis::AnalyticsV3::GaData::DataTable::Row::Representation end class Col # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :label, as: 'label' property :type, as: 'type' end end class Row # @private class Representation < Google::Apis::Core::JsonRepresentation collection :c, as: 'c', class: Google::Apis::AnalyticsV3::GaData::DataTable::Row::C, decorator: Google::Apis::AnalyticsV3::GaData::DataTable::Row::C::Representation end class C # @private class Representation < Google::Apis::Core::JsonRepresentation property :v, as: 'v' end end end end class ProfileInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :internal_web_property_id, as: 'internalWebPropertyId' property :profile_id, as: 'profileId' property :profile_name, as: 'profileName' property :table_id, as: 'tableId' property :web_property_id, as: 'webPropertyId' end end class Query # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimensions, as: 'dimensions' property :end_date, as: 'end-date' property :filters, as: 'filters' property :ids, as: 'ids' property :max_results, as: 'max-results' collection :metrics, as: 'metrics' property :sampling_level, as: 'samplingLevel' property :segment, as: 'segment' collection :sort, as: 'sort' property :start_date, as: 'start-date' property :start_index, as: 'start-index' end end end class Goal # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :active, as: 'active' property :created, as: 'created', type: DateTime property :event_details, as: 'eventDetails', class: Google::Apis::AnalyticsV3::Goal::EventDetails, decorator: Google::Apis::AnalyticsV3::Goal::EventDetails::Representation property :id, as: 'id' property :internal_web_property_id, as: 'internalWebPropertyId' property :kind, as: 'kind' property :name, as: 'name' property :parent_link, as: 'parentLink', class: Google::Apis::AnalyticsV3::Goal::ParentLink, decorator: Google::Apis::AnalyticsV3::Goal::ParentLink::Representation property :profile_id, as: 'profileId' property :self_link, as: 'selfLink' property :type, as: 'type' property :updated, as: 'updated', type: DateTime property :url_destination_details, as: 'urlDestinationDetails', class: Google::Apis::AnalyticsV3::Goal::UrlDestinationDetails, decorator: Google::Apis::AnalyticsV3::Goal::UrlDestinationDetails::Representation property :value, as: 'value' property :visit_num_pages_details, as: 'visitNumPagesDetails', class: Google::Apis::AnalyticsV3::Goal::VisitNumPagesDetails, decorator: Google::Apis::AnalyticsV3::Goal::VisitNumPagesDetails::Representation property :visit_time_on_site_details, as: 'visitTimeOnSiteDetails', class: Google::Apis::AnalyticsV3::Goal::VisitTimeOnSiteDetails, decorator: Google::Apis::AnalyticsV3::Goal::VisitTimeOnSiteDetails::Representation property :web_property_id, as: 'webPropertyId' end class EventDetails # @private class Representation < Google::Apis::Core::JsonRepresentation collection :event_conditions, as: 'eventConditions', class: Google::Apis::AnalyticsV3::Goal::EventDetails::EventCondition, decorator: Google::Apis::AnalyticsV3::Goal::EventDetails::EventCondition::Representation property :use_event_value, as: 'useEventValue' end class EventCondition # @private class Representation < Google::Apis::Core::JsonRepresentation property :comparison_type, as: 'comparisonType' property :comparison_value, :numeric_string => true, as: 'comparisonValue' property :expression, as: 'expression' property :match_type, as: 'matchType' property :type, as: 'type' end end end class ParentLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end class UrlDestinationDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :case_sensitive, as: 'caseSensitive' property :first_step_required, as: 'firstStepRequired' property :match_type, as: 'matchType' collection :steps, as: 'steps', class: Google::Apis::AnalyticsV3::Goal::UrlDestinationDetails::Step, decorator: Google::Apis::AnalyticsV3::Goal::UrlDestinationDetails::Step::Representation property :url, as: 'url' end class Step # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :number, as: 'number' property :url, as: 'url' end end end class VisitNumPagesDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :comparison_type, as: 'comparisonType' property :comparison_value, :numeric_string => true, as: 'comparisonValue' end end class VisitTimeOnSiteDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :comparison_type, as: 'comparisonType' property :comparison_value, :numeric_string => true, as: 'comparisonValue' end end end class Goals # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::Goal, decorator: Google::Apis::AnalyticsV3::Goal::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class IncludeConditions # @private class Representation < Google::Apis::Core::JsonRepresentation property :days_to_look_back, as: 'daysToLookBack' property :is_smart_list, as: 'isSmartList' property :kind, as: 'kind' property :membership_duration_days, as: 'membershipDurationDays' property :segment, as: 'segment' end end class LinkedForeignAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :eligible_for_search, as: 'eligibleForSearch' property :id, as: 'id' property :internal_web_property_id, as: 'internalWebPropertyId' property :kind, as: 'kind' property :linked_account_id, as: 'linkedAccountId' property :remarketing_audience_id, as: 'remarketingAudienceId' property :status, as: 'status' property :type, as: 'type' property :web_property_id, as: 'webPropertyId' end end class McfData # @private class Representation < Google::Apis::Core::JsonRepresentation collection :column_headers, as: 'columnHeaders', class: Google::Apis::AnalyticsV3::McfData::ColumnHeader, decorator: Google::Apis::AnalyticsV3::McfData::ColumnHeader::Representation property :contains_sampled_data, as: 'containsSampledData' property :id, as: 'id' property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :profile_info, as: 'profileInfo', class: Google::Apis::AnalyticsV3::McfData::ProfileInfo, decorator: Google::Apis::AnalyticsV3::McfData::ProfileInfo::Representation property :query, as: 'query', class: Google::Apis::AnalyticsV3::McfData::Query, decorator: Google::Apis::AnalyticsV3::McfData::Query::Representation collection :rows, as: 'rows', :class => Array do include Representable::JSON::Collection items class: Google::Apis::AnalyticsV3::McfData::Row, decorator: Google::Apis::AnalyticsV3::McfData::Row::Representation end property :sample_size, :numeric_string => true, as: 'sampleSize' property :sample_space, :numeric_string => true, as: 'sampleSpace' property :self_link, as: 'selfLink' property :total_results, as: 'totalResults' hash :totals_for_all_results, as: 'totalsForAllResults' end class ColumnHeader # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_type, as: 'columnType' property :data_type, as: 'dataType' property :name, as: 'name' end end class ProfileInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :internal_web_property_id, as: 'internalWebPropertyId' property :profile_id, as: 'profileId' property :profile_name, as: 'profileName' property :table_id, as: 'tableId' property :web_property_id, as: 'webPropertyId' end end class Query # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimensions, as: 'dimensions' property :end_date, as: 'end-date' property :filters, as: 'filters' property :ids, as: 'ids' property :max_results, as: 'max-results' collection :metrics, as: 'metrics' property :sampling_level, as: 'samplingLevel' property :segment, as: 'segment' collection :sort, as: 'sort' property :start_date, as: 'start-date' property :start_index, as: 'start-index' end end class Row # @private class Representation < Google::Apis::Core::JsonRepresentation collection :conversion_path_value, as: 'conversionPathValue', class: Google::Apis::AnalyticsV3::McfData::Row::ConversionPathValue, decorator: Google::Apis::AnalyticsV3::McfData::Row::ConversionPathValue::Representation property :primitive_value, as: 'primitiveValue' end class ConversionPathValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :interaction_type, as: 'interactionType' property :node_value, as: 'nodeValue' end end end end class Profile # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :bot_filtering_enabled, as: 'botFilteringEnabled' property :child_link, as: 'childLink', class: Google::Apis::AnalyticsV3::Profile::ChildLink, decorator: Google::Apis::AnalyticsV3::Profile::ChildLink::Representation property :created, as: 'created', type: DateTime property :currency, as: 'currency' property :default_page, as: 'defaultPage' property :e_commerce_tracking, as: 'eCommerceTracking' property :enhanced_e_commerce_tracking, as: 'enhancedECommerceTracking' property :exclude_query_parameters, as: 'excludeQueryParameters' property :id, as: 'id' property :internal_web_property_id, as: 'internalWebPropertyId' property :kind, as: 'kind' property :name, as: 'name' property :parent_link, as: 'parentLink', class: Google::Apis::AnalyticsV3::Profile::ParentLink, decorator: Google::Apis::AnalyticsV3::Profile::ParentLink::Representation property :permissions, as: 'permissions', class: Google::Apis::AnalyticsV3::Profile::Permissions, decorator: Google::Apis::AnalyticsV3::Profile::Permissions::Representation property :self_link, as: 'selfLink' property :site_search_category_parameters, as: 'siteSearchCategoryParameters' property :site_search_query_parameters, as: 'siteSearchQueryParameters' property :starred, as: 'starred' property :strip_site_search_category_parameters, as: 'stripSiteSearchCategoryParameters' property :strip_site_search_query_parameters, as: 'stripSiteSearchQueryParameters' property :timezone, as: 'timezone' property :type, as: 'type' property :updated, as: 'updated', type: DateTime property :web_property_id, as: 'webPropertyId' property :website_url, as: 'websiteUrl' end class ChildLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end class ParentLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end class Permissions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :effective, as: 'effective' end end end class ProfileFilterLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :filter_ref, as: 'filterRef', class: Google::Apis::AnalyticsV3::FilterRef, decorator: Google::Apis::AnalyticsV3::FilterRef::Representation property :id, as: 'id' property :kind, as: 'kind' property :profile_ref, as: 'profileRef', class: Google::Apis::AnalyticsV3::ProfileRef, decorator: Google::Apis::AnalyticsV3::ProfileRef::Representation property :rank, as: 'rank' property :self_link, as: 'selfLink' end end class ProfileFilterLinks # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::ProfileFilterLink, decorator: Google::Apis::AnalyticsV3::ProfileFilterLink::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class ProfileRef # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :href, as: 'href' property :id, as: 'id' property :internal_web_property_id, as: 'internalWebPropertyId' property :kind, as: 'kind' property :name, as: 'name' property :web_property_id, as: 'webPropertyId' end end class ProfileSummary # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :starred, as: 'starred' property :type, as: 'type' end end class Profiles # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::Profile, decorator: Google::Apis::AnalyticsV3::Profile::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class RealtimeData # @private class Representation < Google::Apis::Core::JsonRepresentation collection :column_headers, as: 'columnHeaders', class: Google::Apis::AnalyticsV3::RealtimeData::ColumnHeader, decorator: Google::Apis::AnalyticsV3::RealtimeData::ColumnHeader::Representation property :id, as: 'id' property :kind, as: 'kind' property :profile_info, as: 'profileInfo', class: Google::Apis::AnalyticsV3::RealtimeData::ProfileInfo, decorator: Google::Apis::AnalyticsV3::RealtimeData::ProfileInfo::Representation property :query, as: 'query', class: Google::Apis::AnalyticsV3::RealtimeData::Query, decorator: Google::Apis::AnalyticsV3::RealtimeData::Query::Representation collection :rows, as: 'rows', :class => Array do include Representable::JSON::Collection items end property :self_link, as: 'selfLink' property :total_results, as: 'totalResults' hash :totals_for_all_results, as: 'totalsForAllResults' end class ColumnHeader # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_type, as: 'columnType' property :data_type, as: 'dataType' property :name, as: 'name' end end class ProfileInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :internal_web_property_id, as: 'internalWebPropertyId' property :profile_id, as: 'profileId' property :profile_name, as: 'profileName' property :table_id, as: 'tableId' property :web_property_id, as: 'webPropertyId' end end class Query # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimensions, as: 'dimensions' property :filters, as: 'filters' property :ids, as: 'ids' property :max_results, as: 'max-results' collection :metrics, as: 'metrics' collection :sort, as: 'sort' end end end class RemarketingAudience # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :audience_definition, as: 'audienceDefinition', class: Google::Apis::AnalyticsV3::RemarketingAudience::AudienceDefinition, decorator: Google::Apis::AnalyticsV3::RemarketingAudience::AudienceDefinition::Representation property :audience_type, as: 'audienceType' property :created, as: 'created', type: DateTime property :description, as: 'description' property :id, as: 'id' property :internal_web_property_id, as: 'internalWebPropertyId' property :kind, as: 'kind' collection :linked_ad_accounts, as: 'linkedAdAccounts', class: Google::Apis::AnalyticsV3::LinkedForeignAccount, decorator: Google::Apis::AnalyticsV3::LinkedForeignAccount::Representation collection :linked_views, as: 'linkedViews' property :name, as: 'name' property :state_based_audience_definition, as: 'stateBasedAudienceDefinition', class: Google::Apis::AnalyticsV3::RemarketingAudience::StateBasedAudienceDefinition, decorator: Google::Apis::AnalyticsV3::RemarketingAudience::StateBasedAudienceDefinition::Representation property :updated, as: 'updated', type: DateTime property :web_property_id, as: 'webPropertyId' end class AudienceDefinition # @private class Representation < Google::Apis::Core::JsonRepresentation property :include_conditions, as: 'includeConditions', class: Google::Apis::AnalyticsV3::IncludeConditions, decorator: Google::Apis::AnalyticsV3::IncludeConditions::Representation end end class StateBasedAudienceDefinition # @private class Representation < Google::Apis::Core::JsonRepresentation property :exclude_conditions, as: 'excludeConditions', class: Google::Apis::AnalyticsV3::RemarketingAudience::StateBasedAudienceDefinition::ExcludeConditions, decorator: Google::Apis::AnalyticsV3::RemarketingAudience::StateBasedAudienceDefinition::ExcludeConditions::Representation property :include_conditions, as: 'includeConditions', class: Google::Apis::AnalyticsV3::IncludeConditions, decorator: Google::Apis::AnalyticsV3::IncludeConditions::Representation end class ExcludeConditions # @private class Representation < Google::Apis::Core::JsonRepresentation property :exclusion_duration, as: 'exclusionDuration' property :segment, as: 'segment' end end end end class RemarketingAudiences # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::RemarketingAudience, decorator: Google::Apis::AnalyticsV3::RemarketingAudience::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class Segment # @private class Representation < Google::Apis::Core::JsonRepresentation property :created, as: 'created', type: DateTime property :definition, as: 'definition' property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :segment_id, as: 'segmentId' property :self_link, as: 'selfLink' property :type, as: 'type' property :updated, as: 'updated', type: DateTime end end class Segments # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::Segment, decorator: Google::Apis::AnalyticsV3::Segment::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class UnsampledReport # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :cloud_storage_download_details, as: 'cloudStorageDownloadDetails', class: Google::Apis::AnalyticsV3::UnsampledReport::CloudStorageDownloadDetails, decorator: Google::Apis::AnalyticsV3::UnsampledReport::CloudStorageDownloadDetails::Representation property :created, as: 'created', type: DateTime property :dimensions, as: 'dimensions' property :download_type, as: 'downloadType' property :drive_download_details, as: 'driveDownloadDetails', class: Google::Apis::AnalyticsV3::UnsampledReport::DriveDownloadDetails, decorator: Google::Apis::AnalyticsV3::UnsampledReport::DriveDownloadDetails::Representation property :end_date, as: 'end-date' property :filters, as: 'filters' property :id, as: 'id' property :kind, as: 'kind' property :metrics, as: 'metrics' property :profile_id, as: 'profileId' property :segment, as: 'segment' property :self_link, as: 'selfLink' property :start_date, as: 'start-date' property :status, as: 'status' property :title, as: 'title' property :updated, as: 'updated', type: DateTime property :web_property_id, as: 'webPropertyId' end class CloudStorageDownloadDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_id, as: 'bucketId' property :obj_id, as: 'objectId' end end class DriveDownloadDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :document_id, as: 'documentId' end end end class UnsampledReports # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::UnsampledReport, decorator: Google::Apis::AnalyticsV3::UnsampledReport::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class Upload # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :custom_data_source_id, as: 'customDataSourceId' collection :errors, as: 'errors' property :id, as: 'id' property :kind, as: 'kind' property :status, as: 'status' property :upload_time, as: 'uploadTime', type: DateTime end end class Uploads # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::Upload, decorator: Google::Apis::AnalyticsV3::Upload::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' end end class UserRef # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' property :id, as: 'id' property :kind, as: 'kind' end end class WebPropertyRef # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :href, as: 'href' property :id, as: 'id' property :internal_web_property_id, as: 'internalWebPropertyId' property :kind, as: 'kind' property :name, as: 'name' end end class WebPropertySummary # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :internal_web_property_id, as: 'internalWebPropertyId' property :kind, as: 'kind' property :level, as: 'level' property :name, as: 'name' collection :profiles, as: 'profiles', class: Google::Apis::AnalyticsV3::ProfileSummary, decorator: Google::Apis::AnalyticsV3::ProfileSummary::Representation property :starred, as: 'starred' property :website_url, as: 'websiteUrl' end end class Webproperties # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AnalyticsV3::Webproperty, decorator: Google::Apis::AnalyticsV3::Webproperty::Representation property :items_per_page, as: 'itemsPerPage' property :kind, as: 'kind' property :next_link, as: 'nextLink' property :previous_link, as: 'previousLink' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' property :username, as: 'username' end end class Webproperty # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :child_link, as: 'childLink', class: Google::Apis::AnalyticsV3::Webproperty::ChildLink, decorator: Google::Apis::AnalyticsV3::Webproperty::ChildLink::Representation property :created, as: 'created', type: DateTime property :default_profile_id, :numeric_string => true, as: 'defaultProfileId' property :id, as: 'id' property :industry_vertical, as: 'industryVertical' property :internal_web_property_id, as: 'internalWebPropertyId' property :kind, as: 'kind' property :level, as: 'level' property :name, as: 'name' property :parent_link, as: 'parentLink', class: Google::Apis::AnalyticsV3::Webproperty::ParentLink, decorator: Google::Apis::AnalyticsV3::Webproperty::ParentLink::Representation property :permissions, as: 'permissions', class: Google::Apis::AnalyticsV3::Webproperty::Permissions, decorator: Google::Apis::AnalyticsV3::Webproperty::Permissions::Representation property :profile_count, as: 'profileCount' property :self_link, as: 'selfLink' property :starred, as: 'starred' property :updated, as: 'updated', type: DateTime property :website_url, as: 'websiteUrl' end class ChildLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end class ParentLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :href, as: 'href' property :type, as: 'type' end end class Permissions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :effective, as: 'effective' end end end end end end google-api-client-0.19.8/generated/google/apis/analytics_v3/classes.rb0000644000004100000410000067261413252673043025714 0ustar www-datawww-data# 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 AnalyticsV3 # JSON template for Analytics account entry. class Account include Google::Apis::Core::Hashable # Child link for an account entry. Points to the list of web properties for this # account. # Corresponds to the JSON property `childLink` # @return [Google::Apis::AnalyticsV3::Account::ChildLink] attr_accessor :child_link # Time the account was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # Account ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for Analytics account. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Account name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Permissions the user has for this account. # Corresponds to the JSON property `permissions` # @return [Google::Apis::AnalyticsV3::Account::Permissions] attr_accessor :permissions # Link for this account. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Indicates whether this account is starred or not. # Corresponds to the JSON property `starred` # @return [Boolean] attr_accessor :starred alias_method :starred?, :starred # Time the account was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @child_link = args[:child_link] if args.key?(:child_link) @created = args[:created] if args.key?(:created) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @permissions = args[:permissions] if args.key?(:permissions) @self_link = args[:self_link] if args.key?(:self_link) @starred = args[:starred] if args.key?(:starred) @updated = args[:updated] if args.key?(:updated) end # Child link for an account entry. Points to the list of web properties for this # account. class ChildLink include Google::Apis::Core::Hashable # Link to the list of web properties for this account. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Type of the child link. Its value is "analytics#webproperties". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end # Permissions the user has for this account. class Permissions include Google::Apis::Core::Hashable # All the permissions that the user has for this account. These include any # implied permissions (e.g., EDIT implies VIEW). # Corresponds to the JSON property `effective` # @return [Array] attr_accessor :effective def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @effective = args[:effective] if args.key?(:effective) end end end # JSON template for a linked account. class AccountRef include Google::Apis::Core::Hashable # Link for this account. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Account ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Analytics account reference. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Account name. # 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) @href = args[:href] if args.key?(:href) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # An AccountSummary collection lists a summary of accounts, properties and views # (profiles) to which the user has access. Each resource in the collection # corresponds to a single AccountSummary. class AccountSummaries include Google::Apis::Core::Hashable # A list of AccountSummaries. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this AccountSummary collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this AccountSummary collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for an Analytics AccountSummary. An AccountSummary is a # lightweight tree comprised of properties/profiles. class AccountSummary include Google::Apis::Core::Hashable # Account ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for Analytics AccountSummary. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Account name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Indicates whether this account is starred or not. # Corresponds to the JSON property `starred` # @return [Boolean] attr_accessor :starred alias_method :starred?, :starred # List of web properties under this account. # Corresponds to the JSON property `webProperties` # @return [Array] attr_accessor :web_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @starred = args[:starred] if args.key?(:starred) @web_properties = args[:web_properties] if args.key?(:web_properties) end end # JSON template for an Analytics account ticket. The account ticket consists of # the ticket ID and the basic information for the account, property and profile. class AccountTicket include Google::Apis::Core::Hashable # JSON template for Analytics account entry. # Corresponds to the JSON property `account` # @return [Google::Apis::AnalyticsV3::Account] attr_accessor :account # Account ticket ID used to access the account ticket. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for account ticket. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # JSON template for an Analytics view (profile). # Corresponds to the JSON property `profile` # @return [Google::Apis::AnalyticsV3::Profile] attr_accessor :profile # Redirect URI where the user will be sent after accepting Terms of Service. # Must be configured in APIs console as a callback URL. # Corresponds to the JSON property `redirectUri` # @return [String] attr_accessor :redirect_uri # JSON template for an Analytics web property. # Corresponds to the JSON property `webproperty` # @return [Google::Apis::AnalyticsV3::Webproperty] attr_accessor :webproperty def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account = args[:account] if args.key?(:account) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @profile = args[:profile] if args.key?(:profile) @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri) @webproperty = args[:webproperty] if args.key?(:webproperty) end end # JSON template for an Analytics account tree requests. The account tree request # is used in the provisioning api to create an account, property, and view ( # profile). It contains the basic information required to make these fields. class AccountTreeRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `accountName` # @return [String] attr_accessor :account_name # # Corresponds to the JSON property `accountSettings` # @return [Google::Apis::AnalyticsV3::AccountTreeRequest::AccountSettings] attr_accessor :account_settings # Resource type for account ticket. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # # Corresponds to the JSON property `profileName` # @return [String] attr_accessor :profile_name # # Corresponds to the JSON property `timezone` # @return [String] attr_accessor :timezone # # Corresponds to the JSON property `webpropertyName` # @return [String] attr_accessor :webproperty_name # # Corresponds to the JSON property `websiteUrl` # @return [String] attr_accessor :website_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_name = args[:account_name] if args.key?(:account_name) @account_settings = args[:account_settings] if args.key?(:account_settings) @kind = args[:kind] if args.key?(:kind) @profile_name = args[:profile_name] if args.key?(:profile_name) @timezone = args[:timezone] if args.key?(:timezone) @webproperty_name = args[:webproperty_name] if args.key?(:webproperty_name) @website_url = args[:website_url] if args.key?(:website_url) end # class AccountSettings include Google::Apis::Core::Hashable # # Corresponds to the JSON property `admobReporting` # @return [Boolean] attr_accessor :admob_reporting alias_method :admob_reporting?, :admob_reporting # # Corresponds to the JSON property `sharingWithGoogleAnySales` # @return [Boolean] attr_accessor :sharing_with_google_any_sales alias_method :sharing_with_google_any_sales?, :sharing_with_google_any_sales # # Corresponds to the JSON property `sharingWithGoogleProducts` # @return [Boolean] attr_accessor :sharing_with_google_products alias_method :sharing_with_google_products?, :sharing_with_google_products # # Corresponds to the JSON property `sharingWithGoogleSales` # @return [Boolean] attr_accessor :sharing_with_google_sales alias_method :sharing_with_google_sales?, :sharing_with_google_sales # # Corresponds to the JSON property `sharingWithGoogleSupport` # @return [Boolean] attr_accessor :sharing_with_google_support alias_method :sharing_with_google_support?, :sharing_with_google_support # # Corresponds to the JSON property `sharingWithOthers` # @return [Boolean] attr_accessor :sharing_with_others alias_method :sharing_with_others?, :sharing_with_others def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @admob_reporting = args[:admob_reporting] if args.key?(:admob_reporting) @sharing_with_google_any_sales = args[:sharing_with_google_any_sales] if args.key?(:sharing_with_google_any_sales) @sharing_with_google_products = args[:sharing_with_google_products] if args.key?(:sharing_with_google_products) @sharing_with_google_sales = args[:sharing_with_google_sales] if args.key?(:sharing_with_google_sales) @sharing_with_google_support = args[:sharing_with_google_support] if args.key?(:sharing_with_google_support) @sharing_with_others = args[:sharing_with_others] if args.key?(:sharing_with_others) end end end # JSON template for an Analytics account tree response. The account tree # response is used in the provisioning api to return the result of creating an # account, property, and view (profile). class AccountTreeResponse include Google::Apis::Core::Hashable # JSON template for Analytics account entry. # Corresponds to the JSON property `account` # @return [Google::Apis::AnalyticsV3::Account] attr_accessor :account # # Corresponds to the JSON property `accountSettings` # @return [Google::Apis::AnalyticsV3::AccountTreeResponse::AccountSettings] attr_accessor :account_settings # Resource type for account ticket. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # JSON template for an Analytics view (profile). # Corresponds to the JSON property `profile` # @return [Google::Apis::AnalyticsV3::Profile] attr_accessor :profile # JSON template for an Analytics web property. # Corresponds to the JSON property `webproperty` # @return [Google::Apis::AnalyticsV3::Webproperty] attr_accessor :webproperty def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account = args[:account] if args.key?(:account) @account_settings = args[:account_settings] if args.key?(:account_settings) @kind = args[:kind] if args.key?(:kind) @profile = args[:profile] if args.key?(:profile) @webproperty = args[:webproperty] if args.key?(:webproperty) end # class AccountSettings include Google::Apis::Core::Hashable # # Corresponds to the JSON property `admobReporting` # @return [Boolean] attr_accessor :admob_reporting alias_method :admob_reporting?, :admob_reporting # # Corresponds to the JSON property `sharingWithGoogleAnySales` # @return [Boolean] attr_accessor :sharing_with_google_any_sales alias_method :sharing_with_google_any_sales?, :sharing_with_google_any_sales # # Corresponds to the JSON property `sharingWithGoogleProducts` # @return [Boolean] attr_accessor :sharing_with_google_products alias_method :sharing_with_google_products?, :sharing_with_google_products # # Corresponds to the JSON property `sharingWithGoogleSales` # @return [Boolean] attr_accessor :sharing_with_google_sales alias_method :sharing_with_google_sales?, :sharing_with_google_sales # # Corresponds to the JSON property `sharingWithGoogleSupport` # @return [Boolean] attr_accessor :sharing_with_google_support alias_method :sharing_with_google_support?, :sharing_with_google_support # # Corresponds to the JSON property `sharingWithOthers` # @return [Boolean] attr_accessor :sharing_with_others alias_method :sharing_with_others?, :sharing_with_others def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @admob_reporting = args[:admob_reporting] if args.key?(:admob_reporting) @sharing_with_google_any_sales = args[:sharing_with_google_any_sales] if args.key?(:sharing_with_google_any_sales) @sharing_with_google_products = args[:sharing_with_google_products] if args.key?(:sharing_with_google_products) @sharing_with_google_sales = args[:sharing_with_google_sales] if args.key?(:sharing_with_google_sales) @sharing_with_google_support = args[:sharing_with_google_support] if args.key?(:sharing_with_google_support) @sharing_with_others = args[:sharing_with_others] if args.key?(:sharing_with_others) end end end # An account collection provides a list of Analytics accounts to which a user # has access. The account collection is the entry point to all management # information. Each resource in the collection corresponds to a single Analytics # account. class Accounts include Google::Apis::Core::Hashable # A list of accounts. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of entries the response can contain, regardless of the # actual number of entries returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Next link for this account collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Previous link for this account collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the entries, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for an AdWords account. class AdWordsAccount include Google::Apis::Core::Hashable # True if auto-tagging is enabled on the AdWords account. Read-only after the # insert operation. # Corresponds to the JSON property `autoTaggingEnabled` # @return [Boolean] attr_accessor :auto_tagging_enabled alias_method :auto_tagging_enabled?, :auto_tagging_enabled # Customer ID. This field is required when creating an AdWords link. # Corresponds to the JSON property `customerId` # @return [String] attr_accessor :customer_id # Resource type for AdWords account. # 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) @auto_tagging_enabled = args[:auto_tagging_enabled] if args.key?(:auto_tagging_enabled) @customer_id = args[:customer_id] if args.key?(:customer_id) @kind = args[:kind] if args.key?(:kind) end end # Request template for the delete upload data request. class DeleteUploadDataRequest include Google::Apis::Core::Hashable # A list of upload UIDs. # Corresponds to the JSON property `customDataImportUids` # @return [Array] attr_accessor :custom_data_import_uids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_data_import_uids = args[:custom_data_import_uids] if args.key?(:custom_data_import_uids) end end # JSON template for a metadata column. class Column include Google::Apis::Core::Hashable # Map of attribute name and value for this column. # Corresponds to the JSON property `attributes` # @return [Hash] attr_accessor :attributes # Column id. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for Analytics column. # 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) @attributes = args[:attributes] if args.key?(:attributes) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) end end # Lists columns (dimensions and metrics) for a particular report type. class Columns include Google::Apis::Core::Hashable # List of attributes names returned by columns. # Corresponds to the JSON property `attributeNames` # @return [Array] attr_accessor :attribute_names # Etag of collection. This etag can be compared with the last response etag to # check if response has changed. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # List of columns for a report type. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Total number of columns returned in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @attribute_names = args[:attribute_names] if args.key?(:attribute_names) @etag = args[:etag] if args.key?(:etag) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @total_results = args[:total_results] if args.key?(:total_results) end end # JSON template for an Analytics custom data source. class CustomDataSource include Google::Apis::Core::Hashable # Account ID to which this custom data source belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # # Corresponds to the JSON property `childLink` # @return [Google::Apis::AnalyticsV3::CustomDataSource::ChildLink] attr_accessor :child_link # Time this custom data source was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # Description of custom data source. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Custom data source ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # # Corresponds to the JSON property `importBehavior` # @return [String] attr_accessor :import_behavior # Resource type for Analytics custom data source. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this custom data source. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parent link for this custom data source. Points to the web property to which # this custom data source belongs. # Corresponds to the JSON property `parentLink` # @return [Google::Apis::AnalyticsV3::CustomDataSource::ParentLink] attr_accessor :parent_link # IDs of views (profiles) linked to the custom data source. # Corresponds to the JSON property `profilesLinked` # @return [Array] attr_accessor :profiles_linked # Collection of schema headers of the custom data source. # Corresponds to the JSON property `schema` # @return [Array] attr_accessor :schema # Link for this Analytics custom data source. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Type of the custom data source. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Time this custom data source was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # Upload type of the custom data source. # Corresponds to the JSON property `uploadType` # @return [String] attr_accessor :upload_type # Web property ID of the form UA-XXXXX-YY to which this custom data source # belongs. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @child_link = args[:child_link] if args.key?(:child_link) @created = args[:created] if args.key?(:created) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @import_behavior = args[:import_behavior] if args.key?(:import_behavior) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @parent_link = args[:parent_link] if args.key?(:parent_link) @profiles_linked = args[:profiles_linked] if args.key?(:profiles_linked) @schema = args[:schema] if args.key?(:schema) @self_link = args[:self_link] if args.key?(:self_link) @type = args[:type] if args.key?(:type) @updated = args[:updated] if args.key?(:updated) @upload_type = args[:upload_type] if args.key?(:upload_type) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end # class ChildLink include Google::Apis::Core::Hashable # Link to the list of daily uploads for this custom data source. Link to the # list of uploads for this custom data source. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Value is "analytics#dailyUploads". Value is "analytics#uploads". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end # Parent link for this custom data source. Points to the web property to which # this custom data source belongs. class ParentLink include Google::Apis::Core::Hashable # Link to the web property to which this custom data source belongs. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Value is "analytics#webproperty". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end end # Lists Analytics custom data sources to which the user has access. Each # resource in the collection corresponds to a single Analytics custom data # source. class CustomDataSources include Google::Apis::Core::Hashable # Collection of custom data sources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this custom data source collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this custom data source collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for Analytics Custom Dimension. class CustomDimension include Google::Apis::Core::Hashable # Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Boolean indicating whether the custom dimension is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Time the custom dimension was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # Custom dimension ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Index of the custom dimension. # Corresponds to the JSON property `index` # @return [Fixnum] attr_accessor :index # Kind value for a custom dimension. Set to "analytics#customDimension". It is a # read-only field. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of the custom dimension. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parent link for the custom dimension. Points to the property to which the # custom dimension belongs. # Corresponds to the JSON property `parentLink` # @return [Google::Apis::AnalyticsV3::CustomDimension::ParentLink] attr_accessor :parent_link # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. # Corresponds to the JSON property `scope` # @return [String] attr_accessor :scope # Link for the custom dimension # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Time the custom dimension was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # Property ID. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @created = args[:created] if args.key?(:created) @id = args[:id] if args.key?(:id) @index = args[:index] if args.key?(:index) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @parent_link = args[:parent_link] if args.key?(:parent_link) @scope = args[:scope] if args.key?(:scope) @self_link = args[:self_link] if args.key?(:self_link) @updated = args[:updated] if args.key?(:updated) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end # Parent link for the custom dimension. Points to the property to which the # custom dimension belongs. class ParentLink include Google::Apis::Core::Hashable # Link to the property to which the custom dimension belongs. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Type of the parent link. Set to "analytics#webproperty". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end end # A custom dimension collection lists Analytics custom dimensions to which the # user has access. Each resource in the collection corresponds to a single # Analytics custom dimension. class CustomDimensions include Google::Apis::Core::Hashable # Collection of custom dimensions. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this custom dimension collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this custom dimension collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for Analytics Custom Metric. class CustomMetric include Google::Apis::Core::Hashable # Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Boolean indicating whether the custom metric is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Time the custom metric was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # Custom metric ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Index of the custom metric. # Corresponds to the JSON property `index` # @return [Fixnum] attr_accessor :index # Kind value for a custom metric. Set to "analytics#customMetric". It is a read- # only field. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Max value of custom metric. # Corresponds to the JSON property `max_value` # @return [String] attr_accessor :max_value # Min value of custom metric. # Corresponds to the JSON property `min_value` # @return [String] attr_accessor :min_value # Name of the custom metric. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parent link for the custom metric. Points to the property to which the custom # metric belongs. # Corresponds to the JSON property `parentLink` # @return [Google::Apis::AnalyticsV3::CustomMetric::ParentLink] attr_accessor :parent_link # Scope of the custom metric: HIT or PRODUCT. # Corresponds to the JSON property `scope` # @return [String] attr_accessor :scope # Link for the custom metric # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Data type of custom metric. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Time the custom metric was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # Property ID. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @created = args[:created] if args.key?(:created) @id = args[:id] if args.key?(:id) @index = args[:index] if args.key?(:index) @kind = args[:kind] if args.key?(:kind) @max_value = args[:max_value] if args.key?(:max_value) @min_value = args[:min_value] if args.key?(:min_value) @name = args[:name] if args.key?(:name) @parent_link = args[:parent_link] if args.key?(:parent_link) @scope = args[:scope] if args.key?(:scope) @self_link = args[:self_link] if args.key?(:self_link) @type = args[:type] if args.key?(:type) @updated = args[:updated] if args.key?(:updated) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end # Parent link for the custom metric. Points to the property to which the custom # metric belongs. class ParentLink include Google::Apis::Core::Hashable # Link to the property to which the custom metric belongs. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Type of the parent link. Set to "analytics#webproperty". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end end # A custom metric collection lists Analytics custom metrics to which the user # has access. Each resource in the collection corresponds to a single Analytics # custom metric. class CustomMetrics include Google::Apis::Core::Hashable # Collection of custom metrics. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this custom metric collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this custom metric collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for Analytics Entity AdWords Link. class EntityAdWordsLink include Google::Apis::Core::Hashable # A list of AdWords client accounts. These cannot be MCC accounts. This field is # required when creating an AdWords link. It cannot be empty. # Corresponds to the JSON property `adWordsAccounts` # @return [Array] attr_accessor :ad_words_accounts # Web property being linked. # Corresponds to the JSON property `entity` # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink::Entity] attr_accessor :entity # Entity AdWords link ID # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for entity AdWords link. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of the link. This field is required when creating an AdWords link. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # IDs of linked Views (Profiles) represented as strings. # Corresponds to the JSON property `profileIds` # @return [Array] attr_accessor :profile_ids # URL link for this Google Analytics - Google AdWords link. # 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) @ad_words_accounts = args[:ad_words_accounts] if args.key?(:ad_words_accounts) @entity = args[:entity] if args.key?(:entity) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @profile_ids = args[:profile_ids] if args.key?(:profile_ids) @self_link = args[:self_link] if args.key?(:self_link) end # Web property being linked. class Entity include Google::Apis::Core::Hashable # JSON template for a web property reference. # Corresponds to the JSON property `webPropertyRef` # @return [Google::Apis::AnalyticsV3::WebPropertyRef] attr_accessor :web_property_ref def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @web_property_ref = args[:web_property_ref] if args.key?(:web_property_ref) end end end # An entity AdWords link collection provides a list of GA-AdWords links Each # resource in this collection corresponds to a single link. class EntityAdWordsLinks include Google::Apis::Core::Hashable # A list of entity AdWords links. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of entries the response can contain, regardless of the # actual number of entries returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Next link for this AdWords link collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Previous link for this AdWords link collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the entries, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) end end # JSON template for an Analytics Entity-User Link. Returns permissions that a # user has for an entity. class EntityUserLink include Google::Apis::Core::Hashable # Entity for this link. It can be an account, a web property, or a view (profile) # . # Corresponds to the JSON property `entity` # @return [Google::Apis::AnalyticsV3::EntityUserLink::Entity] attr_accessor :entity # Entity user link ID # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for entity user link. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Permissions the user has for this entity. # Corresponds to the JSON property `permissions` # @return [Google::Apis::AnalyticsV3::EntityUserLink::Permissions] attr_accessor :permissions # Self link for this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # JSON template for a user reference. # Corresponds to the JSON property `userRef` # @return [Google::Apis::AnalyticsV3::UserRef] attr_accessor :user_ref def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity = args[:entity] if args.key?(:entity) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @permissions = args[:permissions] if args.key?(:permissions) @self_link = args[:self_link] if args.key?(:self_link) @user_ref = args[:user_ref] if args.key?(:user_ref) end # Entity for this link. It can be an account, a web property, or a view (profile) # . class Entity include Google::Apis::Core::Hashable # JSON template for a linked account. # Corresponds to the JSON property `accountRef` # @return [Google::Apis::AnalyticsV3::AccountRef] attr_accessor :account_ref # JSON template for a linked view (profile). # Corresponds to the JSON property `profileRef` # @return [Google::Apis::AnalyticsV3::ProfileRef] attr_accessor :profile_ref # JSON template for a web property reference. # Corresponds to the JSON property `webPropertyRef` # @return [Google::Apis::AnalyticsV3::WebPropertyRef] attr_accessor :web_property_ref def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_ref = args[:account_ref] if args.key?(:account_ref) @profile_ref = args[:profile_ref] if args.key?(:profile_ref) @web_property_ref = args[:web_property_ref] if args.key?(:web_property_ref) end end # Permissions the user has for this entity. class Permissions include Google::Apis::Core::Hashable # Effective permissions represent all the permissions that a user has for this # entity. These include any implied permissions (e.g., EDIT implies VIEW) or # inherited permissions from the parent entity. Effective permissions are read- # only. # Corresponds to the JSON property `effective` # @return [Array] attr_accessor :effective # Permissions that a user has been assigned at this very level. Does not include # any implied or inherited permissions. Local permissions are modifiable. # Corresponds to the JSON property `local` # @return [Array] attr_accessor :local def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @effective = args[:effective] if args.key?(:effective) @local = args[:local] if args.key?(:local) end end end # An entity user link collection provides a list of Analytics ACL links Each # resource in this collection corresponds to a single link. class EntityUserLinks include Google::Apis::Core::Hashable # A list of entity user links. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of entries the response can contain, regardless of the # actual number of entries returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Next link for this account collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Previous link for this account collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the entries, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) end end # JSON template for Analytics experiment resource. class Experiment include Google::Apis::Core::Hashable # Account ID to which this experiment belongs. This field is read-only. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Time the experiment was created. This field is read-only. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # Notes about this experiment. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # If true, the end user will be able to edit the experiment via the Google # Analytics user interface. # Corresponds to the JSON property `editableInGaUi` # @return [Boolean] attr_accessor :editable_in_ga_ui alias_method :editable_in_ga_ui?, :editable_in_ga_ui # The ending time of the experiment (the time the status changed from RUNNING to # ENDED). This field is present only if the experiment has ended. This field is # read-only. # Corresponds to the JSON property `endTime` # @return [DateTime] attr_accessor :end_time # Boolean specifying whether to distribute traffic evenly across all variations. # If the value is False, content experiments follows the default behavior of # adjusting traffic dynamically based on variation performance. Optional -- # defaults to False. This field may not be changed for an experiment whose # status is ENDED. # Corresponds to the JSON property `equalWeighting` # @return [Boolean] attr_accessor :equal_weighting alias_method :equal_weighting?, :equal_weighting # Experiment ID. Required for patch and update. Disallowed for create. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Internal ID for the web property to which this experiment belongs. This field # is read-only. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # Resource type for an Analytics experiment. This field is read-only. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # An integer number in [3, 90]. Specifies the minimum length of the experiment. # Can be changed for a running experiment. This field may not be changed for an # experiments whose status is ENDED. # Corresponds to the JSON property `minimumExperimentLengthInDays` # @return [Fixnum] attr_accessor :minimum_experiment_length_in_days # Experiment name. This field may not be changed for an experiment whose status # is ENDED. This field is required when creating an experiment. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The metric that the experiment is optimizing. Valid values: "ga:goal(n) # Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue" # , "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga: # transactionRevenue". This field is required if status is "RUNNING" and # servingFramework is one of "REDIRECT" or "API". # Corresponds to the JSON property `objectiveMetric` # @return [String] attr_accessor :objective_metric # Whether the objectiveMetric should be minimized or maximized. Possible values: # "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified # without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED" # . # Corresponds to the JSON property `optimizationType` # @return [String] attr_accessor :optimization_type # Parent link for an experiment. Points to the view (profile) to which this # experiment belongs. # Corresponds to the JSON property `parentLink` # @return [Google::Apis::AnalyticsV3::Experiment::ParentLink] attr_accessor :parent_link # View (Profile) ID to which this experiment belongs. This field is read-only. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", " # EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". " # ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner # was projected to be found. If the experiment status is changed via the API to # ENDED this field is set to STOPPED_BY_USER. This field is read-only. # Corresponds to the JSON property `reasonExperimentEnded` # @return [String] attr_accessor :reason_experiment_ended # Boolean specifying whether variations URLS are rewritten to match those of the # original. This field may not be changed for an experiments whose status is # ENDED. # Corresponds to the JSON property `rewriteVariationUrlsAsOriginal` # @return [Boolean] attr_accessor :rewrite_variation_urls_as_original alias_method :rewrite_variation_urls_as_original?, :rewrite_variation_urls_as_original # Link for this experiment. This field is read-only. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The framework used to serve the experiment variations and evaluate the results. # One of: # - REDIRECT: Google Analytics redirects traffic to different variation pages, # reports the chosen variation and evaluates the results. # - API: Google Analytics chooses and reports the variation to serve and # evaluates the results; the caller is responsible for serving the selected # variation. # - EXTERNAL: The variations will be served externally and the chosen variation # reported to Google Analytics. The caller is responsible for serving the # selected variation and evaluating the results. # Corresponds to the JSON property `servingFramework` # @return [String] attr_accessor :serving_framework # The snippet of code to include on the control page(s). This field is read-only. # Corresponds to the JSON property `snippet` # @return [String] attr_accessor :snippet # The starting time of the experiment (the time the status changed from # READY_TO_RUN to RUNNING). This field is present only if the experiment has # started. This field is read-only. # Corresponds to the JSON property `startTime` # @return [DateTime] attr_accessor :start_time # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED" # . Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. # This field is required when creating an experiment. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # A floating-point number in (0, 1]. Specifies the fraction of the traffic that # participates in the experiment. Can be changed for a running experiment. This # field may not be changed for an experiments whose status is ENDED. # Corresponds to the JSON property `trafficCoverage` # @return [Float] attr_accessor :traffic_coverage # Time the experiment was last modified. This field is read-only. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # Array of variations. The first variation in the array is the original. The # number of variations may not change once an experiment is in the RUNNING state. # At least two variations are required before status can be set to RUNNING. # Corresponds to the JSON property `variations` # @return [Array] attr_accessor :variations # Web property ID to which this experiment belongs. The web property ID is of # the form UA-XXXXX-YY. This field is read-only. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id # A floating-point number in (0, 1). Specifies the necessary confidence level to # choose a winner. This field may not be changed for an experiments whose status # is ENDED. # Corresponds to the JSON property `winnerConfidenceLevel` # @return [Float] attr_accessor :winner_confidence_level # Boolean specifying whether a winner has been found for this experiment. This # field is read-only. # Corresponds to the JSON property `winnerFound` # @return [Boolean] attr_accessor :winner_found alias_method :winner_found?, :winner_found def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @created = args[:created] if args.key?(:created) @description = args[:description] if args.key?(:description) @editable_in_ga_ui = args[:editable_in_ga_ui] if args.key?(:editable_in_ga_ui) @end_time = args[:end_time] if args.key?(:end_time) @equal_weighting = args[:equal_weighting] if args.key?(:equal_weighting) @id = args[:id] if args.key?(:id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @kind = args[:kind] if args.key?(:kind) @minimum_experiment_length_in_days = args[:minimum_experiment_length_in_days] if args.key?(:minimum_experiment_length_in_days) @name = args[:name] if args.key?(:name) @objective_metric = args[:objective_metric] if args.key?(:objective_metric) @optimization_type = args[:optimization_type] if args.key?(:optimization_type) @parent_link = args[:parent_link] if args.key?(:parent_link) @profile_id = args[:profile_id] if args.key?(:profile_id) @reason_experiment_ended = args[:reason_experiment_ended] if args.key?(:reason_experiment_ended) @rewrite_variation_urls_as_original = args[:rewrite_variation_urls_as_original] if args.key?(:rewrite_variation_urls_as_original) @self_link = args[:self_link] if args.key?(:self_link) @serving_framework = args[:serving_framework] if args.key?(:serving_framework) @snippet = args[:snippet] if args.key?(:snippet) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @traffic_coverage = args[:traffic_coverage] if args.key?(:traffic_coverage) @updated = args[:updated] if args.key?(:updated) @variations = args[:variations] if args.key?(:variations) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) @winner_confidence_level = args[:winner_confidence_level] if args.key?(:winner_confidence_level) @winner_found = args[:winner_found] if args.key?(:winner_found) end # Parent link for an experiment. Points to the view (profile) to which this # experiment belongs. class ParentLink include Google::Apis::Core::Hashable # Link to the view (profile) to which this experiment belongs. This field is # read-only. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Value is "analytics#profile". This field is read-only. # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end # class Variation include Google::Apis::Core::Hashable # The name of the variation. This field is required when creating an experiment. # This field may not be changed for an experiment whose status is ENDED. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE # variations are not served. This field may not be changed for an experiment # whose status is ENDED. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The URL of the variation. This field may not be changed for an experiment # whose status is RUNNING or ENDED. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Weight that this variation should receive. Only present if the experiment is # running. This field is read-only. # Corresponds to the JSON property `weight` # @return [Float] attr_accessor :weight # True if the experiment has ended and this variation performed (statistically) # significantly better than the original. This field is read-only. # Corresponds to the JSON property `won` # @return [Boolean] attr_accessor :won alias_method :won?, :won def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @status = args[:status] if args.key?(:status) @url = args[:url] if args.key?(:url) @weight = args[:weight] if args.key?(:weight) @won = args[:won] if args.key?(:won) end end end # An experiment collection lists Analytics experiments to which the user has # access. Each view (profile) can have a set of experiments. Each resource in # the Experiment collection corresponds to a single Analytics experiment. class Experiments include Google::Apis::Core::Hashable # A list of experiments. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this experiment collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this experiment collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of # resources in the result. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for an Analytics account filter. class Filter include Google::Apis::Core::Hashable # Account ID to which this filter belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Details for the filter of the type ADVANCED. # Corresponds to the JSON property `advancedDetails` # @return [Google::Apis::AnalyticsV3::Filter::AdvancedDetails] attr_accessor :advanced_details # Time this filter was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # JSON template for an Analytics filter expression. # Corresponds to the JSON property `excludeDetails` # @return [Google::Apis::AnalyticsV3::FilterExpression] attr_accessor :exclude_details # Filter ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # JSON template for an Analytics filter expression. # Corresponds to the JSON property `includeDetails` # @return [Google::Apis::AnalyticsV3::FilterExpression] attr_accessor :include_details # Resource type for Analytics filter. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Details for the filter of the type LOWER. # Corresponds to the JSON property `lowercaseDetails` # @return [Google::Apis::AnalyticsV3::Filter::LowercaseDetails] attr_accessor :lowercase_details # Name of this filter. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parent link for this filter. Points to the account to which this filter # belongs. # Corresponds to the JSON property `parentLink` # @return [Google::Apis::AnalyticsV3::Filter::ParentLink] attr_accessor :parent_link # Details for the filter of the type SEARCH_AND_REPLACE. # Corresponds to the JSON property `searchAndReplaceDetails` # @return [Google::Apis::AnalyticsV3::Filter::SearchAndReplaceDetails] attr_accessor :search_and_replace_details # Link for this filter. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, # UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Time this filter was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # Details for the filter of the type UPPER. # Corresponds to the JSON property `uppercaseDetails` # @return [Google::Apis::AnalyticsV3::Filter::UppercaseDetails] attr_accessor :uppercase_details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advanced_details = args[:advanced_details] if args.key?(:advanced_details) @created = args[:created] if args.key?(:created) @exclude_details = args[:exclude_details] if args.key?(:exclude_details) @id = args[:id] if args.key?(:id) @include_details = args[:include_details] if args.key?(:include_details) @kind = args[:kind] if args.key?(:kind) @lowercase_details = args[:lowercase_details] if args.key?(:lowercase_details) @name = args[:name] if args.key?(:name) @parent_link = args[:parent_link] if args.key?(:parent_link) @search_and_replace_details = args[:search_and_replace_details] if args.key?(:search_and_replace_details) @self_link = args[:self_link] if args.key?(:self_link) @type = args[:type] if args.key?(:type) @updated = args[:updated] if args.key?(:updated) @uppercase_details = args[:uppercase_details] if args.key?(:uppercase_details) end # Details for the filter of the type ADVANCED. class AdvancedDetails include Google::Apis::Core::Hashable # Indicates if the filter expressions are case sensitive. # Corresponds to the JSON property `caseSensitive` # @return [Boolean] attr_accessor :case_sensitive alias_method :case_sensitive?, :case_sensitive # Expression to extract from field A. # Corresponds to the JSON property `extractA` # @return [String] attr_accessor :extract_a # Expression to extract from field B. # Corresponds to the JSON property `extractB` # @return [String] attr_accessor :extract_b # Field A. # Corresponds to the JSON property `fieldA` # @return [String] attr_accessor :field_a # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. # Corresponds to the JSON property `fieldAIndex` # @return [Fixnum] attr_accessor :field_a_index # Indicates if field A is required to match. # Corresponds to the JSON property `fieldARequired` # @return [Boolean] attr_accessor :field_a_required alias_method :field_a_required?, :field_a_required # Field B. # Corresponds to the JSON property `fieldB` # @return [String] attr_accessor :field_b # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. # Corresponds to the JSON property `fieldBIndex` # @return [Fixnum] attr_accessor :field_b_index # Indicates if field B is required to match. # Corresponds to the JSON property `fieldBRequired` # @return [Boolean] attr_accessor :field_b_required alias_method :field_b_required?, :field_b_required # Expression used to construct the output value. # Corresponds to the JSON property `outputConstructor` # @return [String] attr_accessor :output_constructor # Output field. # Corresponds to the JSON property `outputToField` # @return [String] attr_accessor :output_to_field # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. # Corresponds to the JSON property `outputToFieldIndex` # @return [Fixnum] attr_accessor :output_to_field_index # Indicates if the existing value of the output field, if any, should be # overridden by the output expression. # Corresponds to the JSON property `overrideOutputField` # @return [Boolean] attr_accessor :override_output_field alias_method :override_output_field?, :override_output_field def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive) @extract_a = args[:extract_a] if args.key?(:extract_a) @extract_b = args[:extract_b] if args.key?(:extract_b) @field_a = args[:field_a] if args.key?(:field_a) @field_a_index = args[:field_a_index] if args.key?(:field_a_index) @field_a_required = args[:field_a_required] if args.key?(:field_a_required) @field_b = args[:field_b] if args.key?(:field_b) @field_b_index = args[:field_b_index] if args.key?(:field_b_index) @field_b_required = args[:field_b_required] if args.key?(:field_b_required) @output_constructor = args[:output_constructor] if args.key?(:output_constructor) @output_to_field = args[:output_to_field] if args.key?(:output_to_field) @output_to_field_index = args[:output_to_field_index] if args.key?(:output_to_field_index) @override_output_field = args[:override_output_field] if args.key?(:override_output_field) end end # Details for the filter of the type LOWER. class LowercaseDetails include Google::Apis::Core::Hashable # Field to use in the filter. # Corresponds to the JSON property `field` # @return [String] attr_accessor :field # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. # Corresponds to the JSON property `fieldIndex` # @return [Fixnum] attr_accessor :field_index def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) @field_index = args[:field_index] if args.key?(:field_index) end end # Parent link for this filter. Points to the account to which this filter # belongs. class ParentLink include Google::Apis::Core::Hashable # Link to the account to which this filter belongs. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Value is "analytics#account". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end # Details for the filter of the type SEARCH_AND_REPLACE. class SearchAndReplaceDetails include Google::Apis::Core::Hashable # Determines if the filter is case sensitive. # Corresponds to the JSON property `caseSensitive` # @return [Boolean] attr_accessor :case_sensitive alias_method :case_sensitive?, :case_sensitive # Field to use in the filter. # Corresponds to the JSON property `field` # @return [String] attr_accessor :field # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. # Corresponds to the JSON property `fieldIndex` # @return [Fixnum] attr_accessor :field_index # Term to replace the search term with. # Corresponds to the JSON property `replaceString` # @return [String] attr_accessor :replace_string # Term to search. # Corresponds to the JSON property `searchString` # @return [String] attr_accessor :search_string def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive) @field = args[:field] if args.key?(:field) @field_index = args[:field_index] if args.key?(:field_index) @replace_string = args[:replace_string] if args.key?(:replace_string) @search_string = args[:search_string] if args.key?(:search_string) end end # Details for the filter of the type UPPER. class UppercaseDetails include Google::Apis::Core::Hashable # Field to use in the filter. # Corresponds to the JSON property `field` # @return [String] attr_accessor :field # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. # Corresponds to the JSON property `fieldIndex` # @return [Fixnum] attr_accessor :field_index def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) @field_index = args[:field_index] if args.key?(:field_index) end end end # JSON template for an Analytics filter expression. class FilterExpression include Google::Apis::Core::Hashable # Determines if the filter is case sensitive. # Corresponds to the JSON property `caseSensitive` # @return [Boolean] attr_accessor :case_sensitive alias_method :case_sensitive?, :case_sensitive # Filter expression value # Corresponds to the JSON property `expressionValue` # @return [String] attr_accessor :expression_value # Field to filter. Possible values: # - Content and Traffic # - PAGE_REQUEST_URI, # - PAGE_HOSTNAME, # - PAGE_TITLE, # - REFERRAL, # - COST_DATA_URI (Campaign target URL), # - HIT_TYPE, # - INTERNAL_SEARCH_TERM, # - INTERNAL_SEARCH_TYPE, # - SOURCE_PROPERTY_TRACKING_ID, # - Campaign or AdGroup # - CAMPAIGN_SOURCE, # - CAMPAIGN_MEDIUM, # - CAMPAIGN_NAME, # - CAMPAIGN_AD_GROUP, # - CAMPAIGN_TERM, # - CAMPAIGN_CONTENT, # - CAMPAIGN_CODE, # - CAMPAIGN_REFERRAL_PATH, # - E-Commerce # - TRANSACTION_COUNTRY, # - TRANSACTION_REGION, # - TRANSACTION_CITY, # - TRANSACTION_AFFILIATION (Store or order location), # - ITEM_NAME, # - ITEM_CODE, # - ITEM_VARIATION, # - TRANSACTION_ID, # - TRANSACTION_CURRENCY_CODE, # - PRODUCT_ACTION_TYPE, # - Audience/Users # - BROWSER, # - BROWSER_VERSION, # - BROWSER_SIZE, # - PLATFORM, # - PLATFORM_VERSION, # - LANGUAGE, # - SCREEN_RESOLUTION, # - SCREEN_COLORS, # - JAVA_ENABLED (Boolean Field), # - FLASH_VERSION, # - GEO_SPEED (Connection speed), # - VISITOR_TYPE, # - GEO_ORGANIZATION (ISP organization), # - GEO_DOMAIN, # - GEO_IP_ADDRESS, # - GEO_IP_VERSION, # - Location # - GEO_COUNTRY, # - GEO_REGION, # - GEO_CITY, # - Event # - EVENT_CATEGORY, # - EVENT_ACTION, # - EVENT_LABEL, # - Other # - CUSTOM_FIELD_1, # - CUSTOM_FIELD_2, # - USER_DEFINED_VALUE, # - Application # - APP_ID, # - APP_INSTALLER_ID, # - APP_NAME, # - APP_VERSION, # - SCREEN, # - IS_APP (Boolean Field), # - IS_FATAL_EXCEPTION (Boolean Field), # - EXCEPTION_DESCRIPTION, # - Mobile device # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), # - DEVICE_CATEGORY, # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), # - MOBILE_BRAND_NAME, # - MOBILE_MODEL_NAME, # - MOBILE_MARKETING_NAME, # - MOBILE_POINTING_METHOD, # - Social # - SOCIAL_NETWORK, # - SOCIAL_ACTION, # - SOCIAL_ACTION_TARGET, # - Custom dimension # - CUSTOM_DIMENSION (See accompanying field index), # Corresponds to the JSON property `field` # @return [String] attr_accessor :field # The Index of the custom dimension. Set only if the field is a is # CUSTOM_DIMENSION. # Corresponds to the JSON property `fieldIndex` # @return [Fixnum] attr_accessor :field_index # Kind value for filter expression # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, # CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or # PAGE_HOSTNAME filters can use any match type; all other filters must use # MATCHES. # Corresponds to the JSON property `matchType` # @return [String] attr_accessor :match_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive) @expression_value = args[:expression_value] if args.key?(:expression_value) @field = args[:field] if args.key?(:field) @field_index = args[:field_index] if args.key?(:field_index) @kind = args[:kind] if args.key?(:kind) @match_type = args[:match_type] if args.key?(:match_type) end end # JSON template for a profile filter link. class FilterRef include Google::Apis::Core::Hashable # Account ID to which this filter belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Link for this filter. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Filter ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind value for filter reference. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this filter. # 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) @account_id = args[:account_id] if args.key?(:account_id) @href = args[:href] if args.key?(:href) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # A filter collection lists filters created by users in an Analytics account. # Each resource in the collection corresponds to a filter. class Filters include Google::Apis::Core::Hashable # A list of filters. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1,000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this filter collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this filter collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # Analytics data for a given view (profile). class GaData include Google::Apis::Core::Hashable # Column headers that list dimension names followed by the metric names. The # order of dimensions and metrics is same as specified in the request. # Corresponds to the JSON property `columnHeaders` # @return [Array] attr_accessor :column_headers # Determines if Analytics data contains samples. # Corresponds to the JSON property `containsSampledData` # @return [Boolean] attr_accessor :contains_sampled_data alias_method :contains_sampled_data?, :contains_sampled_data # The last refreshed time in seconds for Analytics data. # Corresponds to the JSON property `dataLastRefreshed` # @return [Fixnum] attr_accessor :data_last_refreshed # # Corresponds to the JSON property `dataTable` # @return [Google::Apis::AnalyticsV3::GaData::DataTable] attr_accessor :data_table # Unique ID for this data response. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The maximum number of rows the response can contain, regardless of the actual # number of rows returned. Its value ranges from 1 to 10,000 with a value of # 1000 by default, or otherwise specified by the max-results query parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Resource type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this Analytics data query. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this Analytics data query. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # Information for the view (profile), for which the Analytics data was requested. # Corresponds to the JSON property `profileInfo` # @return [Google::Apis::AnalyticsV3::GaData::ProfileInfo] attr_accessor :profile_info # Analytics data request query parameters. # Corresponds to the JSON property `query` # @return [Google::Apis::AnalyticsV3::GaData::Query] attr_accessor :query # Analytics data rows, where each row contains a list of dimension values # followed by the metric values. The order of dimensions and metrics is same as # specified in the request. # Corresponds to the JSON property `rows` # @return [Array>] attr_accessor :rows # The number of samples used to calculate the result. # Corresponds to the JSON property `sampleSize` # @return [Fixnum] attr_accessor :sample_size # Total size of the sample space from which the samples were selected. # Corresponds to the JSON property `sampleSpace` # @return [Fixnum] attr_accessor :sample_space # Link to this page. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The total number of rows for the query, regardless of the number of rows in # the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Total values for the requested metrics over all the results, not just the # results returned in this response. The order of the metric totals is same as # the metric order specified in the request. # Corresponds to the JSON property `totalsForAllResults` # @return [Hash] attr_accessor :totals_for_all_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_headers = args[:column_headers] if args.key?(:column_headers) @contains_sampled_data = args[:contains_sampled_data] if args.key?(:contains_sampled_data) @data_last_refreshed = args[:data_last_refreshed] if args.key?(:data_last_refreshed) @data_table = args[:data_table] if args.key?(:data_table) @id = args[:id] if args.key?(:id) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @profile_info = args[:profile_info] if args.key?(:profile_info) @query = args[:query] if args.key?(:query) @rows = args[:rows] if args.key?(:rows) @sample_size = args[:sample_size] if args.key?(:sample_size) @sample_space = args[:sample_space] if args.key?(:sample_space) @self_link = args[:self_link] if args.key?(:self_link) @total_results = args[:total_results] if args.key?(:total_results) @totals_for_all_results = args[:totals_for_all_results] if args.key?(:totals_for_all_results) end # class ColumnHeader include Google::Apis::Core::Hashable # Column Type. Either DIMENSION or METRIC. # Corresponds to the JSON property `columnType` # @return [String] attr_accessor :column_type # Data type. Dimension column headers have only STRING as the data type. Metric # column headers have data types for metric values such as INTEGER, DOUBLE, # CURRENCY etc. # Corresponds to the JSON property `dataType` # @return [String] attr_accessor :data_type # Column name. # 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) @column_type = args[:column_type] if args.key?(:column_type) @data_type = args[:data_type] if args.key?(:data_type) @name = args[:name] if args.key?(:name) end end # class DataTable include Google::Apis::Core::Hashable # # Corresponds to the JSON property `cols` # @return [Array] attr_accessor :cols # # Corresponds to the JSON property `rows` # @return [Array] attr_accessor :rows def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cols = args[:cols] if args.key?(:cols) @rows = args[:rows] if args.key?(:rows) end # class Col include Google::Apis::Core::Hashable # # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # # Corresponds to the JSON property `label` # @return [String] attr_accessor :label # # 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) @id = args[:id] if args.key?(:id) @label = args[:label] if args.key?(:label) @type = args[:type] if args.key?(:type) end end # class Row include Google::Apis::Core::Hashable # # Corresponds to the JSON property `c` # @return [Array] attr_accessor :c def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @c = args[:c] if args.key?(:c) end # class C include Google::Apis::Core::Hashable # # Corresponds to the JSON property `v` # @return [String] attr_accessor :v def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @v = args[:v] if args.key?(:v) end end end end # Information for the view (profile), for which the Analytics data was requested. class ProfileInfo include Google::Apis::Core::Hashable # Account ID to which this view (profile) belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Internal ID for the web property to which this view (profile) belongs. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # View (Profile) ID. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id # View (Profile) name. # Corresponds to the JSON property `profileName` # @return [String] attr_accessor :profile_name # Table ID for view (profile). # Corresponds to the JSON property `tableId` # @return [String] attr_accessor :table_id # Web Property ID to which this view (profile) belongs. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @profile_id = args[:profile_id] if args.key?(:profile_id) @profile_name = args[:profile_name] if args.key?(:profile_name) @table_id = args[:table_id] if args.key?(:table_id) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end end # Analytics data request query parameters. class Query include Google::Apis::Core::Hashable # List of analytics dimensions. # Corresponds to the JSON property `dimensions` # @return [String] attr_accessor :dimensions # End date. # Corresponds to the JSON property `end-date` # @return [String] attr_accessor :end_date # Comma-separated list of dimension or metric filters. # Corresponds to the JSON property `filters` # @return [String] attr_accessor :filters # Unique table ID. # Corresponds to the JSON property `ids` # @return [String] attr_accessor :ids # Maximum results per page. # Corresponds to the JSON property `max-results` # @return [Fixnum] attr_accessor :max_results # List of analytics metrics. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Desired sampling level # Corresponds to the JSON property `samplingLevel` # @return [String] attr_accessor :sampling_level # Analytics advanced segment. # Corresponds to the JSON property `segment` # @return [String] attr_accessor :segment # List of dimensions or metrics based on which Analytics data is sorted. # Corresponds to the JSON property `sort` # @return [Array] attr_accessor :sort # Start date. # Corresponds to the JSON property `start-date` # @return [String] attr_accessor :start_date # Start index. # Corresponds to the JSON property `start-index` # @return [Fixnum] attr_accessor :start_index def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimensions = args[:dimensions] if args.key?(:dimensions) @end_date = args[:end_date] if args.key?(:end_date) @filters = args[:filters] if args.key?(:filters) @ids = args[:ids] if args.key?(:ids) @max_results = args[:max_results] if args.key?(:max_results) @metrics = args[:metrics] if args.key?(:metrics) @sampling_level = args[:sampling_level] if args.key?(:sampling_level) @segment = args[:segment] if args.key?(:segment) @sort = args[:sort] if args.key?(:sort) @start_date = args[:start_date] if args.key?(:start_date) @start_index = args[:start_index] if args.key?(:start_index) end end end # JSON template for Analytics goal resource. class Goal include Google::Apis::Core::Hashable # Account ID to which this goal belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Determines whether this goal is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Time this goal was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # Details for the goal of the type EVENT. # Corresponds to the JSON property `eventDetails` # @return [Google::Apis::AnalyticsV3::Goal::EventDetails] attr_accessor :event_details # Goal ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Internal ID for the web property to which this goal belongs. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # Resource type for an Analytics goal. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Goal name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parent link for a goal. Points to the view (profile) to which this goal # belongs. # Corresponds to the JSON property `parentLink` # @return [Google::Apis::AnalyticsV3::Goal::ParentLink] attr_accessor :parent_link # View (Profile) ID to which this goal belongs. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id # Link for this goal. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, # VISIT_NUM_PAGES, AND EVENT. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Time this goal was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # Details for the goal of the type URL_DESTINATION. # Corresponds to the JSON property `urlDestinationDetails` # @return [Google::Apis::AnalyticsV3::Goal::UrlDestinationDetails] attr_accessor :url_destination_details # Goal value. # Corresponds to the JSON property `value` # @return [Float] attr_accessor :value # Details for the goal of the type VISIT_NUM_PAGES. # Corresponds to the JSON property `visitNumPagesDetails` # @return [Google::Apis::AnalyticsV3::Goal::VisitNumPagesDetails] attr_accessor :visit_num_pages_details # Details for the goal of the type VISIT_TIME_ON_SITE. # Corresponds to the JSON property `visitTimeOnSiteDetails` # @return [Google::Apis::AnalyticsV3::Goal::VisitTimeOnSiteDetails] attr_accessor :visit_time_on_site_details # Web property ID to which this goal belongs. The web property ID is of the form # UA-XXXXX-YY. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @created = args[:created] if args.key?(:created) @event_details = args[:event_details] if args.key?(:event_details) @id = args[:id] if args.key?(:id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @parent_link = args[:parent_link] if args.key?(:parent_link) @profile_id = args[:profile_id] if args.key?(:profile_id) @self_link = args[:self_link] if args.key?(:self_link) @type = args[:type] if args.key?(:type) @updated = args[:updated] if args.key?(:updated) @url_destination_details = args[:url_destination_details] if args.key?(:url_destination_details) @value = args[:value] if args.key?(:value) @visit_num_pages_details = args[:visit_num_pages_details] if args.key?(:visit_num_pages_details) @visit_time_on_site_details = args[:visit_time_on_site_details] if args.key?(:visit_time_on_site_details) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end # Details for the goal of the type EVENT. class EventDetails include Google::Apis::Core::Hashable # List of event conditions. # Corresponds to the JSON property `eventConditions` # @return [Array] attr_accessor :event_conditions # Determines if the event value should be used as the value for this goal. # Corresponds to the JSON property `useEventValue` # @return [Boolean] attr_accessor :use_event_value alias_method :use_event_value?, :use_event_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @event_conditions = args[:event_conditions] if args.key?(:event_conditions) @use_event_value = args[:use_event_value] if args.key?(:use_event_value) end # class EventCondition include Google::Apis::Core::Hashable # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL. # Corresponds to the JSON property `comparisonType` # @return [String] attr_accessor :comparison_type # Value used for this comparison. # Corresponds to the JSON property `comparisonValue` # @return [Fixnum] attr_accessor :comparison_value # Expression used for this match. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or # EXACT. # Corresponds to the JSON property `matchType` # @return [String] attr_accessor :match_type # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or # VALUE. # 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) @comparison_type = args[:comparison_type] if args.key?(:comparison_type) @comparison_value = args[:comparison_value] if args.key?(:comparison_value) @expression = args[:expression] if args.key?(:expression) @match_type = args[:match_type] if args.key?(:match_type) @type = args[:type] if args.key?(:type) end end end # Parent link for a goal. Points to the view (profile) to which this goal # belongs. class ParentLink include Google::Apis::Core::Hashable # Link to the view (profile) to which this goal belongs. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Value is "analytics#profile". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end # Details for the goal of the type URL_DESTINATION. class UrlDestinationDetails include Google::Apis::Core::Hashable # Determines if the goal URL must exactly match the capitalization of visited # URLs. # Corresponds to the JSON property `caseSensitive` # @return [Boolean] attr_accessor :case_sensitive alias_method :case_sensitive?, :case_sensitive # Determines if the first step in this goal is required. # Corresponds to the JSON property `firstStepRequired` # @return [Boolean] attr_accessor :first_step_required alias_method :first_step_required?, :first_step_required # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX. # Corresponds to the JSON property `matchType` # @return [String] attr_accessor :match_type # List of steps configured for this goal funnel. # Corresponds to the JSON property `steps` # @return [Array] attr_accessor :steps # URL for this goal. # 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) @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive) @first_step_required = args[:first_step_required] if args.key?(:first_step_required) @match_type = args[:match_type] if args.key?(:match_type) @steps = args[:steps] if args.key?(:steps) @url = args[:url] if args.key?(:url) end # class Step include Google::Apis::Core::Hashable # Step name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Step number. # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number # URL for this step. # 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) @number = args[:number] if args.key?(:number) @url = args[:url] if args.key?(:url) end end end # Details for the goal of the type VISIT_NUM_PAGES. class VisitNumPagesDetails include Google::Apis::Core::Hashable # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL. # Corresponds to the JSON property `comparisonType` # @return [String] attr_accessor :comparison_type # Value used for this comparison. # Corresponds to the JSON property `comparisonValue` # @return [Fixnum] attr_accessor :comparison_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @comparison_type = args[:comparison_type] if args.key?(:comparison_type) @comparison_value = args[:comparison_value] if args.key?(:comparison_value) end end # Details for the goal of the type VISIT_TIME_ON_SITE. class VisitTimeOnSiteDetails include Google::Apis::Core::Hashable # Type of comparison. Possible values are LESS_THAN or GREATER_THAN. # Corresponds to the JSON property `comparisonType` # @return [String] attr_accessor :comparison_type # Value used for this comparison. # Corresponds to the JSON property `comparisonValue` # @return [Fixnum] attr_accessor :comparison_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @comparison_type = args[:comparison_type] if args.key?(:comparison_type) @comparison_value = args[:comparison_value] if args.key?(:comparison_value) end end end # A goal collection lists Analytics goals to which the user has access. Each # view (profile) can have a set of goals. Each resource in the Goal collection # corresponds to a single Analytics goal. class Goals include Google::Apis::Core::Hashable # A list of goals. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this goal collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this goal collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of # resources in the result. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for an Analytics Remarketing Include Conditions. class IncludeConditions include Google::Apis::Core::Hashable # The look-back window lets you specify a time frame for evaluating the behavior # that qualifies users for your audience. For example, if your filters include # users from Central Asia, and Transactions Greater than 2, and you set the look- # back window to 14 days, then any user from Central Asia whose cumulative # transactions exceed 2 during the last 14 days is added to the audience. # Corresponds to the JSON property `daysToLookBack` # @return [Fixnum] attr_accessor :days_to_look_back # Boolean indicating whether this segment is a smart list. https://support. # google.com/analytics/answer/4628577 # Corresponds to the JSON property `isSmartList` # @return [Boolean] attr_accessor :is_smart_list alias_method :is_smart_list?, :is_smart_list # Resource type for include conditions. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Number of days (in the range 1 to 540) a user remains in the audience. # Corresponds to the JSON property `membershipDurationDays` # @return [Fixnum] attr_accessor :membership_duration_days # The segment condition that will cause a user to be added to an audience. # Corresponds to the JSON property `segment` # @return [String] attr_accessor :segment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @days_to_look_back = args[:days_to_look_back] if args.key?(:days_to_look_back) @is_smart_list = args[:is_smart_list] if args.key?(:is_smart_list) @kind = args[:kind] if args.key?(:kind) @membership_duration_days = args[:membership_duration_days] if args.key?(:membership_duration_days) @segment = args[:segment] if args.key?(:segment) end end # JSON template for an Analytics Remarketing Audience Foreign Link. class LinkedForeignAccount include Google::Apis::Core::Hashable # Account ID to which this linked foreign account belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Boolean indicating whether this is eligible for search. # Corresponds to the JSON property `eligibleForSearch` # @return [Boolean] attr_accessor :eligible_for_search alias_method :eligible_for_search?, :eligible_for_search # Entity ad account link ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Internal ID for the web property to which this linked foreign account belongs. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # Resource type for linked foreign account. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The foreign account ID. For example the an AdWords `linkedAccountId` has the # following format XXX-XXX-XXXX. # Corresponds to the JSON property `linkedAccountId` # @return [String] attr_accessor :linked_account_id # Remarketing audience ID to which this linked foreign account belongs. # Corresponds to the JSON property `remarketingAudienceId` # @return [String] attr_accessor :remarketing_audience_id # The status of this foreign account link. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, ` # MCC_LINKS` or `OPTIMIZE`. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Web property ID of the form UA-XXXXX-YY to which this linked foreign account # belongs. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @eligible_for_search = args[:eligible_for_search] if args.key?(:eligible_for_search) @id = args[:id] if args.key?(:id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @kind = args[:kind] if args.key?(:kind) @linked_account_id = args[:linked_account_id] if args.key?(:linked_account_id) @remarketing_audience_id = args[:remarketing_audience_id] if args.key?(:remarketing_audience_id) @status = args[:status] if args.key?(:status) @type = args[:type] if args.key?(:type) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end end # Multi-Channel Funnels data for a given view (profile). class McfData include Google::Apis::Core::Hashable # Column headers that list dimension names followed by the metric names. The # order of dimensions and metrics is same as specified in the request. # Corresponds to the JSON property `columnHeaders` # @return [Array] attr_accessor :column_headers # Determines if the Analytics data contains sampled data. # Corresponds to the JSON property `containsSampledData` # @return [Boolean] attr_accessor :contains_sampled_data alias_method :contains_sampled_data?, :contains_sampled_data # Unique ID for this data response. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The maximum number of rows the response can contain, regardless of the actual # number of rows returned. Its value ranges from 1 to 10,000 with a value of # 1000 by default, or otherwise specified by the max-results query parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Resource type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this Analytics data query. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this Analytics data query. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # Information for the view (profile), for which the Analytics data was requested. # Corresponds to the JSON property `profileInfo` # @return [Google::Apis::AnalyticsV3::McfData::ProfileInfo] attr_accessor :profile_info # Analytics data request query parameters. # Corresponds to the JSON property `query` # @return [Google::Apis::AnalyticsV3::McfData::Query] attr_accessor :query # Analytics data rows, where each row contains a list of dimension values # followed by the metric values. The order of dimensions and metrics is same as # specified in the request. # Corresponds to the JSON property `rows` # @return [Array>] attr_accessor :rows # The number of samples used to calculate the result. # Corresponds to the JSON property `sampleSize` # @return [Fixnum] attr_accessor :sample_size # Total size of the sample space from which the samples were selected. # Corresponds to the JSON property `sampleSpace` # @return [Fixnum] attr_accessor :sample_space # Link to this page. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The total number of rows for the query, regardless of the number of rows in # the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Total values for the requested metrics over all the results, not just the # results returned in this response. The order of the metric totals is same as # the metric order specified in the request. # Corresponds to the JSON property `totalsForAllResults` # @return [Hash] attr_accessor :totals_for_all_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_headers = args[:column_headers] if args.key?(:column_headers) @contains_sampled_data = args[:contains_sampled_data] if args.key?(:contains_sampled_data) @id = args[:id] if args.key?(:id) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @profile_info = args[:profile_info] if args.key?(:profile_info) @query = args[:query] if args.key?(:query) @rows = args[:rows] if args.key?(:rows) @sample_size = args[:sample_size] if args.key?(:sample_size) @sample_space = args[:sample_space] if args.key?(:sample_space) @self_link = args[:self_link] if args.key?(:self_link) @total_results = args[:total_results] if args.key?(:total_results) @totals_for_all_results = args[:totals_for_all_results] if args.key?(:totals_for_all_results) end # class ColumnHeader include Google::Apis::Core::Hashable # Column Type. Either DIMENSION or METRIC. # Corresponds to the JSON property `columnType` # @return [String] attr_accessor :column_type # Data type. Dimension and metric values data types such as INTEGER, DOUBLE, # CURRENCY, MCF_SEQUENCE etc. # Corresponds to the JSON property `dataType` # @return [String] attr_accessor :data_type # Column name. # 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) @column_type = args[:column_type] if args.key?(:column_type) @data_type = args[:data_type] if args.key?(:data_type) @name = args[:name] if args.key?(:name) end end # Information for the view (profile), for which the Analytics data was requested. class ProfileInfo include Google::Apis::Core::Hashable # Account ID to which this view (profile) belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Internal ID for the web property to which this view (profile) belongs. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # View (Profile) ID. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id # View (Profile) name. # Corresponds to the JSON property `profileName` # @return [String] attr_accessor :profile_name # Table ID for view (profile). # Corresponds to the JSON property `tableId` # @return [String] attr_accessor :table_id # Web Property ID to which this view (profile) belongs. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @profile_id = args[:profile_id] if args.key?(:profile_id) @profile_name = args[:profile_name] if args.key?(:profile_name) @table_id = args[:table_id] if args.key?(:table_id) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end end # Analytics data request query parameters. class Query include Google::Apis::Core::Hashable # List of analytics dimensions. # Corresponds to the JSON property `dimensions` # @return [String] attr_accessor :dimensions # End date. # Corresponds to the JSON property `end-date` # @return [String] attr_accessor :end_date # Comma-separated list of dimension or metric filters. # Corresponds to the JSON property `filters` # @return [String] attr_accessor :filters # Unique table ID. # Corresponds to the JSON property `ids` # @return [String] attr_accessor :ids # Maximum results per page. # Corresponds to the JSON property `max-results` # @return [Fixnum] attr_accessor :max_results # List of analytics metrics. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Desired sampling level # Corresponds to the JSON property `samplingLevel` # @return [String] attr_accessor :sampling_level # Analytics advanced segment. # Corresponds to the JSON property `segment` # @return [String] attr_accessor :segment # List of dimensions or metrics based on which Analytics data is sorted. # Corresponds to the JSON property `sort` # @return [Array] attr_accessor :sort # Start date. # Corresponds to the JSON property `start-date` # @return [String] attr_accessor :start_date # Start index. # Corresponds to the JSON property `start-index` # @return [Fixnum] attr_accessor :start_index def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimensions = args[:dimensions] if args.key?(:dimensions) @end_date = args[:end_date] if args.key?(:end_date) @filters = args[:filters] if args.key?(:filters) @ids = args[:ids] if args.key?(:ids) @max_results = args[:max_results] if args.key?(:max_results) @metrics = args[:metrics] if args.key?(:metrics) @sampling_level = args[:sampling_level] if args.key?(:sampling_level) @segment = args[:segment] if args.key?(:segment) @sort = args[:sort] if args.key?(:sort) @start_date = args[:start_date] if args.key?(:start_date) @start_index = args[:start_index] if args.key?(:start_index) end end # A union object representing a dimension or metric value. Only one of " # primitiveValue" or "conversionPathValue" attribute will be populated. class Row include Google::Apis::Core::Hashable # A conversion path dimension value, containing a list of interactions with # their attributes. # Corresponds to the JSON property `conversionPathValue` # @return [Array] attr_accessor :conversion_path_value # A primitive dimension value. A primitive metric value. # Corresponds to the JSON property `primitiveValue` # @return [String] attr_accessor :primitive_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @conversion_path_value = args[:conversion_path_value] if args.key?(:conversion_path_value) @primitive_value = args[:primitive_value] if args.key?(:primitive_value) end # class ConversionPathValue include Google::Apis::Core::Hashable # Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc. # Corresponds to the JSON property `interactionType` # @return [String] attr_accessor :interaction_type # Node value of an interaction on conversion path. Such as source, medium etc. # Corresponds to the JSON property `nodeValue` # @return [String] attr_accessor :node_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @interaction_type = args[:interaction_type] if args.key?(:interaction_type) @node_value = args[:node_value] if args.key?(:node_value) end end end end # JSON template for an Analytics view (profile). class Profile include Google::Apis::Core::Hashable # Account ID to which this view (profile) belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Indicates whether bot filtering is enabled for this view (profile). # Corresponds to the JSON property `botFilteringEnabled` # @return [Boolean] attr_accessor :bot_filtering_enabled alias_method :bot_filtering_enabled?, :bot_filtering_enabled # Child link for this view (profile). Points to the list of goals for this view ( # profile). # Corresponds to the JSON property `childLink` # @return [Google::Apis::AnalyticsV3::Profile::ChildLink] attr_accessor :child_link # Time this view (profile) was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # The currency type associated with this view (profile), defaults to USD. The # supported values are: # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, # THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, # UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, # VEF, LVL # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency # Default page for this view (profile). # Corresponds to the JSON property `defaultPage` # @return [String] attr_accessor :default_page # Indicates whether ecommerce tracking is enabled for this view (profile). # Corresponds to the JSON property `eCommerceTracking` # @return [Boolean] attr_accessor :e_commerce_tracking alias_method :e_commerce_tracking?, :e_commerce_tracking # Indicates whether enhanced ecommerce tracking is enabled for this view ( # profile). This property can only be enabled if ecommerce tracking is enabled. # Corresponds to the JSON property `enhancedECommerceTracking` # @return [Boolean] attr_accessor :enhanced_e_commerce_tracking alias_method :enhanced_e_commerce_tracking?, :enhanced_e_commerce_tracking # The query parameters that are excluded from this view (profile). # Corresponds to the JSON property `excludeQueryParameters` # @return [String] attr_accessor :exclude_query_parameters # View (Profile) ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Internal ID for the web property to which this view (profile) belongs. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # Resource type for Analytics view (profile). # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this view (profile). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parent link for this view (profile). Points to the web property to which this # view (profile) belongs. # Corresponds to the JSON property `parentLink` # @return [Google::Apis::AnalyticsV3::Profile::ParentLink] attr_accessor :parent_link # Permissions the user has for this view (profile). # Corresponds to the JSON property `permissions` # @return [Google::Apis::AnalyticsV3::Profile::Permissions] attr_accessor :permissions # Link for this view (profile). # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Site search category parameters for this view (profile). # Corresponds to the JSON property `siteSearchCategoryParameters` # @return [String] attr_accessor :site_search_category_parameters # The site search query parameters for this view (profile). # Corresponds to the JSON property `siteSearchQueryParameters` # @return [String] attr_accessor :site_search_query_parameters # Indicates whether this view (profile) is starred or not. # Corresponds to the JSON property `starred` # @return [Boolean] attr_accessor :starred alias_method :starred?, :starred # Whether or not Analytics will strip search category parameters from the URLs # in your reports. # Corresponds to the JSON property `stripSiteSearchCategoryParameters` # @return [Boolean] attr_accessor :strip_site_search_category_parameters alias_method :strip_site_search_category_parameters?, :strip_site_search_category_parameters # Whether or not Analytics will strip search query parameters from the URLs in # your reports. # Corresponds to the JSON property `stripSiteSearchQueryParameters` # @return [Boolean] attr_accessor :strip_site_search_query_parameters alias_method :strip_site_search_query_parameters?, :strip_site_search_query_parameters # Time zone for which this view (profile) has been configured. Time zones are # identified by strings from the TZ database. # Corresponds to the JSON property `timezone` # @return [String] attr_accessor :timezone # View (Profile) type. Supported types: WEB or APP. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Time this view (profile) was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id # Website URL for this view (profile). # Corresponds to the JSON property `websiteUrl` # @return [String] attr_accessor :website_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @bot_filtering_enabled = args[:bot_filtering_enabled] if args.key?(:bot_filtering_enabled) @child_link = args[:child_link] if args.key?(:child_link) @created = args[:created] if args.key?(:created) @currency = args[:currency] if args.key?(:currency) @default_page = args[:default_page] if args.key?(:default_page) @e_commerce_tracking = args[:e_commerce_tracking] if args.key?(:e_commerce_tracking) @enhanced_e_commerce_tracking = args[:enhanced_e_commerce_tracking] if args.key?(:enhanced_e_commerce_tracking) @exclude_query_parameters = args[:exclude_query_parameters] if args.key?(:exclude_query_parameters) @id = args[:id] if args.key?(:id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @parent_link = args[:parent_link] if args.key?(:parent_link) @permissions = args[:permissions] if args.key?(:permissions) @self_link = args[:self_link] if args.key?(:self_link) @site_search_category_parameters = args[:site_search_category_parameters] if args.key?(:site_search_category_parameters) @site_search_query_parameters = args[:site_search_query_parameters] if args.key?(:site_search_query_parameters) @starred = args[:starred] if args.key?(:starred) @strip_site_search_category_parameters = args[:strip_site_search_category_parameters] if args.key?(:strip_site_search_category_parameters) @strip_site_search_query_parameters = args[:strip_site_search_query_parameters] if args.key?(:strip_site_search_query_parameters) @timezone = args[:timezone] if args.key?(:timezone) @type = args[:type] if args.key?(:type) @updated = args[:updated] if args.key?(:updated) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) @website_url = args[:website_url] if args.key?(:website_url) end # Child link for this view (profile). Points to the list of goals for this view ( # profile). class ChildLink include Google::Apis::Core::Hashable # Link to the list of goals for this view (profile). # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Value is "analytics#goals". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end # Parent link for this view (profile). Points to the web property to which this # view (profile) belongs. class ParentLink include Google::Apis::Core::Hashable # Link to the web property to which this view (profile) belongs. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Value is "analytics#webproperty". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end # Permissions the user has for this view (profile). class Permissions include Google::Apis::Core::Hashable # All the permissions that the user has for this view (profile). These include # any implied permissions (e.g., EDIT implies VIEW) or inherited permissions # from the parent web property. # Corresponds to the JSON property `effective` # @return [Array] attr_accessor :effective def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @effective = args[:effective] if args.key?(:effective) end end end # JSON template for an Analytics profile filter link. class ProfileFilterLink include Google::Apis::Core::Hashable # JSON template for a profile filter link. # Corresponds to the JSON property `filterRef` # @return [Google::Apis::AnalyticsV3::FilterRef] attr_accessor :filter_ref # Profile filter link ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for Analytics filter. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # JSON template for a linked view (profile). # Corresponds to the JSON property `profileRef` # @return [Google::Apis::AnalyticsV3::ProfileRef] attr_accessor :profile_ref # The rank of this profile filter link relative to the other filters linked to # the same profile. # For readonly (i.e., list and get) operations, the rank always starts at 1. # For write (i.e., create, update, or delete) operations, you may specify a # value between 0 and 255 inclusively, [0, 255]. In order to insert a link at # the end of the list, either don't specify a rank or set a rank to a number # greater than the largest rank in the list. In order to insert a link to the # beginning of the list specify a rank that is less than or equal to 1. The new # link will move all existing filters with the same or lower rank down the list. # After the link is inserted/updated/deleted all profile filter links will be # renumbered starting at 1. # Corresponds to the JSON property `rank` # @return [Fixnum] attr_accessor :rank # Link for this profile filter link. # 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) @filter_ref = args[:filter_ref] if args.key?(:filter_ref) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @profile_ref = args[:profile_ref] if args.key?(:profile_ref) @rank = args[:rank] if args.key?(:rank) @self_link = args[:self_link] if args.key?(:self_link) end end # A profile filter link collection lists profile filter links between profiles # and filters. Each resource in the collection corresponds to a profile filter # link. class ProfileFilterLinks include Google::Apis::Core::Hashable # A list of profile filter links. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1,000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this profile filter link collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this profile filter link collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for a linked view (profile). class ProfileRef include Google::Apis::Core::Hashable # Account ID to which this view (profile) belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Link for this view (profile). # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # View (Profile) ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Internal ID for the web property to which this view (profile) belongs. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # Analytics view (profile) reference. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this view (profile). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @href = args[:href] if args.key?(:href) @id = args[:id] if args.key?(:id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end end # JSON template for an Analytics ProfileSummary. ProfileSummary returns basic # information (i.e., summary) for a profile. class ProfileSummary include Google::Apis::Core::Hashable # View (profile) ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for Analytics ProfileSummary. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # View (profile) name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Indicates whether this view (profile) is starred or not. # Corresponds to the JSON property `starred` # @return [Boolean] attr_accessor :starred alias_method :starred?, :starred # View (Profile) type. Supported types: WEB or APP. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @starred = args[:starred] if args.key?(:starred) @type = args[:type] if args.key?(:type) end end # A view (profile) collection lists Analytics views (profiles) to which the user # has access. Each resource in the collection corresponds to a single Analytics # view (profile). class Profiles include Google::Apis::Core::Hashable # A list of views (profiles). # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this view (profile) collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this view (profile) collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # Real time data for a given view (profile). class RealtimeData include Google::Apis::Core::Hashable # Column headers that list dimension names followed by the metric names. The # order of dimensions and metrics is same as specified in the request. # Corresponds to the JSON property `columnHeaders` # @return [Array] attr_accessor :column_headers # Unique ID for this data response. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Information for the view (profile), for which the real time data was requested. # Corresponds to the JSON property `profileInfo` # @return [Google::Apis::AnalyticsV3::RealtimeData::ProfileInfo] attr_accessor :profile_info # Real time data request query parameters. # Corresponds to the JSON property `query` # @return [Google::Apis::AnalyticsV3::RealtimeData::Query] attr_accessor :query # Real time data rows, where each row contains a list of dimension values # followed by the metric values. The order of dimensions and metrics is same as # specified in the request. # Corresponds to the JSON property `rows` # @return [Array>] attr_accessor :rows # Link to this page. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The total number of rows for the query, regardless of the number of rows in # the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Total values for the requested metrics over all the results, not just the # results returned in this response. The order of the metric totals is same as # the metric order specified in the request. # Corresponds to the JSON property `totalsForAllResults` # @return [Hash] attr_accessor :totals_for_all_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_headers = args[:column_headers] if args.key?(:column_headers) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @profile_info = args[:profile_info] if args.key?(:profile_info) @query = args[:query] if args.key?(:query) @rows = args[:rows] if args.key?(:rows) @self_link = args[:self_link] if args.key?(:self_link) @total_results = args[:total_results] if args.key?(:total_results) @totals_for_all_results = args[:totals_for_all_results] if args.key?(:totals_for_all_results) end # class ColumnHeader include Google::Apis::Core::Hashable # Column Type. Either DIMENSION or METRIC. # Corresponds to the JSON property `columnType` # @return [String] attr_accessor :column_type # Data type. Dimension column headers have only STRING as the data type. Metric # column headers have data types for metric values such as INTEGER, DOUBLE, # CURRENCY etc. # Corresponds to the JSON property `dataType` # @return [String] attr_accessor :data_type # Column name. # 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) @column_type = args[:column_type] if args.key?(:column_type) @data_type = args[:data_type] if args.key?(:data_type) @name = args[:name] if args.key?(:name) end end # Information for the view (profile), for which the real time data was requested. class ProfileInfo include Google::Apis::Core::Hashable # Account ID to which this view (profile) belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Internal ID for the web property to which this view (profile) belongs. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # View (Profile) ID. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id # View (Profile) name. # Corresponds to the JSON property `profileName` # @return [String] attr_accessor :profile_name # Table ID for view (profile). # Corresponds to the JSON property `tableId` # @return [String] attr_accessor :table_id # Web Property ID to which this view (profile) belongs. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @profile_id = args[:profile_id] if args.key?(:profile_id) @profile_name = args[:profile_name] if args.key?(:profile_name) @table_id = args[:table_id] if args.key?(:table_id) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end end # Real time data request query parameters. class Query include Google::Apis::Core::Hashable # List of real time dimensions. # Corresponds to the JSON property `dimensions` # @return [String] attr_accessor :dimensions # Comma-separated list of dimension or metric filters. # Corresponds to the JSON property `filters` # @return [String] attr_accessor :filters # Unique table ID. # Corresponds to the JSON property `ids` # @return [String] attr_accessor :ids # Maximum results per page. # Corresponds to the JSON property `max-results` # @return [Fixnum] attr_accessor :max_results # List of real time metrics. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # List of dimensions or metrics based on which real time data is sorted. # Corresponds to the JSON property `sort` # @return [Array] attr_accessor :sort def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimensions = args[:dimensions] if args.key?(:dimensions) @filters = args[:filters] if args.key?(:filters) @ids = args[:ids] if args.key?(:ids) @max_results = args[:max_results] if args.key?(:max_results) @metrics = args[:metrics] if args.key?(:metrics) @sort = args[:sort] if args.key?(:sort) end end end # JSON template for an Analytics remarketing audience. class RemarketingAudience include Google::Apis::Core::Hashable # Account ID to which this remarketing audience belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # The simple audience definition that will cause a user to be added to an # audience. # Corresponds to the JSON property `audienceDefinition` # @return [Google::Apis::AnalyticsV3::RemarketingAudience::AudienceDefinition] attr_accessor :audience_definition # The type of audience, either SIMPLE or STATE_BASED. # Corresponds to the JSON property `audienceType` # @return [String] attr_accessor :audience_type # Time this remarketing audience was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # The description of this remarketing audience. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Remarketing Audience ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Internal ID for the web property to which this remarketing audience belongs. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The linked ad accounts associated with this remarketing audience. A # remarketing audience can have only one linkedAdAccount currently. # Corresponds to the JSON property `linkedAdAccounts` # @return [Array] attr_accessor :linked_ad_accounts # The views (profiles) that this remarketing audience is linked to. # Corresponds to the JSON property `linkedViews` # @return [Array] attr_accessor :linked_views # The name of this remarketing audience. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A state based audience definition that will cause a user to be added or # removed from an audience. # Corresponds to the JSON property `stateBasedAudienceDefinition` # @return [Google::Apis::AnalyticsV3::RemarketingAudience::StateBasedAudienceDefinition] attr_accessor :state_based_audience_definition # Time this remarketing audience was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # Web property ID of the form UA-XXXXX-YY to which this remarketing audience # belongs. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @audience_definition = args[:audience_definition] if args.key?(:audience_definition) @audience_type = args[:audience_type] if args.key?(:audience_type) @created = args[:created] if args.key?(:created) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @kind = args[:kind] if args.key?(:kind) @linked_ad_accounts = args[:linked_ad_accounts] if args.key?(:linked_ad_accounts) @linked_views = args[:linked_views] if args.key?(:linked_views) @name = args[:name] if args.key?(:name) @state_based_audience_definition = args[:state_based_audience_definition] if args.key?(:state_based_audience_definition) @updated = args[:updated] if args.key?(:updated) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end # The simple audience definition that will cause a user to be added to an # audience. class AudienceDefinition include Google::Apis::Core::Hashable # JSON template for an Analytics Remarketing Include Conditions. # Corresponds to the JSON property `includeConditions` # @return [Google::Apis::AnalyticsV3::IncludeConditions] attr_accessor :include_conditions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @include_conditions = args[:include_conditions] if args.key?(:include_conditions) end end # A state based audience definition that will cause a user to be added or # removed from an audience. class StateBasedAudienceDefinition include Google::Apis::Core::Hashable # Defines the conditions to exclude users from the audience. # Corresponds to the JSON property `excludeConditions` # @return [Google::Apis::AnalyticsV3::RemarketingAudience::StateBasedAudienceDefinition::ExcludeConditions] attr_accessor :exclude_conditions # JSON template for an Analytics Remarketing Include Conditions. # Corresponds to the JSON property `includeConditions` # @return [Google::Apis::AnalyticsV3::IncludeConditions] attr_accessor :include_conditions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @exclude_conditions = args[:exclude_conditions] if args.key?(:exclude_conditions) @include_conditions = args[:include_conditions] if args.key?(:include_conditions) end # Defines the conditions to exclude users from the audience. class ExcludeConditions include Google::Apis::Core::Hashable # Whether to make the exclusion TEMPORARY or PERMANENT. # Corresponds to the JSON property `exclusionDuration` # @return [String] attr_accessor :exclusion_duration # The segment condition that will cause a user to be removed from an audience. # Corresponds to the JSON property `segment` # @return [String] attr_accessor :segment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @exclusion_duration = args[:exclusion_duration] if args.key?(:exclusion_duration) @segment = args[:segment] if args.key?(:segment) end end end end # A remarketing audience collection lists Analytics remarketing audiences to # which the user has access. Each resource in the collection corresponds to a # single Analytics remarketing audience. class RemarketingAudiences include Google::Apis::Core::Hashable # A list of remarketing audiences. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this remarketing audience collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this view (profile) collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for an Analytics segment. class Segment include Google::Apis::Core::Hashable # Time the segment was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # Segment definition. # Corresponds to the JSON property `definition` # @return [String] attr_accessor :definition # Segment ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for Analytics segment. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Segment name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Segment ID. Can be used with the 'segment' parameter in Core Reporting API. # Corresponds to the JSON property `segmentId` # @return [String] attr_accessor :segment_id # Link for this segment. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Type for a segment. Possible values are "BUILT_IN" or "CUSTOM". # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Time the segment was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @created = args[:created] if args.key?(:created) @definition = args[:definition] if args.key?(:definition) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @segment_id = args[:segment_id] if args.key?(:segment_id) @self_link = args[:self_link] if args.key?(:self_link) @type = args[:type] if args.key?(:type) @updated = args[:updated] if args.key?(:updated) end end # An segment collection lists Analytics segments that the user has access to. # Each resource in the collection corresponds to a single Analytics segment. class Segments include Google::Apis::Core::Hashable # A list of segments. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type for segments. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this segment collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this segment collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for Analytics unsampled report resource. class UnsampledReport include Google::Apis::Core::Hashable # Account ID to which this unsampled report belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Download details for a file stored in Google Cloud Storage. # Corresponds to the JSON property `cloudStorageDownloadDetails` # @return [Google::Apis::AnalyticsV3::UnsampledReport::CloudStorageDownloadDetails] attr_accessor :cloud_storage_download_details # Time this unsampled report was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # The dimensions for the unsampled report. # Corresponds to the JSON property `dimensions` # @return [String] attr_accessor :dimensions # The type of download you need to use for the report data file. Possible values # include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is ` # GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is ` # GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. # Corresponds to the JSON property `downloadType` # @return [String] attr_accessor :download_type # Download details for a file stored in Google Drive. # Corresponds to the JSON property `driveDownloadDetails` # @return [Google::Apis::AnalyticsV3::UnsampledReport::DriveDownloadDetails] attr_accessor :drive_download_details # The end date for the unsampled report. # Corresponds to the JSON property `end-date` # @return [String] attr_accessor :end_date # The filters for the unsampled report. # Corresponds to the JSON property `filters` # @return [String] attr_accessor :filters # Unsampled report ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for an Analytics unsampled report. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The metrics for the unsampled report. # Corresponds to the JSON property `metrics` # @return [String] attr_accessor :metrics # View (Profile) ID to which this unsampled report belongs. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id # The segment for the unsampled report. # Corresponds to the JSON property `segment` # @return [String] attr_accessor :segment # Link for this unsampled report. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The start date for the unsampled report. # Corresponds to the JSON property `start-date` # @return [String] attr_accessor :start_date # Status of this unsampled report. Possible values are PENDING, COMPLETED, or # FAILED. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Title of the unsampled report. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Time this unsampled report was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # Web property ID to which this unsampled report belongs. The web property ID is # of the form UA-XXXXX-YY. # Corresponds to the JSON property `webPropertyId` # @return [String] attr_accessor :web_property_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @cloud_storage_download_details = args[:cloud_storage_download_details] if args.key?(:cloud_storage_download_details) @created = args[:created] if args.key?(:created) @dimensions = args[:dimensions] if args.key?(:dimensions) @download_type = args[:download_type] if args.key?(:download_type) @drive_download_details = args[:drive_download_details] if args.key?(:drive_download_details) @end_date = args[:end_date] if args.key?(:end_date) @filters = args[:filters] if args.key?(:filters) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) @profile_id = args[:profile_id] if args.key?(:profile_id) @segment = args[:segment] if args.key?(:segment) @self_link = args[:self_link] if args.key?(:self_link) @start_date = args[:start_date] if args.key?(:start_date) @status = args[:status] if args.key?(:status) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) @web_property_id = args[:web_property_id] if args.key?(:web_property_id) end # Download details for a file stored in Google Cloud Storage. class CloudStorageDownloadDetails include Google::Apis::Core::Hashable # Id of the bucket the file object is stored in. # Corresponds to the JSON property `bucketId` # @return [String] attr_accessor :bucket_id # Id of the file object containing the report data. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :obj_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_id = args[:bucket_id] if args.key?(:bucket_id) @obj_id = args[:obj_id] if args.key?(:obj_id) end end # Download details for a file stored in Google Drive. class DriveDownloadDetails include Google::Apis::Core::Hashable # Id of the document/file containing the report data. # Corresponds to the JSON property `documentId` # @return [String] attr_accessor :document_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document_id = args[:document_id] if args.key?(:document_id) end end end # An unsampled report collection lists Analytics unsampled reports to which the # user has access. Each view (profile) can have a set of unsampled reports. Each # resource in the unsampled report collection corresponds to a single Analytics # unsampled report. class UnsampledReports include Google::Apis::Core::Hashable # A list of unsampled reports. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this unsampled report collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this unsampled report collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of # resources in the result. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # Metadata returned for an upload operation. class Upload include Google::Apis::Core::Hashable # Account Id to which this upload belongs. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Custom data source Id to which this data import belongs. # Corresponds to the JSON property `customDataSourceId` # @return [String] attr_accessor :custom_data_source_id # Data import errors collection. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # A unique ID for this upload. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Resource type for Analytics upload. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Time this file is uploaded. # Corresponds to the JSON property `uploadTime` # @return [DateTime] attr_accessor :upload_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @custom_data_source_id = args[:custom_data_source_id] if args.key?(:custom_data_source_id) @errors = args[:errors] if args.key?(:errors) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) @upload_time = args[:upload_time] if args.key?(:upload_time) end end # Upload collection lists Analytics uploads to which the user has access. Each # custom data source can have a set of uploads. Each resource in the upload # collection corresponds to a single Analytics data upload. class Uploads include Google::Apis::Core::Hashable # A list of uploads. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this upload collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this upload collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of # resources in the result. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) end end # JSON template for a user reference. class UserRef include Google::Apis::Core::Hashable # Email ID of this user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # User ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # # 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) @email = args[:email] if args.key?(:email) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) end end # JSON template for a web property reference. class WebPropertyRef include Google::Apis::Core::Hashable # Account ID to which this web property belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Link for this web property. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Web property ID of the form UA-XXXXX-YY. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Internal ID for this web property. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # Analytics web property reference. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this web property. # 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) @account_id = args[:account_id] if args.key?(:account_id) @href = args[:href] if args.key?(:href) @id = args[:id] if args.key?(:id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # JSON template for an Analytics WebPropertySummary. WebPropertySummary returns # basic information (i.e., summary) for a web property. class WebPropertySummary include Google::Apis::Core::Hashable # Web property ID of the form UA-XXXXX-YY. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Internal ID for this web property. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # Resource type for Analytics WebPropertySummary. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Level for this web property. Possible values are STANDARD or PREMIUM. # Corresponds to the JSON property `level` # @return [String] attr_accessor :level # Web property name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # List of profiles under this web property. # Corresponds to the JSON property `profiles` # @return [Array] attr_accessor :profiles # Indicates whether this web property is starred or not. # Corresponds to the JSON property `starred` # @return [Boolean] attr_accessor :starred alias_method :starred?, :starred # Website url for this web property. # Corresponds to the JSON property `websiteUrl` # @return [String] attr_accessor :website_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @kind = args[:kind] if args.key?(:kind) @level = args[:level] if args.key?(:level) @name = args[:name] if args.key?(:name) @profiles = args[:profiles] if args.key?(:profiles) @starred = args[:starred] if args.key?(:starred) @website_url = args[:website_url] if args.key?(:website_url) end end # A web property collection lists Analytics web properties to which the user has # access. Each resource in the collection corresponds to a single Analytics web # property. class Webproperties include Google::Apis::Core::Hashable # A list of web properties. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The maximum number of resources the response can contain, regardless of the # actual number of resources returned. Its value ranges from 1 to 1000 with a # value of 1000 by default, or otherwise specified by the max-results query # parameter. # Corresponds to the JSON property `itemsPerPage` # @return [Fixnum] attr_accessor :items_per_page # Collection type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to next page for this web property collection. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # Link to previous page for this web property collection. # Corresponds to the JSON property `previousLink` # @return [String] attr_accessor :previous_link # The starting index of the resources, which is 1 by default or otherwise # specified by the start-index query parameter. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results for the query, regardless of the number of results # in the response. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results # Email ID of the authenticated user # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @items_per_page = args[:items_per_page] if args.key?(:items_per_page) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @previous_link = args[:previous_link] if args.key?(:previous_link) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) @username = args[:username] if args.key?(:username) end end # JSON template for an Analytics web property. class Webproperty include Google::Apis::Core::Hashable # Account ID to which this web property belongs. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Child link for this web property. Points to the list of views (profiles) for # this web property. # Corresponds to the JSON property `childLink` # @return [Google::Apis::AnalyticsV3::Webproperty::ChildLink] attr_accessor :child_link # Time this web property was created. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # Default view (profile) ID. # Corresponds to the JSON property `defaultProfileId` # @return [Fixnum] attr_accessor :default_profile_id # Web property ID of the form UA-XXXXX-YY. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The industry vertical/category selected for this web property. # Corresponds to the JSON property `industryVertical` # @return [String] attr_accessor :industry_vertical # Internal ID for this web property. # Corresponds to the JSON property `internalWebPropertyId` # @return [String] attr_accessor :internal_web_property_id # Resource type for Analytics WebProperty. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Level for this web property. Possible values are STANDARD or PREMIUM. # Corresponds to the JSON property `level` # @return [String] attr_accessor :level # Name of this web property. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parent link for this web property. Points to the account to which this web # property belongs. # Corresponds to the JSON property `parentLink` # @return [Google::Apis::AnalyticsV3::Webproperty::ParentLink] attr_accessor :parent_link # Permissions the user has for this web property. # Corresponds to the JSON property `permissions` # @return [Google::Apis::AnalyticsV3::Webproperty::Permissions] attr_accessor :permissions # View (Profile) count for this web property. # Corresponds to the JSON property `profileCount` # @return [Fixnum] attr_accessor :profile_count # Link for this web property. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Indicates whether this web property is starred or not. # Corresponds to the JSON property `starred` # @return [Boolean] attr_accessor :starred alias_method :starred?, :starred # Time this web property was last modified. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # Website url for this web property. # Corresponds to the JSON property `websiteUrl` # @return [String] attr_accessor :website_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @child_link = args[:child_link] if args.key?(:child_link) @created = args[:created] if args.key?(:created) @default_profile_id = args[:default_profile_id] if args.key?(:default_profile_id) @id = args[:id] if args.key?(:id) @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical) @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id) @kind = args[:kind] if args.key?(:kind) @level = args[:level] if args.key?(:level) @name = args[:name] if args.key?(:name) @parent_link = args[:parent_link] if args.key?(:parent_link) @permissions = args[:permissions] if args.key?(:permissions) @profile_count = args[:profile_count] if args.key?(:profile_count) @self_link = args[:self_link] if args.key?(:self_link) @starred = args[:starred] if args.key?(:starred) @updated = args[:updated] if args.key?(:updated) @website_url = args[:website_url] if args.key?(:website_url) end # Child link for this web property. Points to the list of views (profiles) for # this web property. class ChildLink include Google::Apis::Core::Hashable # Link to the list of views (profiles) for this web property. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Type of the parent link. Its value is "analytics#profiles". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end # Parent link for this web property. Points to the account to which this web # property belongs. class ParentLink include Google::Apis::Core::Hashable # Link to the account for this web property. # Corresponds to the JSON property `href` # @return [String] attr_accessor :href # Type of the parent link. Its value is "analytics#account". # 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) @href = args[:href] if args.key?(:href) @type = args[:type] if args.key?(:type) end end # Permissions the user has for this web property. class Permissions include Google::Apis::Core::Hashable # All the permissions that the user has for this web property. These include any # implied permissions (e.g., EDIT implies VIEW) or inherited permissions from # the parent account. # Corresponds to the JSON property `effective` # @return [Array] attr_accessor :effective def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @effective = args[:effective] if args.key?(:effective) end end end end end end google-api-client-0.19.8/generated/google/apis/analytics_v3/service.rb0000644000004100000410000073432113252673043025711 0ustar www-datawww-data# 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 AnalyticsV3 # Google Analytics API # # Views and manages your Google Analytics data. # # @example # require 'google/apis/analytics_v3' # # Analytics = Google::Apis::AnalyticsV3 # Alias the module # service = Analytics::AnalyticsService.new # # @see https://developers.google.com/analytics/ class AnalyticsService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'analytics/v3/') @batch_path = 'batch/analytics/v3' end # Returns Analytics data for a view (profile). # @param [String] ids # Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, # where XXXX is the Analytics view (profile) ID. # @param [String] start_date # Start date for fetching Analytics data. Requests can specify a start date # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or # 7daysAgo). The default value is 7daysAgo. # @param [String] end_date # End date for fetching Analytics data. Request can should specify an end date # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or # 7daysAgo). The default value is yesterday. # @param [String] metrics # A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. # At least one metric must be specified. # @param [String] dimensions # A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. # @param [String] filters # A comma-separated list of dimension or metric filters to be applied to # Analytics data. # @param [Boolean] include_empty_rows # The response will include empty rows if this parameter is set to true, the # default is true # @param [Fixnum] max_results # The maximum number of entries to include in this feed. # @param [String] output # The selected format for the response. Default format is JSON. # @param [String] sampling_level # The desired sampling level. # @param [String] segment # An Analytics segment to be applied to data. # @param [String] sort # A comma-separated list of dimensions or metrics that determine the sort order # for Analytics data. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::GaData] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::GaData] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ga_data(ids, start_date, end_date, metrics, dimensions: nil, filters: nil, include_empty_rows: nil, max_results: nil, output: nil, sampling_level: nil, segment: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'data/ga', options) command.response_representation = Google::Apis::AnalyticsV3::GaData::Representation command.response_class = Google::Apis::AnalyticsV3::GaData command.query['dimensions'] = dimensions unless dimensions.nil? command.query['end-date'] = end_date unless end_date.nil? command.query['filters'] = filters unless filters.nil? command.query['ids'] = ids unless ids.nil? command.query['include-empty-rows'] = include_empty_rows unless include_empty_rows.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['metrics'] = metrics unless metrics.nil? command.query['output'] = output unless output.nil? command.query['samplingLevel'] = sampling_level unless sampling_level.nil? command.query['segment'] = segment unless segment.nil? command.query['sort'] = sort unless sort.nil? command.query['start-date'] = start_date unless start_date.nil? command.query['start-index'] = start_index unless start_index.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 Analytics Multi-Channel Funnels data for a view (profile). # @param [String] ids # Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, # where XXXX is the Analytics view (profile) ID. # @param [String] start_date # Start date for fetching Analytics data. Requests can specify a start date # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or # 7daysAgo). The default value is 7daysAgo. # @param [String] end_date # End date for fetching Analytics data. Requests can specify a start date # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or # 7daysAgo). The default value is 7daysAgo. # @param [String] metrics # A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf: # totalConversions,mcf:totalConversionValue'. At least one metric must be # specified. # @param [String] dimensions # A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source, # mcf:medium'. # @param [String] filters # A comma-separated list of dimension or metric filters to be applied to the # Analytics data. # @param [Fixnum] max_results # The maximum number of entries to include in this feed. # @param [String] sampling_level # The desired sampling level. # @param [String] sort # A comma-separated list of dimensions or metrics that determine the sort order # for the Analytics data. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::McfData] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::McfData] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_mcf_data(ids, start_date, end_date, metrics, dimensions: nil, filters: nil, max_results: nil, sampling_level: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'data/mcf', options) command.response_representation = Google::Apis::AnalyticsV3::McfData::Representation command.response_class = Google::Apis::AnalyticsV3::McfData command.query['dimensions'] = dimensions unless dimensions.nil? command.query['end-date'] = end_date unless end_date.nil? command.query['filters'] = filters unless filters.nil? command.query['ids'] = ids unless ids.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['metrics'] = metrics unless metrics.nil? command.query['samplingLevel'] = sampling_level unless sampling_level.nil? command.query['sort'] = sort unless sort.nil? command.query['start-date'] = start_date unless start_date.nil? command.query['start-index'] = start_index unless start_index.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 real time data for a view (profile). # @param [String] ids # Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, # where XXXX is the Analytics view (profile) ID. # @param [String] metrics # A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least # one metric must be specified. # @param [String] dimensions # A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'. # @param [String] filters # A comma-separated list of dimension or metric filters to be applied to real # time data. # @param [Fixnum] max_results # The maximum number of entries to include in this feed. # @param [String] sort # A comma-separated list of dimensions or metrics that determine the sort order # for real time data. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::RealtimeData] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::RealtimeData] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_realtime_data(ids, metrics, dimensions: nil, filters: nil, max_results: nil, sort: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'data/realtime', options) command.response_representation = Google::Apis::AnalyticsV3::RealtimeData::Representation command.response_class = Google::Apis::AnalyticsV3::RealtimeData command.query['dimensions'] = dimensions unless dimensions.nil? command.query['filters'] = filters unless filters.nil? command.query['ids'] = ids unless ids.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['metrics'] = metrics unless metrics.nil? command.query['sort'] = sort unless sort.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 account summaries (lightweight tree comprised of accounts/properties/ # profiles) to which the user has access. # @param [Fixnum] max_results # The maximum number of account summaries to include in this response, where the # largest acceptable value is 1000. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::AccountSummaries] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::AccountSummaries] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_summaries(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accountSummaries', options) command.response_representation = Google::Apis::AnalyticsV3::AccountSummaries::Representation command.response_class = Google::Apis::AnalyticsV3::AccountSummaries command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 # Removes a user from the given account. # @param [String] account_id # Account ID to delete the user link for. # @param [String] link_id # Link ID to delete the user link for. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_account_user_link(account_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'management/accounts/{accountId}/entityUserLinks/{linkId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['linkId'] = link_id unless link_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 # Adds a new user to the given account. # @param [String] account_id # Account ID to create the user link for. # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityUserLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_link(account_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/entityUserLinks', options) command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.request_object = entity_user_link_object command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.response_class = Google::Apis::AnalyticsV3::EntityUserLink command.params['accountId'] = account_id unless account_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 account-user links for a given account. # @param [String] account_id # Account ID to retrieve the user links for. # @param [Fixnum] max_results # The maximum number of account-user links to include in this response. # @param [Fixnum] start_index # An index of the first account-user link to retrieve. Use this parameter as a # pagination mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLinks] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityUserLinks] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_links(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/entityUserLinks', options) command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks command.params['accountId'] = account_id unless account_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 permissions for an existing user on the given account. # @param [String] account_id # Account ID to update the account-user link for. # @param [String] link_id # Link ID to update the account-user link for. # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityUserLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_link(account_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/entityUserLinks/{linkId}', options) command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.request_object = entity_user_link_object command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.response_class = Google::Apis::AnalyticsV3::EntityUserLink command.params['accountId'] = account_id unless account_id.nil? command.params['linkId'] = link_id unless link_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 all accounts to which the user has access. # @param [Fixnum] max_results # The maximum number of accounts to include in this response. # @param [Fixnum] start_index # An index of the first account to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Accounts] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Accounts] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_accounts(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts', options) command.response_representation = Google::Apis::AnalyticsV3::Accounts::Representation command.response_class = Google::Apis::AnalyticsV3::Accounts command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 custom data sources to which the user has access. # @param [String] account_id # Account Id for the custom data sources to retrieve. # @param [String] web_property_id # Web property Id for the custom data sources to retrieve. # @param [Fixnum] max_results # The maximum number of custom data sources to include in this response. # @param [Fixnum] start_index # A 1-based index of the first custom data source to retrieve. Use this # parameter as a pagination mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomDataSources] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomDataSources] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_data_sources(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources', options) command.response_representation = Google::Apis::AnalyticsV3::CustomDataSources::Representation command.response_class = Google::Apis::AnalyticsV3::CustomDataSources command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 # Get a custom dimension to which the user has access. # @param [String] account_id # Account ID for the custom dimension to retrieve. # @param [String] web_property_id # Web property ID for the custom dimension to retrieve. # @param [String] custom_dimension_id # The ID of the custom dimension to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomDimension] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dimension(account_id, web_property_id, custom_dimension_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options) command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation command.response_class = Google::Apis::AnalyticsV3::CustomDimension command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_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 # Create a new custom dimension. # @param [String] account_id # Account ID for the custom dimension to create. # @param [String] web_property_id # Web property ID for the custom dimension to create. # @param [Google::Apis::AnalyticsV3::CustomDimension] custom_dimension_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomDimension] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_custom_dimension(account_id, web_property_id, custom_dimension_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions', options) command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation command.request_object = custom_dimension_object command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation command.response_class = Google::Apis::AnalyticsV3::CustomDimension command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_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 custom dimensions to which the user has access. # @param [String] account_id # Account ID for the custom dimensions to retrieve. # @param [String] web_property_id # Web property ID for the custom dimensions to retrieve. # @param [Fixnum] max_results # The maximum number of custom dimensions to include in this response. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimensions] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomDimensions] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dimensions(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions', options) command.response_representation = Google::Apis::AnalyticsV3::CustomDimensions::Representation command.response_class = Google::Apis::AnalyticsV3::CustomDimensions command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 custom dimension. This method supports patch semantics. # @param [String] account_id # Account ID for the custom dimension to update. # @param [String] web_property_id # Web property ID for the custom dimension to update. # @param [String] custom_dimension_id # Custom dimension ID for the custom dimension to update. # @param [Google::Apis::AnalyticsV3::CustomDimension] custom_dimension_object # @param [Boolean] ignore_custom_data_source_links # Force the update and ignore any warnings related to the custom dimension being # linked to a custom data source / data set. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomDimension] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_custom_dimension(account_id, web_property_id, custom_dimension_id, custom_dimension_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options) command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation command.request_object = custom_dimension_object command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation command.response_class = Google::Apis::AnalyticsV3::CustomDimension command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil? command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.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 custom dimension. # @param [String] account_id # Account ID for the custom dimension to update. # @param [String] web_property_id # Web property ID for the custom dimension to update. # @param [String] custom_dimension_id # Custom dimension ID for the custom dimension to update. # @param [Google::Apis::AnalyticsV3::CustomDimension] custom_dimension_object # @param [Boolean] ignore_custom_data_source_links # Force the update and ignore any warnings related to the custom dimension being # linked to a custom data source / data set. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomDimension] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_custom_dimension(account_id, web_property_id, custom_dimension_id, custom_dimension_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options) command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation command.request_object = custom_dimension_object command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation command.response_class = Google::Apis::AnalyticsV3::CustomDimension command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil? command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.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 # Get a custom metric to which the user has access. # @param [String] account_id # Account ID for the custom metric to retrieve. # @param [String] web_property_id # Web property ID for the custom metric to retrieve. # @param [String] custom_metric_id # The ID of the custom metric to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomMetric] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metric(account_id, web_property_id, custom_metric_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options) command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation command.response_class = Google::Apis::AnalyticsV3::CustomMetric command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['customMetricId'] = custom_metric_id unless custom_metric_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 # Create a new custom metric. # @param [String] account_id # Account ID for the custom metric to create. # @param [String] web_property_id # Web property ID for the custom dimension to create. # @param [Google::Apis::AnalyticsV3::CustomMetric] custom_metric_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomMetric] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_custom_metric(account_id, web_property_id, custom_metric_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics', options) command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation command.request_object = custom_metric_object command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation command.response_class = Google::Apis::AnalyticsV3::CustomMetric command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_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 custom metrics to which the user has access. # @param [String] account_id # Account ID for the custom metrics to retrieve. # @param [String] web_property_id # Web property ID for the custom metrics to retrieve. # @param [Fixnum] max_results # The maximum number of custom metrics to include in this response. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetrics] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomMetrics] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metrics(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics', options) command.response_representation = Google::Apis::AnalyticsV3::CustomMetrics::Representation command.response_class = Google::Apis::AnalyticsV3::CustomMetrics command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 custom metric. This method supports patch semantics. # @param [String] account_id # Account ID for the custom metric to update. # @param [String] web_property_id # Web property ID for the custom metric to update. # @param [String] custom_metric_id # Custom metric ID for the custom metric to update. # @param [Google::Apis::AnalyticsV3::CustomMetric] custom_metric_object # @param [Boolean] ignore_custom_data_source_links # Force the update and ignore any warnings related to the custom metric being # linked to a custom data source / data set. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomMetric] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_custom_metric(account_id, web_property_id, custom_metric_id, custom_metric_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options) command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation command.request_object = custom_metric_object command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation command.response_class = Google::Apis::AnalyticsV3::CustomMetric command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil? command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.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 custom metric. # @param [String] account_id # Account ID for the custom metric to update. # @param [String] web_property_id # Web property ID for the custom metric to update. # @param [String] custom_metric_id # Custom metric ID for the custom metric to update. # @param [Google::Apis::AnalyticsV3::CustomMetric] custom_metric_object # @param [Boolean] ignore_custom_data_source_links # Force the update and ignore any warnings related to the custom metric being # linked to a custom data source / data set. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::CustomMetric] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_custom_metric(account_id, web_property_id, custom_metric_id, custom_metric_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options) command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation command.request_object = custom_metric_object command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation command.response_class = Google::Apis::AnalyticsV3::CustomMetric command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil? command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.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 experiment. # @param [String] account_id # Account ID to which the experiment belongs # @param [String] web_property_id # Web property ID to which the experiment belongs # @param [String] profile_id # View (Profile) ID to which the experiment belongs # @param [String] experiment_id # ID of the experiment 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_experiment(account_id, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['experimentId'] = experiment_id unless experiment_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 an experiment to which the user has access. # @param [String] account_id # Account ID to retrieve the experiment for. # @param [String] web_property_id # Web property ID to retrieve the experiment for. # @param [String] profile_id # View (Profile) ID to retrieve the experiment for. # @param [String] experiment_id # Experiment ID to retrieve the experiment for. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Experiment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_experiment(account_id, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options) command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation command.response_class = Google::Apis::AnalyticsV3::Experiment command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['experimentId'] = experiment_id unless experiment_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 # Create a new experiment. # @param [String] account_id # Account ID to create the experiment for. # @param [String] web_property_id # Web property ID to create the experiment for. # @param [String] profile_id # View (Profile) ID to create the experiment for. # @param [Google::Apis::AnalyticsV3::Experiment] experiment_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Experiment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_experiment(account_id, web_property_id, profile_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments', options) command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation command.request_object = experiment_object command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation command.response_class = Google::Apis::AnalyticsV3::Experiment command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_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 experiments to which the user has access. # @param [String] account_id # Account ID to retrieve experiments for. # @param [String] web_property_id # Web property ID to retrieve experiments for. # @param [String] profile_id # View (Profile) ID to retrieve experiments for. # @param [Fixnum] max_results # The maximum number of experiments to include in this response. # @param [Fixnum] start_index # An index of the first experiment to retrieve. Use this parameter as a # pagination mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Experiments] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Experiments] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_experiments(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments', options) command.response_representation = Google::Apis::AnalyticsV3::Experiments::Representation command.response_class = Google::Apis::AnalyticsV3::Experiments command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 # Update an existing experiment. This method supports patch semantics. # @param [String] account_id # Account ID of the experiment to update. # @param [String] web_property_id # Web property ID of the experiment to update. # @param [String] profile_id # View (Profile) ID of the experiment to update. # @param [String] experiment_id # Experiment ID of the experiment to update. # @param [Google::Apis::AnalyticsV3::Experiment] experiment_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Experiment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_experiment(account_id, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options) command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation command.request_object = experiment_object command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation command.response_class = Google::Apis::AnalyticsV3::Experiment command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['experimentId'] = experiment_id unless experiment_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 # Update an existing experiment. # @param [String] account_id # Account ID of the experiment to update. # @param [String] web_property_id # Web property ID of the experiment to update. # @param [String] profile_id # View (Profile) ID of the experiment to update. # @param [String] experiment_id # Experiment ID of the experiment to update. # @param [Google::Apis::AnalyticsV3::Experiment] experiment_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Experiment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_experiment(account_id, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options) command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation command.request_object = experiment_object command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation command.response_class = Google::Apis::AnalyticsV3::Experiment command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['experimentId'] = experiment_id unless experiment_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 # Delete a filter. # @param [String] account_id # Account ID to delete the filter for. # @param [String] filter_id # ID of the filter 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Filter] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_filter(account_id, filter_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'management/accounts/{accountId}/filters/{filterId}', options) command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation command.response_class = Google::Apis::AnalyticsV3::Filter command.params['accountId'] = account_id unless account_id.nil? command.params['filterId'] = filter_id unless filter_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 a filters to which the user has access. # @param [String] account_id # Account ID to retrieve filters for. # @param [String] filter_id # Filter ID to retrieve filters for. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Filter] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_filter(account_id, filter_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/filters/{filterId}', options) command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation command.response_class = Google::Apis::AnalyticsV3::Filter command.params['accountId'] = account_id unless account_id.nil? command.params['filterId'] = filter_id unless filter_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 # Create a new filter. # @param [String] account_id # Account ID to create filter for. # @param [Google::Apis::AnalyticsV3::Filter] filter_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Filter] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_filter(account_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/filters', options) command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation command.request_object = filter_object command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation command.response_class = Google::Apis::AnalyticsV3::Filter command.params['accountId'] = account_id unless account_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 all filters for an account # @param [String] account_id # Account ID to retrieve filters for. # @param [Fixnum] max_results # The maximum number of filters to include in this response. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Filters] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Filters] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_filters(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/filters', options) command.response_representation = Google::Apis::AnalyticsV3::Filters::Representation command.response_class = Google::Apis::AnalyticsV3::Filters command.params['accountId'] = account_id unless account_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 filter. This method supports patch semantics. # @param [String] account_id # Account ID to which the filter belongs. # @param [String] filter_id # ID of the filter to be updated. # @param [Google::Apis::AnalyticsV3::Filter] filter_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Filter] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_filter(account_id, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'management/accounts/{accountId}/filters/{filterId}', options) command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation command.request_object = filter_object command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation command.response_class = Google::Apis::AnalyticsV3::Filter command.params['accountId'] = account_id unless account_id.nil? command.params['filterId'] = filter_id unless filter_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 an existing filter. # @param [String] account_id # Account ID to which the filter belongs. # @param [String] filter_id # ID of the filter to be updated. # @param [Google::Apis::AnalyticsV3::Filter] filter_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Filter] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_filter(account_id, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/filters/{filterId}', options) command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation command.request_object = filter_object command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation command.response_class = Google::Apis::AnalyticsV3::Filter command.params['accountId'] = account_id unless account_id.nil? command.params['filterId'] = filter_id unless filter_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 goal to which the user has access. # @param [String] account_id # Account ID to retrieve the goal for. # @param [String] web_property_id # Web property ID to retrieve the goal for. # @param [String] profile_id # View (Profile) ID to retrieve the goal for. # @param [String] goal_id # Goal ID to retrieve the goal for. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Goal] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_goal(account_id, web_property_id, profile_id, goal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options) command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation command.response_class = Google::Apis::AnalyticsV3::Goal command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['goalId'] = goal_id unless goal_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 # Create a new goal. # @param [String] account_id # Account ID to create the goal for. # @param [String] web_property_id # Web property ID to create the goal for. # @param [String] profile_id # View (Profile) ID to create the goal for. # @param [Google::Apis::AnalyticsV3::Goal] goal_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Goal] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_goal(account_id, web_property_id, profile_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals', options) command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation command.request_object = goal_object command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation command.response_class = Google::Apis::AnalyticsV3::Goal command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_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 goals to which the user has access. # @param [String] account_id # Account ID to retrieve goals for. Can either be a specific account ID or '~all' # , which refers to all the accounts that user has access to. # @param [String] web_property_id # Web property ID to retrieve goals for. Can either be a specific web property # ID or '~all', which refers to all the web properties that user has access to. # @param [String] profile_id # View (Profile) ID to retrieve goals for. Can either be a specific view ( # profile) ID or '~all', which refers to all the views (profiles) that user has # access to. # @param [Fixnum] max_results # The maximum number of goals to include in this response. # @param [Fixnum] start_index # An index of the first goal to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Goals] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Goals] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_goals(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals', options) command.response_representation = Google::Apis::AnalyticsV3::Goals::Representation command.response_class = Google::Apis::AnalyticsV3::Goals command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 goal. This method supports patch semantics. # @param [String] account_id # Account ID to update the goal. # @param [String] web_property_id # Web property ID to update the goal. # @param [String] profile_id # View (Profile) ID to update the goal. # @param [String] goal_id # Index of the goal to be updated. # @param [Google::Apis::AnalyticsV3::Goal] goal_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Goal] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_goal(account_id, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options) command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation command.request_object = goal_object command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation command.response_class = Google::Apis::AnalyticsV3::Goal command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['goalId'] = goal_id unless goal_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 an existing goal. # @param [String] account_id # Account ID to update the goal. # @param [String] web_property_id # Web property ID to update the goal. # @param [String] profile_id # View (Profile) ID to update the goal. # @param [String] goal_id # Index of the goal to be updated. # @param [Google::Apis::AnalyticsV3::Goal] goal_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Goal] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_goal(account_id, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options) command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation command.request_object = goal_object command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation command.response_class = Google::Apis::AnalyticsV3::Goal command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['goalId'] = goal_id unless goal_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 # Delete a profile filter link. # @param [String] account_id # Account ID to which the profile filter link belongs. # @param [String] web_property_id # Web property Id to which the profile filter link belongs. # @param [String] profile_id # Profile ID to which the filter link belongs. # @param [String] link_id # ID of the profile filter link 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['linkId'] = link_id unless link_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 a single profile filter link. # @param [String] account_id # Account ID to retrieve profile filter link for. # @param [String] web_property_id # Web property Id to retrieve profile filter link for. # @param [String] profile_id # Profile ID to retrieve filter link for. # @param [String] link_id # ID of the profile filter link. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::ProfileFilterLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options) command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['linkId'] = link_id unless link_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 # Create a new profile filter link. # @param [String] account_id # Account ID to create profile filter link for. # @param [String] web_property_id # Web property Id to create profile filter link for. # @param [String] profile_id # Profile ID to create filter link for. # @param [Google::Apis::AnalyticsV3::ProfileFilterLink] profile_filter_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::ProfileFilterLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile_filter_link(account_id, web_property_id, profile_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks', options) command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation command.request_object = profile_filter_link_object command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_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 all profile filter links for a profile. # @param [String] account_id # Account ID to retrieve profile filter links for. # @param [String] web_property_id # Web property Id for profile filter links for. Can either be a specific web # property ID or '~all', which refers to all the web properties that user has # access to. # @param [String] profile_id # Profile ID to retrieve filter links for. Can either be a specific profile ID # or '~all', which refers to all the profiles that user has access to. # @param [Fixnum] max_results # The maximum number of profile filter links to include in this response. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLinks] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::ProfileFilterLinks] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile_filter_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks', options) command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLinks::Representation command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLinks command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 # Update an existing profile filter link. This method supports patch semantics. # @param [String] account_id # Account ID to which profile filter link belongs. # @param [String] web_property_id # Web property Id to which profile filter link belongs # @param [String] profile_id # Profile ID to which filter link belongs # @param [String] link_id # ID of the profile filter link to be updated. # @param [Google::Apis::AnalyticsV3::ProfileFilterLink] profile_filter_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::ProfileFilterLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options) command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation command.request_object = profile_filter_link_object command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['linkId'] = link_id unless link_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 # Update an existing profile filter link. # @param [String] account_id # Account ID to which profile filter link belongs. # @param [String] web_property_id # Web property Id to which profile filter link belongs # @param [String] profile_id # Profile ID to which filter link belongs # @param [String] link_id # ID of the profile filter link to be updated. # @param [Google::Apis::AnalyticsV3::ProfileFilterLink] profile_filter_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::ProfileFilterLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options) command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation command.request_object = profile_filter_link_object command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['linkId'] = link_id unless link_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 # Removes a user from the given view (profile). # @param [String] account_id # Account ID to delete the user link for. # @param [String] web_property_id # Web Property ID to delete the user link for. # @param [String] profile_id # View (Profile) ID to delete the user link for. # @param [String] link_id # Link ID to delete the user link for. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_profile_user_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['linkId'] = link_id unless link_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 # Adds a new user to the given view (profile). # @param [String] account_id # Account ID to create the user link for. # @param [String] web_property_id # Web Property ID to create the user link for. # @param [String] profile_id # View (Profile) ID to create the user link for. # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityUserLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile_user_link(account_id, web_property_id, profile_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks', options) command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.request_object = entity_user_link_object command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.response_class = Google::Apis::AnalyticsV3::EntityUserLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_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 profile-user links for a given view (profile). # @param [String] account_id # Account ID which the given view (profile) belongs to. # @param [String] web_property_id # Web Property ID which the given view (profile) belongs to. Can either be a # specific web property ID or '~all', which refers to all the web properties # that user has access to. # @param [String] profile_id # View (Profile) ID to retrieve the profile-user links for. Can either be a # specific profile ID or '~all', which refers to all the profiles that user has # access to. # @param [Fixnum] max_results # The maximum number of profile-user links to include in this response. # @param [Fixnum] start_index # An index of the first profile-user link to retrieve. Use this parameter as a # pagination mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLinks] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityUserLinks] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile_user_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks', options) command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 permissions for an existing user on the given view (profile). # @param [String] account_id # Account ID to update the user link for. # @param [String] web_property_id # Web Property ID to update the user link for. # @param [String] profile_id # View (Profile ID) to update the user link for. # @param [String] link_id # Link ID to update the user link for. # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityUserLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile_user_link(account_id, web_property_id, profile_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}', options) command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.request_object = entity_user_link_object command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.response_class = Google::Apis::AnalyticsV3::EntityUserLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['linkId'] = link_id unless link_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 a view (profile). # @param [String] account_id # Account ID to delete the view (profile) for. # @param [String] web_property_id # Web property ID to delete the view (profile) for. # @param [String] profile_id # ID of the view (profile) 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_profile(account_id, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_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 view (profile) to which the user has access. # @param [String] account_id # Account ID to retrieve the view (profile) for. # @param [String] web_property_id # Web property ID to retrieve the view (profile) for. # @param [String] profile_id # View (Profile) ID to retrieve the view (profile) for. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Profile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile(account_id, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options) command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation command.response_class = Google::Apis::AnalyticsV3::Profile command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_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 # Create a new view (profile). # @param [String] account_id # Account ID to create the view (profile) for. # @param [String] web_property_id # Web property ID to create the view (profile) for. # @param [Google::Apis::AnalyticsV3::Profile] profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Profile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile(account_id, web_property_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles', options) command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation command.request_object = profile_object command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation command.response_class = Google::Apis::AnalyticsV3::Profile command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_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 views (profiles) to which the user has access. # @param [String] account_id # Account ID for the view (profiles) to retrieve. Can either be a specific # account ID or '~all', which refers to all the accounts to which the user has # access. # @param [String] web_property_id # Web property ID for the views (profiles) to retrieve. Can either be a specific # web property ID or '~all', which refers to all the web properties to which the # user has access. # @param [Fixnum] max_results # The maximum number of views (profiles) to include in this response. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Profiles] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Profiles] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profiles(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles', options) command.response_representation = Google::Apis::AnalyticsV3::Profiles::Representation command.response_class = Google::Apis::AnalyticsV3::Profiles command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 view (profile). This method supports patch semantics. # @param [String] account_id # Account ID to which the view (profile) belongs # @param [String] web_property_id # Web property ID to which the view (profile) belongs # @param [String] profile_id # ID of the view (profile) to be updated. # @param [Google::Apis::AnalyticsV3::Profile] profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Profile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile(account_id, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options) command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation command.request_object = profile_object command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation command.response_class = Google::Apis::AnalyticsV3::Profile command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_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 an existing view (profile). # @param [String] account_id # Account ID to which the view (profile) belongs # @param [String] web_property_id # Web property ID to which the view (profile) belongs # @param [String] profile_id # ID of the view (profile) to be updated. # @param [Google::Apis::AnalyticsV3::Profile] profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Profile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_profile(account_id, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options) command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation command.request_object = profile_object command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation command.response_class = Google::Apis::AnalyticsV3::Profile command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_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 # Delete a remarketing audience. # @param [String] account_id # Account ID to which the remarketing audience belongs. # @param [String] web_property_id # Web property ID to which the remarketing audience belongs. # @param [String] remarketing_audience_id # The ID of the remarketing audience 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_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 remarketing audience to which the user has access. # @param [String] account_id # The account ID of the remarketing audience to retrieve. # @param [String] web_property_id # The web property ID of the remarketing audience to retrieve. # @param [String] remarketing_audience_id # The ID of the remarketing audience to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::RemarketingAudience] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::RemarketingAudience] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options) command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_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 remarketing audience. # @param [String] account_id # The account ID for which to create the remarketing audience. # @param [String] web_property_id # Web property ID for which to create the remarketing audience. # @param [Google::Apis::AnalyticsV3::RemarketingAudience] remarketing_audience_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::RemarketingAudience] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::RemarketingAudience] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_management_remarketing_audience(account_id, web_property_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences', options) command.request_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation command.request_object = remarketing_audience_object command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_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 remarketing audiences to which the user has access. # @param [String] account_id # The account ID of the remarketing audiences to retrieve. # @param [String] web_property_id # The web property ID of the remarketing audiences to retrieve. # @param [Fixnum] max_results # The maximum number of remarketing audiences to include in this response. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @param [String] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::RemarketingAudiences] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::RemarketingAudiences] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_management_remarketing_audiences(account_id, web_property_id, max_results: nil, start_index: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences', options) command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudiences::Representation command.response_class = Google::Apis::AnalyticsV3::RemarketingAudiences command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.nil? command.query['type'] = type unless 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 an existing remarketing audience. This method supports patch semantics. # @param [String] account_id # The account ID of the remarketing audience to update. # @param [String] web_property_id # The web property ID of the remarketing audience to update. # @param [String] remarketing_audience_id # The ID of the remarketing audience to update. # @param [Google::Apis::AnalyticsV3::RemarketingAudience] remarketing_audience_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::RemarketingAudience] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::RemarketingAudience] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options) command.request_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation command.request_object = remarketing_audience_object command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_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 an existing remarketing audience. # @param [String] account_id # The account ID of the remarketing audience to update. # @param [String] web_property_id # The web property ID of the remarketing audience to update. # @param [String] remarketing_audience_id # The ID of the remarketing audience to update. # @param [Google::Apis::AnalyticsV3::RemarketingAudience] remarketing_audience_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::RemarketingAudience] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::RemarketingAudience] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options) command.request_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation command.request_object = remarketing_audience_object command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_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 segments to which the user has access. # @param [Fixnum] max_results # The maximum number of segments to include in this response. # @param [Fixnum] start_index # An index of the first segment to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Segments] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Segments] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_segments(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/segments', options) command.response_representation = Google::Apis::AnalyticsV3::Segments::Representation command.response_class = Google::Apis::AnalyticsV3::Segments command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 unsampled report. # @param [String] account_id # Account ID to delete the unsampled report for. # @param [String] web_property_id # Web property ID to delete the unsampled reports for. # @param [String] profile_id # View (Profile) ID to delete the unsampled report for. # @param [String] unsampled_report_id # ID of the unsampled report 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['unsampledReportId'] = unsampled_report_id unless unsampled_report_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 a single unsampled report. # @param [String] account_id # Account ID to retrieve unsampled report for. # @param [String] web_property_id # Web property ID to retrieve unsampled reports for. # @param [String] profile_id # View (Profile) ID to retrieve unsampled report for. # @param [String] unsampled_report_id # ID of the unsampled report to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::UnsampledReport] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::UnsampledReport] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}', options) command.response_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation command.response_class = Google::Apis::AnalyticsV3::UnsampledReport command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.params['unsampledReportId'] = unsampled_report_id unless unsampled_report_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 # Create a new unsampled report. # @param [String] account_id # Account ID to create the unsampled report for. # @param [String] web_property_id # Web property ID to create the unsampled report for. # @param [String] profile_id # View (Profile) ID to create the unsampled report for. # @param [Google::Apis::AnalyticsV3::UnsampledReport] unsampled_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::UnsampledReport] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::UnsampledReport] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports', options) command.request_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation command.request_object = unsampled_report_object command.response_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation command.response_class = Google::Apis::AnalyticsV3::UnsampledReport command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_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 unsampled reports to which the user has access. # @param [String] account_id # Account ID to retrieve unsampled reports for. Must be a specific account ID, ~ # all is not supported. # @param [String] web_property_id # Web property ID to retrieve unsampled reports for. Must be a specific web # property ID, ~all is not supported. # @param [String] profile_id # View (Profile) ID to retrieve unsampled reports for. Must be a specific view ( # profile) ID, ~all is not supported. # @param [Fixnum] max_results # The maximum number of unsampled reports to include in this response. # @param [Fixnum] start_index # An index of the first unsampled report to retrieve. Use this parameter as a # pagination mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::UnsampledReports] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::UnsampledReports] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_unsampled_reports(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports', options) command.response_representation = Google::Apis::AnalyticsV3::UnsampledReports::Representation command.response_class = Google::Apis::AnalyticsV3::UnsampledReports command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['profileId'] = profile_id unless profile_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 data associated with a previous upload. # @param [String] account_id # Account Id for the uploads to be deleted. # @param [String] web_property_id # Web property Id for the uploads to be deleted. # @param [String] custom_data_source_id # Custom data source Id for the uploads to be deleted. # @param [Google::Apis::AnalyticsV3::DeleteUploadDataRequest] delete_upload_data_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_upload_data(account_id, web_property_id, custom_data_source_id, delete_upload_data_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData', options) command.request_representation = Google::Apis::AnalyticsV3::DeleteUploadDataRequest::Representation command.request_object = delete_upload_data_request_object command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_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 # List uploads to which the user has access. # @param [String] account_id # Account Id for the upload to retrieve. # @param [String] web_property_id # Web property Id for the upload to retrieve. # @param [String] custom_data_source_id # Custom data source Id for upload to retrieve. # @param [String] upload_id # Upload Id to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Upload] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Upload] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_upload(account_id, web_property_id, custom_data_source_id, upload_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}', options) command.response_representation = Google::Apis::AnalyticsV3::Upload::Representation command.response_class = Google::Apis::AnalyticsV3::Upload command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil? command.params['uploadId'] = upload_id unless upload_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 # List uploads to which the user has access. # @param [String] account_id # Account Id for the uploads to retrieve. # @param [String] web_property_id # Web property Id for the uploads to retrieve. # @param [String] custom_data_source_id # Custom data source Id for uploads to retrieve. # @param [Fixnum] max_results # The maximum number of uploads to include in this response. # @param [Fixnum] start_index # A 1-based index of the first upload to retrieve. Use this parameter as a # pagination mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Uploads] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Uploads] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_uploads(account_id, web_property_id, custom_data_source_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options) command.response_representation = Google::Apis::AnalyticsV3::Uploads::Representation command.response_class = Google::Apis::AnalyticsV3::Uploads command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 # Upload data for a custom data source. # @param [String] account_id # Account Id associated with the upload. # @param [String] web_property_id # Web property UA-string associated with the upload. # @param [String] custom_data_source_id # Custom data source Id to which the data being uploaded belongs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::AnalyticsV3::Upload] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Upload] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_data(account_id, web_property_id, custom_data_source_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, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options) else command = make_upload_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options) command.upload_source = upload_source command.upload_content_type = content_type end command.response_representation = Google::Apis::AnalyticsV3::Upload::Representation command.response_class = Google::Apis::AnalyticsV3::Upload command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_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 a web property-AdWords link. # @param [String] account_id # ID of the account which the given web property belongs to. # @param [String] web_property_id # Web property ID to delete the AdWords link for. # @param [String] web_property_ad_words_link_id # Web property AdWords link 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_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 a web property-AdWords link to which the user has access. # @param [String] account_id # ID of the account which the given web property belongs to. # @param [String] web_property_id # Web property ID to retrieve the AdWords link for. # @param [String] web_property_ad_words_link_id # Web property-AdWords link 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options) command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_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 webProperty-AdWords link. # @param [String] account_id # ID of the Google Analytics account to create the link for. # @param [String] web_property_id # Web property ID to create the link for. # @param [Google::Apis::AnalyticsV3::EntityAdWordsLink] entity_ad_words_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property_ad_words_link(account_id, web_property_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks', options) command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation command.request_object = entity_ad_words_link_object command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_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 webProperty-AdWords links for a given web property. # @param [String] account_id # ID of the account which the given web property belongs to. # @param [String] web_property_id # Web property ID to retrieve the AdWords links for. # @param [Fixnum] max_results # The maximum number of webProperty-AdWords links to include in this response. # @param [Fixnum] start_index # An index of the first webProperty-AdWords link to retrieve. Use this parameter # as a pagination mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLinks] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityAdWordsLinks] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property_ad_words_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks', options) command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLinks::Representation command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLinks command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 webProperty-AdWords link. This method supports patch # semantics. # @param [String] account_id # ID of the account which the given web property belongs to. # @param [String] web_property_id # Web property ID to retrieve the AdWords link for. # @param [String] web_property_ad_words_link_id # Web property-AdWords link ID. # @param [Google::Apis::AnalyticsV3::EntityAdWordsLink] entity_ad_words_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options) command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation command.request_object = entity_ad_words_link_object command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_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 an existing webProperty-AdWords link. # @param [String] account_id # ID of the account which the given web property belongs to. # @param [String] web_property_id # Web property ID to retrieve the AdWords link for. # @param [String] web_property_ad_words_link_id # Web property-AdWords link ID. # @param [Google::Apis::AnalyticsV3::EntityAdWordsLink] entity_ad_words_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options) command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation command.request_object = entity_ad_words_link_object command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_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 web property to which the user has access. # @param [String] account_id # Account ID to retrieve the web property for. # @param [String] web_property_id # ID to retrieve the web property for. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Webproperty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property(account_id, web_property_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options) command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation command.response_class = Google::Apis::AnalyticsV3::Webproperty command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_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 # Create a new property if the account has fewer than 20 properties. Web # properties are visible in the Google Analytics interface only if they have at # least one profile. # @param [String] account_id # Account ID to create the web property for. # @param [Google::Apis::AnalyticsV3::Webproperty] webproperty_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Webproperty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property(account_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties', options) command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation command.request_object = webproperty_object command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation command.response_class = Google::Apis::AnalyticsV3::Webproperty command.params['accountId'] = account_id unless account_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 web properties to which the user has access. # @param [String] account_id # Account ID to retrieve web properties for. Can either be a specific account ID # or '~all', which refers to all the accounts that user has access to. # @param [Fixnum] max_results # The maximum number of web properties to include in this response. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Webproperties] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Webproperties] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_properties(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties', options) command.response_representation = Google::Apis::AnalyticsV3::Webproperties::Representation command.response_class = Google::Apis::AnalyticsV3::Webproperties command.params['accountId'] = account_id unless account_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 web property. This method supports patch semantics. # @param [String] account_id # Account ID to which the web property belongs # @param [String] web_property_id # Web property ID # @param [Google::Apis::AnalyticsV3::Webproperty] webproperty_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Webproperty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property(account_id, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options) command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation command.request_object = webproperty_object command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation command.response_class = Google::Apis::AnalyticsV3::Webproperty command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_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 an existing web property. # @param [String] account_id # Account ID to which the web property belongs # @param [String] web_property_id # Web property ID # @param [Google::Apis::AnalyticsV3::Webproperty] webproperty_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Webproperty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property(account_id, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options) command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation command.request_object = webproperty_object command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation command.response_class = Google::Apis::AnalyticsV3::Webproperty command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_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 # Removes a user from the given web property. # @param [String] account_id # Account ID to delete the user link for. # @param [String] web_property_id # Web Property ID to delete the user link for. # @param [String] link_id # Link ID to delete the user link for. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_web_property_user_link(account_id, web_property_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['linkId'] = link_id unless link_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 # Adds a new user to the given web property. # @param [String] account_id # Account ID to create the user link for. # @param [String] web_property_id # Web Property ID to create the user link for. # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityUserLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property_user_link(account_id, web_property_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks', options) command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.request_object = entity_user_link_object command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.response_class = Google::Apis::AnalyticsV3::EntityUserLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_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 webProperty-user links for a given web property. # @param [String] account_id # Account ID which the given web property belongs to. # @param [String] web_property_id # Web Property ID for the webProperty-user links to retrieve. Can either be a # specific web property ID or '~all', which refers to all the web properties # that user has access to. # @param [Fixnum] max_results # The maximum number of webProperty-user Links to include in this response. # @param [Fixnum] start_index # An index of the first webProperty-user link to retrieve. Use this parameter as # a pagination mechanism along with the max-results parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLinks] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityUserLinks] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property_user_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks', options) command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['start-index'] = start_index unless start_index.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 permissions for an existing user on the given web property. # @param [String] account_id # Account ID to update the account-user link for. # @param [String] web_property_id # Web property ID to update the account-user link for. # @param [String] link_id # Link ID to update the account-user link for. # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::EntityUserLink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_property_user_link(account_id, web_property_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}', options) command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.request_object = entity_user_link_object command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation command.response_class = Google::Apis::AnalyticsV3::EntityUserLink command.params['accountId'] = account_id unless account_id.nil? command.params['webPropertyId'] = web_property_id unless web_property_id.nil? command.params['linkId'] = link_id unless link_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 all columns for a report type # @param [String] report_type # Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core # Reporting 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::Columns] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::Columns] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metadata_columns(report_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'metadata/{reportType}/columns', options) command.response_representation = Google::Apis::AnalyticsV3::Columns::Representation command.response_class = Google::Apis::AnalyticsV3::Columns command.params['reportType'] = report_type unless report_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 # Creates an account ticket. # @param [Google::Apis::AnalyticsV3::AccountTicket] account_ticket_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::AccountTicket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::AccountTicket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_ticket(account_ticket_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'provisioning/createAccountTicket', options) command.request_representation = Google::Apis::AnalyticsV3::AccountTicket::Representation command.request_object = account_ticket_object command.response_representation = Google::Apis::AnalyticsV3::AccountTicket::Representation command.response_class = Google::Apis::AnalyticsV3::AccountTicket 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 # Provision account. # @param [Google::Apis::AnalyticsV3::AccountTreeRequest] account_tree_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticsV3::AccountTreeResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsV3::AccountTreeResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_provisioning_account_tree(account_tree_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'provisioning/createAccount', options) command.request_representation = Google::Apis::AnalyticsV3::AccountTreeRequest::Representation command.request_object = account_tree_request_object command.response_representation = Google::Apis::AnalyticsV3::AccountTreeResponse::Representation command.response_class = Google::Apis::AnalyticsV3::AccountTreeResponse 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 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 end end google-api-client-0.19.8/generated/google/apis/dfareporting_v2_8/0000755000004100000410000000000013252673043024635 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/dfareporting_v2_8/representations.rb0000644000004100000410000057642213252673043030427 0ustar www-datawww-data# 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 DfareportingV2_8 class Account class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountActiveAdSummary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountPermission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountPermissionGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountPermissionGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountPermissionsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountUserProfile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountUserProfilesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Activities class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Ad class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdBlockingConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdSlot class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdsListResponse 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 AdvertiserGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdvertiserGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdvertisersListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AudienceSegment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AudienceSegmentGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Browser class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BrowsersListResponse 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 CampaignCreativeAssociation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CampaignCreativeAssociationsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CampaignsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChangeLog class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChangeLogsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CitiesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class City class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClickTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClickThroughUrl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClickThroughUrlSuffixProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompanionClickThroughOverride class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompanionSetting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompatibleFields class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConnectionType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConnectionTypesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContentCategoriesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContentCategory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Conversion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionsBatchInsertRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionsBatchInsertResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionsBatchUpdateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionsBatchUpdateResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CountriesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Country 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 CreativeAsset class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeAssetId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeAssetMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeAssetSelection class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeCustomEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeField class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeFieldAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeFieldValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeFieldValuesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeFieldsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeGroupAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeOptimizationConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeRotation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CrossDimensionReachReportCompatibleFields class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomFloodlightVariable class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomRichMediaEvents 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 DayPartTargeting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DefaultClickThroughEventTagProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeliverySchedule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DfpSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Dimension class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DimensionFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DimensionValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DimensionValueList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DimensionValueRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySite class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySiteContact class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySiteContactAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySiteContactsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySiteSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySitesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DynamicTargetingKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DynamicTargetingKeysListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EncryptionInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventTagOverride class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventTagsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class File class Representation < Google::Apis::Core::JsonRepresentation; end class Urls class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class FileList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Flight class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivitiesGenerateTagResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivitiesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivityDynamicTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivityGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivityGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivityPublisherDynamicTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightConfigurationsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightReportCompatibleFields 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 FsCommand class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GeoTargeting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InventoryItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InventoryItemsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class KeyValueTargetingExpression class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LandingPage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LandingPagesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Language class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LanguageTargeting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LanguagesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LastModifiedInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPopulationClause class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPopulationRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPopulationTerm class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTargetingExpression class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LookbackConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Metric class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Metro class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetrosListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MobileCarrier class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MobileCarriersListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ObjectFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OffsetPosition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OmnitureSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperatingSystem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperatingSystemVersion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperatingSystemVersionsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperatingSystemsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OptimizationActivity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Order class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderContact class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderDocument class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderDocumentsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PathToConversionReportCompatibleFields class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Placement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementStrategiesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementStrategy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementsGenerateTagsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlatformType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlatformTypesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PopupWindowProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PostalCode class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PostalCodesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Pricing class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PricingSchedule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PricingSchedulePricingPeriod class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Project class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReachReportCompatibleFields class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Recipient class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Region class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemarketingList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemarketingListShare class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemarketingListsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Report class Representation < Google::Apis::Core::JsonRepresentation; end class Criteria class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CrossDimensionReachCriteria class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Delivery class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightCriteria class Representation < Google::Apis::Core::JsonRepresentation; end class ReportProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class PathToConversionCriteria class Representation < Google::Apis::Core::JsonRepresentation; end class ReportProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ReachCriteria class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Schedule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ReportCompatibleFields class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportsConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RichMediaExitOverride class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Rule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Site class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SiteContact class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SiteSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SitesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Size class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SizesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SkippableSetting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SortedDimension class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Subaccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SubaccountsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TagData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TagSetting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TagSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetWindow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetableRemarketingList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetableRemarketingListsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetingTemplate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetingTemplatesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TechnologyTargeting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThirdPartyAuthenticationToken class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThirdPartyTrackingUrl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TranscodeSetting 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 UserDefinedVariableConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserProfile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserProfileList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRole class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRolePermission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRolePermissionGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRolePermissionGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRolePermissionsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRolesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoFormat class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoFormatsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoOffset class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Account # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_permission_ids, as: 'accountPermissionIds' property :account_profile, as: 'accountProfile' property :active, as: 'active' property :active_ads_limit_tier, as: 'activeAdsLimitTier' property :active_view_opt_out, as: 'activeViewOptOut' collection :available_permission_ids, as: 'availablePermissionIds' property :country_id, :numeric_string => true, as: 'countryId' property :currency_id, :numeric_string => true, as: 'currencyId' property :default_creative_size_id, :numeric_string => true, as: 'defaultCreativeSizeId' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :locale, as: 'locale' property :maximum_image_size, :numeric_string => true, as: 'maximumImageSize' property :name, as: 'name' property :nielsen_ocr_enabled, as: 'nielsenOcrEnabled' property :reports_configuration, as: 'reportsConfiguration', class: Google::Apis::DfareportingV2_8::ReportsConfiguration, decorator: Google::Apis::DfareportingV2_8::ReportsConfiguration::Representation property :share_reports_with_twitter, as: 'shareReportsWithTwitter' property :teaser_size_limit, :numeric_string => true, as: 'teaserSizeLimit' end end class AccountActiveAdSummary # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active_ads, :numeric_string => true, as: 'activeAds' property :active_ads_limit_tier, as: 'activeAdsLimitTier' property :available_ads, :numeric_string => true, as: 'availableAds' property :kind, as: 'kind' end end class AccountPermission # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_profiles, as: 'accountProfiles' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :level, as: 'level' property :name, as: 'name' property :permission_group_id, :numeric_string => true, as: 'permissionGroupId' end end class AccountPermissionGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class AccountPermissionGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_permission_groups, as: 'accountPermissionGroups', class: Google::Apis::DfareportingV2_8::AccountPermissionGroup, decorator: Google::Apis::DfareportingV2_8::AccountPermissionGroup::Representation property :kind, as: 'kind' end end class AccountPermissionsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_permissions, as: 'accountPermissions', class: Google::Apis::DfareportingV2_8::AccountPermission, decorator: Google::Apis::DfareportingV2_8::AccountPermission::Representation property :kind, as: 'kind' end end class AccountUserProfile # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active, as: 'active' property :advertiser_filter, as: 'advertiserFilter', class: Google::Apis::DfareportingV2_8::ObjectFilter, decorator: Google::Apis::DfareportingV2_8::ObjectFilter::Representation property :campaign_filter, as: 'campaignFilter', class: Google::Apis::DfareportingV2_8::ObjectFilter, decorator: Google::Apis::DfareportingV2_8::ObjectFilter::Representation property :comments, as: 'comments' property :email, as: 'email' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :locale, as: 'locale' property :name, as: 'name' property :site_filter, as: 'siteFilter', class: Google::Apis::DfareportingV2_8::ObjectFilter, decorator: Google::Apis::DfareportingV2_8::ObjectFilter::Representation property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :trafficker_type, as: 'traffickerType' property :user_access_type, as: 'userAccessType' property :user_role_filter, as: 'userRoleFilter', class: Google::Apis::DfareportingV2_8::ObjectFilter, decorator: Google::Apis::DfareportingV2_8::ObjectFilter::Representation property :user_role_id, :numeric_string => true, as: 'userRoleId' end end class AccountUserProfilesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_user_profiles, as: 'accountUserProfiles', class: Google::Apis::DfareportingV2_8::AccountUserProfile, decorator: Google::Apis::DfareportingV2_8::AccountUserProfile::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class AccountsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accounts, as: 'accounts', class: Google::Apis::DfareportingV2_8::Account, decorator: Google::Apis::DfareportingV2_8::Account::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Activities # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filters, as: 'filters', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :kind, as: 'kind' collection :metric_names, as: 'metricNames' end end class Ad # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active, as: 'active' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :archived, as: 'archived' property :audience_segment_id, :numeric_string => true, as: 'audienceSegmentId' property :campaign_id, :numeric_string => true, as: 'campaignId' property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV2_8::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_8::ClickThroughUrl::Representation property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV2_8::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV2_8::ClickThroughUrlSuffixProperties::Representation property :comments, as: 'comments' property :compatibility, as: 'compatibility' property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV2_8::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV2_8::CreativeGroupAssignment::Representation property :creative_rotation, as: 'creativeRotation', class: Google::Apis::DfareportingV2_8::CreativeRotation, decorator: Google::Apis::DfareportingV2_8::CreativeRotation::Representation property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV2_8::DayPartTargeting, decorator: Google::Apis::DfareportingV2_8::DayPartTargeting::Representation property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV2_8::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV2_8::DefaultClickThroughEventTagProperties::Representation property :delivery_schedule, as: 'deliverySchedule', class: Google::Apis::DfareportingV2_8::DeliverySchedule, decorator: Google::Apis::DfareportingV2_8::DeliverySchedule::Representation property :dynamic_click_tracker, as: 'dynamicClickTracker' property :end_time, as: 'endTime', type: DateTime collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV2_8::EventTagOverride, decorator: Google::Apis::DfareportingV2_8::EventTagOverride::Representation property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV2_8::GeoTargeting, decorator: Google::Apis::DfareportingV2_8::GeoTargeting::Representation property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV2_8::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV2_8::KeyValueTargetingExpression::Representation property :kind, as: 'kind' property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV2_8::LanguageTargeting, decorator: Google::Apis::DfareportingV2_8::LanguageTargeting::Representation property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :name, as: 'name' collection :placement_assignments, as: 'placementAssignments', class: Google::Apis::DfareportingV2_8::PlacementAssignment, decorator: Google::Apis::DfareportingV2_8::PlacementAssignment::Representation property :remarketing_list_expression, as: 'remarketingListExpression', class: Google::Apis::DfareportingV2_8::ListTargetingExpression, decorator: Google::Apis::DfareportingV2_8::ListTargetingExpression::Representation property :size, as: 'size', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation property :ssl_compliant, as: 'sslCompliant' property :ssl_required, as: 'sslRequired' property :start_time, as: 'startTime', type: DateTime property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :targeting_template_id, :numeric_string => true, as: 'targetingTemplateId' property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV2_8::TechnologyTargeting, decorator: Google::Apis::DfareportingV2_8::TechnologyTargeting::Representation property :type, as: 'type' end end class AdBlockingConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through_url, as: 'clickThroughUrl' property :creative_bundle_id, :numeric_string => true, as: 'creativeBundleId' property :enabled, as: 'enabled' property :override_click_through_url, as: 'overrideClickThroughUrl' end end class AdSlot # @private class Representation < Google::Apis::Core::JsonRepresentation property :comment, as: 'comment' property :compatibility, as: 'compatibility' property :height, :numeric_string => true, as: 'height' property :linked_placement_id, :numeric_string => true, as: 'linkedPlacementId' property :name, as: 'name' property :payment_source_type, as: 'paymentSourceType' property :primary, as: 'primary' property :width, :numeric_string => true, as: 'width' end end class AdsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ads, as: 'ads', class: Google::Apis::DfareportingV2_8::Ad, decorator: Google::Apis::DfareportingV2_8::Ad::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Advertiser # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_group_id, :numeric_string => true, as: 'advertiserGroupId' property :click_through_url_suffix, as: 'clickThroughUrlSuffix' property :default_click_through_event_tag_id, :numeric_string => true, as: 'defaultClickThroughEventTagId' property :default_email, as: 'defaultEmail' property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :kind, as: 'kind' property :name, as: 'name' property :original_floodlight_configuration_id, :numeric_string => true, as: 'originalFloodlightConfigurationId' property :status, as: 'status' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :suspended, as: 'suspended' end end class AdvertiserGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class AdvertiserGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :advertiser_groups, as: 'advertiserGroups', class: Google::Apis::DfareportingV2_8::AdvertiserGroup, decorator: Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class AdvertisersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :advertisers, as: 'advertisers', class: Google::Apis::DfareportingV2_8::Advertiser, decorator: Google::Apis::DfareportingV2_8::Advertiser::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class AudienceSegment # @private class Representation < Google::Apis::Core::JsonRepresentation property :allocation, as: 'allocation' property :id, :numeric_string => true, as: 'id' property :name, as: 'name' end end class AudienceSegmentGroup # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audience_segments, as: 'audienceSegments', class: Google::Apis::DfareportingV2_8::AudienceSegment, decorator: Google::Apis::DfareportingV2_8::AudienceSegment::Representation property :id, :numeric_string => true, as: 'id' property :name, as: 'name' end end class Browser # @private class Representation < Google::Apis::Core::JsonRepresentation property :browser_version_id, :numeric_string => true, as: 'browserVersionId' property :dart_id, :numeric_string => true, as: 'dartId' property :kind, as: 'kind' property :major_version, as: 'majorVersion' property :minor_version, as: 'minorVersion' property :name, as: 'name' end end class BrowsersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :browsers, as: 'browsers', class: Google::Apis::DfareportingV2_8::Browser, decorator: Google::Apis::DfareportingV2_8::Browser::Representation property :kind, as: 'kind' end end class Campaign # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :ad_blocking_configuration, as: 'adBlockingConfiguration', class: Google::Apis::DfareportingV2_8::AdBlockingConfiguration, decorator: Google::Apis::DfareportingV2_8::AdBlockingConfiguration::Representation collection :additional_creative_optimization_configurations, as: 'additionalCreativeOptimizationConfigurations', class: Google::Apis::DfareportingV2_8::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV2_8::CreativeOptimizationConfiguration::Representation property :advertiser_group_id, :numeric_string => true, as: 'advertiserGroupId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :archived, as: 'archived' collection :audience_segment_groups, as: 'audienceSegmentGroups', class: Google::Apis::DfareportingV2_8::AudienceSegmentGroup, decorator: Google::Apis::DfareportingV2_8::AudienceSegmentGroup::Representation property :billing_invoice_code, as: 'billingInvoiceCode' property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV2_8::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV2_8::ClickThroughUrlSuffixProperties::Representation property :comment, as: 'comment' property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation collection :creative_group_ids, as: 'creativeGroupIds' property :creative_optimization_configuration, as: 'creativeOptimizationConfiguration', class: Google::Apis::DfareportingV2_8::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV2_8::CreativeOptimizationConfiguration::Representation property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV2_8::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV2_8::DefaultClickThroughEventTagProperties::Representation property :end_date, as: 'endDate', type: Date collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV2_8::EventTagOverride, decorator: Google::Apis::DfareportingV2_8::EventTagOverride::Representation property :external_id, as: 'externalId' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_8::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_8::LookbackConfiguration::Representation property :name, as: 'name' property :nielsen_ocr_enabled, as: 'nielsenOcrEnabled' property :start_date, as: 'startDate', type: Date property :subaccount_id, :numeric_string => true, as: 'subaccountId' collection :trafficker_emails, as: 'traffickerEmails' end end class CampaignCreativeAssociation # @private class Representation < Google::Apis::Core::JsonRepresentation property :creative_id, :numeric_string => true, as: 'creativeId' property :kind, as: 'kind' end end class CampaignCreativeAssociationsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :campaign_creative_associations, as: 'campaignCreativeAssociations', class: Google::Apis::DfareportingV2_8::CampaignCreativeAssociation, decorator: Google::Apis::DfareportingV2_8::CampaignCreativeAssociation::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CampaignsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :campaigns, as: 'campaigns', class: Google::Apis::DfareportingV2_8::Campaign, decorator: Google::Apis::DfareportingV2_8::Campaign::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class ChangeLog # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :action, as: 'action' property :change_time, as: 'changeTime', type: DateTime property :field_name, as: 'fieldName' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :new_value, as: 'newValue' property :object_id_prop, :numeric_string => true, as: 'objectId' property :object_type, as: 'objectType' property :old_value, as: 'oldValue' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :transaction_id, :numeric_string => true, as: 'transactionId' property :user_profile_id, :numeric_string => true, as: 'userProfileId' property :user_profile_name, as: 'userProfileName' end end class ChangeLogsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :change_logs, as: 'changeLogs', class: Google::Apis::DfareportingV2_8::ChangeLog, decorator: Google::Apis::DfareportingV2_8::ChangeLog::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CitiesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :cities, as: 'cities', class: Google::Apis::DfareportingV2_8::City, decorator: Google::Apis::DfareportingV2_8::City::Representation property :kind, as: 'kind' end end class City # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :country_dart_id, :numeric_string => true, as: 'countryDartId' property :dart_id, :numeric_string => true, as: 'dartId' property :kind, as: 'kind' property :metro_code, as: 'metroCode' property :metro_dma_id, :numeric_string => true, as: 'metroDmaId' property :name, as: 'name' property :region_code, as: 'regionCode' property :region_dart_id, :numeric_string => true, as: 'regionDartId' end end class ClickTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :event_name, as: 'eventName' property :name, as: 'name' property :value, as: 'value' end end class ClickThroughUrl # @private class Representation < Google::Apis::Core::JsonRepresentation property :computed_click_through_url, as: 'computedClickThroughUrl' property :custom_click_through_url, as: 'customClickThroughUrl' property :default_landing_page, as: 'defaultLandingPage' property :landing_page_id, :numeric_string => true, as: 'landingPageId' end end class ClickThroughUrlSuffixProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through_url_suffix, as: 'clickThroughUrlSuffix' property :override_inherited_suffix, as: 'overrideInheritedSuffix' end end class CompanionClickThroughOverride # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV2_8::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_8::ClickThroughUrl::Representation property :creative_id, :numeric_string => true, as: 'creativeId' end end class CompanionSetting # @private class Representation < Google::Apis::Core::JsonRepresentation property :companions_disabled, as: 'companionsDisabled' collection :enabled_sizes, as: 'enabledSizes', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation property :image_only, as: 'imageOnly' property :kind, as: 'kind' end end class CompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation property :cross_dimension_reach_report_compatible_fields, as: 'crossDimensionReachReportCompatibleFields', class: Google::Apis::DfareportingV2_8::CrossDimensionReachReportCompatibleFields, decorator: Google::Apis::DfareportingV2_8::CrossDimensionReachReportCompatibleFields::Representation property :floodlight_report_compatible_fields, as: 'floodlightReportCompatibleFields', class: Google::Apis::DfareportingV2_8::FloodlightReportCompatibleFields, decorator: Google::Apis::DfareportingV2_8::FloodlightReportCompatibleFields::Representation property :kind, as: 'kind' property :path_to_conversion_report_compatible_fields, as: 'pathToConversionReportCompatibleFields', class: Google::Apis::DfareportingV2_8::PathToConversionReportCompatibleFields, decorator: Google::Apis::DfareportingV2_8::PathToConversionReportCompatibleFields::Representation property :reach_report_compatible_fields, as: 'reachReportCompatibleFields', class: Google::Apis::DfareportingV2_8::ReachReportCompatibleFields, decorator: Google::Apis::DfareportingV2_8::ReachReportCompatibleFields::Representation property :report_compatible_fields, as: 'reportCompatibleFields', class: Google::Apis::DfareportingV2_8::ReportCompatibleFields, decorator: Google::Apis::DfareportingV2_8::ReportCompatibleFields::Representation end end class ConnectionType # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class ConnectionTypesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :connection_types, as: 'connectionTypes', class: Google::Apis::DfareportingV2_8::ConnectionType, decorator: Google::Apis::DfareportingV2_8::ConnectionType::Representation property :kind, as: 'kind' end end class ContentCategoriesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :content_categories, as: 'contentCategories', class: Google::Apis::DfareportingV2_8::ContentCategory, decorator: Google::Apis::DfareportingV2_8::ContentCategory::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class ContentCategory # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class Conversion # @private class Representation < Google::Apis::Core::JsonRepresentation property :child_directed_treatment, as: 'childDirectedTreatment' collection :custom_variables, as: 'customVariables', class: Google::Apis::DfareportingV2_8::CustomFloodlightVariable, decorator: Google::Apis::DfareportingV2_8::CustomFloodlightVariable::Representation property :encrypted_user_id, as: 'encryptedUserId' collection :encrypted_user_id_candidates, as: 'encryptedUserIdCandidates' property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' property :gclid, as: 'gclid' property :kind, as: 'kind' property :limit_ad_tracking, as: 'limitAdTracking' property :mobile_device_id, as: 'mobileDeviceId' property :ordinal, as: 'ordinal' property :quantity, :numeric_string => true, as: 'quantity' property :timestamp_micros, :numeric_string => true, as: 'timestampMicros' property :value, as: 'value' end end class ConversionError # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :kind, as: 'kind' property :message, as: 'message' end end class ConversionStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :conversion, as: 'conversion', class: Google::Apis::DfareportingV2_8::Conversion, decorator: Google::Apis::DfareportingV2_8::Conversion::Representation collection :errors, as: 'errors', class: Google::Apis::DfareportingV2_8::ConversionError, decorator: Google::Apis::DfareportingV2_8::ConversionError::Representation property :kind, as: 'kind' end end class ConversionsBatchInsertRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV2_8::Conversion, decorator: Google::Apis::DfareportingV2_8::Conversion::Representation property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV2_8::EncryptionInfo, decorator: Google::Apis::DfareportingV2_8::EncryptionInfo::Representation property :kind, as: 'kind' end end class ConversionsBatchInsertResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :has_failures, as: 'hasFailures' property :kind, as: 'kind' collection :status, as: 'status', class: Google::Apis::DfareportingV2_8::ConversionStatus, decorator: Google::Apis::DfareportingV2_8::ConversionStatus::Representation end end class ConversionsBatchUpdateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV2_8::Conversion, decorator: Google::Apis::DfareportingV2_8::Conversion::Representation property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV2_8::EncryptionInfo, decorator: Google::Apis::DfareportingV2_8::EncryptionInfo::Representation property :kind, as: 'kind' end end class ConversionsBatchUpdateResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :has_failures, as: 'hasFailures' property :kind, as: 'kind' collection :status, as: 'status', class: Google::Apis::DfareportingV2_8::ConversionStatus, decorator: Google::Apis::DfareportingV2_8::ConversionStatus::Representation end end class CountriesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :countries, as: 'countries', class: Google::Apis::DfareportingV2_8::Country, decorator: Google::Apis::DfareportingV2_8::Country::Representation property :kind, as: 'kind' end end class Country # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :dart_id, :numeric_string => true, as: 'dartId' property :kind, as: 'kind' property :name, as: 'name' property :ssl_enabled, as: 'sslEnabled' end end class Creative # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active, as: 'active' property :ad_parameters, as: 'adParameters' collection :ad_tag_keys, as: 'adTagKeys' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :allow_script_access, as: 'allowScriptAccess' property :archived, as: 'archived' property :artwork_type, as: 'artworkType' property :authoring_source, as: 'authoringSource' property :authoring_tool, as: 'authoringTool' property :auto_advance_images, as: 'autoAdvanceImages' property :background_color, as: 'backgroundColor' property :backup_image_click_through_url, as: 'backupImageClickThroughUrl' collection :backup_image_features, as: 'backupImageFeatures' property :backup_image_reporting_label, as: 'backupImageReportingLabel' property :backup_image_target_window, as: 'backupImageTargetWindow', class: Google::Apis::DfareportingV2_8::TargetWindow, decorator: Google::Apis::DfareportingV2_8::TargetWindow::Representation collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV2_8::ClickTag, decorator: Google::Apis::DfareportingV2_8::ClickTag::Representation property :commercial_id, as: 'commercialId' collection :companion_creatives, as: 'companionCreatives' collection :compatibility, as: 'compatibility' property :convert_flash_to_html5, as: 'convertFlashToHtml5' collection :counter_custom_events, as: 'counterCustomEvents', class: Google::Apis::DfareportingV2_8::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_8::CreativeCustomEvent::Representation property :creative_asset_selection, as: 'creativeAssetSelection', class: Google::Apis::DfareportingV2_8::CreativeAssetSelection, decorator: Google::Apis::DfareportingV2_8::CreativeAssetSelection::Representation collection :creative_assets, as: 'creativeAssets', class: Google::Apis::DfareportingV2_8::CreativeAsset, decorator: Google::Apis::DfareportingV2_8::CreativeAsset::Representation collection :creative_field_assignments, as: 'creativeFieldAssignments', class: Google::Apis::DfareportingV2_8::CreativeFieldAssignment, decorator: Google::Apis::DfareportingV2_8::CreativeFieldAssignment::Representation collection :custom_key_values, as: 'customKeyValues' property :dynamic_asset_selection, as: 'dynamicAssetSelection' collection :exit_custom_events, as: 'exitCustomEvents', class: Google::Apis::DfareportingV2_8::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_8::CreativeCustomEvent::Representation property :fs_command, as: 'fsCommand', class: Google::Apis::DfareportingV2_8::FsCommand, decorator: Google::Apis::DfareportingV2_8::FsCommand::Representation property :html_code, as: 'htmlCode' property :html_code_locked, as: 'htmlCodeLocked' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :latest_trafficked_creative_id, :numeric_string => true, as: 'latestTraffickedCreativeId' property :name, as: 'name' property :override_css, as: 'overrideCss' property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV2_8::VideoOffset, decorator: Google::Apis::DfareportingV2_8::VideoOffset::Representation property :redirect_url, as: 'redirectUrl' property :rendering_id, :numeric_string => true, as: 'renderingId' property :rendering_id_dimension_value, as: 'renderingIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :required_flash_plugin_version, as: 'requiredFlashPluginVersion' property :required_flash_version, as: 'requiredFlashVersion' property :size, as: 'size', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV2_8::VideoOffset, decorator: Google::Apis::DfareportingV2_8::VideoOffset::Representation property :skippable, as: 'skippable' property :ssl_compliant, as: 'sslCompliant' property :ssl_override, as: 'sslOverride' property :studio_advertiser_id, :numeric_string => true, as: 'studioAdvertiserId' property :studio_creative_id, :numeric_string => true, as: 'studioCreativeId' property :studio_trafficked_creative_id, :numeric_string => true, as: 'studioTraffickedCreativeId' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :third_party_backup_image_impressions_url, as: 'thirdPartyBackupImageImpressionsUrl' property :third_party_rich_media_impressions_url, as: 'thirdPartyRichMediaImpressionsUrl' collection :third_party_urls, as: 'thirdPartyUrls', class: Google::Apis::DfareportingV2_8::ThirdPartyTrackingUrl, decorator: Google::Apis::DfareportingV2_8::ThirdPartyTrackingUrl::Representation collection :timer_custom_events, as: 'timerCustomEvents', class: Google::Apis::DfareportingV2_8::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_8::CreativeCustomEvent::Representation property :total_file_size, :numeric_string => true, as: 'totalFileSize' property :type, as: 'type' property :universal_ad_id, as: 'universalAdId', class: Google::Apis::DfareportingV2_8::UniversalAdId, decorator: Google::Apis::DfareportingV2_8::UniversalAdId::Representation property :version, as: 'version' property :video_description, as: 'videoDescription' property :video_duration, as: 'videoDuration' end end class CreativeAsset # @private class Representation < Google::Apis::Core::JsonRepresentation property :action_script3, as: 'actionScript3' property :active, as: 'active' property :alignment, as: 'alignment' property :artwork_type, as: 'artworkType' property :asset_identifier, as: 'assetIdentifier', class: Google::Apis::DfareportingV2_8::CreativeAssetId, decorator: Google::Apis::DfareportingV2_8::CreativeAssetId::Representation property :backup_image_exit, as: 'backupImageExit', class: Google::Apis::DfareportingV2_8::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_8::CreativeCustomEvent::Representation property :bit_rate, as: 'bitRate' property :child_asset_type, as: 'childAssetType' property :collapsed_size, as: 'collapsedSize', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation collection :companion_creative_ids, as: 'companionCreativeIds' property :custom_start_time_value, as: 'customStartTimeValue' collection :detected_features, as: 'detectedFeatures' property :display_type, as: 'displayType' property :duration, as: 'duration' property :duration_type, as: 'durationType' property :expanded_dimension, as: 'expandedDimension', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation property :file_size, :numeric_string => true, as: 'fileSize' property :flash_version, as: 'flashVersion' property :hide_flash_objects, as: 'hideFlashObjects' property :hide_selection_boxes, as: 'hideSelectionBoxes' property :horizontally_locked, as: 'horizontallyLocked' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :mime_type, as: 'mimeType' property :offset, as: 'offset', class: Google::Apis::DfareportingV2_8::OffsetPosition, decorator: Google::Apis::DfareportingV2_8::OffsetPosition::Representation property :original_backup, as: 'originalBackup' property :position, as: 'position', class: Google::Apis::DfareportingV2_8::OffsetPosition, decorator: Google::Apis::DfareportingV2_8::OffsetPosition::Representation property :position_left_unit, as: 'positionLeftUnit' property :position_top_unit, as: 'positionTopUnit' property :progressive_serving_url, as: 'progressiveServingUrl' property :pushdown, as: 'pushdown' property :pushdown_duration, as: 'pushdownDuration' property :role, as: 'role' property :size, as: 'size', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation property :ssl_compliant, as: 'sslCompliant' property :start_time_type, as: 'startTimeType' property :streaming_serving_url, as: 'streamingServingUrl' property :transparency, as: 'transparency' property :vertically_locked, as: 'verticallyLocked' property :video_duration, as: 'videoDuration' property :window_mode, as: 'windowMode' property :z_index, as: 'zIndex' property :zip_filename, as: 'zipFilename' property :zip_filesize, as: 'zipFilesize' end end class CreativeAssetId # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :type, as: 'type' end end class CreativeAssetMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :asset_identifier, as: 'assetIdentifier', class: Google::Apis::DfareportingV2_8::CreativeAssetId, decorator: Google::Apis::DfareportingV2_8::CreativeAssetId::Representation collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV2_8::ClickTag, decorator: Google::Apis::DfareportingV2_8::ClickTag::Representation collection :detected_features, as: 'detectedFeatures' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :kind, as: 'kind' collection :warned_validation_rules, as: 'warnedValidationRules' end end class CreativeAssetSelection # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_asset_id, :numeric_string => true, as: 'defaultAssetId' collection :rules, as: 'rules', class: Google::Apis::DfareportingV2_8::Rule, decorator: Google::Apis::DfareportingV2_8::Rule::Representation end end class CreativeAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :active, as: 'active' property :apply_event_tags, as: 'applyEventTags' property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV2_8::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_8::ClickThroughUrl::Representation collection :companion_creative_overrides, as: 'companionCreativeOverrides', class: Google::Apis::DfareportingV2_8::CompanionClickThroughOverride, decorator: Google::Apis::DfareportingV2_8::CompanionClickThroughOverride::Representation collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV2_8::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV2_8::CreativeGroupAssignment::Representation property :creative_id, :numeric_string => true, as: 'creativeId' property :creative_id_dimension_value, as: 'creativeIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :end_time, as: 'endTime', type: DateTime collection :rich_media_exit_overrides, as: 'richMediaExitOverrides', class: Google::Apis::DfareportingV2_8::RichMediaExitOverride, decorator: Google::Apis::DfareportingV2_8::RichMediaExitOverride::Representation property :sequence, as: 'sequence' property :ssl_compliant, as: 'sslCompliant' property :start_time, as: 'startTime', type: DateTime property :weight, as: 'weight' end end class CreativeCustomEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :advertiser_custom_event_id, :numeric_string => true, as: 'advertiserCustomEventId' property :advertiser_custom_event_name, as: 'advertiserCustomEventName' property :advertiser_custom_event_type, as: 'advertiserCustomEventType' property :artwork_label, as: 'artworkLabel' property :artwork_type, as: 'artworkType' property :exit_url, as: 'exitUrl' property :id, :numeric_string => true, as: 'id' property :popup_window_properties, as: 'popupWindowProperties', class: Google::Apis::DfareportingV2_8::PopupWindowProperties, decorator: Google::Apis::DfareportingV2_8::PopupWindowProperties::Representation property :target_type, as: 'targetType' property :video_reporting_id, as: 'videoReportingId' end end class CreativeField # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class CreativeFieldAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :creative_field_id, :numeric_string => true, as: 'creativeFieldId' property :creative_field_value_id, :numeric_string => true, as: 'creativeFieldValueId' end end class CreativeFieldValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :value, as: 'value' end end class CreativeFieldValuesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creative_field_values, as: 'creativeFieldValues', class: Google::Apis::DfareportingV2_8::CreativeFieldValue, decorator: Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CreativeFieldsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creative_fields, as: 'creativeFields', class: Google::Apis::DfareportingV2_8::CreativeField, decorator: Google::Apis::DfareportingV2_8::CreativeField::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CreativeGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :group_number, as: 'groupNumber' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class CreativeGroupAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :creative_group_id, :numeric_string => true, as: 'creativeGroupId' property :creative_group_number, as: 'creativeGroupNumber' end end class CreativeGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creative_groups, as: 'creativeGroups', class: Google::Apis::DfareportingV2_8::CreativeGroup, decorator: Google::Apis::DfareportingV2_8::CreativeGroup::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CreativeOptimizationConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :name, as: 'name' collection :optimization_activitys, as: 'optimizationActivitys', class: Google::Apis::DfareportingV2_8::OptimizationActivity, decorator: Google::Apis::DfareportingV2_8::OptimizationActivity::Representation property :optimization_model, as: 'optimizationModel' end end class CreativeRotation # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creative_assignments, as: 'creativeAssignments', class: Google::Apis::DfareportingV2_8::CreativeAssignment, decorator: Google::Apis::DfareportingV2_8::CreativeAssignment::Representation property :creative_optimization_configuration_id, :numeric_string => true, as: 'creativeOptimizationConfigurationId' property :type, as: 'type' property :weight_calculation_strategy, as: 'weightCalculationStrategy' end end class CreativeSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :i_frame_footer, as: 'iFrameFooter' property :i_frame_header, as: 'iFrameHeader' end end class CreativesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creatives, as: 'creatives', class: Google::Apis::DfareportingV2_8::Creative, decorator: Google::Apis::DfareportingV2_8::Creative::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CrossDimensionReachReportCompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation collection :breakdown, as: 'breakdown', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation property :kind, as: 'kind' collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation collection :overlap_metrics, as: 'overlapMetrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation end end class CustomFloodlightVariable # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :type, as: 'type' property :value, as: 'value' end end class CustomRichMediaEvents # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filtered_event_ids, as: 'filteredEventIds', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :kind, as: 'kind' end end class DateRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_date, as: 'endDate', type: Date property :kind, as: 'kind' property :relative_date_range, as: 'relativeDateRange' property :start_date, as: 'startDate', type: Date end end class DayPartTargeting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :days_of_week, as: 'daysOfWeek' collection :hours_of_day, as: 'hoursOfDay' property :user_local_time, as: 'userLocalTime' end end class DefaultClickThroughEventTagProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_click_through_event_tag_id, :numeric_string => true, as: 'defaultClickThroughEventTagId' property :override_inherited_event_tag, as: 'overrideInheritedEventTag' end end class DeliverySchedule # @private class Representation < Google::Apis::Core::JsonRepresentation property :frequency_cap, as: 'frequencyCap', class: Google::Apis::DfareportingV2_8::FrequencyCap, decorator: Google::Apis::DfareportingV2_8::FrequencyCap::Representation property :hard_cutoff, as: 'hardCutoff' property :impression_ratio, :numeric_string => true, as: 'impressionRatio' property :priority, as: 'priority' end end class DfpSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :dfp_network_code, as: 'dfpNetworkCode' property :dfp_network_name, as: 'dfpNetworkName' property :programmatic_placement_accepted, as: 'programmaticPlacementAccepted' property :pub_paid_placement_accepted, as: 'pubPaidPlacementAccepted' property :publisher_portal_only, as: 'publisherPortalOnly' end end class Dimension # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :name, as: 'name' end end class DimensionFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension_name, as: 'dimensionName' property :kind, as: 'kind' property :value, as: 'value' end end class DimensionValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension_name, as: 'dimensionName' property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :match_type, as: 'matchType' property :value, as: 'value' end end class DimensionValueList # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class DimensionValueRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension_name, as: 'dimensionName' property :end_date, as: 'endDate', type: Date collection :filters, as: 'filters', class: Google::Apis::DfareportingV2_8::DimensionFilter, decorator: Google::Apis::DfareportingV2_8::DimensionFilter::Representation property :kind, as: 'kind' property :start_date, as: 'startDate', type: Date end end class DirectorySite # @private class Representation < Google::Apis::Core::JsonRepresentation property :active, as: 'active' collection :contact_assignments, as: 'contactAssignments', class: Google::Apis::DfareportingV2_8::DirectorySiteContactAssignment, decorator: Google::Apis::DfareportingV2_8::DirectorySiteContactAssignment::Representation property :country_id, :numeric_string => true, as: 'countryId' property :currency_id, :numeric_string => true, as: 'currencyId' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation collection :inpage_tag_formats, as: 'inpageTagFormats' collection :interstitial_tag_formats, as: 'interstitialTagFormats' property :kind, as: 'kind' property :name, as: 'name' property :parent_id, :numeric_string => true, as: 'parentId' property :settings, as: 'settings', class: Google::Apis::DfareportingV2_8::DirectorySiteSettings, decorator: Google::Apis::DfareportingV2_8::DirectorySiteSettings::Representation property :url, as: 'url' end end class DirectorySiteContact # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address' property :email, as: 'email' property :first_name, as: 'firstName' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :last_name, as: 'lastName' property :phone, as: 'phone' property :role, as: 'role' property :title, as: 'title' property :type, as: 'type' end end class DirectorySiteContactAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :contact_id, :numeric_string => true, as: 'contactId' property :visibility, as: 'visibility' end end class DirectorySiteContactsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :directory_site_contacts, as: 'directorySiteContacts', class: Google::Apis::DfareportingV2_8::DirectorySiteContact, decorator: Google::Apis::DfareportingV2_8::DirectorySiteContact::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class DirectorySiteSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :active_view_opt_out, as: 'activeViewOptOut' property :dfp_settings, as: 'dfpSettings', class: Google::Apis::DfareportingV2_8::DfpSettings, decorator: Google::Apis::DfareportingV2_8::DfpSettings::Representation property :instream_video_placement_accepted, as: 'instreamVideoPlacementAccepted' property :interstitial_placement_accepted, as: 'interstitialPlacementAccepted' property :nielsen_ocr_opt_out, as: 'nielsenOcrOptOut' property :verification_tag_opt_out, as: 'verificationTagOptOut' property :video_active_view_opt_out, as: 'videoActiveViewOptOut' end end class DirectorySitesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :directory_sites, as: 'directorySites', class: Google::Apis::DfareportingV2_8::DirectorySite, decorator: Google::Apis::DfareportingV2_8::DirectorySite::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class DynamicTargetingKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :name, as: 'name' property :object_id_prop, :numeric_string => true, as: 'objectId' property :object_type, as: 'objectType' end end class DynamicTargetingKeysListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dynamic_targeting_keys, as: 'dynamicTargetingKeys', class: Google::Apis::DfareportingV2_8::DynamicTargetingKey, decorator: Google::Apis::DfareportingV2_8::DynamicTargetingKey::Representation property :kind, as: 'kind' end end class EncryptionInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :encryption_entity_id, :numeric_string => true, as: 'encryptionEntityId' property :encryption_entity_type, as: 'encryptionEntityType' property :encryption_source, as: 'encryptionSource' property :kind, as: 'kind' end end class EventTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :campaign_id, :numeric_string => true, as: 'campaignId' property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :enabled_by_default, as: 'enabledByDefault' property :exclude_from_adx_requests, as: 'excludeFromAdxRequests' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :site_filter_type, as: 'siteFilterType' collection :site_ids, as: 'siteIds' property :ssl_compliant, as: 'sslCompliant' property :status, as: 'status' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :type, as: 'type' property :url, as: 'url' property :url_escape_levels, as: 'urlEscapeLevels' end end class EventTagOverride # @private class Representation < Google::Apis::Core::JsonRepresentation property :enabled, as: 'enabled' property :id, :numeric_string => true, as: 'id' end end class EventTagsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :event_tags, as: 'eventTags', class: Google::Apis::DfareportingV2_8::EventTag, decorator: Google::Apis::DfareportingV2_8::EventTag::Representation property :kind, as: 'kind' end end class File # @private class Representation < Google::Apis::Core::JsonRepresentation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation property :etag, as: 'etag' property :file_name, as: 'fileName' property :format, as: 'format' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :last_modified_time, :numeric_string => true, as: 'lastModifiedTime' property :report_id, :numeric_string => true, as: 'reportId' property :status, as: 'status' property :urls, as: 'urls', class: Google::Apis::DfareportingV2_8::File::Urls, decorator: Google::Apis::DfareportingV2_8::File::Urls::Representation end class Urls # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_url, as: 'apiUrl' property :browser_url, as: 'browserUrl' end end end class FileList # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::DfareportingV2_8::File, decorator: Google::Apis::DfareportingV2_8::File::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Flight # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_date, as: 'endDate', type: Date property :rate_or_cost, :numeric_string => true, as: 'rateOrCost' property :start_date, as: 'startDate', type: Date property :units, :numeric_string => true, as: 'units' end end class FloodlightActivitiesGenerateTagResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :floodlight_activity_tag, as: 'floodlightActivityTag' property :kind, as: 'kind' end end class FloodlightActivitiesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :floodlight_activities, as: 'floodlightActivities', class: Google::Apis::DfareportingV2_8::FloodlightActivity, decorator: Google::Apis::DfareportingV2_8::FloodlightActivity::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class FloodlightActivity # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :cache_busting_type, as: 'cacheBustingType' property :counting_method, as: 'countingMethod' collection :default_tags, as: 'defaultTags', class: Google::Apis::DfareportingV2_8::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV2_8::FloodlightActivityDynamicTag::Representation property :expected_url, as: 'expectedUrl' property :floodlight_activity_group_id, :numeric_string => true, as: 'floodlightActivityGroupId' property :floodlight_activity_group_name, as: 'floodlightActivityGroupName' property :floodlight_activity_group_tag_string, as: 'floodlightActivityGroupTagString' property :floodlight_activity_group_type, as: 'floodlightActivityGroupType' property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :hidden, as: 'hidden' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :image_tag_enabled, as: 'imageTagEnabled' property :kind, as: 'kind' property :name, as: 'name' property :notes, as: 'notes' collection :publisher_tags, as: 'publisherTags', class: Google::Apis::DfareportingV2_8::FloodlightActivityPublisherDynamicTag, decorator: Google::Apis::DfareportingV2_8::FloodlightActivityPublisherDynamicTag::Representation property :secure, as: 'secure' property :ssl_compliant, as: 'sslCompliant' property :ssl_required, as: 'sslRequired' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :tag_format, as: 'tagFormat' property :tag_string, as: 'tagString' collection :user_defined_variable_types, as: 'userDefinedVariableTypes' end end class FloodlightActivityDynamicTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :name, as: 'name' property :tag, as: 'tag' end end class FloodlightActivityGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :kind, as: 'kind' property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :tag_string, as: 'tagString' property :type, as: 'type' end end class FloodlightActivityGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :floodlight_activity_groups, as: 'floodlightActivityGroups', class: Google::Apis::DfareportingV2_8::FloodlightActivityGroup, decorator: Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class FloodlightActivityPublisherDynamicTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through, as: 'clickThrough' property :directory_site_id, :numeric_string => true, as: 'directorySiteId' property :dynamic_tag, as: 'dynamicTag', class: Google::Apis::DfareportingV2_8::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV2_8::FloodlightActivityDynamicTag::Representation property :site_id, :numeric_string => true, as: 'siteId' property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :view_through, as: 'viewThrough' end end class FloodlightConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :analytics_data_sharing_enabled, as: 'analyticsDataSharingEnabled' property :exposure_to_conversion_enabled, as: 'exposureToConversionEnabled' property :first_day_of_week, as: 'firstDayOfWeek' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :in_app_attribution_tracking_enabled, as: 'inAppAttributionTrackingEnabled' property :kind, as: 'kind' property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_8::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_8::LookbackConfiguration::Representation property :natural_search_conversion_attribution_option, as: 'naturalSearchConversionAttributionOption' property :omniture_settings, as: 'omnitureSettings', class: Google::Apis::DfareportingV2_8::OmnitureSettings, decorator: Google::Apis::DfareportingV2_8::OmnitureSettings::Representation property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :tag_settings, as: 'tagSettings', class: Google::Apis::DfareportingV2_8::TagSettings, decorator: Google::Apis::DfareportingV2_8::TagSettings::Representation collection :third_party_authentication_tokens, as: 'thirdPartyAuthenticationTokens', class: Google::Apis::DfareportingV2_8::ThirdPartyAuthenticationToken, decorator: Google::Apis::DfareportingV2_8::ThirdPartyAuthenticationToken::Representation collection :user_defined_variable_configurations, as: 'userDefinedVariableConfigurations', class: Google::Apis::DfareportingV2_8::UserDefinedVariableConfiguration, decorator: Google::Apis::DfareportingV2_8::UserDefinedVariableConfiguration::Representation end end class FloodlightConfigurationsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :floodlight_configurations, as: 'floodlightConfigurations', class: Google::Apis::DfareportingV2_8::FloodlightConfiguration, decorator: Google::Apis::DfareportingV2_8::FloodlightConfiguration::Representation property :kind, as: 'kind' end end class FloodlightReportCompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation property :kind, as: 'kind' collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation end end class FrequencyCap # @private class Representation < Google::Apis::Core::JsonRepresentation property :duration, :numeric_string => true, as: 'duration' property :impressions, :numeric_string => true, as: 'impressions' end end class FsCommand # @private class Representation < Google::Apis::Core::JsonRepresentation property :left, as: 'left' property :position_option, as: 'positionOption' property :top, as: 'top' property :window_height, as: 'windowHeight' property :window_width, as: 'windowWidth' end end class GeoTargeting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :cities, as: 'cities', class: Google::Apis::DfareportingV2_8::City, decorator: Google::Apis::DfareportingV2_8::City::Representation collection :countries, as: 'countries', class: Google::Apis::DfareportingV2_8::Country, decorator: Google::Apis::DfareportingV2_8::Country::Representation property :exclude_countries, as: 'excludeCountries' collection :metros, as: 'metros', class: Google::Apis::DfareportingV2_8::Metro, decorator: Google::Apis::DfareportingV2_8::Metro::Representation collection :postal_codes, as: 'postalCodes', class: Google::Apis::DfareportingV2_8::PostalCode, decorator: Google::Apis::DfareportingV2_8::PostalCode::Representation collection :regions, as: 'regions', class: Google::Apis::DfareportingV2_8::Region, decorator: Google::Apis::DfareportingV2_8::Region::Representation end end class InventoryItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' collection :ad_slots, as: 'adSlots', class: Google::Apis::DfareportingV2_8::AdSlot, decorator: Google::Apis::DfareportingV2_8::AdSlot::Representation property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :content_category_id, :numeric_string => true, as: 'contentCategoryId' property :estimated_click_through_rate, :numeric_string => true, as: 'estimatedClickThroughRate' property :estimated_conversion_rate, :numeric_string => true, as: 'estimatedConversionRate' property :id, :numeric_string => true, as: 'id' property :in_plan, as: 'inPlan' property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :name, as: 'name' property :negotiation_channel_id, :numeric_string => true, as: 'negotiationChannelId' property :order_id, :numeric_string => true, as: 'orderId' property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' property :pricing, as: 'pricing', class: Google::Apis::DfareportingV2_8::Pricing, decorator: Google::Apis::DfareportingV2_8::Pricing::Representation property :project_id, :numeric_string => true, as: 'projectId' property :rfp_id, :numeric_string => true, as: 'rfpId' property :site_id, :numeric_string => true, as: 'siteId' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :type, as: 'type' end end class InventoryItemsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :inventory_items, as: 'inventoryItems', class: Google::Apis::DfareportingV2_8::InventoryItem, decorator: Google::Apis::DfareportingV2_8::InventoryItem::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class KeyValueTargetingExpression # @private class Representation < Google::Apis::Core::JsonRepresentation property :expression, as: 'expression' end end class LandingPage # @private class Representation < Google::Apis::Core::JsonRepresentation property :default, as: 'default' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :url, as: 'url' end end class LandingPagesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :landing_pages, as: 'landingPages', class: Google::Apis::DfareportingV2_8::LandingPage, decorator: Google::Apis::DfareportingV2_8::LandingPage::Representation end end class Language # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :language_code, as: 'languageCode' property :name, as: 'name' end end class LanguageTargeting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :languages, as: 'languages', class: Google::Apis::DfareportingV2_8::Language, decorator: Google::Apis::DfareportingV2_8::Language::Representation end end class LanguagesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :languages, as: 'languages', class: Google::Apis::DfareportingV2_8::Language, decorator: Google::Apis::DfareportingV2_8::Language::Representation end end class LastModifiedInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :time, :numeric_string => true, as: 'time' end end class ListPopulationClause # @private class Representation < Google::Apis::Core::JsonRepresentation collection :terms, as: 'terms', class: Google::Apis::DfareportingV2_8::ListPopulationTerm, decorator: Google::Apis::DfareportingV2_8::ListPopulationTerm::Representation end end class ListPopulationRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' property :floodlight_activity_name, as: 'floodlightActivityName' collection :list_population_clauses, as: 'listPopulationClauses', class: Google::Apis::DfareportingV2_8::ListPopulationClause, decorator: Google::Apis::DfareportingV2_8::ListPopulationClause::Representation end end class ListPopulationTerm # @private class Representation < Google::Apis::Core::JsonRepresentation property :contains, as: 'contains' property :negation, as: 'negation' property :operator, as: 'operator' property :remarketing_list_id, :numeric_string => true, as: 'remarketingListId' property :type, as: 'type' property :value, as: 'value' property :variable_friendly_name, as: 'variableFriendlyName' property :variable_name, as: 'variableName' end end class ListTargetingExpression # @private class Representation < Google::Apis::Core::JsonRepresentation property :expression, as: 'expression' end end class LookbackConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_duration, as: 'clickDuration' property :post_impression_activities_duration, as: 'postImpressionActivitiesDuration' end end class Metric # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :name, as: 'name' end end class Metro # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :country_dart_id, :numeric_string => true, as: 'countryDartId' property :dart_id, :numeric_string => true, as: 'dartId' property :dma_id, :numeric_string => true, as: 'dmaId' property :kind, as: 'kind' property :metro_code, as: 'metroCode' property :name, as: 'name' end end class MetrosListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :metros, as: 'metros', class: Google::Apis::DfareportingV2_8::Metro, decorator: Google::Apis::DfareportingV2_8::Metro::Representation end end class MobileCarrier # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :country_dart_id, :numeric_string => true, as: 'countryDartId' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class MobileCarriersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :mobile_carriers, as: 'mobileCarriers', class: Google::Apis::DfareportingV2_8::MobileCarrier, decorator: Google::Apis::DfareportingV2_8::MobileCarrier::Representation end end class ObjectFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :object_ids, as: 'objectIds' property :status, as: 'status' end end class OffsetPosition # @private class Representation < Google::Apis::Core::JsonRepresentation property :left, as: 'left' property :top, as: 'top' end end class OmnitureSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :omniture_cost_data_enabled, as: 'omnitureCostDataEnabled' property :omniture_integration_enabled, as: 'omnitureIntegrationEnabled' end end class OperatingSystem # @private class Representation < Google::Apis::Core::JsonRepresentation property :dart_id, :numeric_string => true, as: 'dartId' property :desktop, as: 'desktop' property :kind, as: 'kind' property :mobile, as: 'mobile' property :name, as: 'name' end end class OperatingSystemVersion # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :major_version, as: 'majorVersion' property :minor_version, as: 'minorVersion' property :name, as: 'name' property :operating_system, as: 'operatingSystem', class: Google::Apis::DfareportingV2_8::OperatingSystem, decorator: Google::Apis::DfareportingV2_8::OperatingSystem::Representation end end class OperatingSystemVersionsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :operating_system_versions, as: 'operatingSystemVersions', class: Google::Apis::DfareportingV2_8::OperatingSystemVersion, decorator: Google::Apis::DfareportingV2_8::OperatingSystemVersion::Representation end end class OperatingSystemsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :operating_systems, as: 'operatingSystems', class: Google::Apis::DfareportingV2_8::OperatingSystem, decorator: Google::Apis::DfareportingV2_8::OperatingSystem::Representation end end class OptimizationActivity # @private class Representation < Google::Apis::Core::JsonRepresentation property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' property :floodlight_activity_id_dimension_value, as: 'floodlightActivityIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :weight, as: 'weight' end end class Order # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' collection :approver_user_profile_ids, as: 'approverUserProfileIds' property :buyer_invoice_id, as: 'buyerInvoiceId' property :buyer_organization_name, as: 'buyerOrganizationName' property :comments, as: 'comments' collection :contacts, as: 'contacts', class: Google::Apis::DfareportingV2_8::OrderContact, decorator: Google::Apis::DfareportingV2_8::OrderContact::Representation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :name, as: 'name' property :notes, as: 'notes' property :planning_term_id, :numeric_string => true, as: 'planningTermId' property :project_id, :numeric_string => true, as: 'projectId' property :seller_order_id, as: 'sellerOrderId' property :seller_organization_name, as: 'sellerOrganizationName' collection :site_id, as: 'siteId' collection :site_names, as: 'siteNames' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :terms_and_conditions, as: 'termsAndConditions' end end class OrderContact # @private class Representation < Google::Apis::Core::JsonRepresentation property :contact_info, as: 'contactInfo' property :contact_name, as: 'contactName' property :contact_title, as: 'contactTitle' property :contact_type, as: 'contactType' property :signature_user_profile_id, :numeric_string => true, as: 'signatureUserProfileId' end end class OrderDocument # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :amended_order_document_id, :numeric_string => true, as: 'amendedOrderDocumentId' collection :approved_by_user_profile_ids, as: 'approvedByUserProfileIds' property :cancelled, as: 'cancelled' property :created_info, as: 'createdInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :effective_date, as: 'effectiveDate', type: Date property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' collection :last_sent_recipients, as: 'lastSentRecipients' property :last_sent_time, as: 'lastSentTime', type: DateTime property :order_id, :numeric_string => true, as: 'orderId' property :project_id, :numeric_string => true, as: 'projectId' property :signed, as: 'signed' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :title, as: 'title' property :type, as: 'type' end end class OrderDocumentsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :order_documents, as: 'orderDocuments', class: Google::Apis::DfareportingV2_8::OrderDocument, decorator: Google::Apis::DfareportingV2_8::OrderDocument::Representation end end class OrdersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :orders, as: 'orders', class: Google::Apis::DfareportingV2_8::Order, decorator: Google::Apis::DfareportingV2_8::Order::Representation end end class PathToConversionReportCompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation property :kind, as: 'kind' collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation end end class Placement # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :ad_blocking_opt_out, as: 'adBlockingOptOut' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :archived, as: 'archived' property :campaign_id, :numeric_string => true, as: 'campaignId' property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :comment, as: 'comment' property :compatibility, as: 'compatibility' property :content_category_id, :numeric_string => true, as: 'contentCategoryId' property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :directory_site_id, :numeric_string => true, as: 'directorySiteId' property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :external_id, as: 'externalId' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :key_name, as: 'keyName' property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_8::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_8::LookbackConfiguration::Representation property :name, as: 'name' property :payment_approved, as: 'paymentApproved' property :payment_source, as: 'paymentSource' property :placement_group_id, :numeric_string => true, as: 'placementGroupId' property :placement_group_id_dimension_value, as: 'placementGroupIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV2_8::PricingSchedule, decorator: Google::Apis::DfareportingV2_8::PricingSchedule::Representation property :primary, as: 'primary' property :publisher_update_info, as: 'publisherUpdateInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :site_id, :numeric_string => true, as: 'siteId' property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :size, as: 'size', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation property :ssl_required, as: 'sslRequired' property :status, as: 'status' property :subaccount_id, :numeric_string => true, as: 'subaccountId' collection :tag_formats, as: 'tagFormats' property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV2_8::TagSetting, decorator: Google::Apis::DfareportingV2_8::TagSetting::Representation property :video_active_view_opt_out, as: 'videoActiveViewOptOut' property :video_settings, as: 'videoSettings', class: Google::Apis::DfareportingV2_8::VideoSettings, decorator: Google::Apis::DfareportingV2_8::VideoSettings::Representation property :vpaid_adapter_choice, as: 'vpaidAdapterChoice' end end class PlacementAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :active, as: 'active' property :placement_id, :numeric_string => true, as: 'placementId' property :placement_id_dimension_value, as: 'placementIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :ssl_required, as: 'sslRequired' end end class PlacementGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :archived, as: 'archived' property :campaign_id, :numeric_string => true, as: 'campaignId' property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation collection :child_placement_ids, as: 'childPlacementIds' property :comment, as: 'comment' property :content_category_id, :numeric_string => true, as: 'contentCategoryId' property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :directory_site_id, :numeric_string => true, as: 'directorySiteId' property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :external_id, as: 'externalId' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :name, as: 'name' property :placement_group_type, as: 'placementGroupType' property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV2_8::PricingSchedule, decorator: Google::Apis::DfareportingV2_8::PricingSchedule::Representation property :primary_placement_id, :numeric_string => true, as: 'primaryPlacementId' property :primary_placement_id_dimension_value, as: 'primaryPlacementIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :site_id, :numeric_string => true, as: 'siteId' property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class PlacementGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :placement_groups, as: 'placementGroups', class: Google::Apis::DfareportingV2_8::PlacementGroup, decorator: Google::Apis::DfareportingV2_8::PlacementGroup::Representation end end class PlacementStrategiesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :placement_strategies, as: 'placementStrategies', class: Google::Apis::DfareportingV2_8::PlacementStrategy, decorator: Google::Apis::DfareportingV2_8::PlacementStrategy::Representation end end class PlacementStrategy # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class PlacementTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :placement_id, :numeric_string => true, as: 'placementId' collection :tag_datas, as: 'tagDatas', class: Google::Apis::DfareportingV2_8::TagData, decorator: Google::Apis::DfareportingV2_8::TagData::Representation end end class PlacementsGenerateTagsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :placement_tags, as: 'placementTags', class: Google::Apis::DfareportingV2_8::PlacementTag, decorator: Google::Apis::DfareportingV2_8::PlacementTag::Representation end end class PlacementsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :placements, as: 'placements', class: Google::Apis::DfareportingV2_8::Placement, decorator: Google::Apis::DfareportingV2_8::Placement::Representation end end class PlatformType # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class PlatformTypesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :platform_types, as: 'platformTypes', class: Google::Apis::DfareportingV2_8::PlatformType, decorator: Google::Apis::DfareportingV2_8::PlatformType::Representation end end class PopupWindowProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension, as: 'dimension', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation property :offset, as: 'offset', class: Google::Apis::DfareportingV2_8::OffsetPosition, decorator: Google::Apis::DfareportingV2_8::OffsetPosition::Representation property :position_type, as: 'positionType' property :show_address_bar, as: 'showAddressBar' property :show_menu_bar, as: 'showMenuBar' property :show_scroll_bar, as: 'showScrollBar' property :show_status_bar, as: 'showStatusBar' property :show_tool_bar, as: 'showToolBar' property :title, as: 'title' end end class PostalCode # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :country_code, as: 'countryCode' property :country_dart_id, :numeric_string => true, as: 'countryDartId' property :id, as: 'id' property :kind, as: 'kind' end end class PostalCodesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :postal_codes, as: 'postalCodes', class: Google::Apis::DfareportingV2_8::PostalCode, decorator: Google::Apis::DfareportingV2_8::PostalCode::Representation end end class Pricing # @private class Representation < Google::Apis::Core::JsonRepresentation property :cap_cost_type, as: 'capCostType' property :end_date, as: 'endDate', type: Date collection :flights, as: 'flights', class: Google::Apis::DfareportingV2_8::Flight, decorator: Google::Apis::DfareportingV2_8::Flight::Representation property :group_type, as: 'groupType' property :pricing_type, as: 'pricingType' property :start_date, as: 'startDate', type: Date end end class PricingSchedule # @private class Representation < Google::Apis::Core::JsonRepresentation property :cap_cost_option, as: 'capCostOption' property :disregard_overdelivery, as: 'disregardOverdelivery' property :end_date, as: 'endDate', type: Date property :flighted, as: 'flighted' property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' collection :pricing_periods, as: 'pricingPeriods', class: Google::Apis::DfareportingV2_8::PricingSchedulePricingPeriod, decorator: Google::Apis::DfareportingV2_8::PricingSchedulePricingPeriod::Representation property :pricing_type, as: 'pricingType' property :start_date, as: 'startDate', type: Date property :testing_start_date, as: 'testingStartDate', type: Date end end class PricingSchedulePricingPeriod # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_date, as: 'endDate', type: Date property :pricing_comment, as: 'pricingComment' property :rate_or_cost_nanos, :numeric_string => true, as: 'rateOrCostNanos' property :start_date, as: 'startDate', type: Date property :units, :numeric_string => true, as: 'units' end end class Project # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :audience_age_group, as: 'audienceAgeGroup' property :audience_gender, as: 'audienceGender' property :budget, :numeric_string => true, as: 'budget' property :client_billing_code, as: 'clientBillingCode' property :client_name, as: 'clientName' property :end_date, as: 'endDate', type: Date property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation property :name, as: 'name' property :overview, as: 'overview' property :start_date, as: 'startDate', type: Date property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :target_clicks, :numeric_string => true, as: 'targetClicks' property :target_conversions, :numeric_string => true, as: 'targetConversions' property :target_cpa_nanos, :numeric_string => true, as: 'targetCpaNanos' property :target_cpc_nanos, :numeric_string => true, as: 'targetCpcNanos' property :target_cpm_active_view_nanos, :numeric_string => true, as: 'targetCpmActiveViewNanos' property :target_cpm_nanos, :numeric_string => true, as: 'targetCpmNanos' property :target_impressions, :numeric_string => true, as: 'targetImpressions' end end class ProjectsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :projects, as: 'projects', class: Google::Apis::DfareportingV2_8::Project, decorator: Google::Apis::DfareportingV2_8::Project::Representation end end class ReachReportCompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation property :kind, as: 'kind' collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation collection :reach_by_frequency_metrics, as: 'reachByFrequencyMetrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation end end class Recipient # @private class Representation < Google::Apis::Core::JsonRepresentation property :delivery_type, as: 'deliveryType' property :email, as: 'email' property :kind, as: 'kind' end end class Region # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :country_dart_id, :numeric_string => true, as: 'countryDartId' property :dart_id, :numeric_string => true, as: 'dartId' property :kind, as: 'kind' property :name, as: 'name' property :region_code, as: 'regionCode' end end class RegionsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :regions, as: 'regions', class: Google::Apis::DfareportingV2_8::Region, decorator: Google::Apis::DfareportingV2_8::Region::Representation end end class RemarketingList # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active, as: 'active' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :life_span, :numeric_string => true, as: 'lifeSpan' property :list_population_rule, as: 'listPopulationRule', class: Google::Apis::DfareportingV2_8::ListPopulationRule, decorator: Google::Apis::DfareportingV2_8::ListPopulationRule::Representation property :list_size, :numeric_string => true, as: 'listSize' property :list_source, as: 'listSource' property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class RemarketingListShare # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :remarketing_list_id, :numeric_string => true, as: 'remarketingListId' collection :shared_account_ids, as: 'sharedAccountIds' collection :shared_advertiser_ids, as: 'sharedAdvertiserIds' end end class RemarketingListsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :remarketing_lists, as: 'remarketingLists', class: Google::Apis::DfareportingV2_8::RemarketingList, decorator: Google::Apis::DfareportingV2_8::RemarketingList::Representation end end class Report # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :criteria, as: 'criteria', class: Google::Apis::DfareportingV2_8::Report::Criteria, decorator: Google::Apis::DfareportingV2_8::Report::Criteria::Representation property :cross_dimension_reach_criteria, as: 'crossDimensionReachCriteria', class: Google::Apis::DfareportingV2_8::Report::CrossDimensionReachCriteria, decorator: Google::Apis::DfareportingV2_8::Report::CrossDimensionReachCriteria::Representation property :delivery, as: 'delivery', class: Google::Apis::DfareportingV2_8::Report::Delivery, decorator: Google::Apis::DfareportingV2_8::Report::Delivery::Representation property :etag, as: 'etag' property :file_name, as: 'fileName' property :floodlight_criteria, as: 'floodlightCriteria', class: Google::Apis::DfareportingV2_8::Report::FloodlightCriteria, decorator: Google::Apis::DfareportingV2_8::Report::FloodlightCriteria::Representation property :format, as: 'format' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :last_modified_time, :numeric_string => true, as: 'lastModifiedTime' property :name, as: 'name' property :owner_profile_id, :numeric_string => true, as: 'ownerProfileId' property :path_to_conversion_criteria, as: 'pathToConversionCriteria', class: Google::Apis::DfareportingV2_8::Report::PathToConversionCriteria, decorator: Google::Apis::DfareportingV2_8::Report::PathToConversionCriteria::Representation property :reach_criteria, as: 'reachCriteria', class: Google::Apis::DfareportingV2_8::Report::ReachCriteria, decorator: Google::Apis::DfareportingV2_8::Report::ReachCriteria::Representation property :schedule, as: 'schedule', class: Google::Apis::DfareportingV2_8::Report::Schedule, decorator: Google::Apis::DfareportingV2_8::Report::Schedule::Representation property :sub_account_id, :numeric_string => true, as: 'subAccountId' property :type, as: 'type' end class Criteria # @private class Representation < Google::Apis::Core::JsonRepresentation property :activities, as: 'activities', class: Google::Apis::DfareportingV2_8::Activities, decorator: Google::Apis::DfareportingV2_8::Activities::Representation property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_8::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV2_8::CustomRichMediaEvents::Representation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation collection :metric_names, as: 'metricNames' end end class CrossDimensionReachCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation collection :breakdown, as: 'breakdown', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation property :dimension, as: 'dimension' collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation collection :metric_names, as: 'metricNames' collection :overlap_metric_names, as: 'overlapMetricNames' property :pivoted, as: 'pivoted' end end class Delivery # @private class Representation < Google::Apis::Core::JsonRepresentation property :email_owner, as: 'emailOwner' property :email_owner_delivery_type, as: 'emailOwnerDeliveryType' property :message, as: 'message' collection :recipients, as: 'recipients', class: Google::Apis::DfareportingV2_8::Recipient, decorator: Google::Apis::DfareportingV2_8::Recipient::Representation end end class FloodlightCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation collection :metric_names, as: 'metricNames' property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV2_8::Report::FloodlightCriteria::ReportProperties, decorator: Google::Apis::DfareportingV2_8::Report::FloodlightCriteria::ReportProperties::Representation end class ReportProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :include_attributed_ip_conversions, as: 'includeAttributedIPConversions' property :include_unattributed_cookie_conversions, as: 'includeUnattributedCookieConversions' property :include_unattributed_ip_conversions, as: 'includeUnattributedIPConversions' end end end class PathToConversionCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation collection :activity_filters, as: 'activityFilters', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation collection :metric_names, as: 'metricNames' collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV2_8::Report::PathToConversionCriteria::ReportProperties, decorator: Google::Apis::DfareportingV2_8::Report::PathToConversionCriteria::ReportProperties::Representation end class ReportProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :clicks_lookback_window, as: 'clicksLookbackWindow' property :impressions_lookback_window, as: 'impressionsLookbackWindow' property :include_attributed_ip_conversions, as: 'includeAttributedIPConversions' property :include_unattributed_cookie_conversions, as: 'includeUnattributedCookieConversions' property :include_unattributed_ip_conversions, as: 'includeUnattributedIPConversions' property :maximum_click_interactions, as: 'maximumClickInteractions' property :maximum_impression_interactions, as: 'maximumImpressionInteractions' property :maximum_interaction_gap, as: 'maximumInteractionGap' property :pivot_on_interaction_path, as: 'pivotOnInteractionPath' end end end class ReachCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation property :activities, as: 'activities', class: Google::Apis::DfareportingV2_8::Activities, decorator: Google::Apis::DfareportingV2_8::Activities::Representation property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_8::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV2_8::CustomRichMediaEvents::Representation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation property :enable_all_dimension_combinations, as: 'enableAllDimensionCombinations' collection :metric_names, as: 'metricNames' collection :reach_by_frequency_metric_names, as: 'reachByFrequencyMetricNames' end end class Schedule # @private class Representation < Google::Apis::Core::JsonRepresentation property :active, as: 'active' property :every, as: 'every' property :expiration_date, as: 'expirationDate', type: Date property :repeats, as: 'repeats' collection :repeats_on_week_days, as: 'repeatsOnWeekDays' property :runs_on_day_of_month, as: 'runsOnDayOfMonth' property :start_date, as: 'startDate', type: Date end end end class ReportCompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation property :kind, as: 'kind' collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation end end class ReportList # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::DfareportingV2_8::Report, decorator: Google::Apis::DfareportingV2_8::Report::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class ReportsConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :exposure_to_conversion_enabled, as: 'exposureToConversionEnabled' property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_8::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_8::LookbackConfiguration::Representation property :report_generation_time_zone_id, :numeric_string => true, as: 'reportGenerationTimeZoneId' end end class RichMediaExitOverride # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV2_8::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_8::ClickThroughUrl::Representation property :enabled, as: 'enabled' property :exit_id, :numeric_string => true, as: 'exitId' end end class Rule # @private class Representation < Google::Apis::Core::JsonRepresentation property :asset_id, :numeric_string => true, as: 'assetId' property :name, as: 'name' property :targeting_template_id, :numeric_string => true, as: 'targetingTemplateId' end end class Site # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :approved, as: 'approved' property :directory_site_id, :numeric_string => true, as: 'directorySiteId' property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :key_name, as: 'keyName' property :kind, as: 'kind' property :name, as: 'name' collection :site_contacts, as: 'siteContacts', class: Google::Apis::DfareportingV2_8::SiteContact, decorator: Google::Apis::DfareportingV2_8::SiteContact::Representation property :site_settings, as: 'siteSettings', class: Google::Apis::DfareportingV2_8::SiteSettings, decorator: Google::Apis::DfareportingV2_8::SiteSettings::Representation property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class SiteContact # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address' property :contact_type, as: 'contactType' property :email, as: 'email' property :first_name, as: 'firstName' property :id, :numeric_string => true, as: 'id' property :last_name, as: 'lastName' property :phone, as: 'phone' property :title, as: 'title' end end class SiteSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :active_view_opt_out, as: 'activeViewOptOut' property :ad_blocking_opt_out, as: 'adBlockingOptOut' property :creative_settings, as: 'creativeSettings', class: Google::Apis::DfareportingV2_8::CreativeSettings, decorator: Google::Apis::DfareportingV2_8::CreativeSettings::Representation property :disable_new_cookie, as: 'disableNewCookie' property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_8::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_8::LookbackConfiguration::Representation property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV2_8::TagSetting, decorator: Google::Apis::DfareportingV2_8::TagSetting::Representation property :video_active_view_opt_out_template, as: 'videoActiveViewOptOutTemplate' property :vpaid_adapter_choice_template, as: 'vpaidAdapterChoiceTemplate' end end class SitesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :sites, as: 'sites', class: Google::Apis::DfareportingV2_8::Site, decorator: Google::Apis::DfareportingV2_8::Site::Representation end end class Size # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :iab, as: 'iab' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :width, as: 'width' end end class SizesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :sizes, as: 'sizes', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation end end class SkippableSetting # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV2_8::VideoOffset, decorator: Google::Apis::DfareportingV2_8::VideoOffset::Representation property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV2_8::VideoOffset, decorator: Google::Apis::DfareportingV2_8::VideoOffset::Representation property :skippable, as: 'skippable' end end class SortedDimension # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :name, as: 'name' property :sort_order, as: 'sortOrder' end end class Subaccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' collection :available_permission_ids, as: 'availablePermissionIds' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class SubaccountsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :subaccounts, as: 'subaccounts', class: Google::Apis::DfareportingV2_8::Subaccount, decorator: Google::Apis::DfareportingV2_8::Subaccount::Representation end end class TagData # @private class Representation < Google::Apis::Core::JsonRepresentation property :ad_id, :numeric_string => true, as: 'adId' property :click_tag, as: 'clickTag' property :creative_id, :numeric_string => true, as: 'creativeId' property :format, as: 'format' property :impression_tag, as: 'impressionTag' end end class TagSetting # @private class Representation < Google::Apis::Core::JsonRepresentation property :additional_key_values, as: 'additionalKeyValues' property :include_click_through_urls, as: 'includeClickThroughUrls' property :include_click_tracking, as: 'includeClickTracking' property :keyword_option, as: 'keywordOption' end end class TagSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :dynamic_tag_enabled, as: 'dynamicTagEnabled' property :image_tag_enabled, as: 'imageTagEnabled' end end class TargetWindow # @private class Representation < Google::Apis::Core::JsonRepresentation property :custom_html, as: 'customHtml' property :target_window_option, as: 'targetWindowOption' end end class TargetableRemarketingList # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active, as: 'active' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :life_span, :numeric_string => true, as: 'lifeSpan' property :list_size, :numeric_string => true, as: 'listSize' property :list_source, as: 'listSource' property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class TargetableRemarketingListsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :targetable_remarketing_lists, as: 'targetableRemarketingLists', class: Google::Apis::DfareportingV2_8::TargetableRemarketingList, decorator: Google::Apis::DfareportingV2_8::TargetableRemarketingList::Representation end end class TargetingTemplate # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV2_8::DayPartTargeting, decorator: Google::Apis::DfareportingV2_8::DayPartTargeting::Representation property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV2_8::GeoTargeting, decorator: Google::Apis::DfareportingV2_8::GeoTargeting::Representation property :id, :numeric_string => true, as: 'id' property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV2_8::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV2_8::KeyValueTargetingExpression::Representation property :kind, as: 'kind' property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV2_8::LanguageTargeting, decorator: Google::Apis::DfareportingV2_8::LanguageTargeting::Representation property :list_targeting_expression, as: 'listTargetingExpression', class: Google::Apis::DfareportingV2_8::ListTargetingExpression, decorator: Google::Apis::DfareportingV2_8::ListTargetingExpression::Representation property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV2_8::TechnologyTargeting, decorator: Google::Apis::DfareportingV2_8::TechnologyTargeting::Representation end end class TargetingTemplatesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :targeting_templates, as: 'targetingTemplates', class: Google::Apis::DfareportingV2_8::TargetingTemplate, decorator: Google::Apis::DfareportingV2_8::TargetingTemplate::Representation end end class TechnologyTargeting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :browsers, as: 'browsers', class: Google::Apis::DfareportingV2_8::Browser, decorator: Google::Apis::DfareportingV2_8::Browser::Representation collection :connection_types, as: 'connectionTypes', class: Google::Apis::DfareportingV2_8::ConnectionType, decorator: Google::Apis::DfareportingV2_8::ConnectionType::Representation collection :mobile_carriers, as: 'mobileCarriers', class: Google::Apis::DfareportingV2_8::MobileCarrier, decorator: Google::Apis::DfareportingV2_8::MobileCarrier::Representation collection :operating_system_versions, as: 'operatingSystemVersions', class: Google::Apis::DfareportingV2_8::OperatingSystemVersion, decorator: Google::Apis::DfareportingV2_8::OperatingSystemVersion::Representation collection :operating_systems, as: 'operatingSystems', class: Google::Apis::DfareportingV2_8::OperatingSystem, decorator: Google::Apis::DfareportingV2_8::OperatingSystem::Representation collection :platform_types, as: 'platformTypes', class: Google::Apis::DfareportingV2_8::PlatformType, decorator: Google::Apis::DfareportingV2_8::PlatformType::Representation end end class ThirdPartyAuthenticationToken # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :value, as: 'value' end end class ThirdPartyTrackingUrl # @private class Representation < Google::Apis::Core::JsonRepresentation property :third_party_url_type, as: 'thirdPartyUrlType' property :url, as: 'url' end end class TranscodeSetting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :enabled_video_formats, as: 'enabledVideoFormats' property :kind, as: 'kind' end end class UniversalAdId # @private class Representation < Google::Apis::Core::JsonRepresentation property :registry, as: 'registry' property :value, as: 'value' end end class UserDefinedVariableConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :data_type, as: 'dataType' property :report_name, as: 'reportName' property :variable_type, as: 'variableType' end end class UserProfile # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :account_name, as: 'accountName' property :etag, as: 'etag' property :kind, as: 'kind' property :profile_id, :numeric_string => true, as: 'profileId' property :sub_account_id, :numeric_string => true, as: 'subAccountId' property :sub_account_name, as: 'subAccountName' property :user_name, as: 'userName' end end class UserProfileList # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::DfareportingV2_8::UserProfile, decorator: Google::Apis::DfareportingV2_8::UserProfile::Representation property :kind, as: 'kind' end end class UserRole # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :default_user_role, as: 'defaultUserRole' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :parent_user_role_id, :numeric_string => true, as: 'parentUserRoleId' collection :permissions, as: 'permissions', class: Google::Apis::DfareportingV2_8::UserRolePermission, decorator: Google::Apis::DfareportingV2_8::UserRolePermission::Representation property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class UserRolePermission # @private class Representation < Google::Apis::Core::JsonRepresentation property :availability, as: 'availability' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :permission_group_id, :numeric_string => true, as: 'permissionGroupId' end end class UserRolePermissionGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class UserRolePermissionGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :user_role_permission_groups, as: 'userRolePermissionGroups', class: Google::Apis::DfareportingV2_8::UserRolePermissionGroup, decorator: Google::Apis::DfareportingV2_8::UserRolePermissionGroup::Representation end end class UserRolePermissionsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :user_role_permissions, as: 'userRolePermissions', class: Google::Apis::DfareportingV2_8::UserRolePermission, decorator: Google::Apis::DfareportingV2_8::UserRolePermission::Representation end end class UserRolesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :user_roles, as: 'userRoles', class: Google::Apis::DfareportingV2_8::UserRole, decorator: Google::Apis::DfareportingV2_8::UserRole::Representation end end class VideoFormat # @private class Representation < Google::Apis::Core::JsonRepresentation property :file_type, as: 'fileType' property :id, as: 'id' property :kind, as: 'kind' property :resolution, as: 'resolution', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation property :target_bit_rate, as: 'targetBitRate' end end class VideoFormatsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :video_formats, as: 'videoFormats', class: Google::Apis::DfareportingV2_8::VideoFormat, decorator: Google::Apis::DfareportingV2_8::VideoFormat::Representation end end class VideoOffset # @private class Representation < Google::Apis::Core::JsonRepresentation property :offset_percentage, as: 'offsetPercentage' property :offset_seconds, as: 'offsetSeconds' end end class VideoSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :companion_settings, as: 'companionSettings', class: Google::Apis::DfareportingV2_8::CompanionSetting, decorator: Google::Apis::DfareportingV2_8::CompanionSetting::Representation property :kind, as: 'kind' property :skippable_settings, as: 'skippableSettings', class: Google::Apis::DfareportingV2_8::SkippableSetting, decorator: Google::Apis::DfareportingV2_8::SkippableSetting::Representation property :transcode_settings, as: 'transcodeSettings', class: Google::Apis::DfareportingV2_8::TranscodeSetting, decorator: Google::Apis::DfareportingV2_8::TranscodeSetting::Representation end end end end end google-api-client-0.19.8/generated/google/apis/dfareporting_v2_8/classes.rb0000644000004100000410000175046313252673043026637 0ustar www-datawww-data# 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 DfareportingV2_8 # Contains properties of a DCM account. class Account include Google::Apis::Core::Hashable # Account permissions assigned to this account. # Corresponds to the JSON property `accountPermissionIds` # @return [Array] attr_accessor :account_permission_ids # Profile for this account. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountProfile` # @return [String] attr_accessor :account_profile # Whether this account is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Maximum number of active ads allowed for this account. # Corresponds to the JSON property `activeAdsLimitTier` # @return [String] attr_accessor :active_ads_limit_tier # Whether to serve creatives with Active View tags. If disabled, viewability # data will not be available for any impressions. # Corresponds to the JSON property `activeViewOptOut` # @return [Boolean] attr_accessor :active_view_opt_out alias_method :active_view_opt_out?, :active_view_opt_out # User role permissions available to the user roles of this account. # Corresponds to the JSON property `availablePermissionIds` # @return [Array] attr_accessor :available_permission_ids # ID of the country associated with this account. # Corresponds to the JSON property `countryId` # @return [Fixnum] attr_accessor :country_id # ID of currency associated with this account. This is a required field. # Acceptable values are: # - "1" for USD # - "2" for GBP # - "3" for ESP # - "4" for SEK # - "5" for CAD # - "6" for JPY # - "7" for DEM # - "8" for AUD # - "9" for FRF # - "10" for ITL # - "11" for DKK # - "12" for NOK # - "13" for FIM # - "14" for ZAR # - "15" for IEP # - "16" for NLG # - "17" for EUR # - "18" for KRW # - "19" for TWD # - "20" for SGD # - "21" for CNY # - "22" for HKD # - "23" for NZD # - "24" for MYR # - "25" for BRL # - "26" for PTE # - "27" for MXP # - "28" for CLP # - "29" for TRY # - "30" for ARS # - "31" for PEN # - "32" for ILS # - "33" for CHF # - "34" for VEF # - "35" for COP # - "36" for GTQ # - "37" for PLN # - "39" for INR # - "40" for THB # - "41" for IDR # - "42" for CZK # - "43" for RON # - "44" for HUF # - "45" for RUB # - "46" for AED # - "47" for BGN # - "48" for HRK # - "49" for MXN # - "50" for NGN # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id # Default placement dimensions for this account. # Corresponds to the JSON property `defaultCreativeSizeId` # @return [Fixnum] attr_accessor :default_creative_size_id # Description of this account. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # ID of this account. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#account". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Locale of this account. # Acceptable values are: # - "cs" (Czech) # - "de" (German) # - "en" (English) # - "en-GB" (English United Kingdom) # - "es" (Spanish) # - "fr" (French) # - "it" (Italian) # - "ja" (Japanese) # - "ko" (Korean) # - "pl" (Polish) # - "pt-BR" (Portuguese Brazil) # - "ru" (Russian) # - "sv" (Swedish) # - "tr" (Turkish) # - "zh-CN" (Chinese Simplified) # - "zh-TW" (Chinese Traditional) # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # Maximum image size allowed for this account, in kilobytes. Value must be # greater than or equal to 1. # Corresponds to the JSON property `maximumImageSize` # @return [Fixnum] attr_accessor :maximum_image_size # Name of this account. This is a required field, and must be less than 128 # characters long and be globally unique. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether campaigns created in this account will be enabled for Nielsen OCR # reach ratings by default. # Corresponds to the JSON property `nielsenOcrEnabled` # @return [Boolean] attr_accessor :nielsen_ocr_enabled alias_method :nielsen_ocr_enabled?, :nielsen_ocr_enabled # Reporting Configuration # Corresponds to the JSON property `reportsConfiguration` # @return [Google::Apis::DfareportingV2_8::ReportsConfiguration] attr_accessor :reports_configuration # Share Path to Conversion reports with Twitter. # Corresponds to the JSON property `shareReportsWithTwitter` # @return [Boolean] attr_accessor :share_reports_with_twitter alias_method :share_reports_with_twitter?, :share_reports_with_twitter # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values # are 1 to 10240, inclusive. # Corresponds to the JSON property `teaserSizeLimit` # @return [Fixnum] attr_accessor :teaser_size_limit def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_permission_ids = args[:account_permission_ids] if args.key?(:account_permission_ids) @account_profile = args[:account_profile] if args.key?(:account_profile) @active = args[:active] if args.key?(:active) @active_ads_limit_tier = args[:active_ads_limit_tier] if args.key?(:active_ads_limit_tier) @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) @available_permission_ids = args[:available_permission_ids] if args.key?(:available_permission_ids) @country_id = args[:country_id] if args.key?(:country_id) @currency_id = args[:currency_id] if args.key?(:currency_id) @default_creative_size_id = args[:default_creative_size_id] if args.key?(:default_creative_size_id) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @locale = args[:locale] if args.key?(:locale) @maximum_image_size = args[:maximum_image_size] if args.key?(:maximum_image_size) @name = args[:name] if args.key?(:name) @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] if args.key?(:nielsen_ocr_enabled) @reports_configuration = args[:reports_configuration] if args.key?(:reports_configuration) @share_reports_with_twitter = args[:share_reports_with_twitter] if args.key?(:share_reports_with_twitter) @teaser_size_limit = args[:teaser_size_limit] if args.key?(:teaser_size_limit) end end # Gets a summary of active ads in an account. class AccountActiveAdSummary include Google::Apis::Core::Hashable # ID of the account. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Ads that have been activated for the account # Corresponds to the JSON property `activeAds` # @return [Fixnum] attr_accessor :active_ads # Maximum number of active ads allowed for the account. # Corresponds to the JSON property `activeAdsLimitTier` # @return [String] attr_accessor :active_ads_limit_tier # Ads that can be activated for the account. # Corresponds to the JSON property `availableAds` # @return [Fixnum] attr_accessor :available_ads # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountActiveAdSummary". # 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) @account_id = args[:account_id] if args.key?(:account_id) @active_ads = args[:active_ads] if args.key?(:active_ads) @active_ads_limit_tier = args[:active_ads_limit_tier] if args.key?(:active_ads_limit_tier) @available_ads = args[:available_ads] if args.key?(:available_ads) @kind = args[:kind] if args.key?(:kind) end end # AccountPermissions contains information about a particular account permission. # Some features of DCM require an account permission to be present in the # account. class AccountPermission include Google::Apis::Core::Hashable # Account profiles associated with this account permission. # Possible values are: # - "ACCOUNT_PROFILE_BASIC" # - "ACCOUNT_PROFILE_STANDARD" # Corresponds to the JSON property `accountProfiles` # @return [Array] attr_accessor :account_profiles # ID of this account permission. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountPermission". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Administrative level required to enable this account permission. # Corresponds to the JSON property `level` # @return [String] attr_accessor :level # Name of this account permission. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Permission group of this account permission. # Corresponds to the JSON property `permissionGroupId` # @return [Fixnum] attr_accessor :permission_group_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_profiles = args[:account_profiles] if args.key?(:account_profiles) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @level = args[:level] if args.key?(:level) @name = args[:name] if args.key?(:name) @permission_group_id = args[:permission_group_id] if args.key?(:permission_group_id) end end # AccountPermissionGroups contains a mapping of permission group IDs to names. A # permission group is a grouping of account permissions. class AccountPermissionGroup include Google::Apis::Core::Hashable # ID of this account permission group. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountPermissionGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this account permission 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Account Permission Group List Response class AccountPermissionGroupsListResponse include Google::Apis::Core::Hashable # Account permission group collection. # Corresponds to the JSON property `accountPermissionGroups` # @return [Array] attr_accessor :account_permission_groups # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountPermissionGroupsListResponse". # 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) @account_permission_groups = args[:account_permission_groups] if args.key?(:account_permission_groups) @kind = args[:kind] if args.key?(:kind) end end # Account Permission List Response class AccountPermissionsListResponse include Google::Apis::Core::Hashable # Account permission collection. # Corresponds to the JSON property `accountPermissions` # @return [Array] attr_accessor :account_permissions # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountPermissionsListResponse". # 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) @account_permissions = args[:account_permissions] if args.key?(:account_permissions) @kind = args[:kind] if args.key?(:kind) end end # AccountUserProfiles contains properties of a DCM user profile. This resource # is specifically for managing user profiles, whereas UserProfiles is for # accessing the API. class AccountUserProfile include Google::Apis::Core::Hashable # Account ID of the user profile. This is a read-only field that can be left # blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this user profile is active. This defaults to false, and must be set # true on insert for the user profile to be usable. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Object Filter. # Corresponds to the JSON property `advertiserFilter` # @return [Google::Apis::DfareportingV2_8::ObjectFilter] attr_accessor :advertiser_filter # Object Filter. # Corresponds to the JSON property `campaignFilter` # @return [Google::Apis::DfareportingV2_8::ObjectFilter] attr_accessor :campaign_filter # Comments for this user profile. # Corresponds to the JSON property `comments` # @return [String] attr_accessor :comments # Email of the user profile. The email addresss must be linked to a Google # Account. This field is required on insertion and is read-only after insertion. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # ID of the user profile. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountUserProfile". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Locale of the user profile. This is a required field. # Acceptable values are: # - "cs" (Czech) # - "de" (German) # - "en" (English) # - "en-GB" (English United Kingdom) # - "es" (Spanish) # - "fr" (French) # - "it" (Italian) # - "ja" (Japanese) # - "ko" (Korean) # - "pl" (Polish) # - "pt-BR" (Portuguese Brazil) # - "ru" (Russian) # - "sv" (Swedish) # - "tr" (Turkish) # - "zh-CN" (Chinese Simplified) # - "zh-TW" (Chinese Traditional) # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # Name of the user profile. This is a required field. Must be less than 64 # characters long, must be globally unique, and cannot contain whitespace or any # of the following characters: "&;"#%,". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Object Filter. # Corresponds to the JSON property `siteFilter` # @return [Google::Apis::DfareportingV2_8::ObjectFilter] attr_accessor :site_filter # Subaccount ID of the user profile. This is a read-only field that can be left # blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Trafficker type of this user profile. # Corresponds to the JSON property `traffickerType` # @return [String] attr_accessor :trafficker_type # User type of the user profile. This is a read-only field that can be left # blank. # Corresponds to the JSON property `userAccessType` # @return [String] attr_accessor :user_access_type # Object Filter. # Corresponds to the JSON property `userRoleFilter` # @return [Google::Apis::DfareportingV2_8::ObjectFilter] attr_accessor :user_role_filter # User role ID of the user profile. This is a required field. # Corresponds to the JSON property `userRoleId` # @return [Fixnum] attr_accessor :user_role_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @advertiser_filter = args[:advertiser_filter] if args.key?(:advertiser_filter) @campaign_filter = args[:campaign_filter] if args.key?(:campaign_filter) @comments = args[:comments] if args.key?(:comments) @email = args[:email] if args.key?(:email) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @locale = args[:locale] if args.key?(:locale) @name = args[:name] if args.key?(:name) @site_filter = args[:site_filter] if args.key?(:site_filter) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @trafficker_type = args[:trafficker_type] if args.key?(:trafficker_type) @user_access_type = args[:user_access_type] if args.key?(:user_access_type) @user_role_filter = args[:user_role_filter] if args.key?(:user_role_filter) @user_role_id = args[:user_role_id] if args.key?(:user_role_id) end end # Account User Profile List Response class AccountUserProfilesListResponse include Google::Apis::Core::Hashable # Account user profile collection. # Corresponds to the JSON property `accountUserProfiles` # @return [Array] attr_accessor :account_user_profiles # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountUserProfilesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @account_user_profiles = args[:account_user_profiles] if args.key?(:account_user_profiles) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Account List Response class AccountsListResponse include Google::Apis::Core::Hashable # Account collection. # Corresponds to the JSON property `accounts` # @return [Array] attr_accessor :accounts # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @accounts = args[:accounts] if args.key?(:accounts) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Represents an activity group. class Activities include Google::Apis::Core::Hashable # List of activity filters. The dimension values need to be all either of type " # dfa:activity" or "dfa:activityGroup". # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters # The kind of resource this is, in this case dfareporting#activities. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # List of names of floodlight activity metrics. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filters = args[:filters] if args.key?(:filters) @kind = args[:kind] if args.key?(:kind) @metric_names = args[:metric_names] if args.key?(:metric_names) end end # Contains properties of a DCM ad. class Ad include Google::Apis::Core::Hashable # Account ID of this ad. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this ad is active. When true, archived must be false. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Advertiser ID of this ad. This is a required field on insertion. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Whether this ad is archived. When true, active must be false. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # Audience segment ID that is being targeted for this ad. Applicable when type # is AD_SERVING_STANDARD_AD. # Corresponds to the JSON property `audienceSegmentId` # @return [Fixnum] attr_accessor :audience_segment_id # Campaign ID of this ad. This is a required field on insertion. # Corresponds to the JSON property `campaignId` # @return [Fixnum] attr_accessor :campaign_id # Represents a DimensionValue resource. # Corresponds to the JSON property `campaignIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :campaign_id_dimension_value # Click-through URL # Corresponds to the JSON property `clickThroughUrl` # @return [Google::Apis::DfareportingV2_8::ClickThroughUrl] attr_accessor :click_through_url # Click Through URL Suffix settings. # Corresponds to the JSON property `clickThroughUrlSuffixProperties` # @return [Google::Apis::DfareportingV2_8::ClickThroughUrlSuffixProperties] attr_accessor :click_through_url_suffix_properties # Comments for this ad. # Corresponds to the JSON property `comments` # @return [String] attr_accessor :comments # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. # DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on # mobile devices or in mobile apps for regular or interstitial ads, respectively. # APP and APP_INTERSTITIAL are only used for existing default ads. New mobile # placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads # created for those placements will be limited to those compatibility types. # IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the # VAST standard. # Corresponds to the JSON property `compatibility` # @return [String] attr_accessor :compatibility # Modification timestamp. # Corresponds to the JSON property `createInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :create_info # Creative group assignments for this ad. Applicable when type is # AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is # allowed for a maximum of two assignments. # Corresponds to the JSON property `creativeGroupAssignments` # @return [Array] attr_accessor :creative_group_assignments # Creative Rotation. # Corresponds to the JSON property `creativeRotation` # @return [Google::Apis::DfareportingV2_8::CreativeRotation] attr_accessor :creative_rotation # Day Part Targeting. # Corresponds to the JSON property `dayPartTargeting` # @return [Google::Apis::DfareportingV2_8::DayPartTargeting] attr_accessor :day_part_targeting # Properties of inheriting and overriding the default click-through event tag. A # campaign may override the event tag defined at the advertiser level, and an ad # may also override the campaign's setting further. # Corresponds to the JSON property `defaultClickThroughEventTagProperties` # @return [Google::Apis::DfareportingV2_8::DefaultClickThroughEventTagProperties] attr_accessor :default_click_through_event_tag_properties # Delivery Schedule. # Corresponds to the JSON property `deliverySchedule` # @return [Google::Apis::DfareportingV2_8::DeliverySchedule] attr_accessor :delivery_schedule # Whether this ad is a dynamic click tracker. Applicable when type is # AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only # after insert. # Corresponds to the JSON property `dynamicClickTracker` # @return [Boolean] attr_accessor :dynamic_click_tracker alias_method :dynamic_click_tracker?, :dynamic_click_tracker # Date and time that this ad should stop serving. Must be later than the start # time. This is a required field on insertion. # Corresponds to the JSON property `endTime` # @return [DateTime] attr_accessor :end_time # Event tag overrides for this ad. # Corresponds to the JSON property `eventTagOverrides` # @return [Array] attr_accessor :event_tag_overrides # Geographical Targeting. # Corresponds to the JSON property `geoTargeting` # @return [Google::Apis::DfareportingV2_8::GeoTargeting] attr_accessor :geo_targeting # ID of this ad. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Key Value Targeting Expression. # Corresponds to the JSON property `keyValueTargetingExpression` # @return [Google::Apis::DfareportingV2_8::KeyValueTargetingExpression] attr_accessor :key_value_targeting_expression # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#ad". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Language Targeting. # Corresponds to the JSON property `languageTargeting` # @return [Google::Apis::DfareportingV2_8::LanguageTargeting] attr_accessor :language_targeting # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :last_modified_info # Name of this ad. This is a required field and must be less than 256 characters # long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Placement assignments for this ad. # Corresponds to the JSON property `placementAssignments` # @return [Array] attr_accessor :placement_assignments # Remarketing List Targeting Expression. # Corresponds to the JSON property `remarketingListExpression` # @return [Google::Apis::DfareportingV2_8::ListTargetingExpression] attr_accessor :remarketing_list_expression # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `size` # @return [Google::Apis::DfareportingV2_8::Size] attr_accessor :size # Whether this ad is ssl compliant. This is a read-only field that is auto- # generated when the ad is inserted or updated. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Whether this ad requires ssl. This is a read-only field that is auto-generated # when the ad is inserted or updated. # Corresponds to the JSON property `sslRequired` # @return [Boolean] attr_accessor :ssl_required alias_method :ssl_required?, :ssl_required # Date and time that this ad should start serving. If creating an ad, this field # must be a time in the future. This is a required field on insertion. # Corresponds to the JSON property `startTime` # @return [DateTime] attr_accessor :start_time # Subaccount ID of this ad. This is a read-only field that can be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Targeting template ID, used to apply preconfigured targeting information to # this ad. This cannot be set while any of dayPartTargeting, geoTargeting, # keyValueTargetingExpression, languageTargeting, remarketingListExpression, or # technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. # Corresponds to the JSON property `targetingTemplateId` # @return [Fixnum] attr_accessor :targeting_template_id # Technology Targeting. # Corresponds to the JSON property `technologyTargeting` # @return [Google::Apis::DfareportingV2_8::TechnologyTargeting] attr_accessor :technology_targeting # Type of ad. This is a required field on insertion. Note that default ads ( # AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). # 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) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @archived = args[:archived] if args.key?(:archived) @audience_segment_id = args[:audience_segment_id] if args.key?(:audience_segment_id) @campaign_id = args[:campaign_id] if args.key?(:campaign_id) @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties) @comments = args[:comments] if args.key?(:comments) @compatibility = args[:compatibility] if args.key?(:compatibility) @create_info = args[:create_info] if args.key?(:create_info) @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments) @creative_rotation = args[:creative_rotation] if args.key?(:creative_rotation) @day_part_targeting = args[:day_part_targeting] if args.key?(:day_part_targeting) @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties) @delivery_schedule = args[:delivery_schedule] if args.key?(:delivery_schedule) @dynamic_click_tracker = args[:dynamic_click_tracker] if args.key?(:dynamic_click_tracker) @end_time = args[:end_time] if args.key?(:end_time) @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides) @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @key_value_targeting_expression = args[:key_value_targeting_expression] if args.key?(:key_value_targeting_expression) @kind = args[:kind] if args.key?(:kind) @language_targeting = args[:language_targeting] if args.key?(:language_targeting) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @name = args[:name] if args.key?(:name) @placement_assignments = args[:placement_assignments] if args.key?(:placement_assignments) @remarketing_list_expression = args[:remarketing_list_expression] if args.key?(:remarketing_list_expression) @size = args[:size] if args.key?(:size) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @ssl_required = args[:ssl_required] if args.key?(:ssl_required) @start_time = args[:start_time] if args.key?(:start_time) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @targeting_template_id = args[:targeting_template_id] if args.key?(:targeting_template_id) @technology_targeting = args[:technology_targeting] if args.key?(:technology_targeting) @type = args[:type] if args.key?(:type) end end # Campaign ad blocking settings. class AdBlockingConfiguration include Google::Apis::Core::Hashable # Click-through URL used by brand-neutral ads. This is a required field when # overrideClickThroughUrl is set to true. # Corresponds to the JSON property `clickThroughUrl` # @return [String] attr_accessor :click_through_url # ID of a creative bundle to use for this campaign. If set, brand-neutral ads # will select creatives from this bundle. Otherwise, a default transparent pixel # will be used. # Corresponds to the JSON property `creativeBundleId` # @return [Fixnum] attr_accessor :creative_bundle_id # Whether this campaign has enabled ad blocking. When true, ad blocking is # enabled for placements in the campaign, but this may be overridden by site and # placement settings. When false, ad blocking is disabled for all placements # under the campaign, regardless of site and placement settings. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # Whether the brand-neutral ad's click-through URL comes from the campaign's # creative bundle or the override URL. Must be set to true if ad blocking is # enabled and no creative bundle is configured. # Corresponds to the JSON property `overrideClickThroughUrl` # @return [Boolean] attr_accessor :override_click_through_url alias_method :override_click_through_url?, :override_click_through_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @creative_bundle_id = args[:creative_bundle_id] if args.key?(:creative_bundle_id) @enabled = args[:enabled] if args.key?(:enabled) @override_click_through_url = args[:override_click_through_url] if args.key?(:override_click_through_url) end end # Ad Slot class AdSlot include Google::Apis::Core::Hashable # Comment for this ad slot. # Corresponds to the JSON property `comment` # @return [String] attr_accessor :comment # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering # either on desktop, mobile devices or in mobile apps for regular or # interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in # mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads # developed with the VAST standard. # Corresponds to the JSON property `compatibility` # @return [String] attr_accessor :compatibility # Height of this ad slot. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # ID of the placement from an external platform that is linked to this ad slot. # Corresponds to the JSON property `linkedPlacementId` # @return [Fixnum] attr_accessor :linked_placement_id # Name of this ad slot. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Payment source type of this ad slot. # Corresponds to the JSON property `paymentSourceType` # @return [String] attr_accessor :payment_source_type # Primary ad slot of a roadblock inventory item. # Corresponds to the JSON property `primary` # @return [Boolean] attr_accessor :primary alias_method :primary?, :primary # Width of this ad slot. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @comment = args[:comment] if args.key?(:comment) @compatibility = args[:compatibility] if args.key?(:compatibility) @height = args[:height] if args.key?(:height) @linked_placement_id = args[:linked_placement_id] if args.key?(:linked_placement_id) @name = args[:name] if args.key?(:name) @payment_source_type = args[:payment_source_type] if args.key?(:payment_source_type) @primary = args[:primary] if args.key?(:primary) @width = args[:width] if args.key?(:width) end end # Ad List Response class AdsListResponse include Google::Apis::Core::Hashable # Ad collection. # Corresponds to the JSON property `ads` # @return [Array] attr_accessor :ads # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#adsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @ads = args[:ads] if args.key?(:ads) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Contains properties of a DCM advertiser. class Advertiser include Google::Apis::Core::Hashable # Account ID of this advertiser.This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # ID of the advertiser group this advertiser belongs to. You can group # advertisers for reporting purposes, allowing you to see aggregated information # for all advertisers in each group. # Corresponds to the JSON property `advertiserGroupId` # @return [Fixnum] attr_accessor :advertiser_group_id # Suffix added to click-through URL of ad creative associations under this # advertiser. Must be less than 129 characters long. # Corresponds to the JSON property `clickThroughUrlSuffix` # @return [String] attr_accessor :click_through_url_suffix # ID of the click-through event tag to apply by default to the landing pages of # this advertiser's campaigns. # Corresponds to the JSON property `defaultClickThroughEventTagId` # @return [Fixnum] attr_accessor :default_click_through_event_tag_id # Default email address used in sender field for tag emails. # Corresponds to the JSON property `defaultEmail` # @return [String] attr_accessor :default_email # Floodlight configuration ID of this advertiser. The floodlight configuration # ID will be created automatically, so on insert this field should be left blank. # This field can be set to another advertiser's floodlight configuration ID in # order to share that advertiser's floodlight configuration with this advertiser, # so long as: # - This advertiser's original floodlight configuration is not already # associated with floodlight activities or floodlight activity groups. # - This advertiser's original floodlight configuration is not already shared # with another advertiser. # Corresponds to the JSON property `floodlightConfigurationId` # @return [Fixnum] attr_accessor :floodlight_configuration_id # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :floodlight_configuration_id_dimension_value # ID of this advertiser. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#advertiser". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this advertiser. This is a required field and must be less than 256 # characters long and unique among advertisers of the same account. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Original floodlight configuration before any sharing occurred. Set the # floodlightConfigurationId of this advertiser to # originalFloodlightConfigurationId to unshare the advertiser's current # floodlight configuration. You cannot unshare an advertiser's floodlight # configuration if the shared configuration has activities associated with any # campaign or placement. # Corresponds to the JSON property `originalFloodlightConfigurationId` # @return [Fixnum] attr_accessor :original_floodlight_configuration_id # Status of this advertiser. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Subaccount ID of this advertiser.This is a read-only field that can be left # blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Suspension status of this advertiser. # Corresponds to the JSON property `suspended` # @return [Boolean] attr_accessor :suspended alias_method :suspended?, :suspended def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id) @click_through_url_suffix = args[:click_through_url_suffix] if args.key?(:click_through_url_suffix) @default_click_through_event_tag_id = args[:default_click_through_event_tag_id] if args.key?(:default_click_through_event_tag_id) @default_email = args[:default_email] if args.key?(:default_email) @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @original_floodlight_configuration_id = args[:original_floodlight_configuration_id] if args.key?(:original_floodlight_configuration_id) @status = args[:status] if args.key?(:status) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @suspended = args[:suspended] if args.key?(:suspended) end end # Groups advertisers together so that reports can be generated for the entire # group at once. class AdvertiserGroup include Google::Apis::Core::Hashable # Account ID of this advertiser group. This is a read-only field that can be # left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # ID of this advertiser group. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#advertiserGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this advertiser group. This is a required field and must be less than # 256 characters long and unique among advertiser groups of the same account. # 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) @account_id = args[:account_id] if args.key?(:account_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Advertiser Group List Response class AdvertiserGroupsListResponse include Google::Apis::Core::Hashable # Advertiser group collection. # Corresponds to the JSON property `advertiserGroups` # @return [Array] attr_accessor :advertiser_groups # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#advertiserGroupsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @advertiser_groups = args[:advertiser_groups] if args.key?(:advertiser_groups) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Advertiser List Response class AdvertisersListResponse include Google::Apis::Core::Hashable # Advertiser collection. # Corresponds to the JSON property `advertisers` # @return [Array] attr_accessor :advertisers # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#advertisersListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Audience Segment. class AudienceSegment include Google::Apis::Core::Hashable # Weight allocated to this segment. The weight assigned will be understood in # proportion to the weights assigned to other segments in the same segment group. # Acceptable values are 1 to 1000, inclusive. # Corresponds to the JSON property `allocation` # @return [Fixnum] attr_accessor :allocation # ID of this audience segment. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Name of this audience segment. This is a required field and must be less than # 65 characters long. # 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) @allocation = args[:allocation] if args.key?(:allocation) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) end end # Audience Segment Group. class AudienceSegmentGroup include Google::Apis::Core::Hashable # Audience segments assigned to this group. The number of segments must be # between 2 and 100. # Corresponds to the JSON property `audienceSegments` # @return [Array] attr_accessor :audience_segments # ID of this audience segment group. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Name of this audience segment group. This is a required field and must be less # than 65 characters long. # 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) @audience_segments = args[:audience_segments] if args.key?(:audience_segments) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) end end # Contains information about a browser that can be targeted by ads. class Browser include Google::Apis::Core::Hashable # ID referring to this grouping of browser and version numbers. This is the ID # used for targeting. # Corresponds to the JSON property `browserVersionId` # @return [Fixnum] attr_accessor :browser_version_id # DART ID of this browser. This is the ID used when generating reports. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#browser". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Major version number (leftmost number) of this browser. For example, for # Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be # used to target any version number, and a question mark (?) may be used to # target cases where the version number cannot be identified. For example, # Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* # targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad # server knows the browser is Firefox but can't tell which version it is. # Corresponds to the JSON property `majorVersion` # @return [String] attr_accessor :major_version # Minor version number (number after first dot on left) of this browser. For # example, for Chrome 5.0.375.86 beta, this field should be set to 0. An # asterisk (*) may be used to target any version number, and a question mark (?) # may be used to target cases where the version number cannot be identified. For # example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. # Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases # where the ad server knows the browser is Firefox but can't tell which version # it is. # Corresponds to the JSON property `minorVersion` # @return [String] attr_accessor :minor_version # Name of this browser. # 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) @browser_version_id = args[:browser_version_id] if args.key?(:browser_version_id) @dart_id = args[:dart_id] if args.key?(:dart_id) @kind = args[:kind] if args.key?(:kind) @major_version = args[:major_version] if args.key?(:major_version) @minor_version = args[:minor_version] if args.key?(:minor_version) @name = args[:name] if args.key?(:name) end end # Browser List Response class BrowsersListResponse include Google::Apis::Core::Hashable # Browser collection. # Corresponds to the JSON property `browsers` # @return [Array] attr_accessor :browsers # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#browsersListResponse". # 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) @browsers = args[:browsers] if args.key?(:browsers) @kind = args[:kind] if args.key?(:kind) end end # Contains properties of a DCM campaign. class Campaign include Google::Apis::Core::Hashable # Account ID of this campaign. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Campaign ad blocking settings. # Corresponds to the JSON property `adBlockingConfiguration` # @return [Google::Apis::DfareportingV2_8::AdBlockingConfiguration] attr_accessor :ad_blocking_configuration # Additional creative optimization configurations for the campaign. # Corresponds to the JSON property `additionalCreativeOptimizationConfigurations` # @return [Array] attr_accessor :additional_creative_optimization_configurations # Advertiser group ID of the associated advertiser. # Corresponds to the JSON property `advertiserGroupId` # @return [Fixnum] attr_accessor :advertiser_group_id # Advertiser ID of this campaign. This is a required field. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Whether this campaign has been archived. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # Audience segment groups assigned to this campaign. Cannot have more than 300 # segment groups. # Corresponds to the JSON property `audienceSegmentGroups` # @return [Array] attr_accessor :audience_segment_groups # Billing invoice code included in the DCM client billing invoices associated # with the campaign. # Corresponds to the JSON property `billingInvoiceCode` # @return [String] attr_accessor :billing_invoice_code # Click Through URL Suffix settings. # Corresponds to the JSON property `clickThroughUrlSuffixProperties` # @return [Google::Apis::DfareportingV2_8::ClickThroughUrlSuffixProperties] attr_accessor :click_through_url_suffix_properties # Arbitrary comments about this campaign. Must be less than 256 characters long. # Corresponds to the JSON property `comment` # @return [String] attr_accessor :comment # Modification timestamp. # Corresponds to the JSON property `createInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :create_info # List of creative group IDs that are assigned to the campaign. # Corresponds to the JSON property `creativeGroupIds` # @return [Array] attr_accessor :creative_group_ids # Creative optimization settings. # Corresponds to the JSON property `creativeOptimizationConfiguration` # @return [Google::Apis::DfareportingV2_8::CreativeOptimizationConfiguration] attr_accessor :creative_optimization_configuration # Properties of inheriting and overriding the default click-through event tag. A # campaign may override the event tag defined at the advertiser level, and an ad # may also override the campaign's setting further. # Corresponds to the JSON property `defaultClickThroughEventTagProperties` # @return [Google::Apis::DfareportingV2_8::DefaultClickThroughEventTagProperties] attr_accessor :default_click_through_event_tag_properties # Date on which the campaign will stop running. On insert, the end date must be # today or a future date. The end date must be later than or be the same as the # start date. If, for example, you set 6/25/2015 as both the start and end dates, # the effective campaign run date is just that day only, 6/25/2015. The hours, # minutes, and seconds of the end date should not be set, as doing so will # result in an error. This is a required field. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # Overrides that can be used to activate or deactivate advertiser event tags. # Corresponds to the JSON property `eventTagOverrides` # @return [Array] attr_accessor :event_tag_overrides # External ID for this campaign. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id # ID of this campaign. This is a read-only auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#campaign". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :last_modified_info # Lookback configuration settings. # Corresponds to the JSON property `lookbackConfiguration` # @return [Google::Apis::DfareportingV2_8::LookbackConfiguration] attr_accessor :lookback_configuration # Name of this campaign. This is a required field and must be less than 256 # characters long and unique among campaigns of the same advertiser. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether Nielsen reports are enabled for this campaign. # Corresponds to the JSON property `nielsenOcrEnabled` # @return [Boolean] attr_accessor :nielsen_ocr_enabled alias_method :nielsen_ocr_enabled?, :nielsen_ocr_enabled # Date on which the campaign starts running. The start date can be any date. The # hours, minutes, and seconds of the start date should not be set, as doing so # will result in an error. This is a required field. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date # Subaccount ID of this campaign. This is a read-only field that can be left # blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Campaign trafficker contact emails. # Corresponds to the JSON property `traffickerEmails` # @return [Array] attr_accessor :trafficker_emails def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @ad_blocking_configuration = args[:ad_blocking_configuration] if args.key?(:ad_blocking_configuration) @additional_creative_optimization_configurations = args[:additional_creative_optimization_configurations] if args.key?(:additional_creative_optimization_configurations) @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @archived = args[:archived] if args.key?(:archived) @audience_segment_groups = args[:audience_segment_groups] if args.key?(:audience_segment_groups) @billing_invoice_code = args[:billing_invoice_code] if args.key?(:billing_invoice_code) @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties) @comment = args[:comment] if args.key?(:comment) @create_info = args[:create_info] if args.key?(:create_info) @creative_group_ids = args[:creative_group_ids] if args.key?(:creative_group_ids) @creative_optimization_configuration = args[:creative_optimization_configuration] if args.key?(:creative_optimization_configuration) @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties) @end_date = args[:end_date] if args.key?(:end_date) @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides) @external_id = args[:external_id] if args.key?(:external_id) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @name = args[:name] if args.key?(:name) @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] if args.key?(:nielsen_ocr_enabled) @start_date = args[:start_date] if args.key?(:start_date) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @trafficker_emails = args[:trafficker_emails] if args.key?(:trafficker_emails) end end # Identifies a creative which has been associated with a given campaign. class CampaignCreativeAssociation include Google::Apis::Core::Hashable # ID of the creative associated with the campaign. This is a required field. # Corresponds to the JSON property `creativeId` # @return [Fixnum] attr_accessor :creative_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#campaignCreativeAssociation". # 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) @creative_id = args[:creative_id] if args.key?(:creative_id) @kind = args[:kind] if args.key?(:kind) end end # Campaign Creative Association List Response class CampaignCreativeAssociationsListResponse include Google::Apis::Core::Hashable # Campaign creative association collection # Corresponds to the JSON property `campaignCreativeAssociations` # @return [Array] attr_accessor :campaign_creative_associations # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#campaignCreativeAssociationsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @campaign_creative_associations = args[:campaign_creative_associations] if args.key?(:campaign_creative_associations) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Campaign List Response class CampaignsListResponse include Google::Apis::Core::Hashable # Campaign collection. # Corresponds to the JSON property `campaigns` # @return [Array] attr_accessor :campaigns # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#campaignsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Describes a change that a user has made to a resource. class ChangeLog include Google::Apis::Core::Hashable # Account ID of the modified object. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Action which caused the change. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Time when the object was modified. # Corresponds to the JSON property `changeTime` # @return [DateTime] attr_accessor :change_time # Field name of the object which changed. # Corresponds to the JSON property `fieldName` # @return [String] attr_accessor :field_name # ID of this change log. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#changeLog". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # New value of the object field. # Corresponds to the JSON property `newValue` # @return [String] attr_accessor :new_value # ID of the object of this change log. The object could be a campaign, placement, # ad, or other type. # Corresponds to the JSON property `objectId` # @return [Fixnum] attr_accessor :object_id_prop # Object type of the change log. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # Old value of the object field. # Corresponds to the JSON property `oldValue` # @return [String] attr_accessor :old_value # Subaccount ID of the modified object. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Transaction ID of this change log. When a single API call results in many # changes, each change will have a separate ID in the change log but will share # the same transactionId. # Corresponds to the JSON property `transactionId` # @return [Fixnum] attr_accessor :transaction_id # ID of the user who modified the object. # Corresponds to the JSON property `userProfileId` # @return [Fixnum] attr_accessor :user_profile_id # User profile name of the user who modified the object. # Corresponds to the JSON property `userProfileName` # @return [String] attr_accessor :user_profile_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @action = args[:action] if args.key?(:action) @change_time = args[:change_time] if args.key?(:change_time) @field_name = args[:field_name] if args.key?(:field_name) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @new_value = args[:new_value] if args.key?(:new_value) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @object_type = args[:object_type] if args.key?(:object_type) @old_value = args[:old_value] if args.key?(:old_value) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @transaction_id = args[:transaction_id] if args.key?(:transaction_id) @user_profile_id = args[:user_profile_id] if args.key?(:user_profile_id) @user_profile_name = args[:user_profile_name] if args.key?(:user_profile_name) end end # Change Log List Response class ChangeLogsListResponse include Google::Apis::Core::Hashable # Change log collection. # Corresponds to the JSON property `changeLogs` # @return [Array] attr_accessor :change_logs # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#changeLogsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @change_logs = args[:change_logs] if args.key?(:change_logs) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # City List Response class CitiesListResponse include Google::Apis::Core::Hashable # City collection. # Corresponds to the JSON property `cities` # @return [Array] attr_accessor :cities # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#citiesListResponse". # 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) @cities = args[:cities] if args.key?(:cities) @kind = args[:kind] if args.key?(:kind) end end # Contains information about a city that can be targeted by ads. class City include Google::Apis::Core::Hashable # Country code of the country to which this city belongs. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of the country to which this city belongs. # Corresponds to the JSON property `countryDartId` # @return [Fixnum] attr_accessor :country_dart_id # DART ID of this city. This is the ID used for targeting and generating reports. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#city". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metro region code of the metro region (DMA) to which this city belongs. # Corresponds to the JSON property `metroCode` # @return [String] attr_accessor :metro_code # ID of the metro region (DMA) to which this city belongs. # Corresponds to the JSON property `metroDmaId` # @return [Fixnum] attr_accessor :metro_dma_id # Name of this city. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Region code of the region to which this city belongs. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code # DART ID of the region to which this city belongs. # Corresponds to the JSON property `regionDartId` # @return [Fixnum] attr_accessor :region_dart_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country_code = args[:country_code] if args.key?(:country_code) @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) @dart_id = args[:dart_id] if args.key?(:dart_id) @kind = args[:kind] if args.key?(:kind) @metro_code = args[:metro_code] if args.key?(:metro_code) @metro_dma_id = args[:metro_dma_id] if args.key?(:metro_dma_id) @name = args[:name] if args.key?(:name) @region_code = args[:region_code] if args.key?(:region_code) @region_dart_id = args[:region_dart_id] if args.key?(:region_dart_id) end end # Creative Click Tag. class ClickTag include Google::Apis::Core::Hashable # Advertiser event name associated with the click tag. This field is used by # DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when # the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `eventName` # @return [String] attr_accessor :event_name # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative # assets, this field must match the value of the creative asset's # creativeAssetId.name field. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parameter value for the specified click tag. This field contains a click- # through url. # 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) @event_name = args[:event_name] if args.key?(:event_name) @name = args[:name] if args.key?(:name) @value = args[:value] if args.key?(:value) end end # Click-through URL class ClickThroughUrl include Google::Apis::Core::Hashable # Read-only convenience field representing the actual URL that will be used for # this click-through. The URL is computed as follows: # - If defaultLandingPage is enabled then the campaign's default landing page # URL is assigned to this field. # - If defaultLandingPage is not enabled and a landingPageId is specified then # that landing page's URL is assigned to this field. # - If neither of the above cases apply, then the customClickThroughUrl is # assigned to this field. # Corresponds to the JSON property `computedClickThroughUrl` # @return [String] attr_accessor :computed_click_through_url # Custom click-through URL. Applicable if the defaultLandingPage field is set to # false and the landingPageId field is left unset. # Corresponds to the JSON property `customClickThroughUrl` # @return [String] attr_accessor :custom_click_through_url # Whether the campaign default landing page is used. # Corresponds to the JSON property `defaultLandingPage` # @return [Boolean] attr_accessor :default_landing_page alias_method :default_landing_page?, :default_landing_page # ID of the landing page for the click-through URL. Applicable if the # defaultLandingPage field is set to false. # Corresponds to the JSON property `landingPageId` # @return [Fixnum] attr_accessor :landing_page_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @computed_click_through_url = args[:computed_click_through_url] if args.key?(:computed_click_through_url) @custom_click_through_url = args[:custom_click_through_url] if args.key?(:custom_click_through_url) @default_landing_page = args[:default_landing_page] if args.key?(:default_landing_page) @landing_page_id = args[:landing_page_id] if args.key?(:landing_page_id) end end # Click Through URL Suffix settings. class ClickThroughUrlSuffixProperties include Google::Apis::Core::Hashable # Click-through URL suffix to apply to all ads in this entity's scope. Must be # less than 128 characters long. # Corresponds to the JSON property `clickThroughUrlSuffix` # @return [String] attr_accessor :click_through_url_suffix # Whether this entity should override the inherited click-through URL suffix # with its own defined value. # Corresponds to the JSON property `overrideInheritedSuffix` # @return [Boolean] attr_accessor :override_inherited_suffix alias_method :override_inherited_suffix?, :override_inherited_suffix def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_through_url_suffix = args[:click_through_url_suffix] if args.key?(:click_through_url_suffix) @override_inherited_suffix = args[:override_inherited_suffix] if args.key?(:override_inherited_suffix) end end # Companion Click-through override. class CompanionClickThroughOverride include Google::Apis::Core::Hashable # Click-through URL # Corresponds to the JSON property `clickThroughUrl` # @return [Google::Apis::DfareportingV2_8::ClickThroughUrl] attr_accessor :click_through_url # ID of the creative for this companion click-through override. # Corresponds to the JSON property `creativeId` # @return [Fixnum] attr_accessor :creative_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @creative_id = args[:creative_id] if args.key?(:creative_id) end end # Companion Settings class CompanionSetting include Google::Apis::Core::Hashable # Whether companions are disabled for this placement. # Corresponds to the JSON property `companionsDisabled` # @return [Boolean] attr_accessor :companions_disabled alias_method :companions_disabled?, :companions_disabled # Whitelist of companion sizes to be served to this placement. Set this list to # null or empty to serve all companion sizes. # Corresponds to the JSON property `enabledSizes` # @return [Array] attr_accessor :enabled_sizes # Whether to serve only static images as companions. # Corresponds to the JSON property `imageOnly` # @return [Boolean] attr_accessor :image_only alias_method :image_only?, :image_only # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#companionSetting". # 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) @companions_disabled = args[:companions_disabled] if args.key?(:companions_disabled) @enabled_sizes = args[:enabled_sizes] if args.key?(:enabled_sizes) @image_only = args[:image_only] if args.key?(:image_only) @kind = args[:kind] if args.key?(:kind) end end # Represents a response to the queryCompatibleFields method. class CompatibleFields include Google::Apis::Core::Hashable # Represents fields that are compatible to be selected for a report of type " # CROSS_DIMENSION_REACH". # Corresponds to the JSON property `crossDimensionReachReportCompatibleFields` # @return [Google::Apis::DfareportingV2_8::CrossDimensionReachReportCompatibleFields] attr_accessor :cross_dimension_reach_report_compatible_fields # Represents fields that are compatible to be selected for a report of type " # FlOODLIGHT". # Corresponds to the JSON property `floodlightReportCompatibleFields` # @return [Google::Apis::DfareportingV2_8::FloodlightReportCompatibleFields] attr_accessor :floodlight_report_compatible_fields # The kind of resource this is, in this case dfareporting#compatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Represents fields that are compatible to be selected for a report of type " # PATH_TO_CONVERSION". # Corresponds to the JSON property `pathToConversionReportCompatibleFields` # @return [Google::Apis::DfareportingV2_8::PathToConversionReportCompatibleFields] attr_accessor :path_to_conversion_report_compatible_fields # Represents fields that are compatible to be selected for a report of type " # REACH". # Corresponds to the JSON property `reachReportCompatibleFields` # @return [Google::Apis::DfareportingV2_8::ReachReportCompatibleFields] attr_accessor :reach_report_compatible_fields # Represents fields that are compatible to be selected for a report of type " # STANDARD". # Corresponds to the JSON property `reportCompatibleFields` # @return [Google::Apis::DfareportingV2_8::ReportCompatibleFields] attr_accessor :report_compatible_fields def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cross_dimension_reach_report_compatible_fields = args[:cross_dimension_reach_report_compatible_fields] if args.key?(:cross_dimension_reach_report_compatible_fields) @floodlight_report_compatible_fields = args[:floodlight_report_compatible_fields] if args.key?(:floodlight_report_compatible_fields) @kind = args[:kind] if args.key?(:kind) @path_to_conversion_report_compatible_fields = args[:path_to_conversion_report_compatible_fields] if args.key?(:path_to_conversion_report_compatible_fields) @reach_report_compatible_fields = args[:reach_report_compatible_fields] if args.key?(:reach_report_compatible_fields) @report_compatible_fields = args[:report_compatible_fields] if args.key?(:report_compatible_fields) end end # Contains information about an internet connection type that can be targeted by # ads. Clients can use the connection type to target mobile vs. broadband users. class ConnectionType include Google::Apis::Core::Hashable # ID of this connection type. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#connectionType". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this connection type. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Connection Type List Response class ConnectionTypesListResponse include Google::Apis::Core::Hashable # Collection of connection types such as broadband and mobile. # Corresponds to the JSON property `connectionTypes` # @return [Array] attr_accessor :connection_types # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#connectionTypesListResponse". # 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) @connection_types = args[:connection_types] if args.key?(:connection_types) @kind = args[:kind] if args.key?(:kind) end end # Content Category List Response class ContentCategoriesListResponse include Google::Apis::Core::Hashable # Content category collection. # Corresponds to the JSON property `contentCategories` # @return [Array] attr_accessor :content_categories # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#contentCategoriesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @content_categories = args[:content_categories] if args.key?(:content_categories) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Organizes placements according to the contents of their associated webpages. class ContentCategory include Google::Apis::Core::Hashable # Account ID of this content category. This is a read-only field that can be # left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # ID of this content category. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#contentCategory". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this content category. This is a required field and must be less than # 256 characters long and unique among content categories of the same account. # 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) @account_id = args[:account_id] if args.key?(:account_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # A Conversion represents when a user successfully performs a desired action # after seeing an ad. class Conversion include Google::Apis::Core::Hashable # Whether the conversion was directed toward children. # Corresponds to the JSON property `childDirectedTreatment` # @return [Boolean] attr_accessor :child_directed_treatment alias_method :child_directed_treatment?, :child_directed_treatment # Custom floodlight variables. # Corresponds to the JSON property `customVariables` # @return [Array] attr_accessor :custom_variables # The alphanumeric encrypted user ID. When set, encryptionInfo should also be # specified. This field is mutually exclusive with encryptedUserIdCandidates[], # mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or # mobileDeviceId or gclid is a required field. # Corresponds to the JSON property `encryptedUserId` # @return [String] attr_accessor :encrypted_user_id # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior # to the conversion timestamp will be used in the inserted conversion. If no # such user ID is found then the conversion will be rejected with # NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. # This field may only be used when calling batchinsert; it is not supported by # batchupdate. This field is mutually exclusive with encryptedUserId, # mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid # is a required field. # Corresponds to the JSON property `encryptedUserIdCandidates` # @return [Array] attr_accessor :encrypted_user_id_candidates # Floodlight Activity ID of this conversion. This is a required field. # Corresponds to the JSON property `floodlightActivityId` # @return [Fixnum] attr_accessor :floodlight_activity_id # Floodlight Configuration ID of this conversion. This is a required field. # Corresponds to the JSON property `floodlightConfigurationId` # @return [Fixnum] attr_accessor :floodlight_configuration_id # The Google click ID. This field is mutually exclusive with encryptedUserId, # encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or # encryptedUserIdCandidates[] or mobileDeviceId is a required field. # Corresponds to the JSON property `gclid` # @return [String] attr_accessor :gclid # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversion". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be # used for reporting but not targeting. This will prevent remarketing. # Corresponds to the JSON property `limitAdTracking` # @return [Boolean] attr_accessor :limit_ad_tracking alias_method :limit_ad_tracking?, :limit_ad_tracking # The mobile device ID. This field is mutually exclusive with encryptedUserId, # encryptedUserIdCandidates[] and gclid. This or encryptedUserId or # encryptedUserIdCandidates[] or gclid is a required field. # Corresponds to the JSON property `mobileDeviceId` # @return [String] attr_accessor :mobile_device_id # The ordinal of the conversion. Use this field to control how conversions of # the same user and day are de-duplicated. This is a required field. # Corresponds to the JSON property `ordinal` # @return [String] attr_accessor :ordinal # The quantity of the conversion. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # The timestamp of conversion, in Unix epoch micros. This is a required field. # Corresponds to the JSON property `timestampMicros` # @return [Fixnum] attr_accessor :timestamp_micros # The value of the conversion. # 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) @child_directed_treatment = args[:child_directed_treatment] if args.key?(:child_directed_treatment) @custom_variables = args[:custom_variables] if args.key?(:custom_variables) @encrypted_user_id = args[:encrypted_user_id] if args.key?(:encrypted_user_id) @encrypted_user_id_candidates = args[:encrypted_user_id_candidates] if args.key?(:encrypted_user_id_candidates) @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) @gclid = args[:gclid] if args.key?(:gclid) @kind = args[:kind] if args.key?(:kind) @limit_ad_tracking = args[:limit_ad_tracking] if args.key?(:limit_ad_tracking) @mobile_device_id = args[:mobile_device_id] if args.key?(:mobile_device_id) @ordinal = args[:ordinal] if args.key?(:ordinal) @quantity = args[:quantity] if args.key?(:quantity) @timestamp_micros = args[:timestamp_micros] if args.key?(:timestamp_micros) @value = args[:value] if args.key?(:value) end end # The error code and description for a conversion that failed to insert or # update. class ConversionError include Google::Apis::Core::Hashable # The error code. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionError". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A description of the error. # 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) @kind = args[:kind] if args.key?(:kind) @message = args[:message] if args.key?(:message) end end # The original conversion that was inserted or updated and whether there were # any errors. class ConversionStatus include Google::Apis::Core::Hashable # A Conversion represents when a user successfully performs a desired action # after seeing an ad. # Corresponds to the JSON property `conversion` # @return [Google::Apis::DfareportingV2_8::Conversion] attr_accessor :conversion # A list of errors related to this conversion. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionStatus". # 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) @conversion = args[:conversion] if args.key?(:conversion) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) end end # Insert Conversions Request. class ConversionsBatchInsertRequest include Google::Apis::Core::Hashable # The set of conversions to insert. # Corresponds to the JSON property `conversions` # @return [Array] attr_accessor :conversions # A description of how user IDs are encrypted. # Corresponds to the JSON property `encryptionInfo` # @return [Google::Apis::DfareportingV2_8::EncryptionInfo] attr_accessor :encryption_info # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionsBatchInsertRequest". # 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) @conversions = args[:conversions] if args.key?(:conversions) @encryption_info = args[:encryption_info] if args.key?(:encryption_info) @kind = args[:kind] if args.key?(:kind) end end # Insert Conversions Response. class ConversionsBatchInsertResponse include Google::Apis::Core::Hashable # Indicates that some or all conversions failed to insert. # Corresponds to the JSON property `hasFailures` # @return [Boolean] attr_accessor :has_failures alias_method :has_failures?, :has_failures # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionsBatchInsertResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The insert status of each conversion. Statuses are returned in the same order # that conversions are inserted. # Corresponds to the JSON property `status` # @return [Array] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @has_failures = args[:has_failures] if args.key?(:has_failures) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) end end # Update Conversions Request. class ConversionsBatchUpdateRequest include Google::Apis::Core::Hashable # The set of conversions to update. # Corresponds to the JSON property `conversions` # @return [Array] attr_accessor :conversions # A description of how user IDs are encrypted. # Corresponds to the JSON property `encryptionInfo` # @return [Google::Apis::DfareportingV2_8::EncryptionInfo] attr_accessor :encryption_info # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionsBatchUpdateRequest". # 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) @conversions = args[:conversions] if args.key?(:conversions) @encryption_info = args[:encryption_info] if args.key?(:encryption_info) @kind = args[:kind] if args.key?(:kind) end end # Update Conversions Response. class ConversionsBatchUpdateResponse include Google::Apis::Core::Hashable # Indicates that some or all conversions failed to update. # Corresponds to the JSON property `hasFailures` # @return [Boolean] attr_accessor :has_failures alias_method :has_failures?, :has_failures # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionsBatchUpdateResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The update status of each conversion. Statuses are returned in the same order # that conversions are updated. # Corresponds to the JSON property `status` # @return [Array] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @has_failures = args[:has_failures] if args.key?(:has_failures) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) end end # Country List Response class CountriesListResponse include Google::Apis::Core::Hashable # Country collection. # Corresponds to the JSON property `countries` # @return [Array] attr_accessor :countries # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#countriesListResponse". # 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) @countries = args[:countries] if args.key?(:countries) @kind = args[:kind] if args.key?(:kind) end end # Contains information about a country that can be targeted by ads. class Country include Google::Apis::Core::Hashable # Country code. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of this country. This is the ID used for targeting and generating # reports. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#country". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this country. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether ad serving supports secure servers in this country. # Corresponds to the JSON property `sslEnabled` # @return [Boolean] attr_accessor :ssl_enabled alias_method :ssl_enabled?, :ssl_enabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country_code = args[:country_code] if args.key?(:country_code) @dart_id = args[:dart_id] if args.key?(:dart_id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @ssl_enabled = args[:ssl_enabled] if args.key?(:ssl_enabled) end end # Contains properties of a Creative. class Creative include Google::Apis::Core::Hashable # Account ID of this creative. This field, if left unset, will be auto-generated # for both insert and update operations. Applicable to all creative types. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether the creative is active. Applicable to all creative types. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Ad parameters user for VPAID creative. This is a read-only field. Applicable # to the following creative types: all VPAID. # Corresponds to the JSON property `adParameters` # @return [String] attr_accessor :ad_parameters # Keywords for a Rich Media creative. Keywords let you customize the creative # settings of a Rich Media ad running on your site without having to contact the # advertiser. You can use keywords to dynamically change the look or # functionality of a creative. Applicable to the following creative types: all # RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `adTagKeys` # @return [Array] attr_accessor :ad_tag_keys # Advertiser ID of this creative. This is a required field. Applicable to all # creative types. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Whether script access is allowed for this creative. This is a read-only and # deprecated field which will automatically be set to true on update. Applicable # to the following creative types: FLASH_INPAGE. # Corresponds to the JSON property `allowScriptAccess` # @return [Boolean] attr_accessor :allow_script_access alias_method :allow_script_access?, :allow_script_access # Whether the creative is archived. Applicable to all creative types. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # Type of artwork used for the creative. This is a read-only field. Applicable # to the following creative types: all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `artworkType` # @return [String] attr_accessor :artwork_type # Source application where creative was authored. Presently, only DBM authored # creatives will have this field set. Applicable to all creative types. # Corresponds to the JSON property `authoringSource` # @return [String] attr_accessor :authoring_source # Authoring tool for HTML5 banner creatives. This is a read-only field. # Applicable to the following creative types: HTML5_BANNER. # Corresponds to the JSON property `authoringTool` # @return [String] attr_accessor :authoring_tool # Whether images are automatically advanced for image gallery creatives. # Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. # Corresponds to the JSON property `autoAdvanceImages` # @return [Boolean] attr_accessor :auto_advance_images alias_method :auto_advance_images?, :auto_advance_images # The 6-character HTML color code, beginning with #, for the background of the # window area where the Flash file is displayed. Default is white. Applicable to # the following creative types: FLASH_INPAGE. # Corresponds to the JSON property `backgroundColor` # @return [String] attr_accessor :background_color # Click-through URL for backup image. Applicable to the following creative types: # FLASH_INPAGE, and HTML5_BANNER. Applicable to DISPLAY when the primary asset # type is not HTML_IMAGE. # Corresponds to the JSON property `backupImageClickThroughUrl` # @return [String] attr_accessor :backup_image_click_through_url # List of feature dependencies that will cause a backup image to be served if # the browser that serves the ad does not support them. Feature dependencies are # features that a browser must be able to support in order to render your HTML5 # creative asset correctly. This field is initially auto-generated to contain # all features detected by DCM for all the assets of this creative and can then # be modified by the client. To reset this field, copy over all the # creativeAssets' detected features. Applicable to the following creative types: # HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not # HTML_IMAGE. # Corresponds to the JSON property `backupImageFeatures` # @return [Array] attr_accessor :backup_image_features # Reporting label used for HTML5 banner backup image. Applicable to the # following creative types: DISPLAY when the primary asset type is not # HTML_IMAGE. # Corresponds to the JSON property `backupImageReportingLabel` # @return [String] attr_accessor :backup_image_reporting_label # Target Window. # Corresponds to the JSON property `backupImageTargetWindow` # @return [Google::Apis::DfareportingV2_8::TargetWindow] attr_accessor :backup_image_target_window # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER # creatives, this is a subset of detected click tags for the assets associated # with this creative. After creating a flash asset, detected click tags will be # returned in the creativeAssetMetadata. When inserting the creative, populate # the creative clickTags field using the creativeAssetMetadata.clickTags field. # For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this # list for each image creative asset. A click tag is matched with a # corresponding creative asset by matching the clickTag.name field with the # creativeAsset.assetIdentifier.name field. Applicable to the following creative # types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to # DISPLAY when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `clickTags` # @return [Array] attr_accessor :click_tags # Industry standard ID assigned to creative for reach and frequency. Applicable # to INSTREAM_VIDEO_REDIRECT creatives. # Corresponds to the JSON property `commercialId` # @return [String] attr_accessor :commercial_id # List of companion creatives assigned to an in-Stream videocreative. Acceptable # values include IDs of existing flash and image creatives. Applicable to the # following creative types: all VPAID and all INSTREAM_VIDEO with # dynamicAssetSelection set to false. # Corresponds to the JSON property `companionCreatives` # @return [Array] attr_accessor :companion_creatives # Compatibilities associated with this creative. This is a read-only field. # DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on # mobile devices or in mobile apps for regular or interstitial ads, respectively. # APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing # creatives may have these compatibilities since new creatives will either be # assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to # rendering in in-stream video ads developed with the VAST standard. Applicable # to all creative types. # Acceptable values are: # - "APP" # - "APP_INTERSTITIAL" # - "IN_STREAM_VIDEO" # - "DISPLAY" # - "DISPLAY_INTERSTITIAL" # Corresponds to the JSON property `compatibility` # @return [Array] attr_accessor :compatibility # Whether Flash assets associated with the creative need to be automatically # converted to HTML5. This flag is enabled by default and users can choose to # disable it if they don't want the system to generate and use HTML5 asset for # this creative. Applicable to the following creative type: FLASH_INPAGE. # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `convertFlashToHtml5` # @return [Boolean] attr_accessor :convert_flash_to_html5 alias_method :convert_flash_to_html5?, :convert_flash_to_html5 # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY # creatives, these are read-only and auto-generated from clickTags. Applicable # to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and # all VPAID. # Corresponds to the JSON property `counterCustomEvents` # @return [Array] attr_accessor :counter_custom_events # Encapsulates the list of rules for asset selection and a default asset in case # none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Corresponds to the JSON property `creativeAssetSelection` # @return [Google::Apis::DfareportingV2_8::CreativeAssetSelection] attr_accessor :creative_asset_selection # Assets associated with a creative. Applicable to all but the following # creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and # REDIRECT # Corresponds to the JSON property `creativeAssets` # @return [Array] attr_accessor :creative_assets # Creative field assignments for this creative. Applicable to all creative types. # Corresponds to the JSON property `creativeFieldAssignments` # @return [Array] attr_accessor :creative_field_assignments # Custom key-values for a Rich Media creative. Key-values let you customize the # creative settings of a Rich Media ad running on your site without having to # contact the advertiser. You can use key-values to dynamically change the look # or functionality of a creative. Applicable to the following creative types: # all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `customKeyValues` # @return [Array] attr_accessor :custom_key_values # Set this to true to enable the use of rules to target individual assets in # this creative. When set to true creativeAssetSelection must be set. This also # controls asset-level companions. When this is true, companion creatives should # be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO # creatives. # Corresponds to the JSON property `dynamicAssetSelection` # @return [Boolean] attr_accessor :dynamic_asset_selection alias_method :dynamic_asset_selection?, :dynamic_asset_selection # List of exit events configured for the creative. For DISPLAY and # DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from # clickTags, For DISPLAY, an event is also created from the # backupImageReportingLabel. Applicable to the following creative types: # DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY # when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `exitCustomEvents` # @return [Array] attr_accessor :exit_custom_events # FsCommand. # Corresponds to the JSON property `fsCommand` # @return [Google::Apis::DfareportingV2_8::FsCommand] attr_accessor :fs_command # HTML code for the creative. This is a required field when applicable. This # field is ignored if htmlCodeLocked is true. Applicable to the following # creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. # Corresponds to the JSON property `htmlCode` # @return [String] attr_accessor :html_code # Whether HTML code is DCM-generated or manually entered. Set to true to ignore # changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE # and HTML5_BANNER. # Corresponds to the JSON property `htmlCodeLocked` # @return [Boolean] attr_accessor :html_code_locked alias_method :html_code_locked?, :html_code_locked # ID of this creative. This is a read-only, auto-generated field. Applicable to # all creative types. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creative". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :last_modified_info # Latest Studio trafficked creative ID associated with rich media and VPAID # creatives. This is a read-only field. Applicable to the following creative # types: all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `latestTraffickedCreativeId` # @return [Fixnum] attr_accessor :latest_trafficked_creative_id # Name of the creative. This is a required field and must be less than 256 # characters long. Applicable to all creative types. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Override CSS value for rich media creatives. Applicable to the following # creative types: all RICH_MEDIA. # Corresponds to the JSON property `overrideCss` # @return [String] attr_accessor :override_css # Video Offset # Corresponds to the JSON property `progressOffset` # @return [Google::Apis::DfareportingV2_8::VideoOffset] attr_accessor :progress_offset # URL of hosted image or hosted video or another ad tag. For # INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. # The standard for a VAST (Video Ad Serving Template) ad response allows for a # redirect link to another VAST 2.0 or 3.0 call. This is a required field when # applicable. Applicable to the following creative types: DISPLAY_REDIRECT, # INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT # Corresponds to the JSON property `redirectUrl` # @return [String] attr_accessor :redirect_url # ID of current rendering version. This is a read-only field. Applicable to all # creative types. # Corresponds to the JSON property `renderingId` # @return [Fixnum] attr_accessor :rendering_id # Represents a DimensionValue resource. # Corresponds to the JSON property `renderingIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :rendering_id_dimension_value # The minimum required Flash plugin version for this creative. For example, 11.2. # 202.235. This is a read-only field. Applicable to the following creative types: # all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `requiredFlashPluginVersion` # @return [String] attr_accessor :required_flash_plugin_version # The internal Flash version for this creative as calculated by DoubleClick # Studio. This is a read-only field. Applicable to the following creative types: # FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the # primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `requiredFlashVersion` # @return [Fixnum] attr_accessor :required_flash_version # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `size` # @return [Google::Apis::DfareportingV2_8::Size] attr_accessor :size # Video Offset # Corresponds to the JSON property `skipOffset` # @return [Google::Apis::DfareportingV2_8::VideoOffset] attr_accessor :skip_offset # Whether the user can choose to skip the creative. Applicable to the following # creative types: all INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `skippable` # @return [Boolean] attr_accessor :skippable alias_method :skippable?, :skippable # Whether the creative is SSL-compliant. This is a read-only field. Applicable # to all creative types. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Whether creative should be treated as SSL compliant even if the system scan # shows it's not. Applicable to all creative types. # Corresponds to the JSON property `sslOverride` # @return [Boolean] attr_accessor :ssl_override alias_method :ssl_override?, :ssl_override # Studio advertiser ID associated with rich media and VPAID creatives. This is a # read-only field. Applicable to the following creative types: all RICH_MEDIA, # and all VPAID. # Corresponds to the JSON property `studioAdvertiserId` # @return [Fixnum] attr_accessor :studio_advertiser_id # Studio creative ID associated with rich media and VPAID creatives. This is a # read-only field. Applicable to the following creative types: all RICH_MEDIA, # and all VPAID. # Corresponds to the JSON property `studioCreativeId` # @return [Fixnum] attr_accessor :studio_creative_id # Studio trafficked creative ID associated with rich media and VPAID creatives. # This is a read-only field. Applicable to the following creative types: all # RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `studioTraffickedCreativeId` # @return [Fixnum] attr_accessor :studio_trafficked_creative_id # Subaccount ID of this creative. This field, if left unset, will be auto- # generated for both insert and update operations. Applicable to all creative # types. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Third-party URL used to record backup image impressions. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `thirdPartyBackupImageImpressionsUrl` # @return [String] attr_accessor :third_party_backup_image_impressions_url # Third-party URL used to record rich media impressions. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `thirdPartyRichMediaImpressionsUrl` # @return [String] attr_accessor :third_party_rich_media_impressions_url # Third-party URLs for tracking in-stream video creative events. Applicable to # the following creative types: all INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `thirdPartyUrls` # @return [Array] attr_accessor :third_party_urls # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY # creatives, these are read-only and auto-generated from clickTags. Applicable # to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and # all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. # Corresponds to the JSON property `timerCustomEvents` # @return [Array] attr_accessor :timer_custom_events # Combined size of all creative assets. This is a read-only field. Applicable to # the following creative types: all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `totalFileSize` # @return [Fixnum] attr_accessor :total_file_size # Type of this creative. This is a required field. Applicable to all creative # types. # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing # creatives. New creatives should use DISPLAY as a replacement for these types. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following # creative types: INSTREAM_VIDEO and VPAID. # Corresponds to the JSON property `universalAdId` # @return [Google::Apis::DfareportingV2_8::UniversalAdId] attr_accessor :universal_ad_id # The version number helps you keep track of multiple versions of your creative # in your reports. The version number will always be auto-generated during # insert operations to start at 1. For tracking creatives the version cannot be # incremented and will always remain at 1. For all other creative types the # version can be incremented only by 1 during update operations. In addition, # the version will be automatically incremented by 1 when undergoing Rich Media # creative merging. Applicable to all creative types. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version # Description of the video ad. Applicable to the following creative types: all # INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `videoDescription` # @return [String] attr_accessor :video_description # Creative video duration in seconds. This is a read-only field. Applicable to # the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `videoDuration` # @return [Float] attr_accessor :video_duration def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @ad_parameters = args[:ad_parameters] if args.key?(:ad_parameters) @ad_tag_keys = args[:ad_tag_keys] if args.key?(:ad_tag_keys) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @allow_script_access = args[:allow_script_access] if args.key?(:allow_script_access) @archived = args[:archived] if args.key?(:archived) @artwork_type = args[:artwork_type] if args.key?(:artwork_type) @authoring_source = args[:authoring_source] if args.key?(:authoring_source) @authoring_tool = args[:authoring_tool] if args.key?(:authoring_tool) @auto_advance_images = args[:auto_advance_images] if args.key?(:auto_advance_images) @background_color = args[:background_color] if args.key?(:background_color) @backup_image_click_through_url = args[:backup_image_click_through_url] if args.key?(:backup_image_click_through_url) @backup_image_features = args[:backup_image_features] if args.key?(:backup_image_features) @backup_image_reporting_label = args[:backup_image_reporting_label] if args.key?(:backup_image_reporting_label) @backup_image_target_window = args[:backup_image_target_window] if args.key?(:backup_image_target_window) @click_tags = args[:click_tags] if args.key?(:click_tags) @commercial_id = args[:commercial_id] if args.key?(:commercial_id) @companion_creatives = args[:companion_creatives] if args.key?(:companion_creatives) @compatibility = args[:compatibility] if args.key?(:compatibility) @convert_flash_to_html5 = args[:convert_flash_to_html5] if args.key?(:convert_flash_to_html5) @counter_custom_events = args[:counter_custom_events] if args.key?(:counter_custom_events) @creative_asset_selection = args[:creative_asset_selection] if args.key?(:creative_asset_selection) @creative_assets = args[:creative_assets] if args.key?(:creative_assets) @creative_field_assignments = args[:creative_field_assignments] if args.key?(:creative_field_assignments) @custom_key_values = args[:custom_key_values] if args.key?(:custom_key_values) @dynamic_asset_selection = args[:dynamic_asset_selection] if args.key?(:dynamic_asset_selection) @exit_custom_events = args[:exit_custom_events] if args.key?(:exit_custom_events) @fs_command = args[:fs_command] if args.key?(:fs_command) @html_code = args[:html_code] if args.key?(:html_code) @html_code_locked = args[:html_code_locked] if args.key?(:html_code_locked) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @latest_trafficked_creative_id = args[:latest_trafficked_creative_id] if args.key?(:latest_trafficked_creative_id) @name = args[:name] if args.key?(:name) @override_css = args[:override_css] if args.key?(:override_css) @progress_offset = args[:progress_offset] if args.key?(:progress_offset) @redirect_url = args[:redirect_url] if args.key?(:redirect_url) @rendering_id = args[:rendering_id] if args.key?(:rendering_id) @rendering_id_dimension_value = args[:rendering_id_dimension_value] if args.key?(:rendering_id_dimension_value) @required_flash_plugin_version = args[:required_flash_plugin_version] if args.key?(:required_flash_plugin_version) @required_flash_version = args[:required_flash_version] if args.key?(:required_flash_version) @size = args[:size] if args.key?(:size) @skip_offset = args[:skip_offset] if args.key?(:skip_offset) @skippable = args[:skippable] if args.key?(:skippable) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @ssl_override = args[:ssl_override] if args.key?(:ssl_override) @studio_advertiser_id = args[:studio_advertiser_id] if args.key?(:studio_advertiser_id) @studio_creative_id = args[:studio_creative_id] if args.key?(:studio_creative_id) @studio_trafficked_creative_id = args[:studio_trafficked_creative_id] if args.key?(:studio_trafficked_creative_id) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @third_party_backup_image_impressions_url = args[:third_party_backup_image_impressions_url] if args.key?(:third_party_backup_image_impressions_url) @third_party_rich_media_impressions_url = args[:third_party_rich_media_impressions_url] if args.key?(:third_party_rich_media_impressions_url) @third_party_urls = args[:third_party_urls] if args.key?(:third_party_urls) @timer_custom_events = args[:timer_custom_events] if args.key?(:timer_custom_events) @total_file_size = args[:total_file_size] if args.key?(:total_file_size) @type = args[:type] if args.key?(:type) @universal_ad_id = args[:universal_ad_id] if args.key?(:universal_ad_id) @version = args[:version] if args.key?(:version) @video_description = args[:video_description] if args.key?(:video_description) @video_duration = args[:video_duration] if args.key?(:video_duration) end end # Creative Asset. class CreativeAsset include Google::Apis::Core::Hashable # Whether ActionScript3 is enabled for the flash asset. This is a read-only # field. Applicable to the following creative type: FLASH_INPAGE. Applicable to # DISPLAY when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `actionScript3` # @return [Boolean] attr_accessor :action_script3 alias_method :action_script3?, :action_script3 # Whether the video asset is active. This is a read-only field for # VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: # INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Possible alignments for an asset. This is a read-only field. Applicable to the # following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. # Corresponds to the JSON property `alignment` # @return [String] attr_accessor :alignment # Artwork type of rich media creative. This is a read-only field. Applicable to # the following creative types: all RICH_MEDIA. # Corresponds to the JSON property `artworkType` # @return [String] attr_accessor :artwork_type # Creative Asset ID. # Corresponds to the JSON property `assetIdentifier` # @return [Google::Apis::DfareportingV2_8::CreativeAssetId] attr_accessor :asset_identifier # Creative Custom Event. # Corresponds to the JSON property `backupImageExit` # @return [Google::Apis::DfareportingV2_8::CreativeCustomEvent] attr_accessor :backup_image_exit # Detected bit-rate for video asset. This is a read-only field. Applicable to # the following creative types: INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `bitRate` # @return [Fixnum] attr_accessor :bit_rate # Rich media child asset type. This is a read-only field. Applicable to the # following creative types: all VPAID. # Corresponds to the JSON property `childAssetType` # @return [String] attr_accessor :child_asset_type # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `collapsedSize` # @return [Google::Apis::DfareportingV2_8::Size] attr_accessor :collapsed_size # List of companion creatives assigned to an in-stream video creative asset. # Acceptable values include IDs of existing flash and image creatives. # Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to # true. # Corresponds to the JSON property `companionCreativeIds` # @return [Array] attr_accessor :companion_creative_ids # Custom start time in seconds for making the asset visible. Applicable to the # following creative types: all RICH_MEDIA. Value must be greater than or equal # to 0. # Corresponds to the JSON property `customStartTimeValue` # @return [Fixnum] attr_accessor :custom_start_time_value # List of feature dependencies for the creative asset that are detected by DCM. # Feature dependencies are features that a browser must be able to support in # order to render your HTML5 creative correctly. This is a read-only, auto- # generated field. Applicable to the following creative types: HTML5_BANNER. # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `detectedFeatures` # @return [Array] attr_accessor :detected_features # Type of rich media asset. This is a read-only field. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `displayType` # @return [String] attr_accessor :display_type # Duration in seconds for which an asset will be displayed. Applicable to the # following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be # greater than or equal to 1. # Corresponds to the JSON property `duration` # @return [Fixnum] attr_accessor :duration # Duration type for which an asset will be displayed. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `durationType` # @return [String] attr_accessor :duration_type # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `expandedDimension` # @return [Google::Apis::DfareportingV2_8::Size] attr_accessor :expanded_dimension # File size associated with this creative asset. This is a read-only field. # Applicable to all but the following creative types: all REDIRECT and # TRACKING_TEXT. # Corresponds to the JSON property `fileSize` # @return [Fixnum] attr_accessor :file_size # Flash version of the asset. This is a read-only field. Applicable to the # following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `flashVersion` # @return [Fixnum] attr_accessor :flash_version # Whether to hide Flash objects flag for an asset. Applicable to the following # creative types: all RICH_MEDIA. # Corresponds to the JSON property `hideFlashObjects` # @return [Boolean] attr_accessor :hide_flash_objects alias_method :hide_flash_objects?, :hide_flash_objects # Whether to hide selection boxes flag for an asset. Applicable to the following # creative types: all RICH_MEDIA. # Corresponds to the JSON property `hideSelectionBoxes` # @return [Boolean] attr_accessor :hide_selection_boxes alias_method :hide_selection_boxes?, :hide_selection_boxes # Whether the asset is horizontally locked. This is a read-only field. # Applicable to the following creative types: all RICH_MEDIA. # Corresponds to the JSON property `horizontallyLocked` # @return [Boolean] attr_accessor :horizontally_locked alias_method :horizontally_locked?, :horizontally_locked # Numeric ID of this creative asset. This is a required field and should not be # modified. Applicable to all but the following creative types: all REDIRECT and # TRACKING_TEXT. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Detected MIME type for video asset. This is a read-only field. Applicable to # the following creative types: INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type # Offset Position. # Corresponds to the JSON property `offset` # @return [Google::Apis::DfareportingV2_8::OffsetPosition] attr_accessor :offset # Whether the backup asset is original or changed by the user in DCM. Applicable # to the following creative types: all RICH_MEDIA. # Corresponds to the JSON property `originalBackup` # @return [Boolean] attr_accessor :original_backup alias_method :original_backup?, :original_backup # Offset Position. # Corresponds to the JSON property `position` # @return [Google::Apis::DfareportingV2_8::OffsetPosition] attr_accessor :position # Offset left unit for an asset. This is a read-only field. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `positionLeftUnit` # @return [String] attr_accessor :position_left_unit # Offset top unit for an asset. This is a read-only field if the asset # displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following # creative types: all RICH_MEDIA. # Corresponds to the JSON property `positionTopUnit` # @return [String] attr_accessor :position_top_unit # Progressive URL for video asset. This is a read-only field. Applicable to the # following creative types: INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `progressiveServingUrl` # @return [String] attr_accessor :progressive_serving_url # Whether the asset pushes down other content. Applicable to the following # creative types: all RICH_MEDIA. Additionally, only applicable when the asset # offsets are 0, the collapsedSize.width matches size.width, and the # collapsedSize.height is less than size.height. # Corresponds to the JSON property `pushdown` # @return [Boolean] attr_accessor :pushdown alias_method :pushdown?, :pushdown # Pushdown duration in seconds for an asset. Applicable to the following # creative types: all RICH_MEDIA.Additionally, only applicable when the asset # pushdown field is true, the offsets are 0, the collapsedSize.width matches # size.width, and the collapsedSize.height is less than size.height. Acceptable # values are 0 to 9.99, inclusive. # Corresponds to the JSON property `pushdownDuration` # @return [Float] attr_accessor :pushdown_duration # Role of the asset in relation to creative. Applicable to all but the following # creative types: all REDIRECT and TRACKING_TEXT. This is a required field. # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, # DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary # assets), and all VPAID creatives. # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all # VPAID creatives. Applicable to DISPLAY when the primary asset type is not # HTML_IMAGE. # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. # OTHER refers to assets from sources other than DCM, such as Studio uploaded # assets, applicable to all RICH_MEDIA and all VPAID creatives. # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to # INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets # and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from # Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be # added or removed within DCM. # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and # ALTERNATE_VIDEO assets that are marked active serve as backup in case the # VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or # removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `size` # @return [Google::Apis::DfareportingV2_8::Size] attr_accessor :size # Whether the asset is SSL-compliant. This is a read-only field. Applicable to # all but the following creative types: all REDIRECT and TRACKING_TEXT. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Initial wait time type before making the asset visible. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `startTimeType` # @return [String] attr_accessor :start_time_type # Streaming URL for video asset. This is a read-only field. Applicable to the # following creative types: INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `streamingServingUrl` # @return [String] attr_accessor :streaming_serving_url # Whether the asset is transparent. Applicable to the following creative types: # all RICH_MEDIA. Additionally, only applicable to HTML5 assets. # Corresponds to the JSON property `transparency` # @return [Boolean] attr_accessor :transparency alias_method :transparency?, :transparency # Whether the asset is vertically locked. This is a read-only field. Applicable # to the following creative types: all RICH_MEDIA. # Corresponds to the JSON property `verticallyLocked` # @return [Boolean] attr_accessor :vertically_locked alias_method :vertically_locked?, :vertically_locked # Detected video duration for video asset. This is a read-only field. Applicable # to the following creative types: INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `videoDuration` # @return [Float] attr_accessor :video_duration # Window mode options for flash assets. Applicable to the following creative # types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, # RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. # Corresponds to the JSON property `windowMode` # @return [String] attr_accessor :window_mode # zIndex value of an asset. Applicable to the following creative types: all # RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT # one of the following types: ASSET_DISPLAY_TYPE_INPAGE or # ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, # inclusive. # Corresponds to the JSON property `zIndex` # @return [Fixnum] attr_accessor :z_index # File name of zip file. This is a read-only field. Applicable to the following # creative types: HTML5_BANNER. # Corresponds to the JSON property `zipFilename` # @return [String] attr_accessor :zip_filename # Size of zip file. This is a read-only field. Applicable to the following # creative types: HTML5_BANNER. # Corresponds to the JSON property `zipFilesize` # @return [String] attr_accessor :zip_filesize def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action_script3 = args[:action_script3] if args.key?(:action_script3) @active = args[:active] if args.key?(:active) @alignment = args[:alignment] if args.key?(:alignment) @artwork_type = args[:artwork_type] if args.key?(:artwork_type) @asset_identifier = args[:asset_identifier] if args.key?(:asset_identifier) @backup_image_exit = args[:backup_image_exit] if args.key?(:backup_image_exit) @bit_rate = args[:bit_rate] if args.key?(:bit_rate) @child_asset_type = args[:child_asset_type] if args.key?(:child_asset_type) @collapsed_size = args[:collapsed_size] if args.key?(:collapsed_size) @companion_creative_ids = args[:companion_creative_ids] if args.key?(:companion_creative_ids) @custom_start_time_value = args[:custom_start_time_value] if args.key?(:custom_start_time_value) @detected_features = args[:detected_features] if args.key?(:detected_features) @display_type = args[:display_type] if args.key?(:display_type) @duration = args[:duration] if args.key?(:duration) @duration_type = args[:duration_type] if args.key?(:duration_type) @expanded_dimension = args[:expanded_dimension] if args.key?(:expanded_dimension) @file_size = args[:file_size] if args.key?(:file_size) @flash_version = args[:flash_version] if args.key?(:flash_version) @hide_flash_objects = args[:hide_flash_objects] if args.key?(:hide_flash_objects) @hide_selection_boxes = args[:hide_selection_boxes] if args.key?(:hide_selection_boxes) @horizontally_locked = args[:horizontally_locked] if args.key?(:horizontally_locked) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @mime_type = args[:mime_type] if args.key?(:mime_type) @offset = args[:offset] if args.key?(:offset) @original_backup = args[:original_backup] if args.key?(:original_backup) @position = args[:position] if args.key?(:position) @position_left_unit = args[:position_left_unit] if args.key?(:position_left_unit) @position_top_unit = args[:position_top_unit] if args.key?(:position_top_unit) @progressive_serving_url = args[:progressive_serving_url] if args.key?(:progressive_serving_url) @pushdown = args[:pushdown] if args.key?(:pushdown) @pushdown_duration = args[:pushdown_duration] if args.key?(:pushdown_duration) @role = args[:role] if args.key?(:role) @size = args[:size] if args.key?(:size) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @start_time_type = args[:start_time_type] if args.key?(:start_time_type) @streaming_serving_url = args[:streaming_serving_url] if args.key?(:streaming_serving_url) @transparency = args[:transparency] if args.key?(:transparency) @vertically_locked = args[:vertically_locked] if args.key?(:vertically_locked) @video_duration = args[:video_duration] if args.key?(:video_duration) @window_mode = args[:window_mode] if args.key?(:window_mode) @z_index = args[:z_index] if args.key?(:z_index) @zip_filename = args[:zip_filename] if args.key?(:zip_filename) @zip_filesize = args[:zip_filesize] if args.key?(:zip_filesize) end end # Creative Asset ID. class CreativeAssetId include Google::Apis::Core::Hashable # Name of the creative asset. This is a required field while inserting an asset. # After insertion, this assetIdentifier is used to identify the uploaded asset. # Characters in the name must be alphanumeric or one of the following: ".-_ ". # Spaces are allowed. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Type of asset to upload. This is a required field. FLASH and IMAGE are no # longer supported for new uploads. All image assets should use HTML_IMAGE. # 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 # CreativeAssets contains properties of a creative asset file which will be # uploaded or has already been uploaded. Refer to the creative sample code for # how to upload assets and insert a creative. class CreativeAssetMetadata include Google::Apis::Core::Hashable # Creative Asset ID. # Corresponds to the JSON property `assetIdentifier` # @return [Google::Apis::DfareportingV2_8::CreativeAssetId] attr_accessor :asset_identifier # List of detected click tags for assets. This is a read-only auto-generated # field. # Corresponds to the JSON property `clickTags` # @return [Array] attr_accessor :click_tags # List of feature dependencies for the creative asset that are detected by DCM. # Feature dependencies are features that a browser must be able to support in # order to render your HTML5 creative correctly. This is a read-only, auto- # generated field. # Corresponds to the JSON property `detectedFeatures` # @return [Array] attr_accessor :detected_features # Numeric ID of the asset. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeAssetMetadata". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Rules validated during code generation that generated a warning. This is a # read-only, auto-generated field. # Possible values are: # - "ADMOB_REFERENCED" # - "ASSET_FORMAT_UNSUPPORTED_DCM" # - "ASSET_INVALID" # - "CLICK_TAG_HARD_CODED" # - "CLICK_TAG_INVALID" # - "CLICK_TAG_IN_GWD" # - "CLICK_TAG_MISSING" # - "CLICK_TAG_MORE_THAN_ONE" # - "CLICK_TAG_NON_TOP_LEVEL" # - "COMPONENT_UNSUPPORTED_DCM" # - "ENABLER_UNSUPPORTED_METHOD_DCM" # - "EXTERNAL_FILE_REFERENCED" # - "FILE_DETAIL_EMPTY" # - "FILE_TYPE_INVALID" # - "GWD_PROPERTIES_INVALID" # - "HTML5_FEATURE_UNSUPPORTED" # - "LINKED_FILE_NOT_FOUND" # - "MAX_FLASH_VERSION_11" # - "MRAID_REFERENCED" # - "NOT_SSL_COMPLIANT" # - "ORPHANED_ASSET" # - "PRIMARY_HTML_MISSING" # - "SVG_INVALID" # - "ZIP_INVALID" # Corresponds to the JSON property `warnedValidationRules` # @return [Array] attr_accessor :warned_validation_rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @asset_identifier = args[:asset_identifier] if args.key?(:asset_identifier) @click_tags = args[:click_tags] if args.key?(:click_tags) @detected_features = args[:detected_features] if args.key?(:detected_features) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @warned_validation_rules = args[:warned_validation_rules] if args.key?(:warned_validation_rules) end end # Encapsulates the list of rules for asset selection and a default asset in case # none of the rules match. Applicable to INSTREAM_VIDEO creatives. class CreativeAssetSelection include Google::Apis::Core::Hashable # A creativeAssets[].id. This should refer to one of the parent assets in this # creative, and will be served if none of the rules match. This is a required # field. # Corresponds to the JSON property `defaultAssetId` # @return [Fixnum] attr_accessor :default_asset_id # Rules determine which asset will be served to a viewer. Rules will be # evaluated in the order in which they are stored in this list. This list must # contain at least one rule. Applicable to INSTREAM_VIDEO creatives. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_asset_id = args[:default_asset_id] if args.key?(:default_asset_id) @rules = args[:rules] if args.key?(:rules) end end # Creative Assignment. class CreativeAssignment include Google::Apis::Core::Hashable # Whether this creative assignment is active. When true, the creative will be # included in the ad's rotation. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Whether applicable event tags should fire when this creative assignment is # rendered. If this value is unset when the ad is inserted or updated, it will # default to true for all creative types EXCEPT for INTERNAL_REDIRECT, # INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. # Corresponds to the JSON property `applyEventTags` # @return [Boolean] attr_accessor :apply_event_tags alias_method :apply_event_tags?, :apply_event_tags # Click-through URL # Corresponds to the JSON property `clickThroughUrl` # @return [Google::Apis::DfareportingV2_8::ClickThroughUrl] attr_accessor :click_through_url # Companion creative overrides for this creative assignment. Applicable to video # ads. # Corresponds to the JSON property `companionCreativeOverrides` # @return [Array] attr_accessor :companion_creative_overrides # Creative group assignments for this creative assignment. Only one assignment # per creative group number is allowed for a maximum of two assignments. # Corresponds to the JSON property `creativeGroupAssignments` # @return [Array] attr_accessor :creative_group_assignments # ID of the creative to be assigned. This is a required field. # Corresponds to the JSON property `creativeId` # @return [Fixnum] attr_accessor :creative_id # Represents a DimensionValue resource. # Corresponds to the JSON property `creativeIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :creative_id_dimension_value # Date and time that the assigned creative should stop serving. Must be later # than the start time. # Corresponds to the JSON property `endTime` # @return [DateTime] attr_accessor :end_time # Rich media exit overrides for this creative assignment. # Applicable when the creative type is any of the following: # - DISPLAY # - RICH_MEDIA_INPAGE # - RICH_MEDIA_INPAGE_FLOATING # - RICH_MEDIA_IM_EXPAND # - RICH_MEDIA_EXPANDING # - RICH_MEDIA_INTERSTITIAL_FLOAT # - RICH_MEDIA_MOBILE_IN_APP # - RICH_MEDIA_MULTI_FLOATING # - RICH_MEDIA_PEEL_DOWN # - VPAID_LINEAR # - VPAID_NON_LINEAR # Corresponds to the JSON property `richMediaExitOverrides` # @return [Array] attr_accessor :rich_media_exit_overrides # Sequence number of the creative assignment, applicable when the rotation type # is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, # inclusive. # Corresponds to the JSON property `sequence` # @return [Fixnum] attr_accessor :sequence # Whether the creative to be assigned is SSL-compliant. This is a read-only # field that is auto-generated when the ad is inserted or updated. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Date and time that the assigned creative should start serving. # Corresponds to the JSON property `startTime` # @return [DateTime] attr_accessor :start_time # Weight of the creative assignment, applicable when the rotation type is # CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. # Corresponds to the JSON property `weight` # @return [Fixnum] attr_accessor :weight def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active = args[:active] if args.key?(:active) @apply_event_tags = args[:apply_event_tags] if args.key?(:apply_event_tags) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @companion_creative_overrides = args[:companion_creative_overrides] if args.key?(:companion_creative_overrides) @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments) @creative_id = args[:creative_id] if args.key?(:creative_id) @creative_id_dimension_value = args[:creative_id_dimension_value] if args.key?(:creative_id_dimension_value) @end_time = args[:end_time] if args.key?(:end_time) @rich_media_exit_overrides = args[:rich_media_exit_overrides] if args.key?(:rich_media_exit_overrides) @sequence = args[:sequence] if args.key?(:sequence) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @start_time = args[:start_time] if args.key?(:start_time) @weight = args[:weight] if args.key?(:weight) end end # Creative Custom Event. class CreativeCustomEvent include Google::Apis::Core::Hashable # Unique ID of this event used by DDM Reporting and Data Transfer. This is a # read-only field. # Corresponds to the JSON property `advertiserCustomEventId` # @return [Fixnum] attr_accessor :advertiser_custom_event_id # User-entered name for the event. # Corresponds to the JSON property `advertiserCustomEventName` # @return [String] attr_accessor :advertiser_custom_event_name # Type of the event. This is a read-only field. # Corresponds to the JSON property `advertiserCustomEventType` # @return [String] attr_accessor :advertiser_custom_event_type # Artwork label column, used to link events in DCM back to events in Studio. # This is a required field and should not be modified after insertion. # Corresponds to the JSON property `artworkLabel` # @return [String] attr_accessor :artwork_label # Artwork type used by the creative.This is a read-only field. # Corresponds to the JSON property `artworkType` # @return [String] attr_accessor :artwork_type # Exit URL of the event. This field is used only for exit events. # Corresponds to the JSON property `exitUrl` # @return [String] attr_accessor :exit_url # ID of this event. This is a required field and should not be modified after # insertion. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Popup Window Properties. # Corresponds to the JSON property `popupWindowProperties` # @return [Google::Apis::DfareportingV2_8::PopupWindowProperties] attr_accessor :popup_window_properties # Target type used by the event. # Corresponds to the JSON property `targetType` # @return [String] attr_accessor :target_type # Video reporting ID, used to differentiate multiple videos in a single creative. # This is a read-only field. # Corresponds to the JSON property `videoReportingId` # @return [String] attr_accessor :video_reporting_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @advertiser_custom_event_id = args[:advertiser_custom_event_id] if args.key?(:advertiser_custom_event_id) @advertiser_custom_event_name = args[:advertiser_custom_event_name] if args.key?(:advertiser_custom_event_name) @advertiser_custom_event_type = args[:advertiser_custom_event_type] if args.key?(:advertiser_custom_event_type) @artwork_label = args[:artwork_label] if args.key?(:artwork_label) @artwork_type = args[:artwork_type] if args.key?(:artwork_type) @exit_url = args[:exit_url] if args.key?(:exit_url) @id = args[:id] if args.key?(:id) @popup_window_properties = args[:popup_window_properties] if args.key?(:popup_window_properties) @target_type = args[:target_type] if args.key?(:target_type) @video_reporting_id = args[:video_reporting_id] if args.key?(:video_reporting_id) end end # Contains properties of a creative field. class CreativeField include Google::Apis::Core::Hashable # Account ID of this creative field. This is a read-only field that can be left # blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this creative field. This is a required field on insertion. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # ID of this creative field. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeField". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this creative field. This is a required field and must be less than # 256 characters long and unique among creative fields of the same advertiser. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this creative field. This is a read-only field that can be # left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Creative Field Assignment. class CreativeFieldAssignment include Google::Apis::Core::Hashable # ID of the creative field. # Corresponds to the JSON property `creativeFieldId` # @return [Fixnum] attr_accessor :creative_field_id # ID of the creative field value. # Corresponds to the JSON property `creativeFieldValueId` # @return [Fixnum] attr_accessor :creative_field_value_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creative_field_id = args[:creative_field_id] if args.key?(:creative_field_id) @creative_field_value_id = args[:creative_field_value_id] if args.key?(:creative_field_value_id) end end # Contains properties of a creative field value. class CreativeFieldValue include Google::Apis::Core::Hashable # ID of this creative field value. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeFieldValue". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Value of this creative field value. It needs to be less than 256 characters in # length and unique per creative field. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @value = args[:value] if args.key?(:value) end end # Creative Field Value List Response class CreativeFieldValuesListResponse include Google::Apis::Core::Hashable # Creative field value collection. # Corresponds to the JSON property `creativeFieldValues` # @return [Array] attr_accessor :creative_field_values # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeFieldValuesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @creative_field_values = args[:creative_field_values] if args.key?(:creative_field_values) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Creative Field List Response class CreativeFieldsListResponse include Google::Apis::Core::Hashable # Creative field collection. # Corresponds to the JSON property `creativeFields` # @return [Array] attr_accessor :creative_fields # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeFieldsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @creative_fields = args[:creative_fields] if args.key?(:creative_fields) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Contains properties of a creative group. class CreativeGroup include Google::Apis::Core::Hashable # Account ID of this creative group. This is a read-only field that can be left # blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this creative group. This is a required field on insertion. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Subgroup of the creative group. Assign your creative groups to a subgroup in # order to filter or manage them more easily. This field is required on # insertion and is read-only after insertion. Acceptable values are 1 to 2, # inclusive. # Corresponds to the JSON property `groupNumber` # @return [Fixnum] attr_accessor :group_number # ID of this creative group. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this creative group. This is a required field and must be less than # 256 characters long and unique among creative groups of the same advertiser. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this creative group. This is a read-only field that can be # left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @group_number = args[:group_number] if args.key?(:group_number) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Creative Group Assignment. class CreativeGroupAssignment include Google::Apis::Core::Hashable # ID of the creative group to be assigned. # Corresponds to the JSON property `creativeGroupId` # @return [Fixnum] attr_accessor :creative_group_id # Creative group number of the creative group assignment. # Corresponds to the JSON property `creativeGroupNumber` # @return [String] attr_accessor :creative_group_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creative_group_id = args[:creative_group_id] if args.key?(:creative_group_id) @creative_group_number = args[:creative_group_number] if args.key?(:creative_group_number) end end # Creative Group List Response class CreativeGroupsListResponse include Google::Apis::Core::Hashable # Creative group collection. # Corresponds to the JSON property `creativeGroups` # @return [Array] attr_accessor :creative_groups # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeGroupsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @creative_groups = args[:creative_groups] if args.key?(:creative_groups) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Creative optimization settings. class CreativeOptimizationConfiguration include Google::Apis::Core::Hashable # ID of this creative optimization config. This field is auto-generated when the # campaign is inserted or updated. It can be null for existing campaigns. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Name of this creative optimization config. This is a required field and must # be less than 129 characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # List of optimization activities associated with this configuration. # Corresponds to the JSON property `optimizationActivitys` # @return [Array] attr_accessor :optimization_activitys # Optimization model for this configuration. # Corresponds to the JSON property `optimizationModel` # @return [String] attr_accessor :optimization_model def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @optimization_activitys = args[:optimization_activitys] if args.key?(:optimization_activitys) @optimization_model = args[:optimization_model] if args.key?(:optimization_model) end end # Creative Rotation. class CreativeRotation include Google::Apis::Core::Hashable # Creative assignments in this creative rotation. # Corresponds to the JSON property `creativeAssignments` # @return [Array] attr_accessor :creative_assignments # Creative optimization configuration that is used by this ad. It should refer # to one of the existing optimization configurations in the ad's campaign. If it # is unset or set to 0, then the campaign's default optimization configuration # will be used for this ad. # Corresponds to the JSON property `creativeOptimizationConfigurationId` # @return [Fixnum] attr_accessor :creative_optimization_configuration_id # Type of creative rotation. Can be used to specify whether to use sequential or # random rotation. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. # Corresponds to the JSON property `weightCalculationStrategy` # @return [String] attr_accessor :weight_calculation_strategy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creative_assignments = args[:creative_assignments] if args.key?(:creative_assignments) @creative_optimization_configuration_id = args[:creative_optimization_configuration_id] if args.key?(:creative_optimization_configuration_id) @type = args[:type] if args.key?(:type) @weight_calculation_strategy = args[:weight_calculation_strategy] if args.key?(:weight_calculation_strategy) end end # Creative Settings class CreativeSettings include Google::Apis::Core::Hashable # Header text for iFrames for this site. Must be less than or equal to 2000 # characters long. # Corresponds to the JSON property `iFrameFooter` # @return [String] attr_accessor :i_frame_footer # Header text for iFrames for this site. Must be less than or equal to 2000 # characters long. # Corresponds to the JSON property `iFrameHeader` # @return [String] attr_accessor :i_frame_header def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @i_frame_footer = args[:i_frame_footer] if args.key?(:i_frame_footer) @i_frame_header = args[:i_frame_header] if args.key?(:i_frame_header) end end # Creative List Response class CreativesListResponse include Google::Apis::Core::Hashable # Creative collection. # Corresponds to the JSON property `creatives` # @return [Array] attr_accessor :creatives # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Represents fields that are compatible to be selected for a report of type " # CROSS_DIMENSION_REACH". class CrossDimensionReachReportCompatibleFields include Google::Apis::Core::Hashable # Dimensions which are compatible to be selected in the "breakdown" section of # the report. # Corresponds to the JSON property `breakdown` # @return [Array] attr_accessor :breakdown # Dimensions which are compatible to be selected in the "dimensionFilters" # section of the report. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # The kind of resource this is, in this case dfareporting# # crossDimensionReachReportCompatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metrics which are compatible to be selected in the "metricNames" section of # the report. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Metrics which are compatible to be selected in the "overlapMetricNames" # section of the report. # Corresponds to the JSON property `overlapMetrics` # @return [Array] attr_accessor :overlap_metrics def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @breakdown = args[:breakdown] if args.key?(:breakdown) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) @overlap_metrics = args[:overlap_metrics] if args.key?(:overlap_metrics) end end # A custom floodlight variable. class CustomFloodlightVariable include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#customFloodlightVariable". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The type of custom floodlight variable to supply a value for. These map to the # "u[1-20]=" in the tags. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The value of the custom floodlight variable. The length of string must not # exceed 50 characters. # 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) @kind = args[:kind] if args.key?(:kind) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end # Represents a Custom Rich Media Events group. class CustomRichMediaEvents include Google::Apis::Core::Hashable # List of custom rich media event IDs. Dimension values must be all of type dfa: # richMediaEventTypeIdAndName. # Corresponds to the JSON property `filteredEventIds` # @return [Array] attr_accessor :filtered_event_ids # The kind of resource this is, in this case dfareporting#customRichMediaEvents. # 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) @filtered_event_ids = args[:filtered_event_ids] if args.key?(:filtered_event_ids) @kind = args[:kind] if args.key?(:kind) end end # Represents a date range. class DateRange include Google::Apis::Core::Hashable # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" # . # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # The kind of resource this is, in this case dfareporting#dateRange. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The date range relative to the date of when the report is run. # Corresponds to the JSON property `relativeDateRange` # @return [String] attr_accessor :relative_date_range # The start date of the date range, inclusive. A string of the format: "yyyy-MM- # dd". # Corresponds to the JSON property `startDate` # @return [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) @kind = args[:kind] if args.key?(:kind) @relative_date_range = args[:relative_date_range] if args.key?(:relative_date_range) @start_date = args[:start_date] if args.key?(:start_date) end end # Day Part Targeting. class DayPartTargeting include Google::Apis::Core::Hashable # Days of the week when the ad will serve. # Acceptable values are: # - "SUNDAY" # - "MONDAY" # - "TUESDAY" # - "WEDNESDAY" # - "THURSDAY" # - "FRIDAY" # - "SATURDAY" # Corresponds to the JSON property `daysOfWeek` # @return [Array] attr_accessor :days_of_week # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is # 11 PM to midnight. Can be specified with days of week, in which case the ad # would serve during these hours on the specified days. For example if Monday, # Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, # 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays # at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. # Corresponds to the JSON property `hoursOfDay` # @return [Array] attr_accessor :hours_of_day # Whether or not to use the user's local time. If false, the America/New York # time zone applies. # Corresponds to the JSON property `userLocalTime` # @return [Boolean] attr_accessor :user_local_time alias_method :user_local_time?, :user_local_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @days_of_week = args[:days_of_week] if args.key?(:days_of_week) @hours_of_day = args[:hours_of_day] if args.key?(:hours_of_day) @user_local_time = args[:user_local_time] if args.key?(:user_local_time) end end # Properties of inheriting and overriding the default click-through event tag. A # campaign may override the event tag defined at the advertiser level, and an ad # may also override the campaign's setting further. class DefaultClickThroughEventTagProperties include Google::Apis::Core::Hashable # ID of the click-through event tag to apply to all ads in this entity's scope. # Corresponds to the JSON property `defaultClickThroughEventTagId` # @return [Fixnum] attr_accessor :default_click_through_event_tag_id # Whether this entity should override the inherited default click-through event # tag with its own defined value. # Corresponds to the JSON property `overrideInheritedEventTag` # @return [Boolean] attr_accessor :override_inherited_event_tag alias_method :override_inherited_event_tag?, :override_inherited_event_tag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_click_through_event_tag_id = args[:default_click_through_event_tag_id] if args.key?(:default_click_through_event_tag_id) @override_inherited_event_tag = args[:override_inherited_event_tag] if args.key?(:override_inherited_event_tag) end end # Delivery Schedule. class DeliverySchedule include Google::Apis::Core::Hashable # Frequency Cap. # Corresponds to the JSON property `frequencyCap` # @return [Google::Apis::DfareportingV2_8::FrequencyCap] attr_accessor :frequency_cap # Whether or not hard cutoff is enabled. If true, the ad will not serve after # the end date and time. Otherwise the ad will continue to be served until it # has reached its delivery goals. # Corresponds to the JSON property `hardCutoff` # @return [Boolean] attr_accessor :hard_cutoff alias_method :hard_cutoff?, :hard_cutoff # Impression ratio for this ad. This ratio determines how often each ad is # served relative to the others. For example, if ad A has an impression ratio of # 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times # as often as ad A. Acceptable values are 1 to 10, inclusive. # Corresponds to the JSON property `impressionRatio` # @return [Fixnum] attr_accessor :impression_ratio # Serving priority of an ad, with respect to other ads. The lower the priority # number, the greater the priority with which it is served. # Corresponds to the JSON property `priority` # @return [String] attr_accessor :priority def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @frequency_cap = args[:frequency_cap] if args.key?(:frequency_cap) @hard_cutoff = args[:hard_cutoff] if args.key?(:hard_cutoff) @impression_ratio = args[:impression_ratio] if args.key?(:impression_ratio) @priority = args[:priority] if args.key?(:priority) end end # DFP Settings class DfpSettings include Google::Apis::Core::Hashable # DFP network code for this directory site. # Corresponds to the JSON property `dfpNetworkCode` # @return [String] attr_accessor :dfp_network_code # DFP network name for this directory site. # Corresponds to the JSON property `dfpNetworkName` # @return [String] attr_accessor :dfp_network_name # Whether this directory site accepts programmatic placements. # Corresponds to the JSON property `programmaticPlacementAccepted` # @return [Boolean] attr_accessor :programmatic_placement_accepted alias_method :programmatic_placement_accepted?, :programmatic_placement_accepted # Whether this directory site accepts publisher-paid tags. # Corresponds to the JSON property `pubPaidPlacementAccepted` # @return [Boolean] attr_accessor :pub_paid_placement_accepted alias_method :pub_paid_placement_accepted?, :pub_paid_placement_accepted # Whether this directory site is available only via DoubleClick Publisher Portal. # Corresponds to the JSON property `publisherPortalOnly` # @return [Boolean] attr_accessor :publisher_portal_only alias_method :publisher_portal_only?, :publisher_portal_only def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dfp_network_code = args[:dfp_network_code] if args.key?(:dfp_network_code) @dfp_network_name = args[:dfp_network_name] if args.key?(:dfp_network_name) @programmatic_placement_accepted = args[:programmatic_placement_accepted] if args.key?(:programmatic_placement_accepted) @pub_paid_placement_accepted = args[:pub_paid_placement_accepted] if args.key?(:pub_paid_placement_accepted) @publisher_portal_only = args[:publisher_portal_only] if args.key?(:publisher_portal_only) end end # Represents a dimension. class Dimension include Google::Apis::Core::Hashable # The kind of resource this is, in this case dfareporting#dimension. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The dimension name, e.g. dfa:advertiser # 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) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Represents a dimension filter. class DimensionFilter include Google::Apis::Core::Hashable # The name of the dimension to filter. # Corresponds to the JSON property `dimensionName` # @return [String] attr_accessor :dimension_name # The kind of resource this is, in this case dfareporting#dimensionFilter. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The value of the dimension to filter. # 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) @dimension_name = args[:dimension_name] if args.key?(:dimension_name) @kind = args[:kind] if args.key?(:kind) @value = args[:value] if args.key?(:value) end end # Represents a DimensionValue resource. class DimensionValue include Google::Apis::Core::Hashable # The name of the dimension. # Corresponds to the JSON property `dimensionName` # @return [String] attr_accessor :dimension_name # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID associated with the value if available. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of resource this is, in this case dfareporting#dimensionValue. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Determines how the 'value' field is matched when filtering. If not specified, # defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a # placeholder for variable length character sequences, and it can be escaped # with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow # a matchType other than EXACT. # Corresponds to the JSON property `matchType` # @return [String] attr_accessor :match_type # The value of the dimension. # 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) @dimension_name = args[:dimension_name] if args.key?(:dimension_name) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @match_type = args[:match_type] if args.key?(:match_type) @value = args[:value] if args.key?(:value) end end # Represents the list of DimensionValue resources. class DimensionValueList include Google::Apis::Core::Hashable # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The dimension values returned in this response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of list this is, in this case dfareporting#dimensionValueList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through dimension values. To retrieve the next # page of results, set the next request's "pageToken" to the value of this field. # The page token is only valid for a limited amount of time and should not be # persisted. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # Represents a DimensionValuesRequest. class DimensionValueRequest include Google::Apis::Core::Hashable # The name of the dimension for which values should be requested. # Corresponds to the JSON property `dimensionName` # @return [String] attr_accessor :dimension_name # The end date of the date range for which to retrieve dimension values. A # string of the format "yyyy-MM-dd". # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # The list of filters by which to filter values. The filters are ANDed. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters # The kind of request this is, in this case dfareporting#dimensionValueRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The start date of the date range for which to retrieve dimension values. A # string of the format "yyyy-MM-dd". # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimension_name = args[:dimension_name] if args.key?(:dimension_name) @end_date = args[:end_date] if args.key?(:end_date) @filters = args[:filters] if args.key?(:filters) @kind = args[:kind] if args.key?(:kind) @start_date = args[:start_date] if args.key?(:start_date) end end # DirectorySites contains properties of a website from the Site Directory. Sites # need to be added to an account via the Sites resource before they can be # assigned to a placement. class DirectorySite include Google::Apis::Core::Hashable # Whether this directory site is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Directory site contacts. # Corresponds to the JSON property `contactAssignments` # @return [Array] attr_accessor :contact_assignments # Country ID of this directory site. This is a read-only field. # Corresponds to the JSON property `countryId` # @return [Fixnum] attr_accessor :country_id # Currency ID of this directory site. This is a read-only field. # Possible values are: # - "1" for USD # - "2" for GBP # - "3" for ESP # - "4" for SEK # - "5" for CAD # - "6" for JPY # - "7" for DEM # - "8" for AUD # - "9" for FRF # - "10" for ITL # - "11" for DKK # - "12" for NOK # - "13" for FIM # - "14" for ZAR # - "15" for IEP # - "16" for NLG # - "17" for EUR # - "18" for KRW # - "19" for TWD # - "20" for SGD # - "21" for CNY # - "22" for HKD # - "23" for NZD # - "24" for MYR # - "25" for BRL # - "26" for PTE # - "27" for MXP # - "28" for CLP # - "29" for TRY # - "30" for ARS # - "31" for PEN # - "32" for ILS # - "33" for CHF # - "34" for VEF # - "35" for COP # - "36" for GTQ # - "37" for PLN # - "39" for INR # - "40" for THB # - "41" for IDR # - "42" for CZK # - "43" for RON # - "44" for HUF # - "45" for RUB # - "46" for AED # - "47" for BGN # - "48" for HRK # - "49" for MXN # - "50" for NGN # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id # Description of this directory site. This is a read-only field. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # ID of this directory site. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Tag types for regular placements. # Acceptable values are: # - "STANDARD" # - "IFRAME_JAVASCRIPT_INPAGE" # - "INTERNAL_REDIRECT_INPAGE" # - "JAVASCRIPT_INPAGE" # Corresponds to the JSON property `inpageTagFormats` # @return [Array] attr_accessor :inpage_tag_formats # Tag types for interstitial placements. # Acceptable values are: # - "IFRAME_JAVASCRIPT_INTERSTITIAL" # - "INTERNAL_REDIRECT_INTERSTITIAL" # - "JAVASCRIPT_INTERSTITIAL" # Corresponds to the JSON property `interstitialTagFormats` # @return [Array] attr_accessor :interstitial_tag_formats # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#directorySite". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this directory site. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parent directory site ID. # Corresponds to the JSON property `parentId` # @return [Fixnum] attr_accessor :parent_id # Directory Site Settings # Corresponds to the JSON property `settings` # @return [Google::Apis::DfareportingV2_8::DirectorySiteSettings] attr_accessor :settings # URL of this directory site. # 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) @active = args[:active] if args.key?(:active) @contact_assignments = args[:contact_assignments] if args.key?(:contact_assignments) @country_id = args[:country_id] if args.key?(:country_id) @currency_id = args[:currency_id] if args.key?(:currency_id) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @inpage_tag_formats = args[:inpage_tag_formats] if args.key?(:inpage_tag_formats) @interstitial_tag_formats = args[:interstitial_tag_formats] if args.key?(:interstitial_tag_formats) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @parent_id = args[:parent_id] if args.key?(:parent_id) @settings = args[:settings] if args.key?(:settings) @url = args[:url] if args.key?(:url) end end # Contains properties of a Site Directory contact. class DirectorySiteContact include Google::Apis::Core::Hashable # Address of this directory site contact. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Email address of this directory site contact. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # First name of this directory site contact. # Corresponds to the JSON property `firstName` # @return [String] attr_accessor :first_name # ID of this directory site contact. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#directorySiteContact". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Last name of this directory site contact. # Corresponds to the JSON property `lastName` # @return [String] attr_accessor :last_name # Phone number of this directory site contact. # Corresponds to the JSON property `phone` # @return [String] attr_accessor :phone # Directory site contact role. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role # Title or designation of this directory site contact. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Directory site contact 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) @address = args[:address] if args.key?(:address) @email = args[:email] if args.key?(:email) @first_name = args[:first_name] if args.key?(:first_name) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_name = args[:last_name] if args.key?(:last_name) @phone = args[:phone] if args.key?(:phone) @role = args[:role] if args.key?(:role) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) end end # Directory Site Contact Assignment class DirectorySiteContactAssignment include Google::Apis::Core::Hashable # ID of this directory site contact. This is a read-only, auto-generated field. # Corresponds to the JSON property `contactId` # @return [Fixnum] attr_accessor :contact_id # Visibility of this directory site contact assignment. When set to PUBLIC this # contact assignment is visible to all account and agency users; when set to # PRIVATE it is visible only to the site. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contact_id = args[:contact_id] if args.key?(:contact_id) @visibility = args[:visibility] if args.key?(:visibility) end end # Directory Site Contact List Response class DirectorySiteContactsListResponse include Google::Apis::Core::Hashable # Directory site contact collection # Corresponds to the JSON property `directorySiteContacts` # @return [Array] attr_accessor :directory_site_contacts # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#directorySiteContactsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @directory_site_contacts = args[:directory_site_contacts] if args.key?(:directory_site_contacts) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Directory Site Settings class DirectorySiteSettings include Google::Apis::Core::Hashable # Whether this directory site has disabled active view creatives. # Corresponds to the JSON property `activeViewOptOut` # @return [Boolean] attr_accessor :active_view_opt_out alias_method :active_view_opt_out?, :active_view_opt_out # DFP Settings # Corresponds to the JSON property `dfpSettings` # @return [Google::Apis::DfareportingV2_8::DfpSettings] attr_accessor :dfp_settings # Whether this site accepts in-stream video ads. # Corresponds to the JSON property `instreamVideoPlacementAccepted` # @return [Boolean] attr_accessor :instream_video_placement_accepted alias_method :instream_video_placement_accepted?, :instream_video_placement_accepted # Whether this site accepts interstitial ads. # Corresponds to the JSON property `interstitialPlacementAccepted` # @return [Boolean] attr_accessor :interstitial_placement_accepted alias_method :interstitial_placement_accepted?, :interstitial_placement_accepted # Whether this directory site has disabled Nielsen OCR reach ratings. # Corresponds to the JSON property `nielsenOcrOptOut` # @return [Boolean] attr_accessor :nielsen_ocr_opt_out alias_method :nielsen_ocr_opt_out?, :nielsen_ocr_opt_out # Whether this directory site has disabled generation of Verification ins tags. # Corresponds to the JSON property `verificationTagOptOut` # @return [Boolean] attr_accessor :verification_tag_opt_out alias_method :verification_tag_opt_out?, :verification_tag_opt_out # Whether this directory site has disabled active view for in-stream video # creatives. This is a read-only field. # Corresponds to the JSON property `videoActiveViewOptOut` # @return [Boolean] attr_accessor :video_active_view_opt_out alias_method :video_active_view_opt_out?, :video_active_view_opt_out def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) @dfp_settings = args[:dfp_settings] if args.key?(:dfp_settings) @instream_video_placement_accepted = args[:instream_video_placement_accepted] if args.key?(:instream_video_placement_accepted) @interstitial_placement_accepted = args[:interstitial_placement_accepted] if args.key?(:interstitial_placement_accepted) @nielsen_ocr_opt_out = args[:nielsen_ocr_opt_out] if args.key?(:nielsen_ocr_opt_out) @verification_tag_opt_out = args[:verification_tag_opt_out] if args.key?(:verification_tag_opt_out) @video_active_view_opt_out = args[:video_active_view_opt_out] if args.key?(:video_active_view_opt_out) end end # Directory Site List Response class DirectorySitesListResponse include Google::Apis::Core::Hashable # Directory site collection. # Corresponds to the JSON property `directorySites` # @return [Array] attr_accessor :directory_sites # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#directorySitesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @directory_sites = args[:directory_sites] if args.key?(:directory_sites) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Contains properties of a dynamic targeting key. Dynamic targeting keys are # unique, user-friendly labels, created at the advertiser level in DCM, that can # be assigned to ads, creatives, and placements and used for targeting with # DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM # IDs (such as placement IDs) to save time and avoid errors in your dynamic # feeds. class DynamicTargetingKey include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#dynamicTargetingKey". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this dynamic targeting key. This is a required field. Must be less # than 256 characters long and cannot contain commas. All characters are # converted to lowercase. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # ID of the object of this dynamic targeting key. This is a required field. # Corresponds to the JSON property `objectId` # @return [Fixnum] attr_accessor :object_id_prop # Type of the object of this dynamic targeting key. This is a required field. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @object_type = args[:object_type] if args.key?(:object_type) end end # Dynamic Targeting Key List Response class DynamicTargetingKeysListResponse include Google::Apis::Core::Hashable # Dynamic targeting key collection. # Corresponds to the JSON property `dynamicTargetingKeys` # @return [Array] attr_accessor :dynamic_targeting_keys # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#dynamicTargetingKeysListResponse". # 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) @dynamic_targeting_keys = args[:dynamic_targeting_keys] if args.key?(:dynamic_targeting_keys) @kind = args[:kind] if args.key?(:kind) end end # A description of how user IDs are encrypted. class EncryptionInfo include Google::Apis::Core::Hashable # The encryption entity ID. This should match the encryption configuration for # ad serving or Data Transfer. # Corresponds to the JSON property `encryptionEntityId` # @return [Fixnum] attr_accessor :encryption_entity_id # The encryption entity type. This should match the encryption configuration for # ad serving or Data Transfer. # Corresponds to the JSON property `encryptionEntityType` # @return [String] attr_accessor :encryption_entity_type # Describes whether the encrypted cookie was received from ad serving (the %m # macro) or from Data Transfer. # Corresponds to the JSON property `encryptionSource` # @return [String] attr_accessor :encryption_source # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#encryptionInfo". # 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) @encryption_entity_id = args[:encryption_entity_id] if args.key?(:encryption_entity_id) @encryption_entity_type = args[:encryption_entity_type] if args.key?(:encryption_entity_type) @encryption_source = args[:encryption_source] if args.key?(:encryption_source) @kind = args[:kind] if args.key?(:kind) end end # Contains properties of an event tag. class EventTag include Google::Apis::Core::Hashable # Account ID of this event tag. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this event tag. This field or the campaignId field is # required on insertion. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Campaign ID of this event tag. This field or the advertiserId field is # required on insertion. # Corresponds to the JSON property `campaignId` # @return [Fixnum] attr_accessor :campaign_id # Represents a DimensionValue resource. # Corresponds to the JSON property `campaignIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :campaign_id_dimension_value # Whether this event tag should be automatically enabled for all of the # advertiser's campaigns and ads. # Corresponds to the JSON property `enabledByDefault` # @return [Boolean] attr_accessor :enabled_by_default alias_method :enabled_by_default?, :enabled_by_default # Whether to remove this event tag from ads that are trafficked through # DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag # uses a pixel that is unapproved for Ad Exchange bids on one or more networks, # such as the Google Display Network. # Corresponds to the JSON property `excludeFromAdxRequests` # @return [Boolean] attr_accessor :exclude_from_adx_requests alias_method :exclude_from_adx_requests?, :exclude_from_adx_requests # ID of this event tag. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#eventTag". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this event tag. This is a required field and must be less than 256 # characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Site filter type for this event tag. If no type is specified then the event # tag will be applied to all sites. # Corresponds to the JSON property `siteFilterType` # @return [String] attr_accessor :site_filter_type # Filter list of site IDs associated with this event tag. The siteFilterType # determines whether this is a whitelist or blacklist filter. # Corresponds to the JSON property `siteIds` # @return [Array] attr_accessor :site_ids # Whether this tag is SSL-compliant or not. This is a read-only field. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Status of this event tag. Must be ENABLED for this event tag to fire. This is # a required field. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Subaccount ID of this event tag. This is a read-only field that can be left # blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Event tag type. Can be used to specify whether to use a third-party pixel, a # third-party JavaScript URL, or a third-party click-through URL for either # impression or click tracking. This is a required field. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Payload URL for this event tag. The URL on a click-through event tag should # have a landing page URL appended to the end of it. This field is required on # insertion. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Number of times the landing page URL should be URL-escaped before being # appended to the click-through event tag URL. Only applies to click-through # event tags as specified by the event tag type. # Corresponds to the JSON property `urlEscapeLevels` # @return [Fixnum] attr_accessor :url_escape_levels def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @campaign_id = args[:campaign_id] if args.key?(:campaign_id) @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) @enabled_by_default = args[:enabled_by_default] if args.key?(:enabled_by_default) @exclude_from_adx_requests = args[:exclude_from_adx_requests] if args.key?(:exclude_from_adx_requests) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @site_filter_type = args[:site_filter_type] if args.key?(:site_filter_type) @site_ids = args[:site_ids] if args.key?(:site_ids) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @status = args[:status] if args.key?(:status) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) @url_escape_levels = args[:url_escape_levels] if args.key?(:url_escape_levels) end end # Event tag override information. class EventTagOverride include Google::Apis::Core::Hashable # Whether this override is enabled. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # ID of this event tag override. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enabled = args[:enabled] if args.key?(:enabled) @id = args[:id] if args.key?(:id) end end # Event Tag List Response class EventTagsListResponse include Google::Apis::Core::Hashable # Event tag collection. # Corresponds to the JSON property `eventTags` # @return [Array] attr_accessor :event_tags # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#eventTagsListResponse". # 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) @event_tags = args[:event_tags] if args.key?(:event_tags) @kind = args[:kind] if args.key?(:kind) end end # Represents a File resource. A file contains the metadata for a report run. It # shows the status of the run and holds the URLs to the generated report data if # the run is finished and the status is "REPORT_AVAILABLE". class File include Google::Apis::Core::Hashable # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV2_8::DateRange] attr_accessor :date_range # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The filename of the file. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name # The output format of the report. Only available once the file is available. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # The unique ID of this report file. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The kind of resource this is, in this case dfareporting#file. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The timestamp in milliseconds since epoch when this file was last modified. # Corresponds to the JSON property `lastModifiedTime` # @return [Fixnum] attr_accessor :last_modified_time # The ID of the report this file was generated from. # Corresponds to the JSON property `reportId` # @return [Fixnum] attr_accessor :report_id # The status of the report file. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The URLs where the completed report file can be downloaded. # Corresponds to the JSON property `urls` # @return [Google::Apis::DfareportingV2_8::File::Urls] attr_accessor :urls def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @date_range = args[:date_range] if args.key?(:date_range) @etag = args[:etag] if args.key?(:etag) @file_name = args[:file_name] if args.key?(:file_name) @format = args[:format] if args.key?(:format) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time) @report_id = args[:report_id] if args.key?(:report_id) @status = args[:status] if args.key?(:status) @urls = args[:urls] if args.key?(:urls) end # The URLs where the completed report file can be downloaded. class Urls include Google::Apis::Core::Hashable # The URL for downloading the report data through the API. # Corresponds to the JSON property `apiUrl` # @return [String] attr_accessor :api_url # The URL for downloading the report data through a browser. # Corresponds to the JSON property `browserUrl` # @return [String] attr_accessor :browser_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @api_url = args[:api_url] if args.key?(:api_url) @browser_url = args[:browser_url] if args.key?(:browser_url) end end end # Represents the list of File resources. class FileList include Google::Apis::Core::Hashable # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The files returned in this response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of list this is, in this case dfareporting#fileList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through files. To retrieve the next page of # results, set the next request's "pageToken" to the value of this field. The # page token is only valid for a limited amount of time and should not be # persisted. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # Flight class Flight include Google::Apis::Core::Hashable # Inventory item flight end date. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # Rate or cost of this flight. # Corresponds to the JSON property `rateOrCost` # @return [Fixnum] attr_accessor :rate_or_cost # Inventory item flight start date. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date # Units of this flight. # 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) @end_date = args[:end_date] if args.key?(:end_date) @rate_or_cost = args[:rate_or_cost] if args.key?(:rate_or_cost) @start_date = args[:start_date] if args.key?(:start_date) @units = args[:units] if args.key?(:units) end end # Floodlight Activity GenerateTag Response class FloodlightActivitiesGenerateTagResponse include Google::Apis::Core::Hashable # Generated tag for this Floodlight activity. For global site tags, this is the # event snippet. # Corresponds to the JSON property `floodlightActivityTag` # @return [String] attr_accessor :floodlight_activity_tag # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightActivitiesGenerateTagResponse". # 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) @floodlight_activity_tag = args[:floodlight_activity_tag] if args.key?(:floodlight_activity_tag) @kind = args[:kind] if args.key?(:kind) end end # Floodlight Activity List Response class FloodlightActivitiesListResponse include Google::Apis::Core::Hashable # Floodlight activity collection. # Corresponds to the JSON property `floodlightActivities` # @return [Array] attr_accessor :floodlight_activities # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightActivitiesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @floodlight_activities = args[:floodlight_activities] if args.key?(:floodlight_activities) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Contains properties of a Floodlight activity. class FloodlightActivity include Google::Apis::Core::Hashable # Account ID of this floodlight activity. This is a read-only field that can be # left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this floodlight activity. If this field is left blank, the # value will be copied over either from the activity group's advertiser or the # existing activity's advertiser. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Code type used for cache busting in the generated tag. Applicable only when # floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING # or UNIQUE_COUNTING. # Corresponds to the JSON property `cacheBustingType` # @return [String] attr_accessor :cache_busting_type # Counting method for conversions for this floodlight activity. This is a # required field. # Corresponds to the JSON property `countingMethod` # @return [String] attr_accessor :counting_method # Dynamic floodlight tags. # Corresponds to the JSON property `defaultTags` # @return [Array] attr_accessor :default_tags # URL where this tag will be deployed. If specified, must be less than 256 # characters long. # Corresponds to the JSON property `expectedUrl` # @return [String] attr_accessor :expected_url # Floodlight activity group ID of this floodlight activity. This is a required # field. # Corresponds to the JSON property `floodlightActivityGroupId` # @return [Fixnum] attr_accessor :floodlight_activity_group_id # Name of the associated floodlight activity group. This is a read-only field. # Corresponds to the JSON property `floodlightActivityGroupName` # @return [String] attr_accessor :floodlight_activity_group_name # Tag string of the associated floodlight activity group. This is a read-only # field. # Corresponds to the JSON property `floodlightActivityGroupTagString` # @return [String] attr_accessor :floodlight_activity_group_tag_string # Type of the associated floodlight activity group. This is a read-only field. # Corresponds to the JSON property `floodlightActivityGroupType` # @return [String] attr_accessor :floodlight_activity_group_type # Floodlight configuration ID of this floodlight activity. If this field is left # blank, the value will be copied over either from the activity group's # floodlight configuration or from the existing activity's floodlight # configuration. # Corresponds to the JSON property `floodlightConfigurationId` # @return [Fixnum] attr_accessor :floodlight_configuration_id # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :floodlight_configuration_id_dimension_value # Whether this activity is archived. # Corresponds to the JSON property `hidden` # @return [Boolean] attr_accessor :hidden alias_method :hidden?, :hidden # ID of this floodlight activity. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Whether the image tag is enabled for this activity. # Corresponds to the JSON property `imageTagEnabled` # @return [Boolean] attr_accessor :image_tag_enabled alias_method :image_tag_enabled?, :image_tag_enabled # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightActivity". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this floodlight activity. This is a required field. Must be less than # 129 characters long and cannot contain quotes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # General notes or implementation instructions for the tag. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # Publisher dynamic floodlight tags. # Corresponds to the JSON property `publisherTags` # @return [Array] attr_accessor :publisher_tags # Whether this tag should use SSL. # Corresponds to the JSON property `secure` # @return [Boolean] attr_accessor :secure alias_method :secure?, :secure # Whether the floodlight activity is SSL-compliant. This is a read-only field, # its value detected by the system from the floodlight tags. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Whether this floodlight activity must be SSL-compliant. # Corresponds to the JSON property `sslRequired` # @return [Boolean] attr_accessor :ssl_required alias_method :ssl_required?, :ssl_required # Subaccount ID of this floodlight activity. This is a read-only field that can # be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Tag format type for the floodlight activity. If left blank, the tag format # will default to HTML. # Corresponds to the JSON property `tagFormat` # @return [String] attr_accessor :tag_format # Value of the cat= parameter in the floodlight tag, which the ad servers use to # identify the activity. This is optional: if empty, a new tag string will be # generated for you. This string must be 1 to 8 characters long, with valid # characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique # among activities of the same activity group. This field is read-only after # insertion. # Corresponds to the JSON property `tagString` # @return [String] attr_accessor :tag_string # List of the user-defined variables used by this conversion tag. These map to # the "u[1-100]=" in the tags. Each of these can have a user defined type. # Acceptable values are U1 to U100, inclusive. # Corresponds to the JSON property `userDefinedVariableTypes` # @return [Array] attr_accessor :user_defined_variable_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @cache_busting_type = args[:cache_busting_type] if args.key?(:cache_busting_type) @counting_method = args[:counting_method] if args.key?(:counting_method) @default_tags = args[:default_tags] if args.key?(:default_tags) @expected_url = args[:expected_url] if args.key?(:expected_url) @floodlight_activity_group_id = args[:floodlight_activity_group_id] if args.key?(:floodlight_activity_group_id) @floodlight_activity_group_name = args[:floodlight_activity_group_name] if args.key?(:floodlight_activity_group_name) @floodlight_activity_group_tag_string = args[:floodlight_activity_group_tag_string] if args.key?(:floodlight_activity_group_tag_string) @floodlight_activity_group_type = args[:floodlight_activity_group_type] if args.key?(:floodlight_activity_group_type) @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) @hidden = args[:hidden] if args.key?(:hidden) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @image_tag_enabled = args[:image_tag_enabled] if args.key?(:image_tag_enabled) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @publisher_tags = args[:publisher_tags] if args.key?(:publisher_tags) @secure = args[:secure] if args.key?(:secure) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @ssl_required = args[:ssl_required] if args.key?(:ssl_required) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @tag_format = args[:tag_format] if args.key?(:tag_format) @tag_string = args[:tag_string] if args.key?(:tag_string) @user_defined_variable_types = args[:user_defined_variable_types] if args.key?(:user_defined_variable_types) end end # Dynamic Tag class FloodlightActivityDynamicTag include Google::Apis::Core::Hashable # ID of this dynamic tag. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Name of this tag. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Tag code. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @tag = args[:tag] if args.key?(:tag) end end # Contains properties of a Floodlight activity group. class FloodlightActivityGroup include Google::Apis::Core::Hashable # Account ID of this floodlight activity group. This is a read-only field that # can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this floodlight activity group. If this field is left blank, # the value will be copied over either from the floodlight configuration's # advertiser or from the existing activity group's advertiser. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Floodlight configuration ID of this floodlight activity group. This is a # required field. # Corresponds to the JSON property `floodlightConfigurationId` # @return [Fixnum] attr_accessor :floodlight_configuration_id # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :floodlight_configuration_id_dimension_value # ID of this floodlight activity group. This is a read-only, auto-generated # field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightActivityGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this floodlight activity group. This is a required field. Must be less # than 65 characters long and cannot contain quotes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this floodlight activity group. This is a read-only field # that can be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Value of the type= parameter in the floodlight tag, which the ad servers use # to identify the activity group that the activity belongs to. This is optional: # if empty, a new tag string will be generated for you. This string must be 1 to # 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This # tag string must also be unique among activity groups of the same floodlight # configuration. This field is read-only after insertion. # Corresponds to the JSON property `tagString` # @return [String] attr_accessor :tag_string # Type of the floodlight activity group. This is a required field that is read- # only after insertion. # 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) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @tag_string = args[:tag_string] if args.key?(:tag_string) @type = args[:type] if args.key?(:type) end end # Floodlight Activity Group List Response class FloodlightActivityGroupsListResponse include Google::Apis::Core::Hashable # Floodlight activity group collection. # Corresponds to the JSON property `floodlightActivityGroups` # @return [Array] attr_accessor :floodlight_activity_groups # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightActivityGroupsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @floodlight_activity_groups = args[:floodlight_activity_groups] if args.key?(:floodlight_activity_groups) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Publisher Dynamic Tag class FloodlightActivityPublisherDynamicTag include Google::Apis::Core::Hashable # Whether this tag is applicable only for click-throughs. # Corresponds to the JSON property `clickThrough` # @return [Boolean] attr_accessor :click_through alias_method :click_through?, :click_through # Directory site ID of this dynamic tag. This is a write-only field that can be # used as an alternative to the siteId field. When this resource is retrieved, # only the siteId field will be populated. # Corresponds to the JSON property `directorySiteId` # @return [Fixnum] attr_accessor :directory_site_id # Dynamic Tag # Corresponds to the JSON property `dynamicTag` # @return [Google::Apis::DfareportingV2_8::FloodlightActivityDynamicTag] attr_accessor :dynamic_tag # Site ID of this dynamic tag. # Corresponds to the JSON property `siteId` # @return [Fixnum] attr_accessor :site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `siteIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :site_id_dimension_value # Whether this tag is applicable only for view-throughs. # Corresponds to the JSON property `viewThrough` # @return [Boolean] attr_accessor :view_through alias_method :view_through?, :view_through def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_through = args[:click_through] if args.key?(:click_through) @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) @dynamic_tag = args[:dynamic_tag] if args.key?(:dynamic_tag) @site_id = args[:site_id] if args.key?(:site_id) @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) @view_through = args[:view_through] if args.key?(:view_through) end end # Contains properties of a Floodlight configuration. class FloodlightConfiguration include Google::Apis::Core::Hashable # Account ID of this floodlight configuration. This is a read-only field that # can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of the parent advertiser of this floodlight configuration. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Whether advertiser data is shared with Google Analytics. # Corresponds to the JSON property `analyticsDataSharingEnabled` # @return [Boolean] attr_accessor :analytics_data_sharing_enabled alias_method :analytics_data_sharing_enabled?, :analytics_data_sharing_enabled # Whether the exposure-to-conversion report is enabled. This report shows # detailed pathway information on up to 10 of the most recent ad exposures seen # by a user before converting. # Corresponds to the JSON property `exposureToConversionEnabled` # @return [Boolean] attr_accessor :exposure_to_conversion_enabled alias_method :exposure_to_conversion_enabled?, :exposure_to_conversion_enabled # Day that will be counted as the first day of the week in reports. This is a # required field. # Corresponds to the JSON property `firstDayOfWeek` # @return [String] attr_accessor :first_day_of_week # ID of this floodlight configuration. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Whether in-app attribution tracking is enabled. # Corresponds to the JSON property `inAppAttributionTrackingEnabled` # @return [Boolean] attr_accessor :in_app_attribution_tracking_enabled alias_method :in_app_attribution_tracking_enabled?, :in_app_attribution_tracking_enabled # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightConfiguration". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Lookback configuration settings. # Corresponds to the JSON property `lookbackConfiguration` # @return [Google::Apis::DfareportingV2_8::LookbackConfiguration] attr_accessor :lookback_configuration # Types of attribution options for natural search conversions. # Corresponds to the JSON property `naturalSearchConversionAttributionOption` # @return [String] attr_accessor :natural_search_conversion_attribution_option # Omniture Integration Settings. # Corresponds to the JSON property `omnitureSettings` # @return [Google::Apis::DfareportingV2_8::OmnitureSettings] attr_accessor :omniture_settings # Subaccount ID of this floodlight configuration. This is a read-only field that # can be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Dynamic and Image Tag Settings. # Corresponds to the JSON property `tagSettings` # @return [Google::Apis::DfareportingV2_8::TagSettings] attr_accessor :tag_settings # List of third-party authentication tokens enabled for this configuration. # Corresponds to the JSON property `thirdPartyAuthenticationTokens` # @return [Array] attr_accessor :third_party_authentication_tokens # List of user defined variables enabled for this configuration. # Corresponds to the JSON property `userDefinedVariableConfigurations` # @return [Array] attr_accessor :user_defined_variable_configurations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @analytics_data_sharing_enabled = args[:analytics_data_sharing_enabled] if args.key?(:analytics_data_sharing_enabled) @exposure_to_conversion_enabled = args[:exposure_to_conversion_enabled] if args.key?(:exposure_to_conversion_enabled) @first_day_of_week = args[:first_day_of_week] if args.key?(:first_day_of_week) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @in_app_attribution_tracking_enabled = args[:in_app_attribution_tracking_enabled] if args.key?(:in_app_attribution_tracking_enabled) @kind = args[:kind] if args.key?(:kind) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @natural_search_conversion_attribution_option = args[:natural_search_conversion_attribution_option] if args.key?(:natural_search_conversion_attribution_option) @omniture_settings = args[:omniture_settings] if args.key?(:omniture_settings) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @tag_settings = args[:tag_settings] if args.key?(:tag_settings) @third_party_authentication_tokens = args[:third_party_authentication_tokens] if args.key?(:third_party_authentication_tokens) @user_defined_variable_configurations = args[:user_defined_variable_configurations] if args.key?(:user_defined_variable_configurations) end end # Floodlight Configuration List Response class FloodlightConfigurationsListResponse include Google::Apis::Core::Hashable # Floodlight configuration collection. # Corresponds to the JSON property `floodlightConfigurations` # @return [Array] attr_accessor :floodlight_configurations # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightConfigurationsListResponse". # 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) @floodlight_configurations = args[:floodlight_configurations] if args.key?(:floodlight_configurations) @kind = args[:kind] if args.key?(:kind) end end # Represents fields that are compatible to be selected for a report of type " # FlOODLIGHT". class FloodlightReportCompatibleFields include Google::Apis::Core::Hashable # Dimensions which are compatible to be selected in the "dimensionFilters" # section of the report. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # Dimensions which are compatible to be selected in the "dimensions" section of # the report. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # The kind of resource this is, in this case dfareporting# # floodlightReportCompatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metrics which are compatible to be selected in the "metricNames" section of # the report. # 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) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) end end # Frequency Cap. class FrequencyCap include Google::Apis::Core::Hashable # Duration of time, in seconds, for this frequency cap. The maximum duration is # 90 days. Acceptable values are 1 to 7776000, inclusive. # Corresponds to the JSON property `duration` # @return [Fixnum] attr_accessor :duration # Number of times an individual user can be served the ad within the specified # duration. Acceptable values are 1 to 15, inclusive. # Corresponds to the JSON property `impressions` # @return [Fixnum] attr_accessor :impressions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @duration = args[:duration] if args.key?(:duration) @impressions = args[:impressions] if args.key?(:impressions) end end # FsCommand. class FsCommand include Google::Apis::Core::Hashable # Distance from the left of the browser.Applicable when positionOption is # DISTANCE_FROM_TOP_LEFT_CORNER. # Corresponds to the JSON property `left` # @return [Fixnum] attr_accessor :left # Position in the browser where the window will open. # Corresponds to the JSON property `positionOption` # @return [String] attr_accessor :position_option # Distance from the top of the browser. Applicable when positionOption is # DISTANCE_FROM_TOP_LEFT_CORNER. # Corresponds to the JSON property `top` # @return [Fixnum] attr_accessor :top # Height of the window. # Corresponds to the JSON property `windowHeight` # @return [Fixnum] attr_accessor :window_height # Width of the window. # Corresponds to the JSON property `windowWidth` # @return [Fixnum] attr_accessor :window_width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @left = args[:left] if args.key?(:left) @position_option = args[:position_option] if args.key?(:position_option) @top = args[:top] if args.key?(:top) @window_height = args[:window_height] if args.key?(:window_height) @window_width = args[:window_width] if args.key?(:window_width) end end # Geographical Targeting. class GeoTargeting include Google::Apis::Core::Hashable # Cities to be targeted. For each city only dartId is required. The other fields # are populated automatically when the ad is inserted or updated. If targeting a # city, do not target or exclude the country of the city, and do not target the # metro or region of the city. # Corresponds to the JSON property `cities` # @return [Array] attr_accessor :cities # Countries to be targeted or excluded from targeting, depending on the setting # of the excludeCountries field. For each country only dartId is required. The # other fields are populated automatically when the ad is inserted or updated. # If targeting or excluding a country, do not target regions, cities, metros, or # postal codes in the same country. # Corresponds to the JSON property `countries` # @return [Array] attr_accessor :countries # Whether or not to exclude the countries in the countries field from targeting. # If false, the countries field refers to countries which will be targeted by # the ad. # Corresponds to the JSON property `excludeCountries` # @return [Boolean] attr_accessor :exclude_countries alias_method :exclude_countries?, :exclude_countries # Metros to be targeted. For each metro only dmaId is required. The other fields # are populated automatically when the ad is inserted or updated. If targeting a # metro, do not target or exclude the country of the metro. # Corresponds to the JSON property `metros` # @return [Array] attr_accessor :metros # Postal codes to be targeted. For each postal code only id is required. The # other fields are populated automatically when the ad is inserted or updated. # If targeting a postal code, do not target or exclude the country of the postal # code. # Corresponds to the JSON property `postalCodes` # @return [Array] attr_accessor :postal_codes # Regions to be targeted. For each region only dartId is required. The other # fields are populated automatically when the ad is inserted or updated. If # targeting a region, do not target or exclude the country of the region. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cities = args[:cities] if args.key?(:cities) @countries = args[:countries] if args.key?(:countries) @exclude_countries = args[:exclude_countries] if args.key?(:exclude_countries) @metros = args[:metros] if args.key?(:metros) @postal_codes = args[:postal_codes] if args.key?(:postal_codes) @regions = args[:regions] if args.key?(:regions) end end # Represents a buy from the DoubleClick Planning inventory store. class InventoryItem include Google::Apis::Core::Hashable # Account ID of this inventory item. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Ad slots of this inventory item. If this inventory item represents a # standalone placement, there will be exactly one ad slot. If this inventory # item represents a placement group, there will be more than one ad slot, each # representing one child placement in that placement group. # Corresponds to the JSON property `adSlots` # @return [Array] attr_accessor :ad_slots # Advertiser ID of this inventory item. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Content category ID of this inventory item. # Corresponds to the JSON property `contentCategoryId` # @return [Fixnum] attr_accessor :content_category_id # Estimated click-through rate of this inventory item. # Corresponds to the JSON property `estimatedClickThroughRate` # @return [Fixnum] attr_accessor :estimated_click_through_rate # Estimated conversion rate of this inventory item. # Corresponds to the JSON property `estimatedConversionRate` # @return [Fixnum] attr_accessor :estimated_conversion_rate # ID of this inventory item. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Whether this inventory item is in plan. # Corresponds to the JSON property `inPlan` # @return [Boolean] attr_accessor :in_plan alias_method :in_plan?, :in_plan # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#inventoryItem". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :last_modified_info # Name of this inventory item. For standalone inventory items, this is the same # name as that of its only ad slot. For group inventory items, this can differ # from the name of any of its ad slots. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Negotiation channel ID of this inventory item. # Corresponds to the JSON property `negotiationChannelId` # @return [Fixnum] attr_accessor :negotiation_channel_id # Order ID of this inventory item. # Corresponds to the JSON property `orderId` # @return [Fixnum] attr_accessor :order_id # Placement strategy ID of this inventory item. # Corresponds to the JSON property `placementStrategyId` # @return [Fixnum] attr_accessor :placement_strategy_id # Pricing Information # Corresponds to the JSON property `pricing` # @return [Google::Apis::DfareportingV2_8::Pricing] attr_accessor :pricing # Project ID of this inventory item. # Corresponds to the JSON property `projectId` # @return [Fixnum] attr_accessor :project_id # RFP ID of this inventory item. # Corresponds to the JSON property `rfpId` # @return [Fixnum] attr_accessor :rfp_id # ID of the site this inventory item is associated with. # Corresponds to the JSON property `siteId` # @return [Fixnum] attr_accessor :site_id # Subaccount ID of this inventory item. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Type of inventory item. # 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) @account_id = args[:account_id] if args.key?(:account_id) @ad_slots = args[:ad_slots] if args.key?(:ad_slots) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @content_category_id = args[:content_category_id] if args.key?(:content_category_id) @estimated_click_through_rate = args[:estimated_click_through_rate] if args.key?(:estimated_click_through_rate) @estimated_conversion_rate = args[:estimated_conversion_rate] if args.key?(:estimated_conversion_rate) @id = args[:id] if args.key?(:id) @in_plan = args[:in_plan] if args.key?(:in_plan) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @name = args[:name] if args.key?(:name) @negotiation_channel_id = args[:negotiation_channel_id] if args.key?(:negotiation_channel_id) @order_id = args[:order_id] if args.key?(:order_id) @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) @pricing = args[:pricing] if args.key?(:pricing) @project_id = args[:project_id] if args.key?(:project_id) @rfp_id = args[:rfp_id] if args.key?(:rfp_id) @site_id = args[:site_id] if args.key?(:site_id) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @type = args[:type] if args.key?(:type) end end # Inventory item List Response class InventoryItemsListResponse include Google::Apis::Core::Hashable # Inventory item collection # Corresponds to the JSON property `inventoryItems` # @return [Array] attr_accessor :inventory_items # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#inventoryItemsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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_items = args[:inventory_items] if args.key?(:inventory_items) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Key Value Targeting Expression. class KeyValueTargetingExpression include Google::Apis::Core::Hashable # Keyword expression being targeted by the ad. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expression = args[:expression] if args.key?(:expression) end end # Contains information about where a user's browser is taken after the user # clicks an ad. class LandingPage include Google::Apis::Core::Hashable # Whether or not this landing page will be assigned to any ads or creatives that # do not have a landing page assigned explicitly. Only one default landing page # is allowed per campaign. # Corresponds to the JSON property `default` # @return [Boolean] attr_accessor :default alias_method :default?, :default # ID of this landing page. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#landingPage". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this landing page. This is a required field. It must be less than 256 # characters long, and must be unique among landing pages of the same campaign. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # URL of this landing page. This is a required field. # 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) @default = args[:default] if args.key?(:default) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @url = args[:url] if args.key?(:url) end end # Landing Page List Response class LandingPagesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#landingPagesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Landing page collection # Corresponds to the JSON property `landingPages` # @return [Array] attr_accessor :landing_pages def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @landing_pages = args[:landing_pages] if args.key?(:landing_pages) end end # Contains information about a language that can be targeted by ads. class Language include Google::Apis::Core::Hashable # Language ID of this language. This is the ID used for targeting and generating # reports. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#language". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Format of language code is an ISO 639 two-letter language code optionally # followed by an underscore followed by an ISO 3166 code. Examples are "en" for # English or "zh_CN" for Simplified Chinese. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Name of this language. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @language_code = args[:language_code] if args.key?(:language_code) @name = args[:name] if args.key?(:name) end end # Language Targeting. class LanguageTargeting include Google::Apis::Core::Hashable # Languages that this ad targets. For each language only languageId is required. # The other fields are populated automatically when the ad is inserted or # updated. # 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) @languages = args[:languages] if args.key?(:languages) end end # Language List Response class LanguagesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#languagesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Language collection. # 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) @kind = args[:kind] if args.key?(:kind) @languages = args[:languages] if args.key?(:languages) end end # Modification timestamp. class LastModifiedInfo include Google::Apis::Core::Hashable # Timestamp of the last change in milliseconds since epoch. # Corresponds to the JSON property `time` # @return [Fixnum] attr_accessor :time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @time = args[:time] if args.key?(:time) end end # A group clause made up of list population terms representing constraints # joined by ORs. class ListPopulationClause include Google::Apis::Core::Hashable # Terms of this list population clause. Each clause is made up of list # population terms representing constraints and are joined by ORs. # Corresponds to the JSON property `terms` # @return [Array] attr_accessor :terms def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @terms = args[:terms] if args.key?(:terms) end end # Remarketing List Population Rule. class ListPopulationRule include Google::Apis::Core::Hashable # Floodlight activity ID associated with this rule. This field can be left blank. # Corresponds to the JSON property `floodlightActivityId` # @return [Fixnum] attr_accessor :floodlight_activity_id # Name of floodlight activity associated with this rule. This is a read-only, # auto-generated field. # Corresponds to the JSON property `floodlightActivityName` # @return [String] attr_accessor :floodlight_activity_name # Clauses that make up this list population rule. Clauses are joined by ANDs, # and the clauses themselves are made up of list population terms which are # joined by ORs. # Corresponds to the JSON property `listPopulationClauses` # @return [Array] attr_accessor :list_population_clauses 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) @floodlight_activity_name = args[:floodlight_activity_name] if args.key?(:floodlight_activity_name) @list_population_clauses = args[:list_population_clauses] if args.key?(:list_population_clauses) end end # Remarketing List Population Rule Term. class ListPopulationTerm include Google::Apis::Core::Hashable # Will be true if the term should check if the user is in the list and false if # the term should check if the user is not in the list. This field is only # relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. # Corresponds to the JSON property `contains` # @return [Boolean] attr_accessor :contains alias_method :contains?, :contains # Whether to negate the comparison result of this term during rule evaluation. # This field is only relevant when type is left unset or set to # CUSTOM_VARIABLE_TERM or REFERRER_TERM. # Corresponds to the JSON property `negation` # @return [Boolean] attr_accessor :negation alias_method :negation?, :negation # Comparison operator of this term. This field is only relevant when type is # left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator # ID of the list in question. This field is only relevant when type is set to # LIST_MEMBERSHIP_TERM. # Corresponds to the JSON property `remarketingListId` # @return [Fixnum] attr_accessor :remarketing_list_id # List population term type determines the applicable fields in this object. If # left unset or set to CUSTOM_VARIABLE_TERM, then variableName, # variableFriendlyName, operator, value, and negation are applicable. If set to # LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If # set to REFERRER_TERM then operator, value, and negation are applicable. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Literal to compare the variable to. This field is only relevant when type is # left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value # Friendly name of this term's variable. This is a read-only, auto-generated # field. This field is only relevant when type is left unset or set to # CUSTOM_VARIABLE_TERM. # Corresponds to the JSON property `variableFriendlyName` # @return [String] attr_accessor :variable_friendly_name # Name of the variable (U1, U2, etc.) being compared in this term. This field is # only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. # Corresponds to the JSON property `variableName` # @return [String] attr_accessor :variable_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contains = args[:contains] if args.key?(:contains) @negation = args[:negation] if args.key?(:negation) @operator = args[:operator] if args.key?(:operator) @remarketing_list_id = args[:remarketing_list_id] if args.key?(:remarketing_list_id) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) @variable_friendly_name = args[:variable_friendly_name] if args.key?(:variable_friendly_name) @variable_name = args[:variable_name] if args.key?(:variable_name) end end # Remarketing List Targeting Expression. class ListTargetingExpression include Google::Apis::Core::Hashable # Expression describing which lists are being targeted by the ad. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expression = args[:expression] if args.key?(:expression) end end # Lookback configuration settings. class LookbackConfiguration include Google::Apis::Core::Hashable # Lookback window, in days, from the last time a given user clicked on one of # your ads. If you enter 0, clicks will not be considered as triggering events # for floodlight tracking. If you leave this field blank, the default value for # your account will be used. Acceptable values are 0 to 90, inclusive. # Corresponds to the JSON property `clickDuration` # @return [Fixnum] attr_accessor :click_duration # Lookback window, in days, from the last time a given user viewed one of your # ads. If you enter 0, impressions will not be considered as triggering events # for floodlight tracking. If you leave this field blank, the default value for # your account will be used. Acceptable values are 0 to 90, inclusive. # Corresponds to the JSON property `postImpressionActivitiesDuration` # @return [Fixnum] attr_accessor :post_impression_activities_duration def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_duration = args[:click_duration] if args.key?(:click_duration) @post_impression_activities_duration = args[:post_impression_activities_duration] if args.key?(:post_impression_activities_duration) end end # Represents a metric. class Metric include Google::Apis::Core::Hashable # The kind of resource this is, in this case dfareporting#metric. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The metric name, e.g. dfa:impressions # 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) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Contains information about a metro region that can be targeted by ads. class Metro include Google::Apis::Core::Hashable # Country code of the country to which this metro region belongs. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of the country to which this metro region belongs. # Corresponds to the JSON property `countryDartId` # @return [Fixnum] attr_accessor :country_dart_id # DART ID of this metro region. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # DMA ID of this metro region. This is the ID used for targeting and generating # reports, and is equivalent to metro_code. # Corresponds to the JSON property `dmaId` # @return [Fixnum] attr_accessor :dma_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#metro". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metro code of this metro region. This is equivalent to dma_id. # Corresponds to the JSON property `metroCode` # @return [String] attr_accessor :metro_code # Name of this metro region. # 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) @country_code = args[:country_code] if args.key?(:country_code) @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) @dart_id = args[:dart_id] if args.key?(:dart_id) @dma_id = args[:dma_id] if args.key?(:dma_id) @kind = args[:kind] if args.key?(:kind) @metro_code = args[:metro_code] if args.key?(:metro_code) @name = args[:name] if args.key?(:name) end end # Metro List Response class MetrosListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#metrosListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metro collection. # Corresponds to the JSON property `metros` # @return [Array] attr_accessor :metros def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @metros = args[:metros] if args.key?(:metros) end end # Contains information about a mobile carrier that can be targeted by ads. class MobileCarrier include Google::Apis::Core::Hashable # Country code of the country to which this mobile carrier belongs. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of the country to which this mobile carrier belongs. # Corresponds to the JSON property `countryDartId` # @return [Fixnum] attr_accessor :country_dart_id # ID of this mobile carrier. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#mobileCarrier". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this mobile carrier. # 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) @country_code = args[:country_code] if args.key?(:country_code) @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Mobile Carrier List Response class MobileCarriersListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#mobileCarriersListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Mobile carrier collection. # Corresponds to the JSON property `mobileCarriers` # @return [Array] attr_accessor :mobile_carriers def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers) end end # Object Filter. class ObjectFilter include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#objectFilter". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Applicable when status is ASSIGNED. The user has access to objects with these # object IDs. # Corresponds to the JSON property `objectIds` # @return [Array] attr_accessor :object_ids # Status of the filter. NONE means the user has access to none of the objects. # ALL means the user has access to all objects. ASSIGNED means the user has # access to the objects with IDs in the objectIds list. # 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) @kind = args[:kind] if args.key?(:kind) @object_ids = args[:object_ids] if args.key?(:object_ids) @status = args[:status] if args.key?(:status) end end # Offset Position. class OffsetPosition include Google::Apis::Core::Hashable # Offset distance from left side of an asset or a window. # Corresponds to the JSON property `left` # @return [Fixnum] attr_accessor :left # Offset distance from top side of an asset or a window. # Corresponds to the JSON property `top` # @return [Fixnum] attr_accessor :top def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @left = args[:left] if args.key?(:left) @top = args[:top] if args.key?(:top) end end # Omniture Integration Settings. class OmnitureSettings include Google::Apis::Core::Hashable # Whether placement cost data will be sent to Omniture. This property can be # enabled only if omnitureIntegrationEnabled is true. # Corresponds to the JSON property `omnitureCostDataEnabled` # @return [Boolean] attr_accessor :omniture_cost_data_enabled alias_method :omniture_cost_data_enabled?, :omniture_cost_data_enabled # Whether Omniture integration is enabled. This property can be enabled only # when the "Advanced Ad Serving" account setting is enabled. # Corresponds to the JSON property `omnitureIntegrationEnabled` # @return [Boolean] attr_accessor :omniture_integration_enabled alias_method :omniture_integration_enabled?, :omniture_integration_enabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @omniture_cost_data_enabled = args[:omniture_cost_data_enabled] if args.key?(:omniture_cost_data_enabled) @omniture_integration_enabled = args[:omniture_integration_enabled] if args.key?(:omniture_integration_enabled) end end # Contains information about an operating system that can be targeted by ads. class OperatingSystem include Google::Apis::Core::Hashable # DART ID of this operating system. This is the ID used for targeting. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # Whether this operating system is for desktop. # Corresponds to the JSON property `desktop` # @return [Boolean] attr_accessor :desktop alias_method :desktop?, :desktop # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#operatingSystem". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Whether this operating system is for mobile. # Corresponds to the JSON property `mobile` # @return [Boolean] attr_accessor :mobile alias_method :mobile?, :mobile # Name of this operating system. # 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) @dart_id = args[:dart_id] if args.key?(:dart_id) @desktop = args[:desktop] if args.key?(:desktop) @kind = args[:kind] if args.key?(:kind) @mobile = args[:mobile] if args.key?(:mobile) @name = args[:name] if args.key?(:name) end end # Contains information about a particular version of an operating system that # can be targeted by ads. class OperatingSystemVersion include Google::Apis::Core::Hashable # ID of this operating system version. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#operatingSystemVersion". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Major version (leftmost number) of this operating system version. # Corresponds to the JSON property `majorVersion` # @return [String] attr_accessor :major_version # Minor version (number after the first dot) of this operating system version. # Corresponds to the JSON property `minorVersion` # @return [String] attr_accessor :minor_version # Name of this operating system version. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Contains information about an operating system that can be targeted by ads. # Corresponds to the JSON property `operatingSystem` # @return [Google::Apis::DfareportingV2_8::OperatingSystem] attr_accessor :operating_system def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @major_version = args[:major_version] if args.key?(:major_version) @minor_version = args[:minor_version] if args.key?(:minor_version) @name = args[:name] if args.key?(:name) @operating_system = args[:operating_system] if args.key?(:operating_system) end end # Operating System Version List Response class OperatingSystemVersionsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#operatingSystemVersionsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Operating system version collection. # Corresponds to the JSON property `operatingSystemVersions` # @return [Array] attr_accessor :operating_system_versions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @operating_system_versions = args[:operating_system_versions] if args.key?(:operating_system_versions) end end # Operating System List Response class OperatingSystemsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#operatingSystemsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Operating system collection. # Corresponds to the JSON property `operatingSystems` # @return [Array] attr_accessor :operating_systems def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @operating_systems = args[:operating_systems] if args.key?(:operating_systems) end end # Creative optimization activity. class OptimizationActivity include Google::Apis::Core::Hashable # Floodlight activity ID of this optimization activity. This is a required field. # Corresponds to the JSON property `floodlightActivityId` # @return [Fixnum] attr_accessor :floodlight_activity_id # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightActivityIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :floodlight_activity_id_dimension_value # Weight associated with this optimization. The weight assigned will be # understood in proportion to the weights assigned to the other optimization # activities. Value must be greater than or equal to 1. # Corresponds to the JSON property `weight` # @return [Fixnum] attr_accessor :weight 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) @floodlight_activity_id_dimension_value = args[:floodlight_activity_id_dimension_value] if args.key?(:floodlight_activity_id_dimension_value) @weight = args[:weight] if args.key?(:weight) end end # Describes properties of a DoubleClick Planning order. class Order include Google::Apis::Core::Hashable # Account ID of this order. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this order. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # IDs for users that have to approve documents created for this order. # Corresponds to the JSON property `approverUserProfileIds` # @return [Array] attr_accessor :approver_user_profile_ids # Buyer invoice ID associated with this order. # Corresponds to the JSON property `buyerInvoiceId` # @return [String] attr_accessor :buyer_invoice_id # Name of the buyer organization. # Corresponds to the JSON property `buyerOrganizationName` # @return [String] attr_accessor :buyer_organization_name # Comments in this order. # Corresponds to the JSON property `comments` # @return [String] attr_accessor :comments # Contacts for this order. # Corresponds to the JSON property `contacts` # @return [Array] attr_accessor :contacts # ID of this order. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#order". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :last_modified_info # Name of this order. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Notes of this order. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # ID of the terms and conditions template used in this order. # Corresponds to the JSON property `planningTermId` # @return [Fixnum] attr_accessor :planning_term_id # Project ID of this order. # Corresponds to the JSON property `projectId` # @return [Fixnum] attr_accessor :project_id # Seller order ID associated with this order. # Corresponds to the JSON property `sellerOrderId` # @return [String] attr_accessor :seller_order_id # Name of the seller organization. # Corresponds to the JSON property `sellerOrganizationName` # @return [String] attr_accessor :seller_organization_name # Site IDs this order is associated with. # Corresponds to the JSON property `siteId` # @return [Array] attr_accessor :site_id # Free-form site names this order is associated with. # Corresponds to the JSON property `siteNames` # @return [Array] attr_accessor :site_names # Subaccount ID of this order. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Terms and conditions of this order. # Corresponds to the JSON property `termsAndConditions` # @return [String] attr_accessor :terms_and_conditions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @approver_user_profile_ids = args[:approver_user_profile_ids] if args.key?(:approver_user_profile_ids) @buyer_invoice_id = args[:buyer_invoice_id] if args.key?(:buyer_invoice_id) @buyer_organization_name = args[:buyer_organization_name] if args.key?(:buyer_organization_name) @comments = args[:comments] if args.key?(:comments) @contacts = args[:contacts] if args.key?(:contacts) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @planning_term_id = args[:planning_term_id] if args.key?(:planning_term_id) @project_id = args[:project_id] if args.key?(:project_id) @seller_order_id = args[:seller_order_id] if args.key?(:seller_order_id) @seller_organization_name = args[:seller_organization_name] if args.key?(:seller_organization_name) @site_id = args[:site_id] if args.key?(:site_id) @site_names = args[:site_names] if args.key?(:site_names) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @terms_and_conditions = args[:terms_and_conditions] if args.key?(:terms_and_conditions) end end # Contact of an order. class OrderContact include Google::Apis::Core::Hashable # Free-form information about this contact. It could be any information related # to this contact in addition to type, title, name, and signature user profile # ID. # Corresponds to the JSON property `contactInfo` # @return [String] attr_accessor :contact_info # Name of this contact. # Corresponds to the JSON property `contactName` # @return [String] attr_accessor :contact_name # Title of this contact. # Corresponds to the JSON property `contactTitle` # @return [String] attr_accessor :contact_title # Type of this contact. # Corresponds to the JSON property `contactType` # @return [String] attr_accessor :contact_type # ID of the user profile containing the signature that will be embedded into # order documents. # Corresponds to the JSON property `signatureUserProfileId` # @return [Fixnum] attr_accessor :signature_user_profile_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contact_info = args[:contact_info] if args.key?(:contact_info) @contact_name = args[:contact_name] if args.key?(:contact_name) @contact_title = args[:contact_title] if args.key?(:contact_title) @contact_type = args[:contact_type] if args.key?(:contact_type) @signature_user_profile_id = args[:signature_user_profile_id] if args.key?(:signature_user_profile_id) end end # Contains properties of a DoubleClick Planning order document. class OrderDocument include Google::Apis::Core::Hashable # Account ID of this order document. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this order document. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # The amended order document ID of this order document. An order document can be # created by optionally amending another order document so that the change # history can be preserved. # Corresponds to the JSON property `amendedOrderDocumentId` # @return [Fixnum] attr_accessor :amended_order_document_id # IDs of users who have approved this order document. # Corresponds to the JSON property `approvedByUserProfileIds` # @return [Array] attr_accessor :approved_by_user_profile_ids # Whether this order document is cancelled. # Corresponds to the JSON property `cancelled` # @return [Boolean] attr_accessor :cancelled alias_method :cancelled?, :cancelled # Modification timestamp. # Corresponds to the JSON property `createdInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :created_info # Effective date of this order document. # Corresponds to the JSON property `effectiveDate` # @return [Date] attr_accessor :effective_date # ID of this order document. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#orderDocument". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # List of email addresses that received the last sent document. # Corresponds to the JSON property `lastSentRecipients` # @return [Array] attr_accessor :last_sent_recipients # Timestamp of the last email sent with this order document. # Corresponds to the JSON property `lastSentTime` # @return [DateTime] attr_accessor :last_sent_time # ID of the order from which this order document is created. # Corresponds to the JSON property `orderId` # @return [Fixnum] attr_accessor :order_id # Project ID of this order document. # Corresponds to the JSON property `projectId` # @return [Fixnum] attr_accessor :project_id # Whether this order document has been signed. # Corresponds to the JSON property `signed` # @return [Boolean] attr_accessor :signed alias_method :signed?, :signed # Subaccount ID of this order document. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Title of this order document. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Type of this order document # 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) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @amended_order_document_id = args[:amended_order_document_id] if args.key?(:amended_order_document_id) @approved_by_user_profile_ids = args[:approved_by_user_profile_ids] if args.key?(:approved_by_user_profile_ids) @cancelled = args[:cancelled] if args.key?(:cancelled) @created_info = args[:created_info] if args.key?(:created_info) @effective_date = args[:effective_date] if args.key?(:effective_date) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_sent_recipients = args[:last_sent_recipients] if args.key?(:last_sent_recipients) @last_sent_time = args[:last_sent_time] if args.key?(:last_sent_time) @order_id = args[:order_id] if args.key?(:order_id) @project_id = args[:project_id] if args.key?(:project_id) @signed = args[:signed] if args.key?(:signed) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) end end # Order document List Response class OrderDocumentsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#orderDocumentsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Order document collection # Corresponds to the JSON property `orderDocuments` # @return [Array] attr_accessor :order_documents 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) @order_documents = args[:order_documents] if args.key?(:order_documents) end end # Order List Response class OrdersListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#ordersListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Order collection. # Corresponds to the JSON property `orders` # @return [Array] attr_accessor :orders 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) @orders = args[:orders] if args.key?(:orders) end end # Represents fields that are compatible to be selected for a report of type " # PATH_TO_CONVERSION". class PathToConversionReportCompatibleFields include Google::Apis::Core::Hashable # Conversion dimensions which are compatible to be selected in the " # conversionDimensions" section of the report. # Corresponds to the JSON property `conversionDimensions` # @return [Array] attr_accessor :conversion_dimensions # Custom floodlight variables which are compatible to be selected in the " # customFloodlightVariables" section of the report. # Corresponds to the JSON property `customFloodlightVariables` # @return [Array] attr_accessor :custom_floodlight_variables # The kind of resource this is, in this case dfareporting# # pathToConversionReportCompatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metrics which are compatible to be selected in the "metricNames" section of # the report. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Per-interaction dimensions which are compatible to be selected in the " # perInteractionDimensions" section of the report. # Corresponds to the JSON property `perInteractionDimensions` # @return [Array] attr_accessor :per_interaction_dimensions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @conversion_dimensions = args[:conversion_dimensions] if args.key?(:conversion_dimensions) @custom_floodlight_variables = args[:custom_floodlight_variables] if args.key?(:custom_floodlight_variables) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) @per_interaction_dimensions = args[:per_interaction_dimensions] if args.key?(:per_interaction_dimensions) end end # Contains properties of a placement. class Placement include Google::Apis::Core::Hashable # Account ID of this placement. This field can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this placement opts out of ad blocking. When true, ad blocking is # disabled for this placement. When false, the campaign and site settings take # effect. # Corresponds to the JSON property `adBlockingOptOut` # @return [Boolean] attr_accessor :ad_blocking_opt_out alias_method :ad_blocking_opt_out?, :ad_blocking_opt_out # Advertiser ID of this placement. This field can be left blank. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Whether this placement is archived. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # Campaign ID of this placement. This field is a required field on insertion. # Corresponds to the JSON property `campaignId` # @return [Fixnum] attr_accessor :campaign_id # Represents a DimensionValue resource. # Corresponds to the JSON property `campaignIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :campaign_id_dimension_value # Comments for this placement. # Corresponds to the JSON property `comment` # @return [String] attr_accessor :comment # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering # on desktop, on mobile devices or in mobile apps for regular or interstitial # ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new # placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. # IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the # VAST standard. This field is required on insertion. # Corresponds to the JSON property `compatibility` # @return [String] attr_accessor :compatibility # ID of the content category assigned to this placement. # Corresponds to the JSON property `contentCategoryId` # @return [Fixnum] attr_accessor :content_category_id # Modification timestamp. # Corresponds to the JSON property `createInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :create_info # Directory site ID of this placement. On insert, you must set either this field # or the siteId field to specify the site associated with this placement. This # is a required field that is read-only after insertion. # Corresponds to the JSON property `directorySiteId` # @return [Fixnum] attr_accessor :directory_site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `directorySiteIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :directory_site_id_dimension_value # External ID for this placement. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id # ID of this placement. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Key name of this placement. This is a read-only, auto-generated field. # Corresponds to the JSON property `keyName` # @return [String] attr_accessor :key_name # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placement". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :last_modified_info # Lookback configuration settings. # Corresponds to the JSON property `lookbackConfiguration` # @return [Google::Apis::DfareportingV2_8::LookbackConfiguration] attr_accessor :lookback_configuration # Name of this placement.This is a required field and must be less than 256 # characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether payment was approved for this placement. This is a read-only field # relevant only to publisher-paid placements. # Corresponds to the JSON property `paymentApproved` # @return [Boolean] attr_accessor :payment_approved alias_method :payment_approved?, :payment_approved # Payment source for this placement. This is a required field that is read-only # after insertion. # Corresponds to the JSON property `paymentSource` # @return [String] attr_accessor :payment_source # ID of this placement's group, if applicable. # Corresponds to the JSON property `placementGroupId` # @return [Fixnum] attr_accessor :placement_group_id # Represents a DimensionValue resource. # Corresponds to the JSON property `placementGroupIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :placement_group_id_dimension_value # ID of the placement strategy assigned to this placement. # Corresponds to the JSON property `placementStrategyId` # @return [Fixnum] attr_accessor :placement_strategy_id # Pricing Schedule # Corresponds to the JSON property `pricingSchedule` # @return [Google::Apis::DfareportingV2_8::PricingSchedule] attr_accessor :pricing_schedule # Whether this placement is the primary placement of a roadblock (placement # group). You cannot change this field from true to false. Setting this field to # true will automatically set the primary field on the original primary # placement of the roadblock to false, and it will automatically set the # roadblock's primaryPlacementId field to the ID of this placement. # Corresponds to the JSON property `primary` # @return [Boolean] attr_accessor :primary alias_method :primary?, :primary # Modification timestamp. # Corresponds to the JSON property `publisherUpdateInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :publisher_update_info # Site ID associated with this placement. On insert, you must set either this # field or the directorySiteId field to specify the site associated with this # placement. This is a required field that is read-only after insertion. # Corresponds to the JSON property `siteId` # @return [Fixnum] attr_accessor :site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `siteIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :site_id_dimension_value # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `size` # @return [Google::Apis::DfareportingV2_8::Size] attr_accessor :size # Whether creatives assigned to this placement must be SSL-compliant. # Corresponds to the JSON property `sslRequired` # @return [Boolean] attr_accessor :ssl_required alias_method :ssl_required?, :ssl_required # Third-party placement status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Subaccount ID of this placement. This field can be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Tag formats to generate for this placement. This field is required on # insertion. # Acceptable values are: # - "PLACEMENT_TAG_STANDARD" # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" # - "PLACEMENT_TAG_IFRAME_ILAYER" # - "PLACEMENT_TAG_INTERNAL_REDIRECT" # - "PLACEMENT_TAG_JAVASCRIPT" # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" # - "PLACEMENT_TAG_CLICK_COMMANDS" # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" # - "PLACEMENT_TAG_TRACKING" # - "PLACEMENT_TAG_TRACKING_IFRAME" # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" # Corresponds to the JSON property `tagFormats` # @return [Array] attr_accessor :tag_formats # Tag Settings # Corresponds to the JSON property `tagSetting` # @return [Google::Apis::DfareportingV2_8::TagSetting] attr_accessor :tag_setting # Whether Verification and ActiveView are disabled for in-stream video creatives # for this placement. The same setting videoActiveViewOptOut exists on the site # level -- the opt out occurs if either of these settings are true. These # settings are distinct from DirectorySites.settings.activeViewOptOut or Sites. # siteSettings.activeViewOptOut which only apply to display ads. However, # Accounts.activeViewOptOut opts out both video traffic, as well as display ads, # from Verification and ActiveView. # Corresponds to the JSON property `videoActiveViewOptOut` # @return [Boolean] attr_accessor :video_active_view_opt_out alias_method :video_active_view_opt_out?, :video_active_view_opt_out # Video Settings # Corresponds to the JSON property `videoSettings` # @return [Google::Apis::DfareportingV2_8::VideoSettings] attr_accessor :video_settings # VPAID adapter setting for this placement. Controls which VPAID format the # measurement adapter will use for in-stream video creatives assigned to this # placement. # Note: Flash is no longer supported. This field now defaults to HTML5 when the # following values are provided: FLASH, BOTH. # Corresponds to the JSON property `vpaidAdapterChoice` # @return [String] attr_accessor :vpaid_adapter_choice def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @ad_blocking_opt_out = args[:ad_blocking_opt_out] if args.key?(:ad_blocking_opt_out) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @archived = args[:archived] if args.key?(:archived) @campaign_id = args[:campaign_id] if args.key?(:campaign_id) @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) @comment = args[:comment] if args.key?(:comment) @compatibility = args[:compatibility] if args.key?(:compatibility) @content_category_id = args[:content_category_id] if args.key?(:content_category_id) @create_info = args[:create_info] if args.key?(:create_info) @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) @external_id = args[:external_id] if args.key?(:external_id) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @key_name = args[:key_name] if args.key?(:key_name) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @name = args[:name] if args.key?(:name) @payment_approved = args[:payment_approved] if args.key?(:payment_approved) @payment_source = args[:payment_source] if args.key?(:payment_source) @placement_group_id = args[:placement_group_id] if args.key?(:placement_group_id) @placement_group_id_dimension_value = args[:placement_group_id_dimension_value] if args.key?(:placement_group_id_dimension_value) @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) @pricing_schedule = args[:pricing_schedule] if args.key?(:pricing_schedule) @primary = args[:primary] if args.key?(:primary) @publisher_update_info = args[:publisher_update_info] if args.key?(:publisher_update_info) @site_id = args[:site_id] if args.key?(:site_id) @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) @size = args[:size] if args.key?(:size) @ssl_required = args[:ssl_required] if args.key?(:ssl_required) @status = args[:status] if args.key?(:status) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @tag_formats = args[:tag_formats] if args.key?(:tag_formats) @tag_setting = args[:tag_setting] if args.key?(:tag_setting) @video_active_view_opt_out = args[:video_active_view_opt_out] if args.key?(:video_active_view_opt_out) @video_settings = args[:video_settings] if args.key?(:video_settings) @vpaid_adapter_choice = args[:vpaid_adapter_choice] if args.key?(:vpaid_adapter_choice) end end # Placement Assignment. class PlacementAssignment include Google::Apis::Core::Hashable # Whether this placement assignment is active. When true, the placement will be # included in the ad's rotation. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # ID of the placement to be assigned. This is a required field. # Corresponds to the JSON property `placementId` # @return [Fixnum] attr_accessor :placement_id # Represents a DimensionValue resource. # Corresponds to the JSON property `placementIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :placement_id_dimension_value # Whether the placement to be assigned requires SSL. This is a read-only field # that is auto-generated when the ad is inserted or updated. # Corresponds to the JSON property `sslRequired` # @return [Boolean] attr_accessor :ssl_required alias_method :ssl_required?, :ssl_required def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active = args[:active] if args.key?(:active) @placement_id = args[:placement_id] if args.key?(:placement_id) @placement_id_dimension_value = args[:placement_id_dimension_value] if args.key?(:placement_id_dimension_value) @ssl_required = args[:ssl_required] if args.key?(:ssl_required) end end # Contains properties of a package or roadblock. class PlacementGroup include Google::Apis::Core::Hashable # Account ID of this placement group. This is a read-only field that can be left # blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this placement group. This is a required field on insertion. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Whether this placement group is archived. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # Campaign ID of this placement group. This field is required on insertion. # Corresponds to the JSON property `campaignId` # @return [Fixnum] attr_accessor :campaign_id # Represents a DimensionValue resource. # Corresponds to the JSON property `campaignIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :campaign_id_dimension_value # IDs of placements which are assigned to this placement group. This is a read- # only, auto-generated field. # Corresponds to the JSON property `childPlacementIds` # @return [Array] attr_accessor :child_placement_ids # Comments for this placement group. # Corresponds to the JSON property `comment` # @return [String] attr_accessor :comment # ID of the content category assigned to this placement group. # Corresponds to the JSON property `contentCategoryId` # @return [Fixnum] attr_accessor :content_category_id # Modification timestamp. # Corresponds to the JSON property `createInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :create_info # Directory site ID associated with this placement group. On insert, you must # set either this field or the site_id field to specify the site associated with # this placement group. This is a required field that is read-only after # insertion. # Corresponds to the JSON property `directorySiteId` # @return [Fixnum] attr_accessor :directory_site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `directorySiteIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :directory_site_id_dimension_value # External ID for this placement. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id # ID of this placement group. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :last_modified_info # Name of this placement group. This is a required field and must be less than # 256 characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Type of this placement group. A package is a simple group of placements that # acts as a single pricing point for a group of tags. A roadblock is a group of # placements that not only acts as a single pricing point, but also assumes that # all the tags in it will be served at the same time. A roadblock requires one # of its assigned placements to be marked as primary for reporting. This field # is required on insertion. # Corresponds to the JSON property `placementGroupType` # @return [String] attr_accessor :placement_group_type # ID of the placement strategy assigned to this placement group. # Corresponds to the JSON property `placementStrategyId` # @return [Fixnum] attr_accessor :placement_strategy_id # Pricing Schedule # Corresponds to the JSON property `pricingSchedule` # @return [Google::Apis::DfareportingV2_8::PricingSchedule] attr_accessor :pricing_schedule # ID of the primary placement, used to calculate the media cost of a roadblock ( # placement group). Modifying this field will automatically modify the primary # field on all affected roadblock child placements. # Corresponds to the JSON property `primaryPlacementId` # @return [Fixnum] attr_accessor :primary_placement_id # Represents a DimensionValue resource. # Corresponds to the JSON property `primaryPlacementIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :primary_placement_id_dimension_value # Site ID associated with this placement group. On insert, you must set either # this field or the directorySiteId field to specify the site associated with # this placement group. This is a required field that is read-only after # insertion. # Corresponds to the JSON property `siteId` # @return [Fixnum] attr_accessor :site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `siteIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :site_id_dimension_value # Subaccount ID of this placement group. This is a read-only field that can be # left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @archived = args[:archived] if args.key?(:archived) @campaign_id = args[:campaign_id] if args.key?(:campaign_id) @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) @child_placement_ids = args[:child_placement_ids] if args.key?(:child_placement_ids) @comment = args[:comment] if args.key?(:comment) @content_category_id = args[:content_category_id] if args.key?(:content_category_id) @create_info = args[:create_info] if args.key?(:create_info) @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) @external_id = args[:external_id] if args.key?(:external_id) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @name = args[:name] if args.key?(:name) @placement_group_type = args[:placement_group_type] if args.key?(:placement_group_type) @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) @pricing_schedule = args[:pricing_schedule] if args.key?(:pricing_schedule) @primary_placement_id = args[:primary_placement_id] if args.key?(:primary_placement_id) @primary_placement_id_dimension_value = args[:primary_placement_id_dimension_value] if args.key?(:primary_placement_id_dimension_value) @site_id = args[:site_id] if args.key?(:site_id) @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Placement Group List Response class PlacementGroupsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementGroupsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Placement group collection. # Corresponds to the JSON property `placementGroups` # @return [Array] attr_accessor :placement_groups 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) @placement_groups = args[:placement_groups] if args.key?(:placement_groups) end end # Placement Strategy List Response class PlacementStrategiesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementStrategiesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Placement strategy collection. # Corresponds to the JSON property `placementStrategies` # @return [Array] attr_accessor :placement_strategies 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) @placement_strategies = args[:placement_strategies] if args.key?(:placement_strategies) end end # Contains properties of a placement strategy. class PlacementStrategy include Google::Apis::Core::Hashable # Account ID of this placement strategy.This is a read-only field that can be # left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # ID of this placement strategy. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementStrategy". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this placement strategy. This is a required field. It must be less # than 256 characters long and unique among placement strategies of the same # account. # 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) @account_id = args[:account_id] if args.key?(:account_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Placement Tag class PlacementTag include Google::Apis::Core::Hashable # Placement ID # Corresponds to the JSON property `placementId` # @return [Fixnum] attr_accessor :placement_id # Tags generated for this placement. # Corresponds to the JSON property `tagDatas` # @return [Array] attr_accessor :tag_datas def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @placement_id = args[:placement_id] if args.key?(:placement_id) @tag_datas = args[:tag_datas] if args.key?(:tag_datas) end end # Placement GenerateTags Response class PlacementsGenerateTagsResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementsGenerateTagsResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Set of generated tags for the specified placements. # Corresponds to the JSON property `placementTags` # @return [Array] attr_accessor :placement_tags def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @placement_tags = args[:placement_tags] if args.key?(:placement_tags) end end # Placement List Response class PlacementsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Placement collection. # Corresponds to the JSON property `placements` # @return [Array] attr_accessor :placements 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) @placements = args[:placements] if args.key?(:placements) end end # Contains information about a platform type that can be targeted by ads. class PlatformType include Google::Apis::Core::Hashable # ID of this platform type. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#platformType". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this platform type. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Platform Type List Response class PlatformTypesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#platformTypesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Platform type collection. # Corresponds to the JSON property `platformTypes` # @return [Array] attr_accessor :platform_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @platform_types = args[:platform_types] if args.key?(:platform_types) end end # Popup Window Properties. class PopupWindowProperties include Google::Apis::Core::Hashable # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `dimension` # @return [Google::Apis::DfareportingV2_8::Size] attr_accessor :dimension # Offset Position. # Corresponds to the JSON property `offset` # @return [Google::Apis::DfareportingV2_8::OffsetPosition] attr_accessor :offset # Popup window position either centered or at specific coordinate. # Corresponds to the JSON property `positionType` # @return [String] attr_accessor :position_type # Whether to display the browser address bar. # Corresponds to the JSON property `showAddressBar` # @return [Boolean] attr_accessor :show_address_bar alias_method :show_address_bar?, :show_address_bar # Whether to display the browser menu bar. # Corresponds to the JSON property `showMenuBar` # @return [Boolean] attr_accessor :show_menu_bar alias_method :show_menu_bar?, :show_menu_bar # Whether to display the browser scroll bar. # Corresponds to the JSON property `showScrollBar` # @return [Boolean] attr_accessor :show_scroll_bar alias_method :show_scroll_bar?, :show_scroll_bar # Whether to display the browser status bar. # Corresponds to the JSON property `showStatusBar` # @return [Boolean] attr_accessor :show_status_bar alias_method :show_status_bar?, :show_status_bar # Whether to display the browser tool bar. # Corresponds to the JSON property `showToolBar` # @return [Boolean] attr_accessor :show_tool_bar alias_method :show_tool_bar?, :show_tool_bar # Title of popup window. # 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) @dimension = args[:dimension] if args.key?(:dimension) @offset = args[:offset] if args.key?(:offset) @position_type = args[:position_type] if args.key?(:position_type) @show_address_bar = args[:show_address_bar] if args.key?(:show_address_bar) @show_menu_bar = args[:show_menu_bar] if args.key?(:show_menu_bar) @show_scroll_bar = args[:show_scroll_bar] if args.key?(:show_scroll_bar) @show_status_bar = args[:show_status_bar] if args.key?(:show_status_bar) @show_tool_bar = args[:show_tool_bar] if args.key?(:show_tool_bar) @title = args[:title] if args.key?(:title) end end # Contains information about a postal code that can be targeted by ads. class PostalCode include Google::Apis::Core::Hashable # Postal code. This is equivalent to the id field. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # Country code of the country to which this postal code belongs. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of the country to which this postal code belongs. # Corresponds to the JSON property `countryDartId` # @return [Fixnum] attr_accessor :country_dart_id # ID of this postal code. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#postalCode". # 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) @code = args[:code] if args.key?(:code) @country_code = args[:country_code] if args.key?(:country_code) @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) end end # Postal Code List Response class PostalCodesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#postalCodesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Postal code collection. # Corresponds to the JSON property `postalCodes` # @return [Array] attr_accessor :postal_codes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @postal_codes = args[:postal_codes] if args.key?(:postal_codes) end end # Pricing Information class Pricing include Google::Apis::Core::Hashable # Cap cost type of this inventory item. # Corresponds to the JSON property `capCostType` # @return [String] attr_accessor :cap_cost_type # End date of this inventory item. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # Flights of this inventory item. A flight (a.k.a. pricing period) represents # the inventory item pricing information for a specific period of time. # Corresponds to the JSON property `flights` # @return [Array] attr_accessor :flights # Group type of this inventory item if it represents a placement group. Is null # otherwise. There are two type of placement groups: # PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items # that acts as a single pricing point for a group of tags. # PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not # only acts as a single pricing point, but also assumes that all the tags in it # will be served at the same time. A roadblock requires one of its assigned # inventory items to be marked as primary. # Corresponds to the JSON property `groupType` # @return [String] attr_accessor :group_type # Pricing type of this inventory item. # Corresponds to the JSON property `pricingType` # @return [String] attr_accessor :pricing_type # Start date of this inventory item. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cap_cost_type = args[:cap_cost_type] if args.key?(:cap_cost_type) @end_date = args[:end_date] if args.key?(:end_date) @flights = args[:flights] if args.key?(:flights) @group_type = args[:group_type] if args.key?(:group_type) @pricing_type = args[:pricing_type] if args.key?(:pricing_type) @start_date = args[:start_date] if args.key?(:start_date) end end # Pricing Schedule class PricingSchedule include Google::Apis::Core::Hashable # Placement cap cost option. # Corresponds to the JSON property `capCostOption` # @return [String] attr_accessor :cap_cost_option # Whether cap costs are ignored by ad serving. # Corresponds to the JSON property `disregardOverdelivery` # @return [Boolean] attr_accessor :disregard_overdelivery alias_method :disregard_overdelivery?, :disregard_overdelivery # Placement end date. This date must be later than, or the same day as, the # placement start date, but not later than the campaign end date. If, for # example, you set 6/25/2015 as both the start and end dates, the effective # placement date is just that day only, 6/25/2015. The hours, minutes, and # seconds of the end date should not be set, as doing so will result in an error. # This field is required on insertion. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # Whether this placement is flighted. If true, pricing periods will be computed # automatically. # Corresponds to the JSON property `flighted` # @return [Boolean] attr_accessor :flighted alias_method :flighted?, :flighted # Floodlight activity ID associated with this placement. This field should be # set when placement pricing type is set to PRICING_TYPE_CPA. # Corresponds to the JSON property `floodlightActivityId` # @return [Fixnum] attr_accessor :floodlight_activity_id # Pricing periods for this placement. # Corresponds to the JSON property `pricingPeriods` # @return [Array] attr_accessor :pricing_periods # Placement pricing type. This field is required on insertion. # Corresponds to the JSON property `pricingType` # @return [String] attr_accessor :pricing_type # Placement start date. This date must be later than, or the same day as, the # campaign start date. The hours, minutes, and seconds of the start date should # not be set, as doing so will result in an error. This field is required on # insertion. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date # Testing start date of this placement. The hours, minutes, and seconds of the # start date should not be set, as doing so will result in an error. # Corresponds to the JSON property `testingStartDate` # @return [Date] attr_accessor :testing_start_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cap_cost_option = args[:cap_cost_option] if args.key?(:cap_cost_option) @disregard_overdelivery = args[:disregard_overdelivery] if args.key?(:disregard_overdelivery) @end_date = args[:end_date] if args.key?(:end_date) @flighted = args[:flighted] if args.key?(:flighted) @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) @pricing_periods = args[:pricing_periods] if args.key?(:pricing_periods) @pricing_type = args[:pricing_type] if args.key?(:pricing_type) @start_date = args[:start_date] if args.key?(:start_date) @testing_start_date = args[:testing_start_date] if args.key?(:testing_start_date) end end # Pricing Period class PricingSchedulePricingPeriod include Google::Apis::Core::Hashable # Pricing period end date. This date must be later than, or the same day as, the # pricing period start date, but not later than the placement end date. The # period end date can be the same date as the period start date. If, for example, # you set 6/25/2015 as both the start and end dates, the effective pricing # period date is just that day only, 6/25/2015. The hours, minutes, and seconds # of the end date should not be set, as doing so will result in an error. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # Comments for this pricing period. # Corresponds to the JSON property `pricingComment` # @return [String] attr_accessor :pricing_comment # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). # Acceptable values are 0 to 1000000000000000000, inclusive. # Corresponds to the JSON property `rateOrCostNanos` # @return [Fixnum] attr_accessor :rate_or_cost_nanos # Pricing period start date. This date must be later than, or the same day as, # the placement start date. The hours, minutes, and seconds of the start date # should not be set, as doing so will result in an error. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date # Units of this pricing period. Acceptable values are 0 to 10000000000, # inclusive. # 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) @end_date = args[:end_date] if args.key?(:end_date) @pricing_comment = args[:pricing_comment] if args.key?(:pricing_comment) @rate_or_cost_nanos = args[:rate_or_cost_nanos] if args.key?(:rate_or_cost_nanos) @start_date = args[:start_date] if args.key?(:start_date) @units = args[:units] if args.key?(:units) end end # Contains properties of a DoubleClick Planning project. class Project include Google::Apis::Core::Hashable # Account ID of this project. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this project. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Audience age group of this project. # Corresponds to the JSON property `audienceAgeGroup` # @return [String] attr_accessor :audience_age_group # Audience gender of this project. # Corresponds to the JSON property `audienceGender` # @return [String] attr_accessor :audience_gender # Budget of this project in the currency specified by the current account. The # value stored in this field represents only the non-fractional amount. For # example, for USD, the smallest value that can be represented by this field is # 1 US dollar. # Corresponds to the JSON property `budget` # @return [Fixnum] attr_accessor :budget # Client billing code of this project. # Corresponds to the JSON property `clientBillingCode` # @return [String] attr_accessor :client_billing_code # Name of the project client. # Corresponds to the JSON property `clientName` # @return [String] attr_accessor :client_name # End date of the project. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # ID of this project. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#project". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV2_8::LastModifiedInfo] attr_accessor :last_modified_info # Name of this project. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Overview of this project. # Corresponds to the JSON property `overview` # @return [String] attr_accessor :overview # Start date of the project. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date # Subaccount ID of this project. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Number of clicks that the advertiser is targeting. # Corresponds to the JSON property `targetClicks` # @return [Fixnum] attr_accessor :target_clicks # Number of conversions that the advertiser is targeting. # Corresponds to the JSON property `targetConversions` # @return [Fixnum] attr_accessor :target_conversions # CPA that the advertiser is targeting. # Corresponds to the JSON property `targetCpaNanos` # @return [Fixnum] attr_accessor :target_cpa_nanos # CPC that the advertiser is targeting. # Corresponds to the JSON property `targetCpcNanos` # @return [Fixnum] attr_accessor :target_cpc_nanos # vCPM from Active View that the advertiser is targeting. # Corresponds to the JSON property `targetCpmActiveViewNanos` # @return [Fixnum] attr_accessor :target_cpm_active_view_nanos # CPM that the advertiser is targeting. # Corresponds to the JSON property `targetCpmNanos` # @return [Fixnum] attr_accessor :target_cpm_nanos # Number of impressions that the advertiser is targeting. # Corresponds to the JSON property `targetImpressions` # @return [Fixnum] attr_accessor :target_impressions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @audience_age_group = args[:audience_age_group] if args.key?(:audience_age_group) @audience_gender = args[:audience_gender] if args.key?(:audience_gender) @budget = args[:budget] if args.key?(:budget) @client_billing_code = args[:client_billing_code] if args.key?(:client_billing_code) @client_name = args[:client_name] if args.key?(:client_name) @end_date = args[:end_date] if args.key?(:end_date) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @name = args[:name] if args.key?(:name) @overview = args[:overview] if args.key?(:overview) @start_date = args[:start_date] if args.key?(:start_date) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @target_clicks = args[:target_clicks] if args.key?(:target_clicks) @target_conversions = args[:target_conversions] if args.key?(:target_conversions) @target_cpa_nanos = args[:target_cpa_nanos] if args.key?(:target_cpa_nanos) @target_cpc_nanos = args[:target_cpc_nanos] if args.key?(:target_cpc_nanos) @target_cpm_active_view_nanos = args[:target_cpm_active_view_nanos] if args.key?(:target_cpm_active_view_nanos) @target_cpm_nanos = args[:target_cpm_nanos] if args.key?(:target_cpm_nanos) @target_impressions = args[:target_impressions] if args.key?(:target_impressions) end end # Project List Response class ProjectsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#projectsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Project collection. # Corresponds to the JSON property `projects` # @return [Array] attr_accessor :projects 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) @projects = args[:projects] if args.key?(:projects) end end # Represents fields that are compatible to be selected for a report of type " # REACH". class ReachReportCompatibleFields include Google::Apis::Core::Hashable # Dimensions which are compatible to be selected in the "dimensionFilters" # section of the report. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # Dimensions which are compatible to be selected in the "dimensions" section of # the report. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # The kind of resource this is, in this case dfareporting# # reachReportCompatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metrics which are compatible to be selected in the "metricNames" section of # the report. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Metrics which are compatible to be selected as activity metrics to pivot on in # the "activities" section of the report. # Corresponds to the JSON property `pivotedActivityMetrics` # @return [Array] attr_accessor :pivoted_activity_metrics # Metrics which are compatible to be selected in the " # reachByFrequencyMetricNames" section of the report. # Corresponds to the JSON property `reachByFrequencyMetrics` # @return [Array] attr_accessor :reach_by_frequency_metrics def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) @pivoted_activity_metrics = args[:pivoted_activity_metrics] if args.key?(:pivoted_activity_metrics) @reach_by_frequency_metrics = args[:reach_by_frequency_metrics] if args.key?(:reach_by_frequency_metrics) end end # Represents a recipient. class Recipient include Google::Apis::Core::Hashable # The delivery type for the recipient. # Corresponds to the JSON property `deliveryType` # @return [String] attr_accessor :delivery_type # The email address of the recipient. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The kind of resource this is, in this case dfareporting#recipient. # 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) @delivery_type = args[:delivery_type] if args.key?(:delivery_type) @email = args[:email] if args.key?(:email) @kind = args[:kind] if args.key?(:kind) end end # Contains information about a region that can be targeted by ads. class Region include Google::Apis::Core::Hashable # Country code of the country to which this region belongs. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of the country to which this region belongs. # Corresponds to the JSON property `countryDartId` # @return [Fixnum] attr_accessor :country_dart_id # DART ID of this region. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#region". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this region. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Region code. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country_code = args[:country_code] if args.key?(:country_code) @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) @dart_id = args[:dart_id] if args.key?(:dart_id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @region_code = args[:region_code] if args.key?(:region_code) end end # Region List Response class RegionsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#regionsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Region collection. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @regions = args[:regions] if args.key?(:regions) end end # Contains properties of a remarketing list. Remarketing enables you to create # lists of users who have performed specific actions on a site, then target ads # to members of those lists. This resource can be used to manage remarketing # lists that are owned by your advertisers. To see all remarketing lists that # are visible to your advertisers, including those that are shared to your # advertiser or account, use the TargetableRemarketingLists resource. class RemarketingList include Google::Apis::Core::Hashable # Account ID of this remarketing list. This is a read-only, auto-generated field # that is only returned in GET requests. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this remarketing list is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Dimension value for the advertiser ID that owns this remarketing list. This is # a required field. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Remarketing list description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Remarketing list ID. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#remarketingList". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Number of days that a user should remain in the remarketing list without an # impression. Acceptable values are 1 to 540, inclusive. # Corresponds to the JSON property `lifeSpan` # @return [Fixnum] attr_accessor :life_span # Remarketing List Population Rule. # Corresponds to the JSON property `listPopulationRule` # @return [Google::Apis::DfareportingV2_8::ListPopulationRule] attr_accessor :list_population_rule # Number of users currently in the list. This is a read-only field. # Corresponds to the JSON property `listSize` # @return [Fixnum] attr_accessor :list_size # Product from which this remarketing list was originated. # Corresponds to the JSON property `listSource` # @return [String] attr_accessor :list_source # Name of the remarketing list. This is a required field. Must be no greater # than 128 characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this remarketing list. This is a read-only, auto-generated # field that is only returned in GET requests. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @life_span = args[:life_span] if args.key?(:life_span) @list_population_rule = args[:list_population_rule] if args.key?(:list_population_rule) @list_size = args[:list_size] if args.key?(:list_size) @list_source = args[:list_source] if args.key?(:list_source) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Contains properties of a remarketing list's sharing information. Sharing # allows other accounts or advertisers to target to your remarketing lists. This # resource can be used to manage remarketing list sharing to other accounts and # advertisers. class RemarketingListShare include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#remarketingListShare". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Remarketing list ID. This is a read-only, auto-generated field. # Corresponds to the JSON property `remarketingListId` # @return [Fixnum] attr_accessor :remarketing_list_id # Accounts that the remarketing list is shared with. # Corresponds to the JSON property `sharedAccountIds` # @return [Array] attr_accessor :shared_account_ids # Advertisers that the remarketing list is shared with. # Corresponds to the JSON property `sharedAdvertiserIds` # @return [Array] attr_accessor :shared_advertiser_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @remarketing_list_id = args[:remarketing_list_id] if args.key?(:remarketing_list_id) @shared_account_ids = args[:shared_account_ids] if args.key?(:shared_account_ids) @shared_advertiser_ids = args[:shared_advertiser_ids] if args.key?(:shared_advertiser_ids) end end # Remarketing list response class RemarketingListsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#remarketingListsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Remarketing list collection. # Corresponds to the JSON property `remarketingLists` # @return [Array] attr_accessor :remarketing_lists 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) @remarketing_lists = args[:remarketing_lists] if args.key?(:remarketing_lists) end end # Represents a Report resource. class Report include Google::Apis::Core::Hashable # The account ID to which this report belongs. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # The report criteria for a report of type "STANDARD". # Corresponds to the JSON property `criteria` # @return [Google::Apis::DfareportingV2_8::Report::Criteria] attr_accessor :criteria # The report criteria for a report of type "CROSS_DIMENSION_REACH". # Corresponds to the JSON property `crossDimensionReachCriteria` # @return [Google::Apis::DfareportingV2_8::Report::CrossDimensionReachCriteria] attr_accessor :cross_dimension_reach_criteria # The report's email delivery settings. # Corresponds to the JSON property `delivery` # @return [Google::Apis::DfareportingV2_8::Report::Delivery] attr_accessor :delivery # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The filename used when generating report files for this report. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name # The report criteria for a report of type "FLOODLIGHT". # Corresponds to the JSON property `floodlightCriteria` # @return [Google::Apis::DfareportingV2_8::Report::FloodlightCriteria] attr_accessor :floodlight_criteria # The output format of the report. If not specified, default format is "CSV". # Note that the actual format in the completed report file might differ if for # instance the report's size exceeds the format's capabilities. "CSV" will then # be the fallback format. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # The unique ID identifying this report resource. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The kind of resource this is, in this case dfareporting#report. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The timestamp (in milliseconds since epoch) of when this report was last # modified. # Corresponds to the JSON property `lastModifiedTime` # @return [Fixnum] attr_accessor :last_modified_time # The name of the report. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The user profile id of the owner of this report. # Corresponds to the JSON property `ownerProfileId` # @return [Fixnum] attr_accessor :owner_profile_id # The report criteria for a report of type "PATH_TO_CONVERSION". # Corresponds to the JSON property `pathToConversionCriteria` # @return [Google::Apis::DfareportingV2_8::Report::PathToConversionCriteria] attr_accessor :path_to_conversion_criteria # The report criteria for a report of type "REACH". # Corresponds to the JSON property `reachCriteria` # @return [Google::Apis::DfareportingV2_8::Report::ReachCriteria] attr_accessor :reach_criteria # The report's schedule. Can only be set if the report's 'dateRange' is a # relative date range and the relative date range is not "TODAY". # Corresponds to the JSON property `schedule` # @return [Google::Apis::DfareportingV2_8::Report::Schedule] attr_accessor :schedule # The subaccount ID to which this report belongs if applicable. # Corresponds to the JSON property `subAccountId` # @return [Fixnum] attr_accessor :sub_account_id # The type of the report. # 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) @account_id = args[:account_id] if args.key?(:account_id) @criteria = args[:criteria] if args.key?(:criteria) @cross_dimension_reach_criteria = args[:cross_dimension_reach_criteria] if args.key?(:cross_dimension_reach_criteria) @delivery = args[:delivery] if args.key?(:delivery) @etag = args[:etag] if args.key?(:etag) @file_name = args[:file_name] if args.key?(:file_name) @floodlight_criteria = args[:floodlight_criteria] if args.key?(:floodlight_criteria) @format = args[:format] if args.key?(:format) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time) @name = args[:name] if args.key?(:name) @owner_profile_id = args[:owner_profile_id] if args.key?(:owner_profile_id) @path_to_conversion_criteria = args[:path_to_conversion_criteria] if args.key?(:path_to_conversion_criteria) @reach_criteria = args[:reach_criteria] if args.key?(:reach_criteria) @schedule = args[:schedule] if args.key?(:schedule) @sub_account_id = args[:sub_account_id] if args.key?(:sub_account_id) @type = args[:type] if args.key?(:type) end # The report criteria for a report of type "STANDARD". class Criteria include Google::Apis::Core::Hashable # Represents an activity group. # Corresponds to the JSON property `activities` # @return [Google::Apis::DfareportingV2_8::Activities] attr_accessor :activities # Represents a Custom Rich Media Events group. # Corresponds to the JSON property `customRichMediaEvents` # @return [Google::Apis::DfareportingV2_8::CustomRichMediaEvents] attr_accessor :custom_rich_media_events # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV2_8::DateRange] attr_accessor :date_range # The list of filters on which dimensions are filtered. # Filters for different dimensions are ANDed, filters for the same dimension are # grouped together and ORed. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # The list of standard dimensions the report should include. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # The list of names of metrics the report should include. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @activities = args[:activities] if args.key?(:activities) @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) @date_range = args[:date_range] if args.key?(:date_range) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @metric_names = args[:metric_names] if args.key?(:metric_names) end end # The report criteria for a report of type "CROSS_DIMENSION_REACH". class CrossDimensionReachCriteria include Google::Apis::Core::Hashable # The list of dimensions the report should include. # Corresponds to the JSON property `breakdown` # @return [Array] attr_accessor :breakdown # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV2_8::DateRange] attr_accessor :date_range # The dimension option. # Corresponds to the JSON property `dimension` # @return [String] attr_accessor :dimension # The list of filters on which dimensions are filtered. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # The list of names of metrics the report should include. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names # The list of names of overlap metrics the report should include. # Corresponds to the JSON property `overlapMetricNames` # @return [Array] attr_accessor :overlap_metric_names # Whether the report is pivoted or not. Defaults to true. # Corresponds to the JSON property `pivoted` # @return [Boolean] attr_accessor :pivoted alias_method :pivoted?, :pivoted def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @breakdown = args[:breakdown] if args.key?(:breakdown) @date_range = args[:date_range] if args.key?(:date_range) @dimension = args[:dimension] if args.key?(:dimension) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @metric_names = args[:metric_names] if args.key?(:metric_names) @overlap_metric_names = args[:overlap_metric_names] if args.key?(:overlap_metric_names) @pivoted = args[:pivoted] if args.key?(:pivoted) end end # The report's email delivery settings. class Delivery include Google::Apis::Core::Hashable # Whether the report should be emailed to the report owner. # Corresponds to the JSON property `emailOwner` # @return [Boolean] attr_accessor :email_owner alias_method :email_owner?, :email_owner # The type of delivery for the owner to receive, if enabled. # Corresponds to the JSON property `emailOwnerDeliveryType` # @return [String] attr_accessor :email_owner_delivery_type # The message to be sent with each email. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message # The list of recipients to which to email the report. # Corresponds to the JSON property `recipients` # @return [Array] attr_accessor :recipients def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email_owner = args[:email_owner] if args.key?(:email_owner) @email_owner_delivery_type = args[:email_owner_delivery_type] if args.key?(:email_owner_delivery_type) @message = args[:message] if args.key?(:message) @recipients = args[:recipients] if args.key?(:recipients) end end # The report criteria for a report of type "FLOODLIGHT". class FloodlightCriteria include Google::Apis::Core::Hashable # The list of custom rich media events to include. # Corresponds to the JSON property `customRichMediaEvents` # @return [Array] attr_accessor :custom_rich_media_events # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV2_8::DateRange] attr_accessor :date_range # The list of filters on which dimensions are filtered. # Filters for different dimensions are ANDed, filters for the same dimension are # grouped together and ORed. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # The list of dimensions the report should include. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightConfigId` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :floodlight_config_id # The list of names of metrics the report should include. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names # The properties of the report. # Corresponds to the JSON property `reportProperties` # @return [Google::Apis::DfareportingV2_8::Report::FloodlightCriteria::ReportProperties] attr_accessor :report_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) @date_range = args[:date_range] if args.key?(:date_range) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @floodlight_config_id = args[:floodlight_config_id] if args.key?(:floodlight_config_id) @metric_names = args[:metric_names] if args.key?(:metric_names) @report_properties = args[:report_properties] if args.key?(:report_properties) end # The properties of the report. class ReportProperties include Google::Apis::Core::Hashable # Include conversions that have no cookie, but do have an exposure path. # Corresponds to the JSON property `includeAttributedIPConversions` # @return [Boolean] attr_accessor :include_attributed_ip_conversions alias_method :include_attributed_ip_conversions?, :include_attributed_ip_conversions # Include conversions of users with a DoubleClick cookie but without an exposure. # That means the user did not click or see an ad from the advertiser within the # Floodlight group, or that the interaction happened outside the lookback window. # Corresponds to the JSON property `includeUnattributedCookieConversions` # @return [Boolean] attr_accessor :include_unattributed_cookie_conversions alias_method :include_unattributed_cookie_conversions?, :include_unattributed_cookie_conversions # Include conversions that have no associated cookies and no exposures. It’s # therefore impossible to know how the user was exposed to your ads during the # lookback window prior to a conversion. # Corresponds to the JSON property `includeUnattributedIPConversions` # @return [Boolean] attr_accessor :include_unattributed_ip_conversions alias_method :include_unattributed_ip_conversions?, :include_unattributed_ip_conversions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @include_attributed_ip_conversions = args[:include_attributed_ip_conversions] if args.key?(:include_attributed_ip_conversions) @include_unattributed_cookie_conversions = args[:include_unattributed_cookie_conversions] if args.key?(:include_unattributed_cookie_conversions) @include_unattributed_ip_conversions = args[:include_unattributed_ip_conversions] if args.key?(:include_unattributed_ip_conversions) end end end # The report criteria for a report of type "PATH_TO_CONVERSION". class PathToConversionCriteria include Google::Apis::Core::Hashable # The list of 'dfa:activity' values to filter on. # Corresponds to the JSON property `activityFilters` # @return [Array] attr_accessor :activity_filters # The list of conversion dimensions the report should include. # Corresponds to the JSON property `conversionDimensions` # @return [Array] attr_accessor :conversion_dimensions # The list of custom floodlight variables the report should include. # Corresponds to the JSON property `customFloodlightVariables` # @return [Array] attr_accessor :custom_floodlight_variables # The list of custom rich media events to include. # Corresponds to the JSON property `customRichMediaEvents` # @return [Array] attr_accessor :custom_rich_media_events # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV2_8::DateRange] attr_accessor :date_range # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightConfigId` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :floodlight_config_id # The list of names of metrics the report should include. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names # The list of per interaction dimensions the report should include. # Corresponds to the JSON property `perInteractionDimensions` # @return [Array] attr_accessor :per_interaction_dimensions # The properties of the report. # Corresponds to the JSON property `reportProperties` # @return [Google::Apis::DfareportingV2_8::Report::PathToConversionCriteria::ReportProperties] attr_accessor :report_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @activity_filters = args[:activity_filters] if args.key?(:activity_filters) @conversion_dimensions = args[:conversion_dimensions] if args.key?(:conversion_dimensions) @custom_floodlight_variables = args[:custom_floodlight_variables] if args.key?(:custom_floodlight_variables) @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) @date_range = args[:date_range] if args.key?(:date_range) @floodlight_config_id = args[:floodlight_config_id] if args.key?(:floodlight_config_id) @metric_names = args[:metric_names] if args.key?(:metric_names) @per_interaction_dimensions = args[:per_interaction_dimensions] if args.key?(:per_interaction_dimensions) @report_properties = args[:report_properties] if args.key?(:report_properties) end # The properties of the report. class ReportProperties include Google::Apis::Core::Hashable # DFA checks to see if a click interaction occurred within the specified period # of time before a conversion. By default the value is pulled from Floodlight or # you can manually enter a custom value. Valid values: 1-90. # Corresponds to the JSON property `clicksLookbackWindow` # @return [Fixnum] attr_accessor :clicks_lookback_window # DFA checks to see if an impression interaction occurred within the specified # period of time before a conversion. By default the value is pulled from # Floodlight or you can manually enter a custom value. Valid values: 1-90. # Corresponds to the JSON property `impressionsLookbackWindow` # @return [Fixnum] attr_accessor :impressions_lookback_window # Deprecated: has no effect. # Corresponds to the JSON property `includeAttributedIPConversions` # @return [Boolean] attr_accessor :include_attributed_ip_conversions alias_method :include_attributed_ip_conversions?, :include_attributed_ip_conversions # Include conversions of users with a DoubleClick cookie but without an exposure. # That means the user did not click or see an ad from the advertiser within the # Floodlight group, or that the interaction happened outside the lookback window. # Corresponds to the JSON property `includeUnattributedCookieConversions` # @return [Boolean] attr_accessor :include_unattributed_cookie_conversions alias_method :include_unattributed_cookie_conversions?, :include_unattributed_cookie_conversions # Include conversions that have no associated cookies and no exposures. It’s # therefore impossible to know how the user was exposed to your ads during the # lookback window prior to a conversion. # Corresponds to the JSON property `includeUnattributedIPConversions` # @return [Boolean] attr_accessor :include_unattributed_ip_conversions alias_method :include_unattributed_ip_conversions?, :include_unattributed_ip_conversions # The maximum number of click interactions to include in the report. Advertisers # currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). # If another advertiser in your network is paying for E2C, you can have up to 5 # total exposures per report. # Corresponds to the JSON property `maximumClickInteractions` # @return [Fixnum] attr_accessor :maximum_click_interactions # The maximum number of click interactions to include in the report. Advertisers # currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). # If another advertiser in your network is paying for E2C, you can have up to 5 # total exposures per report. # Corresponds to the JSON property `maximumImpressionInteractions` # @return [Fixnum] attr_accessor :maximum_impression_interactions # The maximum amount of time that can take place between interactions (clicks or # impressions) by the same user. Valid values: 1-90. # Corresponds to the JSON property `maximumInteractionGap` # @return [Fixnum] attr_accessor :maximum_interaction_gap # Enable pivoting on interaction path. # Corresponds to the JSON property `pivotOnInteractionPath` # @return [Boolean] attr_accessor :pivot_on_interaction_path alias_method :pivot_on_interaction_path?, :pivot_on_interaction_path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @clicks_lookback_window = args[:clicks_lookback_window] if args.key?(:clicks_lookback_window) @impressions_lookback_window = args[:impressions_lookback_window] if args.key?(:impressions_lookback_window) @include_attributed_ip_conversions = args[:include_attributed_ip_conversions] if args.key?(:include_attributed_ip_conversions) @include_unattributed_cookie_conversions = args[:include_unattributed_cookie_conversions] if args.key?(:include_unattributed_cookie_conversions) @include_unattributed_ip_conversions = args[:include_unattributed_ip_conversions] if args.key?(:include_unattributed_ip_conversions) @maximum_click_interactions = args[:maximum_click_interactions] if args.key?(:maximum_click_interactions) @maximum_impression_interactions = args[:maximum_impression_interactions] if args.key?(:maximum_impression_interactions) @maximum_interaction_gap = args[:maximum_interaction_gap] if args.key?(:maximum_interaction_gap) @pivot_on_interaction_path = args[:pivot_on_interaction_path] if args.key?(:pivot_on_interaction_path) end end end # The report criteria for a report of type "REACH". class ReachCriteria include Google::Apis::Core::Hashable # Represents an activity group. # Corresponds to the JSON property `activities` # @return [Google::Apis::DfareportingV2_8::Activities] attr_accessor :activities # Represents a Custom Rich Media Events group. # Corresponds to the JSON property `customRichMediaEvents` # @return [Google::Apis::DfareportingV2_8::CustomRichMediaEvents] attr_accessor :custom_rich_media_events # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV2_8::DateRange] attr_accessor :date_range # The list of filters on which dimensions are filtered. # Filters for different dimensions are ANDed, filters for the same dimension are # grouped together and ORed. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # The list of dimensions the report should include. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # Whether to enable all reach dimension combinations in the report. Defaults to # false. If enabled, the date range of the report should be within the last 42 # days. # Corresponds to the JSON property `enableAllDimensionCombinations` # @return [Boolean] attr_accessor :enable_all_dimension_combinations alias_method :enable_all_dimension_combinations?, :enable_all_dimension_combinations # The list of names of metrics the report should include. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names # The list of names of Reach By Frequency metrics the report should include. # Corresponds to the JSON property `reachByFrequencyMetricNames` # @return [Array] attr_accessor :reach_by_frequency_metric_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @activities = args[:activities] if args.key?(:activities) @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) @date_range = args[:date_range] if args.key?(:date_range) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @enable_all_dimension_combinations = args[:enable_all_dimension_combinations] if args.key?(:enable_all_dimension_combinations) @metric_names = args[:metric_names] if args.key?(:metric_names) @reach_by_frequency_metric_names = args[:reach_by_frequency_metric_names] if args.key?(:reach_by_frequency_metric_names) end end # The report's schedule. Can only be set if the report's 'dateRange' is a # relative date range and the relative date range is not "TODAY". class Schedule include Google::Apis::Core::Hashable # Whether the schedule is active or not. Must be set to either true or false. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Defines every how many days, weeks or months the report should be run. Needs # to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY". # Corresponds to the JSON property `every` # @return [Fixnum] attr_accessor :every # The expiration date when the scheduled report stops running. # Corresponds to the JSON property `expirationDate` # @return [Date] attr_accessor :expiration_date # The interval for which the report is repeated. Note: # - "DAILY" also requires field "every" to be set. # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set. # Corresponds to the JSON property `repeats` # @return [String] attr_accessor :repeats # List of week days "WEEKLY" on which scheduled reports should run. # Corresponds to the JSON property `repeatsOnWeekDays` # @return [Array] attr_accessor :repeats_on_week_days # Enum to define for "MONTHLY" scheduled reports whether reports should be # repeated on the same day of the month as "startDate" or the same day of the # week of the month. # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" # would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" # would run subsequent reports on the first Monday of the month. # Corresponds to the JSON property `runsOnDayOfMonth` # @return [String] attr_accessor :runs_on_day_of_month # Start date of date range for which scheduled reports should be run. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active = args[:active] if args.key?(:active) @every = args[:every] if args.key?(:every) @expiration_date = args[:expiration_date] if args.key?(:expiration_date) @repeats = args[:repeats] if args.key?(:repeats) @repeats_on_week_days = args[:repeats_on_week_days] if args.key?(:repeats_on_week_days) @runs_on_day_of_month = args[:runs_on_day_of_month] if args.key?(:runs_on_day_of_month) @start_date = args[:start_date] if args.key?(:start_date) end end end # Represents fields that are compatible to be selected for a report of type " # STANDARD". class ReportCompatibleFields include Google::Apis::Core::Hashable # Dimensions which are compatible to be selected in the "dimensionFilters" # section of the report. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # Dimensions which are compatible to be selected in the "dimensions" section of # the report. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # The kind of resource this is, in this case dfareporting#reportCompatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metrics which are compatible to be selected in the "metricNames" section of # the report. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Metrics which are compatible to be selected as activity metrics to pivot on in # the "activities" section of the report. # Corresponds to the JSON property `pivotedActivityMetrics` # @return [Array] attr_accessor :pivoted_activity_metrics def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) @pivoted_activity_metrics = args[:pivoted_activity_metrics] if args.key?(:pivoted_activity_metrics) end end # Represents the list of reports. class ReportList include Google::Apis::Core::Hashable # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The reports returned in this response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of list this is, in this case dfareporting#reportList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through reports. To retrieve the next page of # results, set the next request's "pageToken" to the value of this field. The # page token is only valid for a limited amount of time and should not be # persisted. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # Reporting Configuration class ReportsConfiguration include Google::Apis::Core::Hashable # Whether the exposure to conversion report is enabled. This report shows # detailed pathway information on up to 10 of the most recent ad exposures seen # by a user before converting. # Corresponds to the JSON property `exposureToConversionEnabled` # @return [Boolean] attr_accessor :exposure_to_conversion_enabled alias_method :exposure_to_conversion_enabled?, :exposure_to_conversion_enabled # Lookback configuration settings. # Corresponds to the JSON property `lookbackConfiguration` # @return [Google::Apis::DfareportingV2_8::LookbackConfiguration] attr_accessor :lookback_configuration # Report generation time zone ID of this account. This is a required field that # can only be changed by a superuser. # Acceptable values are: # - "1" for "America/New_York" # - "2" for "Europe/London" # - "3" for "Europe/Paris" # - "4" for "Africa/Johannesburg" # - "5" for "Asia/Jerusalem" # - "6" for "Asia/Shanghai" # - "7" for "Asia/Hong_Kong" # - "8" for "Asia/Tokyo" # - "9" for "Australia/Sydney" # - "10" for "Asia/Dubai" # - "11" for "America/Los_Angeles" # - "12" for "Pacific/Auckland" # - "13" for "America/Sao_Paulo" # Corresponds to the JSON property `reportGenerationTimeZoneId` # @return [Fixnum] attr_accessor :report_generation_time_zone_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @exposure_to_conversion_enabled = args[:exposure_to_conversion_enabled] if args.key?(:exposure_to_conversion_enabled) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @report_generation_time_zone_id = args[:report_generation_time_zone_id] if args.key?(:report_generation_time_zone_id) end end # Rich Media Exit Override. class RichMediaExitOverride include Google::Apis::Core::Hashable # Click-through URL # Corresponds to the JSON property `clickThroughUrl` # @return [Google::Apis::DfareportingV2_8::ClickThroughUrl] attr_accessor :click_through_url # Whether to use the clickThroughUrl. If false, the creative-level exit will be # used. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # ID for the override to refer to a specific exit in the creative. # Corresponds to the JSON property `exitId` # @return [Fixnum] attr_accessor :exit_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @enabled = args[:enabled] if args.key?(:enabled) @exit_id = args[:exit_id] if args.key?(:exit_id) end end # A rule associates an asset with a targeting template for asset-level targeting. # Applicable to INSTREAM_VIDEO creatives. class Rule include Google::Apis::Core::Hashable # A creativeAssets[].id. This should refer to one of the parent assets in this # creative. This is a required field. # Corresponds to the JSON property `assetId` # @return [Fixnum] attr_accessor :asset_id # A user-friendly name for this rule. This is a required field. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A targeting template ID. The targeting from the targeting template will be # used to determine whether this asset should be served. This is a required # field. # Corresponds to the JSON property `targetingTemplateId` # @return [Fixnum] attr_accessor :targeting_template_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @asset_id = args[:asset_id] if args.key?(:asset_id) @name = args[:name] if args.key?(:name) @targeting_template_id = args[:targeting_template_id] if args.key?(:targeting_template_id) end end # Contains properties of a site. class Site include Google::Apis::Core::Hashable # Account ID of this site. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this site is approved. # Corresponds to the JSON property `approved` # @return [Boolean] attr_accessor :approved alias_method :approved?, :approved # Directory site associated with this site. This is a required field that is # read-only after insertion. # Corresponds to the JSON property `directorySiteId` # @return [Fixnum] attr_accessor :directory_site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `directorySiteIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :directory_site_id_dimension_value # ID of this site. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :id_dimension_value # Key name of this site. This is a read-only, auto-generated field. # Corresponds to the JSON property `keyName` # @return [String] attr_accessor :key_name # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#site". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this site.This is a required field. Must be less than 128 characters # long. If this site is under a subaccount, the name must be unique among sites # of the same subaccount. Otherwise, this site is a top-level site, and the name # must be unique among top-level sites of the same account. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Site contacts. # Corresponds to the JSON property `siteContacts` # @return [Array] attr_accessor :site_contacts # Site Settings # Corresponds to the JSON property `siteSettings` # @return [Google::Apis::DfareportingV2_8::SiteSettings] attr_accessor :site_settings # Subaccount ID of this site. This is a read-only field that can be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @approved = args[:approved] if args.key?(:approved) @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @key_name = args[:key_name] if args.key?(:key_name) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @site_contacts = args[:site_contacts] if args.key?(:site_contacts) @site_settings = args[:site_settings] if args.key?(:site_settings) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Site Contact class SiteContact include Google::Apis::Core::Hashable # Address of this site contact. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Site contact type. # Corresponds to the JSON property `contactType` # @return [String] attr_accessor :contact_type # Email address of this site contact. This is a required field. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # First name of this site contact. # Corresponds to the JSON property `firstName` # @return [String] attr_accessor :first_name # ID of this site contact. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Last name of this site contact. # Corresponds to the JSON property `lastName` # @return [String] attr_accessor :last_name # Primary phone number of this site contact. # Corresponds to the JSON property `phone` # @return [String] attr_accessor :phone # Title or designation of this site contact. # 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) @address = args[:address] if args.key?(:address) @contact_type = args[:contact_type] if args.key?(:contact_type) @email = args[:email] if args.key?(:email) @first_name = args[:first_name] if args.key?(:first_name) @id = args[:id] if args.key?(:id) @last_name = args[:last_name] if args.key?(:last_name) @phone = args[:phone] if args.key?(:phone) @title = args[:title] if args.key?(:title) end end # Site Settings class SiteSettings include Google::Apis::Core::Hashable # Whether active view creatives are disabled for this site. # Corresponds to the JSON property `activeViewOptOut` # @return [Boolean] attr_accessor :active_view_opt_out alias_method :active_view_opt_out?, :active_view_opt_out # Whether this site opts out of ad blocking. When true, ad blocking is disabled # for all placements under the site, regardless of the individual placement # settings. When false, the campaign and placement settings take effect. # Corresponds to the JSON property `adBlockingOptOut` # @return [Boolean] attr_accessor :ad_blocking_opt_out alias_method :ad_blocking_opt_out?, :ad_blocking_opt_out # Creative Settings # Corresponds to the JSON property `creativeSettings` # @return [Google::Apis::DfareportingV2_8::CreativeSettings] attr_accessor :creative_settings # Whether new cookies are disabled for this site. # Corresponds to the JSON property `disableNewCookie` # @return [Boolean] attr_accessor :disable_new_cookie alias_method :disable_new_cookie?, :disable_new_cookie # Lookback configuration settings. # Corresponds to the JSON property `lookbackConfiguration` # @return [Google::Apis::DfareportingV2_8::LookbackConfiguration] attr_accessor :lookback_configuration # Tag Settings # Corresponds to the JSON property `tagSetting` # @return [Google::Apis::DfareportingV2_8::TagSetting] attr_accessor :tag_setting # Whether Verification and ActiveView for in-stream video creatives are disabled # by default for new placements created under this site. This value will be used # to populate the placement.videoActiveViewOptOut field, when no value is # specified for the new placement. # Corresponds to the JSON property `videoActiveViewOptOutTemplate` # @return [Boolean] attr_accessor :video_active_view_opt_out_template alias_method :video_active_view_opt_out_template?, :video_active_view_opt_out_template # Default VPAID adapter setting for new placements created under this site. This # value will be used to populate the placements.vpaidAdapterChoice field, when # no value is specified for the new placement. Controls which VPAID format the # measurement adapter will use for in-stream video creatives assigned to the # placement. The publisher's specifications will typically determine this # setting. For VPAID creatives, the adapter format will match the VPAID format ( # HTML5 VPAID creatives use the HTML5 adapter). # Note: Flash is no longer supported. This field now defaults to HTML5 when the # following values are provided: FLASH, BOTH. # Corresponds to the JSON property `vpaidAdapterChoiceTemplate` # @return [String] attr_accessor :vpaid_adapter_choice_template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) @ad_blocking_opt_out = args[:ad_blocking_opt_out] if args.key?(:ad_blocking_opt_out) @creative_settings = args[:creative_settings] if args.key?(:creative_settings) @disable_new_cookie = args[:disable_new_cookie] if args.key?(:disable_new_cookie) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @tag_setting = args[:tag_setting] if args.key?(:tag_setting) @video_active_view_opt_out_template = args[:video_active_view_opt_out_template] if args.key?(:video_active_view_opt_out_template) @vpaid_adapter_choice_template = args[:vpaid_adapter_choice_template] if args.key?(:vpaid_adapter_choice_template) end end # Site List Response class SitesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#sitesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Site collection. # Corresponds to the JSON property `sites` # @return [Array] attr_accessor :sites 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) @sites = args[:sites] if args.key?(:sites) end end # Represents the dimensions of ads, placements, creatives, or creative assets. class Size include Google::Apis::Core::Hashable # Height of this size. Acceptable values are 0 to 32767, inclusive. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # IAB standard size. This is a read-only, auto-generated field. # Corresponds to the JSON property `iab` # @return [Boolean] attr_accessor :iab alias_method :iab?, :iab # ID of this size. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#size". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Width of this size. Acceptable values are 0 to 32767, inclusive. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @iab = args[:iab] if args.key?(:iab) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @width = args[:width] if args.key?(:width) end end # Size List Response class SizesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#sizesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Size collection. # Corresponds to the JSON property `sizes` # @return [Array] attr_accessor :sizes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @sizes = args[:sizes] if args.key?(:sizes) end end # Skippable Settings class SkippableSetting include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#skippableSetting". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Video Offset # Corresponds to the JSON property `progressOffset` # @return [Google::Apis::DfareportingV2_8::VideoOffset] attr_accessor :progress_offset # Video Offset # Corresponds to the JSON property `skipOffset` # @return [Google::Apis::DfareportingV2_8::VideoOffset] attr_accessor :skip_offset # Whether the user can skip creatives served to this placement. # Corresponds to the JSON property `skippable` # @return [Boolean] attr_accessor :skippable alias_method :skippable?, :skippable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @progress_offset = args[:progress_offset] if args.key?(:progress_offset) @skip_offset = args[:skip_offset] if args.key?(:skip_offset) @skippable = args[:skippable] if args.key?(:skippable) end end # Represents a sorted dimension. class SortedDimension include Google::Apis::Core::Hashable # The kind of resource this is, in this case dfareporting#sortedDimension. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the dimension. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An optional sort order for the dimension column. # Corresponds to the JSON property `sortOrder` # @return [String] attr_accessor :sort_order def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @sort_order = args[:sort_order] if args.key?(:sort_order) end end # Contains properties of a DCM subaccount. class Subaccount include Google::Apis::Core::Hashable # ID of the account that contains this subaccount. This is a read-only field # that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # IDs of the available user role permissions for this subaccount. # Corresponds to the JSON property `availablePermissionIds` # @return [Array] attr_accessor :available_permission_ids # ID of this subaccount. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#subaccount". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this subaccount. This is a required field. Must be less than 128 # characters long and be unique among subaccounts of the same account. # 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) @account_id = args[:account_id] if args.key?(:account_id) @available_permission_ids = args[:available_permission_ids] if args.key?(:available_permission_ids) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Subaccount List Response class SubaccountsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#subaccountsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Subaccount collection. # Corresponds to the JSON property `subaccounts` # @return [Array] attr_accessor :subaccounts 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) @subaccounts = args[:subaccounts] if args.key?(:subaccounts) end end # Placement Tag Data class TagData include Google::Apis::Core::Hashable # Ad associated with this placement tag. Applicable only when format is # PLACEMENT_TAG_TRACKING. # Corresponds to the JSON property `adId` # @return [Fixnum] attr_accessor :ad_id # Tag string to record a click. # Corresponds to the JSON property `clickTag` # @return [String] attr_accessor :click_tag # Creative associated with this placement tag. Applicable only when format is # PLACEMENT_TAG_TRACKING. # Corresponds to the JSON property `creativeId` # @return [Fixnum] attr_accessor :creative_id # TagData tag format of this tag. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # Tag string for serving an ad. # Corresponds to the JSON property `impressionTag` # @return [String] attr_accessor :impression_tag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_id = args[:ad_id] if args.key?(:ad_id) @click_tag = args[:click_tag] if args.key?(:click_tag) @creative_id = args[:creative_id] if args.key?(:creative_id) @format = args[:format] if args.key?(:format) @impression_tag = args[:impression_tag] if args.key?(:impression_tag) end end # Tag Settings class TagSetting include Google::Apis::Core::Hashable # Additional key-values to be included in tags. Each key-value pair must be of # the form key=value, and pairs must be separated by a semicolon (;). Keys and # values must not contain commas. For example, id=2;color=red is a valid value # for this field. # Corresponds to the JSON property `additionalKeyValues` # @return [String] attr_accessor :additional_key_values # Whether static landing page URLs should be included in the tags. This setting # applies only to placements. # Corresponds to the JSON property `includeClickThroughUrls` # @return [Boolean] attr_accessor :include_click_through_urls alias_method :include_click_through_urls?, :include_click_through_urls # Whether click-tracking string should be included in the tags. # Corresponds to the JSON property `includeClickTracking` # @return [Boolean] attr_accessor :include_click_tracking alias_method :include_click_tracking?, :include_click_tracking # Option specifying how keywords are embedded in ad tags. This setting can be # used to specify whether keyword placeholders are inserted in placement tags # for this site. Publishers can then add keywords to those placeholders. # Corresponds to the JSON property `keywordOption` # @return [String] attr_accessor :keyword_option def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @additional_key_values = args[:additional_key_values] if args.key?(:additional_key_values) @include_click_through_urls = args[:include_click_through_urls] if args.key?(:include_click_through_urls) @include_click_tracking = args[:include_click_tracking] if args.key?(:include_click_tracking) @keyword_option = args[:keyword_option] if args.key?(:keyword_option) end end # Dynamic and Image Tag Settings. class TagSettings include Google::Apis::Core::Hashable # Whether dynamic floodlight tags are enabled. # Corresponds to the JSON property `dynamicTagEnabled` # @return [Boolean] attr_accessor :dynamic_tag_enabled alias_method :dynamic_tag_enabled?, :dynamic_tag_enabled # Whether image tags are enabled. # Corresponds to the JSON property `imageTagEnabled` # @return [Boolean] attr_accessor :image_tag_enabled alias_method :image_tag_enabled?, :image_tag_enabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dynamic_tag_enabled = args[:dynamic_tag_enabled] if args.key?(:dynamic_tag_enabled) @image_tag_enabled = args[:image_tag_enabled] if args.key?(:image_tag_enabled) end end # Target Window. class TargetWindow include Google::Apis::Core::Hashable # User-entered value. # Corresponds to the JSON property `customHtml` # @return [String] attr_accessor :custom_html # Type of browser window for which the backup image of the flash creative can be # displayed. # Corresponds to the JSON property `targetWindowOption` # @return [String] attr_accessor :target_window_option def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_html = args[:custom_html] if args.key?(:custom_html) @target_window_option = args[:target_window_option] if args.key?(:target_window_option) end end # Contains properties of a targetable remarketing list. Remarketing enables you # to create lists of users who have performed specific actions on a site, then # target ads to members of those lists. This resource is a read-only view of a # remarketing list to be used to faciliate targeting ads to specific lists. # Remarketing lists that are owned by your advertisers and those that are shared # to your advertisers or account are accessible via this resource. To manage # remarketing lists that are owned by your advertisers, use the RemarketingLists # resource. class TargetableRemarketingList include Google::Apis::Core::Hashable # Account ID of this remarketing list. This is a read-only, auto-generated field # that is only returned in GET requests. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this targetable remarketing list is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Dimension value for the advertiser ID that owns this targetable remarketing # list. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Targetable remarketing list description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Targetable remarketing list ID. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#targetableRemarketingList". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Number of days that a user should remain in the targetable remarketing list # without an impression. # Corresponds to the JSON property `lifeSpan` # @return [Fixnum] attr_accessor :life_span # Number of users currently in the list. This is a read-only field. # Corresponds to the JSON property `listSize` # @return [Fixnum] attr_accessor :list_size # Product from which this targetable remarketing list was originated. # Corresponds to the JSON property `listSource` # @return [String] attr_accessor :list_source # Name of the targetable remarketing list. Is no greater than 128 characters # long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this remarketing list. This is a read-only, auto-generated # field that is only returned in GET requests. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @life_span = args[:life_span] if args.key?(:life_span) @list_size = args[:list_size] if args.key?(:list_size) @list_source = args[:list_source] if args.key?(:list_source) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Targetable remarketing list response class TargetableRemarketingListsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#targetableRemarketingListsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Targetable remarketing list collection. # Corresponds to the JSON property `targetableRemarketingLists` # @return [Array] attr_accessor :targetable_remarketing_lists 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) @targetable_remarketing_lists = args[:targetable_remarketing_lists] if args.key?(:targetable_remarketing_lists) end end # Contains properties of a targeting template. A targeting template encapsulates # targeting information which can be reused across multiple ads. class TargetingTemplate include Google::Apis::Core::Hashable # Account ID of this targeting template. This field, if left unset, will be auto- # generated on insert and is read-only after insert. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this targeting template. This is a required field on insert # and is read-only after insert. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV2_8::DimensionValue] attr_accessor :advertiser_id_dimension_value # Day Part Targeting. # Corresponds to the JSON property `dayPartTargeting` # @return [Google::Apis::DfareportingV2_8::DayPartTargeting] attr_accessor :day_part_targeting # Geographical Targeting. # Corresponds to the JSON property `geoTargeting` # @return [Google::Apis::DfareportingV2_8::GeoTargeting] attr_accessor :geo_targeting # ID of this targeting template. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Key Value Targeting Expression. # Corresponds to the JSON property `keyValueTargetingExpression` # @return [Google::Apis::DfareportingV2_8::KeyValueTargetingExpression] attr_accessor :key_value_targeting_expression # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#targetingTemplate". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Language Targeting. # Corresponds to the JSON property `languageTargeting` # @return [Google::Apis::DfareportingV2_8::LanguageTargeting] attr_accessor :language_targeting # Remarketing List Targeting Expression. # Corresponds to the JSON property `listTargetingExpression` # @return [Google::Apis::DfareportingV2_8::ListTargetingExpression] attr_accessor :list_targeting_expression # Name of this targeting template. This field is required. It must be less than # 256 characters long and unique within an advertiser. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this targeting template. This field, if left unset, will be # auto-generated on insert and is read-only after insert. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Technology Targeting. # Corresponds to the JSON property `technologyTargeting` # @return [Google::Apis::DfareportingV2_8::TechnologyTargeting] attr_accessor :technology_targeting def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @day_part_targeting = args[:day_part_targeting] if args.key?(:day_part_targeting) @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting) @id = args[:id] if args.key?(:id) @key_value_targeting_expression = args[:key_value_targeting_expression] if args.key?(:key_value_targeting_expression) @kind = args[:kind] if args.key?(:kind) @language_targeting = args[:language_targeting] if args.key?(:language_targeting) @list_targeting_expression = args[:list_targeting_expression] if args.key?(:list_targeting_expression) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @technology_targeting = args[:technology_targeting] if args.key?(:technology_targeting) end end # Targeting Template List Response class TargetingTemplatesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#targetingTemplatesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Targeting template collection. # Corresponds to the JSON property `targetingTemplates` # @return [Array] attr_accessor :targeting_templates 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) @targeting_templates = args[:targeting_templates] if args.key?(:targeting_templates) end end # Technology Targeting. class TechnologyTargeting include Google::Apis::Core::Hashable # Browsers that this ad targets. For each browser either set browserVersionId or # dartId along with the version numbers. If both are specified, only # browserVersionId will be used. The other fields are populated automatically # when the ad is inserted or updated. # Corresponds to the JSON property `browsers` # @return [Array] attr_accessor :browsers # Connection types that this ad targets. For each connection type only id is # required. The other fields are populated automatically when the ad is inserted # or updated. # Corresponds to the JSON property `connectionTypes` # @return [Array] attr_accessor :connection_types # Mobile carriers that this ad targets. For each mobile carrier only id is # required, and the other fields are populated automatically when the ad is # inserted or updated. If targeting a mobile carrier, do not set targeting for # any zip codes. # Corresponds to the JSON property `mobileCarriers` # @return [Array] attr_accessor :mobile_carriers # Operating system versions that this ad targets. To target all versions, use # operatingSystems. For each operating system version, only id is required. The # other fields are populated automatically when the ad is inserted or updated. # If targeting an operating system version, do not set targeting for the # corresponding operating system in operatingSystems. # Corresponds to the JSON property `operatingSystemVersions` # @return [Array] attr_accessor :operating_system_versions # Operating systems that this ad targets. To target specific versions, use # operatingSystemVersions. For each operating system only dartId is required. # The other fields are populated automatically when the ad is inserted or # updated. If targeting an operating system, do not set targeting for operating # system versions for the same operating system. # Corresponds to the JSON property `operatingSystems` # @return [Array] attr_accessor :operating_systems # Platform types that this ad targets. For example, desktop, mobile, or tablet. # For each platform type, only id is required, and the other fields are # populated automatically when the ad is inserted or updated. # Corresponds to the JSON property `platformTypes` # @return [Array] attr_accessor :platform_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @browsers = args[:browsers] if args.key?(:browsers) @connection_types = args[:connection_types] if args.key?(:connection_types) @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers) @operating_system_versions = args[:operating_system_versions] if args.key?(:operating_system_versions) @operating_systems = args[:operating_systems] if args.key?(:operating_systems) @platform_types = args[:platform_types] if args.key?(:platform_types) end end # Third Party Authentication Token class ThirdPartyAuthenticationToken include Google::Apis::Core::Hashable # Name of the third-party authentication token. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Value of the third-party authentication token. This is a read-only, auto- # generated field. # 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 # Third-party Tracking URL. class ThirdPartyTrackingUrl include Google::Apis::Core::Hashable # Third-party URL type for in-stream video creatives. # Corresponds to the JSON property `thirdPartyUrlType` # @return [String] attr_accessor :third_party_url_type # URL for the specified third-party URL type. # 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) @third_party_url_type = args[:third_party_url_type] if args.key?(:third_party_url_type) @url = args[:url] if args.key?(:url) end end # Transcode Settings class TranscodeSetting include Google::Apis::Core::Hashable # Whitelist of video formats to be served to this placement. Set this list to # null or empty to serve all video formats. # Corresponds to the JSON property `enabledVideoFormats` # @return [Array] attr_accessor :enabled_video_formats # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#transcodeSetting". # 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) @enabled_video_formats = args[:enabled_video_formats] if args.key?(:enabled_video_formats) @kind = args[:kind] if args.key?(:kind) end end # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following # creative types: INSTREAM_VIDEO and VPAID. class UniversalAdId include Google::Apis::Core::Hashable # Registry used for the Ad ID value. # Corresponds to the JSON property `registry` # @return [String] attr_accessor :registry # ID value for this creative. Only alphanumeric characters and the following # symbols are valid: "_/\-". Maximum length is 64 characters. Read only when # registry is DCM. # 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) @registry = args[:registry] if args.key?(:registry) @value = args[:value] if args.key?(:value) end end # User Defined Variable configuration. class UserDefinedVariableConfiguration include Google::Apis::Core::Hashable # Data type for the variable. This is a required field. # Corresponds to the JSON property `dataType` # @return [String] attr_accessor :data_type # User-friendly name for the variable which will appear in reports. This is a # required field, must be less than 64 characters long, and cannot contain the # following characters: ""<>". # Corresponds to the JSON property `reportName` # @return [String] attr_accessor :report_name # Variable name in the tag. This is a required field. # Corresponds to the JSON property `variableType` # @return [String] attr_accessor :variable_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data_type = args[:data_type] if args.key?(:data_type) @report_name = args[:report_name] if args.key?(:report_name) @variable_type = args[:variable_type] if args.key?(:variable_type) end end # Represents a UserProfile resource. class UserProfile include Google::Apis::Core::Hashable # The account ID to which this profile belongs. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # The account name this profile belongs to. # Corresponds to the JSON property `accountName` # @return [String] attr_accessor :account_name # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The kind of resource this is, in this case dfareporting#userProfile. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The unique ID of the user profile. # Corresponds to the JSON property `profileId` # @return [Fixnum] attr_accessor :profile_id # The sub account ID this profile belongs to if applicable. # Corresponds to the JSON property `subAccountId` # @return [Fixnum] attr_accessor :sub_account_id # The sub account name this profile belongs to if applicable. # Corresponds to the JSON property `subAccountName` # @return [String] attr_accessor :sub_account_name # The user name. # 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) @account_id = args[:account_id] if args.key?(:account_id) @account_name = args[:account_name] if args.key?(:account_name) @etag = args[:etag] if args.key?(:etag) @kind = args[:kind] if args.key?(:kind) @profile_id = args[:profile_id] if args.key?(:profile_id) @sub_account_id = args[:sub_account_id] if args.key?(:sub_account_id) @sub_account_name = args[:sub_account_name] if args.key?(:sub_account_name) @user_name = args[:user_name] if args.key?(:user_name) end end # Represents the list of user profiles. class UserProfileList include Google::Apis::Core::Hashable # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The user profiles returned in this response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of list this is, in this case dfareporting#userProfileList. # 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) @etag = args[:etag] if args.key?(:etag) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # Contains properties of auser role, which is used to manage user access. class UserRole include Google::Apis::Core::Hashable # Account ID of this user role. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this is a default user role. Default user roles are created by the # system for the account/subaccount and cannot be modified or deleted. Each # default user role comes with a basic set of preassigned permissions. # Corresponds to the JSON property `defaultUserRole` # @return [Boolean] attr_accessor :default_user_role alias_method :default_user_role?, :default_user_role # ID of this user role. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRole". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this user role. This is a required field. Must be less than 256 # characters long. If this user role is under a subaccount, the name must be # unique among sites of the same subaccount. Otherwise, this user role is a top- # level user role, and the name must be unique among top-level user roles of the # same account. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # ID of the user role that this user role is based on or copied from. This is a # required field. # Corresponds to the JSON property `parentUserRoleId` # @return [Fixnum] attr_accessor :parent_user_role_id # List of permissions associated with this user role. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions # Subaccount ID of this user role. This is a read-only field that can be left # blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @default_user_role = args[:default_user_role] if args.key?(:default_user_role) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @parent_user_role_id = args[:parent_user_role_id] if args.key?(:parent_user_role_id) @permissions = args[:permissions] if args.key?(:permissions) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Contains properties of a user role permission. class UserRolePermission include Google::Apis::Core::Hashable # Levels of availability for a user role permission. # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability # ID of this user role permission. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRolePermission". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this user role permission. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # ID of the permission group that this user role permission belongs to. # Corresponds to the JSON property `permissionGroupId` # @return [Fixnum] attr_accessor :permission_group_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @availability = args[:availability] if args.key?(:availability) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @permission_group_id = args[:permission_group_id] if args.key?(:permission_group_id) end end # Represents a grouping of related user role permissions. class UserRolePermissionGroup include Google::Apis::Core::Hashable # ID of this user role permission. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRolePermissionGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this user role permission 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # User Role Permission Group List Response class UserRolePermissionGroupsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRolePermissionGroupsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # User role permission group collection. # Corresponds to the JSON property `userRolePermissionGroups` # @return [Array] attr_accessor :user_role_permission_groups def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @user_role_permission_groups = args[:user_role_permission_groups] if args.key?(:user_role_permission_groups) end end # User Role Permission List Response class UserRolePermissionsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRolePermissionsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # User role permission collection. # Corresponds to the JSON property `userRolePermissions` # @return [Array] attr_accessor :user_role_permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @user_role_permissions = args[:user_role_permissions] if args.key?(:user_role_permissions) end end # User Role List Response class UserRolesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRolesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # User role collection. # Corresponds to the JSON property `userRoles` # @return [Array] attr_accessor :user_roles 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) @user_roles = args[:user_roles] if args.key?(:user_roles) end end # Contains information about supported video formats. class VideoFormat include Google::Apis::Core::Hashable # File type of the video format. # Corresponds to the JSON property `fileType` # @return [String] attr_accessor :file_type # ID of the video format. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#videoFormat". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `resolution` # @return [Google::Apis::DfareportingV2_8::Size] attr_accessor :resolution # The target bit rate of this video format. # Corresponds to the JSON property `targetBitRate` # @return [Fixnum] attr_accessor :target_bit_rate def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file_type = args[:file_type] if args.key?(:file_type) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @resolution = args[:resolution] if args.key?(:resolution) @target_bit_rate = args[:target_bit_rate] if args.key?(:target_bit_rate) end end # Video Format List Response class VideoFormatsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#videoFormatsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Video format collection. # Corresponds to the JSON property `videoFormats` # @return [Array] attr_accessor :video_formats def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @video_formats = args[:video_formats] if args.key?(:video_formats) end end # Video Offset class VideoOffset include Google::Apis::Core::Hashable # Duration, as a percentage of video duration. Do not set when offsetSeconds is # set. Acceptable values are 0 to 100, inclusive. # Corresponds to the JSON property `offsetPercentage` # @return [Fixnum] attr_accessor :offset_percentage # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable # values are 0 to 86399, inclusive. # Corresponds to the JSON property `offsetSeconds` # @return [Fixnum] attr_accessor :offset_seconds def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @offset_percentage = args[:offset_percentage] if args.key?(:offset_percentage) @offset_seconds = args[:offset_seconds] if args.key?(:offset_seconds) end end # Video Settings class VideoSettings include Google::Apis::Core::Hashable # Companion Settings # Corresponds to the JSON property `companionSettings` # @return [Google::Apis::DfareportingV2_8::CompanionSetting] attr_accessor :companion_settings # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#videoSettings". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Skippable Settings # Corresponds to the JSON property `skippableSettings` # @return [Google::Apis::DfareportingV2_8::SkippableSetting] attr_accessor :skippable_settings # Transcode Settings # Corresponds to the JSON property `transcodeSettings` # @return [Google::Apis::DfareportingV2_8::TranscodeSetting] attr_accessor :transcode_settings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @companion_settings = args[:companion_settings] if args.key?(:companion_settings) @kind = args[:kind] if args.key?(:kind) @skippable_settings = args[:skippable_settings] if args.key?(:skippable_settings) @transcode_settings = args[:transcode_settings] if args.key?(:transcode_settings) end end end end end google-api-client-0.19.8/generated/google/apis/dfareporting_v2_8/service.rb0000644000004100000410000213766513252673043026646 0ustar www-datawww-data# 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 DfareportingV2_8 # DCM/DFA Reporting And Trafficking API # # Manages your DoubleClick Campaign Manager ad campaigns and reports. # # @example # require 'google/apis/dfareporting_v2_8' # # Dfareporting = Google::Apis::DfareportingV2_8 # Alias the module # service = Dfareporting::DfareportingService.new # # @see https://developers.google.com/doubleclick-advertisers/ class DfareportingService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'dfareporting/v2.8/') @batch_path = 'batch/dfareporting/v2.8' end # Gets the account's active ad summary by account ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] summary_account_id # Account 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountActiveAdSummary] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountActiveAdSummary] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_active_ad_summary(profile_id, summary_account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}', options) command.response_representation = Google::Apis::DfareportingV2_8::AccountActiveAdSummary::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountActiveAdSummary command.params['profileId'] = profile_id unless profile_id.nil? command.params['summaryAccountId'] = summary_account_id unless summary_account_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 one account permission group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Account permission group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountPermissionGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountPermissionGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::AccountPermissionGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountPermissionGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 the list of account permission groups. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountPermissionGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountPermissionGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups', options) command.response_representation = Google::Apis::DfareportingV2_8::AccountPermissionGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountPermissionGroupsListResponse command.params['profileId'] = profile_id unless profile_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 one account permission by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Account permission 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountPermission] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountPermission] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::AccountPermission::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountPermission command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 the list of account permissions. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountPermissionsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountPermissionsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_permissions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions', options) command.response_representation = Google::Apis::DfareportingV2_8::AccountPermissionsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountPermissionsListResponse command.params['profileId'] = profile_id unless profile_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 one account user profile by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User profile 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountUserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_profile(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountUserProfile command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new account user profile. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::AccountUserProfile] account_user_profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountUserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/accountUserProfiles', options) command.request_representation = Google::Apis::DfareportingV2_8::AccountUserProfile::Representation command.request_object = account_user_profile_object command.response_representation = Google::Apis::DfareportingV2_8::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountUserProfile command.params['profileId'] = profile_id unless profile_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 account user profiles, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active user profiles. # @param [Array, Fixnum] ids # Select only user profiles with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name, ID or email. Wildcards (*) are allowed. # For example, "user profile*2015" will return objects with names like "user # profile June 2015", "user profile April 2015", or simply "user profile 2015". # Most of the searches also add wildcards implicitly at the start and the end of # the search string. For example, a search string of "user profile" will match # objects with name "my user profile", "user profile 2015", or simply "user # profile". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] subaccount_id # Select only user profiles with the specified subaccount ID. # @param [Fixnum] user_role_id # Select only user profiles with the specified user role 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountUserProfilesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountUserProfilesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_profiles(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, user_role_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles', options) command.response_representation = Google::Apis::DfareportingV2_8::AccountUserProfilesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountUserProfilesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? command.query['userRoleId'] = user_role_id unless user_role_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 an existing account user profile. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User profile ID. # @param [Google::Apis::DfareportingV2_8::AccountUserProfile] account_user_profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountUserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_profile(profile_id, id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/accountUserProfiles', options) command.request_representation = Google::Apis::DfareportingV2_8::AccountUserProfile::Representation command.request_object = account_user_profile_object command.response_representation = Google::Apis::DfareportingV2_8::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountUserProfile command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing account user profile. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::AccountUserProfile] account_user_profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountUserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/accountUserProfiles', options) command.request_representation = Google::Apis::DfareportingV2_8::AccountUserProfile::Representation command.request_object = account_user_profile_object command.response_representation = Google::Apis::DfareportingV2_8::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountUserProfile command.params['profileId'] = profile_id unless profile_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 one account by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Account 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accounts/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Account::Representation command.response_class = Google::Apis::DfareportingV2_8::Account command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 the list of accounts, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active accounts. Don't set this field to select both active and # non-active accounts. # @param [Array, Fixnum] ids # Select only accounts with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "account*2015" will return objects with names like "account June 2015" # , "account April 2015", or simply "account 2015". Most of the searches also # add wildcards implicitly at the start and the end of the search string. For # example, a search string of "account" will match objects with name "my account" # , "account 2015", or simply "account". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AccountsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AccountsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_accounts(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accounts', options) command.response_representation = Google::Apis::DfareportingV2_8::AccountsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::AccountsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 account. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Account ID. # @param [Google::Apis::DfareportingV2_8::Account] account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(profile_id, id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/accounts', options) command.request_representation = Google::Apis::DfareportingV2_8::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::DfareportingV2_8::Account::Representation command.response_class = Google::Apis::DfareportingV2_8::Account command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing account. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::Account] account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(profile_id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/accounts', options) command.request_representation = Google::Apis::DfareportingV2_8::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::DfareportingV2_8::Account::Representation command.response_class = Google::Apis::DfareportingV2_8::Account command.params['profileId'] = profile_id unless profile_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 one ad by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Ad 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Ad] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ad(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/ads/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Ad::Representation command.response_class = Google::Apis::DfareportingV2_8::Ad command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new ad. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::Ad] ad_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Ad] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/ads', options) command.request_representation = Google::Apis::DfareportingV2_8::Ad::Representation command.request_object = ad_object command.response_representation = Google::Apis::DfareportingV2_8::Ad::Representation command.response_class = Google::Apis::DfareportingV2_8::Ad command.params['profileId'] = profile_id unless profile_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 ads, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active ads. # @param [Fixnum] advertiser_id # Select only ads with this advertiser ID. # @param [Boolean] archived # Select only archived ads. # @param [Array, Fixnum] audience_segment_ids # Select only ads with these audience segment IDs. # @param [Array, Fixnum] campaign_ids # Select only ads with these campaign IDs. # @param [String] compatibility # Select default ads with the specified compatibility. Applicable when type is # AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering # either on desktop or on mobile devices for regular or interstitial ads, # respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. # IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the # VAST standard. # @param [Array, Fixnum] creative_ids # Select only ads with these creative IDs assigned. # @param [Array, Fixnum] creative_optimization_configuration_ids # Select only ads with these creative optimization configuration IDs. # @param [Boolean] dynamic_click_tracker # Select only dynamic click trackers. Applicable when type is # AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, # select static click trackers. Leave unset to select both. # @param [Array, Fixnum] ids # Select only ads with these IDs. # @param [Array, Fixnum] landing_page_ids # Select only ads with these landing page IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Fixnum] overridden_event_tag_id # Select only ads with this event tag override ID. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Array, Fixnum] placement_ids # Select only ads with these placement IDs assigned. # @param [Array, Fixnum] remarketing_list_ids # Select only ads whose list targeting expression use these remarketing list IDs. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "ad*2015" will return objects with names like "ad June 2015", "ad # April 2015", or simply "ad 2015". Most of the searches also add wildcards # implicitly at the start and the end of the search string. For example, a # search string of "ad" will match objects with name "my ad", "ad 2015", or # simply "ad". # @param [Array, Fixnum] size_ids # Select only ads with these size IDs. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Boolean] ssl_compliant # Select only ads that are SSL-compliant. # @param [Boolean] ssl_required # Select only ads that require SSL. # @param [Array, String] type # Select only ads with these types. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AdsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AdsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ads(profile_id, active: nil, advertiser_id: nil, archived: nil, audience_segment_ids: nil, campaign_ids: nil, compatibility: nil, creative_ids: nil, creative_optimization_configuration_ids: nil, dynamic_click_tracker: nil, ids: nil, landing_page_ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, placement_ids: nil, remarketing_list_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, ssl_compliant: nil, ssl_required: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/ads', options) command.response_representation = Google::Apis::DfareportingV2_8::AdsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::AdsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['archived'] = archived unless archived.nil? command.query['audienceSegmentIds'] = audience_segment_ids unless audience_segment_ids.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['compatibility'] = compatibility unless compatibility.nil? command.query['creativeIds'] = creative_ids unless creative_ids.nil? command.query['creativeOptimizationConfigurationIds'] = creative_optimization_configuration_ids unless creative_optimization_configuration_ids.nil? command.query['dynamicClickTracker'] = dynamic_click_tracker unless dynamic_click_tracker.nil? command.query['ids'] = ids unless ids.nil? command.query['landingPageIds'] = landing_page_ids unless landing_page_ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['overriddenEventTagId'] = overridden_event_tag_id unless overridden_event_tag_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['placementIds'] = placement_ids unless placement_ids.nil? command.query['remarketingListIds'] = remarketing_list_ids unless remarketing_list_ids.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sizeIds'] = size_ids unless size_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['sslCompliant'] = ssl_compliant unless ssl_compliant.nil? command.query['sslRequired'] = ssl_required unless ssl_required.nil? command.query['type'] = type unless 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 an existing ad. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Ad ID. # @param [Google::Apis::DfareportingV2_8::Ad] ad_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Ad] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ad(profile_id, id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/ads', options) command.request_representation = Google::Apis::DfareportingV2_8::Ad::Representation command.request_object = ad_object command.response_representation = Google::Apis::DfareportingV2_8::Ad::Representation command.response_class = Google::Apis::DfareportingV2_8::Ad command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing ad. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::Ad] ad_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Ad] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/ads', options) command.request_representation = Google::Apis::DfareportingV2_8::Ad::Representation command.request_object = ad_object command.response_representation = Google::Apis::DfareportingV2_8::Ad::Representation command.response_class = Google::Apis::DfareportingV2_8::Ad command.params['profileId'] = profile_id unless profile_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 existing advertiser group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Advertiser group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_advertiser_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/advertiserGroups/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one advertiser group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Advertiser group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AdvertiserGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::AdvertiserGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new advertiser group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::AdvertiserGroup] advertiser_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AdvertiserGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/advertiserGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation command.request_object = advertiser_group_object command.response_representation = Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::AdvertiserGroup command.params['profileId'] = profile_id unless profile_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 advertiser groups, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Select only advertiser groups with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "advertiser*2015" will return objects with names like "advertiser # group June 2015", "advertiser group April 2015", or simply "advertiser group # 2015". Most of the searches also add wildcards implicitly at the start and the # end of the search string. For example, a search string of "advertisergroup" # will match objects with name "my advertisergroup", "advertisergroup 2015", or # simply "advertisergroup". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertiserGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AdvertiserGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_groups(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups', options) command.response_representation = Google::Apis::DfareportingV2_8::AdvertiserGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::AdvertiserGroupsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 advertiser group. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Advertiser group ID. # @param [Google::Apis::DfareportingV2_8::AdvertiserGroup] advertiser_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AdvertiserGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(profile_id, id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/advertiserGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation command.request_object = advertiser_group_object command.response_representation = Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::AdvertiserGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing advertiser group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::AdvertiserGroup] advertiser_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AdvertiserGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/advertiserGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation command.request_object = advertiser_group_object command.response_representation = Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::AdvertiserGroup command.params['profileId'] = profile_id unless profile_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 one advertiser by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Advertiser 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/advertisers/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Advertiser::Representation command.response_class = Google::Apis::DfareportingV2_8::Advertiser command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new advertiser. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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 insert_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/advertisers', options) command.request_representation = Google::Apis::DfareportingV2_8::Advertiser::Representation command.request_object = advertiser_object command.response_representation = Google::Apis::DfareportingV2_8::Advertiser::Representation command.response_class = Google::Apis::DfareportingV2_8::Advertiser command.params['profileId'] = profile_id unless profile_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 advertisers, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_group_ids # Select only advertisers with these advertiser group IDs. # @param [Array, Fixnum] floodlight_configuration_ids # Select only advertisers with these floodlight configuration IDs. # @param [Array, Fixnum] ids # Select only advertisers with these IDs. # @param [Boolean] include_advertisers_without_groups_only # Select only advertisers which do not belong to any advertiser group. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Boolean] only_parent # Select only advertisers which use another advertiser's floodlight # configuration. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "advertiser*2015" will return objects with names like "advertiser # June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the # searches also add wildcards implicitly at the start and the end of the search # string. For example, a search string of "advertiser" will match objects with # name "my advertiser", "advertiser 2015", or simply "advertiser". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [String] status # Select only advertisers with the specified status. # @param [Fixnum] subaccount_id # Select only advertisers with these subaccount IDs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertisersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::AdvertisersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(profile_id, advertiser_group_ids: nil, floodlight_configuration_ids: nil, ids: nil, include_advertisers_without_groups_only: nil, max_results: nil, only_parent: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, status: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/advertisers', options) command.response_representation = Google::Apis::DfareportingV2_8::AdvertisersListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::AdvertisersListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserGroupIds'] = advertiser_group_ids unless advertiser_group_ids.nil? command.query['floodlightConfigurationIds'] = floodlight_configuration_ids unless floodlight_configuration_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['includeAdvertisersWithoutGroupsOnly'] = include_advertisers_without_groups_only unless include_advertisers_without_groups_only.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['onlyParent'] = only_parent unless only_parent.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['status'] = status unless status.nil? command.query['subaccountId'] = subaccount_id unless subaccount_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 an existing advertiser. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Advertiser ID. # @param [Google::Apis::DfareportingV2_8::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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(profile_id, id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/advertisers', options) command.request_representation = Google::Apis::DfareportingV2_8::Advertiser::Representation command.request_object = advertiser_object command.response_representation = Google::Apis::DfareportingV2_8::Advertiser::Representation command.response_class = Google::Apis::DfareportingV2_8::Advertiser command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing advertiser. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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 update_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/advertisers', options) command.request_representation = Google::Apis::DfareportingV2_8::Advertiser::Representation command.request_object = advertiser_object command.response_representation = Google::Apis::DfareportingV2_8::Advertiser::Representation command.response_class = Google::Apis::DfareportingV2_8::Advertiser command.params['profileId'] = profile_id unless profile_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 browsers. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::BrowsersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::BrowsersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_browsers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/browsers', options) command.response_representation = Google::Apis::DfareportingV2_8::BrowsersListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::BrowsersListResponse command.params['profileId'] = profile_id unless profile_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 # Associates a creative with the specified campaign. This method creates a # default ad with dimensions matching the creative in the campaign if such a # default ad does not exist already. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Campaign ID in this association. # @param [Google::Apis::DfareportingV2_8::CampaignCreativeAssociation] campaign_creative_association_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CampaignCreativeAssociation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CampaignCreativeAssociation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_campaign_creative_association(profile_id, campaign_id, campaign_creative_association_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options) command.request_representation = Google::Apis::DfareportingV2_8::CampaignCreativeAssociation::Representation command.request_object = campaign_creative_association_object command.response_representation = Google::Apis::DfareportingV2_8::CampaignCreativeAssociation::Representation command.response_class = Google::Apis::DfareportingV2_8::CampaignCreativeAssociation command.params['profileId'] = profile_id unless profile_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves the list of creative IDs associated with the specified campaign. # This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Campaign ID in this association. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CampaignCreativeAssociationsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CampaignCreativeAssociationsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_campaign_creative_associations(profile_id, campaign_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options) command.response_representation = Google::Apis::DfareportingV2_8::CampaignCreativeAssociationsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::CampaignCreativeAssociationsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one campaign by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Campaign 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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_campaign(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Campaign::Representation command.response_class = Google::Apis::DfareportingV2_8::Campaign command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new campaign. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [String] default_landing_page_name # Default landing page name for this new campaign. Must be less than 256 # characters long. # @param [String] default_landing_page_url # Default landing page URL for this new campaign. # @param [Google::Apis::DfareportingV2_8::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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 insert_campaign(profile_id, default_landing_page_name, default_landing_page_url, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns', options) command.request_representation = Google::Apis::DfareportingV2_8::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::DfareportingV2_8::Campaign::Representation command.response_class = Google::Apis::DfareportingV2_8::Campaign command.params['profileId'] = profile_id unless profile_id.nil? command.query['defaultLandingPageName'] = default_landing_page_name unless default_landing_page_name.nil? command.query['defaultLandingPageUrl'] = default_landing_page_url unless default_landing_page_url.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 campaigns, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_group_ids # Select only campaigns whose advertisers belong to these advertiser groups. # @param [Array, Fixnum] advertiser_ids # Select only campaigns that belong to these advertisers. # @param [Boolean] archived # Select only archived campaigns. Don't set this field to select both archived # and non-archived campaigns. # @param [Boolean] at_least_one_optimization_activity # Select only campaigns that have at least one optimization activity. # @param [Array, Fixnum] excluded_ids # Exclude campaigns with these IDs. # @param [Array, Fixnum] ids # Select only campaigns with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Fixnum] overridden_event_tag_id # Select only campaigns that have overridden this event tag ID. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For # example, "campaign*2015" will return campaigns with names like "campaign June # 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "campaign" will match campaigns with name "my # campaign", "campaign 2015", or simply "campaign". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] subaccount_id # Select only campaigns that belong to this subaccount. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CampaignsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CampaignsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_campaigns(profile_id, advertiser_group_ids: nil, advertiser_ids: nil, archived: nil, at_least_one_optimization_activity: nil, excluded_ids: nil, ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns', options) command.response_representation = Google::Apis::DfareportingV2_8::CampaignsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::CampaignsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserGroupIds'] = advertiser_group_ids unless advertiser_group_ids.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['archived'] = archived unless archived.nil? command.query['atLeastOneOptimizationActivity'] = at_least_one_optimization_activity unless at_least_one_optimization_activity.nil? command.query['excludedIds'] = excluded_ids unless excluded_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['overriddenEventTagId'] = overridden_event_tag_id unless overridden_event_tag_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_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 an existing campaign. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Campaign ID. # @param [Google::Apis::DfareportingV2_8::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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_campaign(profile_id, id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/campaigns', options) command.request_representation = Google::Apis::DfareportingV2_8::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::DfareportingV2_8::Campaign::Representation command.response_class = Google::Apis::DfareportingV2_8::Campaign command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing campaign. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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 update_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/campaigns', options) command.request_representation = Google::Apis::DfareportingV2_8::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::DfareportingV2_8::Campaign::Representation command.response_class = Google::Apis::DfareportingV2_8::Campaign command.params['profileId'] = profile_id unless profile_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 one change log by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Change log 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ChangeLog] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ChangeLog] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_change_log(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/changeLogs/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::ChangeLog::Representation command.response_class = Google::Apis::DfareportingV2_8::ChangeLog command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 change logs. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [String] action # Select only change logs with the specified action. # @param [Array, Fixnum] ids # Select only change logs with these IDs. # @param [String] max_change_time # Select only change logs whose change time is before the specified # maxChangeTime.The time should be formatted as an RFC3339 date/time string. For # example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, # the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, # day, the letter T, the hour (24-hour clock system), minute, second, and then # the time zone offset. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] min_change_time # Select only change logs whose change time is before the specified # minChangeTime.The time should be formatted as an RFC3339 date/time string. For # example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, # the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, # day, the letter T, the hour (24-hour clock system), minute, second, and then # the time zone offset. # @param [Array, Fixnum] object_ids # Select only change logs with these object IDs. # @param [String] object_type # Select only change logs with the specified object type. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Select only change logs whose object ID, user name, old or new values match # the search string. # @param [Array, Fixnum] user_profile_ids # Select only change logs with these user profile IDs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ChangeLogsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ChangeLogsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_change_logs(profile_id, action: nil, ids: nil, max_change_time: nil, max_results: nil, min_change_time: nil, object_ids: nil, object_type: nil, page_token: nil, search_string: nil, user_profile_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/changeLogs', options) command.response_representation = Google::Apis::DfareportingV2_8::ChangeLogsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::ChangeLogsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['action'] = action unless action.nil? command.query['ids'] = ids unless ids.nil? command.query['maxChangeTime'] = max_change_time unless max_change_time.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['minChangeTime'] = min_change_time unless min_change_time.nil? command.query['objectIds'] = object_ids unless object_ids.nil? command.query['objectType'] = object_type unless object_type.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['userProfileIds'] = user_profile_ids unless user_profile_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 a list of cities, possibly filtered. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] country_dart_ids # Select only cities from these countries. # @param [Array, Fixnum] dart_ids # Select only cities with these DART IDs. # @param [String] name_prefix # Select only cities with names starting with this prefix. # @param [Array, Fixnum] region_dart_ids # Select only cities from these regions. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CitiesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CitiesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_cities(profile_id, country_dart_ids: nil, dart_ids: nil, name_prefix: nil, region_dart_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/cities', options) command.response_representation = Google::Apis::DfareportingV2_8::CitiesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::CitiesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['countryDartIds'] = country_dart_ids unless country_dart_ids.nil? command.query['dartIds'] = dart_ids unless dart_ids.nil? command.query['namePrefix'] = name_prefix unless name_prefix.nil? command.query['regionDartIds'] = region_dart_ids unless region_dart_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 # Gets one connection type by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Connection type 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ConnectionType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ConnectionType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_connection_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::ConnectionType::Representation command.response_class = Google::Apis::DfareportingV2_8::ConnectionType command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 connection types. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ConnectionTypesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ConnectionTypesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_connection_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes', options) command.response_representation = Google::Apis::DfareportingV2_8::ConnectionTypesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::ConnectionTypesListResponse command.params['profileId'] = profile_id unless profile_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 existing content category. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Content category 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/contentCategories/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one content category by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Content category 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ContentCategory] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/contentCategories/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV2_8::ContentCategory command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new content category. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::ContentCategory] content_category_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ContentCategory] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/contentCategories', options) command.request_representation = Google::Apis::DfareportingV2_8::ContentCategory::Representation command.request_object = content_category_object command.response_representation = Google::Apis::DfareportingV2_8::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV2_8::ContentCategory command.params['profileId'] = profile_id unless profile_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 content categories, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Select only content categories with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "contentcategory*2015" will return objects with names like " # contentcategory June 2015", "contentcategory April 2015", or simply " # contentcategory 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # contentcategory" will match objects with name "my contentcategory", " # contentcategory 2015", or simply "contentcategory". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ContentCategoriesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ContentCategoriesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_categories(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/contentCategories', options) command.response_representation = Google::Apis::DfareportingV2_8::ContentCategoriesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::ContentCategoriesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 content category. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Content category ID. # @param [Google::Apis::DfareportingV2_8::ContentCategory] content_category_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ContentCategory] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_category(profile_id, id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/contentCategories', options) command.request_representation = Google::Apis::DfareportingV2_8::ContentCategory::Representation command.request_object = content_category_object command.response_representation = Google::Apis::DfareportingV2_8::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV2_8::ContentCategory command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing content category. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::ContentCategory] content_category_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ContentCategory] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/contentCategories', options) command.request_representation = Google::Apis::DfareportingV2_8::ContentCategory::Representation command.request_object = content_category_object command.response_representation = Google::Apis::DfareportingV2_8::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV2_8::ContentCategory command.params['profileId'] = profile_id unless profile_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 # Inserts conversions. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::ConversionsBatchInsertRequest] conversions_batch_insert_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ConversionsBatchInsertResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ConversionsBatchInsertResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def batchinsert_conversion(profile_id, conversions_batch_insert_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/conversions/batchinsert', options) command.request_representation = Google::Apis::DfareportingV2_8::ConversionsBatchInsertRequest::Representation command.request_object = conversions_batch_insert_request_object command.response_representation = Google::Apis::DfareportingV2_8::ConversionsBatchInsertResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::ConversionsBatchInsertResponse command.params['profileId'] = profile_id unless profile_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 existing conversions. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::ConversionsBatchUpdateRequest] conversions_batch_update_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ConversionsBatchUpdateResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ConversionsBatchUpdateResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def batchupdate_conversion(profile_id, conversions_batch_update_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/conversions/batchupdate', options) command.request_representation = Google::Apis::DfareportingV2_8::ConversionsBatchUpdateRequest::Representation command.request_object = conversions_batch_update_request_object command.response_representation = Google::Apis::DfareportingV2_8::ConversionsBatchUpdateResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::ConversionsBatchUpdateResponse command.params['profileId'] = profile_id unless profile_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 one country by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] dart_id # Country DART 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Country] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Country] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_country(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/countries/{dartId}', options) command.response_representation = Google::Apis::DfareportingV2_8::Country::Representation command.response_class = Google::Apis::DfareportingV2_8::Country command.params['profileId'] = profile_id unless profile_id.nil? command.params['dartId'] = dart_id unless dart_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 countries. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CountriesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CountriesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_countries(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/countries', options) command.response_representation = Google::Apis::DfareportingV2_8::CountriesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::CountriesListResponse command.params['profileId'] = profile_id unless profile_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 # Inserts a new creative asset. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Advertiser ID of this creative. This is a required field. # @param [Google::Apis::DfareportingV2_8::CreativeAssetMetadata] creative_asset_metadata_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::DfareportingV2_8::CreativeAssetMetadata] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeAssetMetadata] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_asset(profile_id, advertiser_id, creative_asset_metadata_object = 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, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options) else command = make_upload_command(:post, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::DfareportingV2_8::CreativeAssetMetadata::Representation command.request_object = creative_asset_metadata_object command.response_representation = Google::Apis::DfareportingV2_8::CreativeAssetMetadata::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeAssetMetadata command.params['profileId'] = profile_id unless profile_id.nil? 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing creative field value. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Fixnum] id # Creative Field Value 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.params['id'] = id unless 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 one creative field value by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Fixnum] id # Creative Field Value 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeFieldValue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.params['id'] = id unless 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 # Inserts a new creative field value. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Google::Apis::DfareportingV2_8::CreativeFieldValue] creative_field_value_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeFieldValue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) command.request_representation = Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation command.request_object = creative_field_value_object command.response_representation = Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_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 creative field values, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Array, Fixnum] ids # Select only creative field values with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for creative field values by their values. Wildcards (e.g. *) # are not allowed. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldValuesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeFieldValuesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field_values(profile_id, creative_field_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) command.response_representation = Google::Apis::DfareportingV2_8::CreativeFieldValuesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeFieldValuesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 creative field value. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Fixnum] id # Creative Field Value ID # @param [Google::Apis::DfareportingV2_8::CreativeFieldValue] creative_field_value_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeFieldValue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field_value(profile_id, creative_field_id, id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) command.request_representation = Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation command.request_object = creative_field_value_object command.response_representation = Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.query['id'] = id unless 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 an existing creative field value. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Google::Apis::DfareportingV2_8::CreativeFieldValue] creative_field_value_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeFieldValue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) command.request_representation = Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation command.request_object = creative_field_value_object command.response_representation = Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_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 existing creative field. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative Field 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/creativeFields/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one creative field by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative Field 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeField] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::CreativeField::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeField command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new creative field. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::CreativeField] creative_field_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeField] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/creativeFields', options) command.request_representation = Google::Apis::DfareportingV2_8::CreativeField::Representation command.request_object = creative_field_object command.response_representation = Google::Apis::DfareportingV2_8::CreativeField::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeField command.params['profileId'] = profile_id unless profile_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 creative fields, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only creative fields that belong to these advertisers. # @param [Array, Fixnum] ids # Select only creative fields with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for creative fields by name or ID. Wildcards (*) are allowed. # For example, "creativefield*2015" will return creative fields with names like " # creativefield June 2015", "creativefield April 2015", or simply "creativefield # 2015". Most of the searches also add wild-cards implicitly at the start and # the end of the search string. For example, a search string of "creativefield" # will match creative fields with the name "my creativefield", "creativefield # 2015", or simply "creativefield". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeFieldsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_fields(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields', options) command.response_representation = Google::Apis::DfareportingV2_8::CreativeFieldsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeFieldsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 creative field. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative Field ID # @param [Google::Apis::DfareportingV2_8::CreativeField] creative_field_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeField] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field(profile_id, id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields', options) command.request_representation = Google::Apis::DfareportingV2_8::CreativeField::Representation command.request_object = creative_field_object command.response_representation = Google::Apis::DfareportingV2_8::CreativeField::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeField command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing creative field. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::CreativeField] creative_field_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeField] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/creativeFields', options) command.request_representation = Google::Apis::DfareportingV2_8::CreativeField::Representation command.request_object = creative_field_object command.response_representation = Google::Apis::DfareportingV2_8::CreativeField::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeField command.params['profileId'] = profile_id unless profile_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 one creative group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new creative group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::CreativeGroup] creative_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/creativeGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::CreativeGroup::Representation command.request_object = creative_group_object command.response_representation = Google::Apis::DfareportingV2_8::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeGroup command.params['profileId'] = profile_id unless profile_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 creative groups, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only creative groups that belong to these advertisers. # @param [Fixnum] group_number # Select only creative groups that belong to this subgroup. # @param [Array, Fixnum] ids # Select only creative groups with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for creative groups by name or ID. Wildcards (*) are allowed. # For example, "creativegroup*2015" will return creative groups with names like " # creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup # 2015". Most of the searches also add wild-cards implicitly at the start and # the end of the search string. For example, a search string of "creativegroup" # will match creative groups with the name "my creativegroup", "creativegroup # 2015", or simply "creativegroup". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_groups(profile_id, advertiser_ids: nil, group_number: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups', options) command.response_representation = Google::Apis::DfareportingV2_8::CreativeGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeGroupsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['groupNumber'] = group_number unless group_number.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 creative group. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative group ID. # @param [Google::Apis::DfareportingV2_8::CreativeGroup] creative_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_group(profile_id, id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::CreativeGroup::Representation command.request_object = creative_group_object command.response_representation = Google::Apis::DfareportingV2_8::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing creative group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::CreativeGroup] creative_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativeGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/creativeGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::CreativeGroup::Representation command.request_object = creative_group_object command.response_representation = Google::Apis::DfareportingV2_8::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativeGroup command.params['profileId'] = profile_id unless profile_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 one creative by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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_creative(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creatives/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Creative::Representation command.response_class = Google::Apis::DfareportingV2_8::Creative command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new creative. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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 insert_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/creatives', options) command.request_representation = Google::Apis::DfareportingV2_8::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::DfareportingV2_8::Creative::Representation command.response_class = Google::Apis::DfareportingV2_8::Creative command.params['profileId'] = profile_id unless profile_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 creatives, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active creatives. Leave blank to select active and inactive # creatives. # @param [Fixnum] advertiser_id # Select only creatives with this advertiser ID. # @param [Boolean] archived # Select only archived creatives. Leave blank to select archived and unarchived # creatives. # @param [Fixnum] campaign_id # Select only creatives with this campaign ID. # @param [Array, Fixnum] companion_creative_ids # Select only in-stream video creatives with these companion IDs. # @param [Array, Fixnum] creative_field_ids # Select only creatives with these creative field IDs. # @param [Array, Fixnum] ids # Select only creatives with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Array, Fixnum] rendering_ids # Select only creatives with these rendering IDs. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "creative*2015" will return objects with names like "creative June # 2015", "creative April 2015", or simply "creative 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "creative" will match objects with name "my # creative", "creative 2015", or simply "creative". # @param [Array, Fixnum] size_ids # Select only creatives with these size IDs. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] studio_creative_id # Select only creatives corresponding to this Studio creative ID. # @param [Array, String] types # Select only creatives with these creative types. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CreativesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CreativesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creatives(profile_id, active: nil, advertiser_id: nil, archived: nil, campaign_id: nil, companion_creative_ids: nil, creative_field_ids: nil, ids: nil, max_results: nil, page_token: nil, rendering_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, studio_creative_id: nil, types: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creatives', options) command.response_representation = Google::Apis::DfareportingV2_8::CreativesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::CreativesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['archived'] = archived unless archived.nil? command.query['campaignId'] = campaign_id unless campaign_id.nil? command.query['companionCreativeIds'] = companion_creative_ids unless companion_creative_ids.nil? command.query['creativeFieldIds'] = creative_field_ids unless creative_field_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['renderingIds'] = rendering_ids unless rendering_ids.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sizeIds'] = size_ids unless size_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['studioCreativeId'] = studio_creative_id unless studio_creative_id.nil? command.query['types'] = types unless 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 # Updates an existing creative. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative ID. # @param [Google::Apis::DfareportingV2_8::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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_creative(profile_id, id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/creatives', options) command.request_representation = Google::Apis::DfareportingV2_8::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::DfareportingV2_8::Creative::Representation command.response_class = Google::Apis::DfareportingV2_8::Creative command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing creative. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::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 update_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/creatives', options) command.request_representation = Google::Apis::DfareportingV2_8::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::DfareportingV2_8::Creative::Representation command.response_class = Google::Apis::DfareportingV2_8::Creative command.params['profileId'] = profile_id unless profile_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 list of report dimension values for a list of filters. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Google::Apis::DfareportingV2_8::DimensionValueRequest] dimension_value_request_object # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::DimensionValueList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::DimensionValueList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_dimension_value(profile_id, dimension_value_request_object = nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/dimensionvalues/query', options) command.request_representation = Google::Apis::DfareportingV2_8::DimensionValueRequest::Representation command.request_object = dimension_value_request_object command.response_representation = Google::Apis::DfareportingV2_8::DimensionValueList::Representation command.response_class = Google::Apis::DfareportingV2_8::DimensionValueList command.params['profileId'] = profile_id unless profile_id.nil? command.query['maxResults'] = max_results unless max_results.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 # Gets one directory site contact by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Directory site contact 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::DirectorySiteContact] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::DirectorySiteContact] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_directory_site_contact(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/directorySiteContacts/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::DirectorySiteContact::Representation command.response_class = Google::Apis::DfareportingV2_8::DirectorySiteContact command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 directory site contacts, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] directory_site_ids # Select only directory site contacts with these directory site IDs. This is a # required field. # @param [Array, Fixnum] ids # Select only directory site contacts with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name, ID or email. Wildcards (*) are allowed. # For example, "directory site contact*2015" will return objects with names like # "directory site contact June 2015", "directory site contact April 2015", or # simply "directory site contact 2015". Most of the searches also add wildcards # implicitly at the start and the end of the search string. For example, a # search string of "directory site contact" will match objects with name "my # directory site contact", "directory site contact 2015", or simply "directory # site contact". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::DirectorySiteContactsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::DirectorySiteContactsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_directory_site_contacts(profile_id, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/directorySiteContacts', options) command.response_representation = Google::Apis::DfareportingV2_8::DirectorySiteContactsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::DirectorySiteContactsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one directory site by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Directory site 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::DirectorySite] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::DirectorySite] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_directory_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/directorySites/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::DirectorySite::Representation command.response_class = Google::Apis::DfareportingV2_8::DirectorySite command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new directory site. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::DirectorySite] directory_site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::DirectorySite] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::DirectorySite] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_directory_site(profile_id, directory_site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/directorySites', options) command.request_representation = Google::Apis::DfareportingV2_8::DirectorySite::Representation command.request_object = directory_site_object command.response_representation = Google::Apis::DfareportingV2_8::DirectorySite::Representation command.response_class = Google::Apis::DfareportingV2_8::DirectorySite command.params['profileId'] = profile_id unless profile_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 directory sites, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] accepts_in_stream_video_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_interstitial_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_publisher_paid_placements # Select only directory sites that accept publisher paid placements. This field # can be left blank. # @param [Boolean] active # Select only active directory sites. Leave blank to retrieve both active and # inactive directory sites. # @param [Fixnum] country_id # Select only directory sites with this country ID. # @param [String] dfp_network_code # Select only directory sites with this DFP network code. # @param [Array, Fixnum] ids # Select only directory sites with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Fixnum] parent_id # Select only directory sites with this parent ID. # @param [String] search_string # Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. # For example, "directory site*2015" will return objects with names like " # directory site June 2015", "directory site April 2015", or simply "directory # site 2015". Most of the searches also add wildcards implicitly at the start # and the end of the search string. For example, a search string of "directory # site" will match objects with name "my directory site", "directory site 2015" # or simply, "directory site". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::DirectorySitesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::DirectorySitesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_directory_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, active: nil, country_id: nil, dfp_network_code: nil, ids: nil, max_results: nil, page_token: nil, parent_id: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/directorySites', options) command.response_representation = Google::Apis::DfareportingV2_8::DirectorySitesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::DirectorySitesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['acceptsInStreamVideoPlacements'] = accepts_in_stream_video_placements unless accepts_in_stream_video_placements.nil? command.query['acceptsInterstitialPlacements'] = accepts_interstitial_placements unless accepts_interstitial_placements.nil? command.query['acceptsPublisherPaidPlacements'] = accepts_publisher_paid_placements unless accepts_publisher_paid_placements.nil? command.query['active'] = active unless active.nil? command.query['countryId'] = country_id unless country_id.nil? command.query['dfpNetworkCode'] = dfp_network_code unless dfp_network_code.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parentId'] = parent_id unless parent_id.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 existing dynamic targeting key. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] object_id_ # ID of the object of this dynamic targeting key. This is a required field. # @param [String] name # Name of this dynamic targeting key. This is a required field. Must be less # than 256 characters long and cannot contain commas. All characters are # converted to lowercase. # @param [String] object_type # Type of the object of this dynamic targeting key. This is a required 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_dynamic_targeting_key(profile_id, object_id_, name, object_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/dynamicTargetingKeys/{objectId}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['objectId'] = object_id_ unless object_id_.nil? command.query['name'] = name unless name.nil? command.query['objectType'] = object_type unless object_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 # Inserts a new dynamic targeting key. Keys must be created at the advertiser # level before being assigned to the advertiser's ads, creatives, or placements. # There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 # keys can be assigned per ad, creative, or placement. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::DynamicTargetingKey] dynamic_targeting_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::DynamicTargetingKey] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::DynamicTargetingKey] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dynamic_targeting_key(profile_id, dynamic_targeting_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/dynamicTargetingKeys', options) command.request_representation = Google::Apis::DfareportingV2_8::DynamicTargetingKey::Representation command.request_object = dynamic_targeting_key_object command.response_representation = Google::Apis::DfareportingV2_8::DynamicTargetingKey::Representation command.response_class = Google::Apis::DfareportingV2_8::DynamicTargetingKey command.params['profileId'] = profile_id unless profile_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 dynamic targeting keys. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only dynamic targeting keys whose object has this advertiser ID. # @param [Array, String] names # Select only dynamic targeting keys exactly matching these names. # @param [Fixnum] object_id_ # Select only dynamic targeting keys with this object ID. # @param [String] object_type # Select only dynamic targeting keys with this object 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::DynamicTargetingKeysListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::DynamicTargetingKeysListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dynamic_targeting_keys(profile_id, advertiser_id: nil, names: nil, object_id_: nil, object_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/dynamicTargetingKeys', options) command.response_representation = Google::Apis::DfareportingV2_8::DynamicTargetingKeysListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::DynamicTargetingKeysListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['names'] = names unless names.nil? command.query['objectId'] = object_id_ unless object_id_.nil? command.query['objectType'] = object_type unless object_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 an existing event tag. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Event tag 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/eventTags/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one event tag by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Event tag 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::EventTag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/eventTags/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::EventTag::Representation command.response_class = Google::Apis::DfareportingV2_8::EventTag command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new event tag. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::EventTag] event_tag_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::EventTag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/eventTags', options) command.request_representation = Google::Apis::DfareportingV2_8::EventTag::Representation command.request_object = event_tag_object command.response_representation = Google::Apis::DfareportingV2_8::EventTag::Representation command.response_class = Google::Apis::DfareportingV2_8::EventTag command.params['profileId'] = profile_id unless profile_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 event tags, possibly filtered. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] ad_id # Select only event tags that belong to this ad. # @param [Fixnum] advertiser_id # Select only event tags that belong to this advertiser. # @param [Fixnum] campaign_id # Select only event tags that belong to this campaign. # @param [Boolean] definitions_only # Examine only the specified campaign or advertiser's event tags for matching # selector criteria. When set to false, the parent advertiser and parent # campaign of the specified ad or campaign is examined as well. In addition, # when set to false, the status field is examined as well, along with the # enabledByDefault field. This parameter can not be set to true when adId is # specified as ads do not define their own even tags. # @param [Boolean] enabled # Select only enabled event tags. What is considered enabled or disabled depends # on the definitionsOnly parameter. When definitionsOnly is set to true, only # the specified advertiser or campaign's event tags' enabledByDefault field is # examined. When definitionsOnly is set to false, the specified ad or specified # campaign's parent advertiser's or parent campaign's event tags' # enabledByDefault and status fields are examined as well. # @param [Array, String] event_tag_types # Select only event tags with the specified event tag types. Event tag types can # be used to specify whether to use a third-party pixel, a third-party # JavaScript URL, or a third-party click-through URL for either impression or # click tracking. # @param [Array, Fixnum] ids # Select only event tags with these IDs. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "eventtag*2015" will return objects with names like "eventtag June # 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "eventtag" will match objects with name "my # eventtag", "eventtag 2015", or simply "eventtag". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::EventTagsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::EventTagsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_tags(profile_id, ad_id: nil, advertiser_id: nil, campaign_id: nil, definitions_only: nil, enabled: nil, event_tag_types: nil, ids: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/eventTags', options) command.response_representation = Google::Apis::DfareportingV2_8::EventTagsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::EventTagsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['adId'] = ad_id unless ad_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['campaignId'] = campaign_id unless campaign_id.nil? command.query['definitionsOnly'] = definitions_only unless definitions_only.nil? command.query['enabled'] = enabled unless enabled.nil? command.query['eventTagTypes'] = event_tag_types unless event_tag_types.nil? command.query['ids'] = ids unless ids.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 event tag. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Event tag ID. # @param [Google::Apis::DfareportingV2_8::EventTag] event_tag_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::EventTag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_tag(profile_id, id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/eventTags', options) command.request_representation = Google::Apis::DfareportingV2_8::EventTag::Representation command.request_object = event_tag_object command.response_representation = Google::Apis::DfareportingV2_8::EventTag::Representation command.response_class = Google::Apis::DfareportingV2_8::EventTag command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing event tag. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::EventTag] event_tag_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::EventTag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/eventTags', options) command.request_representation = Google::Apis::DfareportingV2_8::EventTag::Representation command.request_object = event_tag_object command.response_representation = Google::Apis::DfareportingV2_8::EventTag::Representation command.response_class = Google::Apis::DfareportingV2_8::EventTag command.params['profileId'] = profile_id unless profile_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 report file by its report ID and file ID. This method supports # media download. # @param [Fixnum] report_id # The ID of the report. # @param [Fixnum] file_id # The ID of the report 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::File] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::File] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_file(report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'reports/{reportId}/files/{fileId}', options) else command = make_download_command(:get, 'reports/{reportId}/files/{fileId}', options) command.download_dest = download_dest end command.response_representation = Google::Apis::DfareportingV2_8::File::Representation command.response_class = Google::Apis::DfareportingV2_8::File command.params['reportId'] = report_id unless report_id.nil? command.params['fileId'] = file_id unless file_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 files for a user profile. # @param [Fixnum] profile_id # The DFA profile ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @param [String] scope # The scope that defines which results are returned. # @param [String] sort_field # The field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FileList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FileList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_files(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/files', options) command.response_representation = Google::Apis::DfareportingV2_8::FileList::Representation command.response_class = Google::Apis::DfareportingV2_8::FileList command.params['profileId'] = profile_id unless profile_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['scope'] = scope unless scope.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 existing floodlight activity. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight activity 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/floodlightActivities/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Generates a tag for a floodlight activity. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] floodlight_activity_id # Floodlight activity ID for which we want to generate a tag. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivitiesGenerateTagResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivitiesGenerateTagResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def generatetag_floodlight_activity(profile_id, floodlight_activity_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities/generatetag', options) command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivitiesGenerateTagResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivitiesGenerateTagResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_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 one floodlight activity by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight activity 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivity command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new floodlight activity. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::FloodlightActivity] floodlight_activity_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities', options) command.request_representation = Google::Apis::DfareportingV2_8::FloodlightActivity::Representation command.request_object = floodlight_activity_object command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivity command.params['profileId'] = profile_id unless profile_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 floodlight activities, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only floodlight activities for the specified advertiser ID. Must # specify either ids, advertiserId, or floodlightConfigurationId for a non-empty # result. # @param [Array, Fixnum] floodlight_activity_group_ids # Select only floodlight activities with the specified floodlight activity group # IDs. # @param [String] floodlight_activity_group_name # Select only floodlight activities with the specified floodlight activity group # name. # @param [String] floodlight_activity_group_tag_string # Select only floodlight activities with the specified floodlight activity group # tag string. # @param [String] floodlight_activity_group_type # Select only floodlight activities with the specified floodlight activity group # type. # @param [Fixnum] floodlight_configuration_id # Select only floodlight activities for the specified floodlight configuration # ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a # non-empty result. # @param [Array, Fixnum] ids # Select only floodlight activities with the specified IDs. Must specify either # ids, advertiserId, or floodlightConfigurationId for a non-empty result. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "floodlightactivity*2015" will return objects with names like " # floodlightactivity June 2015", "floodlightactivity April 2015", or simply " # floodlightactivity 2015". Most of the searches also add wildcards implicitly # at the start and the end of the search string. For example, a search string of # "floodlightactivity" will match objects with name "my floodlightactivity # activity", "floodlightactivity 2015", or simply "floodlightactivity". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [String] tag_string # Select only floodlight activities with the specified tag string. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivitiesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivitiesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activities(profile_id, advertiser_id: nil, floodlight_activity_group_ids: nil, floodlight_activity_group_name: nil, floodlight_activity_group_tag_string: nil, floodlight_activity_group_type: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, tag_string: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities', options) command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivitiesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivitiesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['floodlightActivityGroupIds'] = floodlight_activity_group_ids unless floodlight_activity_group_ids.nil? command.query['floodlightActivityGroupName'] = floodlight_activity_group_name unless floodlight_activity_group_name.nil? command.query['floodlightActivityGroupTagString'] = floodlight_activity_group_tag_string unless floodlight_activity_group_tag_string.nil? command.query['floodlightActivityGroupType'] = floodlight_activity_group_type unless floodlight_activity_group_type.nil? command.query['floodlightConfigurationId'] = floodlight_configuration_id unless floodlight_configuration_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['tagString'] = tag_string unless tag_string.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 floodlight activity. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight activity ID. # @param [Google::Apis::DfareportingV2_8::FloodlightActivity] floodlight_activity_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity(profile_id, id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivities', options) command.request_representation = Google::Apis::DfareportingV2_8::FloodlightActivity::Representation command.request_object = floodlight_activity_object command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivity command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing floodlight activity. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::FloodlightActivity] floodlight_activity_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivities', options) command.request_representation = Google::Apis::DfareportingV2_8::FloodlightActivity::Representation command.request_object = floodlight_activity_object command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivity command.params['profileId'] = profile_id unless profile_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 one floodlight activity group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight activity Group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new floodlight activity group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] floodlight_activity_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivityGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation command.request_object = floodlight_activity_group_object command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_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 floodlight activity groups, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only floodlight activity groups with the specified advertiser ID. Must # specify either advertiserId or floodlightConfigurationId for a non-empty # result. # @param [Fixnum] floodlight_configuration_id # Select only floodlight activity groups with the specified floodlight # configuration ID. Must specify either advertiserId, or # floodlightConfigurationId for a non-empty result. # @param [Array, Fixnum] ids # Select only floodlight activity groups with the specified IDs. Must specify # either advertiserId or floodlightConfigurationId for a non-empty result. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "floodlightactivitygroup*2015" will return objects with names like " # floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or # simply "floodlightactivitygroup 2015". Most of the searches also add wildcards # implicitly at the start and the end of the search string. For example, a # search string of "floodlightactivitygroup" will match objects with name "my # floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply " # floodlightactivitygroup". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [String] type # Select only floodlight activity groups with the specified floodlight activity # group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivityGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivityGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activity_groups(profile_id, advertiser_id: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups', options) command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivityGroupsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['floodlightConfigurationId'] = floodlight_configuration_id unless floodlight_configuration_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['type'] = type unless 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 an existing floodlight activity group. This method supports patch # semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight activity Group ID. # @param [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] floodlight_activity_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity_group(profile_id, id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivityGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation command.request_object = floodlight_activity_group_object command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing floodlight activity group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] floodlight_activity_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivityGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation command.request_object = floodlight_activity_group_object command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_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 one floodlight configuration by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight configuration 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_configuration(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::FloodlightConfiguration::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightConfiguration command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 floodlight configurations, possibly filtered. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Set of IDs of floodlight configurations to retrieve. Required field; otherwise # an empty list 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightConfigurationsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightConfigurationsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_configurations(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations', options) command.response_representation = Google::Apis::DfareportingV2_8::FloodlightConfigurationsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightConfigurationsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless 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 # Updates an existing floodlight configuration. This method supports patch # semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight configuration ID. # @param [Google::Apis::DfareportingV2_8::FloodlightConfiguration] floodlight_configuration_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_configuration(profile_id, id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightConfigurations', options) command.request_representation = Google::Apis::DfareportingV2_8::FloodlightConfiguration::Representation command.request_object = floodlight_configuration_object command.response_representation = Google::Apis::DfareportingV2_8::FloodlightConfiguration::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightConfiguration command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing floodlight configuration. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::FloodlightConfiguration] floodlight_configuration_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FloodlightConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_configuration(profile_id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightConfigurations', options) command.request_representation = Google::Apis::DfareportingV2_8::FloodlightConfiguration::Representation command.request_object = floodlight_configuration_object command.response_representation = Google::Apis::DfareportingV2_8::FloodlightConfiguration::Representation command.response_class = Google::Apis::DfareportingV2_8::FloodlightConfiguration command.params['profileId'] = profile_id unless profile_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 one inventory item by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for order documents. # @param [Fixnum] id # Inventory item 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::InventoryItem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::InventoryItem] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_item(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::InventoryItem::Representation command.response_class = Google::Apis::DfareportingV2_8::InventoryItem command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless 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 inventory items, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for order documents. # @param [Array, Fixnum] ids # Select only inventory items with these IDs. # @param [Boolean] in_plan # Select only inventory items that are in plan. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Array, Fixnum] order_id # Select only inventory items that belong to specified orders. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Array, Fixnum] site_id # Select only inventory items that are associated with these sites. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [String] type # Select only inventory items with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::InventoryItemsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::InventoryItemsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_items(profile_id, project_id, ids: nil, in_plan: nil, max_results: nil, order_id: nil, page_token: nil, site_id: nil, sort_field: nil, sort_order: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems', options) command.response_representation = Google::Apis::DfareportingV2_8::InventoryItemsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::InventoryItemsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.query['ids'] = ids unless ids.nil? command.query['inPlan'] = in_plan unless in_plan.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderId'] = order_id unless order_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['siteId'] = site_id unless site_id.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['type'] = type unless 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 an existing campaign landing page. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Landing page campaign ID. # @param [Fixnum] id # Landing page 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['campaignId'] = campaign_id unless campaign_id.nil? command.params['id'] = id unless 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 one campaign landing page by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Landing page campaign ID. # @param [Fixnum] id # Landing page 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::LandingPage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation command.response_class = Google::Apis::DfareportingV2_8::LandingPage command.params['profileId'] = profile_id unless profile_id.nil? command.params['campaignId'] = campaign_id unless campaign_id.nil? command.params['id'] = id unless 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 # Inserts a new landing page for the specified campaign. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Landing page campaign ID. # @param [Google::Apis::DfareportingV2_8::LandingPage] landing_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::LandingPage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_landing_page(profile_id, campaign_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) command.request_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation command.request_object = landing_page_object command.response_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation command.response_class = Google::Apis::DfareportingV2_8::LandingPage command.params['profileId'] = profile_id unless profile_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves the list of landing pages for the specified campaign. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Landing page campaign 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::LandingPagesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::LandingPagesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_landing_pages(profile_id, campaign_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) command.response_representation = Google::Apis::DfareportingV2_8::LandingPagesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::LandingPagesListResponse command.params['profileId'] = profile_id unless profile_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates an existing campaign landing page. This method supports patch # semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Landing page campaign ID. # @param [Fixnum] id # Landing page ID. # @param [Google::Apis::DfareportingV2_8::LandingPage] landing_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::LandingPage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_landing_page(profile_id, campaign_id, id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) command.request_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation command.request_object = landing_page_object command.response_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation command.response_class = Google::Apis::DfareportingV2_8::LandingPage command.params['profileId'] = profile_id unless profile_id.nil? command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['id'] = id unless 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 an existing campaign landing page. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Landing page campaign ID. # @param [Google::Apis::DfareportingV2_8::LandingPage] landing_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::LandingPage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_landing_page(profile_id, campaign_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) command.request_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation command.request_object = landing_page_object command.response_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation command.response_class = Google::Apis::DfareportingV2_8::LandingPage command.params['profileId'] = profile_id unless profile_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of languages. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::LanguagesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::LanguagesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_languages(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/languages', options) command.response_representation = Google::Apis::DfareportingV2_8::LanguagesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::LanguagesListResponse command.params['profileId'] = profile_id unless profile_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 metros. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::MetrosListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::MetrosListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metros(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/metros', options) command.response_representation = Google::Apis::DfareportingV2_8::MetrosListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::MetrosListResponse command.params['profileId'] = profile_id unless profile_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 one mobile carrier by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Mobile carrier 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::MobileCarrier] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::MobileCarrier] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_mobile_carrier(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::MobileCarrier::Representation command.response_class = Google::Apis::DfareportingV2_8::MobileCarrier command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 mobile carriers. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::MobileCarriersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::MobileCarriersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_mobile_carriers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers', options) command.response_representation = Google::Apis::DfareportingV2_8::MobileCarriersListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::MobileCarriersListResponse command.params['profileId'] = profile_id unless profile_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 one operating system version by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Operating system version 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::OperatingSystemVersion] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::OperatingSystemVersion] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operating_system_version(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::OperatingSystemVersion::Representation command.response_class = Google::Apis::DfareportingV2_8::OperatingSystemVersion command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 operating system versions. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::OperatingSystemVersionsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::OperatingSystemVersionsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operating_system_versions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions', options) command.response_representation = Google::Apis::DfareportingV2_8::OperatingSystemVersionsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::OperatingSystemVersionsListResponse command.params['profileId'] = profile_id unless profile_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 one operating system by DART ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] dart_id # Operating system DART 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::OperatingSystem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::OperatingSystem] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operating_system(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems/{dartId}', options) command.response_representation = Google::Apis::DfareportingV2_8::OperatingSystem::Representation command.response_class = Google::Apis::DfareportingV2_8::OperatingSystem command.params['profileId'] = profile_id unless profile_id.nil? command.params['dartId'] = dart_id unless dart_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 operating systems. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::OperatingSystemsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::OperatingSystemsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operating_systems(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems', options) command.response_representation = Google::Apis::DfareportingV2_8::OperatingSystemsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::OperatingSystemsListResponse command.params['profileId'] = profile_id unless profile_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 one order document by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for order documents. # @param [Fixnum] id # Order document 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::OrderDocument] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::OrderDocument] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order_document(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::OrderDocument::Representation command.response_class = Google::Apis::DfareportingV2_8::OrderDocument command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless 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 order documents, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for order documents. # @param [Boolean] approved # Select only order documents that have been approved by at least one user. # @param [Array, Fixnum] ids # Select only order documents with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Array, Fixnum] order_id # Select only order documents for specified orders. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for order documents by name or ID. Wildcards (*) are allowed. # For example, "orderdocument*2015" will return order documents with names like " # orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument # 2015". Most of the searches also add wildcards implicitly at the start and the # end of the search string. For example, a search string of "orderdocument" will # match order documents with name "my orderdocument", "orderdocument 2015", or # simply "orderdocument". # @param [Array, Fixnum] site_id # Select only order documents that are associated with these sites. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::OrderDocumentsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::OrderDocumentsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order_documents(profile_id, project_id, approved: nil, ids: nil, max_results: nil, order_id: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments', options) command.response_representation = Google::Apis::DfareportingV2_8::OrderDocumentsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::OrderDocumentsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.query['approved'] = approved unless approved.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderId'] = order_id unless order_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteId'] = site_id unless site_id.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one order by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for orders. # @param [Fixnum] id # Order 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Order] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Order] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Order::Representation command.response_class = Google::Apis::DfareportingV2_8::Order command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless 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 orders, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for orders. # @param [Array, Fixnum] ids # Select only orders with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for orders by name or ID. Wildcards (*) are allowed. For # example, "order*2015" will return orders with names like "order June 2015", " # order April 2015", or simply "order 2015". Most of the searches also add # wildcards implicitly at the start and the end of the search string. For # example, a search string of "order" will match orders with name "my order", " # order 2015", or simply "order". # @param [Array, Fixnum] site_id # Select only orders that are associated with these site IDs. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::OrdersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::OrdersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_orders(profile_id, project_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders', options) command.response_representation = Google::Apis::DfareportingV2_8::OrdersListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::OrdersListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteId'] = site_id unless site_id.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one placement group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placementGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new placement group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::PlacementGroup] placement_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/placementGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::PlacementGroup::Representation command.request_object = placement_group_object command.response_representation = Google::Apis::DfareportingV2_8::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementGroup command.params['profileId'] = profile_id unless profile_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 placement groups, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only placement groups that belong to these advertisers. # @param [Boolean] archived # Select only archived placements. Don't set this field to select both archived # and non-archived placements. # @param [Array, Fixnum] campaign_ids # Select only placement groups that belong to these campaigns. # @param [Array, Fixnum] content_category_ids # Select only placement groups that are associated with these content categories. # @param [Array, Fixnum] directory_site_ids # Select only placement groups that are associated with these directory sites. # @param [Array, Fixnum] ids # Select only placement groups with these IDs. # @param [String] max_end_date # Select only placements or placement groups whose end date is on or before the # specified maxEndDate. The date should be formatted as "yyyy-MM-dd". # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] max_start_date # Select only placements or placement groups whose start date is on or before # the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". # @param [String] min_end_date # Select only placements or placement groups whose end date is on or after the # specified minEndDate. The date should be formatted as "yyyy-MM-dd". # @param [String] min_start_date # Select only placements or placement groups whose start date is on or after the # specified minStartDate. The date should be formatted as "yyyy-MM-dd". # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] placement_group_type # Select only placement groups belonging with this group type. A package is a # simple group of placements that acts as a single pricing point for a group of # tags. A roadblock is a group of placements that not only acts as a single # pricing point but also assumes that all the tags in it will be served at the # same time. A roadblock requires one of its assigned placements to be marked as # primary for reporting. # @param [Array, Fixnum] placement_strategy_ids # Select only placement groups that are associated with these placement # strategies. # @param [Array, String] pricing_types # Select only placement groups with these pricing types. # @param [String] search_string # Allows searching for placement groups by name or ID. Wildcards (*) are allowed. # For example, "placement*2015" will return placement groups with names like " # placement group June 2015", "placement group May 2015", or simply "placements # 2015". Most of the searches also add wildcards implicitly at the start and the # end of the search string. For example, a search string of "placementgroup" # will match placement groups with name "my placementgroup", "placementgroup # 2015", or simply "placementgroup". # @param [Array, Fixnum] site_ids # Select only placement groups that are associated with these sites. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_groups(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, content_category_ids: nil, directory_site_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, placement_group_type: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placementGroups', options) command.response_representation = Google::Apis::DfareportingV2_8::PlacementGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementGroupsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['archived'] = archived unless archived.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxEndDate'] = max_end_date unless max_end_date.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['maxStartDate'] = max_start_date unless max_start_date.nil? command.query['minEndDate'] = min_end_date unless min_end_date.nil? command.query['minStartDate'] = min_start_date unless min_start_date.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['placementGroupType'] = placement_group_type unless placement_group_type.nil? command.query['placementStrategyIds'] = placement_strategy_ids unless placement_strategy_ids.nil? command.query['pricingTypes'] = pricing_types unless pricing_types.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteIds'] = site_ids unless site_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 placement group. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement group ID. # @param [Google::Apis::DfareportingV2_8::PlacementGroup] placement_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_group(profile_id, id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/placementGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::PlacementGroup::Representation command.request_object = placement_group_object command.response_representation = Google::Apis::DfareportingV2_8::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing placement group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::PlacementGroup] placement_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/placementGroups', options) command.request_representation = Google::Apis::DfareportingV2_8::PlacementGroup::Representation command.request_object = placement_group_object command.response_representation = Google::Apis::DfareportingV2_8::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementGroup command.params['profileId'] = profile_id unless profile_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 existing placement strategy. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement strategy 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/placementStrategies/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one placement strategy by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement strategy 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementStrategy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementStrategy command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new placement strategy. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::PlacementStrategy] placement_strategy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementStrategy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/placementStrategies', options) command.request_representation = Google::Apis::DfareportingV2_8::PlacementStrategy::Representation command.request_object = placement_strategy_object command.response_representation = Google::Apis::DfareportingV2_8::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementStrategy command.params['profileId'] = profile_id unless profile_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 placement strategies, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Select only placement strategies with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "placementstrategy*2015" will return objects with names like " # placementstrategy June 2015", "placementstrategy April 2015", or simply " # placementstrategy 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # placementstrategy" will match objects with name "my placementstrategy", " # placementstrategy 2015", or simply "placementstrategy". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementStrategiesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementStrategiesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_strategies(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies', options) command.response_representation = Google::Apis::DfareportingV2_8::PlacementStrategiesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementStrategiesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 placement strategy. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement strategy ID. # @param [Google::Apis::DfareportingV2_8::PlacementStrategy] placement_strategy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementStrategy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_strategy(profile_id, id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/placementStrategies', options) command.request_representation = Google::Apis::DfareportingV2_8::PlacementStrategy::Representation command.request_object = placement_strategy_object command.response_representation = Google::Apis::DfareportingV2_8::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementStrategy command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing placement strategy. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::PlacementStrategy] placement_strategy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementStrategy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/placementStrategies', options) command.request_representation = Google::Apis::DfareportingV2_8::PlacementStrategy::Representation command.request_object = placement_strategy_object command.response_representation = Google::Apis::DfareportingV2_8::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementStrategy command.params['profileId'] = profile_id unless profile_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 # Generates tags for a placement. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Generate placements belonging to this campaign. This is a required field. # @param [Array, Fixnum] placement_ids # Generate tags for these placements. # @param [Array, String] tag_formats # Tag formats to generate for these placements. # Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementsGenerateTagsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementsGenerateTagsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def generatetags_placement(profile_id, campaign_id: nil, placement_ids: nil, tag_formats: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/placements/generatetags', options) command.response_representation = Google::Apis::DfareportingV2_8::PlacementsGenerateTagsResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementsGenerateTagsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['campaignId'] = campaign_id unless campaign_id.nil? command.query['placementIds'] = placement_ids unless placement_ids.nil? command.query['tagFormats'] = tag_formats unless tag_formats.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 one placement by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Placement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placements/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Placement::Representation command.response_class = Google::Apis::DfareportingV2_8::Placement command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new placement. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::Placement] placement_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Placement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/placements', options) command.request_representation = Google::Apis::DfareportingV2_8::Placement::Representation command.request_object = placement_object command.response_representation = Google::Apis::DfareportingV2_8::Placement::Representation command.response_class = Google::Apis::DfareportingV2_8::Placement command.params['profileId'] = profile_id unless profile_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 placements, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only placements that belong to these advertisers. # @param [Boolean] archived # Select only archived placements. Don't set this field to select both archived # and non-archived placements. # @param [Array, Fixnum] campaign_ids # Select only placements that belong to these campaigns. # @param [Array, String] compatibilities # Select only placements that are associated with these compatibilities. DISPLAY # and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile # devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL # are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in- # stream video ads developed with the VAST standard. # @param [Array, Fixnum] content_category_ids # Select only placements that are associated with these content categories. # @param [Array, Fixnum] directory_site_ids # Select only placements that are associated with these directory sites. # @param [Array, Fixnum] group_ids # Select only placements that belong to these placement groups. # @param [Array, Fixnum] ids # Select only placements with these IDs. # @param [String] max_end_date # Select only placements or placement groups whose end date is on or before the # specified maxEndDate. The date should be formatted as "yyyy-MM-dd". # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] max_start_date # Select only placements or placement groups whose start date is on or before # the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". # @param [String] min_end_date # Select only placements or placement groups whose end date is on or after the # specified minEndDate. The date should be formatted as "yyyy-MM-dd". # @param [String] min_start_date # Select only placements or placement groups whose start date is on or after the # specified minStartDate. The date should be formatted as "yyyy-MM-dd". # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] payment_source # Select only placements with this payment source. # @param [Array, Fixnum] placement_strategy_ids # Select only placements that are associated with these placement strategies. # @param [Array, String] pricing_types # Select only placements with these pricing types. # @param [String] search_string # Allows searching for placements by name or ID. Wildcards (*) are allowed. For # example, "placement*2015" will return placements with names like "placement # June 2015", "placement May 2015", or simply "placements 2015". Most of the # searches also add wildcards implicitly at the start and the end of the search # string. For example, a search string of "placement" will match placements with # name "my placement", "placement 2015", or simply "placement". # @param [Array, Fixnum] site_ids # Select only placements that are associated with these sites. # @param [Array, Fixnum] size_ids # Select only placements that are associated with these sizes. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlacementsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placements(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, compatibilities: nil, content_category_ids: nil, directory_site_ids: nil, group_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, payment_source: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, size_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placements', options) command.response_representation = Google::Apis::DfareportingV2_8::PlacementsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::PlacementsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['archived'] = archived unless archived.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['compatibilities'] = compatibilities unless compatibilities.nil? command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['groupIds'] = group_ids unless group_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxEndDate'] = max_end_date unless max_end_date.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['maxStartDate'] = max_start_date unless max_start_date.nil? command.query['minEndDate'] = min_end_date unless min_end_date.nil? command.query['minStartDate'] = min_start_date unless min_start_date.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['paymentSource'] = payment_source unless payment_source.nil? command.query['placementStrategyIds'] = placement_strategy_ids unless placement_strategy_ids.nil? command.query['pricingTypes'] = pricing_types unless pricing_types.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteIds'] = site_ids unless site_ids.nil? command.query['sizeIds'] = size_ids unless size_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 placement. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement ID. # @param [Google::Apis::DfareportingV2_8::Placement] placement_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Placement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement(profile_id, id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/placements', options) command.request_representation = Google::Apis::DfareportingV2_8::Placement::Representation command.request_object = placement_object command.response_representation = Google::Apis::DfareportingV2_8::Placement::Representation command.response_class = Google::Apis::DfareportingV2_8::Placement command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing placement. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::Placement] placement_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Placement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/placements', options) command.request_representation = Google::Apis::DfareportingV2_8::Placement::Representation command.request_object = placement_object command.response_representation = Google::Apis::DfareportingV2_8::Placement::Representation command.response_class = Google::Apis::DfareportingV2_8::Placement command.params['profileId'] = profile_id unless profile_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 one platform type by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Platform type 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlatformType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlatformType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_platform_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/platformTypes/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::PlatformType::Representation command.response_class = Google::Apis::DfareportingV2_8::PlatformType command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 platform types. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PlatformTypesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PlatformTypesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_platform_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/platformTypes', options) command.response_representation = Google::Apis::DfareportingV2_8::PlatformTypesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::PlatformTypesListResponse command.params['profileId'] = profile_id unless profile_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 one postal code by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [String] code # Postal code 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PostalCode] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PostalCode] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_postal_code(profile_id, code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/postalCodes/{code}', options) command.response_representation = Google::Apis::DfareportingV2_8::PostalCode::Representation command.response_class = Google::Apis::DfareportingV2_8::PostalCode command.params['profileId'] = profile_id unless profile_id.nil? command.params['code'] = code unless 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 # Retrieves a list of postal codes. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::PostalCodesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::PostalCodesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_postal_codes(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/postalCodes', options) command.response_representation = Google::Apis::DfareportingV2_8::PostalCodesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::PostalCodesListResponse command.params['profileId'] = profile_id unless profile_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 one project by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Project 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Project] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Project] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Project::Representation command.response_class = Google::Apis::DfareportingV2_8::Project command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 projects, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only projects with these advertiser IDs. # @param [Array, Fixnum] ids # Select only projects with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for projects by name or ID. Wildcards (*) are allowed. For # example, "project*2015" will return projects with names like "project June # 2015", "project April 2015", or simply "project 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "project" will match projects with name "my # project", "project 2015", or simply "project". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ProjectsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ProjectsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_projects(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects', options) command.response_representation = Google::Apis::DfareportingV2_8::ProjectsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::ProjectsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 regions. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::RegionsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::RegionsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_regions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/regions', options) command.response_representation = Google::Apis::DfareportingV2_8::RegionsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::RegionsListResponse command.params['profileId'] = profile_id unless profile_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 one remarketing list share by remarketing list ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] remarketing_list_id # Remarketing list 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingListShare] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::RemarketingListShare] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list_share(profile_id, remarketing_list_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingListShares/{remarketingListId}', options) command.response_representation = Google::Apis::DfareportingV2_8::RemarketingListShare::Representation command.response_class = Google::Apis::DfareportingV2_8::RemarketingListShare command.params['profileId'] = profile_id unless profile_id.nil? command.params['remarketingListId'] = remarketing_list_id unless remarketing_list_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 an existing remarketing list share. This method supports patch # semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] remarketing_list_id # Remarketing list ID. # @param [Google::Apis::DfareportingV2_8::RemarketingListShare] remarketing_list_share_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingListShare] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::RemarketingListShare] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list_share(profile_id, remarketing_list_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/remarketingListShares', options) command.request_representation = Google::Apis::DfareportingV2_8::RemarketingListShare::Representation command.request_object = remarketing_list_share_object command.response_representation = Google::Apis::DfareportingV2_8::RemarketingListShare::Representation command.response_class = Google::Apis::DfareportingV2_8::RemarketingListShare command.params['profileId'] = profile_id unless profile_id.nil? command.query['remarketingListId'] = remarketing_list_id unless remarketing_list_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 an existing remarketing list share. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::RemarketingListShare] remarketing_list_share_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingListShare] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::RemarketingListShare] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list_share(profile_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/remarketingListShares', options) command.request_representation = Google::Apis::DfareportingV2_8::RemarketingListShare::Representation command.request_object = remarketing_list_share_object command.response_representation = Google::Apis::DfareportingV2_8::RemarketingListShare::Representation command.response_class = Google::Apis::DfareportingV2_8::RemarketingListShare command.params['profileId'] = profile_id unless profile_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 one remarketing list by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Remarketing list 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::RemarketingList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV2_8::RemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new remarketing list. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::RemarketingList] remarketing_list_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::RemarketingList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/remarketingLists', options) command.request_representation = Google::Apis::DfareportingV2_8::RemarketingList::Representation command.request_object = remarketing_list_object command.response_representation = Google::Apis::DfareportingV2_8::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV2_8::RemarketingList command.params['profileId'] = profile_id unless profile_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 remarketing lists, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only remarketing lists owned by this advertiser. # @param [Boolean] active # Select only active or only inactive remarketing lists. # @param [Fixnum] floodlight_activity_id # Select only remarketing lists that have this floodlight activity ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] name # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "remarketing list*2015" will return objects with names like " # remarketing list June 2015", "remarketing list April 2015", or simply " # remarketing list 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # remarketing list" will match objects with name "my remarketing list", " # remarketing list 2015", or simply "remarketing list". # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingListsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::RemarketingListsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_lists(profile_id, advertiser_id, active: nil, floodlight_activity_id: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists', options) command.response_representation = Google::Apis::DfareportingV2_8::RemarketingListsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::RemarketingListsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['name'] = name unless name.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 remarketing list. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Remarketing list ID. # @param [Google::Apis::DfareportingV2_8::RemarketingList] remarketing_list_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::RemarketingList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list(profile_id, id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/remarketingLists', options) command.request_representation = Google::Apis::DfareportingV2_8::RemarketingList::Representation command.request_object = remarketing_list_object command.response_representation = Google::Apis::DfareportingV2_8::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV2_8::RemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing remarketing list. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::RemarketingList] remarketing_list_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::RemarketingList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/remarketingLists', options) command.request_representation = Google::Apis::DfareportingV2_8::RemarketingList::Representation command.request_object = remarketing_list_object command.response_representation = Google::Apis::DfareportingV2_8::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV2_8::RemarketingList command.params['profileId'] = profile_id unless profile_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 a report by its ID. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Fixnum] report_id # The ID of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/reports/{reportId}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_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 report by its ID. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Fixnum] report_id # The ID of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}', options) command.response_representation = Google::Apis::DfareportingV2_8::Report::Representation command.response_class = Google::Apis::DfareportingV2_8::Report command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_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 report. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Google::Apis::DfareportingV2_8::Report] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/reports', options) command.request_representation = Google::Apis::DfareportingV2_8::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV2_8::Report::Representation command.response_class = Google::Apis::DfareportingV2_8::Report command.params['profileId'] = profile_id unless profile_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 list of reports. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @param [String] scope # The scope that defines which results are returned. # @param [String] sort_field # The field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::ReportList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::ReportList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reports(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/reports', options) command.response_representation = Google::Apis::DfareportingV2_8::ReportList::Representation command.response_class = Google::Apis::DfareportingV2_8::ReportList command.params['profileId'] = profile_id unless profile_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['scope'] = scope unless scope.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 a report. This method supports patch semantics. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Fixnum] report_id # The ID of the report. # @param [Google::Apis::DfareportingV2_8::Report] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/reports/{reportId}', options) command.request_representation = Google::Apis::DfareportingV2_8::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV2_8::Report::Representation command.response_class = Google::Apis::DfareportingV2_8::Report command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_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 # Runs a report. # @param [Fixnum] profile_id # The DFA profile ID. # @param [Fixnum] report_id # The ID of the report. # @param [Boolean] synchronous # If set and true, tries to run the report synchronously. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::File] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::File] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def run_report(profile_id, report_id, synchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/reports/{reportId}/run', options) command.response_representation = Google::Apis::DfareportingV2_8::File::Representation command.response_class = Google::Apis::DfareportingV2_8::File command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['synchronous'] = synchronous unless synchronous.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 a report. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Fixnum] report_id # The ID of the report. # @param [Google::Apis::DfareportingV2_8::Report] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/reports/{reportId}', options) command.request_representation = Google::Apis::DfareportingV2_8::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV2_8::Report::Representation command.response_class = Google::Apis::DfareportingV2_8::Report command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_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 fields that are compatible to be selected in the respective # sections of a report criteria, given the fields already selected in the input # report and user permissions. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Google::Apis::DfareportingV2_8::Report] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::CompatibleFields] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::CompatibleFields] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_report_compatible_field(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/reports/compatiblefields/query', options) command.request_representation = Google::Apis::DfareportingV2_8::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV2_8::CompatibleFields::Representation command.response_class = Google::Apis::DfareportingV2_8::CompatibleFields command.params['profileId'] = profile_id unless profile_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 report file. This method supports media download. # @param [Fixnum] profile_id # The DFA profile ID. # @param [Fixnum] report_id # The ID of the report. # @param [Fixnum] file_id # The ID of the report 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::File] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::File] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report_file(profile_id, report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options) else command = make_download_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options) command.download_dest = download_dest end command.response_representation = Google::Apis::DfareportingV2_8::File::Representation command.response_class = Google::Apis::DfareportingV2_8::File command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.params['fileId'] = file_id unless file_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 files for a report. # @param [Fixnum] profile_id # The DFA profile ID. # @param [Fixnum] report_id # The ID of the parent report. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @param [String] sort_field # The field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::FileList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::FileList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report_files(profile_id, report_id, max_results: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files', options) command.response_representation = Google::Apis::DfareportingV2_8::FileList::Representation command.response_class = Google::Apis::DfareportingV2_8::FileList command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one site by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Site 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Site] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/sites/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Site::Representation command.response_class = Google::Apis::DfareportingV2_8::Site command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new site. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::Site] site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Site] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/sites', options) command.request_representation = Google::Apis::DfareportingV2_8::Site::Representation command.request_object = site_object command.response_representation = Google::Apis::DfareportingV2_8::Site::Representation command.response_class = Google::Apis::DfareportingV2_8::Site command.params['profileId'] = profile_id unless profile_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 sites, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] accepts_in_stream_video_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_interstitial_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_publisher_paid_placements # Select only sites that accept publisher paid placements. # @param [Boolean] ad_words_site # Select only AdWords sites. # @param [Boolean] approved # Select only approved sites. # @param [Array, Fixnum] campaign_ids # Select only sites with these campaign IDs. # @param [Array, Fixnum] directory_site_ids # Select only sites with these directory site IDs. # @param [Array, Fixnum] ids # Select only sites with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. # For example, "site*2015" will return objects with names like "site June 2015", # "site April 2015", or simply "site 2015". Most of the searches also add # wildcards implicitly at the start and the end of the search string. For # example, a search string of "site" will match objects with name "my site", " # site 2015", or simply "site". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] subaccount_id # Select only sites with this subaccount ID. # @param [Boolean] unmapped_site # Select only sites that have not been mapped to a directory site. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::SitesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::SitesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, ad_words_site: nil, approved: nil, campaign_ids: nil, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, unmapped_site: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/sites', options) command.response_representation = Google::Apis::DfareportingV2_8::SitesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::SitesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['acceptsInStreamVideoPlacements'] = accepts_in_stream_video_placements unless accepts_in_stream_video_placements.nil? command.query['acceptsInterstitialPlacements'] = accepts_interstitial_placements unless accepts_interstitial_placements.nil? command.query['acceptsPublisherPaidPlacements'] = accepts_publisher_paid_placements unless accepts_publisher_paid_placements.nil? command.query['adWordsSite'] = ad_words_site unless ad_words_site.nil? command.query['approved'] = approved unless approved.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? command.query['unmappedSite'] = unmapped_site unless unmapped_site.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 site. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Site ID. # @param [Google::Apis::DfareportingV2_8::Site] site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Site] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(profile_id, id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/sites', options) command.request_representation = Google::Apis::DfareportingV2_8::Site::Representation command.request_object = site_object command.response_representation = Google::Apis::DfareportingV2_8::Site::Representation command.response_class = Google::Apis::DfareportingV2_8::Site command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing site. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::Site] site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Site] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/sites', options) command.request_representation = Google::Apis::DfareportingV2_8::Site::Representation command.request_object = site_object command.response_representation = Google::Apis::DfareportingV2_8::Site::Representation command.response_class = Google::Apis::DfareportingV2_8::Site command.params['profileId'] = profile_id unless profile_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 one size by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Size 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Size] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Size] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_size(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/sizes/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Size::Representation command.response_class = Google::Apis::DfareportingV2_8::Size command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new size. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::Size] size_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Size] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Size] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_size(profile_id, size_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/sizes', options) command.request_representation = Google::Apis::DfareportingV2_8::Size::Representation command.request_object = size_object command.response_representation = Google::Apis::DfareportingV2_8::Size::Representation command.response_class = Google::Apis::DfareportingV2_8::Size command.params['profileId'] = profile_id unless profile_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 sizes, possibly filtered. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] height # Select only sizes with this height. # @param [Boolean] iab_standard # Select only IAB standard sizes. # @param [Array, Fixnum] ids # Select only sizes with these IDs. # @param [Fixnum] width # Select only sizes with this width. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::SizesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::SizesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_sizes(profile_id, height: nil, iab_standard: nil, ids: nil, width: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/sizes', options) command.response_representation = Google::Apis::DfareportingV2_8::SizesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::SizesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['height'] = height unless height.nil? command.query['iabStandard'] = iab_standard unless iab_standard.nil? command.query['ids'] = ids unless ids.nil? command.query['width'] = width unless width.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 one subaccount by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Subaccount 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Subaccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subaccount(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/subaccounts/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::Subaccount::Representation command.response_class = Google::Apis::DfareportingV2_8::Subaccount command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new subaccount. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::Subaccount] subaccount_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Subaccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/subaccounts', options) command.request_representation = Google::Apis::DfareportingV2_8::Subaccount::Representation command.request_object = subaccount_object command.response_representation = Google::Apis::DfareportingV2_8::Subaccount::Representation command.response_class = Google::Apis::DfareportingV2_8::Subaccount command.params['profileId'] = profile_id unless profile_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 list of subaccounts, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Select only subaccounts with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "subaccount*2015" will return objects with names like "subaccount # June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the # searches also add wildcards implicitly at the start and the end of the search # string. For example, a search string of "subaccount" will match objects with # name "my subaccount", "subaccount 2015", or simply "subaccount". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::SubaccountsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::SubaccountsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subaccounts(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/subaccounts', options) command.response_representation = Google::Apis::DfareportingV2_8::SubaccountsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::SubaccountsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 subaccount. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Subaccount ID. # @param [Google::Apis::DfareportingV2_8::Subaccount] subaccount_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Subaccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subaccount(profile_id, id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/subaccounts', options) command.request_representation = Google::Apis::DfareportingV2_8::Subaccount::Representation command.request_object = subaccount_object command.response_representation = Google::Apis::DfareportingV2_8::Subaccount::Representation command.response_class = Google::Apis::DfareportingV2_8::Subaccount command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing subaccount. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::Subaccount] subaccount_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::Subaccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/subaccounts', options) command.request_representation = Google::Apis::DfareportingV2_8::Subaccount::Representation command.request_object = subaccount_object command.response_representation = Google::Apis::DfareportingV2_8::Subaccount::Representation command.response_class = Google::Apis::DfareportingV2_8::Subaccount command.params['profileId'] = profile_id unless profile_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 one remarketing list by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Remarketing list 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::TargetableRemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::TargetableRemarketingList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_targetable_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::TargetableRemarketingList::Representation command.response_class = Google::Apis::DfareportingV2_8::TargetableRemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 targetable remarketing lists, possibly filtered. This # method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only targetable remarketing lists targetable by these advertisers. # @param [Boolean] active # Select only active or only inactive targetable remarketing lists. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] name # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "remarketing list*2015" will return objects with names like " # remarketing list June 2015", "remarketing list April 2015", or simply " # remarketing list 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # remarketing list" will match objects with name "my remarketing list", " # remarketing list 2015", or simply "remarketing list". # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::TargetableRemarketingListsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::TargetableRemarketingListsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_targetable_remarketing_lists(profile_id, advertiser_id, active: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists', options) command.response_representation = Google::Apis::DfareportingV2_8::TargetableRemarketingListsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::TargetableRemarketingListsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['name'] = name unless name.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one targeting template by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Targeting template 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::TargetingTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::TargetingTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_template(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::TargetingTemplate::Representation command.response_class = Google::Apis::DfareportingV2_8::TargetingTemplate command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new targeting template. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::TargetingTemplate] targeting_template_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::TargetingTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::TargetingTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/targetingTemplates', options) command.request_representation = Google::Apis::DfareportingV2_8::TargetingTemplate::Representation command.request_object = targeting_template_object command.response_representation = Google::Apis::DfareportingV2_8::TargetingTemplate::Representation command.response_class = Google::Apis::DfareportingV2_8::TargetingTemplate command.params['profileId'] = profile_id unless profile_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 targeting templates, optionally filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only targeting templates with this advertiser ID. # @param [Array, Fixnum] ids # Select only targeting templates with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "template*2015" will return objects with names like "template June # 2015", "template April 2015", or simply "template 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "template" will match objects with name "my # template", "template 2015", or simply "template". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::TargetingTemplatesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::TargetingTemplatesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_templates(profile_id, advertiser_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates', options) command.response_representation = Google::Apis::DfareportingV2_8::TargetingTemplatesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::TargetingTemplatesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 targeting template. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Targeting template ID. # @param [Google::Apis::DfareportingV2_8::TargetingTemplate] targeting_template_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::TargetingTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::TargetingTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_targeting_template(profile_id, id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/targetingTemplates', options) command.request_representation = Google::Apis::DfareportingV2_8::TargetingTemplate::Representation command.request_object = targeting_template_object command.response_representation = Google::Apis::DfareportingV2_8::TargetingTemplate::Representation command.response_class = Google::Apis::DfareportingV2_8::TargetingTemplate command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing targeting template. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::TargetingTemplate] targeting_template_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::TargetingTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::TargetingTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/targetingTemplates', options) command.request_representation = Google::Apis::DfareportingV2_8::TargetingTemplate::Representation command.request_object = targeting_template_object command.response_representation = Google::Apis::DfareportingV2_8::TargetingTemplate::Representation command.response_class = Google::Apis::DfareportingV2_8::TargetingTemplate command.params['profileId'] = profile_id unless profile_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 one user profile by ID. # @param [Fixnum] profile_id # The user profile 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profile(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}', options) command.response_representation = Google::Apis::DfareportingV2_8::UserProfile::Representation command.response_class = Google::Apis::DfareportingV2_8::UserProfile command.params['profileId'] = profile_id unless profile_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 list of user profiles for a user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserProfileList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserProfileList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profiles(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles', options) command.response_representation = Google::Apis::DfareportingV2_8::UserProfileList::Representation command.response_class = Google::Apis::DfareportingV2_8::UserProfileList 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 one user role permission group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User role permission group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserRolePermissionGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserRolePermissionGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::UserRolePermissionGroup::Representation command.response_class = Google::Apis::DfareportingV2_8::UserRolePermissionGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 list of all supported user role permission groups. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserRolePermissionGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserRolePermissionGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups', options) command.response_representation = Google::Apis::DfareportingV2_8::UserRolePermissionGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::UserRolePermissionGroupsListResponse command.params['profileId'] = profile_id unless profile_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 one user role permission by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User role permission 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserRolePermission] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserRolePermission] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::UserRolePermission::Representation command.response_class = Google::Apis::DfareportingV2_8::UserRolePermission command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 list of user role permissions, possibly filtered. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Select only user role permissions with these IDs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserRolePermissionsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserRolePermissionsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role_permissions(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions', options) command.response_representation = Google::Apis::DfareportingV2_8::UserRolePermissionsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::UserRolePermissionsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless 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 # Deletes an existing user role. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User role 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/userRoles/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one user role by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User role 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserRole] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRoles/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::UserRole::Representation command.response_class = Google::Apis::DfareportingV2_8::UserRole command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new user role. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::UserRole] user_role_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserRole] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/userRoles', options) command.request_representation = Google::Apis::DfareportingV2_8::UserRole::Representation command.request_object = user_role_object command.response_representation = Google::Apis::DfareportingV2_8::UserRole::Representation command.response_class = Google::Apis::DfareportingV2_8::UserRole command.params['profileId'] = profile_id unless profile_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 user roles, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] account_user_role_only # Select only account level user roles not associated with any specific # subaccount. # @param [Array, Fixnum] ids # Select only user roles with the specified IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "userrole*2015" will return objects with names like "userrole June # 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "userrole" will match objects with name "my # userrole", "userrole 2015", or simply "userrole". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] subaccount_id # Select only user roles that belong to this subaccount. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserRolesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserRolesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_roles(profile_id, account_user_role_only: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRoles', options) command.response_representation = Google::Apis::DfareportingV2_8::UserRolesListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::UserRolesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['accountUserRoleOnly'] = account_user_role_only unless account_user_role_only.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_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 an existing user role. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User role ID. # @param [Google::Apis::DfareportingV2_8::UserRole] user_role_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserRole] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role(profile_id, id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/userRoles', options) command.request_representation = Google::Apis::DfareportingV2_8::UserRole::Representation command.request_object = user_role_object command.response_representation = Google::Apis::DfareportingV2_8::UserRole::Representation command.response_class = Google::Apis::DfareportingV2_8::UserRole command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing user role. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV2_8::UserRole] user_role_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::UserRole] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/userRoles', options) command.request_representation = Google::Apis::DfareportingV2_8::UserRole::Representation command.request_object = user_role_object command.response_representation = Google::Apis::DfareportingV2_8::UserRole::Representation command.response_class = Google::Apis::DfareportingV2_8::UserRole command.params['profileId'] = profile_id unless profile_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 one video format by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Video format 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::VideoFormat] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::VideoFormat] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_video_format(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/videoFormats/{id}', options) command.response_representation = Google::Apis::DfareportingV2_8::VideoFormat::Representation command.response_class = Google::Apis::DfareportingV2_8::VideoFormat command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 available video formats. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV2_8::VideoFormatsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV2_8::VideoFormatsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_video_formats(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/videoFormats', options) command.response_representation = Google::Apis::DfareportingV2_8::VideoFormatsListResponse::Representation command.response_class = Google::Apis::DfareportingV2_8::VideoFormatsListResponse command.params['profileId'] = profile_id unless profile_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 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 end end google-api-client-0.19.8/generated/google/apis/playcustomapp_v1/0000755000004100000410000000000013252673044024623 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/playcustomapp_v1/representations.rb0000644000004100000410000000231213252673044030373 0ustar www-datawww-data# 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 PlaycustomappV1 class CustomApp class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomApp # @private class Representation < Google::Apis::Core::JsonRepresentation property :language_code, as: 'languageCode' property :title, as: 'title' end end end end end google-api-client-0.19.8/generated/google/apis/playcustomapp_v1/classes.rb0000644000004100000410000000305313252673044026606 0ustar www-datawww-data# 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 PlaycustomappV1 # This resource represents a custom app. class CustomApp include Google::Apis::Core::Hashable # Default listing language in BCP 47 format. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Title for the Android app. # 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) @language_code = args[:language_code] if args.key?(:language_code) @title = args[:title] if args.key?(:title) end end end end end google-api-client-0.19.8/generated/google/apis/playcustomapp_v1/service.rb0000644000004100000410000001214413252673044026612 0ustar www-datawww-data# 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 PlaycustomappV1 # Google Play Custom App Publishing API # # An API to publish custom Android apps. # # @example # require 'google/apis/playcustomapp_v1' # # Playcustomapp = Google::Apis::PlaycustomappV1 # Alias the module # service = Playcustomapp::PlaycustomappService.new # # @see https://developers.google.com/android/work/play/custom-app-api class PlaycustomappService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'playcustomapp/v1/accounts/') @batch_path = 'batch/playcustomapp/v1' end # Create and publish a new custom app. # @param [Fixnum] account # Developer account ID. # @param [Google::Apis::PlaycustomappV1::CustomApp] custom_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::PlaycustomappV1::CustomApp] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlaycustomappV1::CustomApp] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_custom_app(account, custom_app_object = 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, '{account}/customApps', options) else command = make_upload_command(:post, '{account}/customApps', options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::PlaycustomappV1::CustomApp::Representation command.request_object = custom_app_object command.response_representation = Google::Apis::PlaycustomappV1::CustomApp::Representation command.response_class = Google::Apis::PlaycustomappV1::CustomApp command.params['account'] = account unless account.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 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 end end google-api-client-0.19.8/generated/google/apis/cloudfunctions_v1.rb0000644000004100000410000000226013252673043025305 0ustar www-datawww-data# 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/cloudfunctions_v1/service.rb' require 'google/apis/cloudfunctions_v1/classes.rb' require 'google/apis/cloudfunctions_v1/representations.rb' module Google module Apis # Google Cloud Functions API # # API for managing lightweight user-provided functions executed in response to # events. # # @see https://cloud.google.com/functions module CloudfunctionsV1 VERSION = 'V1' REVISION = '20171208' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end google-api-client-0.19.8/generated/google/apis/oslogin_v1alpha.rb0000644000004100000410000000307313252673044024732 0ustar www-datawww-data# 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/oslogin_v1alpha/service.rb' require 'google/apis/oslogin_v1alpha/classes.rb' require 'google/apis/oslogin_v1alpha/representations.rb' module Google module Apis # Google Cloud OS Login API # # Manages OS login configuration for Google account users. # # @see https://cloud.google.com/compute/docs/oslogin/rest/ module OsloginV1alpha VERSION = 'V1alpha' REVISION = '20180117' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' # View and manage your Google Compute Engine resources AUTH_COMPUTE = 'https://www.googleapis.com/auth/compute' # View your Google Compute Engine resources AUTH_COMPUTE_READONLY = 'https://www.googleapis.com/auth/compute.readonly' end end end google-api-client-0.19.8/generated/google/apis/datastore_v1beta3.rb0000644000004100000410000000251613252673043025157 0ustar www-datawww-data# 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/datastore_v1beta3/service.rb' require 'google/apis/datastore_v1beta3/classes.rb' require 'google/apis/datastore_v1beta3/representations.rb' module Google module Apis # Google Cloud Datastore API # # Accesses the schemaless NoSQL database to provide fully managed, robust, # scalable storage for your application. # # @see https://cloud.google.com/datastore/ module DatastoreV1beta3 VERSION = 'V1beta3' REVISION = '20171024' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View and manage your Google Cloud Datastore data AUTH_DATASTORE = 'https://www.googleapis.com/auth/datastore' end end end google-api-client-0.19.8/generated/google/apis/admin_reports_v1.rb0000644000004100000410000000260613252673043025120 0ustar www-datawww-data# 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/admin_reports_v1/service.rb' require 'google/apis/admin_reports_v1/classes.rb' require 'google/apis/admin_reports_v1/representations.rb' module Google module Apis # Admin Reports API # # Fetches reports for the administrators of G Suite customers about the usage, # collaboration, security, and risk for their users. # # @see https://developers.google.com/admin-sdk/reports/ module AdminReportsV1 VERSION = 'ReportsV1' REVISION = '20180110' # View audit reports for your G Suite domain AUTH_ADMIN_REPORTS_AUDIT_READONLY = 'https://www.googleapis.com/auth/admin.reports.audit.readonly' # View usage reports for your G Suite domain AUTH_ADMIN_REPORTS_USAGE_READONLY = 'https://www.googleapis.com/auth/admin.reports.usage.readonly' end end end google-api-client-0.19.8/generated/google/apis/sheets_v4.rb0000644000004100000410000000312713252673044023550 0ustar www-datawww-data# 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/sheets_v4/service.rb' require 'google/apis/sheets_v4/classes.rb' require 'google/apis/sheets_v4/representations.rb' module Google module Apis # Google Sheets API # # Reads and writes Google Sheets. # # @see https://developers.google.com/sheets/ module SheetsV4 VERSION = 'V4' REVISION = '20180124' # View and manage the files in your Google Drive AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' # View and manage Google Drive files and folders that you have opened or created with this app AUTH_DRIVE_FILE = 'https://www.googleapis.com/auth/drive.file' # View the files in your Google Drive AUTH_DRIVE_READONLY = 'https://www.googleapis.com/auth/drive.readonly' # View and manage your spreadsheets in Google Drive AUTH_SPREADSHEETS = 'https://www.googleapis.com/auth/spreadsheets' # View your Google Spreadsheets AUTH_SPREADSHEETS_READONLY = 'https://www.googleapis.com/auth/spreadsheets.readonly' end end end google-api-client-0.19.8/generated/google/apis/cloudiot_v1beta1.rb0000644000004100000410000000247013252673043025010 0ustar www-datawww-data# 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/cloudiot_v1beta1/service.rb' require 'google/apis/cloudiot_v1beta1/classes.rb' require 'google/apis/cloudiot_v1beta1/representations.rb' module Google module Apis # Google Cloud IoT API # # Registers and manages IoT (Internet of Things) devices that connect to the # Google Cloud Platform. # # @see https://cloud.google.com/iot module CloudiotV1beta1 VERSION = 'V1beta1' REVISION = '20171227' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # Register and manage devices in the Google Cloud IoT service AUTH_CLOUDIOT = 'https://www.googleapis.com/auth/cloudiot' end end end google-api-client-0.19.8/generated/google/apis/books_v1.rb0000644000004100000410000000206313252673043023364 0ustar www-datawww-data# 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/books_v1/service.rb' require 'google/apis/books_v1/classes.rb' require 'google/apis/books_v1/representations.rb' module Google module Apis # Books API # # Searches for books and manages your Google Books library. # # @see https://developers.google.com/books/docs/v1/getting_started module BooksV1 VERSION = 'V1' REVISION = '20171127' # Manage your books AUTH_BOOKS = 'https://www.googleapis.com/auth/books' end end end google-api-client-0.19.8/generated/google/apis/androidpublisher_v1_1/0000755000004100000410000000000013252673043025477 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/androidpublisher_v1_1/representations.rb0000644000004100000410000000417513252673043031260 0ustar www-datawww-data# 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 AndroidpublisherV1_1 class InappPurchase 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 InappPurchase # @private class Representation < Google::Apis::Core::JsonRepresentation property :consumption_state, as: 'consumptionState' property :developer_payload, as: 'developerPayload' property :kind, as: 'kind' property :order_id, as: 'orderId' property :purchase_state, as: 'purchaseState' property :purchase_time, :numeric_string => true, as: 'purchaseTime' 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 google-api-client-0.19.8/generated/google/apis/androidpublisher_v1_1/classes.rb0000644000004100000410000001214413252673043027463 0ustar www-datawww-data# 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 AndroidpublisherV1_1 # An InappPurchase resource indicates the status of a user's inapp product # purchase. class InappPurchase include Google::Apis::Core::Hashable # The consumption state of the inapp product. Possible values are: # - Yet to be consumed # - Consumed # Corresponds to the JSON property `consumptionState` # @return [Fixnum] attr_accessor :consumption_state # A developer-specified string that contains supplemental information about an # order. # Corresponds to the JSON property `developerPayload` # @return [String] attr_accessor :developer_payload # This kind represents an inappPurchase object in the androidpublisher service. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The order id associated with the purchase of the inapp product. # Corresponds to the JSON property `orderId` # @return [String] attr_accessor :order_id # The purchase state of the order. Possible values are: # - Purchased # - Canceled # Corresponds to the JSON property `purchaseState` # @return [Fixnum] attr_accessor :purchase_state # The time the product was purchased, in milliseconds since the epoch (Jan 1, # 1970). # Corresponds to the JSON property `purchaseTime` # @return [Fixnum] attr_accessor :purchase_time # The type of purchase of the inapp product. 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 def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @consumption_state = args[:consumption_state] if args.key?(:consumption_state) @developer_payload = args[:developer_payload] if args.key?(:developer_payload) @kind = args[:kind] if args.key?(:kind) @order_id = args[:order_id] if args.key?(:order_id) @purchase_state = args[:purchase_state] if args.key?(:purchase_state) @purchase_time = args[:purchase_time] if args.key?(:purchase_time) @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 google-api-client-0.19.8/generated/google/apis/androidpublisher_v1_1/service.rb0000644000004100000410000002415213252673043027470 0ustar www-datawww-data# 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 AndroidpublisherV1_1 # Google Play Developer API # # Lets Android application developers access their Google Play accounts. # # @example # require 'google/apis/androidpublisher_v1_1' # # Androidpublisher = Google::Apis::AndroidpublisherV1_1 # Alias the module # service = Androidpublisher::AndroidPublisherService.new # # @see https://developers.google.com/android-publisher class AndroidPublisherService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'androidpublisher/v1.1/applications/') @batch_path = 'batch/androidpublisher/v1.1' 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, # 'com.some.thing'). # @param [String] product_id # The inapp product SKU (for example, 'com.some.thing.inapp1'). # @param [String] token # The token provided to the user's device when the inapp product was purchased. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidpublisherV1_1::InappPurchase] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidpublisherV1_1::InappPurchase] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inapppurchase(package_name, product_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{packageName}/inapp/{productId}/purchases/{token}', options) command.response_representation = Google::Apis::AndroidpublisherV1_1::InappPurchase::Representation command.response_class = Google::Apis::AndroidpublisherV1_1::InappPurchase command.params['packageName'] = package_name unless package_name.nil? command.params['productId'] = product_id unless product_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 # 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 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 end end google-api-client-0.19.8/generated/google/apis/language_v1beta1.rb0000644000004100000410000000267713252673044024763 0ustar www-datawww-data# 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/language_v1beta1/service.rb' require 'google/apis/language_v1beta1/classes.rb' require 'google/apis/language_v1beta1/representations.rb' module Google module Apis # Google Cloud Natural Language API # # Provides natural language understanding technologies to developers. Examples # include sentiment analysis, entity recognition, entity sentiment analysis, and # text annotations. # # @see https://cloud.google.com/natural-language/ module LanguageV1beta1 VERSION = 'V1beta1' REVISION = '20170911' # Apply machine learning models to reveal the structure and meaning of text AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end google-api-client-0.19.8/generated/google/apis/plus_v1.rb0000644000004100000410000000261513252673044023236 0ustar www-datawww-data# 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/plus_v1/service.rb' require 'google/apis/plus_v1/classes.rb' require 'google/apis/plus_v1/representations.rb' module Google module Apis # Google+ API # # Builds on top of the Google+ platform. # # @see https://developers.google.com/+/api/ module PlusV1 VERSION = 'V1' REVISION = '20171030' # Know the list of people in your circles, your age range, and language AUTH_PLUS_LOGIN = 'https://www.googleapis.com/auth/plus.login' # Know who you are on Google AUTH_PLUS_ME = 'https://www.googleapis.com/auth/plus.me' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' # View your basic profile info AUTH_USERINFO_PROFILE = 'https://www.googleapis.com/auth/userinfo.profile' end end end google-api-client-0.19.8/generated/google/apis/games_configuration_v1configuration.rb0000644000004100000410000000235213252673043031063 0ustar www-datawww-data# 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/games_configuration_v1configuration/service.rb' require 'google/apis/games_configuration_v1configuration/classes.rb' require 'google/apis/games_configuration_v1configuration/representations.rb' module Google module Apis # Google Play Game Services Publishing API # # The Publishing API for Google Play Game Services. # # @see https://developers.google.com/games/services module GamesConfigurationV1configuration VERSION = 'V1configuration' REVISION = '20170912' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' end end end google-api-client-0.19.8/generated/google/apis/tasks_v1.rb0000644000004100000410000000220713252673044023375 0ustar www-datawww-data# 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/tasks_v1/service.rb' require 'google/apis/tasks_v1/classes.rb' require 'google/apis/tasks_v1/representations.rb' module Google module Apis # Tasks API # # Lets you manage your tasks and task lists. # # @see https://developers.google.com/google-apps/tasks/firstapp module TasksV1 VERSION = 'V1' REVISION = '20141121' # Manage your tasks AUTH_TASKS = 'https://www.googleapis.com/auth/tasks' # View your tasks AUTH_TASKS_READONLY = 'https://www.googleapis.com/auth/tasks.readonly' end end end google-api-client-0.19.8/generated/google/apis/appstate_v1/0000755000004100000410000000000013252673043023542 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/appstate_v1/representations.rb0000644000004100000410000000532013252673043027314 0ustar www-datawww-data# 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 AppstateV1 class GetResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WriteResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_state_version, as: 'currentStateVersion' property :data, as: 'data' property :kind, as: 'kind' property :state_key, as: 'stateKey' end end class ListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AppstateV1::GetResponse, decorator: Google::Apis::AppstateV1::GetResponse::Representation property :kind, as: 'kind' property :maximum_key_count, as: 'maximumKeyCount' end end class UpdateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, as: 'data' property :kind, as: 'kind' end end class WriteResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_state_version, as: 'currentStateVersion' property :kind, as: 'kind' property :state_key, as: 'stateKey' end end end end end google-api-client-0.19.8/generated/google/apis/appstate_v1/classes.rb0000644000004100000410000001213413252673043025525 0ustar www-datawww-data# 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 AppstateV1 # This is a JSON template for an app state resource. class GetResponse include Google::Apis::Core::Hashable # The current app state version. # Corresponds to the JSON property `currentStateVersion` # @return [String] attr_accessor :current_state_version # The requested data. # Corresponds to the JSON property `data` # @return [String] attr_accessor :data # Uniquely identifies the type of this resource. Value is always the fixed # string appstate#getResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The key for the data. # Corresponds to the JSON property `stateKey` # @return [Fixnum] attr_accessor :state_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_state_version = args[:current_state_version] if args.key?(:current_state_version) @data = args[:data] if args.key?(:data) @kind = args[:kind] if args.key?(:kind) @state_key = args[:state_key] if args.key?(:state_key) end end # This is a JSON template to convert a list-response for app state. class ListResponse include Google::Apis::Core::Hashable # The app state data. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string appstate#listResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The maximum number of keys allowed for this user. # Corresponds to the JSON property `maximumKeyCount` # @return [Fixnum] attr_accessor :maximum_key_count def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @maximum_key_count = args[:maximum_key_count] if args.key?(:maximum_key_count) end end # This is a JSON template for a requests which update app state class UpdateRequest include Google::Apis::Core::Hashable # The new app state data that your application is trying to update with. # Corresponds to the JSON property `data` # @return [String] attr_accessor :data # Uniquely identifies the type of this resource. Value is always the fixed # string appstate#updateRequest. # 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) @data = args[:data] if args.key?(:data) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for an app state write result. class WriteResult include Google::Apis::Core::Hashable # The version of the data for this key on the server. # Corresponds to the JSON property `currentStateVersion` # @return [String] attr_accessor :current_state_version # Uniquely identifies the type of this resource. Value is always the fixed # string appstate#writeResult. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The written key. # Corresponds to the JSON property `stateKey` # @return [Fixnum] attr_accessor :state_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_state_version = args[:current_state_version] if args.key?(:current_state_version) @kind = args[:kind] if args.key?(:kind) @state_key = args[:state_key] if args.key?(:state_key) end end end end end google-api-client-0.19.8/generated/google/apis/appstate_v1/service.rb0000644000004100000410000003403313252673043025532 0ustar www-datawww-data# 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 AppstateV1 # Google App State API # # The Google App State API. # # @example # require 'google/apis/appstate_v1' # # Appstate = Google::Apis::AppstateV1 # Alias the module # service = Appstate::AppStateService.new # # @see https://developers.google.com/games/services/web/api/states class AppStateService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'appstate/v1/') @batch_path = 'batch/appstate/v1' end # Clears (sets to empty) the data for the passed key if and only if the passed # version matches the currently stored version. This method results in a # conflict error on version mismatch. # @param [Fixnum] state_key # The key for the data to be retrieved. # @param [String] current_data_version # The version of the data to be cleared. Version strings are returned by the # server. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AppstateV1::WriteResult] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppstateV1::WriteResult] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def clear_state(state_key, current_data_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'states/{stateKey}/clear', options) command.response_representation = Google::Apis::AppstateV1::WriteResult::Representation command.response_class = Google::Apis::AppstateV1::WriteResult command.params['stateKey'] = state_key unless state_key.nil? command.query['currentDataVersion'] = current_data_version unless current_data_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 # Deletes a key and the data associated with it. The key is removed and no # longer counts against the key quota. Note that since this method is not safe # in the face of concurrent modifications, it should only be used for # development and testing purposes. Invoking this method in shipping code can # result in data loss and data corruption. # @param [Fixnum] state_key # The key for the data to be retrieved. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_state(state_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'states/{stateKey}', options) command.params['stateKey'] = state_key unless state_key.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 the data corresponding to the passed key. If the key does not exist # on the server, an HTTP 404 will be returned. # @param [Fixnum] state_key # The key for the data to be retrieved. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AppstateV1::GetResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppstateV1::GetResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_state(state_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'states/{stateKey}', options) command.response_representation = Google::Apis::AppstateV1::GetResponse::Representation command.response_class = Google::Apis::AppstateV1::GetResponse command.params['stateKey'] = state_key unless state_key.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 states keys, and optionally the state data. # @param [Boolean] include_data # Whether to include the full data in addition to the version number # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AppstateV1::ListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppstateV1::ListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_states(include_data: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'states', options) command.response_representation = Google::Apis::AppstateV1::ListResponse::Representation command.response_class = Google::Apis::AppstateV1::ListResponse command.query['includeData'] = include_data unless include_data.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 # Update the data associated with the input key if and only if the passed # version matches the currently stored version. This method is safe in the face # of concurrent writes. Maximum per-key size is 128KB. # @param [Fixnum] state_key # The key for the data to be retrieved. # @param [Google::Apis::AppstateV1::UpdateRequest] update_request_object # @param [String] current_state_version # The version of the app state your application is attempting to update. If this # does not match the current version, this method will return a conflict error. # If there is no data stored on the server for this key, the update will succeed # irrespective of the value of this parameter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AppstateV1::WriteResult] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppstateV1::WriteResult] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_state(state_key, update_request_object = nil, current_state_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'states/{stateKey}', options) command.request_representation = Google::Apis::AppstateV1::UpdateRequest::Representation command.request_object = update_request_object command.response_representation = Google::Apis::AppstateV1::WriteResult::Representation command.response_class = Google::Apis::AppstateV1::WriteResult command.params['stateKey'] = state_key unless state_key.nil? command.query['currentStateVersion'] = current_state_version unless current_state_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 protected 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 end end google-api-client-0.19.8/generated/google/apis/pagespeedonline_v1.rb0000644000004100000410000000211213252673044025405 0ustar www-datawww-data# 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/pagespeedonline_v1/service.rb' require 'google/apis/pagespeedonline_v1/classes.rb' require 'google/apis/pagespeedonline_v1/representations.rb' module Google module Apis # PageSpeed Insights API # # Analyzes the performance of a web page and provides tailored suggestions to # make that page faster. # # @see https://developers.google.com/speed/docs/insights/v1/getting_started module PagespeedonlineV1 VERSION = 'V1' REVISION = '20180108' end end end google-api-client-0.19.8/generated/google/apis/datastore_v1beta3/0000755000004100000410000000000013252673043024626 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/datastore_v1beta3/representations.rb0000644000004100000410000007166413252673043030416 0ustar www-datawww-data# 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 DatastoreV1beta3 class AllocateIdsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AllocateIdsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ArrayValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BeginTransactionRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BeginTransactionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CommitRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CommitResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompositeFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Entity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EntityResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Filter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1CommonMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1EntityFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1ExportEntitiesMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1ExportEntitiesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1ImportEntitiesMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1Progress class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GqlQuery class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GqlQueryParameter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Key class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class KindExpression class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LatLng class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LookupRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LookupResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Mutation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MutationResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PartitionId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PathElement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Projection class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PropertyFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PropertyOrder class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PropertyReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Query class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryResultBatch class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReadOnly class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReadOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReadWrite class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReserveIdsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReserveIdsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RollbackRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RollbackResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RunQueryRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RunQueryResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TransactionOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Value class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AllocateIdsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :keys, as: 'keys', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation end end class AllocateIdsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :keys, as: 'keys', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation end end class ArrayValue # @private class Representation < Google::Apis::Core::JsonRepresentation collection :values, as: 'values', class: Google::Apis::DatastoreV1beta3::Value, decorator: Google::Apis::DatastoreV1beta3::Value::Representation end end class BeginTransactionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :transaction_options, as: 'transactionOptions', class: Google::Apis::DatastoreV1beta3::TransactionOptions, decorator: Google::Apis::DatastoreV1beta3::TransactionOptions::Representation end end class BeginTransactionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :transaction, :base64 => true, as: 'transaction' end end class CommitRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :mode, as: 'mode' collection :mutations, as: 'mutations', class: Google::Apis::DatastoreV1beta3::Mutation, decorator: Google::Apis::DatastoreV1beta3::Mutation::Representation property :transaction, :base64 => true, as: 'transaction' end end class CommitResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :index_updates, as: 'indexUpdates' collection :mutation_results, as: 'mutationResults', class: Google::Apis::DatastoreV1beta3::MutationResult, decorator: Google::Apis::DatastoreV1beta3::MutationResult::Representation end end class CompositeFilter # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filters, as: 'filters', class: Google::Apis::DatastoreV1beta3::Filter, decorator: Google::Apis::DatastoreV1beta3::Filter::Representation property :op, as: 'op' end end class Entity # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation hash :properties, as: 'properties', class: Google::Apis::DatastoreV1beta3::Value, decorator: Google::Apis::DatastoreV1beta3::Value::Representation end end class EntityResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :cursor, :base64 => true, as: 'cursor' property :entity, as: 'entity', class: Google::Apis::DatastoreV1beta3::Entity, decorator: Google::Apis::DatastoreV1beta3::Entity::Representation property :version, :numeric_string => true, as: 'version' end end class Filter # @private class Representation < Google::Apis::Core::JsonRepresentation property :composite_filter, as: 'compositeFilter', class: Google::Apis::DatastoreV1beta3::CompositeFilter, decorator: Google::Apis::DatastoreV1beta3::CompositeFilter::Representation property :property_filter, as: 'propertyFilter', class: Google::Apis::DatastoreV1beta3::PropertyFilter, decorator: Google::Apis::DatastoreV1beta3::PropertyFilter::Representation end end class GoogleDatastoreAdminV1beta1CommonMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime' hash :labels, as: 'labels' property :operation_type, as: 'operationType' property :start_time, as: 'startTime' property :state, as: 'state' end end class GoogleDatastoreAdminV1beta1EntityFilter # @private class Representation < Google::Apis::Core::JsonRepresentation collection :kinds, as: 'kinds' collection :namespace_ids, as: 'namespaceIds' end end class GoogleDatastoreAdminV1beta1ExportEntitiesMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1CommonMetadata, decorator: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1CommonMetadata::Representation property :entity_filter, as: 'entityFilter', class: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1EntityFilter, decorator: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1EntityFilter::Representation property :output_url_prefix, as: 'outputUrlPrefix' property :progress_bytes, as: 'progressBytes', class: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress, decorator: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress::Representation property :progress_entities, as: 'progressEntities', class: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress, decorator: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress::Representation end end class GoogleDatastoreAdminV1beta1ExportEntitiesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :output_url, as: 'outputUrl' end end class GoogleDatastoreAdminV1beta1ImportEntitiesMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1CommonMetadata, decorator: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1CommonMetadata::Representation property :entity_filter, as: 'entityFilter', class: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1EntityFilter, decorator: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1EntityFilter::Representation property :input_url, as: 'inputUrl' property :progress_bytes, as: 'progressBytes', class: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress, decorator: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress::Representation property :progress_entities, as: 'progressEntities', class: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress, decorator: Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress::Representation end end class GoogleDatastoreAdminV1beta1Progress # @private class Representation < Google::Apis::Core::JsonRepresentation property :work_completed, :numeric_string => true, as: 'workCompleted' property :work_estimated, :numeric_string => true, as: 'workEstimated' end end class GqlQuery # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_literals, as: 'allowLiterals' hash :named_bindings, as: 'namedBindings', class: Google::Apis::DatastoreV1beta3::GqlQueryParameter, decorator: Google::Apis::DatastoreV1beta3::GqlQueryParameter::Representation collection :positional_bindings, as: 'positionalBindings', class: Google::Apis::DatastoreV1beta3::GqlQueryParameter, decorator: Google::Apis::DatastoreV1beta3::GqlQueryParameter::Representation property :query_string, as: 'queryString' end end class GqlQueryParameter # @private class Representation < Google::Apis::Core::JsonRepresentation property :cursor, :base64 => true, as: 'cursor' property :value, as: 'value', class: Google::Apis::DatastoreV1beta3::Value, decorator: Google::Apis::DatastoreV1beta3::Value::Representation end end class Key # @private class Representation < Google::Apis::Core::JsonRepresentation property :partition_id, as: 'partitionId', class: Google::Apis::DatastoreV1beta3::PartitionId, decorator: Google::Apis::DatastoreV1beta3::PartitionId::Representation collection :path, as: 'path', class: Google::Apis::DatastoreV1beta3::PathElement, decorator: Google::Apis::DatastoreV1beta3::PathElement::Representation end end class KindExpression # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class LatLng # @private class Representation < Google::Apis::Core::JsonRepresentation property :latitude, as: 'latitude' property :longitude, as: 'longitude' end end class LookupRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :keys, as: 'keys', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation property :read_options, as: 'readOptions', class: Google::Apis::DatastoreV1beta3::ReadOptions, decorator: Google::Apis::DatastoreV1beta3::ReadOptions::Representation end end class LookupResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :deferred, as: 'deferred', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation collection :found, as: 'found', class: Google::Apis::DatastoreV1beta3::EntityResult, decorator: Google::Apis::DatastoreV1beta3::EntityResult::Representation collection :missing, as: 'missing', class: Google::Apis::DatastoreV1beta3::EntityResult, decorator: Google::Apis::DatastoreV1beta3::EntityResult::Representation end end class Mutation # @private class Representation < Google::Apis::Core::JsonRepresentation property :base_version, :numeric_string => true, as: 'baseVersion' property :delete, as: 'delete', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation property :insert, as: 'insert', class: Google::Apis::DatastoreV1beta3::Entity, decorator: Google::Apis::DatastoreV1beta3::Entity::Representation property :update, as: 'update', class: Google::Apis::DatastoreV1beta3::Entity, decorator: Google::Apis::DatastoreV1beta3::Entity::Representation property :upsert, as: 'upsert', class: Google::Apis::DatastoreV1beta3::Entity, decorator: Google::Apis::DatastoreV1beta3::Entity::Representation end end class MutationResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :conflict_detected, as: 'conflictDetected' property :key, as: 'key', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation property :version, :numeric_string => true, as: 'version' end end class PartitionId # @private class Representation < Google::Apis::Core::JsonRepresentation property :namespace_id, as: 'namespaceId' property :project_id, as: 'projectId' end end class PathElement # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class Projection # @private class Representation < Google::Apis::Core::JsonRepresentation property :property, as: 'property', class: Google::Apis::DatastoreV1beta3::PropertyReference, decorator: Google::Apis::DatastoreV1beta3::PropertyReference::Representation end end class PropertyFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :op, as: 'op' property :property, as: 'property', class: Google::Apis::DatastoreV1beta3::PropertyReference, decorator: Google::Apis::DatastoreV1beta3::PropertyReference::Representation property :value, as: 'value', class: Google::Apis::DatastoreV1beta3::Value, decorator: Google::Apis::DatastoreV1beta3::Value::Representation end end class PropertyOrder # @private class Representation < Google::Apis::Core::JsonRepresentation property :direction, as: 'direction' property :property, as: 'property', class: Google::Apis::DatastoreV1beta3::PropertyReference, decorator: Google::Apis::DatastoreV1beta3::PropertyReference::Representation end end class PropertyReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class Query # @private class Representation < Google::Apis::Core::JsonRepresentation collection :distinct_on, as: 'distinctOn', class: Google::Apis::DatastoreV1beta3::PropertyReference, decorator: Google::Apis::DatastoreV1beta3::PropertyReference::Representation property :end_cursor, :base64 => true, as: 'endCursor' property :filter, as: 'filter', class: Google::Apis::DatastoreV1beta3::Filter, decorator: Google::Apis::DatastoreV1beta3::Filter::Representation collection :kind, as: 'kind', class: Google::Apis::DatastoreV1beta3::KindExpression, decorator: Google::Apis::DatastoreV1beta3::KindExpression::Representation property :limit, as: 'limit' property :offset, as: 'offset' collection :order, as: 'order', class: Google::Apis::DatastoreV1beta3::PropertyOrder, decorator: Google::Apis::DatastoreV1beta3::PropertyOrder::Representation collection :projection, as: 'projection', class: Google::Apis::DatastoreV1beta3::Projection, decorator: Google::Apis::DatastoreV1beta3::Projection::Representation property :start_cursor, :base64 => true, as: 'startCursor' end end class QueryResultBatch # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_cursor, :base64 => true, as: 'endCursor' property :entity_result_type, as: 'entityResultType' collection :entity_results, as: 'entityResults', class: Google::Apis::DatastoreV1beta3::EntityResult, decorator: Google::Apis::DatastoreV1beta3::EntityResult::Representation property :more_results, as: 'moreResults' property :skipped_cursor, :base64 => true, as: 'skippedCursor' property :skipped_results, as: 'skippedResults' property :snapshot_version, :numeric_string => true, as: 'snapshotVersion' end end class ReadOnly # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ReadOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :read_consistency, as: 'readConsistency' property :transaction, :base64 => true, as: 'transaction' end end class ReadWrite # @private class Representation < Google::Apis::Core::JsonRepresentation property :previous_transaction, :base64 => true, as: 'previousTransaction' end end class ReserveIdsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :database_id, as: 'databaseId' collection :keys, as: 'keys', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation end end class ReserveIdsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation end end class RollbackRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :transaction, :base64 => true, as: 'transaction' end end class RollbackResponse # @private class Representation < Google::Apis::Core::JsonRepresentation end end class RunQueryRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :gql_query, as: 'gqlQuery', class: Google::Apis::DatastoreV1beta3::GqlQuery, decorator: Google::Apis::DatastoreV1beta3::GqlQuery::Representation property :partition_id, as: 'partitionId', class: Google::Apis::DatastoreV1beta3::PartitionId, decorator: Google::Apis::DatastoreV1beta3::PartitionId::Representation property :query, as: 'query', class: Google::Apis::DatastoreV1beta3::Query, decorator: Google::Apis::DatastoreV1beta3::Query::Representation property :read_options, as: 'readOptions', class: Google::Apis::DatastoreV1beta3::ReadOptions, decorator: Google::Apis::DatastoreV1beta3::ReadOptions::Representation end end class RunQueryResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch, as: 'batch', class: Google::Apis::DatastoreV1beta3::QueryResultBatch, decorator: Google::Apis::DatastoreV1beta3::QueryResultBatch::Representation property :query, as: 'query', class: Google::Apis::DatastoreV1beta3::Query, decorator: Google::Apis::DatastoreV1beta3::Query::Representation end end class TransactionOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :read_only, as: 'readOnly', class: Google::Apis::DatastoreV1beta3::ReadOnly, decorator: Google::Apis::DatastoreV1beta3::ReadOnly::Representation property :read_write, as: 'readWrite', class: Google::Apis::DatastoreV1beta3::ReadWrite, decorator: Google::Apis::DatastoreV1beta3::ReadWrite::Representation end end class Value # @private class Representation < Google::Apis::Core::JsonRepresentation property :array_value, as: 'arrayValue', class: Google::Apis::DatastoreV1beta3::ArrayValue, decorator: Google::Apis::DatastoreV1beta3::ArrayValue::Representation property :blob_value, :base64 => true, as: 'blobValue' property :boolean_value, as: 'booleanValue' property :double_value, as: 'doubleValue' property :entity_value, as: 'entityValue', class: Google::Apis::DatastoreV1beta3::Entity, decorator: Google::Apis::DatastoreV1beta3::Entity::Representation property :exclude_from_indexes, as: 'excludeFromIndexes' property :geo_point_value, as: 'geoPointValue', class: Google::Apis::DatastoreV1beta3::LatLng, decorator: Google::Apis::DatastoreV1beta3::LatLng::Representation property :integer_value, :numeric_string => true, as: 'integerValue' property :key_value, as: 'keyValue', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation property :meaning, as: 'meaning' property :null_value, as: 'nullValue' property :string_value, as: 'stringValue' property :timestamp_value, as: 'timestampValue' end end end end end google-api-client-0.19.8/generated/google/apis/datastore_v1beta3/classes.rb0000644000004100000410000017325513252673043026625 0ustar www-datawww-data# 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 DatastoreV1beta3 # The request for Datastore.AllocateIds. class AllocateIdsRequest include Google::Apis::Core::Hashable # A list of keys with incomplete key paths for which to allocate IDs. # No key may be reserved/read-only. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @keys = args[:keys] if args.key?(:keys) end end # The response for Datastore.AllocateIds. class AllocateIdsResponse include Google::Apis::Core::Hashable # The keys specified in the request (in the same order), each with # its key path completed with a newly allocated ID. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @keys = args[:keys] if args.key?(:keys) end end # An array value. class ArrayValue include Google::Apis::Core::Hashable # Values in the array. # The order of this array may not be preserved if it contains a mix of # indexed and unindexed values. # 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) @values = args[:values] if args.key?(:values) end end # The request for Datastore.BeginTransaction. class BeginTransactionRequest include Google::Apis::Core::Hashable # Options for beginning a new transaction. # Transactions can be created explicitly with calls to # Datastore.BeginTransaction or implicitly by setting # ReadOptions.new_transaction in read requests. # Corresponds to the JSON property `transactionOptions` # @return [Google::Apis::DatastoreV1beta3::TransactionOptions] attr_accessor :transaction_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @transaction_options = args[:transaction_options] if args.key?(:transaction_options) end end # The response for Datastore.BeginTransaction. class BeginTransactionResponse include Google::Apis::Core::Hashable # The transaction identifier (always present). # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :transaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @transaction = args[:transaction] if args.key?(:transaction) end end # The request for Datastore.Commit. class CommitRequest include Google::Apis::Core::Hashable # The type of commit to perform. Defaults to `TRANSACTIONAL`. # Corresponds to the JSON property `mode` # @return [String] attr_accessor :mode # The mutations to perform. # When mode is `TRANSACTIONAL`, mutations affecting a single entity are # applied in order. The following sequences of mutations affecting a single # entity are not permitted in a single `Commit` request: # - `insert` followed by `insert` # - `update` followed by `insert` # - `upsert` followed by `insert` # - `delete` followed by `update` # When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single # entity. # Corresponds to the JSON property `mutations` # @return [Array] attr_accessor :mutations # The identifier of the transaction associated with the commit. A # transaction identifier is returned by a call to # Datastore.BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :transaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @mode = args[:mode] if args.key?(:mode) @mutations = args[:mutations] if args.key?(:mutations) @transaction = args[:transaction] if args.key?(:transaction) end end # The response for Datastore.Commit. class CommitResponse include Google::Apis::Core::Hashable # The number of index entries updated during the commit, or zero if none were # updated. # Corresponds to the JSON property `indexUpdates` # @return [Fixnum] attr_accessor :index_updates # The result of performing the mutations. # The i-th mutation result corresponds to the i-th mutation in the request. # Corresponds to the JSON property `mutationResults` # @return [Array] attr_accessor :mutation_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @index_updates = args[:index_updates] if args.key?(:index_updates) @mutation_results = args[:mutation_results] if args.key?(:mutation_results) end end # A filter that merges multiple other filters using the given operator. class CompositeFilter include Google::Apis::Core::Hashable # The list of filters to combine. # Must contain at least one filter. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters # The operator for combining multiple filters. # Corresponds to the JSON property `op` # @return [String] attr_accessor :op def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filters = args[:filters] if args.key?(:filters) @op = args[:op] if args.key?(:op) end end # A Datastore data object. # An entity is limited to 1 megabyte when stored. That _roughly_ # corresponds to a limit of 1 megabyte for the serialized form of this # message. class Entity include Google::Apis::Core::Hashable # A unique identifier for an entity. # If a key's partition ID or any of its path kinds or names are # reserved/read-only, the key is reserved/read-only. # A reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `key` # @return [Google::Apis::DatastoreV1beta3::Key] attr_accessor :key # The entity's properties. # The map's keys are property names. # A property name matching regex `__.*__` is reserved. # A reserved property name is forbidden in certain documented contexts. # The name must not contain more than 500 characters. # The name cannot be `""`. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key = args[:key] if args.key?(:key) @properties = args[:properties] if args.key?(:properties) end end # The result of fetching an entity from Datastore. class EntityResult include Google::Apis::Core::Hashable # A cursor that points to the position after the result entity. # Set only when the `EntityResult` is part of a `QueryResultBatch` message. # Corresponds to the JSON property `cursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :cursor # A Datastore data object. # An entity is limited to 1 megabyte when stored. That _roughly_ # corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `entity` # @return [Google::Apis::DatastoreV1beta3::Entity] attr_accessor :entity # The version of the entity, a strictly positive number that monotonically # increases with changes to the entity. # This field is set for `FULL` entity # results. # For missing entities in `LookupResponse`, this # is the version of the snapshot that was used to look up the entity, and it # is always set except for eventually consistent reads. # 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) @cursor = args[:cursor] if args.key?(:cursor) @entity = args[:entity] if args.key?(:entity) @version = args[:version] if args.key?(:version) end end # A holder for any type of filter. class Filter include Google::Apis::Core::Hashable # A filter that merges multiple other filters using the given operator. # Corresponds to the JSON property `compositeFilter` # @return [Google::Apis::DatastoreV1beta3::CompositeFilter] attr_accessor :composite_filter # A filter on a specific property. # Corresponds to the JSON property `propertyFilter` # @return [Google::Apis::DatastoreV1beta3::PropertyFilter] attr_accessor :property_filter def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @composite_filter = args[:composite_filter] if args.key?(:composite_filter) @property_filter = args[:property_filter] if args.key?(:property_filter) end end # Metadata common to all Datastore Admin operations. class GoogleDatastoreAdminV1beta1CommonMetadata include Google::Apis::Core::Hashable # The time the operation ended, either successfully or otherwise. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # The client-assigned labels which were provided when the operation was # created. May also include additional labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The type of the operation. Can be used as a filter in # ListOperationsRequest. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # The time that work began on the operation. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # The current state of the Operation. # 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) @end_time = args[:end_time] if args.key?(:end_time) @labels = args[:labels] if args.key?(:labels) @operation_type = args[:operation_type] if args.key?(:operation_type) @start_time = args[:start_time] if args.key?(:start_time) @state = args[:state] if args.key?(:state) end end # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). # Example usage: # Entire project: # kinds=[], namespace_ids=[] # Kinds Foo and Bar in all namespaces: # kinds=['Foo', 'Bar'], namespace_ids=[] # Kinds Foo and Bar only in the default namespace: # kinds=['Foo', 'Bar'], namespace_ids=[''] # Kinds Foo and Bar in both the default and Baz namespaces: # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] # The entire Baz namespace: # kinds=[], namespace_ids=['Baz'] class GoogleDatastoreAdminV1beta1EntityFilter include Google::Apis::Core::Hashable # If empty, then this represents all kinds. # Corresponds to the JSON property `kinds` # @return [Array] attr_accessor :kinds # An empty list represents all namespaces. This is the preferred # usage for projects that don't use namespaces. # An empty string element represents the default namespace. This should be # used if the project has data in non-default namespaces, but doesn't want to # include them. # Each namespace in this list must be unique. # Corresponds to the JSON property `namespaceIds` # @return [Array] attr_accessor :namespace_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kinds = args[:kinds] if args.key?(:kinds) @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids) end end # Metadata for ExportEntities operations. class GoogleDatastoreAdminV1beta1ExportEntitiesMetadata include Google::Apis::Core::Hashable # Metadata common to all Datastore Admin operations. # Corresponds to the JSON property `common` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1CommonMetadata] attr_accessor :common # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). # Example usage: # Entire project: # kinds=[], namespace_ids=[] # Kinds Foo and Bar in all namespaces: # kinds=['Foo', 'Bar'], namespace_ids=[] # Kinds Foo and Bar only in the default namespace: # kinds=['Foo', 'Bar'], namespace_ids=[''] # Kinds Foo and Bar in both the default and Baz namespaces: # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] # The entire Baz namespace: # kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter # Location for the export metadata and data files. This will be the same # value as the # google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix # field. The final output location is provided in # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix # Measures the progress of a particular metric. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_bytes # Measures the progress of a particular metric. # Corresponds to the JSON property `progressEntities` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_entities def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @output_url_prefix = args[:output_url_prefix] if args.key?(:output_url_prefix) @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) @progress_entities = args[:progress_entities] if args.key?(:progress_entities) end end # The response for # google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1beta1ExportEntitiesResponse include Google::Apis::Core::Hashable # Location of the output metadata file. This can be used to begin an import # into Cloud Datastore (this project or another project). See # google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. # Only present if the operation completed successfully. # Corresponds to the JSON property `outputUrl` # @return [String] attr_accessor :output_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @output_url = args[:output_url] if args.key?(:output_url) end end # Metadata for ImportEntities operations. class GoogleDatastoreAdminV1beta1ImportEntitiesMetadata include Google::Apis::Core::Hashable # Metadata common to all Datastore Admin operations. # Corresponds to the JSON property `common` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1CommonMetadata] attr_accessor :common # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). # Example usage: # Entire project: # kinds=[], namespace_ids=[] # Kinds Foo and Bar in all namespaces: # kinds=['Foo', 'Bar'], namespace_ids=[] # Kinds Foo and Bar only in the default namespace: # kinds=['Foo', 'Bar'], namespace_ids=[''] # Kinds Foo and Bar in both the default and Baz namespaces: # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] # The entire Baz namespace: # kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter # The location of the import metadata file. This will be the same value as # the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url # field. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url # Measures the progress of a particular metric. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_bytes # Measures the progress of a particular metric. # Corresponds to the JSON property `progressEntities` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_entities def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @input_url = args[:input_url] if args.key?(:input_url) @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) @progress_entities = args[:progress_entities] if args.key?(:progress_entities) end end # Measures the progress of a particular metric. class GoogleDatastoreAdminV1beta1Progress include Google::Apis::Core::Hashable # The amount of work that has been completed. Note that this may be greater # than work_estimated. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed # An estimate of how much work needs to be performed. May be zero if the # work estimate is unavailable. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @work_completed = args[:work_completed] if args.key?(:work_completed) @work_estimated = args[:work_estimated] if args.key?(:work_estimated) end end # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). class GqlQuery include Google::Apis::Core::Hashable # When false, the query string must not contain any literals and instead must # bind all values. For example, # `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while # `SELECT * FROM Kind WHERE a = @value` is. # Corresponds to the JSON property `allowLiterals` # @return [Boolean] attr_accessor :allow_literals alias_method :allow_literals?, :allow_literals # For each non-reserved named binding site in the query string, there must be # a named parameter with that name, but not necessarily the inverse. # Key must match regex `A-Za-z_$*`, must not match regex # `__.*__`, and must not be `""`. # Corresponds to the JSON property `namedBindings` # @return [Hash] attr_accessor :named_bindings # Numbered binding site @1 references the first numbered parameter, # effectively using 1-based indexing, rather than the usual 0. # For each binding site numbered i in `query_string`, there must be an i-th # numbered parameter. The inverse must also be true. # Corresponds to the JSON property `positionalBindings` # @return [Array] attr_accessor :positional_bindings # A string of the format described # [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # Corresponds to the JSON property `queryString` # @return [String] attr_accessor :query_string def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allow_literals = args[:allow_literals] if args.key?(:allow_literals) @named_bindings = args[:named_bindings] if args.key?(:named_bindings) @positional_bindings = args[:positional_bindings] if args.key?(:positional_bindings) @query_string = args[:query_string] if args.key?(:query_string) end end # A binding parameter for a GQL query. class GqlQueryParameter include Google::Apis::Core::Hashable # A query cursor. Query cursors are returned in query # result batches. # Corresponds to the JSON property `cursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :cursor # A message that can hold any of the supported value types and associated # metadata. # Corresponds to the JSON property `value` # @return [Google::Apis::DatastoreV1beta3::Value] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cursor = args[:cursor] if args.key?(:cursor) @value = args[:value] if args.key?(:value) end end # A unique identifier for an entity. # If a key's partition ID or any of its path kinds or names are # reserved/read-only, the key is reserved/read-only. # A reserved/read-only key is forbidden in certain documented contexts. class Key include Google::Apis::Core::Hashable # A partition ID identifies a grouping of entities. The grouping is always # by project and namespace, however the namespace ID may be empty. # A partition ID contains several dimensions: # project ID and namespace ID. # Partition dimensions: # - May be `""`. # - Must be valid UTF-8 bytes. # - Must have values that match regex `[A-Za-z\d\.\-_]`1,100`` # If the value of any dimension matches regex `__.*__`, the partition is # reserved/read-only. # A reserved/read-only partition ID is forbidden in certain documented # contexts. # Foreign partition IDs (in which the project ID does # not match the context project ID ) are discouraged. # Reads and writes of foreign partition IDs may fail if the project is not in an # active state. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DatastoreV1beta3::PartitionId] attr_accessor :partition_id # The entity path. # An entity path consists of one or more elements composed of a kind and a # string or numerical identifier, which identify entities. The first # element identifies a _root entity_, the second element identifies # a _child_ of the root entity, the third element identifies a child of the # second entity, and so forth. The entities identified by all prefixes of # the path are called the element's _ancestors_. # An entity path is always fully complete: *all* of the entity's ancestors # are required to be in the path along with the entity identifier itself. # The only exception is that in some documented cases, the identifier in the # last path element (for the entity) itself may be omitted. For example, # the last path element of the key of `Mutation.insert` may have no # identifier. # A path can never be empty, and a path can have at most 100 elements. # Corresponds to the JSON property `path` # @return [Array] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @partition_id = args[:partition_id] if args.key?(:partition_id) @path = args[:path] if args.key?(:path) end end # A representation of a kind. class KindExpression include Google::Apis::Core::Hashable # The name of the kind. # 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 # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. class LatLng include Google::Apis::Core::Hashable # The latitude in degrees. It must be in the range [-90.0, +90.0]. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude # The longitude in degrees. It must be in the range [-180.0, +180.0]. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @latitude = args[:latitude] if args.key?(:latitude) @longitude = args[:longitude] if args.key?(:longitude) end end # The request for Datastore.Lookup. class LookupRequest include Google::Apis::Core::Hashable # Keys of entities to look up. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys # The options shared by read requests. # Corresponds to the JSON property `readOptions` # @return [Google::Apis::DatastoreV1beta3::ReadOptions] attr_accessor :read_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @keys = args[:keys] if args.key?(:keys) @read_options = args[:read_options] if args.key?(:read_options) end end # The response for Datastore.Lookup. class LookupResponse include Google::Apis::Core::Hashable # A list of keys that were not looked up due to resource constraints. The # order of results in this field is undefined and has no relation to the # order of the keys in the input. # Corresponds to the JSON property `deferred` # @return [Array] attr_accessor :deferred # Entities found as `ResultType.FULL` entities. The order of results in this # field is undefined and has no relation to the order of the keys in the # input. # Corresponds to the JSON property `found` # @return [Array] attr_accessor :found # Entities not found as `ResultType.KEY_ONLY` entities. The order of results # in this field is undefined and has no relation to the order of the keys # in the input. # Corresponds to the JSON property `missing` # @return [Array] attr_accessor :missing def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deferred = args[:deferred] if args.key?(:deferred) @found = args[:found] if args.key?(:found) @missing = args[:missing] if args.key?(:missing) end end # A mutation to apply to an entity. class Mutation include Google::Apis::Core::Hashable # The version of the entity that this mutation is being applied to. If this # does not match the current version on the server, the mutation conflicts. # Corresponds to the JSON property `baseVersion` # @return [Fixnum] attr_accessor :base_version # A unique identifier for an entity. # If a key's partition ID or any of its path kinds or names are # reserved/read-only, the key is reserved/read-only. # A reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `delete` # @return [Google::Apis::DatastoreV1beta3::Key] attr_accessor :delete # A Datastore data object. # An entity is limited to 1 megabyte when stored. That _roughly_ # corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `insert` # @return [Google::Apis::DatastoreV1beta3::Entity] attr_accessor :insert # A Datastore data object. # An entity is limited to 1 megabyte when stored. That _roughly_ # corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `update` # @return [Google::Apis::DatastoreV1beta3::Entity] attr_accessor :update # A Datastore data object. # An entity is limited to 1 megabyte when stored. That _roughly_ # corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `upsert` # @return [Google::Apis::DatastoreV1beta3::Entity] attr_accessor :upsert def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @base_version = args[:base_version] if args.key?(:base_version) @delete = args[:delete] if args.key?(:delete) @insert = args[:insert] if args.key?(:insert) @update = args[:update] if args.key?(:update) @upsert = args[:upsert] if args.key?(:upsert) end end # The result of applying a mutation. class MutationResult include Google::Apis::Core::Hashable # Whether a conflict was detected for this mutation. Always false when a # conflict detection strategy field is not set in the mutation. # Corresponds to the JSON property `conflictDetected` # @return [Boolean] attr_accessor :conflict_detected alias_method :conflict_detected?, :conflict_detected # A unique identifier for an entity. # If a key's partition ID or any of its path kinds or names are # reserved/read-only, the key is reserved/read-only. # A reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `key` # @return [Google::Apis::DatastoreV1beta3::Key] attr_accessor :key # The version of the entity on the server after processing the mutation. If # the mutation doesn't change anything on the server, then the version will # be the version of the current entity or, if no entity is present, a version # that is strictly greater than the version of any previous entity and less # than the version of any possible future entity. # 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) @conflict_detected = args[:conflict_detected] if args.key?(:conflict_detected) @key = args[:key] if args.key?(:key) @version = args[:version] if args.key?(:version) end end # A partition ID identifies a grouping of entities. The grouping is always # by project and namespace, however the namespace ID may be empty. # A partition ID contains several dimensions: # project ID and namespace ID. # Partition dimensions: # - May be `""`. # - Must be valid UTF-8 bytes. # - Must have values that match regex `[A-Za-z\d\.\-_]`1,100`` # If the value of any dimension matches regex `__.*__`, the partition is # reserved/read-only. # A reserved/read-only partition ID is forbidden in certain documented # contexts. # Foreign partition IDs (in which the project ID does # not match the context project ID ) are discouraged. # Reads and writes of foreign partition IDs may fail if the project is not in an # active state. class PartitionId include Google::Apis::Core::Hashable # If not empty, the ID of the namespace to which the entities belong. # Corresponds to the JSON property `namespaceId` # @return [String] attr_accessor :namespace_id # The ID of the project to which the entities belong. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @namespace_id = args[:namespace_id] if args.key?(:namespace_id) @project_id = args[:project_id] if args.key?(:project_id) end end # A (kind, ID/name) pair used to construct a key path. # If either name or ID is set, the element is complete. # If neither is set, the element is incomplete. class PathElement include Google::Apis::Core::Hashable # The auto-allocated ID of the entity. # Never equal to zero. Values less than zero are discouraged and may not # be supported in the future. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The kind of the entity. # A kind matching regex `__.*__` is reserved/read-only. # A kind must not contain more than 1500 bytes when UTF-8 encoded. # Cannot be `""`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the entity. # A name matching regex `__.*__` is reserved/read-only. # A name must not be more than 1500 bytes when UTF-8 encoded. # Cannot be `""`. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # A representation of a property in a projection. class Projection include Google::Apis::Core::Hashable # A reference to a property relative to the kind expressions. # Corresponds to the JSON property `property` # @return [Google::Apis::DatastoreV1beta3::PropertyReference] 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 filter on a specific property. class PropertyFilter include Google::Apis::Core::Hashable # The operator to filter by. # Corresponds to the JSON property `op` # @return [String] attr_accessor :op # A reference to a property relative to the kind expressions. # Corresponds to the JSON property `property` # @return [Google::Apis::DatastoreV1beta3::PropertyReference] attr_accessor :property # A message that can hold any of the supported value types and associated # metadata. # Corresponds to the JSON property `value` # @return [Google::Apis::DatastoreV1beta3::Value] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @op = args[:op] if args.key?(:op) @property = args[:property] if args.key?(:property) @value = args[:value] if args.key?(:value) end end # The desired order for a specific property. class PropertyOrder include Google::Apis::Core::Hashable # The direction to order by. Defaults to `ASCENDING`. # Corresponds to the JSON property `direction` # @return [String] attr_accessor :direction # A reference to a property relative to the kind expressions. # Corresponds to the JSON property `property` # @return [Google::Apis::DatastoreV1beta3::PropertyReference] attr_accessor :property def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @direction = args[:direction] if args.key?(:direction) @property = args[:property] if args.key?(:property) end end # A reference to a property relative to the kind expressions. class PropertyReference include Google::Apis::Core::Hashable # The name of the property. # If name includes "."s, it may be interpreted as a property name path. # 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 # A query for entities. class Query include Google::Apis::Core::Hashable # The properties to make distinct. The query results will contain the first # result for each distinct combination of values for the given properties # (if empty, all results are returned). # Corresponds to the JSON property `distinctOn` # @return [Array] attr_accessor :distinct_on # An ending point for the query results. Query cursors are # returned in query result batches and # [can only be used to limit the same query](https://cloud.google.com/datastore/ # docs/concepts/queries#cursors_limits_and_offsets). # Corresponds to the JSON property `endCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :end_cursor # A holder for any type of filter. # Corresponds to the JSON property `filter` # @return [Google::Apis::DatastoreV1beta3::Filter] attr_accessor :filter # The kinds to query (if empty, returns entities of all kinds). # Currently at most 1 kind may be specified. # Corresponds to the JSON property `kind` # @return [Array] attr_accessor :kind # The maximum number of results to return. Applies after all other # constraints. Optional. # Unspecified is interpreted as no limit. # Must be >= 0 if specified. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit # The number of results to skip. Applies before limit, but after all other # constraints. Optional. Must be >= 0 if specified. # Corresponds to the JSON property `offset` # @return [Fixnum] attr_accessor :offset # The order to apply to the query results (if empty, order is unspecified). # Corresponds to the JSON property `order` # @return [Array] attr_accessor :order # The projection to return. Defaults to returning all properties. # Corresponds to the JSON property `projection` # @return [Array] attr_accessor :projection # A starting point for the query results. Query cursors are # returned in query result batches and # [can only be used to continue the same query](https://cloud.google.com/ # datastore/docs/concepts/queries#cursors_limits_and_offsets). # Corresponds to the JSON property `startCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :start_cursor def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @distinct_on = args[:distinct_on] if args.key?(:distinct_on) @end_cursor = args[:end_cursor] if args.key?(:end_cursor) @filter = args[:filter] if args.key?(:filter) @kind = args[:kind] if args.key?(:kind) @limit = args[:limit] if args.key?(:limit) @offset = args[:offset] if args.key?(:offset) @order = args[:order] if args.key?(:order) @projection = args[:projection] if args.key?(:projection) @start_cursor = args[:start_cursor] if args.key?(:start_cursor) end end # A batch of results produced by a query. class QueryResultBatch include Google::Apis::Core::Hashable # A cursor that points to the position after the last result in the batch. # Corresponds to the JSON property `endCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :end_cursor # The result type for every entity in `entity_results`. # Corresponds to the JSON property `entityResultType` # @return [String] attr_accessor :entity_result_type # The results for this batch. # Corresponds to the JSON property `entityResults` # @return [Array] attr_accessor :entity_results # The state of the query after the current batch. # Corresponds to the JSON property `moreResults` # @return [String] attr_accessor :more_results # A cursor that points to the position after the last skipped result. # Will be set when `skipped_results` != 0. # Corresponds to the JSON property `skippedCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :skipped_cursor # The number of results skipped, typically because of an offset. # Corresponds to the JSON property `skippedResults` # @return [Fixnum] attr_accessor :skipped_results # The version number of the snapshot this batch was returned from. # This applies to the range of results from the query's `start_cursor` (or # the beginning of the query if no cursor was given) to this batch's # `end_cursor` (not the query's `end_cursor`). # In a single transaction, subsequent query result batches for the same query # can have a greater snapshot version number. Each batch's snapshot version # is valid for all preceding batches. # The value will be zero for eventually consistent queries. # Corresponds to the JSON property `snapshotVersion` # @return [Fixnum] attr_accessor :snapshot_version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_cursor = args[:end_cursor] if args.key?(:end_cursor) @entity_result_type = args[:entity_result_type] if args.key?(:entity_result_type) @entity_results = args[:entity_results] if args.key?(:entity_results) @more_results = args[:more_results] if args.key?(:more_results) @skipped_cursor = args[:skipped_cursor] if args.key?(:skipped_cursor) @skipped_results = args[:skipped_results] if args.key?(:skipped_results) @snapshot_version = args[:snapshot_version] if args.key?(:snapshot_version) end end # Options specific to read-only transactions. class ReadOnly include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The options shared by read requests. class ReadOptions include Google::Apis::Core::Hashable # The non-transactional read consistency to use. # Cannot be set to `STRONG` for global queries. # Corresponds to the JSON property `readConsistency` # @return [String] attr_accessor :read_consistency # The identifier of the transaction in which to read. A # transaction identifier is returned by a call to # Datastore.BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :transaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @read_consistency = args[:read_consistency] if args.key?(:read_consistency) @transaction = args[:transaction] if args.key?(:transaction) end end # Options specific to read / write transactions. class ReadWrite include Google::Apis::Core::Hashable # The transaction identifier of the transaction being retried. # Corresponds to the JSON property `previousTransaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :previous_transaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @previous_transaction = args[:previous_transaction] if args.key?(:previous_transaction) end end # The request for Datastore.ReserveIds. class ReserveIdsRequest include Google::Apis::Core::Hashable # If not empty, the ID of the database against which to make the request. # Corresponds to the JSON property `databaseId` # @return [String] attr_accessor :database_id # A list of keys with complete key paths whose numeric IDs should not be # auto-allocated. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @database_id = args[:database_id] if args.key?(:database_id) @keys = args[:keys] if args.key?(:keys) end end # The response for Datastore.ReserveIds. class ReserveIdsResponse include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The request for Datastore.Rollback. class RollbackRequest include Google::Apis::Core::Hashable # The transaction identifier, returned by a call to # Datastore.BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :transaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @transaction = args[:transaction] if args.key?(:transaction) end end # The response for Datastore.Rollback. # (an empty message). class RollbackResponse include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The request for Datastore.RunQuery. class RunQueryRequest include Google::Apis::Core::Hashable # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # Corresponds to the JSON property `gqlQuery` # @return [Google::Apis::DatastoreV1beta3::GqlQuery] attr_accessor :gql_query # A partition ID identifies a grouping of entities. The grouping is always # by project and namespace, however the namespace ID may be empty. # A partition ID contains several dimensions: # project ID and namespace ID. # Partition dimensions: # - May be `""`. # - Must be valid UTF-8 bytes. # - Must have values that match regex `[A-Za-z\d\.\-_]`1,100`` # If the value of any dimension matches regex `__.*__`, the partition is # reserved/read-only. # A reserved/read-only partition ID is forbidden in certain documented # contexts. # Foreign partition IDs (in which the project ID does # not match the context project ID ) are discouraged. # Reads and writes of foreign partition IDs may fail if the project is not in an # active state. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DatastoreV1beta3::PartitionId] attr_accessor :partition_id # A query for entities. # Corresponds to the JSON property `query` # @return [Google::Apis::DatastoreV1beta3::Query] attr_accessor :query # The options shared by read requests. # Corresponds to the JSON property `readOptions` # @return [Google::Apis::DatastoreV1beta3::ReadOptions] attr_accessor :read_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @gql_query = args[:gql_query] if args.key?(:gql_query) @partition_id = args[:partition_id] if args.key?(:partition_id) @query = args[:query] if args.key?(:query) @read_options = args[:read_options] if args.key?(:read_options) end end # The response for Datastore.RunQuery. class RunQueryResponse include Google::Apis::Core::Hashable # A batch of results produced by a query. # Corresponds to the JSON property `batch` # @return [Google::Apis::DatastoreV1beta3::QueryResultBatch] attr_accessor :batch # A query for entities. # Corresponds to the JSON property `query` # @return [Google::Apis::DatastoreV1beta3::Query] attr_accessor :query def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch = args[:batch] if args.key?(:batch) @query = args[:query] if args.key?(:query) end end # Options for beginning a new transaction. # Transactions can be created explicitly with calls to # Datastore.BeginTransaction or implicitly by setting # ReadOptions.new_transaction in read requests. class TransactionOptions include Google::Apis::Core::Hashable # Options specific to read-only transactions. # Corresponds to the JSON property `readOnly` # @return [Google::Apis::DatastoreV1beta3::ReadOnly] attr_accessor :read_only # Options specific to read / write transactions. # Corresponds to the JSON property `readWrite` # @return [Google::Apis::DatastoreV1beta3::ReadWrite] attr_accessor :read_write def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @read_only = args[:read_only] if args.key?(:read_only) @read_write = args[:read_write] if args.key?(:read_write) end end # A message that can hold any of the supported value types and associated # metadata. class Value include Google::Apis::Core::Hashable # An array value. # Corresponds to the JSON property `arrayValue` # @return [Google::Apis::DatastoreV1beta3::ArrayValue] attr_accessor :array_value # A blob value. # May have at most 1,000,000 bytes. # When `exclude_from_indexes` is false, may have at most 1500 bytes. # In JSON requests, must be base64-encoded. # Corresponds to the JSON property `blobValue` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :blob_value # A boolean value. # Corresponds to the JSON property `booleanValue` # @return [Boolean] attr_accessor :boolean_value alias_method :boolean_value?, :boolean_value # A double value. # Corresponds to the JSON property `doubleValue` # @return [Float] attr_accessor :double_value # A Datastore data object. # An entity is limited to 1 megabyte when stored. That _roughly_ # corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `entityValue` # @return [Google::Apis::DatastoreV1beta3::Entity] attr_accessor :entity_value # If the value should be excluded from all indexes including those defined # explicitly. # Corresponds to the JSON property `excludeFromIndexes` # @return [Boolean] attr_accessor :exclude_from_indexes alias_method :exclude_from_indexes?, :exclude_from_indexes # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. # Corresponds to the JSON property `geoPointValue` # @return [Google::Apis::DatastoreV1beta3::LatLng] attr_accessor :geo_point_value # An integer value. # Corresponds to the JSON property `integerValue` # @return [Fixnum] attr_accessor :integer_value # A unique identifier for an entity. # If a key's partition ID or any of its path kinds or names are # reserved/read-only, the key is reserved/read-only. # A reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `keyValue` # @return [Google::Apis::DatastoreV1beta3::Key] attr_accessor :key_value # The `meaning` field should only be populated for backwards compatibility. # Corresponds to the JSON property `meaning` # @return [Fixnum] attr_accessor :meaning # A null value. # Corresponds to the JSON property `nullValue` # @return [String] attr_accessor :null_value # A UTF-8 encoded string value. # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 # bytes. # Otherwise, may be set to at least 1,000,000 bytes. # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value # A timestamp value. # When stored in the Datastore, precise only to microseconds; # any additional precision is rounded down. # Corresponds to the JSON property `timestampValue` # @return [String] attr_accessor :timestamp_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @array_value = args[:array_value] if args.key?(:array_value) @blob_value = args[:blob_value] if args.key?(:blob_value) @boolean_value = args[:boolean_value] if args.key?(:boolean_value) @double_value = args[:double_value] if args.key?(:double_value) @entity_value = args[:entity_value] if args.key?(:entity_value) @exclude_from_indexes = args[:exclude_from_indexes] if args.key?(:exclude_from_indexes) @geo_point_value = args[:geo_point_value] if args.key?(:geo_point_value) @integer_value = args[:integer_value] if args.key?(:integer_value) @key_value = args[:key_value] if args.key?(:key_value) @meaning = args[:meaning] if args.key?(:meaning) @null_value = args[:null_value] if args.key?(:null_value) @string_value = args[:string_value] if args.key?(:string_value) @timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value) end end end end end google-api-client-0.19.8/generated/google/apis/datastore_v1beta3/service.rb0000644000004100000410000004211013252673043026611 0ustar www-datawww-data# 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 DatastoreV1beta3 # Google Cloud Datastore API # # Accesses the schemaless NoSQL database to provide fully managed, robust, # scalable storage for your application. # # @example # require 'google/apis/datastore_v1beta3' # # Datastore = Google::Apis::DatastoreV1beta3 # Alias the module # service = Datastore::DatastoreService.new # # @see https://cloud.google.com/datastore/ class DatastoreService < 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://datastore.googleapis.com/', '') @batch_path = 'batch' end # Allocates IDs for the given keys, which is useful for referencing an entity # before it is inserted. # @param [String] project_id # The ID of the project against which to make the request. # @param [Google::Apis::DatastoreV1beta3::AllocateIdsRequest] allocate_ids_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::DatastoreV1beta3::AllocateIdsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DatastoreV1beta3::AllocateIdsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def allocate_project_ids(project_id, allocate_ids_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta3/projects/{projectId}:allocateIds', options) command.request_representation = Google::Apis::DatastoreV1beta3::AllocateIdsRequest::Representation command.request_object = allocate_ids_request_object command.response_representation = Google::Apis::DatastoreV1beta3::AllocateIdsResponse::Representation command.response_class = Google::Apis::DatastoreV1beta3::AllocateIdsResponse 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 # Begins a new transaction. # @param [String] project_id # The ID of the project against which to make the request. # @param [Google::Apis::DatastoreV1beta3::BeginTransactionRequest] begin_transaction_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::DatastoreV1beta3::BeginTransactionResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DatastoreV1beta3::BeginTransactionResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def begin_project_transaction(project_id, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta3/projects/{projectId}:beginTransaction', options) command.request_representation = Google::Apis::DatastoreV1beta3::BeginTransactionRequest::Representation command.request_object = begin_transaction_request_object command.response_representation = Google::Apis::DatastoreV1beta3::BeginTransactionResponse::Representation command.response_class = Google::Apis::DatastoreV1beta3::BeginTransactionResponse 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 # Commits a transaction, optionally creating, deleting or modifying some # entities. # @param [String] project_id # The ID of the project against which to make the request. # @param [Google::Apis::DatastoreV1beta3::CommitRequest] commit_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::DatastoreV1beta3::CommitResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DatastoreV1beta3::CommitResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project(project_id, commit_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta3/projects/{projectId}:commit', options) command.request_representation = Google::Apis::DatastoreV1beta3::CommitRequest::Representation command.request_object = commit_request_object command.response_representation = Google::Apis::DatastoreV1beta3::CommitResponse::Representation command.response_class = Google::Apis::DatastoreV1beta3::CommitResponse 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 # Looks up entities by key. # @param [String] project_id # The ID of the project against which to make the request. # @param [Google::Apis::DatastoreV1beta3::LookupRequest] lookup_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::DatastoreV1beta3::LookupResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DatastoreV1beta3::LookupResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project(project_id, lookup_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta3/projects/{projectId}:lookup', options) command.request_representation = Google::Apis::DatastoreV1beta3::LookupRequest::Representation command.request_object = lookup_request_object command.response_representation = Google::Apis::DatastoreV1beta3::LookupResponse::Representation command.response_class = Google::Apis::DatastoreV1beta3::LookupResponse 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 # Prevents the supplied keys' IDs from being auto-allocated by Cloud # Datastore. # @param [String] project_id # The ID of the project against which to make the request. # @param [Google::Apis::DatastoreV1beta3::ReserveIdsRequest] reserve_ids_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::DatastoreV1beta3::ReserveIdsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DatastoreV1beta3::ReserveIdsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def reserve_project_ids(project_id, reserve_ids_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta3/projects/{projectId}:reserveIds', options) command.request_representation = Google::Apis::DatastoreV1beta3::ReserveIdsRequest::Representation command.request_object = reserve_ids_request_object command.response_representation = Google::Apis::DatastoreV1beta3::ReserveIdsResponse::Representation command.response_class = Google::Apis::DatastoreV1beta3::ReserveIdsResponse 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 # Rolls back a transaction. # @param [String] project_id # The ID of the project against which to make the request. # @param [Google::Apis::DatastoreV1beta3::RollbackRequest] rollback_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::DatastoreV1beta3::RollbackResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DatastoreV1beta3::RollbackResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def rollback_project(project_id, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta3/projects/{projectId}:rollback', options) command.request_representation = Google::Apis::DatastoreV1beta3::RollbackRequest::Representation command.request_object = rollback_request_object command.response_representation = Google::Apis::DatastoreV1beta3::RollbackResponse::Representation command.response_class = Google::Apis::DatastoreV1beta3::RollbackResponse 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 # Queries for entities. # @param [String] project_id # The ID of the project against which to make the request. # @param [Google::Apis::DatastoreV1beta3::RunQueryRequest] run_query_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::DatastoreV1beta3::RunQueryResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DatastoreV1beta3::RunQueryResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def run_project_query(project_id, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta3/projects/{projectId}:runQuery', options) command.request_representation = Google::Apis::DatastoreV1beta3::RunQueryRequest::Representation command.request_object = run_query_request_object command.response_representation = Google::Apis::DatastoreV1beta3::RunQueryResponse::Representation command.response_class = Google::Apis::DatastoreV1beta3::RunQueryResponse 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 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 google-api-client-0.19.8/generated/google/apis/abusiveexperiencereport_v1.rb0000644000004100000410000000236013252673043027211 0ustar www-datawww-data# 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/abusiveexperiencereport_v1/service.rb' require 'google/apis/abusiveexperiencereport_v1/classes.rb' require 'google/apis/abusiveexperiencereport_v1/representations.rb' module Google module Apis # Google Abusive Experience Report API # # View Abusive Experience Report data, and get a list of sites that have a # significant number of abusive experiences. # # @see https://developers.google.com/abusive-experience-report/ module AbusiveexperiencereportV1 VERSION = 'V1' REVISION = '20171129' # Test scope for access to the Zoo service AUTH_XAPI_ZOO = 'https://www.googleapis.com/auth/xapi.zoo' end end end google-api-client-0.19.8/generated/google/apis/script_v1/0000755000004100000410000000000013252673044023226 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/script_v1/representations.rb0000644000004100000410000004741413252673044027012 0ustar www-datawww-data# 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 ScriptV1 class Content class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateProjectRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Deployment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentConfig 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 EntryPoint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExecutionError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExecutionRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExecutionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class File class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeAddOnEntryPoint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeExecutionApiConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeExecutionApiEntryPoint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeFunction class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeFunctionSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeProcess class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeScope class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeScopeSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeUser class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeWebAppConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleAppsScriptTypeWebAppEntryPoint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDeploymentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListScriptProcessesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListUserProcessesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListVersionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Metrics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricsValue 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 Project class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ScriptStackTraceElement 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 UpdateDeploymentRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Version class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Content # @private class Representation < Google::Apis::Core::JsonRepresentation collection :files, as: 'files', class: Google::Apis::ScriptV1::File, decorator: Google::Apis::ScriptV1::File::Representation property :script_id, as: 'scriptId' end end class CreateProjectRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :parent_id, as: 'parentId' property :title, as: 'title' end end class Deployment # @private class Representation < Google::Apis::Core::JsonRepresentation property :deployment_config, as: 'deploymentConfig', class: Google::Apis::ScriptV1::DeploymentConfig, decorator: Google::Apis::ScriptV1::DeploymentConfig::Representation property :deployment_id, as: 'deploymentId' collection :entry_points, as: 'entryPoints', class: Google::Apis::ScriptV1::EntryPoint, decorator: Google::Apis::ScriptV1::EntryPoint::Representation property :function_set, as: 'functionSet', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeFunctionSet, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeFunctionSet::Representation property :scope_set, as: 'scopeSet', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeScopeSet, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeScopeSet::Representation property :update_time, as: 'updateTime' end end class DeploymentConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :manifest_file_name, as: 'manifestFileName' property :script_id, as: 'scriptId' property :version_number, as: 'versionNumber' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class EntryPoint # @private class Representation < Google::Apis::Core::JsonRepresentation property :add_on, as: 'addOn', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeAddOnEntryPoint, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeAddOnEntryPoint::Representation property :entry_point_type, as: 'entryPointType' property :execution_api, as: 'executionApi', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeExecutionApiEntryPoint, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeExecutionApiEntryPoint::Representation property :web_app, as: 'webApp', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeWebAppEntryPoint, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeWebAppEntryPoint::Representation end end class ExecutionError # @private class Representation < Google::Apis::Core::JsonRepresentation property :error_message, as: 'errorMessage' property :error_type, as: 'errorType' collection :script_stack_trace_elements, as: 'scriptStackTraceElements', class: Google::Apis::ScriptV1::ScriptStackTraceElement, decorator: Google::Apis::ScriptV1::ScriptStackTraceElement::Representation end end class ExecutionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :dev_mode, as: 'devMode' property :function, as: 'function' collection :parameters, as: 'parameters' property :session_state, as: 'sessionState' end end class ExecutionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :result, as: 'result' end end class File # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :function_set, as: 'functionSet', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeFunctionSet, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeFunctionSet::Representation property :last_modify_user, as: 'lastModifyUser', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeUser, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeUser::Representation property :name, as: 'name' property :source, as: 'source' property :type, as: 'type' property :update_time, as: 'updateTime' end end class GoogleAppsScriptTypeAddOnEntryPoint # @private class Representation < Google::Apis::Core::JsonRepresentation property :add_on_type, as: 'addOnType' property :description, as: 'description' property :help_url, as: 'helpUrl' property :post_install_tip_url, as: 'postInstallTipUrl' property :report_issue_url, as: 'reportIssueUrl' property :title, as: 'title' end end class GoogleAppsScriptTypeExecutionApiConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :access, as: 'access' end end class GoogleAppsScriptTypeExecutionApiEntryPoint # @private class Representation < Google::Apis::Core::JsonRepresentation property :entry_point_config, as: 'entryPointConfig', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeExecutionApiConfig, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeExecutionApiConfig::Representation end end class GoogleAppsScriptTypeFunction # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class GoogleAppsScriptTypeFunctionSet # @private class Representation < Google::Apis::Core::JsonRepresentation collection :values, as: 'values', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeFunction, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeFunction::Representation end end class GoogleAppsScriptTypeProcess # @private class Representation < Google::Apis::Core::JsonRepresentation property :duration, as: 'duration' property :executing_user, as: 'executingUser' property :function_name, as: 'functionName' property :process_status, as: 'processStatus' property :process_type, as: 'processType' property :project_name, as: 'projectName' property :start_time, as: 'startTime' property :user_access_level, as: 'userAccessLevel' end end class GoogleAppsScriptTypeScope # @private class Representation < Google::Apis::Core::JsonRepresentation property :authorizer, as: 'authorizer' property :name, as: 'name' end end class GoogleAppsScriptTypeScopeSet # @private class Representation < Google::Apis::Core::JsonRepresentation collection :values, as: 'values', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeScope, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeScope::Representation end end class GoogleAppsScriptTypeUser # @private class Representation < Google::Apis::Core::JsonRepresentation property :domain, as: 'domain' property :email, as: 'email' property :name, as: 'name' property :photo_url, as: 'photoUrl' end end class GoogleAppsScriptTypeWebAppConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :access, as: 'access' property :execute_as, as: 'executeAs' end end class GoogleAppsScriptTypeWebAppEntryPoint # @private class Representation < Google::Apis::Core::JsonRepresentation property :entry_point_config, as: 'entryPointConfig', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeWebAppConfig, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeWebAppConfig::Representation property :url, as: 'url' end end class ListDeploymentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :deployments, as: 'deployments', class: Google::Apis::ScriptV1::Deployment, decorator: Google::Apis::ScriptV1::Deployment::Representation property :next_page_token, as: 'nextPageToken' end end class ListScriptProcessesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :processes, as: 'processes', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeProcess, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeProcess::Representation end end class ListUserProcessesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :processes, as: 'processes', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeProcess, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeProcess::Representation end end class ListVersionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :versions, as: 'versions', class: Google::Apis::ScriptV1::Version, decorator: Google::Apis::ScriptV1::Version::Representation end end class Metrics # @private class Representation < Google::Apis::Core::JsonRepresentation collection :active_users, as: 'activeUsers', class: Google::Apis::ScriptV1::MetricsValue, decorator: Google::Apis::ScriptV1::MetricsValue::Representation collection :failed_executions, as: 'failedExecutions', class: Google::Apis::ScriptV1::MetricsValue, decorator: Google::Apis::ScriptV1::MetricsValue::Representation collection :total_executions, as: 'totalExecutions', class: Google::Apis::ScriptV1::MetricsValue, decorator: Google::Apis::ScriptV1::MetricsValue::Representation end end class MetricsValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime' property :start_time, as: 'startTime' property :value, :numeric_string => true, as: 'value' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::ScriptV1::Status, decorator: Google::Apis::ScriptV1::Status::Representation hash :response, as: 'response' end end class Project # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :creator, as: 'creator', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeUser, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeUser::Representation property :last_modify_user, as: 'lastModifyUser', class: Google::Apis::ScriptV1::GoogleAppsScriptTypeUser, decorator: Google::Apis::ScriptV1::GoogleAppsScriptTypeUser::Representation property :parent_id, as: 'parentId' property :script_id, as: 'scriptId' property :title, as: 'title' property :update_time, as: 'updateTime' end end class ScriptStackTraceElement # @private class Representation < Google::Apis::Core::JsonRepresentation property :function, as: 'function' property :line_number, as: 'lineNumber' 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 UpdateDeploymentRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :deployment_config, as: 'deploymentConfig', class: Google::Apis::ScriptV1::DeploymentConfig, decorator: Google::Apis::ScriptV1::DeploymentConfig::Representation end end class Version # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :description, as: 'description' property :script_id, as: 'scriptId' property :version_number, as: 'versionNumber' end end end end end google-api-client-0.19.8/generated/google/apis/script_v1/classes.rb0000644000004100000410000012334413252673044025217 0ustar www-datawww-data# 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 ScriptV1 # The Content resource. class Content include Google::Apis::Core::Hashable # The list of script project files. # One of the files is a script manifest; it must be named "appsscript", # must have type of JSON, and include the manifest configurations for the # project. # Corresponds to the JSON property `files` # @return [Array] attr_accessor :files # The script project's Drive ID. # Corresponds to the JSON property `scriptId` # @return [String] attr_accessor :script_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @files = args[:files] if args.key?(:files) @script_id = args[:script_id] if args.key?(:script_id) end end # Request to create a script project. class CreateProjectRequest include Google::Apis::Core::Hashable # The Drive ID of a parent file that the created script project is bound to. # This is usually the ID of a Google Doc, Google Sheet, Google Form, or # Google Slides file. If not set, a standalone script project is created. # Corresponds to the JSON property `parentId` # @return [String] attr_accessor :parent_id # The title for the project. # 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) @parent_id = args[:parent_id] if args.key?(:parent_id) @title = args[:title] if args.key?(:title) end end # Representation of a single script deployment. class Deployment include Google::Apis::Core::Hashable # Metadata the defines how a deployment is configured. # Corresponds to the JSON property `deploymentConfig` # @return [Google::Apis::ScriptV1::DeploymentConfig] attr_accessor :deployment_config # The deployment ID for this deployment. # Corresponds to the JSON property `deploymentId` # @return [String] attr_accessor :deployment_id # The deployment's entry points. # Corresponds to the JSON property `entryPoints` # @return [Array] attr_accessor :entry_points # A set of functions. No duplicates are permitted. # Corresponds to the JSON property `functionSet` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeFunctionSet] attr_accessor :function_set # A set of scopes. No duplicates are permitted. # Corresponds to the JSON property `scopeSet` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeScopeSet] attr_accessor :scope_set # Last modified date time stamp. # 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) @deployment_config = args[:deployment_config] if args.key?(:deployment_config) @deployment_id = args[:deployment_id] if args.key?(:deployment_id) @entry_points = args[:entry_points] if args.key?(:entry_points) @function_set = args[:function_set] if args.key?(:function_set) @scope_set = args[:scope_set] if args.key?(:scope_set) @update_time = args[:update_time] if args.key?(:update_time) end end # Metadata the defines how a deployment is configured. class DeploymentConfig include Google::Apis::Core::Hashable # The description for this deployment. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The manifest file name for this deployment. # Corresponds to the JSON property `manifestFileName` # @return [String] attr_accessor :manifest_file_name # The script project's Drive ID. # Corresponds to the JSON property `scriptId` # @return [String] attr_accessor :script_id # The version number on which this deployment is based. # Corresponds to the JSON property `versionNumber` # @return [Fixnum] attr_accessor :version_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @manifest_file_name = args[:manifest_file_name] if args.key?(:manifest_file_name) @script_id = args[:script_id] if args.key?(:script_id) @version_number = args[:version_number] if args.key?(:version_number) 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 configuration that defines how a deployment is accessed externally. class EntryPoint include Google::Apis::Core::Hashable # An add-on entry point. # Corresponds to the JSON property `addOn` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeAddOnEntryPoint] attr_accessor :add_on # The type of the entry point. # Corresponds to the JSON property `entryPointType` # @return [String] attr_accessor :entry_point_type # An API executable entry point. # Corresponds to the JSON property `executionApi` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeExecutionApiEntryPoint] attr_accessor :execution_api # A web application entry point. # Corresponds to the JSON property `webApp` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeWebAppEntryPoint] attr_accessor :web_app def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @add_on = args[:add_on] if args.key?(:add_on) @entry_point_type = args[:entry_point_type] if args.key?(:entry_point_type) @execution_api = args[:execution_api] if args.key?(:execution_api) @web_app = args[:web_app] if args.key?(:web_app) end end # An object that provides information about the nature of an error resulting # from an attempted execution of a script function using the Apps Script API. # If a run call # succeeds but the script function (or Apps Script itself) throws an exception, # the response body's error field # contains a # Status object. The `Status` object's `details` field # contains an array with a single one of these `ExecutionError` objects. class ExecutionError include Google::Apis::Core::Hashable # The error message thrown by Apps Script, usually localized into the user's # language. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message # The error type, for example `TypeError` or `ReferenceError`. If the error # type is unavailable, this field is not included. # Corresponds to the JSON property `errorType` # @return [String] attr_accessor :error_type # An array of objects that provide a stack trace through the script to show # where the execution failed, with the deepest call first. # Corresponds to the JSON property `scriptStackTraceElements` # @return [Array] attr_accessor :script_stack_trace_elements def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_message = args[:error_message] if args.key?(:error_message) @error_type = args[:error_type] if args.key?(:error_type) @script_stack_trace_elements = args[:script_stack_trace_elements] if args.key?(:script_stack_trace_elements) end end # A request to run the function in a script. The script is identified by the # specified `script_id`. Executing a function on a script returns results # based on the implementation of the script. class ExecutionRequest include Google::Apis::Core::Hashable # If `true` and the user is an owner of the script, the script runs at the # most recently saved version rather than the version deployed for use with # the Apps Script API. Optional; default is `false`. # Corresponds to the JSON property `devMode` # @return [Boolean] attr_accessor :dev_mode alias_method :dev_mode?, :dev_mode # The name of the function to execute in the given script. The name does not # include parentheses or parameters. # Corresponds to the JSON property `function` # @return [String] attr_accessor :function # The parameters to be passed to the function being executed. The object type # for each parameter should match the expected type in Apps Script. # Parameters cannot be Apps Script-specific object types (such as a # `Document` or a `Calendar`); they can only be primitive types such as # `string`, `number`, `array`, `object`, or `boolean`. Optional. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # For Android add-ons only. An ID that represents the user's current session # in the Android app for Google Docs or Sheets, included as extra data in the # [Intent](https://developer.android.com/guide/components/intents-filters.html) # that launches the add-on. When an Android add-on is run with a session # state, it gains the privileges of a # [bound](https://developers.google.com/apps-script/guides/bound) # script—that is, it can access information like the user's current # cursor position (in Docs) or selected cell (in Sheets). To retrieve the # state, call # `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`. # Optional. # Corresponds to the JSON property `sessionState` # @return [String] attr_accessor :session_state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dev_mode = args[:dev_mode] if args.key?(:dev_mode) @function = args[:function] if args.key?(:function) @parameters = args[:parameters] if args.key?(:parameters) @session_state = args[:session_state] if args.key?(:session_state) end end # An object that provides the return value of a function executed using the # Apps Script API. If the script function returns successfully, the response # body's response field contains this # `ExecutionResponse` object. class ExecutionResponse include Google::Apis::Core::Hashable # The return value of the script function. The type matches the object type # returned in Apps Script. Functions called using the Apps Script API cannot # return Apps Script-specific objects (such as a `Document` or a `Calendar`); # they can only return primitive types such as a `string`, `number`, `array`, # `object`, or `boolean`. # Corresponds to the JSON property `result` # @return [Object] 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 # An individual file within a script project. # A file is a third-party source code created by one or more # developers. It can be a server-side JS code, HTML, or a # configuration file. Each script project can contain multiple files. class File include Google::Apis::Core::Hashable # Creation date timestamp. # This read-only field is only visible to users who have WRITER # permission for the script project. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # A set of functions. No duplicates are permitted. # Corresponds to the JSON property `functionSet` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeFunctionSet] attr_accessor :function_set # A simple user profile resource. # Corresponds to the JSON property `lastModifyUser` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeUser] attr_accessor :last_modify_user # The name of the file. The file extension is not part of the file # name, which can be identified from the type field. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The file content. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source # The type of the file. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Last modified date timestamp. # This read-only field is only visible to users who have WRITER # permission for the script project. # 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) @function_set = args[:function_set] if args.key?(:function_set) @last_modify_user = args[:last_modify_user] if args.key?(:last_modify_user) @name = args[:name] if args.key?(:name) @source = args[:source] if args.key?(:source) @type = args[:type] if args.key?(:type) @update_time = args[:update_time] if args.key?(:update_time) end end # An add-on entry point. class GoogleAppsScriptTypeAddOnEntryPoint include Google::Apis::Core::Hashable # The add-on's required list of supported container types. # Corresponds to the JSON property `addOnType` # @return [String] attr_accessor :add_on_type # The add-on's optional description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The add-on's optional help URL. # Corresponds to the JSON property `helpUrl` # @return [String] attr_accessor :help_url # The add-on's required post install tip URL. # Corresponds to the JSON property `postInstallTipUrl` # @return [String] attr_accessor :post_install_tip_url # The add-on's optional report issue URL. # Corresponds to the JSON property `reportIssueUrl` # @return [String] attr_accessor :report_issue_url # The add-on's required title. # 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) @add_on_type = args[:add_on_type] if args.key?(:add_on_type) @description = args[:description] if args.key?(:description) @help_url = args[:help_url] if args.key?(:help_url) @post_install_tip_url = args[:post_install_tip_url] if args.key?(:post_install_tip_url) @report_issue_url = args[:report_issue_url] if args.key?(:report_issue_url) @title = args[:title] if args.key?(:title) end end # API executable entry point configuration. class GoogleAppsScriptTypeExecutionApiConfig include Google::Apis::Core::Hashable # Who has permission to run the API executable. # Corresponds to the JSON property `access` # @return [String] attr_accessor :access def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @access = args[:access] if args.key?(:access) end end # An API executable entry point. class GoogleAppsScriptTypeExecutionApiEntryPoint include Google::Apis::Core::Hashable # API executable entry point configuration. # Corresponds to the JSON property `entryPointConfig` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeExecutionApiConfig] attr_accessor :entry_point_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entry_point_config = args[:entry_point_config] if args.key?(:entry_point_config) end end # Represents a function in a script project. class GoogleAppsScriptTypeFunction include Google::Apis::Core::Hashable # The function name in the script project. # 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 # A set of functions. No duplicates are permitted. class GoogleAppsScriptTypeFunctionSet include Google::Apis::Core::Hashable # A list of functions composing the set. # 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) @values = args[:values] if args.key?(:values) end end # Representation of a single script process execution that was started from # the script editor, a trigger, an application, or using the Apps Script API. # This is distinct from the `Operation` # resource, which only represents exeuctions started via the Apps Script API. class GoogleAppsScriptTypeProcess include Google::Apis::Core::Hashable # Duration the execution spent executing. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration # User-facing name for the user executing the script. # Corresponds to the JSON property `executingUser` # @return [String] attr_accessor :executing_user # Name of the function the started the execution. # Corresponds to the JSON property `functionName` # @return [String] attr_accessor :function_name # The executions status. # Corresponds to the JSON property `processStatus` # @return [String] attr_accessor :process_status # The executions type. # Corresponds to the JSON property `processType` # @return [String] attr_accessor :process_type # Name of the script being executed. # Corresponds to the JSON property `projectName` # @return [String] attr_accessor :project_name # Time the execution started. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # The executing users access level to the script. # Corresponds to the JSON property `userAccessLevel` # @return [String] attr_accessor :user_access_level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @duration = args[:duration] if args.key?(:duration) @executing_user = args[:executing_user] if args.key?(:executing_user) @function_name = args[:function_name] if args.key?(:function_name) @process_status = args[:process_status] if args.key?(:process_status) @process_type = args[:process_type] if args.key?(:process_type) @project_name = args[:project_name] if args.key?(:project_name) @start_time = args[:start_time] if args.key?(:start_time) @user_access_level = args[:user_access_level] if args.key?(:user_access_level) end end # Represents an authorization scope. class GoogleAppsScriptTypeScope include Google::Apis::Core::Hashable # Who authorized the scope. # Corresponds to the JSON property `authorizer` # @return [String] attr_accessor :authorizer # The scope's identifying string. # 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) @authorizer = args[:authorizer] if args.key?(:authorizer) @name = args[:name] if args.key?(:name) end end # A set of scopes. No duplicates are permitted. class GoogleAppsScriptTypeScopeSet include Google::Apis::Core::Hashable # List of scope values in the set. # 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) @values = args[:values] if args.key?(:values) end end # A simple user profile resource. class GoogleAppsScriptTypeUser include Google::Apis::Core::Hashable # The user's domain. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # The user's identifying email address. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The user's display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The user's photo. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @domain = args[:domain] if args.key?(:domain) @email = args[:email] if args.key?(:email) @name = args[:name] if args.key?(:name) @photo_url = args[:photo_url] if args.key?(:photo_url) end end # Web app entry point configuration. class GoogleAppsScriptTypeWebAppConfig include Google::Apis::Core::Hashable # Who has permission to run the web app. # Corresponds to the JSON property `access` # @return [String] attr_accessor :access # Who to execute the web app as. # Corresponds to the JSON property `executeAs` # @return [String] attr_accessor :execute_as def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @access = args[:access] if args.key?(:access) @execute_as = args[:execute_as] if args.key?(:execute_as) end end # A web application entry point. class GoogleAppsScriptTypeWebAppEntryPoint include Google::Apis::Core::Hashable # Web app entry point configuration. # Corresponds to the JSON property `entryPointConfig` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeWebAppConfig] attr_accessor :entry_point_config # The URL for the web application. # 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) @entry_point_config = args[:entry_point_config] if args.key?(:entry_point_config) @url = args[:url] if args.key?(:url) end end # Response with the list of deployments for the specified Apps Script project. class ListDeploymentsResponse include Google::Apis::Core::Hashable # The list of deployments. # Corresponds to the JSON property `deployments` # @return [Array] attr_accessor :deployments # The token that can be used in the next call to get 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) @deployments = args[:deployments] if args.key?(:deployments) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response with the list of # Process resources. class ListScriptProcessesResponse include Google::Apis::Core::Hashable # Token for the next page of results. If empty, there are no more pages # remaining. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # List of processes matching request parameters. # Corresponds to the JSON property `processes` # @return [Array] attr_accessor :processes 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) @processes = args[:processes] if args.key?(:processes) end end # Response with the list of # Process resources. class ListUserProcessesResponse include Google::Apis::Core::Hashable # Token for the next page of results. If empty, there are no more pages # remaining. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # List of processes matching request parameters. # Corresponds to the JSON property `processes` # @return [Array] attr_accessor :processes 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) @processes = args[:processes] if args.key?(:processes) end end # Response with the list of the versions for the specified script project. class ListVersionsResponse include Google::Apis::Core::Hashable # The token use to fetch the next page of records. if not exist in the # response, that means no more versions to list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of versions. # Corresponds to the JSON property `versions` # @return [Array] attr_accessor :versions 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) @versions = args[:versions] if args.key?(:versions) end end # Resource containing usage stats for a given script, based on the supplied # filter and mask present in the request. class Metrics include Google::Apis::Core::Hashable # Number of active users. # Corresponds to the JSON property `activeUsers` # @return [Array] attr_accessor :active_users # Number of failed executions. # Corresponds to the JSON property `failedExecutions` # @return [Array] attr_accessor :failed_executions # Number of total executions. # Corresponds to the JSON property `totalExecutions` # @return [Array] attr_accessor :total_executions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active_users = args[:active_users] if args.key?(:active_users) @failed_executions = args[:failed_executions] if args.key?(:failed_executions) @total_executions = args[:total_executions] if args.key?(:total_executions) end end # Metrics value that holds number of executions counted. class MetricsValue include Google::Apis::Core::Hashable # Required field indicating the end time of the interval. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Required field indicating the start time of the interval. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Indicates the number of executions counted. # Corresponds to the JSON property `value` # @return [Fixnum] attr_accessor :value 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) @value = args[:value] if args.key?(:value) end end # A representation of a execution of an Apps Script function that is started # using run. The execution response does not arrive until the function finishes # executing. The maximum execution runtime is listed in the [Apps Script quotas # guide](/apps-script/guides/services/quotas#current_limitations).

After the # execution is started, it can have one of four outcomes:

  • If the # script function returns successfully, the # response field contains an # ExecutionResponse object # with the function's return value in the object's `result` field.
    • #
  • If the script function (or Apps Script itself) throws an exception, the # error field contains a # Status object. The `Status` object's `details` # field contains an array with a single # ExecutionError object that # provides information about the nature of the error.
    • #
  • If the execution has not yet completed, # the done field is `false` and # the neither the `response` nor `error` fields are present.
    • #
  • If the `run` call itself fails (for example, because of a # malformed request or an authorization error), the method returns an HTTP # response code in the 4XX range with a different format for the response # body. Client libraries automatically convert a 4XX response into an # exception class.
    • #
class Operation include Google::Apis::Core::Hashable # This field indicates whether the script execution has completed. A completed # execution has a populated `response` field containing the ExecutionResponse # from function that was executed. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done # If a `run` call succeeds but the script function (or Apps Script itself) # throws an exception, the response body's error field contains this `Status` # object. # Corresponds to the JSON property `error` # @return [Google::Apis::ScriptV1::Status] attr_accessor :error # If the script function returns successfully, this field contains an # ExecutionResponse object with the function's return value. # 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) @response = args[:response] if args.key?(:response) end end # The script project resource. class Project include Google::Apis::Core::Hashable # When the script was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # A simple user profile resource. # Corresponds to the JSON property `creator` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeUser] attr_accessor :creator # A simple user profile resource. # Corresponds to the JSON property `lastModifyUser` # @return [Google::Apis::ScriptV1::GoogleAppsScriptTypeUser] attr_accessor :last_modify_user # The parent's Drive ID that the script will be attached to. This is usually # the ID of a Google Document or Google Sheet. This filed is optional, and # if not set, a stand-alone script will be created. # Corresponds to the JSON property `parentId` # @return [String] attr_accessor :parent_id # The script project's Drive ID. # Corresponds to the JSON property `scriptId` # @return [String] attr_accessor :script_id # The title for the project. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # When the script was last 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) @creator = args[:creator] if args.key?(:creator) @last_modify_user = args[:last_modify_user] if args.key?(:last_modify_user) @parent_id = args[:parent_id] if args.key?(:parent_id) @script_id = args[:script_id] if args.key?(:script_id) @title = args[:title] if args.key?(:title) @update_time = args[:update_time] if args.key?(:update_time) end end # A stack trace through the script that shows where the execution failed. class ScriptStackTraceElement include Google::Apis::Core::Hashable # The name of the function that failed. # Corresponds to the JSON property `function` # @return [String] attr_accessor :function # The line number where the script failed. # Corresponds to the JSON property `lineNumber` # @return [Fixnum] attr_accessor :line_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @function = args[:function] if args.key?(:function) @line_number = args[:line_number] if args.key?(:line_number) end end # If a `run` call succeeds but the script function (or Apps Script itself) # throws an exception, the response body's error field contains this `Status` # object. class Status include Google::Apis::Core::Hashable # The status code. For this API, this value either:
  • 3, indicating an ` # INVALID_ARGUMENT` error, or
  • 1, indicating a `CANCELLED` execution.
# Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code # An array that contains a single ExecutionError object that provides # information about the nature of the error. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details # A developer-facing error message, which is in English. Any user-facing error # message is localized and sent in the [google.rpc.Status.details](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 # Request with deployment information to update an existing deployment. class UpdateDeploymentRequest include Google::Apis::Core::Hashable # Metadata the defines how a deployment is configured. # Corresponds to the JSON property `deploymentConfig` # @return [Google::Apis::ScriptV1::DeploymentConfig] attr_accessor :deployment_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deployment_config = args[:deployment_config] if args.key?(:deployment_config) end end # A resource representing a script project version. A version is a "snapshot" # of a script project and is similar to a read-only branched release. When # creating deployments, the version to use must be specified. class Version include Google::Apis::Core::Hashable # When the version was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The description for this version. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The script project's Drive ID. # Corresponds to the JSON property `scriptId` # @return [String] attr_accessor :script_id # The incremental ID that is created by Apps Script when a version is # created. This is system assigned number and is immutable once created. # Corresponds to the JSON property `versionNumber` # @return [Fixnum] attr_accessor :version_number 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) @script_id = args[:script_id] if args.key?(:script_id) @version_number = args[:version_number] if args.key?(:version_number) end end end end end google-api-client-0.19.8/generated/google/apis/script_v1/service.rb0000644000004100000410000012377713252673044025234 0ustar www-datawww-data# 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 ScriptV1 # Google Apps Script API # # An API for managing and executing Google Apps Script projects. # # @example # require 'google/apis/script_v1' # # Script = Google::Apis::ScriptV1 # Alias the module # service = Script::ScriptService.new # # @see https://developers.google.com/apps-script/api/ class ScriptService < 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://script.googleapis.com/', '') @batch_path = 'batch' end # List information about processes made by or on behalf of a user, # such as process type and current status. # @param [Fixnum] page_size # The maximum number of returned processes per page of results. Defaults to # 50. # @param [String] page_token # The token for continuing a previous list request on the next page. This # should be set to the value of `nextPageToken` from a previous response. # @param [String] user_process_filter_deployment_id # Optional field used to limit returned processes to those originating from # projects with a specific deployment ID. # @param [String] user_process_filter_end_time # Optional field used to limit returned processes to those that completed # on or before the given timestamp. # @param [String] user_process_filter_function_name # Optional field used to limit returned processes to those originating from # a script function with the given function name. # @param [String] user_process_filter_project_name # Optional field used to limit returned processes to those originating from # projects with a specific project name. # @param [String] user_process_filter_script_id # Optional field used to limit returned processes to those originating from # projects with a specific script ID. # @param [String] user_process_filter_start_time # Optional field used to limit returned processes to those that were # started on or after the given timestamp. # @param [Array, String] user_process_filter_statuses # Optional field used to limit returned processes to those having one of # the specified process statuses. # @param [Array, String] user_process_filter_types # Optional field used to limit returned processes to those having one of # the specified process types. # @param [Array, String] user_process_filter_user_access_levels # Optional field used to limit returned processes to those having one of # the specified user access levels. # @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::ScriptV1::ListUserProcessesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::ListUserProcessesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_processes(page_size: nil, page_token: nil, user_process_filter_deployment_id: nil, user_process_filter_end_time: nil, user_process_filter_function_name: nil, user_process_filter_project_name: nil, user_process_filter_script_id: nil, user_process_filter_start_time: nil, user_process_filter_statuses: nil, user_process_filter_types: nil, user_process_filter_user_access_levels: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/processes', options) command.response_representation = Google::Apis::ScriptV1::ListUserProcessesResponse::Representation command.response_class = Google::Apis::ScriptV1::ListUserProcessesResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['userProcessFilter.deploymentId'] = user_process_filter_deployment_id unless user_process_filter_deployment_id.nil? command.query['userProcessFilter.endTime'] = user_process_filter_end_time unless user_process_filter_end_time.nil? command.query['userProcessFilter.functionName'] = user_process_filter_function_name unless user_process_filter_function_name.nil? command.query['userProcessFilter.projectName'] = user_process_filter_project_name unless user_process_filter_project_name.nil? command.query['userProcessFilter.scriptId'] = user_process_filter_script_id unless user_process_filter_script_id.nil? command.query['userProcessFilter.startTime'] = user_process_filter_start_time unless user_process_filter_start_time.nil? command.query['userProcessFilter.statuses'] = user_process_filter_statuses unless user_process_filter_statuses.nil? command.query['userProcessFilter.types'] = user_process_filter_types unless user_process_filter_types.nil? command.query['userProcessFilter.userAccessLevels'] = user_process_filter_user_access_levels unless user_process_filter_user_access_levels.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 information about a script's executed processes, such as process type # and current status. # @param [Fixnum] page_size # The maximum number of returned processes per page of results. Defaults to # 50. # @param [String] page_token # The token for continuing a previous list request on the next page. This # should be set to the value of `nextPageToken` from a previous response. # @param [String] script_id # The script ID of the project whose processes are listed. # @param [String] script_process_filter_deployment_id # Optional field used to limit returned processes to those originating from # projects with a specific deployment ID. # @param [String] script_process_filter_end_time # Optional field used to limit returned processes to those that completed # on or before the given timestamp. # @param [String] script_process_filter_function_name # Optional field used to limit returned processes to those originating from # a script function with the given function name. # @param [String] script_process_filter_start_time # Optional field used to limit returned processes to those that were # started on or after the given timestamp. # @param [Array, String] script_process_filter_statuses # Optional field used to limit returned processes to those having one of # the specified process statuses. # @param [Array, String] script_process_filter_types # Optional field used to limit returned processes to those having one of # the specified process types. # @param [Array, String] script_process_filter_user_access_levels # Optional field used to limit returned processes to those having one of # the specified user access levels. # @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::ScriptV1::ListScriptProcessesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::ListScriptProcessesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_process_script_processes(page_size: nil, page_token: nil, script_id: nil, script_process_filter_deployment_id: nil, script_process_filter_end_time: nil, script_process_filter_function_name: nil, script_process_filter_start_time: nil, script_process_filter_statuses: nil, script_process_filter_types: nil, script_process_filter_user_access_levels: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/processes:listScriptProcesses', options) command.response_representation = Google::Apis::ScriptV1::ListScriptProcessesResponse::Representation command.response_class = Google::Apis::ScriptV1::ListScriptProcessesResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['scriptId'] = script_id unless script_id.nil? command.query['scriptProcessFilter.deploymentId'] = script_process_filter_deployment_id unless script_process_filter_deployment_id.nil? command.query['scriptProcessFilter.endTime'] = script_process_filter_end_time unless script_process_filter_end_time.nil? command.query['scriptProcessFilter.functionName'] = script_process_filter_function_name unless script_process_filter_function_name.nil? command.query['scriptProcessFilter.startTime'] = script_process_filter_start_time unless script_process_filter_start_time.nil? command.query['scriptProcessFilter.statuses'] = script_process_filter_statuses unless script_process_filter_statuses.nil? command.query['scriptProcessFilter.types'] = script_process_filter_types unless script_process_filter_types.nil? command.query['scriptProcessFilter.userAccessLevels'] = script_process_filter_user_access_levels unless script_process_filter_user_access_levels.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, empty script project with no script files and a base # manifest file. # @param [Google::Apis::ScriptV1::CreateProjectRequest] create_project_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::ScriptV1::Project] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::Project] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(create_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects', options) command.request_representation = Google::Apis::ScriptV1::CreateProjectRequest::Representation command.request_object = create_project_request_object command.response_representation = Google::Apis::ScriptV1::Project::Representation command.response_class = Google::Apis::ScriptV1::Project 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 script project's metadata. # @param [String] script_id # The script project's Drive 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::ScriptV1::Project] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::Project] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(script_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{scriptId}', options) command.response_representation = Google::Apis::ScriptV1::Project::Representation command.response_class = Google::Apis::ScriptV1::Project command.params['scriptId'] = script_id unless script_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 the content of the script project, including the code source and # metadata for each script file. # @param [String] script_id # The script project's Drive ID. # @param [Fixnum] version_number # The version number of the project to retrieve. If not provided, the # project's HEAD version 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::ScriptV1::Content] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::Content] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content(script_id, version_number: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{scriptId}/content', options) command.response_representation = Google::Apis::ScriptV1::Content::Representation command.response_class = Google::Apis::ScriptV1::Content command.params['scriptId'] = script_id unless script_id.nil? command.query['versionNumber'] = version_number unless version_number.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 metrics data for scripts, such as number of executions and # active users. # @param [String] script_id # Required field indicating the script to get metrics for. # @param [String] metrics_filter_deployment_id # Optional field indicating a specific deployment to retrieve metrics from. # @param [String] metrics_granularity # Required field indicating what granularity of metrics are 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::ScriptV1::Metrics] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::Metrics] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metrics(script_id, metrics_filter_deployment_id: nil, metrics_granularity: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{scriptId}/metrics', options) command.response_representation = Google::Apis::ScriptV1::Metrics::Representation command.response_class = Google::Apis::ScriptV1::Metrics command.params['scriptId'] = script_id unless script_id.nil? command.query['metricsFilter.deploymentId'] = metrics_filter_deployment_id unless metrics_filter_deployment_id.nil? command.query['metricsGranularity'] = metrics_granularity unless metrics_granularity.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 content of the specified script project. # This content is stored as the HEAD version, and is used when the script is # executed as a trigger, in the script editor, in add-on preview mode, or as # a web app or Apps Script API in development mode. This clears all the # existing files in the project. # @param [String] script_id # The script project's Drive ID. # @param [Google::Apis::ScriptV1::Content] content_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::ScriptV1::Content] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::Content] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_content(script_id, content_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/projects/{scriptId}/content', options) command.request_representation = Google::Apis::ScriptV1::Content::Representation command.request_object = content_object command.response_representation = Google::Apis::ScriptV1::Content::Representation command.response_class = Google::Apis::ScriptV1::Content command.params['scriptId'] = script_id unless script_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 deployment of an Apps Script project. # @param [String] script_id # The script project's Drive ID. # @param [Google::Apis::ScriptV1::DeploymentConfig] deployment_config_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::ScriptV1::Deployment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::Deployment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deployment(script_id, deployment_config_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{scriptId}/deployments', options) command.request_representation = Google::Apis::ScriptV1::DeploymentConfig::Representation command.request_object = deployment_config_object command.response_representation = Google::Apis::ScriptV1::Deployment::Representation command.response_class = Google::Apis::ScriptV1::Deployment command.params['scriptId'] = script_id unless script_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 deployment of an Apps Script project. # @param [String] script_id # The script project's Drive ID. # @param [String] deployment_id # The deployment ID to be undeployed. # @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::ScriptV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::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_deployment(script_id, deployment_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/projects/{scriptId}/deployments/{deploymentId}', options) command.response_representation = Google::Apis::ScriptV1::Empty::Representation command.response_class = Google::Apis::ScriptV1::Empty command.params['scriptId'] = script_id unless script_id.nil? command.params['deploymentId'] = deployment_id unless 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 # Gets a deployment of an Apps Script project. # @param [String] script_id # The script project's Drive ID. # @param [String] deployment_id # The deployment 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::ScriptV1::Deployment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::Deployment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deployment(script_id, deployment_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{scriptId}/deployments/{deploymentId}', options) command.response_representation = Google::Apis::ScriptV1::Deployment::Representation command.response_class = Google::Apis::ScriptV1::Deployment command.params['scriptId'] = script_id unless script_id.nil? command.params['deploymentId'] = deployment_id unless 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 # Lists the deployments of an Apps Script project. # @param [String] script_id # The script project's Drive ID. # @param [Fixnum] page_size # The maximum number of deployments on each returned page. Defaults to 50. # @param [String] page_token # The token for continuing a previous list request on the next page. This # should be set to the value of `nextPageToken` from a previous 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::ScriptV1::ListDeploymentsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::ListDeploymentsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deployments(script_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{scriptId}/deployments', options) command.response_representation = Google::Apis::ScriptV1::ListDeploymentsResponse::Representation command.response_class = Google::Apis::ScriptV1::ListDeploymentsResponse command.params['scriptId'] = script_id unless script_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 a deployment of an Apps Script project. # @param [String] script_id # The script project's Drive ID. # @param [String] deployment_id # The deployment ID for this deployment. # @param [Google::Apis::ScriptV1::UpdateDeploymentRequest] update_deployment_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::ScriptV1::Deployment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::Deployment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deployment(script_id, deployment_id, update_deployment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/projects/{scriptId}/deployments/{deploymentId}', options) command.request_representation = Google::Apis::ScriptV1::UpdateDeploymentRequest::Representation command.request_object = update_deployment_request_object command.response_representation = Google::Apis::ScriptV1::Deployment::Representation command.response_class = Google::Apis::ScriptV1::Deployment command.params['scriptId'] = script_id unless script_id.nil? command.params['deploymentId'] = deployment_id unless 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 # Creates a new immutable version using the current code, with a unique # version number. # @param [String] script_id # The script project's Drive ID. # @param [Google::Apis::ScriptV1::Version] version_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::ScriptV1::Version] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::Version] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_version(script_id, version_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{scriptId}/versions', options) command.request_representation = Google::Apis::ScriptV1::Version::Representation command.request_object = version_object command.response_representation = Google::Apis::ScriptV1::Version::Representation command.response_class = Google::Apis::ScriptV1::Version command.params['scriptId'] = script_id unless script_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 version of a script project. # @param [String] script_id # The script project's Drive ID. # @param [Fixnum] version_number # The version number. # @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::ScriptV1::Version] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::Version] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_version(script_id, version_number, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{scriptId}/versions/{versionNumber}', options) command.response_representation = Google::Apis::ScriptV1::Version::Representation command.response_class = Google::Apis::ScriptV1::Version command.params['scriptId'] = script_id unless script_id.nil? command.params['versionNumber'] = version_number unless version_number.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 the versions of a script project. # @param [String] script_id # The script project's Drive ID. # @param [Fixnum] page_size # The maximum number of versions on each returned page. Defaults to 50. # @param [String] page_token # The token for continuing a previous list request on the next page. This # should be set to the value of `nextPageToken` from a previous 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::ScriptV1::ListVersionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::ListVersionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_versions(script_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{scriptId}/versions', options) command.response_representation = Google::Apis::ScriptV1::ListVersionsResponse::Representation command.response_class = Google::Apis::ScriptV1::ListVersionsResponse command.params['scriptId'] = script_id unless script_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 # Runs a function in an Apps Script project. The project must be deployed # for use with the Apps Script API. # This method requires authorization with an OAuth 2.0 token that includes at # least one of the scopes listed in the [Authorization](#authorization) # section; script projects that do not require authorization cannot be # executed through this API. To find the correct scopes to include in the # authentication token, open the project in the script editor, then select # **File > Project properties** and click the **Scopes** tab. # @param [String] script_id # The script ID of the script to be executed. To find the script ID, open # the project in the script editor and select **File > Project properties**. # @param [Google::Apis::ScriptV1::ExecutionRequest] execution_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::ScriptV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ScriptV1::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 run_script(script_id, execution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/scripts/{scriptId}:run', options) command.request_representation = Google::Apis::ScriptV1::ExecutionRequest::Representation command.request_object = execution_request_object command.response_representation = Google::Apis::ScriptV1::Operation::Representation command.response_class = Google::Apis::ScriptV1::Operation command.params['scriptId'] = script_id unless script_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 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 google-api-client-0.19.8/generated/google/apis/oauth2_v1.rb0000644000004100000410000000271013252673044023451 0ustar www-datawww-data# 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/oauth2_v1/service.rb' require 'google/apis/oauth2_v1/classes.rb' require 'google/apis/oauth2_v1/representations.rb' module Google module Apis # Google OAuth2 API # # Obtains end-user authorization grants for use with other Google APIs. # # @see https://developers.google.com/accounts/docs/OAuth2 module Oauth2V1 VERSION = 'V1' REVISION = '20170807' # Know the list of people in your circles, your age range, and language AUTH_PLUS_LOGIN = 'https://www.googleapis.com/auth/plus.login' # Know who you are on Google AUTH_PLUS_ME = 'https://www.googleapis.com/auth/plus.me' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' # View your basic profile info AUTH_USERINFO_PROFILE = 'https://www.googleapis.com/auth/userinfo.profile' end end end google-api-client-0.19.8/generated/google/apis/dns_v1/0000755000004100000410000000000013252673043022505 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/dns_v1/representations.rb0000644000004100000410000001357113252673043026266 0ustar www-datawww-data# 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 DnsV1 class Change class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListChangesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedZone class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListManagedZonesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Project class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Quota class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceRecordSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListResourceRecordSetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Change # @private class Representation < Google::Apis::Core::JsonRepresentation collection :additions, as: 'additions', class: Google::Apis::DnsV1::ResourceRecordSet, decorator: Google::Apis::DnsV1::ResourceRecordSet::Representation collection :deletions, as: 'deletions', class: Google::Apis::DnsV1::ResourceRecordSet, decorator: Google::Apis::DnsV1::ResourceRecordSet::Representation property :id, as: 'id' property :kind, as: 'kind' property :start_time, as: 'startTime' property :status, as: 'status' end end class ListChangesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :changes, as: 'changes', class: Google::Apis::DnsV1::Change, decorator: Google::Apis::DnsV1::Change::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class ManagedZone # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_time, as: 'creationTime' property :description, as: 'description' property :dns_name, as: 'dnsName' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :name_server_set, as: 'nameServerSet' collection :name_servers, as: 'nameServers' end end class ListManagedZonesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :managed_zones, as: 'managedZones', class: Google::Apis::DnsV1::ManagedZone, decorator: Google::Apis::DnsV1::ManagedZone::Representation property :next_page_token, as: 'nextPageToken' end end class Project # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :number, :numeric_string => true, as: 'number' property :quota, as: 'quota', class: Google::Apis::DnsV1::Quota, decorator: Google::Apis::DnsV1::Quota::Representation end end class Quota # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :managed_zones, as: 'managedZones' property :resource_records_per_rrset, as: 'resourceRecordsPerRrset' property :rrset_additions_per_change, as: 'rrsetAdditionsPerChange' property :rrset_deletions_per_change, as: 'rrsetDeletionsPerChange' property :rrsets_per_managed_zone, as: 'rrsetsPerManagedZone' property :total_rrdata_size_per_change, as: 'totalRrdataSizePerChange' end end class ResourceRecordSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :name, as: 'name' collection :rrdatas, as: 'rrdatas' property :ttl, as: 'ttl' property :type, as: 'type' end end class ListResourceRecordSetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :rrsets, as: 'rrsets', class: Google::Apis::DnsV1::ResourceRecordSet, decorator: Google::Apis::DnsV1::ResourceRecordSet::Representation end end end end end google-api-client-0.19.8/generated/google/apis/dns_v1/classes.rb0000644000004100000410000003761513252673043024503 0ustar www-datawww-data# 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 DnsV1 # An atomic update to a collection of ResourceRecordSets. class Change include Google::Apis::Core::Hashable # Which ResourceRecordSets to add? # Corresponds to the JSON property `additions` # @return [Array] attr_accessor :additions # Which ResourceRecordSets to remove? Must match existing data exactly. # Corresponds to the JSON property `deletions` # @return [Array] attr_accessor :deletions # Unique identifier for the resource; defined by the server (output only). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "dns#change". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The time that this operation was started by the server (output only). This is # in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Status of the operation (output only). # 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) @additions = args[:additions] if args.key?(:additions) @deletions = args[:deletions] if args.key?(:deletions) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) end end # The response to a request to enumerate Changes to a ResourceRecordSets # collection. class ListChangesResponse include Google::Apis::Core::Hashable # The requested changes. # Corresponds to the JSON property `changes` # @return [Array] attr_accessor :changes # Type of resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The presence of this field indicates that there exist more results following # your last page of results in pagination order. To fetch them, make another # list request using this value as your pagination token. # In this way you can retrieve the complete contents of even very large # collections one page at a time. However, if the contents of the collection # change between the first and last paginated list request, the set of all # elements returned will be an inconsistent view of the collection. There is no # way to retrieve a "snapshot" of collections larger than the maximum page size. # 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) @changes = args[:changes] if args.key?(:changes) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # A zone is a subtree of the DNS namespace under one administrative # responsibility. A ManagedZone is a resource that represents a DNS zone hosted # by the Cloud DNS service. class ManagedZone include Google::Apis::Core::Hashable # The time that this resource was created on the server. This is in RFC3339 text # format. Output only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time # A mutable string of at most 1024 characters associated with this resource for # the user's convenience. Has no effect on the managed zone's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The DNS name of this managed zone, for instance "example.com.". # Corresponds to the JSON property `dnsName` # @return [String] attr_accessor :dns_name # Unique identifier for the resource; defined by the server (output only) # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "dns# # managedZone". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # User assigned name for this resource. Must be unique within the project. The # name must be 1-63 characters long, must begin with a letter, end with a letter # or digit, and only contain lowercase letters, digits or dashes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet # is a set of DNS name servers that all host the same ManagedZones. Most users # will leave this field unset. # Corresponds to the JSON property `nameServerSet` # @return [String] attr_accessor :name_server_set # Delegate your managed_zone to these virtual name servers; defined by the # server (output only) # Corresponds to the JSON property `nameServers` # @return [Array] attr_accessor :name_servers def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_time = args[:creation_time] if args.key?(:creation_time) @description = args[:description] if args.key?(:description) @dns_name = args[:dns_name] if args.key?(:dns_name) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @name_server_set = args[:name_server_set] if args.key?(:name_server_set) @name_servers = args[:name_servers] if args.key?(:name_servers) end end # class ListManagedZonesResponse include Google::Apis::Core::Hashable # Type of resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The managed zone resources. # Corresponds to the JSON property `managedZones` # @return [Array] attr_accessor :managed_zones # The presence of this field indicates that there exist more results following # your last page of results in pagination order. To fetch them, make another # list request using this value as your page token. # In this way you can retrieve the complete contents of even very large # collections one page at a time. However, if the contents of the collection # change between the first and last paginated list request, the set of all # elements returned will be an inconsistent view of the collection. There is no # way to retrieve a consistent snapshot of a collection larger than the maximum # page size. # 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) @kind = args[:kind] if args.key?(:kind) @managed_zones = args[:managed_zones] if args.key?(:managed_zones) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # A project resource. The project is a top level container for resources # including Cloud DNS ManagedZones. Projects can be created only in the APIs # console. class Project include Google::Apis::Core::Hashable # User assigned unique identifier for the resource (output only). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "dns#project" # . # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Unique numeric identifier for the resource; defined by the server (output only) # . # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number # Limits associated with a Project. # Corresponds to the JSON property `quota` # @return [Google::Apis::DnsV1::Quota] attr_accessor :quota def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @number = args[:number] if args.key?(:number) @quota = args[:quota] if args.key?(:quota) end end # Limits associated with a Project. class Quota include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "dns#quota". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Maximum allowed number of managed zones in the project. # Corresponds to the JSON property `managedZones` # @return [Fixnum] attr_accessor :managed_zones # Maximum allowed number of ResourceRecords per ResourceRecordSet. # Corresponds to the JSON property `resourceRecordsPerRrset` # @return [Fixnum] attr_accessor :resource_records_per_rrset # Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. # Corresponds to the JSON property `rrsetAdditionsPerChange` # @return [Fixnum] attr_accessor :rrset_additions_per_change # Maximum allowed number of ResourceRecordSets to delete per # ChangesCreateRequest. # Corresponds to the JSON property `rrsetDeletionsPerChange` # @return [Fixnum] attr_accessor :rrset_deletions_per_change # Maximum allowed number of ResourceRecordSets per zone in the project. # Corresponds to the JSON property `rrsetsPerManagedZone` # @return [Fixnum] attr_accessor :rrsets_per_managed_zone # Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. # Corresponds to the JSON property `totalRrdataSizePerChange` # @return [Fixnum] attr_accessor :total_rrdata_size_per_change def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @managed_zones = args[:managed_zones] if args.key?(:managed_zones) @resource_records_per_rrset = args[:resource_records_per_rrset] if args.key?(:resource_records_per_rrset) @rrset_additions_per_change = args[:rrset_additions_per_change] if args.key?(:rrset_additions_per_change) @rrset_deletions_per_change = args[:rrset_deletions_per_change] if args.key?(:rrset_deletions_per_change) @rrsets_per_managed_zone = args[:rrsets_per_managed_zone] if args.key?(:rrsets_per_managed_zone) @total_rrdata_size_per_change = args[:total_rrdata_size_per_change] if args.key?(:total_rrdata_size_per_change) end end # A unit of data that will be returned by the DNS servers. class ResourceRecordSet include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "dns# # resourceRecordSet". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # For example, www.example.com. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). # Corresponds to the JSON property `rrdatas` # @return [Array] attr_accessor :rrdatas # Number of seconds that this ResourceRecordSet can be cached by resolvers. # Corresponds to the JSON property `ttl` # @return [Fixnum] attr_accessor :ttl # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and # so on. # 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) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @rrdatas = args[:rrdatas] if args.key?(:rrdatas) @ttl = args[:ttl] if args.key?(:ttl) @type = args[:type] if args.key?(:type) end end # class ListResourceRecordSetsResponse include Google::Apis::Core::Hashable # Type of resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The presence of this field indicates that there exist more results following # your last page of results in pagination order. To fetch them, make another # list request using this value as your pagination token. # In this way you can retrieve the complete contents of even very large # collections one page at a time. However, if the contents of the collection # change between the first and last paginated list request, the set of all # elements returned will be an inconsistent view of the collection. There is no # way to retrieve a consistent snapshot of a collection larger than the maximum # page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The resource record set resources. # Corresponds to the JSON property `rrsets` # @return [Array] attr_accessor :rrsets 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) @rrsets = args[:rrsets] if args.key?(:rrsets) end end end end end google-api-client-0.19.8/generated/google/apis/dns_v1/service.rb0000644000004100000410000006237113252673043024503 0ustar www-datawww-data# 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 DnsV1 # Google Cloud DNS API # # Configures and serves authoritative DNS records. # # @example # require 'google/apis/dns_v1' # # Dns = Google::Apis::DnsV1 # Alias the module # service = Dns::DnsService.new # # @see https://developers.google.com/cloud-dns class DnsService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'dns/v1/projects/') @batch_path = 'batch/dns/v1' end # Atomically update the ResourceRecordSet collection. # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone # Identifies the managed zone addressed by this request. Can be the managed zone # name or id. # @param [Google::Apis::DnsV1::Change] change_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DnsV1::Change] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DnsV1::Change] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_change(project, managed_zone, change_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/managedZones/{managedZone}/changes', options) command.request_representation = Google::Apis::DnsV1::Change::Representation command.request_object = change_object command.response_representation = Google::Apis::DnsV1::Change::Representation command.response_class = Google::Apis::DnsV1::Change command.params['project'] = project unless project.nil? command.params['managedZone'] = managed_zone unless managed_zone.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 # Fetch the representation of an existing Change. # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone # Identifies the managed zone addressed by this request. Can be the managed zone # name or id. # @param [String] change_id # The identifier of the requested change, from a previous # ResourceRecordSetsChangeResponse. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DnsV1::Change] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DnsV1::Change] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_change(project, managed_zone, change_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/managedZones/{managedZone}/changes/{changeId}', options) command.response_representation = Google::Apis::DnsV1::Change::Representation command.response_class = Google::Apis::DnsV1::Change command.params['project'] = project unless project.nil? command.params['managedZone'] = managed_zone unless managed_zone.nil? command.params['changeId'] = change_id unless change_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 # Enumerate Changes to a ResourceRecordSet collection. # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone # Identifies the managed zone addressed by this request. Can be the managed zone # name or id. # @param [Fixnum] max_results # Optional. Maximum number of results to be returned. If unspecified, the server # will decide how many results to return. # @param [String] page_token # Optional. A tag returned by a previous list request that was truncated. Use # this parameter to continue a previous list request. # @param [String] sort_by # Sorting criterion. The only supported value is change sequence. # @param [String] sort_order # Sorting order direction: 'ascending' or 'descending'. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DnsV1::ListChangesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DnsV1::ListChangesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_changes(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/managedZones/{managedZone}/changes', options) command.response_representation = Google::Apis::DnsV1::ListChangesResponse::Representation command.response_class = Google::Apis::DnsV1::ListChangesResponse command.params['project'] = project unless project.nil? command.params['managedZone'] = managed_zone unless managed_zone.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortBy'] = sort_by unless sort_by.nil? command.query['sortOrder'] = sort_order unless sort_order.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 # Create a new ManagedZone. # @param [String] project # Identifies the project addressed by this request. # @param [Google::Apis::DnsV1::ManagedZone] managed_zone_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DnsV1::ManagedZone] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DnsV1::ManagedZone] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managed_zone(project, managed_zone_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/managedZones', options) command.request_representation = Google::Apis::DnsV1::ManagedZone::Representation command.request_object = managed_zone_object command.response_representation = Google::Apis::DnsV1::ManagedZone::Representation command.response_class = Google::Apis::DnsV1::ManagedZone command.params['project'] = project unless project.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 a previously created ManagedZone. # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone # Identifies the managed zone addressed by this request. Can be the managed zone # name or 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_managed_zone(project, managed_zone, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/managedZones/{managedZone}', options) command.params['project'] = project unless project.nil? command.params['managedZone'] = managed_zone unless managed_zone.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 # Fetch the representation of an existing ManagedZone. # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone # Identifies the managed zone addressed by this request. Can be the managed zone # name or 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DnsV1::ManagedZone] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DnsV1::ManagedZone] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managed_zone(project, managed_zone, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/managedZones/{managedZone}', options) command.response_representation = Google::Apis::DnsV1::ManagedZone::Representation command.response_class = Google::Apis::DnsV1::ManagedZone command.params['project'] = project unless project.nil? command.params['managedZone'] = managed_zone unless managed_zone.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 # Enumerate ManagedZones that have been created but not yet deleted. # @param [String] project # Identifies the project addressed by this request. # @param [String] dns_name # Restricts the list to return only zones with this domain name. # @param [Fixnum] max_results # Optional. Maximum number of results to be returned. If unspecified, the server # will decide how many results to return. # @param [String] page_token # Optional. A tag returned by a previous list request that was truncated. Use # this parameter to continue 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DnsV1::ListManagedZonesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DnsV1::ListManagedZonesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managed_zones(project, dns_name: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/managedZones', options) command.response_representation = Google::Apis::DnsV1::ListManagedZonesResponse::Representation command.response_class = Google::Apis::DnsV1::ListManagedZonesResponse command.params['project'] = project unless project.nil? command.query['dnsName'] = dns_name unless dns_name.nil? command.query['maxResults'] = max_results unless max_results.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 # Fetch the representation of an existing Project. # @param [String] project # Identifies the project addressed by this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DnsV1::Project] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DnsV1::Project] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(project, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}', options) command.response_representation = Google::Apis::DnsV1::Project::Representation command.response_class = Google::Apis::DnsV1::Project command.params['project'] = project unless project.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 # Enumerate ResourceRecordSets that have been created but not yet deleted. # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone # Identifies the managed zone addressed by this request. Can be the managed zone # name or id. # @param [Fixnum] max_results # Optional. Maximum number of results to be returned. If unspecified, the server # will decide how many results to return. # @param [String] name # Restricts the list to return only records with this fully qualified domain # name. # @param [String] page_token # Optional. A tag returned by a previous list request that was truncated. Use # this parameter to continue a previous list request. # @param [String] type # Restricts the list to return only records of this type. If present, the "name" # parameter must also be present. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DnsV1::ListResourceRecordSetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DnsV1::ListResourceRecordSetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_resource_record_sets(project, managed_zone, max_results: nil, name: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/managedZones/{managedZone}/rrsets', options) command.response_representation = Google::Apis::DnsV1::ListResourceRecordSetsResponse::Representation command.response_class = Google::Apis::DnsV1::ListResourceRecordSetsResponse command.params['project'] = project unless project.nil? command.params['managedZone'] = managed_zone unless managed_zone.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['name'] = name unless name.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['type'] = type unless 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 protected 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 end end google-api-client-0.19.8/generated/google/apis/adexchangeseller_v2_0/0000755000004100000410000000000013252673043025437 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/adexchangeseller_v2_0/representations.rb0000644000004100000410000002743613252673043031225 0ustar www-datawww-data# 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 AdexchangesellerV2_0 class Account class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Accounts class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdClient class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdClients class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Alert class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Alerts class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomChannel class Representation < Google::Apis::Core::JsonRepresentation; end class TargetingInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class CustomChannels class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Metadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PreferredDeal class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PreferredDeals class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Report class Representation < Google::Apis::Core::JsonRepresentation; end class Header class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ReportingMetadataEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SavedReport class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SavedReports class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlChannel class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlChannels class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Account # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class Accounts # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::Account, decorator: Google::Apis::AdexchangesellerV2_0::Account::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class AdClient # @private class Representation < Google::Apis::Core::JsonRepresentation property :arc_opt_in, as: 'arcOptIn' property :id, as: 'id' property :kind, as: 'kind' property :product_code, as: 'productCode' property :supports_reporting, as: 'supportsReporting' end end class AdClients # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::AdClient, decorator: Google::Apis::AdexchangesellerV2_0::AdClient::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Alert # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :message, as: 'message' property :severity, as: 'severity' property :type, as: 'type' end end class Alerts # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::Alert, decorator: Google::Apis::AdexchangesellerV2_0::Alert::Representation property :kind, as: 'kind' end end class CustomChannel # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :targeting_info, as: 'targetingInfo', class: Google::Apis::AdexchangesellerV2_0::CustomChannel::TargetingInfo, decorator: Google::Apis::AdexchangesellerV2_0::CustomChannel::TargetingInfo::Representation end class TargetingInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :ads_appear_on, as: 'adsAppearOn' property :description, as: 'description' property :location, as: 'location' property :site_language, as: 'siteLanguage' end end end class CustomChannels # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::CustomChannel, decorator: Google::Apis::AdexchangesellerV2_0::CustomChannel::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Metadata # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::ReportingMetadataEntry, decorator: Google::Apis::AdexchangesellerV2_0::ReportingMetadataEntry::Representation property :kind, as: 'kind' end end class PreferredDeal # @private class Representation < Google::Apis::Core::JsonRepresentation property :advertiser_name, as: 'advertiserName' property :buyer_network_name, as: 'buyerNetworkName' property :currency_code, as: 'currencyCode' property :end_time, :numeric_string => true, as: 'endTime' property :fixed_cpm, :numeric_string => true, as: 'fixedCpm' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :start_time, :numeric_string => true, as: 'startTime' end end class PreferredDeals # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::PreferredDeal, decorator: Google::Apis::AdexchangesellerV2_0::PreferredDeal::Representation property :kind, as: 'kind' end end class Report # @private class Representation < Google::Apis::Core::JsonRepresentation collection :averages, as: 'averages' collection :headers, as: 'headers', class: Google::Apis::AdexchangesellerV2_0::Report::Header, decorator: Google::Apis::AdexchangesellerV2_0::Report::Header::Representation property :kind, as: 'kind' collection :rows, as: 'rows', :class => Array do include Representable::JSON::Collection items end property :total_matched_rows, :numeric_string => true, as: 'totalMatchedRows' collection :totals, as: 'totals' collection :warnings, as: 'warnings' end class Header # @private class Representation < Google::Apis::Core::JsonRepresentation property :currency, as: 'currency' property :name, as: 'name' property :type, as: 'type' end end end class ReportingMetadataEntry # @private class Representation < Google::Apis::Core::JsonRepresentation collection :compatible_dimensions, as: 'compatibleDimensions' collection :compatible_metrics, as: 'compatibleMetrics' property :id, as: 'id' property :kind, as: 'kind' collection :required_dimensions, as: 'requiredDimensions' collection :required_metrics, as: 'requiredMetrics' collection :supported_products, as: 'supportedProducts' end end class SavedReport # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class SavedReports # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::SavedReport, decorator: Google::Apis::AdexchangesellerV2_0::SavedReport::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class UrlChannel # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :url_pattern, as: 'urlPattern' end end class UrlChannels # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::UrlChannel, decorator: Google::Apis::AdexchangesellerV2_0::UrlChannel::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end end end end google-api-client-0.19.8/generated/google/apis/adexchangeseller_v2_0/classes.rb0000644000004100000410000007070313252673043027430 0ustar www-datawww-data# 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 AdexchangesellerV2_0 # class Account include Google::Apis::Core::Hashable # Unique identifier of this account. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#account. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this account. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # class Accounts include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The accounts returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#accounts. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through accounts. To retrieve the next page of # results, set the next request's "pageToken" value to this. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # class AdClient include Google::Apis::Core::Hashable # Whether this ad client is opted in to ARC. # Corresponds to the JSON property `arcOptIn` # @return [Boolean] attr_accessor :arc_opt_in alias_method :arc_opt_in?, :arc_opt_in # Unique identifier of this ad client. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#adClient. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This ad client's product code, which corresponds to the PRODUCT_CODE report # dimension. # Corresponds to the JSON property `productCode` # @return [String] attr_accessor :product_code # Whether this ad client supports being reported on. # Corresponds to the JSON property `supportsReporting` # @return [Boolean] attr_accessor :supports_reporting alias_method :supports_reporting?, :supports_reporting def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @arc_opt_in = args[:arc_opt_in] if args.key?(:arc_opt_in) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @product_code = args[:product_code] if args.key?(:product_code) @supports_reporting = args[:supports_reporting] if args.key?(:supports_reporting) end end # class AdClients include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ad clients returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#adClients. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through ad clients. To retrieve the next page # of results, set the next request's "pageToken" value to this. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # class Alert include Google::Apis::Core::Hashable # Unique identifier of this alert. This should be considered an opaque # identifier; it is not safe to rely on it being in any particular format. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#alert. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The localized alert message. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message # Severity of this alert. Possible values: INFO, WARNING, SEVERE. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity # Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, # ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, # GRAYLISTED_PUBLISHER, API_HOLD. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @message = args[:message] if args.key?(:message) @severity = args[:severity] if args.key?(:severity) @type = args[:type] if args.key?(:type) end end # class Alerts include Google::Apis::Core::Hashable # The alerts returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#alerts. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class CustomChannel include Google::Apis::Core::Hashable # Code of this custom channel, not necessarily unique across ad clients. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # Unique identifier of this custom channel. This should be considered an opaque # identifier; it is not safe to rely on it being in any particular format. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#customChannel. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this custom channel. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The targeting information of this custom channel, if activated. # Corresponds to the JSON property `targetingInfo` # @return [Google::Apis::AdexchangesellerV2_0::CustomChannel::TargetingInfo] attr_accessor :targeting_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @code = args[:code] if args.key?(:code) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @targeting_info = args[:targeting_info] if args.key?(:targeting_info) end # The targeting information of this custom channel, if activated. class TargetingInfo include Google::Apis::Core::Hashable # The name used to describe this channel externally. # Corresponds to the JSON property `adsAppearOn` # @return [String] attr_accessor :ads_appear_on # The external description of the channel. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The locations in which ads appear. (Only valid for content and mobile content # ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, # MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, # BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: # TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The language of the sites ads will be displayed on. # Corresponds to the JSON property `siteLanguage` # @return [String] attr_accessor :site_language def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ads_appear_on = args[:ads_appear_on] if args.key?(:ads_appear_on) @description = args[:description] if args.key?(:description) @location = args[:location] if args.key?(:location) @site_language = args[:site_language] if args.key?(:site_language) end end end # class CustomChannels include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The custom channels returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#customChannels. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through custom channels. To retrieve the next # page of results, set the next request's "pageToken" value to this. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # class Metadata include Google::Apis::Core::Hashable # # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#metadata. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class PreferredDeal include Google::Apis::Core::Hashable # The name of the advertiser this deal is for. # Corresponds to the JSON property `advertiserName` # @return [String] attr_accessor :advertiser_name # The name of the buyer network this deal is for. # Corresponds to the JSON property `buyerNetworkName` # @return [String] attr_accessor :buyer_network_name # The currency code that applies to the fixed_cpm value. If not set then assumed # to be USD. # Corresponds to the JSON property `currencyCode` # @return [String] attr_accessor :currency_code # Time when this deal stops being active in seconds since the epoch (GMT). If # not set then this deal is valid until manually disabled by the publisher. # Corresponds to the JSON property `endTime` # @return [Fixnum] attr_accessor :end_time # The fixed price for this preferred deal. In cpm micros of currency according # to currencyCode. If set, then this preferred deal is eligible for the fixed # price tier of buying (highest priority, pay exactly the configured fixed price) # . # Corresponds to the JSON property `fixedCpm` # @return [Fixnum] attr_accessor :fixed_cpm # Unique identifier of this preferred deal. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#preferredDeal. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Time when this deal becomes active in seconds since the epoch (GMT). If not # set then this deal is active immediately upon creation. # Corresponds to the JSON property `startTime` # @return [Fixnum] attr_accessor :start_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name) @buyer_network_name = args[:buyer_network_name] if args.key?(:buyer_network_name) @currency_code = args[:currency_code] if args.key?(:currency_code) @end_time = args[:end_time] if args.key?(:end_time) @fixed_cpm = args[:fixed_cpm] if args.key?(:fixed_cpm) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @start_time = args[:start_time] if args.key?(:start_time) end end # class PreferredDeals include Google::Apis::Core::Hashable # The preferred deals returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#preferredDeals. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class Report include Google::Apis::Core::Hashable # The averages of the report. This is the same length as any other row in the # report; cells corresponding to dimension columns are empty. # Corresponds to the JSON property `averages` # @return [Array] attr_accessor :averages # The header information of the columns requested in the report. This is a list # of headers; one for each dimension in the request, followed by one for each # metric in the request. # Corresponds to the JSON property `headers` # @return [Array] attr_accessor :headers # Kind this is, in this case adexchangeseller#report. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The output rows of the report. Each row is a list of cells; one for each # dimension in the request, followed by one for each metric in the request. The # dimension cells contain strings, and the metric cells contain numbers. # Corresponds to the JSON property `rows` # @return [Array>] attr_accessor :rows # The total number of rows matched by the report request. Fewer rows may be # returned in the response due to being limited by the row count requested or # the report row limit. # Corresponds to the JSON property `totalMatchedRows` # @return [Fixnum] attr_accessor :total_matched_rows # The totals of the report. This is the same length as any other row in the # report; cells corresponding to dimension columns are empty. # Corresponds to the JSON property `totals` # @return [Array] attr_accessor :totals # Any warnings associated with generation of the report. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @averages = args[:averages] if args.key?(:averages) @headers = args[:headers] if args.key?(:headers) @kind = args[:kind] if args.key?(:kind) @rows = args[:rows] if args.key?(:rows) @total_matched_rows = args[:total_matched_rows] if args.key?(:total_matched_rows) @totals = args[:totals] if args.key?(:totals) @warnings = args[:warnings] if args.key?(:warnings) end # class Header include Google::Apis::Core::Hashable # The currency of this column. Only present if the header type is # METRIC_CURRENCY. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency # The name of the header. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or # METRIC_CURRENCY. # 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) @currency = args[:currency] if args.key?(:currency) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) end end end # class ReportingMetadataEntry include Google::Apis::Core::Hashable # For metrics this is a list of dimension IDs which the metric is compatible # with, for dimensions it is a list of compatibility groups the dimension # belongs to. # Corresponds to the JSON property `compatibleDimensions` # @return [Array] attr_accessor :compatible_dimensions # The names of the metrics the dimension or metric this reporting metadata entry # describes is compatible with. # Corresponds to the JSON property `compatibleMetrics` # @return [Array] attr_accessor :compatible_metrics # Unique identifier of this reporting metadata entry, corresponding to the name # of the appropriate dimension or metric. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#reportingMetadataEntry. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The names of the dimensions which the dimension or metric this reporting # metadata entry describes requires to also be present in order for the report # to be valid. Omitting these will not cause an error or warning, but may result # in data which cannot be correctly interpreted. # Corresponds to the JSON property `requiredDimensions` # @return [Array] attr_accessor :required_dimensions # The names of the metrics which the dimension or metric this reporting metadata # entry describes requires to also be present in order for the report to be # valid. Omitting these will not cause an error or warning, but may result in # data which cannot be correctly interpreted. # Corresponds to the JSON property `requiredMetrics` # @return [Array] attr_accessor :required_metrics # The codes of the projects supported by the dimension or metric this reporting # metadata entry describes. # Corresponds to the JSON property `supportedProducts` # @return [Array] attr_accessor :supported_products def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @compatible_dimensions = args[:compatible_dimensions] if args.key?(:compatible_dimensions) @compatible_metrics = args[:compatible_metrics] if args.key?(:compatible_metrics) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @required_dimensions = args[:required_dimensions] if args.key?(:required_dimensions) @required_metrics = args[:required_metrics] if args.key?(:required_metrics) @supported_products = args[:supported_products] if args.key?(:supported_products) end end # class SavedReport include Google::Apis::Core::Hashable # Unique identifier of this saved report. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#savedReport. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This saved report's name. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # class SavedReports include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The saved reports returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#savedReports. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through saved reports. To retrieve the next # page of results, set the next request's "pageToken" value to this. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # class UrlChannel include Google::Apis::Core::Hashable # Unique identifier of this URL channel. This should be considered an opaque # identifier; it is not safe to rely on it being in any particular format. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#urlChannel. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # URL Pattern of this URL channel. Does not include "http://" or "https://". # Example: www.example.com/home # Corresponds to the JSON property `urlPattern` # @return [String] attr_accessor :url_pattern def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @url_pattern = args[:url_pattern] if args.key?(:url_pattern) end end # class UrlChannels include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The URL channels returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#urlChannels. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through URL channels. To retrieve the next # page of results, set the next request's "pageToken" value to this. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end end end end google-api-client-0.19.8/generated/google/apis/adexchangeseller_v2_0/service.rb0000644000004100000410000011575313252673043027440 0ustar www-datawww-data# 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 AdexchangesellerV2_0 # Ad Exchange Seller API # # Accesses the inventory of Ad Exchange seller users and generates reports. # # @example # require 'google/apis/adexchangeseller_v2_0' # # Adexchangeseller = Google::Apis::AdexchangesellerV2_0 # Alias the module # service = Adexchangeseller::AdExchangeSellerService.new # # @see https://developers.google.com/ad-exchange/seller-rest/ class AdExchangeSellerService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'adexchangeseller/v2.0/') @batch_path = 'batch/adexchangeseller/v2.0' end # Get information about the selected Ad Exchange account. # @param [String] account_id # Account to get information about. Tip: 'myaccount' is a valid 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::Account::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Account command.params['accountId'] = account_id unless account_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 # List all accounts available to this Ad Exchange account. # @param [Fixnum] max_results # The maximum number of accounts to include in the response, used for paging. # @param [String] page_token # A continuation token, used to page through accounts. To retrieve the next page, # set this parameter to the value of "nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::Accounts] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::Accounts] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_accounts(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::Accounts::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Accounts command.query['maxResults'] = max_results unless max_results.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 # List all ad clients in this Ad Exchange account. # @param [String] account_id # Account to which the ad client belongs. # @param [Fixnum] max_results # The maximum number of ad clients to include in the response, used for paging. # @param [String] page_token # A continuation token, used to page through ad clients. To retrieve the next # page, set this parameter to the value of "nextPageToken" from the previous # 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::AdClients] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::AdClients] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_ad_clients(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/adclients', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::AdClients::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::AdClients command.params['accountId'] = account_id unless account_id.nil? command.query['maxResults'] = max_results unless max_results.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 # List the alerts for this Ad Exchange account. # @param [String] account_id # Account owning the alerts. # @param [String] locale # The locale to use for translating alert messages. The account locale will be # used if this is not supplied. The AdSense default (English) will be used if # the supplied locale is invalid or unsupported. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::Alerts] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::Alerts] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_alerts(account_id, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/alerts', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::Alerts::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Alerts command.params['accountId'] = account_id unless account_id.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 # Get the specified custom channel from the specified ad client. # @param [String] account_id # Account to which the ad client belongs. # @param [String] ad_client_id # Ad client which contains the custom channel. # @param [String] custom_channel_id # Custom channel to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::CustomChannel] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::CustomChannel] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_custom_channel(account_id, ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::CustomChannel::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::CustomChannel command.params['accountId'] = account_id unless account_id.nil? command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.params['customChannelId'] = custom_channel_id unless custom_channel_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 # List all custom channels in the specified ad client for this Ad Exchange # account. # @param [String] account_id # Account to which the ad client belongs. # @param [String] ad_client_id # Ad client for which to list custom channels. # @param [Fixnum] max_results # The maximum number of custom channels to include in the response, used for # paging. # @param [String] page_token # A continuation token, used to page through custom channels. To retrieve the # next page, set this parameter to the value of "nextPageToken" from the # previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::CustomChannels] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::CustomChannels] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_custom_channels(account_id, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/customchannels', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::CustomChannels::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::CustomChannels command.params['accountId'] = account_id unless account_id.nil? command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.query['maxResults'] = max_results unless max_results.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 # List the metadata for the dimensions available to this AdExchange account. # @param [String] account_id # Account with visibility to the dimensions. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::Metadata] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::Metadata] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_metadata_dimensions(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/metadata/dimensions', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::Metadata::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Metadata command.params['accountId'] = account_id unless account_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 # List the metadata for the metrics available to this AdExchange account. # @param [String] account_id # Account with visibility to the metrics. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::Metadata] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::Metadata] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_metadata_metrics(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/metadata/metrics', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::Metadata::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Metadata command.params['accountId'] = account_id unless account_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 # Get information about the selected Ad Exchange Preferred Deal. # @param [String] account_id # Account owning the deal. # @param [String] deal_id # Preferred deal to get information about. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::PreferredDeal] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::PreferredDeal] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_preferred_deal(account_id, deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/preferreddeals/{dealId}', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::PreferredDeal::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::PreferredDeal command.params['accountId'] = account_id unless account_id.nil? command.params['dealId'] = deal_id unless deal_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 # List the preferred deals for this Ad Exchange account. # @param [String] account_id # Account owning the deals. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::PreferredDeals] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::PreferredDeals] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_preferred_deals(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/preferreddeals', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::PreferredDeals::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::PreferredDeals command.params['accountId'] = account_id unless account_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 # Generate an Ad Exchange report based on the report request sent in the query # parameters. Returns the result as JSON; to retrieve output in CSV format # specify "alt=csv" as a query parameter. # @param [String] account_id # Account which owns the generated report. # @param [String] start_date # Start of the date range to report on in "YYYY-MM-DD" format, inclusive. # @param [String] end_date # End of the date range to report on in "YYYY-MM-DD" format, inclusive. # @param [Array, String] dimension # Dimensions to base the report on. # @param [Array, String] filter # Filters to be run on the report. # @param [String] locale # Optional locale to use for translating report output to a local language. # Defaults to "en_US" if not specified. # @param [Fixnum] max_results # The maximum number of rows of report data to return. # @param [Array, String] metric # Numeric columns to include in the report. # @param [Array, String] sort # The name of a dimension or metric to sort the resulting report on, optionally # prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is # specified, the column is sorted ascending. # @param [Fixnum] start_index # Index of the first row of report data to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_report(account_id, start_date, end_date, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'accounts/{accountId}/reports', options) else command = make_download_command(:get, 'accounts/{accountId}/reports', options) command.download_dest = download_dest end command.response_representation = Google::Apis::AdexchangesellerV2_0::Report::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Report command.params['accountId'] = account_id unless account_id.nil? command.query['dimension'] = dimension unless dimension.nil? command.query['endDate'] = end_date unless end_date.nil? command.query['filter'] = filter unless filter.nil? command.query['locale'] = locale unless locale.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['metric'] = metric unless metric.nil? command.query['sort'] = sort unless sort.nil? command.query['startDate'] = start_date unless start_date.nil? command.query['startIndex'] = start_index unless start_index.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 # Generate an Ad Exchange report based on the saved report ID sent in the query # parameters. # @param [String] account_id # Account owning the saved report. # @param [String] saved_report_id # The saved report to retrieve. # @param [String] locale # Optional locale to use for translating report output to a local language. # Defaults to "en_US" if not specified. # @param [Fixnum] max_results # The maximum number of rows of report data to return. # @param [Fixnum] start_index # Index of the first row of report data to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_saved_report(account_id, saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/reports/{savedReportId}', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::Report::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::Report command.params['accountId'] = account_id unless account_id.nil? command.params['savedReportId'] = saved_report_id unless saved_report_id.nil? command.query['locale'] = locale unless locale.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['startIndex'] = start_index unless start_index.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 saved reports in this Ad Exchange account. # @param [String] account_id # Account owning the saved reports. # @param [Fixnum] max_results # The maximum number of saved reports to include in the response, used for # paging. # @param [String] page_token # A continuation token, used to page through saved reports. To retrieve the next # page, set this parameter to the value of "nextPageToken" from the previous # 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::SavedReports] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::SavedReports] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_saved_reports(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/reports/saved', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::SavedReports::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::SavedReports command.params['accountId'] = account_id unless account_id.nil? command.query['maxResults'] = max_results unless max_results.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 # List all URL channels in the specified ad client for this Ad Exchange account. # @param [String] account_id # Account to which the ad client belongs. # @param [String] ad_client_id # Ad client for which to list URL channels. # @param [Fixnum] max_results # The maximum number of URL channels to include in the response, used for paging. # @param [String] page_token # A continuation token, used to page through URL channels. To retrieve the next # page, set this parameter to the value of "nextPageToken" from the previous # 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV2_0::UrlChannels] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV2_0::UrlChannels] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_url_channels(account_id, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/urlchannels', options) command.response_representation = Google::Apis::AdexchangesellerV2_0::UrlChannels::Representation command.response_class = Google::Apis::AdexchangesellerV2_0::UrlChannels command.params['accountId'] = account_id unless account_id.nil? command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.query['maxResults'] = max_results unless max_results.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 protected 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 end end google-api-client-0.19.8/generated/google/apis/deploymentmanager_v2beta/0000755000004100000410000000000013252673043026271 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/deploymentmanager_v2beta/representations.rb0000644000004100000410000012556713252673043032063 0ustar www-datawww-data# 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 DeploymentmanagerV2beta class AsyncOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditLogConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthorizationLoggingOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BaseType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BasicAuth 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 CollectionOverride class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompositeType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompositeTypeLabelEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompositeTypesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Condition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConfigFile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Credential class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Deployment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentLabelEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentUpdate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentUpdateLabelEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentsCancelPreviewRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentsStopRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Diagnostic 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 ImportFile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InputMapping class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfigCloudAuditOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfigCounterOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfigDataAccessOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Manifest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManifestsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Operation class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport 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 OperationsListResponse 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 Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PollingOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Resource 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 ResourceAccessControl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceUpdate class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport 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 ResourcesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Rule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TemplateContents class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Type class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeInfoSchemaInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeLabelEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeProvider class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeProviderLabelEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeProvidersListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeProvidersListTypesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ValidationOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AsyncOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :method_match, as: 'methodMatch' property :polling_options, as: 'pollingOptions', class: Google::Apis::DeploymentmanagerV2beta::PollingOptions, decorator: Google::Apis::DeploymentmanagerV2beta::PollingOptions::Representation end end class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::DeploymentmanagerV2beta::AuditLogConfig, decorator: Google::Apis::DeploymentmanagerV2beta::AuditLogConfig::Representation collection :exempted_members, as: 'exemptedMembers' property :service, as: 'service' end end class AuditLogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exempted_members, as: 'exemptedMembers' property :log_type, as: 'logType' end end class AuthorizationLoggingOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :permission_type, as: 'permissionType' end end class BaseType # @private class Representation < Google::Apis::Core::JsonRepresentation collection :collection_overrides, as: 'collectionOverrides', class: Google::Apis::DeploymentmanagerV2beta::CollectionOverride, decorator: Google::Apis::DeploymentmanagerV2beta::CollectionOverride::Representation property :credential, as: 'credential', class: Google::Apis::DeploymentmanagerV2beta::Credential, decorator: Google::Apis::DeploymentmanagerV2beta::Credential::Representation property :descriptor_url, as: 'descriptorUrl' property :options, as: 'options', class: Google::Apis::DeploymentmanagerV2beta::Options, decorator: Google::Apis::DeploymentmanagerV2beta::Options::Representation end end class BasicAuth # @private class Representation < Google::Apis::Core::JsonRepresentation property :password, as: 'password' property :user, as: 'user' end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation property :condition, as: 'condition', class: Google::Apis::DeploymentmanagerV2beta::Expr, decorator: Google::Apis::DeploymentmanagerV2beta::Expr::Representation collection :members, as: 'members' property :role, as: 'role' end end class CollectionOverride # @private class Representation < Google::Apis::Core::JsonRepresentation property :collection, as: 'collection' property :options, as: 'options', class: Google::Apis::DeploymentmanagerV2beta::Options, decorator: Google::Apis::DeploymentmanagerV2beta::Options::Representation end end class CompositeType # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerV2beta::CompositeTypeLabelEntry, decorator: Google::Apis::DeploymentmanagerV2beta::CompositeTypeLabelEntry::Representation property :name, as: 'name' property :operation, as: 'operation', class: Google::Apis::DeploymentmanagerV2beta::Operation, decorator: Google::Apis::DeploymentmanagerV2beta::Operation::Representation property :self_link, as: 'selfLink' property :status, as: 'status' property :template_contents, as: 'templateContents', class: Google::Apis::DeploymentmanagerV2beta::TemplateContents, decorator: Google::Apis::DeploymentmanagerV2beta::TemplateContents::Representation end end class CompositeTypeLabelEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class CompositeTypesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :composite_types, as: 'compositeTypes', class: Google::Apis::DeploymentmanagerV2beta::CompositeType, decorator: Google::Apis::DeploymentmanagerV2beta::CompositeType::Representation property :next_page_token, as: 'nextPageToken' end end class Condition # @private class Representation < Google::Apis::Core::JsonRepresentation property :iam, as: 'iam' property :op, as: 'op' property :svc, as: 'svc' property :sys, as: 'sys' property :value, as: 'value' collection :values, as: 'values' end end class ConfigFile # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' end end class Credential # @private class Representation < Google::Apis::Core::JsonRepresentation property :basic_auth, as: 'basicAuth', class: Google::Apis::DeploymentmanagerV2beta::BasicAuth, decorator: Google::Apis::DeploymentmanagerV2beta::BasicAuth::Representation property :service_account, as: 'serviceAccount', class: Google::Apis::DeploymentmanagerV2beta::ServiceAccount, decorator: Google::Apis::DeploymentmanagerV2beta::ServiceAccount::Representation property :use_project_default, as: 'useProjectDefault' end end class Deployment # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :fingerprint, :base64 => true, as: 'fingerprint' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerV2beta::DeploymentLabelEntry, decorator: Google::Apis::DeploymentmanagerV2beta::DeploymentLabelEntry::Representation property :manifest, as: 'manifest' property :name, as: 'name' property :operation, as: 'operation', class: Google::Apis::DeploymentmanagerV2beta::Operation, decorator: Google::Apis::DeploymentmanagerV2beta::Operation::Representation property :self_link, as: 'selfLink' property :target, as: 'target', class: Google::Apis::DeploymentmanagerV2beta::TargetConfiguration, decorator: Google::Apis::DeploymentmanagerV2beta::TargetConfiguration::Representation property :update, as: 'update', class: Google::Apis::DeploymentmanagerV2beta::DeploymentUpdate, decorator: Google::Apis::DeploymentmanagerV2beta::DeploymentUpdate::Representation end end class DeploymentLabelEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class DeploymentUpdate # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerV2beta::DeploymentUpdateLabelEntry, decorator: Google::Apis::DeploymentmanagerV2beta::DeploymentUpdateLabelEntry::Representation property :manifest, as: 'manifest' end end class DeploymentUpdateLabelEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class DeploymentsCancelPreviewRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' end end class DeploymentsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :deployments, as: 'deployments', class: Google::Apis::DeploymentmanagerV2beta::Deployment, decorator: Google::Apis::DeploymentmanagerV2beta::Deployment::Representation property :next_page_token, as: 'nextPageToken' end end class DeploymentsStopRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' end end class Diagnostic # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field' property :level, as: 'level' 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 ImportFile # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :name, as: 'name' end end class InputMapping # @private class Representation < Google::Apis::Core::JsonRepresentation property :field_name, as: 'fieldName' property :location, as: 'location' property :method_match, as: 'methodMatch' property :value, as: 'value' end end class LogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :cloud_audit, as: 'cloudAudit', class: Google::Apis::DeploymentmanagerV2beta::LogConfigCloudAuditOptions, decorator: Google::Apis::DeploymentmanagerV2beta::LogConfigCloudAuditOptions::Representation property :counter, as: 'counter', class: Google::Apis::DeploymentmanagerV2beta::LogConfigCounterOptions, decorator: Google::Apis::DeploymentmanagerV2beta::LogConfigCounterOptions::Representation property :data_access, as: 'dataAccess', class: Google::Apis::DeploymentmanagerV2beta::LogConfigDataAccessOptions, decorator: Google::Apis::DeploymentmanagerV2beta::LogConfigDataAccessOptions::Representation end end class LogConfigCloudAuditOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :authorization_logging_options, as: 'authorizationLoggingOptions', class: Google::Apis::DeploymentmanagerV2beta::AuthorizationLoggingOptions, decorator: Google::Apis::DeploymentmanagerV2beta::AuthorizationLoggingOptions::Representation property :log_name, as: 'logName' end end class LogConfigCounterOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field' property :metric, as: 'metric' end end class LogConfigDataAccessOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :log_mode, as: 'logMode' end end class Manifest # @private class Representation < Google::Apis::Core::JsonRepresentation property :config, as: 'config', class: Google::Apis::DeploymentmanagerV2beta::ConfigFile, decorator: Google::Apis::DeploymentmanagerV2beta::ConfigFile::Representation property :expanded_config, as: 'expandedConfig' property :id, :numeric_string => true, as: 'id' collection :imports, as: 'imports', class: Google::Apis::DeploymentmanagerV2beta::ImportFile, decorator: Google::Apis::DeploymentmanagerV2beta::ImportFile::Representation property :insert_time, as: 'insertTime' property :layout, as: 'layout' property :name, as: 'name' property :self_link, as: 'selfLink' end end class ManifestsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :manifests, as: 'manifests', class: Google::Apis::DeploymentmanagerV2beta::Manifest, decorator: Google::Apis::DeploymentmanagerV2beta::Manifest::Representation property :next_page_token, as: 'nextPageToken' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_operation_id, as: 'clientOperationId' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :end_time, as: 'endTime' property :error, as: 'error', class: Google::Apis::DeploymentmanagerV2beta::Operation::Error, decorator: Google::Apis::DeploymentmanagerV2beta::Operation::Error::Representation property :http_error_message, as: 'httpErrorMessage' property :http_error_status_code, as: 'httpErrorStatusCode' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' property :kind, as: 'kind' property :name, as: 'name' property :operation_type, as: 'operationType' property :progress, as: 'progress' property :region, as: 'region' property :self_link, as: 'selfLink' property :start_time, as: 'startTime' property :status, as: 'status' property :status_message, as: 'statusMessage' property :target_id, :numeric_string => true, as: 'targetId' property :target_link, as: 'targetLink' property :user, as: 'user' collection :warnings, as: 'warnings', class: Google::Apis::DeploymentmanagerV2beta::Operation::Warning, decorator: Google::Apis::DeploymentmanagerV2beta::Operation::Warning::Representation property :zone, as: 'zone' end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::DeploymentmanagerV2beta::Operation::Error::Error, decorator: Google::Apis::DeploymentmanagerV2beta::Operation::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::DeploymentmanagerV2beta::Operation::Warning::Datum, decorator: Google::Apis::DeploymentmanagerV2beta::Operation::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 OperationsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::DeploymentmanagerV2beta::Operation, decorator: Google::Apis::DeploymentmanagerV2beta::Operation::Representation end end class Options # @private class Representation < Google::Apis::Core::JsonRepresentation collection :async_options, as: 'asyncOptions', class: Google::Apis::DeploymentmanagerV2beta::AsyncOptions, decorator: Google::Apis::DeploymentmanagerV2beta::AsyncOptions::Representation collection :input_mappings, as: 'inputMappings', class: Google::Apis::DeploymentmanagerV2beta::InputMapping, decorator: Google::Apis::DeploymentmanagerV2beta::InputMapping::Representation property :validation_options, as: 'validationOptions', class: Google::Apis::DeploymentmanagerV2beta::ValidationOptions, decorator: Google::Apis::DeploymentmanagerV2beta::ValidationOptions::Representation property :virtual_properties, as: 'virtualProperties' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_configs, as: 'auditConfigs', class: Google::Apis::DeploymentmanagerV2beta::AuditConfig, decorator: Google::Apis::DeploymentmanagerV2beta::AuditConfig::Representation collection :bindings, as: 'bindings', class: Google::Apis::DeploymentmanagerV2beta::Binding, decorator: Google::Apis::DeploymentmanagerV2beta::Binding::Representation property :etag, :base64 => true, as: 'etag' property :iam_owned, as: 'iamOwned' collection :rules, as: 'rules', class: Google::Apis::DeploymentmanagerV2beta::Rule, decorator: Google::Apis::DeploymentmanagerV2beta::Rule::Representation property :version, as: 'version' end end class PollingOptions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :diagnostics, as: 'diagnostics', class: Google::Apis::DeploymentmanagerV2beta::Diagnostic, decorator: Google::Apis::DeploymentmanagerV2beta::Diagnostic::Representation property :fail_condition, as: 'failCondition' property :finish_condition, as: 'finishCondition' property :polling_link, as: 'pollingLink' property :target_link, as: 'targetLink' end end class Resource # @private class Representation < Google::Apis::Core::JsonRepresentation property :access_control, as: 'accessControl', class: Google::Apis::DeploymentmanagerV2beta::ResourceAccessControl, decorator: Google::Apis::DeploymentmanagerV2beta::ResourceAccessControl::Representation property :final_properties, as: 'finalProperties' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' property :manifest, as: 'manifest' property :name, as: 'name' property :properties, as: 'properties' property :type, as: 'type' property :update, as: 'update', class: Google::Apis::DeploymentmanagerV2beta::ResourceUpdate, decorator: Google::Apis::DeploymentmanagerV2beta::ResourceUpdate::Representation property :update_time, as: 'updateTime' property :url, as: 'url' collection :warnings, as: 'warnings', class: Google::Apis::DeploymentmanagerV2beta::Resource::Warning, decorator: Google::Apis::DeploymentmanagerV2beta::Resource::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::DeploymentmanagerV2beta::Resource::Warning::Datum, decorator: Google::Apis::DeploymentmanagerV2beta::Resource::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 ResourceAccessControl # @private class Representation < Google::Apis::Core::JsonRepresentation property :gcp_iam_policy, as: 'gcpIamPolicy' end end class ResourceUpdate # @private class Representation < Google::Apis::Core::JsonRepresentation property :access_control, as: 'accessControl', class: Google::Apis::DeploymentmanagerV2beta::ResourceAccessControl, decorator: Google::Apis::DeploymentmanagerV2beta::ResourceAccessControl::Representation property :error, as: 'error', class: Google::Apis::DeploymentmanagerV2beta::ResourceUpdate::Error, decorator: Google::Apis::DeploymentmanagerV2beta::ResourceUpdate::Error::Representation property :final_properties, as: 'finalProperties' property :intent, as: 'intent' property :manifest, as: 'manifest' property :properties, as: 'properties' property :state, as: 'state' collection :warnings, as: 'warnings', class: Google::Apis::DeploymentmanagerV2beta::ResourceUpdate::Warning, decorator: Google::Apis::DeploymentmanagerV2beta::ResourceUpdate::Warning::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::DeploymentmanagerV2beta::ResourceUpdate::Error::Error, decorator: Google::Apis::DeploymentmanagerV2beta::ResourceUpdate::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::DeploymentmanagerV2beta::ResourceUpdate::Warning::Datum, decorator: Google::Apis::DeploymentmanagerV2beta::ResourceUpdate::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 ResourcesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :resources, as: 'resources', class: Google::Apis::DeploymentmanagerV2beta::Resource, decorator: Google::Apis::DeploymentmanagerV2beta::Resource::Representation end end class Rule # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' collection :conditions, as: 'conditions', class: Google::Apis::DeploymentmanagerV2beta::Condition, decorator: Google::Apis::DeploymentmanagerV2beta::Condition::Representation property :description, as: 'description' collection :ins, as: 'ins' collection :log_configs, as: 'logConfigs', class: Google::Apis::DeploymentmanagerV2beta::LogConfig, decorator: Google::Apis::DeploymentmanagerV2beta::LogConfig::Representation collection :not_ins, as: 'notIns' collection :permissions, as: 'permissions' end end class ServiceAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' end end class TargetConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :config, as: 'config', class: Google::Apis::DeploymentmanagerV2beta::ConfigFile, decorator: Google::Apis::DeploymentmanagerV2beta::ConfigFile::Representation collection :imports, as: 'imports', class: Google::Apis::DeploymentmanagerV2beta::ImportFile, decorator: Google::Apis::DeploymentmanagerV2beta::ImportFile::Representation end end class TemplateContents # @private class Representation < Google::Apis::Core::JsonRepresentation collection :imports, as: 'imports', class: Google::Apis::DeploymentmanagerV2beta::ImportFile, decorator: Google::Apis::DeploymentmanagerV2beta::ImportFile::Representation property :interpreter, as: 'interpreter' property :main_template, as: 'mainTemplate' property :schema, as: 'schema' property :template, as: 'template' end end class TestPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class Type # @private class Representation < Google::Apis::Core::JsonRepresentation property :base, as: 'base', class: Google::Apis::DeploymentmanagerV2beta::BaseType, decorator: Google::Apis::DeploymentmanagerV2beta::BaseType::Representation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerV2beta::TypeLabelEntry, decorator: Google::Apis::DeploymentmanagerV2beta::TypeLabelEntry::Representation property :name, as: 'name' property :operation, as: 'operation', class: Google::Apis::DeploymentmanagerV2beta::Operation, decorator: Google::Apis::DeploymentmanagerV2beta::Operation::Representation property :self_link, as: 'selfLink' end end class TypeInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :documentation_link, as: 'documentationLink' property :kind, as: 'kind' property :name, as: 'name' property :schema, as: 'schema', class: Google::Apis::DeploymentmanagerV2beta::TypeInfoSchemaInfo, decorator: Google::Apis::DeploymentmanagerV2beta::TypeInfoSchemaInfo::Representation property :self_link, as: 'selfLink' property :title, as: 'title' end end class TypeInfoSchemaInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :input, as: 'input' property :output, as: 'output' end end class TypeLabelEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class TypeProvider # @private class Representation < Google::Apis::Core::JsonRepresentation collection :collection_overrides, as: 'collectionOverrides', class: Google::Apis::DeploymentmanagerV2beta::CollectionOverride, decorator: Google::Apis::DeploymentmanagerV2beta::CollectionOverride::Representation property :credential, as: 'credential', class: Google::Apis::DeploymentmanagerV2beta::Credential, decorator: Google::Apis::DeploymentmanagerV2beta::Credential::Representation property :description, as: 'description' property :descriptor_url, as: 'descriptorUrl' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerV2beta::TypeProviderLabelEntry, decorator: Google::Apis::DeploymentmanagerV2beta::TypeProviderLabelEntry::Representation property :name, as: 'name' property :operation, as: 'operation', class: Google::Apis::DeploymentmanagerV2beta::Operation, decorator: Google::Apis::DeploymentmanagerV2beta::Operation::Representation property :options, as: 'options', class: Google::Apis::DeploymentmanagerV2beta::Options, decorator: Google::Apis::DeploymentmanagerV2beta::Options::Representation property :self_link, as: 'selfLink' end end class TypeProviderLabelEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class TypeProvidersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :type_providers, as: 'typeProviders', class: Google::Apis::DeploymentmanagerV2beta::TypeProvider, decorator: Google::Apis::DeploymentmanagerV2beta::TypeProvider::Representation end end class TypeProvidersListTypesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :types, as: 'types', class: Google::Apis::DeploymentmanagerV2beta::TypeInfo, decorator: Google::Apis::DeploymentmanagerV2beta::TypeInfo::Representation end end class TypesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :types, as: 'types', class: Google::Apis::DeploymentmanagerV2beta::Type, decorator: Google::Apis::DeploymentmanagerV2beta::Type::Representation end end class ValidationOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :schema_validation, as: 'schemaValidation' property :undeclared_properties, as: 'undeclaredProperties' end end end end end google-api-client-0.19.8/generated/google/apis/deploymentmanager_v2beta/classes.rb0000644000004100000410000031130413252673043030255 0ustar www-datawww-data# 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 DeploymentmanagerV2beta # Async options that determine when a resource should finish. class AsyncOptions include Google::Apis::Core::Hashable # Method regex where this policy will apply. # Corresponds to the JSON property `methodMatch` # @return [String] attr_accessor :method_match # # Corresponds to the JSON property `pollingOptions` # @return [Google::Apis::DeploymentmanagerV2beta::PollingOptions] attr_accessor :polling_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @method_match = args[:method_match] if args.key?(:method_match) @polling_options = args[:polling_options] if args.key?(:polling_options) 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:foo@gmail.com" ] `, ` " # log_type": "DATA_WRITE", `, ` "log_type": "ADMIN_READ", ` ] `, ` "service": " # fooservice.googleapis.com" "audit_log_configs": [ ` "log_type": "DATA_READ", `, # ` "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] ` ] ` # ] ` # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail. # com from DATA_WRITE logging. class AuditConfig include Google::Apis::Core::Hashable # The configuration for logging of each type of permission. # Corresponds to the JSON property `auditLogConfigs` # @return [Array] attr_accessor :audit_log_configs # # Corresponds to the JSON property `exemptedMembers` # @return [Array] attr_accessor :exempted_members # 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) @exempted_members = args[:exempted_members] if args.key?(:exempted_members) @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:foo@gmail.com" ] `, ` "log_type": "DATA_WRITE", ` ] ` # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail. # com from DATA_READ logging. class AuditLogConfig include Google::Apis::Core::Hashable # Specifies the identities that do not cause logging for this type of permission. # Follows the same format of [Binding.members][]. # Corresponds to the JSON property `exemptedMembers` # @return [Array] 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 # Authorization-related information used by Cloud Audit Logging. class AuthorizationLoggingOptions include Google::Apis::Core::Hashable # The type of the permission that was checked. # Corresponds to the JSON property `permissionType` # @return [String] attr_accessor :permission_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permission_type = args[:permission_type] if args.key?(:permission_type) end end # BaseType that describes a service-backed Type. class BaseType include Google::Apis::Core::Hashable # Allows resource handling overrides for specific collections # Corresponds to the JSON property `collectionOverrides` # @return [Array] attr_accessor :collection_overrides # The credential used by Deployment Manager and TypeProvider. Only one of the # options is permitted. # Corresponds to the JSON property `credential` # @return [Google::Apis::DeploymentmanagerV2beta::Credential] attr_accessor :credential # Descriptor Url for the this type. # Corresponds to the JSON property `descriptorUrl` # @return [String] attr_accessor :descriptor_url # Options allows customized resource handling by Deployment Manager. # Corresponds to the JSON property `options` # @return [Google::Apis::DeploymentmanagerV2beta::Options] attr_accessor :options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @collection_overrides = args[:collection_overrides] if args.key?(:collection_overrides) @credential = args[:credential] if args.key?(:credential) @descriptor_url = args[:descriptor_url] if args.key?(:descriptor_url) @options = args[:options] if args.key?(:options) end end # Basic Auth used as a credential. class BasicAuth include Google::Apis::Core::Hashable # # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # # Corresponds to the JSON property `user` # @return [String] attr_accessor :user def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @password = args[:password] if args.key?(:password) @user = args[:user] if args.key?(:user) end end # Associates `members` with a `role`. class Binding include Google::Apis::Core::Hashable # Represents an expression text. Example: # title: "User account presence" description: "Determines whether the request # has a user account" expression: "size(request.user) > 0" # Corresponds to the JSON property `condition` # @return [Google::Apis::DeploymentmanagerV2beta::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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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 # CollectionOverride allows resource handling overrides for specific resources # within a BaseType class CollectionOverride include Google::Apis::Core::Hashable # The collection that identifies this resource within its service. # Corresponds to the JSON property `collection` # @return [String] attr_accessor :collection # Options allows customized resource handling by Deployment Manager. # Corresponds to the JSON property `options` # @return [Google::Apis::DeploymentmanagerV2beta::Options] attr_accessor :options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @collection = args[:collection] if args.key?(:collection) @options = args[:options] if args.key?(:options) end end # Holds the composite type. class CompositeType include Google::Apis::Core::Hashable # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. Timestamp when the composite type was created, in RFC3339 text # format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Map of labels; provided by the client when the resource is created or updated. # Specifically: Label keys must be between 1 and 63 characters long and must # conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label # values must be between 0 and 63 characters long and must conform to the # regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Name of the composite type, must follow the expression: [a-z]([-a-z0-9_.]`0,61` # [a-z0-9])?. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) # Corresponds to the JSON property `operation` # @return [Google::Apis::DeploymentmanagerV2beta::Operation] attr_accessor :operation # Output only. Self link for the type provider. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Files that make up the template contents of a template type. # Corresponds to the JSON property `templateContents` # @return [Google::Apis::DeploymentmanagerV2beta::TemplateContents] attr_accessor :template_contents def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @operation = args[:operation] if args.key?(:operation) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) @template_contents = args[:template_contents] if args.key?(:template_contents) end end # class CompositeTypeLabelEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # A response that returns all Composite Types supported by Deployment Manager class CompositeTypesListResponse include Google::Apis::Core::Hashable # Output only. A list of resource composite types supported by Deployment # Manager. # Corresponds to the JSON property `compositeTypes` # @return [Array] attr_accessor :composite_types # A token used to continue a truncated list request. # 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) @composite_types = args[:composite_types] if args.key?(:composite_types) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # A condition to be met. class Condition include Google::Apis::Core::Hashable # Trusted attributes supplied by the IAM system. # Corresponds to the JSON property `iam` # @return [String] attr_accessor :iam # An operator to apply the subject with. # Corresponds to the JSON property `op` # @return [String] attr_accessor :op # Trusted attributes discharged by the service. # Corresponds to the JSON property `svc` # @return [String] attr_accessor :svc # Trusted attributes supplied by any service that owns resources and uses the # IAM system for access control. # Corresponds to the JSON property `sys` # @return [String] attr_accessor :sys # DEPRECATED. Use 'values' instead. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value # The objects of the condition. This is mutually exclusive with 'value'. # 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) @iam = args[:iam] if args.key?(:iam) @op = args[:op] if args.key?(:op) @svc = args[:svc] if args.key?(:svc) @sys = args[:sys] if args.key?(:sys) @value = args[:value] if args.key?(:value) @values = args[:values] if args.key?(:values) end end # class ConfigFile include Google::Apis::Core::Hashable # The contents of the file. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content = args[:content] if args.key?(:content) end end # The credential used by Deployment Manager and TypeProvider. Only one of the # options is permitted. class Credential include Google::Apis::Core::Hashable # Basic Auth used as a credential. # Corresponds to the JSON property `basicAuth` # @return [Google::Apis::DeploymentmanagerV2beta::BasicAuth] attr_accessor :basic_auth # Service Account used as a credential. # Corresponds to the JSON property `serviceAccount` # @return [Google::Apis::DeploymentmanagerV2beta::ServiceAccount] attr_accessor :service_account # Specify to use the project default credential, only supported by Deployment. # Corresponds to the JSON property `useProjectDefault` # @return [Boolean] attr_accessor :use_project_default alias_method :use_project_default?, :use_project_default def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @basic_auth = args[:basic_auth] if args.key?(:basic_auth) @service_account = args[:service_account] if args.key?(:service_account) @use_project_default = args[:use_project_default] if args.key?(:use_project_default) end end # class Deployment include Google::Apis::Core::Hashable # An optional user-provided description of the deployment. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Provides a fingerprint to use in requests to modify a deployment, such as # update(), stop(), and cancelPreview() requests. A fingerprint is a randomly # generated value that must be provided with update(), stop(), and cancelPreview( # ) requests to perform optimistic locking. This ensures optimistic concurrency # so that only one request happens at a time. # The fingerprint is initially generated by Deployment Manager and changes after # every request to modify data. To get the latest fingerprint value, perform a # get() request to a deployment. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. Timestamp when the deployment was created, in RFC3339 text format # . # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Map of labels; provided by the client when the resource is created or updated. # Specifically: Label keys must be between 1 and 63 characters long and must # conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label # values must be between 0 and 63 characters long and must conform to the # regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Output only. URL of the manifest representing the last manifest that was # successfully deployed. # Corresponds to the JSON property `manifest` # @return [String] attr_accessor :manifest # 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 Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) # Corresponds to the JSON property `operation` # @return [Google::Apis::DeploymentmanagerV2beta::Operation] attr_accessor :operation # Output only. Self link for the deployment. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # # Corresponds to the JSON property `target` # @return [Google::Apis::DeploymentmanagerV2beta::TargetConfiguration] attr_accessor :target # # Corresponds to the JSON property `update` # @return [Google::Apis::DeploymentmanagerV2beta::DeploymentUpdate] attr_accessor :update def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @labels = args[:labels] if args.key?(:labels) @manifest = args[:manifest] if args.key?(:manifest) @name = args[:name] if args.key?(:name) @operation = args[:operation] if args.key?(:operation) @self_link = args[:self_link] if args.key?(:self_link) @target = args[:target] if args.key?(:target) @update = args[:update] if args.key?(:update) end end # class DeploymentLabelEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # class DeploymentUpdate include Google::Apis::Core::Hashable # Output only. An optional user-provided description of the deployment after the # current update has been applied. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Output only. Map of labels; provided by the client when the resource is # created or updated. Specifically: Label keys must be between 1 and 63 # characters long and must conform to the following regular expression: [a-z]([- # a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and # must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Output only. URL of the manifest representing the update configuration of this # deployment. # Corresponds to the JSON property `manifest` # @return [String] attr_accessor :manifest def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @labels = args[:labels] if args.key?(:labels) @manifest = args[:manifest] if args.key?(:manifest) end end # class DeploymentUpdateLabelEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # class DeploymentsCancelPreviewRequest include Google::Apis::Core::Hashable # Specifies a fingerprint for cancelPreview() requests. A fingerprint is a # randomly generated value that must be provided in cancelPreview() requests to # perform optimistic locking. This ensures optimistic concurrency so that the # deployment does not have conflicting requests (e.g. if someone attempts to # make a new update request while another user attempts to cancel a preview, # this would prevent one of the requests). # The fingerprint is initially generated by Deployment Manager and changes after # every request to modify a deployment. To get the latest fingerprint value, # perform a get() request on the deployment. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) end end # A response containing a partial list of deployments and a page token used to # build the next request if the request has been truncated. class DeploymentsListResponse include Google::Apis::Core::Hashable # Output only. The deployments contained in this response. # Corresponds to the JSON property `deployments` # @return [Array] attr_accessor :deployments # Output only. A token used to continue a truncated list request. # 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) @deployments = args[:deployments] if args.key?(:deployments) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # class DeploymentsStopRequest include Google::Apis::Core::Hashable # Specifies a fingerprint for stop() requests. A fingerprint is a randomly # generated value that must be provided in stop() requests to perform optimistic # locking. This ensures optimistic concurrency so that the deployment does not # have conflicting requests (e.g. if someone attempts to make a new update # request while another user attempts to stop an ongoing update request, this # would prevent a collision). # The fingerprint is initially generated by Deployment Manager and changes after # every request to modify a deployment. To get the latest fingerprint value, # perform a get() request on the deployment. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) end end # class Diagnostic include Google::Apis::Core::Hashable # JsonPath expression on the resource that if non empty, indicates that this # field needs to be extracted as a diagnostic. # Corresponds to the JSON property `field` # @return [String] attr_accessor :field # Level to record this diagnostic. # Corresponds to the JSON property `level` # @return [String] attr_accessor :level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) @level = args[:level] if args.key?(:level) end end # Represents an expression text. Example: # title: "User account presence" description: "Determines whether the request # has a user account" expression: "size(request.user) > 0" class Expr include Google::Apis::Core::Hashable # An 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. # The application context of the containing message determines which well-known # feature set of CEL is supported. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression # An 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 # An 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 # class ImportFile include Google::Apis::Core::Hashable # The contents of the file. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The name of the file. # 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) @content = args[:content] if args.key?(:content) @name = args[:name] if args.key?(:name) end end # InputMapping creates a 'virtual' property that will be injected into the # properties before sending the request to the underlying API. class InputMapping include Google::Apis::Core::Hashable # The name of the field that is going to be injected. # Corresponds to the JSON property `fieldName` # @return [String] attr_accessor :field_name # The location where this mapping applies. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # Regex to evaluate on method to decide if input applies. # Corresponds to the JSON property `methodMatch` # @return [String] attr_accessor :method_match # A jsonPath expression to select an element. # 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) @field_name = args[:field_name] if args.key?(:field_name) @location = args[:location] if args.key?(:location) @method_match = args[:method_match] if args.key?(:method_match) @value = args[:value] if args.key?(:value) end end # Specifies what kind of log the caller must write class LogConfig include Google::Apis::Core::Hashable # Write a Cloud Audit log # Corresponds to the JSON property `cloudAudit` # @return [Google::Apis::DeploymentmanagerV2beta::LogConfigCloudAuditOptions] attr_accessor :cloud_audit # Increment a streamz counter with the specified metric and field names. # Metric names should start with a '/', generally be lowercase-only, and end in " # _count". Field names should not contain an initial slash. The actual exported # metric names will have "/iam/policy" prepended. # Field names correspond to IAM request parameters and field values are their # respective values. # At present the only supported field names are - "iam_principal", corresponding # to IAMContext.principal; - "" (empty string), resulting in one aggretated # counter with no field. # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/backend_debug_access_count `iam_principal=[value # of IAMContext.principal]` # At this time we do not support: * multiple field names (though this may be # supported in the future) * decrementing the counter * incrementing it by # anything other than 1 # Corresponds to the JSON property `counter` # @return [Google::Apis::DeploymentmanagerV2beta::LogConfigCounterOptions] attr_accessor :counter # Write a Data Access (Gin) log # Corresponds to the JSON property `dataAccess` # @return [Google::Apis::DeploymentmanagerV2beta::LogConfigDataAccessOptions] attr_accessor :data_access def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cloud_audit = args[:cloud_audit] if args.key?(:cloud_audit) @counter = args[:counter] if args.key?(:counter) @data_access = args[:data_access] if args.key?(:data_access) end end # Write a Cloud Audit log class LogConfigCloudAuditOptions include Google::Apis::Core::Hashable # Authorization-related information used by Cloud Audit Logging. # Corresponds to the JSON property `authorizationLoggingOptions` # @return [Google::Apis::DeploymentmanagerV2beta::AuthorizationLoggingOptions] attr_accessor :authorization_logging_options # The log_name to populate in the Cloud Audit Record. # Corresponds to the JSON property `logName` # @return [String] attr_accessor :log_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @authorization_logging_options = args[:authorization_logging_options] if args.key?(:authorization_logging_options) @log_name = args[:log_name] if args.key?(:log_name) end end # Increment a streamz counter with the specified metric and field names. # Metric names should start with a '/', generally be lowercase-only, and end in " # _count". Field names should not contain an initial slash. The actual exported # metric names will have "/iam/policy" prepended. # Field names correspond to IAM request parameters and field values are their # respective values. # At present the only supported field names are - "iam_principal", corresponding # to IAMContext.principal; - "" (empty string), resulting in one aggretated # counter with no field. # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/backend_debug_access_count `iam_principal=[value # of IAMContext.principal]` # At this time we do not support: * multiple field names (though this may be # supported in the future) * decrementing the counter * incrementing it by # anything other than 1 class LogConfigCounterOptions include Google::Apis::Core::Hashable # The field value to attribute. # Corresponds to the JSON property `field` # @return [String] attr_accessor :field # The metric to update. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) @metric = args[:metric] if args.key?(:metric) end end # Write a Data Access (Gin) log class LogConfigDataAccessOptions include Google::Apis::Core::Hashable # Whether Gin logging should happen in a fail-closed manner at the caller. This # is relevant only in the LocalIAM implementation, for now. # Corresponds to the JSON property `logMode` # @return [String] attr_accessor :log_mode def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @log_mode = args[:log_mode] if args.key?(:log_mode) end end # class Manifest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `config` # @return [Google::Apis::DeploymentmanagerV2beta::ConfigFile] attr_accessor :config # Output only. The fully-expanded configuration file, including any templates # and references. # Corresponds to the JSON property `expandedConfig` # @return [String] attr_accessor :expanded_config # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. The imported files for this manifest. # Corresponds to the JSON property `imports` # @return [Array] attr_accessor :imports # Output only. Timestamp when the manifest was created, in RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Output only. The YAML layout for this manifest. # Corresponds to the JSON property `layout` # @return [String] attr_accessor :layout # Output only. # The name of the manifest. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. Self link for the manifest. # 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) @config = args[:config] if args.key?(:config) @expanded_config = args[:expanded_config] if args.key?(:expanded_config) @id = args[:id] if args.key?(:id) @imports = args[:imports] if args.key?(:imports) @insert_time = args[:insert_time] if args.key?(:insert_time) @layout = args[:layout] if args.key?(:layout) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) end end # A response containing a partial list of manifests and a page token used to # build the next request if the request has been truncated. class ManifestsListResponse include Google::Apis::Core::Hashable # Output only. Manifests contained in this list response. # Corresponds to the JSON property `manifests` # @return [Array] attr_accessor :manifests # Output only. A token used to continue a truncated list request. # 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) @manifests = args[:manifests] if args.key?(:manifests) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # An Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) class Operation include Google::Apis::Core::Hashable # [Output Only] Reserved for future use. # Corresponds to the JSON property `clientOperationId` # @return [String] attr_accessor :client_operation_id # [Deprecated] This field is deprecated. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] A textual description of the operation, which is set when the # operation is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The time that this operation was completed. This value is in # RFC3339 text format. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # [Output Only] If errors are generated during processing of the operation, this # field will be populated. # Corresponds to the JSON property `error` # @return [Google::Apis::DeploymentmanagerV2beta::Operation::Error] attr_accessor :error # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as NOT FOUND. # Corresponds to the JSON property `httpErrorMessage` # @return [String] attr_accessor :http_error_message # [Output Only] If the operation fails, this field contains the HTTP error # status code that was returned. For example, a 404 means the resource was not # found. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] attr_accessor :http_error_status_code # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The time that this operation was requested. This value is in # RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # [Output Only] Type of the resource. Always compute#operation for Operation # resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] The type of operation, such as insert, update, or delete, and so # on. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # [Output Only] An optional progress indicator that ranges from 0 to 100. There # is no requirement that this be linear or support any granularity of operations. # This should not be used to guess when the operation will be complete. This # number should monotonically increase as the operation progresses. # Corresponds to the JSON property `progress` # @return [Fixnum] attr_accessor :progress # [Output Only] The URL of the region where the operation resides. Only # available when performing regional operations. 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 # [Output Only] The time that this operation was started by the server. This # value is in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # [Output Only] The status of the operation, which can be one of the following: # PENDING, RUNNING, or DONE. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional textual description of the current status of the # operation. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # [Output Only] The unique target ID, which identifies a specific incarnation of # the target resource. # Corresponds to the JSON property `targetId` # @return [Fixnum] attr_accessor :target_id # [Output Only] The URL of the resource that the operation modifies. For # operations related to creating a snapshot, this points to the persistent disk # that the snapshot was created from. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link # [Output Only] User who requested the operation, for example: user@example.com. # Corresponds to the JSON property `user` # @return [String] attr_accessor :user # [Output Only] If warning messages are generated during processing of the # operation, this field will be populated. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings # [Output Only] The URL of the zone where the operation resides. Only available # when performing per-zone operations. 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 `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @end_time = args[:end_time] if args.key?(:end_time) @error = args[:error] if args.key?(:error) @http_error_message = args[:http_error_message] if args.key?(:http_error_message) @http_error_status_code = args[:http_error_status_code] if args.key?(:http_error_status_code) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @operation_type = args[:operation_type] if args.key?(:operation_type) @progress = args[:progress] if args.key?(:progress) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @target_id = args[:target_id] if args.key?(:target_id) @target_link = args[:target_link] if args.key?(:target_link) @user = args[:user] if args.key?(:user) @warnings = args[:warnings] if args.key?(:warnings) @zone = args[:zone] if args.key?(:zone) end # [Output Only] If errors are generated during processing of the operation, this # field will be populated. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end # 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 response containing a partial list of operations and a page token used to # build the next request if the request has been truncated. class OperationsListResponse include Google::Apis::Core::Hashable # Output only. A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. Operations contained in this list response. # 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 # Options allows customized resource handling by Deployment Manager. class Options include Google::Apis::Core::Hashable # Options regarding how to thread async requests. # Corresponds to the JSON property `asyncOptions` # @return [Array] attr_accessor :async_options # The mappings that apply for requests. # Corresponds to the JSON property `inputMappings` # @return [Array] attr_accessor :input_mappings # Options for how to validate and process properties on a resource. # Corresponds to the JSON property `validationOptions` # @return [Google::Apis::DeploymentmanagerV2beta::ValidationOptions] attr_accessor :validation_options # Additional properties block described as a jsonSchema, these properties will # never be part of the json payload, but they can be consumed by InputMappings, # this must be a valid json schema draft-04. The properties specified here will # be decouple in a different section. This schema will be merged to the schema # validation, and properties here will be extracted From the payload and # consumed explicitly by InputMappings. ex: field1: type: string field2: type: # number # Corresponds to the JSON property `virtualProperties` # @return [String] attr_accessor :virtual_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @async_options = args[:async_options] if args.key?(:async_options) @input_mappings = args[:input_mappings] if args.key?(:input_mappings) @validation_options = args[:validation_options] if args.key?(:validation_options) @virtual_properties = args[:virtual_properties] if args.key?(:virtual_properties) end end # Defines an Identity and Access Management (IAM) policy. It is used to specify # access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of ` # members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` "bindings": [ ` "role": "roles/owner", "members": [ "user:mike@example.com", # "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@ # appspot.gserviceaccount.com", ] `, ` "role": "roles/viewer", "members": ["user: # sean@example.com"] ` ] ` # For a description of IAM and its features, see the [IAM developer's guide]( # https://cloud.google.com/iam/docs). class Policy include Google::Apis::Core::Hashable # Specifies cloud audit logging configuration for this policy. # Corresponds to the JSON property `auditConfigs` # @return [Array] attr_accessor :audit_configs # Associates a list of `members` to a `role`. `bindings` with no members will # result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # # Corresponds to the JSON property `iamOwned` # @return [Boolean] attr_accessor :iam_owned alias_method :iam_owned?, :iam_owned # If more than one rule is specified, the rules are applied in the following # manner: - All matching LOG rules are always applied. - If any DENY/ # DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if # one or more matching rule requires logging. - Otherwise, if any ALLOW/ # ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if # one or more matching rule requires logging. - Otherwise, if no rule applies, # permission is denied. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules # Deprecated. # 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) @iam_owned = args[:iam_owned] if args.key?(:iam_owned) @rules = args[:rules] if args.key?(:rules) @version = args[:version] if args.key?(:version) end end # class PollingOptions include Google::Apis::Core::Hashable # An array of diagnostics to be collected by Deployment Manager, these # diagnostics will be displayed to the user. # Corresponds to the JSON property `diagnostics` # @return [Array] attr_accessor :diagnostics # JsonPath expression that determines if the request failed. # Corresponds to the JSON property `failCondition` # @return [String] attr_accessor :fail_condition # JsonPath expression that determines if the request is completed. # Corresponds to the JSON property `finishCondition` # @return [String] attr_accessor :finish_condition # JsonPath expression that evaluates to string, it indicates where to poll. # Corresponds to the JSON property `pollingLink` # @return [String] attr_accessor :polling_link # JsonPath expression, after polling is completed, indicates where to fetch the # resource. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @diagnostics = args[:diagnostics] if args.key?(:diagnostics) @fail_condition = args[:fail_condition] if args.key?(:fail_condition) @finish_condition = args[:finish_condition] if args.key?(:finish_condition) @polling_link = args[:polling_link] if args.key?(:polling_link) @target_link = args[:target_link] if args.key?(:target_link) end end # class Resource include Google::Apis::Core::Hashable # The access controls set on the resource. # Corresponds to the JSON property `accessControl` # @return [Google::Apis::DeploymentmanagerV2beta::ResourceAccessControl] attr_accessor :access_control # Output only. The evaluated properties of the resource with references expanded. # Returned as serialized YAML. # Corresponds to the JSON property `finalProperties` # @return [String] attr_accessor :final_properties # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. Timestamp when the resource was created or acquired, in RFC3339 # text format . # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Output only. URL of the manifest representing the current configuration of # this resource. # Corresponds to the JSON property `manifest` # @return [String] attr_accessor :manifest # Output only. The name of the resource as it appears in the YAML config. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The current properties of the resource before any references have # been filled in. Returned as serialized YAML. # Corresponds to the JSON property `properties` # @return [String] attr_accessor :properties # Output only. The type of the resource, for example compute.v1.instance, or # cloudfunctions.v1beta1.function. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # # Corresponds to the JSON property `update` # @return [Google::Apis::DeploymentmanagerV2beta::ResourceUpdate] attr_accessor :update # Output only. Timestamp when the resource was updated, in RFC3339 text format . # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Output only. The URL of the actual resource. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Output only. If warning messages are generated during processing of this # resource, this field will be populated. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @access_control = args[:access_control] if args.key?(:access_control) @final_properties = args[:final_properties] if args.key?(:final_properties) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @manifest = args[:manifest] if args.key?(:manifest) @name = args[:name] if args.key?(:name) @properties = args[:properties] if args.key?(:properties) @type = args[:type] if args.key?(:type) @update = args[:update] if args.key?(:update) @update_time = args[:update_time] if args.key?(:update_time) @url = args[:url] if args.key?(:url) @warnings = args[:warnings] if args.key?(:warnings) end # 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 # The access controls set on the resource. class ResourceAccessControl include Google::Apis::Core::Hashable # The GCP IAM Policy to set on the resource. # Corresponds to the JSON property `gcpIamPolicy` # @return [String] attr_accessor :gcp_iam_policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @gcp_iam_policy = args[:gcp_iam_policy] if args.key?(:gcp_iam_policy) end end # class ResourceUpdate include Google::Apis::Core::Hashable # The access controls set on the resource. # Corresponds to the JSON property `accessControl` # @return [Google::Apis::DeploymentmanagerV2beta::ResourceAccessControl] attr_accessor :access_control # Output only. If errors are generated during update of the resource, this field # will be populated. # Corresponds to the JSON property `error` # @return [Google::Apis::DeploymentmanagerV2beta::ResourceUpdate::Error] attr_accessor :error # Output only. The expanded properties of the resource with reference values # expanded. Returned as serialized YAML. # Corresponds to the JSON property `finalProperties` # @return [String] attr_accessor :final_properties # Output only. The intent of the resource: PREVIEW, UPDATE, or CANCEL. # Corresponds to the JSON property `intent` # @return [String] attr_accessor :intent # Output only. URL of the manifest representing the update configuration of this # resource. # Corresponds to the JSON property `manifest` # @return [String] attr_accessor :manifest # Output only. The set of updated properties for this resource, before # references are expanded. Returned as serialized YAML. # Corresponds to the JSON property `properties` # @return [String] attr_accessor :properties # Output only. The state of the resource. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. If warning messages are generated during processing of this # resource, this field will be populated. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @access_control = args[:access_control] if args.key?(:access_control) @error = args[:error] if args.key?(:error) @final_properties = args[:final_properties] if args.key?(:final_properties) @intent = args[:intent] if args.key?(:intent) @manifest = args[:manifest] if args.key?(:manifest) @properties = args[:properties] if args.key?(:properties) @state = args[:state] if args.key?(:state) @warnings = args[:warnings] if args.key?(:warnings) end # Output only. If errors are generated during update of the resource, this field # will be populated. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end # 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 response containing a partial list of resources and a page token used to # build the next request if the request has been truncated. class ResourcesListResponse include Google::Apis::Core::Hashable # A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Resources contained in this list response. # 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) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @resources = args[:resources] if args.key?(:resources) end end # A rule to be applied in a Policy. class Rule include Google::Apis::Core::Hashable # Required # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Additional restrictions that must be met. All conditions must pass for the # rule to match. # Corresponds to the JSON property `conditions` # @return [Array] attr_accessor :conditions # Human-readable description of the rule. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/ # AUTHORITY_SELECTOR is in at least one of these entries. # Corresponds to the JSON property `ins` # @return [Array] attr_accessor :ins # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries # that match the LOG action. # Corresponds to the JSON property `logConfigs` # @return [Array] attr_accessor :log_configs # If one or more 'not_in' clauses are specified, the rule matches if the # PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. # Corresponds to the JSON property `notIns` # @return [Array] attr_accessor :not_ins # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value # of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets. # *') matches all verbs. # 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) @action = args[:action] if args.key?(:action) @conditions = args[:conditions] if args.key?(:conditions) @description = args[:description] if args.key?(:description) @ins = args[:ins] if args.key?(:ins) @log_configs = args[:log_configs] if args.key?(:log_configs) @not_ins = args[:not_ins] if args.key?(:not_ins) @permissions = args[:permissions] if args.key?(:permissions) end end # Service Account used as a credential. class ServiceAccount include Google::Apis::Core::Hashable # The IAM service account email address like test@myproject.iam.gserviceaccount. # com # Corresponds to the JSON property `email` # @return [String] attr_accessor :email def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) end end # class TargetConfiguration include Google::Apis::Core::Hashable # # Corresponds to the JSON property `config` # @return [Google::Apis::DeploymentmanagerV2beta::ConfigFile] attr_accessor :config # Specifies any files to import for this configuration. This can be used to # import templates or other files. For example, you might import a text file in # order to use the file in a template. # Corresponds to the JSON property `imports` # @return [Array] attr_accessor :imports def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @config = args[:config] if args.key?(:config) @imports = args[:imports] if args.key?(:imports) end end # Files that make up the template contents of a template type. class TemplateContents include Google::Apis::Core::Hashable # Import files referenced by the main template. # Corresponds to the JSON property `imports` # @return [Array] attr_accessor :imports # Which interpreter (python or jinja) should be used during expansion. # Corresponds to the JSON property `interpreter` # @return [String] attr_accessor :interpreter # The filename of the mainTemplate # Corresponds to the JSON property `mainTemplate` # @return [String] attr_accessor :main_template # The contents of the template schema. # Corresponds to the JSON property `schema` # @return [String] attr_accessor :schema # The contents of the main template file. # Corresponds to the JSON property `template` # @return [String] attr_accessor :template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @imports = args[:imports] if args.key?(:imports) @interpreter = args[:interpreter] if args.key?(:interpreter) @main_template = args[:main_template] if args.key?(:main_template) @schema = args[:schema] if args.key?(:schema) @template = args[:template] if args.key?(:template) end end # class TestPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the 'resource'. Permissions with wildcards # (such as '*' or 'storage.*') are not 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 # class TestPermissionsResponse 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 # A resource type supported by Deployment Manager. class Type include Google::Apis::Core::Hashable # BaseType that describes a service-backed Type. # Corresponds to the JSON property `base` # @return [Google::Apis::DeploymentmanagerV2beta::BaseType] attr_accessor :base # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. Timestamp when the type was created, in RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Map of labels; provided by the client when the resource is created or updated. # Specifically: Label keys must be between 1 and 63 characters long and must # conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label # values must be between 0 and 63 characters long and must conform to the # regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Name of the type. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) # Corresponds to the JSON property `operation` # @return [Google::Apis::DeploymentmanagerV2beta::Operation] attr_accessor :operation # Output only. Self link for the type. # 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) @base = args[:base] if args.key?(:base) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @operation = args[:operation] if args.key?(:operation) @self_link = args[:self_link] if args.key?(:self_link) end end # Contains detailed information about a composite type, base type, or base type # with specific collection. class TypeInfo include Google::Apis::Core::Hashable # The description of the type. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field # will be empty. # Corresponds to the JSON property `documentationLink` # @return [String] attr_accessor :documentation_link # Output only. Type of the output. Always deploymentManager#TypeInfo for # TypeInfo. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The base type or composite type name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # # Corresponds to the JSON property `schema` # @return [Google::Apis::DeploymentmanagerV2beta::TypeInfoSchemaInfo] attr_accessor :schema # Output only. Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The title on the API descriptor URL provided. # 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) @documentation_link = args[:documentation_link] if args.key?(:documentation_link) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @schema = args[:schema] if args.key?(:schema) @self_link = args[:self_link] if args.key?(:self_link) @title = args[:title] if args.key?(:title) end end # class TypeInfoSchemaInfo include Google::Apis::Core::Hashable # The properties that this composite type or base type collection accept as # input, represented as a json blob, format is: JSON Schema Draft V4 # Corresponds to the JSON property `input` # @return [String] attr_accessor :input # The properties that this composite type or base type collection exposes as # output, these properties can be used for references, represented as json blob, # format is: JSON Schema Draft V4 # Corresponds to the JSON property `output` # @return [String] attr_accessor :output def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @input = args[:input] if args.key?(:input) @output = args[:output] if args.key?(:output) end end # class TypeLabelEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # A type provider that describes a service-backed Type. class TypeProvider include Google::Apis::Core::Hashable # Allows resource handling overrides for specific collections # Corresponds to the JSON property `collectionOverrides` # @return [Array] attr_accessor :collection_overrides # The credential used by Deployment Manager and TypeProvider. Only one of the # options is permitted. # Corresponds to the JSON property `credential` # @return [Google::Apis::DeploymentmanagerV2beta::Credential] attr_accessor :credential # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Descriptor Url for the this type provider. # Corresponds to the JSON property `descriptorUrl` # @return [String] attr_accessor :descriptor_url # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. Timestamp when the type provider was created, in RFC3339 text # format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Map of labels; provided by the client when the resource is created or updated. # Specifically: Label keys must be between 1 and 63 characters long and must # conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label # values must be between 0 and 63 characters long and must conform to the # regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Name of the type provider. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) # Corresponds to the JSON property `operation` # @return [Google::Apis::DeploymentmanagerV2beta::Operation] attr_accessor :operation # Options allows customized resource handling by Deployment Manager. # Corresponds to the JSON property `options` # @return [Google::Apis::DeploymentmanagerV2beta::Options] attr_accessor :options # Output only. Self link for the type provider. # 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) @collection_overrides = args[:collection_overrides] if args.key?(:collection_overrides) @credential = args[:credential] if args.key?(:credential) @description = args[:description] if args.key?(:description) @descriptor_url = args[:descriptor_url] if args.key?(:descriptor_url) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @operation = args[:operation] if args.key?(:operation) @options = args[:options] if args.key?(:options) @self_link = args[:self_link] if args.key?(:self_link) end end # class TypeProviderLabelEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # A response that returns all Type Providers supported by Deployment Manager class TypeProvidersListResponse include Google::Apis::Core::Hashable # A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. A list of resource type providers supported by Deployment Manager. # Corresponds to the JSON property `typeProviders` # @return [Array] attr_accessor :type_providers 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) @type_providers = args[:type_providers] if args.key?(:type_providers) end end # class TypeProvidersListTypesResponse include Google::Apis::Core::Hashable # A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. A list of resource type info. # Corresponds to the JSON property `types` # @return [Array] attr_accessor :types 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) @types = args[:types] if args.key?(:types) end end # A response that returns all Types supported by Deployment Manager class TypesListResponse include Google::Apis::Core::Hashable # A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. A list of resource types supported by Deployment Manager. # Corresponds to the JSON property `types` # @return [Array] attr_accessor :types 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) @types = args[:types] if args.key?(:types) end end # Options for how to validate and process properties on a resource. class ValidationOptions include Google::Apis::Core::Hashable # Customize how deployment manager will validate the resource against schema # errors. # Corresponds to the JSON property `schemaValidation` # @return [String] attr_accessor :schema_validation # Specify what to do with extra properties when executing a request. # Corresponds to the JSON property `undeclaredProperties` # @return [String] attr_accessor :undeclared_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @schema_validation = args[:schema_validation] if args.key?(:schema_validation) @undeclared_properties = args[:undeclared_properties] if args.key?(:undeclared_properties) end end end end end google-api-client-0.19.8/generated/google/apis/deploymentmanager_v2beta/service.rb0000644000004100000410000032602213252673043030263 0ustar www-datawww-data# 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 DeploymentmanagerV2beta # Google Cloud Deployment Manager API V2Beta Methods # # The Deployment Manager API allows users to declaratively configure, deploy and # run complex solutions on the Google Cloud Platform. # # @example # require 'google/apis/deploymentmanager_v2beta' # # Deploymentmanager = Google::Apis::DeploymentmanagerV2beta # Alias the module # service = Deploymentmanager::DeploymentManagerV2BetaService.new # # @see https://developers.google.com/deployment-manager/ class DeploymentManagerV2BetaService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'deploymentmanager/v2beta/projects/') @batch_path = 'batch/deploymentmanager/v2beta' end # Deletes a composite type. # @param [String] project # The project ID for this request. # @param [String] composite_type # The name of the type for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_composite_type(project, composite_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/compositeTypes/{compositeType}', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['compositeType'] = composite_type unless composite_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 # Gets information about a specific composite type. # @param [String] project # The project ID for this request. # @param [String] composite_type # The name of the composite type for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::CompositeType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::CompositeType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_composite_type(project, composite_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/compositeTypes/{compositeType}', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::CompositeType::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::CompositeType command.params['project'] = project unless project.nil? command.params['compositeType'] = composite_type unless composite_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 # Creates a composite type. # @param [String] project # The project ID for this request. # @param [Google::Apis::DeploymentmanagerV2beta::CompositeType] composite_type_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_composite_type(project, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/compositeTypes', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::CompositeType::Representation command.request_object = composite_type_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.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 composite types for Deployment Manager. # @param [String] project # The project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::CompositeTypesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::CompositeTypesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_composite_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/compositeTypes', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::CompositeTypesListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::CompositeTypesListResponse command.params['project'] = project unless project.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['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 a composite type. This method supports patch semantics. # @param [String] project # The project ID for this request. # @param [String] composite_type # The name of the composite type for this request. # @param [Google::Apis::DeploymentmanagerV2beta::CompositeType] composite_type_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_composite_type(project, composite_type, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/compositeTypes/{compositeType}', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::CompositeType::Representation command.request_object = composite_type_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['compositeType'] = composite_type unless composite_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 a composite type. # @param [String] project # The project ID for this request. # @param [String] composite_type # The name of the composite type for this request. # @param [Google::Apis::DeploymentmanagerV2beta::CompositeType] composite_type_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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 update_composite_type(project, composite_type, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/compositeTypes/{compositeType}', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::CompositeType::Representation command.request_object = composite_type_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['compositeType'] = composite_type unless composite_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 # Cancels and removes the preview currently associated with the deployment. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [Google::Apis::DeploymentmanagerV2beta::DeploymentsCancelPreviewRequest] deployments_cancel_preview_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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 cancel_deployment_preview(project, deployment, deployments_cancel_preview_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments/{deployment}/cancelPreview', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::DeploymentsCancelPreviewRequest::Representation command.request_object = deployments_cancel_preview_request_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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 a deployment and all of the resources in the deployment. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [String] delete_policy # Sets the policy to use for deleting resources. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_deployment(project, deployment, delete_policy: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/deployments/{deployment}', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['deletePolicy'] = delete_policy unless delete_policy.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 information about a specific deployment. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Deployment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::Deployment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deployment(project, deployment, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::Deployment::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Deployment command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_deployment_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{resource}/getIamPolicy', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::Policy::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Policy command.params['project'] = project unless project.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 # Creates a deployment and all of the resources described by the deployment # manifest. # @param [String] project # The project ID for this request. # @param [Google::Apis::DeploymentmanagerV2beta::Deployment] deployment_object # @param [String] create_policy # # @param [Boolean] preview # If set to true, creates a deployment and creates "shell" resources but does # not actually instantiate these resources. This allows you to preview what your # deployment looks like. After previewing a deployment, you can deploy your # resources by making a request with the update() method or you can use the # cancelPreview() method to cancel the preview altogether. Note that the # deployment will still exist after you cancel the preview and you must # separately delete this deployment if you want to remove it. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_deployment(project, deployment_object = nil, create_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::Deployment::Representation command.request_object = deployment_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.query['createPolicy'] = create_policy unless create_policy.nil? command.query['preview'] = preview unless preview.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 deployments for a given project. # @param [String] project # The project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::DeploymentsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::DeploymentsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deployments(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::DeploymentsListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::DeploymentsListResponse command.params['project'] = project unless project.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['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 a deployment and all of the resources described by the deployment # manifest. This method supports patch semantics. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [Google::Apis::DeploymentmanagerV2beta::Deployment] deployment_object # @param [String] create_policy # Sets the policy to use for creating new resources. # @param [String] delete_policy # Sets the policy to use for deleting resources. # @param [Boolean] preview # If set to true, updates the deployment and creates and updates the "shell" # resources but does not actually alter or instantiate these resources. This # allows you to preview what your deployment will look like. You can use this # intent to preview how an update would affect your deployment. You must provide # a target.config with a configuration if this is set to true. After previewing # a deployment, you can deploy your resources by making a request with the # update() or you can cancelPreview() to remove the preview altogether. Note # that the deployment will still exist after you cancel the preview and you must # separately delete this deployment if you want to remove it. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/deployments/{deployment}', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::Deployment::Representation command.request_object = deployment_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['createPolicy'] = create_policy unless create_policy.nil? command.query['deletePolicy'] = delete_policy unless delete_policy.nil? command.query['preview'] = preview unless preview.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] resource # Name of the resource for this request. # @param [Google::Apis::DeploymentmanagerV2beta::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_deployment_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Policy::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Policy command.params['project'] = project unless project.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 # Stops an ongoing operation. This does not roll back any work that has already # been completed, but prevents any new work from being started. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [Google::Apis::DeploymentmanagerV2beta::DeploymentsStopRequest] deployments_stop_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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 stop_deployment(project, deployment, deployments_stop_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments/{deployment}/stop', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::DeploymentsStopRequest::Representation command.request_object = deployments_stop_request_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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] resource # Name of the resource for this request. # @param [Google::Apis::DeploymentmanagerV2beta::TestPermissionsRequest] test_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::TestPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_deployment_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments/{resource}/testIamPermissions', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::TestPermissionsRequest::Representation command.request_object = test_permissions_request_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::TestPermissionsResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::TestPermissionsResponse command.params['project'] = project unless project.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 # Updates a deployment and all of the resources described by the deployment # manifest. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [Google::Apis::DeploymentmanagerV2beta::Deployment] deployment_object # @param [String] create_policy # Sets the policy to use for creating new resources. # @param [String] delete_policy # Sets the policy to use for deleting resources. # @param [Boolean] preview # If set to true, updates the deployment and creates and updates the "shell" # resources but does not actually alter or instantiate these resources. This # allows you to preview what your deployment will look like. You can use this # intent to preview how an update would affect your deployment. You must provide # a target.config with a configuration if this is set to true. After previewing # a deployment, you can deploy your resources by making a request with the # update() or you can cancelPreview() to remove the preview altogether. Note # that the deployment will still exist after you cancel the preview and you must # separately delete this deployment if you want to remove it. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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 update_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/deployments/{deployment}', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::Deployment::Representation command.request_object = deployment_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['createPolicy'] = create_policy unless create_policy.nil? command.query['deletePolicy'] = delete_policy unless delete_policy.nil? command.query['preview'] = preview unless preview.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 information about a specific manifest. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [String] manifest # The name of the manifest for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Manifest] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::Manifest] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_manifest(project, deployment, manifest, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/manifests/{manifest}', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::Manifest::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Manifest command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.params['manifest'] = manifest unless manifest.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 manifests for a given deployment. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::ManifestsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::ManifestsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_manifests(project, deployment, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/manifests', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::ManifestsListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::ManifestsListResponse command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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['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 information about a specific operation. # @param [String] project # The project ID for this request. # @param [String] operation # The name of the operation for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations/{operation}', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['operation'] = operation unless operation.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 operations for a project. # @param [String] project # The project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::OperationsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::OperationsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::OperationsListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::OperationsListResponse command.params['project'] = project unless project.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['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 information about a single resource. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [String] resource # The name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Resource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::Resource] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_resource(project, deployment, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/resources/{resource}', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::Resource::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Resource command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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 # Lists all resources in a given deployment. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::ResourcesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::ResourcesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_resources(project, deployment, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/resources', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::ResourcesListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::ResourcesListResponse command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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['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 a type provider. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_type_provider(project, type_provider, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/typeProviders/{typeProvider}', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.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 information about a specific type provider. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::TypeProvider] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::TypeProvider] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_type_provider(project, type_provider, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/typeProviders/{typeProvider}', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvider::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::TypeProvider command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.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 type info for a type provided by a TypeProvider. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this request. # @param [String] type # The name of the type provider for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::TypeInfo] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::TypeInfo] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_type_provider_type(project, type_provider, type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/typeProviders/{typeProvider}/types/{type}', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::TypeInfo::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::TypeInfo command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.nil? command.params['type'] = type unless 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 # Creates a type provider. # @param [String] project # The project ID for this request. # @param [Google::Apis::DeploymentmanagerV2beta::TypeProvider] type_provider_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_type_provider(project, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/typeProviders', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvider::Representation command.request_object = type_provider_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.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 resource type providers for Deployment Manager. # @param [String] project # The project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::TypeProvidersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::TypeProvidersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_type_providers(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/typeProviders', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvidersListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::TypeProvidersListResponse command.params['project'] = project unless project.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['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 type info for a TypeProvider. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::TypeProvidersListTypesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::TypeProvidersListTypesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_type_provider_types(project, type_provider, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/typeProviders/{typeProvider}/types', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvidersListTypesResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::TypeProvidersListTypesResponse command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.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['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 a type provider. This method supports patch semantics. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this request. # @param [Google::Apis::DeploymentmanagerV2beta::TypeProvider] type_provider_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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_type_provider(project, type_provider, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/typeProviders/{typeProvider}', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvider::Representation command.request_object = type_provider_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.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 a type provider. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this request. # @param [Google::Apis::DeploymentmanagerV2beta::TypeProvider] type_provider_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::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 update_type_provider(project, type_provider, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/typeProviders/{typeProvider}', options) command.request_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvider::Representation command.request_object = type_provider_object command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.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 resource types for Deployment Manager. # @param [String] project # The project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerV2beta::TypesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerV2beta::TypesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/types', options) command.response_representation = Google::Apis::DeploymentmanagerV2beta::TypesListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2beta::TypesListResponse command.params['project'] = project unless project.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['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 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 end end google-api-client-0.19.8/generated/google/apis/partners_v2.rb0000644000004100000410000000202313252673044024103 0ustar www-datawww-data# 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/partners_v2/service.rb' require 'google/apis/partners_v2/classes.rb' require 'google/apis/partners_v2/representations.rb' module Google module Apis # Google Partners API # # Searches certified companies and creates contact leads with them, and also # audits the usage of clients. # # @see https://developers.google.com/partners/ module PartnersV2 VERSION = 'V2' REVISION = '20180122' end end end google-api-client-0.19.8/generated/google/apis/runtimeconfig_v1beta1.rb0000644000004100000410000000307413252673044026041 0ustar www-datawww-data# 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/runtimeconfig_v1beta1/service.rb' require 'google/apis/runtimeconfig_v1beta1/classes.rb' require 'google/apis/runtimeconfig_v1beta1/representations.rb' module Google module Apis # Google Cloud Runtime Configuration API # # The Runtime Configurator allows you to dynamically configure and expose # variables through Google Cloud Platform. In addition, you can also set # Watchers and Waiters that will watch for changes to your data and return based # on certain conditions. # # @see https://cloud.google.com/deployment-manager/runtime-configurator/ module RuntimeconfigV1beta1 VERSION = 'V1beta1' REVISION = '20180212' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # Manage your Google Cloud Platform services' runtime configuration AUTH_CLOUDRUNTIMECONFIG = 'https://www.googleapis.com/auth/cloudruntimeconfig' end end end google-api-client-0.19.8/generated/google/apis/cloudtrace_v1.rb0000644000004100000410000000302113252673043024367 0ustar www-datawww-data# 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/cloudtrace_v1/service.rb' require 'google/apis/cloudtrace_v1/classes.rb' require 'google/apis/cloudtrace_v1/representations.rb' module Google module Apis # Stackdriver Trace API # # Sends application trace data to Stackdriver Trace for viewing. Trace data is # collected for all App Engine applications by default. Trace data from other # applications can be provided using this API. # # @see https://cloud.google.com/trace module CloudtraceV1 VERSION = 'V1' REVISION = '20171106' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # Write Trace data for a project or application AUTH_TRACE_APPEND = 'https://www.googleapis.com/auth/trace.append' # Read Trace data for a project or application AUTH_TRACE_READONLY = 'https://www.googleapis.com/auth/trace.readonly' end end end google-api-client-0.19.8/generated/google/apis/servicecontrol_v1/0000755000004100000410000000000013252673044024763 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/servicecontrol_v1/representations.rb0000644000004100000410000006174113252673044030546 0ustar www-datawww-data# Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'date' require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module ServicecontrolV1 class AllocateInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AllocateQuotaRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AllocateQuotaResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditLog class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthenticationInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthorizationInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CheckError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CheckInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CheckRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CheckResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConsumerInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Distribution class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EndReconciliationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EndReconciliationResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExplicitBuckets class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExponentialBuckets class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinearBuckets class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricValueSet 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 Operation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuotaError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuotaInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuotaOperation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuotaProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReleaseQuotaRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReleaseQuotaResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RequestMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StartReconciliationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StartReconciliationResponse 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 AllocateInfo # @private class Representation < Google::Apis::Core::JsonRepresentation collection :unused_arguments, as: 'unusedArguments' end end class AllocateQuotaRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :allocate_operation, as: 'allocateOperation', class: Google::Apis::ServicecontrolV1::QuotaOperation, decorator: Google::Apis::ServicecontrolV1::QuotaOperation::Representation property :service_config_id, as: 'serviceConfigId' end end class AllocateQuotaResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :allocate_errors, as: 'allocateErrors', class: Google::Apis::ServicecontrolV1::QuotaError, decorator: Google::Apis::ServicecontrolV1::QuotaError::Representation property :allocate_info, as: 'allocateInfo', class: Google::Apis::ServicecontrolV1::AllocateInfo, decorator: Google::Apis::ServicecontrolV1::AllocateInfo::Representation property :operation_id, as: 'operationId' collection :quota_metrics, as: 'quotaMetrics', class: Google::Apis::ServicecontrolV1::MetricValueSet, decorator: Google::Apis::ServicecontrolV1::MetricValueSet::Representation property :service_config_id, as: 'serviceConfigId' end end class AuditLog # @private class Representation < Google::Apis::Core::JsonRepresentation property :authentication_info, as: 'authenticationInfo', class: Google::Apis::ServicecontrolV1::AuthenticationInfo, decorator: Google::Apis::ServicecontrolV1::AuthenticationInfo::Representation collection :authorization_info, as: 'authorizationInfo', class: Google::Apis::ServicecontrolV1::AuthorizationInfo, decorator: Google::Apis::ServicecontrolV1::AuthorizationInfo::Representation hash :metadata, as: 'metadata' property :method_name, as: 'methodName' property :num_response_items, :numeric_string => true, as: 'numResponseItems' hash :request, as: 'request' property :request_metadata, as: 'requestMetadata', class: Google::Apis::ServicecontrolV1::RequestMetadata, decorator: Google::Apis::ServicecontrolV1::RequestMetadata::Representation property :resource_name, as: 'resourceName' hash :response, as: 'response' hash :service_data, as: 'serviceData' property :service_name, as: 'serviceName' property :status, as: 'status', class: Google::Apis::ServicecontrolV1::Status, decorator: Google::Apis::ServicecontrolV1::Status::Representation end end class AuthenticationInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :authority_selector, as: 'authoritySelector' property :principal_email, as: 'principalEmail' hash :third_party_principal, as: 'thirdPartyPrincipal' end end class AuthorizationInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :granted, as: 'granted' property :permission, as: 'permission' property :resource, as: 'resource' end end class CheckError # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :detail, as: 'detail' property :subject, as: 'subject' end end class CheckInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :consumer_info, as: 'consumerInfo', class: Google::Apis::ServicecontrolV1::ConsumerInfo, decorator: Google::Apis::ServicecontrolV1::ConsumerInfo::Representation collection :unused_arguments, as: 'unusedArguments' end end class CheckRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :operation, as: 'operation', class: Google::Apis::ServicecontrolV1::Operation, decorator: Google::Apis::ServicecontrolV1::Operation::Representation property :request_project_settings, as: 'requestProjectSettings' property :service_config_id, as: 'serviceConfigId' property :skip_activation_check, as: 'skipActivationCheck' end end class CheckResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :check_errors, as: 'checkErrors', class: Google::Apis::ServicecontrolV1::CheckError, decorator: Google::Apis::ServicecontrolV1::CheckError::Representation property :check_info, as: 'checkInfo', class: Google::Apis::ServicecontrolV1::CheckInfo, decorator: Google::Apis::ServicecontrolV1::CheckInfo::Representation property :operation_id, as: 'operationId' property :quota_info, as: 'quotaInfo', class: Google::Apis::ServicecontrolV1::QuotaInfo, decorator: Google::Apis::ServicecontrolV1::QuotaInfo::Representation property :service_config_id, as: 'serviceConfigId' end end class ConsumerInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :project_number, :numeric_string => true, as: 'projectNumber' end end class Distribution # @private class Representation < Google::Apis::Core::JsonRepresentation collection :bucket_counts, as: 'bucketCounts' property :count, :numeric_string => true, as: 'count' property :explicit_buckets, as: 'explicitBuckets', class: Google::Apis::ServicecontrolV1::ExplicitBuckets, decorator: Google::Apis::ServicecontrolV1::ExplicitBuckets::Representation property :exponential_buckets, as: 'exponentialBuckets', class: Google::Apis::ServicecontrolV1::ExponentialBuckets, decorator: Google::Apis::ServicecontrolV1::ExponentialBuckets::Representation property :linear_buckets, as: 'linearBuckets', class: Google::Apis::ServicecontrolV1::LinearBuckets, decorator: Google::Apis::ServicecontrolV1::LinearBuckets::Representation property :maximum, as: 'maximum' property :mean, as: 'mean' property :minimum, as: 'minimum' property :sum_of_squared_deviation, as: 'sumOfSquaredDeviation' end end class EndReconciliationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :reconciliation_operation, as: 'reconciliationOperation', class: Google::Apis::ServicecontrolV1::QuotaOperation, decorator: Google::Apis::ServicecontrolV1::QuotaOperation::Representation property :service_config_id, as: 'serviceConfigId' end end class EndReconciliationResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :operation_id, as: 'operationId' collection :quota_metrics, as: 'quotaMetrics', class: Google::Apis::ServicecontrolV1::MetricValueSet, decorator: Google::Apis::ServicecontrolV1::MetricValueSet::Representation collection :reconciliation_errors, as: 'reconciliationErrors', class: Google::Apis::ServicecontrolV1::QuotaError, decorator: Google::Apis::ServicecontrolV1::QuotaError::Representation property :service_config_id, as: 'serviceConfigId' end end class ExplicitBuckets # @private class Representation < Google::Apis::Core::JsonRepresentation collection :bounds, as: 'bounds' end end class ExponentialBuckets # @private class Representation < Google::Apis::Core::JsonRepresentation property :growth_factor, as: 'growthFactor' property :num_finite_buckets, as: 'numFiniteBuckets' property :scale, as: 'scale' end end class LinearBuckets # @private class Representation < Google::Apis::Core::JsonRepresentation property :num_finite_buckets, as: 'numFiniteBuckets' property :offset, as: 'offset' property :width, as: 'width' end end class LogEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :insert_id, as: 'insertId' hash :labels, as: 'labels' property :name, as: 'name' hash :proto_payload, as: 'protoPayload' property :severity, as: 'severity' hash :struct_payload, as: 'structPayload' property :text_payload, as: 'textPayload' property :timestamp, as: 'timestamp' end end class MetricValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :bool_value, as: 'boolValue' property :distribution_value, as: 'distributionValue', class: Google::Apis::ServicecontrolV1::Distribution, decorator: Google::Apis::ServicecontrolV1::Distribution::Representation property :double_value, as: 'doubleValue' property :end_time, as: 'endTime' property :int64_value, :numeric_string => true, as: 'int64Value' hash :labels, as: 'labels' property :money_value, as: 'moneyValue', class: Google::Apis::ServicecontrolV1::Money, decorator: Google::Apis::ServicecontrolV1::Money::Representation property :start_time, as: 'startTime' property :string_value, as: 'stringValue' end end class MetricValueSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :metric_name, as: 'metricName' collection :metric_values, as: 'metricValues', class: Google::Apis::ServicecontrolV1::MetricValue, decorator: Google::Apis::ServicecontrolV1::MetricValue::Representation 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 Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :consumer_id, as: 'consumerId' property :end_time, as: 'endTime' property :importance, as: 'importance' hash :labels, as: 'labels' collection :log_entries, as: 'logEntries', class: Google::Apis::ServicecontrolV1::LogEntry, decorator: Google::Apis::ServicecontrolV1::LogEntry::Representation collection :metric_value_sets, as: 'metricValueSets', class: Google::Apis::ServicecontrolV1::MetricValueSet, decorator: Google::Apis::ServicecontrolV1::MetricValueSet::Representation property :operation_id, as: 'operationId' property :operation_name, as: 'operationName' property :quota_properties, as: 'quotaProperties', class: Google::Apis::ServicecontrolV1::QuotaProperties, decorator: Google::Apis::ServicecontrolV1::QuotaProperties::Representation property :resource_container, as: 'resourceContainer' collection :resources, as: 'resources', class: Google::Apis::ServicecontrolV1::ResourceInfo, decorator: Google::Apis::ServicecontrolV1::ResourceInfo::Representation property :start_time, as: 'startTime' hash :user_labels, as: 'userLabels' end end class QuotaError # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :description, as: 'description' property :subject, as: 'subject' end end class QuotaInfo # @private class Representation < Google::Apis::Core::JsonRepresentation collection :limit_exceeded, as: 'limitExceeded' hash :quota_consumed, as: 'quotaConsumed' collection :quota_metrics, as: 'quotaMetrics', class: Google::Apis::ServicecontrolV1::MetricValueSet, decorator: Google::Apis::ServicecontrolV1::MetricValueSet::Representation end end class QuotaOperation # @private class Representation < Google::Apis::Core::JsonRepresentation property :consumer_id, as: 'consumerId' hash :labels, as: 'labels' property :method_name, as: 'methodName' property :operation_id, as: 'operationId' collection :quota_metrics, as: 'quotaMetrics', class: Google::Apis::ServicecontrolV1::MetricValueSet, decorator: Google::Apis::ServicecontrolV1::MetricValueSet::Representation property :quota_mode, as: 'quotaMode' end end class QuotaProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :quota_mode, as: 'quotaMode' end end class ReleaseQuotaRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :release_operation, as: 'releaseOperation', class: Google::Apis::ServicecontrolV1::QuotaOperation, decorator: Google::Apis::ServicecontrolV1::QuotaOperation::Representation property :service_config_id, as: 'serviceConfigId' end end class ReleaseQuotaResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :operation_id, as: 'operationId' collection :quota_metrics, as: 'quotaMetrics', class: Google::Apis::ServicecontrolV1::MetricValueSet, decorator: Google::Apis::ServicecontrolV1::MetricValueSet::Representation collection :release_errors, as: 'releaseErrors', class: Google::Apis::ServicecontrolV1::QuotaError, decorator: Google::Apis::ServicecontrolV1::QuotaError::Representation property :service_config_id, as: 'serviceConfigId' end end class ReportError # @private class Representation < Google::Apis::Core::JsonRepresentation property :operation_id, as: 'operationId' property :status, as: 'status', class: Google::Apis::ServicecontrolV1::Status, decorator: Google::Apis::ServicecontrolV1::Status::Representation end end class ReportInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :operation_id, as: 'operationId' property :quota_info, as: 'quotaInfo', class: Google::Apis::ServicecontrolV1::QuotaInfo, decorator: Google::Apis::ServicecontrolV1::QuotaInfo::Representation end end class ReportRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :operations, as: 'operations', class: Google::Apis::ServicecontrolV1::Operation, decorator: Google::Apis::ServicecontrolV1::Operation::Representation property :service_config_id, as: 'serviceConfigId' end end class ReportResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :report_errors, as: 'reportErrors', class: Google::Apis::ServicecontrolV1::ReportError, decorator: Google::Apis::ServicecontrolV1::ReportError::Representation collection :report_infos, as: 'reportInfos', class: Google::Apis::ServicecontrolV1::ReportInfo, decorator: Google::Apis::ServicecontrolV1::ReportInfo::Representation property :service_config_id, as: 'serviceConfigId' end end class RequestMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :caller_ip, as: 'callerIp' property :caller_network, as: 'callerNetwork' property :caller_supplied_user_agent, as: 'callerSuppliedUserAgent' end end class ResourceInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource_container, as: 'resourceContainer' property :resource_name, as: 'resourceName' end end class StartReconciliationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :reconciliation_operation, as: 'reconciliationOperation', class: Google::Apis::ServicecontrolV1::QuotaOperation, decorator: Google::Apis::ServicecontrolV1::QuotaOperation::Representation property :service_config_id, as: 'serviceConfigId' end end class StartReconciliationResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :operation_id, as: 'operationId' collection :quota_metrics, as: 'quotaMetrics', class: Google::Apis::ServicecontrolV1::MetricValueSet, decorator: Google::Apis::ServicecontrolV1::MetricValueSet::Representation collection :reconciliation_errors, as: 'reconciliationErrors', class: Google::Apis::ServicecontrolV1::QuotaError, decorator: Google::Apis::ServicecontrolV1::QuotaError::Representation property :service_config_id, as: 'serviceConfigId' 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 google-api-client-0.19.8/generated/google/apis/servicecontrol_v1/classes.rb0000644000004100000410000023471213252673044026756 0ustar www-datawww-data# Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'date' require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module ServicecontrolV1 # class AllocateInfo include Google::Apis::Core::Hashable # A list of label keys that were unused by the server in processing the # request. Thus, for similar requests repeated in a certain future time # window, the caller can choose to ignore these labels in the requests # to achieve better client-side cache hits and quota aggregation. # Corresponds to the JSON property `unusedArguments` # @return [Array] attr_accessor :unused_arguments def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @unused_arguments = args[:unused_arguments] if args.key?(:unused_arguments) end end # Request message for the AllocateQuota method. class AllocateQuotaRequest include Google::Apis::Core::Hashable # Represents information regarding a quota operation. # Corresponds to the JSON property `allocateOperation` # @return [Google::Apis::ServicecontrolV1::QuotaOperation] attr_accessor :allocate_operation # Specifies which version of service configuration should be used to process # the request. If unspecified or no matching version can be found, the latest # one will be used. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allocate_operation = args[:allocate_operation] if args.key?(:allocate_operation) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) end end # Response message for the AllocateQuota method. class AllocateQuotaResponse include Google::Apis::Core::Hashable # Indicates the decision of the allocate. # Corresponds to the JSON property `allocateErrors` # @return [Array] attr_accessor :allocate_errors # WARNING: DO NOT use this field until this warning message is removed. # Corresponds to the JSON property `allocateInfo` # @return [Google::Apis::ServicecontrolV1::AllocateInfo] attr_accessor :allocate_info # The same operation_id value used in the AllocateQuotaRequest. Used for # logging and diagnostics purposes. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # Quota metrics to indicate the result of allocation. Depending on the # request, one or more of the following metrics will be included: # 1. Per quota group or per quota metric incremental usage will be specified # using the following delta metric : # "serviceruntime.googleapis.com/api/consumer/quota_used_count" # 2. The quota limit reached condition will be specified using the following # boolean metric : # "serviceruntime.googleapis.com/quota/exceeded" # Corresponds to the JSON property `quotaMetrics` # @return [Array] attr_accessor :quota_metrics # ID of the actual config used to process the request. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allocate_errors = args[:allocate_errors] if args.key?(:allocate_errors) @allocate_info = args[:allocate_info] if args.key?(:allocate_info) @operation_id = args[:operation_id] if args.key?(:operation_id) @quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) end end # Common audit log format for Google Cloud Platform API operations. class AuditLog include Google::Apis::Core::Hashable # Authentication information for the operation. # Corresponds to the JSON property `authenticationInfo` # @return [Google::Apis::ServicecontrolV1::AuthenticationInfo] attr_accessor :authentication_info # Authorization information. If there are multiple # resources or permissions involved, then there is # one AuthorizationInfo element for each `resource, permission` tuple. # Corresponds to the JSON property `authorizationInfo` # @return [Array] attr_accessor :authorization_info # Other service-specific data about the request, response, and other # information associated with the current audited event. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The name of the service method or operation. # For API calls, this should be the name of the API method. # For example, # "google.datastore.v1.Datastore.RunQuery" # "google.logging.v1.LoggingService.DeleteLog" # Corresponds to the JSON property `methodName` # @return [String] attr_accessor :method_name # The number of items returned from a List or Query API method, # if applicable. # Corresponds to the JSON property `numResponseItems` # @return [Fixnum] attr_accessor :num_response_items # The operation request. This may not include all request parameters, # such as those that are too large, privacy-sensitive, or duplicated # elsewhere in the log record. # It should never include user-generated data, such as file contents. # When the JSON object represented here has a proto equivalent, the proto # name will be indicated in the `@type` property. # Corresponds to the JSON property `request` # @return [Hash] attr_accessor :request # Metadata about the request. # Corresponds to the JSON property `requestMetadata` # @return [Google::Apis::ServicecontrolV1::RequestMetadata] attr_accessor :request_metadata # The resource or collection that is the target of the operation. # The name is a scheme-less URI, not including the API service name. # For example: # "shelves/SHELF_ID/books" # "shelves/SHELF_ID/books/BOOK_ID" # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name # The operation response. This may not include all response elements, # such as those that are too large, privacy-sensitive, or duplicated # elsewhere in the log record. # It should never include user-generated data, such as file contents. # When the JSON object represented here has a proto equivalent, the proto # name will be indicated in the `@type` property. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response # Deprecated, use `metadata` field instead. # Other service-specific data about the request, response, and other # activities. # Corresponds to the JSON property `serviceData` # @return [Hash] attr_accessor :service_data # The name of the API service performing the operation. For example, # `"datastore.googleapis.com"`. # Corresponds to the JSON property `serviceName` # @return [String] attr_accessor :service_name # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `status` # @return [Google::Apis::ServicecontrolV1::Status] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @authentication_info = args[:authentication_info] if args.key?(:authentication_info) @authorization_info = args[:authorization_info] if args.key?(:authorization_info) @metadata = args[:metadata] if args.key?(:metadata) @method_name = args[:method_name] if args.key?(:method_name) @num_response_items = args[:num_response_items] if args.key?(:num_response_items) @request = args[:request] if args.key?(:request) @request_metadata = args[:request_metadata] if args.key?(:request_metadata) @resource_name = args[:resource_name] if args.key?(:resource_name) @response = args[:response] if args.key?(:response) @service_data = args[:service_data] if args.key?(:service_data) @service_name = args[:service_name] if args.key?(:service_name) @status = args[:status] if args.key?(:status) end end # Authentication information for the operation. class AuthenticationInfo include Google::Apis::Core::Hashable # The authority selector specified by the requestor, if any. # It is not guaranteed that the principal was allowed to use this authority. # Corresponds to the JSON property `authoritySelector` # @return [String] attr_accessor :authority_selector # The email address of the authenticated user (or service account on behalf # of third party principal) making the request. For privacy reasons, the # principal email address is redacted for all read-only operations that fail # with a "permission denied" error. # Corresponds to the JSON property `principalEmail` # @return [String] attr_accessor :principal_email # The third party identification (if any) of the authenticated user making # the request. # When the JSON object represented here has a proto equivalent, the proto # name will be indicated in the `@type` property. # Corresponds to the JSON property `thirdPartyPrincipal` # @return [Hash] attr_accessor :third_party_principal def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @authority_selector = args[:authority_selector] if args.key?(:authority_selector) @principal_email = args[:principal_email] if args.key?(:principal_email) @third_party_principal = args[:third_party_principal] if args.key?(:third_party_principal) end end # Authorization information for the operation. class AuthorizationInfo include Google::Apis::Core::Hashable # Whether or not authorization for `resource` and `permission` # was granted. # Corresponds to the JSON property `granted` # @return [Boolean] attr_accessor :granted alias_method :granted?, :granted # The required IAM permission. # Corresponds to the JSON property `permission` # @return [String] attr_accessor :permission # The resource being accessed, as a REST-style string. For example: # bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @granted = args[:granted] if args.key?(:granted) @permission = args[:permission] if args.key?(:permission) @resource = args[:resource] if args.key?(:resource) end end # Defines the errors to be returned in # google.api.servicecontrol.v1.CheckResponse.check_errors. class CheckError include Google::Apis::Core::Hashable # The error code. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # Free-form text providing details on the error cause of the error. # Corresponds to the JSON property `detail` # @return [String] attr_accessor :detail # Subject to whom this error applies. See the specific code enum for more # details on this field. For example: # - “project:” # - “folder:” # - “organization:” # Corresponds to the JSON property `subject` # @return [String] attr_accessor :subject def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @code = args[:code] if args.key?(:code) @detail = args[:detail] if args.key?(:detail) @subject = args[:subject] if args.key?(:subject) end end # Contains additional information about the check operation. class CheckInfo include Google::Apis::Core::Hashable # `ConsumerInfo` provides information about the consumer project. # Corresponds to the JSON property `consumerInfo` # @return [Google::Apis::ServicecontrolV1::ConsumerInfo] attr_accessor :consumer_info # A list of fields and label keys that are ignored by the server. # The client doesn't need to send them for following requests to improve # performance and allow better aggregation. # Corresponds to the JSON property `unusedArguments` # @return [Array] attr_accessor :unused_arguments def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @consumer_info = args[:consumer_info] if args.key?(:consumer_info) @unused_arguments = args[:unused_arguments] if args.key?(:unused_arguments) end end # Request message for the Check method. class CheckRequest include Google::Apis::Core::Hashable # Represents information regarding an operation. # Corresponds to the JSON property `operation` # @return [Google::Apis::ServicecontrolV1::Operation] attr_accessor :operation # Requests the project settings to be returned as part of the check response. # Corresponds to the JSON property `requestProjectSettings` # @return [Boolean] attr_accessor :request_project_settings alias_method :request_project_settings?, :request_project_settings # Specifies which version of service configuration should be used to process # the request. # If unspecified or no matching version can be found, the # latest one will be used. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id # Indicates if service activation check should be skipped for this request. # Default behavior is to perform the check and apply relevant quota. # Corresponds to the JSON property `skipActivationCheck` # @return [Boolean] attr_accessor :skip_activation_check alias_method :skip_activation_check?, :skip_activation_check def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @operation = args[:operation] if args.key?(:operation) @request_project_settings = args[:request_project_settings] if args.key?(:request_project_settings) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) @skip_activation_check = args[:skip_activation_check] if args.key?(:skip_activation_check) end end # Response message for the Check method. class CheckResponse include Google::Apis::Core::Hashable # Indicate the decision of the check. # If no check errors are present, the service should process the operation. # Otherwise the service should use the list of errors to determine the # appropriate action. # Corresponds to the JSON property `checkErrors` # @return [Array] attr_accessor :check_errors # Contains additional information about the check operation. # Corresponds to the JSON property `checkInfo` # @return [Google::Apis::ServicecontrolV1::CheckInfo] attr_accessor :check_info # The same operation_id value used in the CheckRequest. # Used for logging and diagnostics purposes. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # Contains the quota information for a quota check response. # Corresponds to the JSON property `quotaInfo` # @return [Google::Apis::ServicecontrolV1::QuotaInfo] attr_accessor :quota_info # The actual config id used to process the request. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @check_errors = args[:check_errors] if args.key?(:check_errors) @check_info = args[:check_info] if args.key?(:check_info) @operation_id = args[:operation_id] if args.key?(:operation_id) @quota_info = args[:quota_info] if args.key?(:quota_info) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) end end # `ConsumerInfo` provides information about the consumer project. class ConsumerInfo include Google::Apis::Core::Hashable # The Google cloud project number, e.g. 1234567890. A value of 0 indicates # no project number is found. # Corresponds to the JSON property `projectNumber` # @return [Fixnum] attr_accessor :project_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @project_number = args[:project_number] if args.key?(:project_number) end end # Distribution represents a frequency distribution of double-valued sample # points. It contains the size of the population of sample points plus # additional optional information: # - the arithmetic mean of the samples # - the minimum and maximum of the samples # - the sum-squared-deviation of the samples, used to compute variance # - a histogram of the values of the sample points class Distribution include Google::Apis::Core::Hashable # The number of samples in each histogram bucket. `bucket_counts` are # optional. If present, they must sum to the `count` value. # The buckets are defined below in `bucket_option`. There are N buckets. # `bucket_counts[0]` is the number of samples in the underflow bucket. # `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples # in each of the finite buckets. And `bucket_counts[N] is the number # of samples in the overflow bucket. See the comments of `bucket_option` # below for more details. # Any suffix of trailing zeros may be omitted. # Corresponds to the JSON property `bucketCounts` # @return [Array] attr_accessor :bucket_counts # The total number of samples in the distribution. Must be >= 0. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # Describing buckets with arbitrary user-provided width. # Corresponds to the JSON property `explicitBuckets` # @return [Google::Apis::ServicecontrolV1::ExplicitBuckets] attr_accessor :explicit_buckets # Describing buckets with exponentially growing width. # Corresponds to the JSON property `exponentialBuckets` # @return [Google::Apis::ServicecontrolV1::ExponentialBuckets] attr_accessor :exponential_buckets # Describing buckets with constant width. # Corresponds to the JSON property `linearBuckets` # @return [Google::Apis::ServicecontrolV1::LinearBuckets] attr_accessor :linear_buckets # The maximum of the population of values. Ignored if `count` is zero. # Corresponds to the JSON property `maximum` # @return [Float] attr_accessor :maximum # The arithmetic mean of the samples in the distribution. If `count` is # zero then this field must be zero. # Corresponds to the JSON property `mean` # @return [Float] attr_accessor :mean # The minimum of the population of values. Ignored if `count` is zero. # Corresponds to the JSON property `minimum` # @return [Float] attr_accessor :minimum # The sum of squared deviations from the mean: # Sum[i=1..count]((x_i - mean)^2) # where each x_i is a sample values. If `count` is zero then this field # must be zero, otherwise validation of the request fails. # Corresponds to the JSON property `sumOfSquaredDeviation` # @return [Float] attr_accessor :sum_of_squared_deviation def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_counts = args[:bucket_counts] if args.key?(:bucket_counts) @count = args[:count] if args.key?(:count) @explicit_buckets = args[:explicit_buckets] if args.key?(:explicit_buckets) @exponential_buckets = args[:exponential_buckets] if args.key?(:exponential_buckets) @linear_buckets = args[:linear_buckets] if args.key?(:linear_buckets) @maximum = args[:maximum] if args.key?(:maximum) @mean = args[:mean] if args.key?(:mean) @minimum = args[:minimum] if args.key?(:minimum) @sum_of_squared_deviation = args[:sum_of_squared_deviation] if args.key?(:sum_of_squared_deviation) end end # Request message for QuotaController.EndReconciliation. class EndReconciliationRequest include Google::Apis::Core::Hashable # Represents information regarding a quota operation. # Corresponds to the JSON property `reconciliationOperation` # @return [Google::Apis::ServicecontrolV1::QuotaOperation] attr_accessor :reconciliation_operation # Specifies which version of service configuration should be used to process # the request. If unspecified or no matching version can be found, the latest # one will be used. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @reconciliation_operation = args[:reconciliation_operation] if args.key?(:reconciliation_operation) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) end end # Response message for QuotaController.EndReconciliation. class EndReconciliationResponse include Google::Apis::Core::Hashable # The same operation_id value used in the EndReconciliationRequest. Used for # logging and diagnostics purposes. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # Metric values as tracked by One Platform before the adjustment was made. # The following metrics will be included: # 1. Per quota metric total usage will be specified using the following gauge # metric: # "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" # 2. Value for each quota limit associated with the metrics will be specified # using the following gauge metric: # "serviceruntime.googleapis.com/quota/limit" # 3. Delta value of the usage after the reconciliation for limits associated # with the metrics will be specified using the following metric: # "serviceruntime.googleapis.com/allocation/reconciliation_delta" # The delta value is defined as: # new_usage_from_client - existing_value_in_spanner. # This metric is not defined in serviceruntime.yaml or in Cloud Monarch. # This metric is meant for callers' use only. Since this metric is not # defined in the monitoring backend, reporting on this metric will result in # an error. # Corresponds to the JSON property `quotaMetrics` # @return [Array] attr_accessor :quota_metrics # Indicates the decision of the reconciliation end. # Corresponds to the JSON property `reconciliationErrors` # @return [Array] attr_accessor :reconciliation_errors # ID of the actual config used to process the request. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @operation_id = args[:operation_id] if args.key?(:operation_id) @quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics) @reconciliation_errors = args[:reconciliation_errors] if args.key?(:reconciliation_errors) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) end end # Describing buckets with arbitrary user-provided width. class ExplicitBuckets include Google::Apis::Core::Hashable # 'bound' is a list of strictly increasing boundaries between # buckets. Note that a list of length N-1 defines N buckets because # of fenceposting. See comments on `bucket_options` for details. # The i'th finite bucket covers the interval # [bound[i-1], bound[i]) # where i ranges from 1 to bound_size() - 1. Note that there are no # finite buckets at all if 'bound' only contains a single element; in # that special case the single bound defines the boundary between the # underflow and overflow buckets. # bucket number lower bound upper bound # i == 0 (underflow) -inf bound[i] # 0 < i < bound_size() bound[i-1] bound[i] # i == bound_size() (overflow) bound[i-1] +inf # Corresponds to the JSON property `bounds` # @return [Array] attr_accessor :bounds def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bounds = args[:bounds] if args.key?(:bounds) end end # Describing buckets with exponentially growing width. class ExponentialBuckets include Google::Apis::Core::Hashable # The i'th exponential bucket covers the interval # [scale * growth_factor^(i-1), scale * growth_factor^i) # where i ranges from 1 to num_finite_buckets inclusive. # Must be larger than 1.0. # Corresponds to the JSON property `growthFactor` # @return [Float] attr_accessor :growth_factor # The number of finite buckets. With the underflow and overflow buckets, # the total number of buckets is `num_finite_buckets` + 2. # See comments on `bucket_options` for details. # Corresponds to the JSON property `numFiniteBuckets` # @return [Fixnum] attr_accessor :num_finite_buckets # The i'th exponential bucket covers the interval # [scale * growth_factor^(i-1), scale * growth_factor^i) # where i ranges from 1 to num_finite_buckets inclusive. # Must be > 0. # Corresponds to the JSON property `scale` # @return [Float] attr_accessor :scale def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @growth_factor = args[:growth_factor] if args.key?(:growth_factor) @num_finite_buckets = args[:num_finite_buckets] if args.key?(:num_finite_buckets) @scale = args[:scale] if args.key?(:scale) end end # Describing buckets with constant width. class LinearBuckets include Google::Apis::Core::Hashable # The number of finite buckets. With the underflow and overflow buckets, # the total number of buckets is `num_finite_buckets` + 2. # See comments on `bucket_options` for details. # Corresponds to the JSON property `numFiniteBuckets` # @return [Fixnum] attr_accessor :num_finite_buckets # The i'th linear bucket covers the interval # [offset + (i-1) * width, offset + i * width) # where i ranges from 1 to num_finite_buckets, inclusive. # Corresponds to the JSON property `offset` # @return [Float] attr_accessor :offset # The i'th linear bucket covers the interval # [offset + (i-1) * width, offset + i * width) # where i ranges from 1 to num_finite_buckets, inclusive. # Must be strictly positive. # Corresponds to the JSON property `width` # @return [Float] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @num_finite_buckets = args[:num_finite_buckets] if args.key?(:num_finite_buckets) @offset = args[:offset] if args.key?(:offset) @width = args[:width] if args.key?(:width) end end # An individual log entry. class LogEntry include Google::Apis::Core::Hashable # A unique ID for the log entry used for deduplication. If omitted, # the implementation will generate one based on operation_id. # Corresponds to the JSON property `insertId` # @return [String] attr_accessor :insert_id # A set of user-defined (key, value) data that provides additional # information about the log entry. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Required. The log to which this log entry belongs. Examples: `"syslog"`, # `"book_log"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The log entry payload, represented as a protocol buffer that is # expressed as a JSON object. The only accepted type currently is # AuditLog. # Corresponds to the JSON property `protoPayload` # @return [Hash] attr_accessor :proto_payload # The severity of the log entry. The default value is # `LogSeverity.DEFAULT`. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity # The log entry payload, represented as a structure that # is expressed as a JSON object. # Corresponds to the JSON property `structPayload` # @return [Hash] attr_accessor :struct_payload # The log entry payload, represented as a Unicode string (UTF-8). # Corresponds to the JSON property `textPayload` # @return [String] attr_accessor :text_payload # The time the event described by the log entry occurred. If # omitted, defaults to operation start time. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @insert_id = args[:insert_id] if args.key?(:insert_id) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @proto_payload = args[:proto_payload] if args.key?(:proto_payload) @severity = args[:severity] if args.key?(:severity) @struct_payload = args[:struct_payload] if args.key?(:struct_payload) @text_payload = args[:text_payload] if args.key?(:text_payload) @timestamp = args[:timestamp] if args.key?(:timestamp) end end # Represents a single metric value. class MetricValue include Google::Apis::Core::Hashable # A boolean value. # Corresponds to the JSON property `boolValue` # @return [Boolean] attr_accessor :bool_value alias_method :bool_value?, :bool_value # Distribution represents a frequency distribution of double-valued sample # points. It contains the size of the population of sample points plus # additional optional information: # - the arithmetic mean of the samples # - the minimum and maximum of the samples # - the sum-squared-deviation of the samples, used to compute variance # - a histogram of the values of the sample points # Corresponds to the JSON property `distributionValue` # @return [Google::Apis::ServicecontrolV1::Distribution] attr_accessor :distribution_value # A double precision floating point value. # Corresponds to the JSON property `doubleValue` # @return [Float] attr_accessor :double_value # The end of the time period over which this metric value's measurement # applies. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # A signed 64-bit integer value. # Corresponds to the JSON property `int64Value` # @return [Fixnum] attr_accessor :int64_value # The labels describing the metric value. # See comments on google.api.servicecontrol.v1.Operation.labels for # the overriding relationship. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Represents an amount of money with its currency type. # Corresponds to the JSON property `moneyValue` # @return [Google::Apis::ServicecontrolV1::Money] attr_accessor :money_value # The start of the time period over which this metric value's measurement # applies. The time period has different semantics for different metric # types (cumulative, delta, and gauge). See the metric definition # documentation in the service configuration for details. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # A text 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) @distribution_value = args[:distribution_value] if args.key?(:distribution_value) @double_value = args[:double_value] if args.key?(:double_value) @end_time = args[:end_time] if args.key?(:end_time) @int64_value = args[:int64_value] if args.key?(:int64_value) @labels = args[:labels] if args.key?(:labels) @money_value = args[:money_value] if args.key?(:money_value) @start_time = args[:start_time] if args.key?(:start_time) @string_value = args[:string_value] if args.key?(:string_value) end end # Represents a set of metric values in the same metric. # Each metric value in the set should have a unique combination of start time, # end time, and label values. class MetricValueSet include Google::Apis::Core::Hashable # The metric name defined in the service configuration. # Corresponds to the JSON property `metricName` # @return [String] attr_accessor :metric_name # The values in this metric. # Corresponds to the JSON property `metricValues` # @return [Array] attr_accessor :metric_values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @metric_name = args[:metric_name] if args.key?(:metric_name) @metric_values = args[:metric_values] if args.key?(:metric_values) 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 # Represents information regarding an operation. class Operation include Google::Apis::Core::Hashable # Identity of the consumer who is using the service. # This field should be filled in for the operations initiated by a # consumer, but not for service-initiated operations that are # not related to a specific consumer. # This can be in one of the following formats: # project:, # project_number:, # api_key:. # Corresponds to the JSON property `consumerId` # @return [String] attr_accessor :consumer_id # End time of the operation. # Required when the operation is used in ServiceController.Report, # but optional when the operation is used in ServiceController.Check. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # DO NOT USE. This is an experimental field. # Corresponds to the JSON property `importance` # @return [String] attr_accessor :importance # Labels describing the operation. Only the following labels are allowed: # - Labels describing monitored resources as defined in # the service configuration. # - Default labels of metric values. When specified, labels defined in the # metric value override these default. # - The following labels defined by Google Cloud Platform: # - `cloud.googleapis.com/location` describing the location where the # operation happened, # - `servicecontrol.googleapis.com/user_agent` describing the user agent # of the API request, # - `servicecontrol.googleapis.com/service_agent` describing the service # used to handle the API request (e.g. ESP), # - `servicecontrol.googleapis.com/platform` describing the platform # where the API is served (e.g. GAE, GCE, GKE). # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Represents information to be logged. # Corresponds to the JSON property `logEntries` # @return [Array] attr_accessor :log_entries # Represents information about this operation. Each MetricValueSet # corresponds to a metric defined in the service configuration. # The data type used in the MetricValueSet must agree with # the data type specified in the metric definition. # Within a single operation, it is not allowed to have more than one # MetricValue instances that have the same metric names and identical # label value combinations. If a request has such duplicated MetricValue # instances, the entire request is rejected with # an invalid argument error. # Corresponds to the JSON property `metricValueSets` # @return [Array] attr_accessor :metric_value_sets # Identity of the operation. This must be unique within the scope of the # service that generated the operation. If the service calls # Check() and Report() on the same operation, the two calls should carry # the same id. # UUID version 4 is recommended, though not required. # In scenarios where an operation is computed from existing information # and an idempotent id is desirable for deduplication purpose, UUID version 5 # is recommended. See RFC 4122 for details. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # Fully qualified name of the operation. Reserved for future use. # Corresponds to the JSON property `operationName` # @return [String] attr_accessor :operation_name # Represents the properties needed for quota operations. # Corresponds to the JSON property `quotaProperties` # @return [Google::Apis::ServicecontrolV1::QuotaProperties] attr_accessor :quota_properties # DO NOT USE. This field is deprecated, use "resources" field instead. # The resource name of the parent of a resource in the resource hierarchy. # This can be in one of the following formats: # - “projects/” # - “folders/” # - “organizations/” # Corresponds to the JSON property `resourceContainer` # @return [String] attr_accessor :resource_container # The resources that are involved in the operation. # Corresponds to the JSON property `resources` # @return [Array] attr_accessor :resources # Required. Start time of the operation. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # User defined labels for the resource that this operation is associated # with. Only a combination of 1000 user labels per consumer project are # allowed. # Corresponds to the JSON property `userLabels` # @return [Hash] attr_accessor :user_labels def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @consumer_id = args[:consumer_id] if args.key?(:consumer_id) @end_time = args[:end_time] if args.key?(:end_time) @importance = args[:importance] if args.key?(:importance) @labels = args[:labels] if args.key?(:labels) @log_entries = args[:log_entries] if args.key?(:log_entries) @metric_value_sets = args[:metric_value_sets] if args.key?(:metric_value_sets) @operation_id = args[:operation_id] if args.key?(:operation_id) @operation_name = args[:operation_name] if args.key?(:operation_name) @quota_properties = args[:quota_properties] if args.key?(:quota_properties) @resource_container = args[:resource_container] if args.key?(:resource_container) @resources = args[:resources] if args.key?(:resources) @start_time = args[:start_time] if args.key?(:start_time) @user_labels = args[:user_labels] if args.key?(:user_labels) end end # Represents error information for QuotaOperation. class QuotaError include Google::Apis::Core::Hashable # Error code. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # Free-form text that provides details on the cause of the error. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Subject to whom this error applies. See the specific enum for more details # on this field. For example, "clientip:" or # "project:". # Corresponds to the JSON property `subject` # @return [String] attr_accessor :subject def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @code = args[:code] if args.key?(:code) @description = args[:description] if args.key?(:description) @subject = args[:subject] if args.key?(:subject) end end # Contains the quota information for a quota check response. class QuotaInfo include Google::Apis::Core::Hashable # Quota Metrics that have exceeded quota limits. # For QuotaGroup-based quota, this is QuotaGroup.name # For QuotaLimit-based quota, this is QuotaLimit.name # See: google.api.Quota # Deprecated: Use quota_metrics to get per quota group limit exceeded status. # Corresponds to the JSON property `limitExceeded` # @return [Array] attr_accessor :limit_exceeded # Map of quota group name to the actual number of tokens consumed. If the # quota check was not successful, then this will not be populated due to no # quota consumption. # We are not merging this field with 'quota_metrics' field because of the # complexity of scaling in Chemist client code base. For simplicity, we will # keep this field for Castor (that scales quota usage) and 'quota_metrics' # for SuperQuota (that doesn't scale quota usage). # Corresponds to the JSON property `quotaConsumed` # @return [Hash] attr_accessor :quota_consumed # Quota metrics to indicate the usage. Depending on the check request, one or # more of the following metrics will be included: # 1. For rate quota, per quota group or per quota metric incremental usage # will be specified using the following delta metric: # "serviceruntime.googleapis.com/api/consumer/quota_used_count" # 2. For allocation quota, per quota metric total usage will be specified # using the following gauge metric: # "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" # 3. For both rate quota and allocation quota, the quota limit reached # condition will be specified using the following boolean metric: # "serviceruntime.googleapis.com/quota/exceeded" # Corresponds to the JSON property `quotaMetrics` # @return [Array] attr_accessor :quota_metrics def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @limit_exceeded = args[:limit_exceeded] if args.key?(:limit_exceeded) @quota_consumed = args[:quota_consumed] if args.key?(:quota_consumed) @quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics) end end # Represents information regarding a quota operation. class QuotaOperation include Google::Apis::Core::Hashable # Identity of the consumer for whom this quota operation is being performed. # This can be in one of the following formats: # project:, # project_number:, # api_key:. # Corresponds to the JSON property `consumerId` # @return [String] attr_accessor :consumer_id # Labels describing the operation. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Fully qualified name of the API method for which this quota operation is # requested. This name is used for matching quota rules or metric rules and # billing status rules defined in service configuration. # This field should not be set if any of the following is true: # (1) the quota operation is performed on non-API resources. # (2) quota_metrics is set because the caller is doing quota override. # Example of an RPC method name: # google.example.library.v1.LibraryService.CreateShelf # Corresponds to the JSON property `methodName` # @return [String] attr_accessor :method_name # Identity of the operation. This is expected to be unique within the scope # of the service that generated the operation, and guarantees idempotency in # case of retries. # UUID version 4 is recommended, though not required. In scenarios where an # operation is computed from existing information and an idempotent id is # desirable for deduplication purpose, UUID version 5 is recommended. See # RFC 4122 for details. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # Represents information about this operation. Each MetricValueSet # corresponds to a metric defined in the service configuration. # The data type used in the MetricValueSet must agree with # the data type specified in the metric definition. # Within a single operation, it is not allowed to have more than one # MetricValue instances that have the same metric names and identical # label value combinations. If a request has such duplicated MetricValue # instances, the entire request is rejected with # an invalid argument error. # This field is mutually exclusive with method_name. # Corresponds to the JSON property `quotaMetrics` # @return [Array] attr_accessor :quota_metrics # Quota mode for this operation. # Corresponds to the JSON property `quotaMode` # @return [String] attr_accessor :quota_mode def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @consumer_id = args[:consumer_id] if args.key?(:consumer_id) @labels = args[:labels] if args.key?(:labels) @method_name = args[:method_name] if args.key?(:method_name) @operation_id = args[:operation_id] if args.key?(:operation_id) @quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics) @quota_mode = args[:quota_mode] if args.key?(:quota_mode) end end # Represents the properties needed for quota operations. class QuotaProperties include Google::Apis::Core::Hashable # Quota mode for this operation. # Corresponds to the JSON property `quotaMode` # @return [String] attr_accessor :quota_mode def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @quota_mode = args[:quota_mode] if args.key?(:quota_mode) end end # Request message for the ReleaseQuota method. class ReleaseQuotaRequest include Google::Apis::Core::Hashable # Represents information regarding a quota operation. # Corresponds to the JSON property `releaseOperation` # @return [Google::Apis::ServicecontrolV1::QuotaOperation] attr_accessor :release_operation # Specifies which version of service configuration should be used to process # the request. If unspecified or no matching version can be found, the latest # one will be used. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @release_operation = args[:release_operation] if args.key?(:release_operation) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) end end # Response message for the ReleaseQuota method. class ReleaseQuotaResponse include Google::Apis::Core::Hashable # The same operation_id value used in the ReleaseQuotaRequest. Used for # logging and diagnostics purposes. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # Quota metrics to indicate the result of release. Depending on the # request, one or more of the following metrics will be included: # 1. For rate quota, per quota group or per quota metric released amount # will be specified using the following delta metric: # "serviceruntime.googleapis.com/api/consumer/quota_refund_count" # 2. For allocation quota, per quota metric total usage will be specified # using the following gauge metric: # "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" # 3. For allocation quota, value for each quota limit associated with # the metrics will be specified using the following gauge metric: # "serviceruntime.googleapis.com/quota/limit" # Corresponds to the JSON property `quotaMetrics` # @return [Array] attr_accessor :quota_metrics # Indicates the decision of the release. # Corresponds to the JSON property `releaseErrors` # @return [Array] attr_accessor :release_errors # ID of the actual config used to process the request. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @operation_id = args[:operation_id] if args.key?(:operation_id) @quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics) @release_errors = args[:release_errors] if args.key?(:release_errors) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) end end # Represents the processing error of one Operation in the request. class ReportError include Google::Apis::Core::Hashable # The Operation.operation_id value from the request. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `status` # @return [Google::Apis::ServicecontrolV1::Status] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @operation_id = args[:operation_id] if args.key?(:operation_id) @status = args[:status] if args.key?(:status) end end # Contains additional info about the report operation. class ReportInfo include Google::Apis::Core::Hashable # The Operation.operation_id value from the request. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # Contains the quota information for a quota check response. # Corresponds to the JSON property `quotaInfo` # @return [Google::Apis::ServicecontrolV1::QuotaInfo] attr_accessor :quota_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @operation_id = args[:operation_id] if args.key?(:operation_id) @quota_info = args[:quota_info] if args.key?(:quota_info) end end # Request message for the Report method. class ReportRequest include Google::Apis::Core::Hashable # Operations to be reported. # Typically the service should report one operation per request. # Putting multiple operations into a single request is allowed, but should # be used only when multiple operations are natually available at the time # of the report. # If multiple operations are in a single request, the total request size # should be no larger than 1MB. See ReportResponse.report_errors for # partial failure behavior. # Corresponds to the JSON property `operations` # @return [Array] attr_accessor :operations # Specifies which version of service config should be used to process the # request. # If unspecified or no matching version can be found, the # latest one will be used. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @operations = args[:operations] if args.key?(:operations) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) end end # Response message for the Report method. class ReportResponse include Google::Apis::Core::Hashable # Partial failures, one for each `Operation` in the request that failed # processing. There are three possible combinations of the RPC status: # 1. The combination of a successful RPC status and an empty `report_errors` # list indicates a complete success where all `Operations` in the # request are processed successfully. # 2. The combination of a successful RPC status and a non-empty # `report_errors` list indicates a partial success where some # `Operations` in the request succeeded. Each # `Operation` that failed processing has a corresponding item # in this list. # 3. A failed RPC status indicates a general non-deterministic failure. # When this happens, it's impossible to know which of the # 'Operations' in the request succeeded or failed. # Corresponds to the JSON property `reportErrors` # @return [Array] attr_accessor :report_errors # Quota usage for each quota release `Operation` request. # Fully or partially failed quota release request may or may not be present # in `report_quota_info`. For example, a failed quota release request will # have the current quota usage info when precise quota library returns the # info. A deadline exceeded quota request will not have quota usage info. # If there is no quota release request, report_quota_info will be empty. # Corresponds to the JSON property `reportInfos` # @return [Array] attr_accessor :report_infos # The actual config id used to process the request. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @report_errors = args[:report_errors] if args.key?(:report_errors) @report_infos = args[:report_infos] if args.key?(:report_infos) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) end end # Metadata about the request. class RequestMetadata include Google::Apis::Core::Hashable # The IP address of the caller. # For caller from internet, this will be public IPv4 or IPv6 address. # For caller from a Compute Engine VM with external IP address, this # will be the VM's external IP address. For caller from a Compute # Engine VM without external IP address, if the VM is in the same # organization (or project) as the accessed resource, `caller_ip` will # be the VM's internal IPv4 address, otherwise the `caller_ip` will be # redacted to "gce-internal-ip". # See https://cloud.google.com/compute/docs/vpc/ for more information. # Corresponds to the JSON property `callerIp` # @return [String] attr_accessor :caller_ip # The network of the caller. # Set only if the network host project is part of the same GCP organization # (or project) as the accessed resource. # See https://cloud.google.com/compute/docs/vpc/ for more information. # This is a scheme-less URI full resource name. For example: # "//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID" # Corresponds to the JSON property `callerNetwork` # @return [String] attr_accessor :caller_network # The user agent of the caller. # This information is not authenticated and should be treated accordingly. # For example: # + `google-api-python-client/1.4.0`: # The request was made by the Google API client for Python. # + `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`: # The request was made by the Google Cloud SDK CLI (gcloud). # + `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project` # : # The request was made from the `my-project` App Engine app. # NOLINT # Corresponds to the JSON property `callerSuppliedUserAgent` # @return [String] attr_accessor :caller_supplied_user_agent def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @caller_ip = args[:caller_ip] if args.key?(:caller_ip) @caller_network = args[:caller_network] if args.key?(:caller_network) @caller_supplied_user_agent = args[:caller_supplied_user_agent] if args.key?(:caller_supplied_user_agent) end end # Describes a resource associated with this operation. class ResourceInfo include Google::Apis::Core::Hashable # The identifier of the parent of this resource instance. # Must be in one of the following formats: # - “projects/” # - “folders/” # - “organizations/” # Corresponds to the JSON property `resourceContainer` # @return [String] attr_accessor :resource_container # Name of the resource. This is used for auditing purposes. # 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_container = args[:resource_container] if args.key?(:resource_container) @resource_name = args[:resource_name] if args.key?(:resource_name) end end # Request message for QuotaController.StartReconciliation. class StartReconciliationRequest include Google::Apis::Core::Hashable # Represents information regarding a quota operation. # Corresponds to the JSON property `reconciliationOperation` # @return [Google::Apis::ServicecontrolV1::QuotaOperation] attr_accessor :reconciliation_operation # Specifies which version of service configuration should be used to process # the request. If unspecified or no matching version can be found, the latest # one will be used. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @reconciliation_operation = args[:reconciliation_operation] if args.key?(:reconciliation_operation) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) end end # Response message for QuotaController.StartReconciliation. class StartReconciliationResponse include Google::Apis::Core::Hashable # The same operation_id value used in the StartReconciliationRequest. Used # for logging and diagnostics purposes. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # Metric values as tracked by One Platform before the start of # reconciliation. The following metrics will be included: # 1. Per quota metric total usage will be specified using the following gauge # metric: # "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" # 2. Value for each quota limit associated with the metrics will be specified # using the following gauge metric: # "serviceruntime.googleapis.com/quota/limit" # Corresponds to the JSON property `quotaMetrics` # @return [Array] attr_accessor :quota_metrics # Indicates the decision of the reconciliation start. # Corresponds to the JSON property `reconciliationErrors` # @return [Array] attr_accessor :reconciliation_errors # ID of the actual config used to process the request. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @operation_id = args[:operation_id] if args.key?(:operation_id) @quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics) @reconciliation_errors = args[:reconciliation_errors] if args.key?(:reconciliation_errors) @service_config_id = args[:service_config_id] if args.key?(:service_config_id) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 google-api-client-0.19.8/generated/google/apis/servicecontrol_v1/service.rb0000644000004100000410000005037513252673044026762 0ustar www-datawww-data# 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 ServicecontrolV1 # Google Service Control API # # Google Service Control provides control plane functionality to managed # services, such as logging, monitoring, and status checks. # # @example # require 'google/apis/servicecontrol_v1' # # Servicecontrol = Google::Apis::ServicecontrolV1 # Alias the module # service = Servicecontrol::ServiceControlService.new # # @see https://cloud.google.com/service-control/ class ServiceControlService < 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://servicecontrol.googleapis.com/', '') @batch_path = 'batch' end # Attempts to allocate quota for the specified consumer. It should be called # before the operation is executed. # This method requires the `servicemanagement.services.quota` # permission on the specified service. For more information, see # [Cloud IAM](https://cloud.google.com/iam). # **NOTE:** The client **must** fail-open on server errors `INTERNAL`, # `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system # reliability, the server may inject these errors to prohibit any hard # dependency on the quota functionality. # @param [String] service_name # Name of the service as specified in the service configuration. For example, # `"pubsub.googleapis.com"`. # See google.api.Service for the definition of a service name. # @param [Google::Apis::ServicecontrolV1::AllocateQuotaRequest] allocate_quota_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::ServicecontrolV1::AllocateQuotaResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServicecontrolV1::AllocateQuotaResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def allocate_service_quota(service_name, allocate_quota_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/services/{serviceName}:allocateQuota', options) command.request_representation = Google::Apis::ServicecontrolV1::AllocateQuotaRequest::Representation command.request_object = allocate_quota_request_object command.response_representation = Google::Apis::ServicecontrolV1::AllocateQuotaResponse::Representation command.response_class = Google::Apis::ServicecontrolV1::AllocateQuotaResponse command.params['serviceName'] = service_name unless service_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 # Checks an operation with Google Service Control to decide whether # the given operation should proceed. It should be called before the # operation is executed. # If feasible, the client should cache the check results and reuse them for # 60 seconds. In case of server errors, the client can rely on the cached # results for longer time. # NOTE: the CheckRequest has the size limit of 64KB. # This method requires the `servicemanagement.services.check` permission # on the specified service. For more information, see # [Google Cloud IAM](https://cloud.google.com/iam). # @param [String] service_name # The service name as specified in its service configuration. For example, # `"pubsub.googleapis.com"`. # See # [google.api.Service](https://cloud.google.com/service-management/reference/rpc/ # google.api#google.api.Service) # for the definition of a service name. # @param [Google::Apis::ServicecontrolV1::CheckRequest] check_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::ServicecontrolV1::CheckResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServicecontrolV1::CheckResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def check_service(service_name, check_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/services/{serviceName}:check', options) command.request_representation = Google::Apis::ServicecontrolV1::CheckRequest::Representation command.request_object = check_request_object command.response_representation = Google::Apis::ServicecontrolV1::CheckResponse::Representation command.response_class = Google::Apis::ServicecontrolV1::CheckResponse command.params['serviceName'] = service_name unless service_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 # Signals the quota controller that service ends the ongoing usage # reconciliation. # This method requires the `servicemanagement.services.quota` # permission on the specified service. For more information, see # [Google Cloud IAM](https://cloud.google.com/iam). # @param [String] service_name # Name of the service as specified in the service configuration. For example, # `"pubsub.googleapis.com"`. # See google.api.Service for the definition of a service name. # @param [Google::Apis::ServicecontrolV1::EndReconciliationRequest] end_reconciliation_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::ServicecontrolV1::EndReconciliationResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServicecontrolV1::EndReconciliationResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def end_service_reconciliation(service_name, end_reconciliation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/services/{serviceName}:endReconciliation', options) command.request_representation = Google::Apis::ServicecontrolV1::EndReconciliationRequest::Representation command.request_object = end_reconciliation_request_object command.response_representation = Google::Apis::ServicecontrolV1::EndReconciliationResponse::Representation command.response_class = Google::Apis::ServicecontrolV1::EndReconciliationResponse command.params['serviceName'] = service_name unless service_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 # Releases previously allocated quota done through AllocateQuota method. # This method requires the `servicemanagement.services.quota` # permission on the specified service. For more information, see # [Cloud IAM](https://cloud.google.com/iam). # **NOTE:** The client **must** fail-open on server errors `INTERNAL`, # `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system # reliability, the server may inject these errors to prohibit any hard # dependency on the quota functionality. # @param [String] service_name # Name of the service as specified in the service configuration. For example, # `"pubsub.googleapis.com"`. # See google.api.Service for the definition of a service name. # @param [Google::Apis::ServicecontrolV1::ReleaseQuotaRequest] release_quota_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::ServicecontrolV1::ReleaseQuotaResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServicecontrolV1::ReleaseQuotaResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def release_service_quota(service_name, release_quota_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/services/{serviceName}:releaseQuota', options) command.request_representation = Google::Apis::ServicecontrolV1::ReleaseQuotaRequest::Representation command.request_object = release_quota_request_object command.response_representation = Google::Apis::ServicecontrolV1::ReleaseQuotaResponse::Representation command.response_class = Google::Apis::ServicecontrolV1::ReleaseQuotaResponse command.params['serviceName'] = service_name unless service_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 # Reports operation results to Google Service Control, such as logs and # metrics. It should be called after an operation is completed. # If feasible, the client should aggregate reporting data for up to 5 # seconds to reduce API traffic. Limiting aggregation to 5 seconds is to # reduce data loss during client crashes. Clients should carefully choose # the aggregation time window to avoid data loss risk more than 0.01% # for business and compliance reasons. # NOTE: the ReportRequest has the size limit of 1MB. # This method requires the `servicemanagement.services.report` permission # on the specified service. For more information, see # [Google Cloud IAM](https://cloud.google.com/iam). # @param [String] service_name # The service name as specified in its service configuration. For example, # `"pubsub.googleapis.com"`. # See # [google.api.Service](https://cloud.google.com/service-management/reference/rpc/ # google.api#google.api.Service) # for the definition of a service name. # @param [Google::Apis::ServicecontrolV1::ReportRequest] report_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::ServicecontrolV1::ReportResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServicecontrolV1::ReportResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def report_service(service_name, report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/services/{serviceName}:report', options) command.request_representation = Google::Apis::ServicecontrolV1::ReportRequest::Representation command.request_object = report_request_object command.response_representation = Google::Apis::ServicecontrolV1::ReportResponse::Representation command.response_class = Google::Apis::ServicecontrolV1::ReportResponse command.params['serviceName'] = service_name unless service_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 # Unlike rate quota, allocation quota does not get refilled periodically. # So, it is possible that the quota usage as seen by the service differs from # what the One Platform considers the usage is. This is expected to happen # only rarely, but over time this can accumulate. Services can invoke # StartReconciliation and EndReconciliation to correct this usage drift, as # described below: # 1. Service sends StartReconciliation with a timestamp in future for each # metric that needs to be reconciled. The timestamp being in future allows # to account for in-flight AllocateQuota and ReleaseQuota requests for the # same metric. # 2. One Platform records this timestamp and starts tracking subsequent # AllocateQuota and ReleaseQuota requests until EndReconciliation is # called. # 3. At or after the time specified in the StartReconciliation, service # sends EndReconciliation with the usage that needs to be reconciled to. # 4. One Platform adjusts its own record of usage for that metric to the # value specified in EndReconciliation by taking in to account any # allocation or release between StartReconciliation and EndReconciliation. # Signals the quota controller that the service wants to perform a usage # reconciliation as specified in the request. # This method requires the `servicemanagement.services.quota` # permission on the specified service. For more information, see # [Google Cloud IAM](https://cloud.google.com/iam). # @param [String] service_name # Name of the service as specified in the service configuration. For example, # `"pubsub.googleapis.com"`. # See google.api.Service for the definition of a service name. # @param [Google::Apis::ServicecontrolV1::StartReconciliationRequest] start_reconciliation_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::ServicecontrolV1::StartReconciliationResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServicecontrolV1::StartReconciliationResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def start_service_reconciliation(service_name, start_reconciliation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/services/{serviceName}:startReconciliation', options) command.request_representation = Google::Apis::ServicecontrolV1::StartReconciliationRequest::Representation command.request_object = start_reconciliation_request_object command.response_representation = Google::Apis::ServicecontrolV1::StartReconciliationResponse::Representation command.response_class = Google::Apis::ServicecontrolV1::StartReconciliationResponse command.params['serviceName'] = service_name unless service_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 google-api-client-0.19.8/generated/google/apis/genomics_v1.rb0000644000004100000410000000311013252673043024045 0ustar www-datawww-data# 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/genomics_v1/service.rb' require 'google/apis/genomics_v1/classes.rb' require 'google/apis/genomics_v1/representations.rb' module Google module Apis # Genomics API # # Upload, process, query, and search Genomics data in the cloud. # # @see https://cloud.google.com/genomics module GenomicsV1 VERSION = 'V1' REVISION = '20180208' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # Manage your data in Google Cloud Storage AUTH_DEVSTORAGE_READ_WRITE = 'https://www.googleapis.com/auth/devstorage.read_write' # View and manage Genomics data AUTH_GENOMICS = 'https://www.googleapis.com/auth/genomics' # View Genomics data AUTH_GENOMICS_READONLY = 'https://www.googleapis.com/auth/genomics.readonly' end end end google-api-client-0.19.8/generated/google/apis/civicinfo_v2/0000755000004100000410000000000013252673043023673 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/civicinfo_v2/representations.rb0000644000004100000410000005770213252673043027460 0ustar www-datawww-data# 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 CivicinfoV2 class AdministrationRegion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdministrativeBody class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Candidate 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 Contest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContextParams class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DivisionRepresentativeInfoRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DivisionSearchRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchDivisionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DivisionSearchResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Election class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ElectionOfficial class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ElectionsQueryRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryElectionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ElectoralDistrict class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GeographicDivision class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Office class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Official class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PollingLocation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PostalAddress class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RepresentativeInfoData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RepresentativeInfoRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RepresentativeInfoResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SimpleAddressType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Source class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VoterInfoRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VoterInfoResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VoterInfoSegmentResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdministrationRegion # @private class Representation < Google::Apis::Core::JsonRepresentation property :election_administration_body, as: 'electionAdministrationBody', class: Google::Apis::CivicinfoV2::AdministrativeBody, decorator: Google::Apis::CivicinfoV2::AdministrativeBody::Representation property :id, as: 'id' property :local_jurisdiction, as: 'local_jurisdiction', class: Google::Apis::CivicinfoV2::AdministrationRegion, decorator: Google::Apis::CivicinfoV2::AdministrationRegion::Representation property :name, as: 'name' collection :sources, as: 'sources', class: Google::Apis::CivicinfoV2::Source, decorator: Google::Apis::CivicinfoV2::Source::Representation end end class AdministrativeBody # @private class Representation < Google::Apis::Core::JsonRepresentation property :absentee_voting_info_url, as: 'absenteeVotingInfoUrl' collection :address_lines, as: 'addressLines' property :ballot_info_url, as: 'ballotInfoUrl' property :correspondence_address, as: 'correspondenceAddress', class: Google::Apis::CivicinfoV2::SimpleAddressType, decorator: Google::Apis::CivicinfoV2::SimpleAddressType::Representation property :election_info_url, as: 'electionInfoUrl' collection :election_officials, as: 'electionOfficials', class: Google::Apis::CivicinfoV2::ElectionOfficial, decorator: Google::Apis::CivicinfoV2::ElectionOfficial::Representation property :election_registration_confirmation_url, as: 'electionRegistrationConfirmationUrl' property :election_registration_url, as: 'electionRegistrationUrl' property :election_rules_url, as: 'electionRulesUrl' property :hours_of_operation, as: 'hoursOfOperation' property :name, as: 'name' property :physical_address, as: 'physicalAddress', class: Google::Apis::CivicinfoV2::SimpleAddressType, decorator: Google::Apis::CivicinfoV2::SimpleAddressType::Representation collection :voter_services, as: 'voter_services' property :voting_location_finder_url, as: 'votingLocationFinderUrl' end end class Candidate # @private class Representation < Google::Apis::Core::JsonRepresentation property :candidate_url, as: 'candidateUrl' collection :channels, as: 'channels', class: Google::Apis::CivicinfoV2::Channel, decorator: Google::Apis::CivicinfoV2::Channel::Representation property :email, as: 'email' property :name, as: 'name' property :order_on_ballot, :numeric_string => true, as: 'orderOnBallot' property :party, as: 'party' property :phone, as: 'phone' property :photo_url, as: 'photoUrl' end end class Channel # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :type, as: 'type' end end class Contest # @private class Representation < Google::Apis::Core::JsonRepresentation property :ballot_placement, :numeric_string => true, as: 'ballotPlacement' collection :candidates, as: 'candidates', class: Google::Apis::CivicinfoV2::Candidate, decorator: Google::Apis::CivicinfoV2::Candidate::Representation property :district, as: 'district', class: Google::Apis::CivicinfoV2::ElectoralDistrict, decorator: Google::Apis::CivicinfoV2::ElectoralDistrict::Representation property :electorate_specifications, as: 'electorateSpecifications' property :id, as: 'id' collection :level, as: 'level' property :number_elected, :numeric_string => true, as: 'numberElected' property :number_voting_for, :numeric_string => true, as: 'numberVotingFor' property :office, as: 'office' property :primary_party, as: 'primaryParty' collection :referendum_ballot_responses, as: 'referendumBallotResponses' property :referendum_brief, as: 'referendumBrief' property :referendum_con_statement, as: 'referendumConStatement' property :referendum_effect_of_abstain, as: 'referendumEffectOfAbstain' property :referendum_passage_threshold, as: 'referendumPassageThreshold' property :referendum_pro_statement, as: 'referendumProStatement' property :referendum_subtitle, as: 'referendumSubtitle' property :referendum_text, as: 'referendumText' property :referendum_title, as: 'referendumTitle' property :referendum_url, as: 'referendumUrl' collection :roles, as: 'roles' collection :sources, as: 'sources', class: Google::Apis::CivicinfoV2::Source, decorator: Google::Apis::CivicinfoV2::Source::Representation property :special, as: 'special' property :type, as: 'type' end end class ContextParams # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_profile, as: 'clientProfile' end end class DivisionRepresentativeInfoRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :context_params, as: 'contextParams', class: Google::Apis::CivicinfoV2::ContextParams, decorator: Google::Apis::CivicinfoV2::ContextParams::Representation end end class DivisionSearchRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :context_params, as: 'contextParams', class: Google::Apis::CivicinfoV2::ContextParams, decorator: Google::Apis::CivicinfoV2::ContextParams::Representation end end class SearchDivisionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :results, as: 'results', class: Google::Apis::CivicinfoV2::DivisionSearchResult, decorator: Google::Apis::CivicinfoV2::DivisionSearchResult::Representation end end class DivisionSearchResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :aliases, as: 'aliases' property :name, as: 'name' property :ocd_id, as: 'ocdId' end end class Election # @private class Representation < Google::Apis::Core::JsonRepresentation property :election_day, as: 'electionDay' property :id, :numeric_string => true, as: 'id' property :name, as: 'name' property :ocd_division_id, as: 'ocdDivisionId' end end class ElectionOfficial # @private class Representation < Google::Apis::Core::JsonRepresentation property :email_address, as: 'emailAddress' property :fax_number, as: 'faxNumber' property :name, as: 'name' property :office_phone_number, as: 'officePhoneNumber' property :title, as: 'title' end end class ElectionsQueryRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :context_params, as: 'contextParams', class: Google::Apis::CivicinfoV2::ContextParams, decorator: Google::Apis::CivicinfoV2::ContextParams::Representation end end class QueryElectionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :elections, as: 'elections', class: Google::Apis::CivicinfoV2::Election, decorator: Google::Apis::CivicinfoV2::Election::Representation property :kind, as: 'kind' end end class ElectoralDistrict # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kg_foreign_key, as: 'kgForeignKey' property :name, as: 'name' property :scope, as: 'scope' end end class GeographicDivision # @private class Representation < Google::Apis::Core::JsonRepresentation collection :also_known_as, as: 'alsoKnownAs' property :name, as: 'name' collection :office_indices, as: 'officeIndices' end end class Office # @private class Representation < Google::Apis::Core::JsonRepresentation property :division_id, as: 'divisionId' collection :levels, as: 'levels' property :name, as: 'name' collection :official_indices, as: 'officialIndices' collection :roles, as: 'roles' collection :sources, as: 'sources', class: Google::Apis::CivicinfoV2::Source, decorator: Google::Apis::CivicinfoV2::Source::Representation end end class Official # @private class Representation < Google::Apis::Core::JsonRepresentation collection :address, as: 'address', class: Google::Apis::CivicinfoV2::SimpleAddressType, decorator: Google::Apis::CivicinfoV2::SimpleAddressType::Representation collection :channels, as: 'channels', class: Google::Apis::CivicinfoV2::Channel, decorator: Google::Apis::CivicinfoV2::Channel::Representation collection :emails, as: 'emails' property :name, as: 'name' property :party, as: 'party' collection :phones, as: 'phones' property :photo_url, as: 'photoUrl' collection :urls, as: 'urls' end end class PollingLocation # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address', class: Google::Apis::CivicinfoV2::SimpleAddressType, decorator: Google::Apis::CivicinfoV2::SimpleAddressType::Representation property :end_date, as: 'endDate' property :id, as: 'id' property :name, as: 'name' property :notes, as: 'notes' property :polling_hours, as: 'pollingHours' collection :sources, as: 'sources', class: Google::Apis::CivicinfoV2::Source, decorator: Google::Apis::CivicinfoV2::Source::Representation property :start_date, as: 'startDate' property :voter_services, as: 'voterServices' end end class PostalAddress # @private class Representation < Google::Apis::Core::JsonRepresentation collection :address_lines, as: 'addressLines' property :administrative_area_name, as: 'administrativeAreaName' property :country_name, as: 'countryName' property :country_name_code, as: 'countryNameCode' property :dependent_locality_name, as: 'dependentLocalityName' property :dependent_thoroughfare_leading_type, as: 'dependentThoroughfareLeadingType' property :dependent_thoroughfare_name, as: 'dependentThoroughfareName' property :dependent_thoroughfare_post_direction, as: 'dependentThoroughfarePostDirection' property :dependent_thoroughfare_pre_direction, as: 'dependentThoroughfarePreDirection' property :dependent_thoroughfare_trailing_type, as: 'dependentThoroughfareTrailingType' property :dependent_thoroughfares_connector, as: 'dependentThoroughfaresConnector' property :dependent_thoroughfares_indicator, as: 'dependentThoroughfaresIndicator' property :dependent_thoroughfares_type, as: 'dependentThoroughfaresType' property :firm_name, as: 'firmName' property :is_disputed, as: 'isDisputed' property :language_code, as: 'languageCode' property :locality_name, as: 'localityName' property :post_box_number, as: 'postBoxNumber' property :postal_code_number, as: 'postalCodeNumber' property :postal_code_number_extension, as: 'postalCodeNumberExtension' property :premise_name, as: 'premiseName' property :recipient_name, as: 'recipientName' property :sorting_code, as: 'sortingCode' property :sub_administrative_area_name, as: 'subAdministrativeAreaName' property :sub_premise_name, as: 'subPremiseName' property :thoroughfare_leading_type, as: 'thoroughfareLeadingType' property :thoroughfare_name, as: 'thoroughfareName' property :thoroughfare_number, as: 'thoroughfareNumber' property :thoroughfare_post_direction, as: 'thoroughfarePostDirection' property :thoroughfare_pre_direction, as: 'thoroughfarePreDirection' property :thoroughfare_trailing_type, as: 'thoroughfareTrailingType' end end class RepresentativeInfoData # @private class Representation < Google::Apis::Core::JsonRepresentation hash :divisions, as: 'divisions', class: Google::Apis::CivicinfoV2::GeographicDivision, decorator: Google::Apis::CivicinfoV2::GeographicDivision::Representation collection :offices, as: 'offices', class: Google::Apis::CivicinfoV2::Office, decorator: Google::Apis::CivicinfoV2::Office::Representation collection :officials, as: 'officials', class: Google::Apis::CivicinfoV2::Official, decorator: Google::Apis::CivicinfoV2::Official::Representation end end class RepresentativeInfoRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :context_params, as: 'contextParams', class: Google::Apis::CivicinfoV2::ContextParams, decorator: Google::Apis::CivicinfoV2::ContextParams::Representation end end class RepresentativeInfoResponse # @private class Representation < Google::Apis::Core::JsonRepresentation hash :divisions, as: 'divisions', class: Google::Apis::CivicinfoV2::GeographicDivision, decorator: Google::Apis::CivicinfoV2::GeographicDivision::Representation property :kind, as: 'kind' property :normalized_input, as: 'normalizedInput', class: Google::Apis::CivicinfoV2::SimpleAddressType, decorator: Google::Apis::CivicinfoV2::SimpleAddressType::Representation collection :offices, as: 'offices', class: Google::Apis::CivicinfoV2::Office, decorator: Google::Apis::CivicinfoV2::Office::Representation collection :officials, as: 'officials', class: Google::Apis::CivicinfoV2::Official, decorator: Google::Apis::CivicinfoV2::Official::Representation end end class SimpleAddressType # @private class Representation < Google::Apis::Core::JsonRepresentation property :city, as: 'city' property :line1, as: 'line1' property :line2, as: 'line2' property :line3, as: 'line3' property :location_name, as: 'locationName' property :state, as: 'state' property :zip, as: 'zip' end end class Source # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :official, as: 'official' end end class VoterInfoRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :context_params, as: 'contextParams', class: Google::Apis::CivicinfoV2::ContextParams, decorator: Google::Apis::CivicinfoV2::ContextParams::Representation property :voter_info_segment_result, as: 'voterInfoSegmentResult', class: Google::Apis::CivicinfoV2::VoterInfoSegmentResult, decorator: Google::Apis::CivicinfoV2::VoterInfoSegmentResult::Representation end end class VoterInfoResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :contests, as: 'contests', class: Google::Apis::CivicinfoV2::Contest, decorator: Google::Apis::CivicinfoV2::Contest::Representation collection :drop_off_locations, as: 'dropOffLocations', class: Google::Apis::CivicinfoV2::PollingLocation, decorator: Google::Apis::CivicinfoV2::PollingLocation::Representation collection :early_vote_sites, as: 'earlyVoteSites', class: Google::Apis::CivicinfoV2::PollingLocation, decorator: Google::Apis::CivicinfoV2::PollingLocation::Representation property :election, as: 'election', class: Google::Apis::CivicinfoV2::Election, decorator: Google::Apis::CivicinfoV2::Election::Representation property :kind, as: 'kind' property :mail_only, as: 'mailOnly' property :normalized_input, as: 'normalizedInput', class: Google::Apis::CivicinfoV2::SimpleAddressType, decorator: Google::Apis::CivicinfoV2::SimpleAddressType::Representation collection :other_elections, as: 'otherElections', class: Google::Apis::CivicinfoV2::Election, decorator: Google::Apis::CivicinfoV2::Election::Representation collection :polling_locations, as: 'pollingLocations', class: Google::Apis::CivicinfoV2::PollingLocation, decorator: Google::Apis::CivicinfoV2::PollingLocation::Representation property :precinct_id, as: 'precinctId' collection :state, as: 'state', class: Google::Apis::CivicinfoV2::AdministrationRegion, decorator: Google::Apis::CivicinfoV2::AdministrationRegion::Representation end end class VoterInfoSegmentResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :generated_millis, :numeric_string => true, as: 'generatedMillis' property :postal_address, as: 'postalAddress', class: Google::Apis::CivicinfoV2::PostalAddress, decorator: Google::Apis::CivicinfoV2::PostalAddress::Representation property :request, as: 'request', class: Google::Apis::CivicinfoV2::VoterInfoRequest, decorator: Google::Apis::CivicinfoV2::VoterInfoRequest::Representation property :response, as: 'response', class: Google::Apis::CivicinfoV2::VoterInfoResponse, decorator: Google::Apis::CivicinfoV2::VoterInfoResponse::Representation end end end end end google-api-client-0.19.8/generated/google/apis/civicinfo_v2/classes.rb0000644000004100000410000016717613252673043025677 0ustar www-datawww-data# 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 CivicinfoV2 # Describes information about a regional election administrative area. class AdministrationRegion include Google::Apis::Core::Hashable # Information about an election administrative body (e.g. County Board of # Elections). # Corresponds to the JSON property `electionAdministrationBody` # @return [Google::Apis::CivicinfoV2::AdministrativeBody] attr_accessor :election_administration_body # An ID for this object. IDs may change in future requests and should not be # cached. Access to this field requires special access that can be requested # from the Request more link on the Quotas page. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Describes information about a regional election administrative area. # Corresponds to the JSON property `local_jurisdiction` # @return [Google::Apis::CivicinfoV2::AdministrationRegion] attr_accessor :local_jurisdiction # The name of the jurisdiction. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A list of sources for this area. If multiple sources are listed the data has # been aggregated from those sources. # Corresponds to the JSON property `sources` # @return [Array] attr_accessor :sources def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @election_administration_body = args[:election_administration_body] if args.key?(:election_administration_body) @id = args[:id] if args.key?(:id) @local_jurisdiction = args[:local_jurisdiction] if args.key?(:local_jurisdiction) @name = args[:name] if args.key?(:name) @sources = args[:sources] if args.key?(:sources) end end # Information about an election administrative body (e.g. County Board of # Elections). class AdministrativeBody include Google::Apis::Core::Hashable # A URL provided by this administrative body for information on absentee voting. # Corresponds to the JSON property `absenteeVotingInfoUrl` # @return [String] attr_accessor :absentee_voting_info_url # # Corresponds to the JSON property `addressLines` # @return [Array] attr_accessor :address_lines # A URL provided by this administrative body to give contest information to the # voter. # Corresponds to the JSON property `ballotInfoUrl` # @return [String] attr_accessor :ballot_info_url # A simple representation of an address. # Corresponds to the JSON property `correspondenceAddress` # @return [Google::Apis::CivicinfoV2::SimpleAddressType] attr_accessor :correspondence_address # A URL provided by this administrative body for looking up general election # information. # Corresponds to the JSON property `electionInfoUrl` # @return [String] attr_accessor :election_info_url # The election officials for this election administrative body. # Corresponds to the JSON property `electionOfficials` # @return [Array] attr_accessor :election_officials # A URL provided by this administrative body for confirming that the voter is # registered to vote. # Corresponds to the JSON property `electionRegistrationConfirmationUrl` # @return [String] attr_accessor :election_registration_confirmation_url # A URL provided by this administrative body for looking up how to register to # vote. # Corresponds to the JSON property `electionRegistrationUrl` # @return [String] attr_accessor :election_registration_url # A URL provided by this administrative body describing election rules to the # voter. # Corresponds to the JSON property `electionRulesUrl` # @return [String] attr_accessor :election_rules_url # A description of the hours of operation for this administrative body. # Corresponds to the JSON property `hoursOfOperation` # @return [String] attr_accessor :hours_of_operation # The name of this election administrative body. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A simple representation of an address. # Corresponds to the JSON property `physicalAddress` # @return [Google::Apis::CivicinfoV2::SimpleAddressType] attr_accessor :physical_address # A description of the services this administrative body may provide. # Corresponds to the JSON property `voter_services` # @return [Array] attr_accessor :voter_services # A URL provided by this administrative body for looking up where to vote. # Corresponds to the JSON property `votingLocationFinderUrl` # @return [String] attr_accessor :voting_location_finder_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @absentee_voting_info_url = args[:absentee_voting_info_url] if args.key?(:absentee_voting_info_url) @address_lines = args[:address_lines] if args.key?(:address_lines) @ballot_info_url = args[:ballot_info_url] if args.key?(:ballot_info_url) @correspondence_address = args[:correspondence_address] if args.key?(:correspondence_address) @election_info_url = args[:election_info_url] if args.key?(:election_info_url) @election_officials = args[:election_officials] if args.key?(:election_officials) @election_registration_confirmation_url = args[:election_registration_confirmation_url] if args.key?(:election_registration_confirmation_url) @election_registration_url = args[:election_registration_url] if args.key?(:election_registration_url) @election_rules_url = args[:election_rules_url] if args.key?(:election_rules_url) @hours_of_operation = args[:hours_of_operation] if args.key?(:hours_of_operation) @name = args[:name] if args.key?(:name) @physical_address = args[:physical_address] if args.key?(:physical_address) @voter_services = args[:voter_services] if args.key?(:voter_services) @voting_location_finder_url = args[:voting_location_finder_url] if args.key?(:voting_location_finder_url) end end # Information about a candidate running for elected office. class Candidate include Google::Apis::Core::Hashable # The URL for the candidate's campaign web site. # Corresponds to the JSON property `candidateUrl` # @return [String] attr_accessor :candidate_url # A list of known (social) media channels for this candidate. # Corresponds to the JSON property `channels` # @return [Array] attr_accessor :channels # The email address for the candidate's campaign. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The candidate's name. If this is a joint ticket it will indicate the name of # the candidate at the top of a ticket followed by a / and that name of # candidate at the bottom of the ticket. e.g. "Mitt Romney / Paul Ryan" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The order the candidate appears on the ballot for this contest. # Corresponds to the JSON property `orderOnBallot` # @return [Fixnum] attr_accessor :order_on_ballot # The full name of the party the candidate is a member of. # Corresponds to the JSON property `party` # @return [String] attr_accessor :party # The voice phone number for the candidate's campaign office. # Corresponds to the JSON property `phone` # @return [String] attr_accessor :phone # A URL for a photo of the candidate. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @candidate_url = args[:candidate_url] if args.key?(:candidate_url) @channels = args[:channels] if args.key?(:channels) @email = args[:email] if args.key?(:email) @name = args[:name] if args.key?(:name) @order_on_ballot = args[:order_on_ballot] if args.key?(:order_on_ballot) @party = args[:party] if args.key?(:party) @phone = args[:phone] if args.key?(:phone) @photo_url = args[:photo_url] if args.key?(:photo_url) end end # A social media or web channel for a candidate. class Channel include Google::Apis::Core::Hashable # The unique public identifier for the candidate's channel. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of channel. The following is a list of types of channels, but is not # exhaustive. More channel types may be added at a later time. One of: # GooglePlus, YouTube, Facebook, Twitter # 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) @id = args[:id] if args.key?(:id) @type = args[:type] if args.key?(:type) end end # Information about a contest that appears on a voter's ballot. class Contest include Google::Apis::Core::Hashable # A number specifying the position of this contest on the voter's ballot. # Corresponds to the JSON property `ballotPlacement` # @return [Fixnum] attr_accessor :ballot_placement # The candidate choices for this contest. # Corresponds to the JSON property `candidates` # @return [Array] attr_accessor :candidates # Describes the geographic scope of a contest. # Corresponds to the JSON property `district` # @return [Google::Apis::CivicinfoV2::ElectoralDistrict] attr_accessor :district # A description of any additional eligibility requirements for voting in this # contest. # Corresponds to the JSON property `electorateSpecifications` # @return [String] attr_accessor :electorate_specifications # An ID for this object. IDs may change in future requests and should not be # cached. Access to this field requires special access that can be requested # from the Request more link on the Quotas page. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The levels of government of the office for this contest. There may be more # than one in cases where a jurisdiction effectively acts at two different # levels of government; for example, the mayor of the District of Columbia acts # at "locality" level, but also effectively at both "administrative-area-2" and " # administrative-area-1". # Corresponds to the JSON property `level` # @return [Array] attr_accessor :level # The number of candidates that will be elected to office in this contest. # Corresponds to the JSON property `numberElected` # @return [Fixnum] attr_accessor :number_elected # The number of candidates that a voter may vote for in this contest. # Corresponds to the JSON property `numberVotingFor` # @return [Fixnum] attr_accessor :number_voting_for # The name of the office for this contest. # Corresponds to the JSON property `office` # @return [String] attr_accessor :office # If this is a partisan election, the name of the party it is for. # Corresponds to the JSON property `primaryParty` # @return [String] attr_accessor :primary_party # The set of ballot responses for the referendum. A ballot response represents a # line on the ballot. Common examples might include "yes" or "no" for referenda. # This field is only populated for contests of type 'Referendum'. # Corresponds to the JSON property `referendumBallotResponses` # @return [Array] attr_accessor :referendum_ballot_responses # Specifies a short summary of the referendum that is typically on the ballot # below the title but above the text. This field is only populated for contests # of type 'Referendum'. # Corresponds to the JSON property `referendumBrief` # @return [String] attr_accessor :referendum_brief # A statement in opposition to the referendum. It does not necessarily appear on # the ballot. This field is only populated for contests of type 'Referendum'. # Corresponds to the JSON property `referendumConStatement` # @return [String] attr_accessor :referendum_con_statement # Specifies what effect abstaining (not voting) on the proposition will have (i. # e. whether abstaining is considered a vote against it). This field is only # populated for contests of type 'Referendum'. # Corresponds to the JSON property `referendumEffectOfAbstain` # @return [String] attr_accessor :referendum_effect_of_abstain # The threshold of votes that the referendum needs in order to pass, e.g. "two- # thirds". This field is only populated for contests of type 'Referendum'. # Corresponds to the JSON property `referendumPassageThreshold` # @return [String] attr_accessor :referendum_passage_threshold # A statement in favor of the referendum. It does not necessarily appear on the # ballot. This field is only populated for contests of type 'Referendum'. # Corresponds to the JSON property `referendumProStatement` # @return [String] attr_accessor :referendum_pro_statement # A brief description of the referendum. This field is only populated for # contests of type 'Referendum'. # Corresponds to the JSON property `referendumSubtitle` # @return [String] attr_accessor :referendum_subtitle # The full text of the referendum. This field is only populated for contests of # type 'Referendum'. # Corresponds to the JSON property `referendumText` # @return [String] attr_accessor :referendum_text # The title of the referendum (e.g. 'Proposition 42'). This field is only # populated for contests of type 'Referendum'. # Corresponds to the JSON property `referendumTitle` # @return [String] attr_accessor :referendum_title # A link to the referendum. This field is only populated for contests of type ' # Referendum'. # Corresponds to the JSON property `referendumUrl` # @return [String] attr_accessor :referendum_url # The roles which this office fulfills. # Corresponds to the JSON property `roles` # @return [Array] attr_accessor :roles # A list of sources for this contest. If multiple sources are listed, the data # has been aggregated from those sources. # Corresponds to the JSON property `sources` # @return [Array] attr_accessor :sources # "Yes" or "No" depending on whether this a contest being held outside the # normal election cycle. # Corresponds to the JSON property `special` # @return [String] attr_accessor :special # The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' # for contests with candidates. For referenda this will be 'Referendum'. For # Retention contests this will typically be 'Retention'. # 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) @ballot_placement = args[:ballot_placement] if args.key?(:ballot_placement) @candidates = args[:candidates] if args.key?(:candidates) @district = args[:district] if args.key?(:district) @electorate_specifications = args[:electorate_specifications] if args.key?(:electorate_specifications) @id = args[:id] if args.key?(:id) @level = args[:level] if args.key?(:level) @number_elected = args[:number_elected] if args.key?(:number_elected) @number_voting_for = args[:number_voting_for] if args.key?(:number_voting_for) @office = args[:office] if args.key?(:office) @primary_party = args[:primary_party] if args.key?(:primary_party) @referendum_ballot_responses = args[:referendum_ballot_responses] if args.key?(:referendum_ballot_responses) @referendum_brief = args[:referendum_brief] if args.key?(:referendum_brief) @referendum_con_statement = args[:referendum_con_statement] if args.key?(:referendum_con_statement) @referendum_effect_of_abstain = args[:referendum_effect_of_abstain] if args.key?(:referendum_effect_of_abstain) @referendum_passage_threshold = args[:referendum_passage_threshold] if args.key?(:referendum_passage_threshold) @referendum_pro_statement = args[:referendum_pro_statement] if args.key?(:referendum_pro_statement) @referendum_subtitle = args[:referendum_subtitle] if args.key?(:referendum_subtitle) @referendum_text = args[:referendum_text] if args.key?(:referendum_text) @referendum_title = args[:referendum_title] if args.key?(:referendum_title) @referendum_url = args[:referendum_url] if args.key?(:referendum_url) @roles = args[:roles] if args.key?(:roles) @sources = args[:sources] if args.key?(:sources) @special = args[:special] if args.key?(:special) @type = args[:type] if args.key?(:type) end end # class ContextParams include Google::Apis::Core::Hashable # # Corresponds to the JSON property `clientProfile` # @return [String] attr_accessor :client_profile def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_profile = args[:client_profile] if args.key?(:client_profile) end end # A request to look up representative information for a single division. class DivisionRepresentativeInfoRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `contextParams` # @return [Google::Apis::CivicinfoV2::ContextParams] attr_accessor :context_params def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @context_params = args[:context_params] if args.key?(:context_params) end end # A search request for political geographies. class DivisionSearchRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `contextParams` # @return [Google::Apis::CivicinfoV2::ContextParams] attr_accessor :context_params def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @context_params = args[:context_params] if args.key?(:context_params) end end # The result of a division search query. class SearchDivisionResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "civicinfo# # divisionSearchResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # # 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) @kind = args[:kind] if args.key?(:kind) @results = args[:results] if args.key?(:results) end end # Represents a political geographic division that matches the requested query. class DivisionSearchResult include Google::Apis::Core::Hashable # Other Open Civic Data identifiers that refer to the same division -- for # example, those that refer to other political divisions whose boundaries are # defined to be coterminous with this one. For example, ocd-division/country:us/ # state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since # Wyoming has only one Congressional district. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases # The name of the division. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The unique Open Civic Data identifier for this division. # Corresponds to the JSON property `ocdId` # @return [String] attr_accessor :ocd_id 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) @ocd_id = args[:ocd_id] if args.key?(:ocd_id) end end # Information about the election that was queried. class Election include Google::Apis::Core::Hashable # Day of the election in YYYY-MM-DD format. # Corresponds to the JSON property `electionDay` # @return [String] attr_accessor :election_day # The unique ID of this election. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # A displayable name for the election. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The political division of the election. Represented as an OCD Division ID. # Voters within these political jurisdictions are covered by this election. This # is typically a state such as ocd-division/country:us/state:ca or for the # midterms or general election the entire US (i.e. ocd-division/country:us). # Corresponds to the JSON property `ocdDivisionId` # @return [String] attr_accessor :ocd_division_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @election_day = args[:election_day] if args.key?(:election_day) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @ocd_division_id = args[:ocd_division_id] if args.key?(:ocd_division_id) end end # Information about individual election officials. class ElectionOfficial include Google::Apis::Core::Hashable # The email address of the election official. # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address # The fax number of the election official. # Corresponds to the JSON property `faxNumber` # @return [String] attr_accessor :fax_number # The full name of the election official. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The office phone number of the election official. # Corresponds to the JSON property `officePhoneNumber` # @return [String] attr_accessor :office_phone_number # The title of the election official. # 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) @email_address = args[:email_address] if args.key?(:email_address) @fax_number = args[:fax_number] if args.key?(:fax_number) @name = args[:name] if args.key?(:name) @office_phone_number = args[:office_phone_number] if args.key?(:office_phone_number) @title = args[:title] if args.key?(:title) end end # class ElectionsQueryRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `contextParams` # @return [Google::Apis::CivicinfoV2::ContextParams] attr_accessor :context_params def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @context_params = args[:context_params] if args.key?(:context_params) end end # The list of elections available for this version of the API. class QueryElectionsResponse include Google::Apis::Core::Hashable # A list of available elections # Corresponds to the JSON property `elections` # @return [Array] attr_accessor :elections # Identifies what kind of resource this is. Value: the fixed string "civicinfo# # electionsQueryResponse". # 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) @elections = args[:elections] if args.key?(:elections) @kind = args[:kind] if args.key?(:kind) end end # Describes the geographic scope of a contest. class ElectoralDistrict include Google::Apis::Core::Hashable # An identifier for this district, relative to its scope. For example, the 34th # State Senate district would have id "34" and a scope of stateUpper. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # # Corresponds to the JSON property `kgForeignKey` # @return [String] attr_accessor :kg_foreign_key # The name of the district. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The geographic scope of this district. If unspecified the district's geography # is not known. One of: national, statewide, congressional, stateUpper, # stateLower, countywide, judicial, schoolBoard, cityWide, township, # countyCouncil, cityCouncil, ward, special # Corresponds to the JSON property `scope` # @return [String] attr_accessor :scope def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kg_foreign_key = args[:kg_foreign_key] if args.key?(:kg_foreign_key) @name = args[:name] if args.key?(:name) @scope = args[:scope] if args.key?(:scope) end end # Describes a political geography. class GeographicDivision include Google::Apis::Core::Hashable # Any other valid OCD IDs that refer to the same division. # Because OCD IDs are meant to be human-readable and at least somewhat # predictable, there are occasionally several identifiers for a single division. # These identifiers are defined to be equivalent to one another, and one is # always indicated as the primary identifier. The primary identifier will be # returned in ocd_id above, and any other equivalent valid identifiers will be # returned in this list. # For example, if this division's OCD ID is ocd-division/country:us/district:dc, # this will contain ocd-division/country:us/state:dc. # Corresponds to the JSON property `alsoKnownAs` # @return [Array] attr_accessor :also_known_as # The name of the division. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # List of indices in the offices array, one for each office elected from this # division. Will only be present if includeOffices was true (or absent) in the # request. # Corresponds to the JSON property `officeIndices` # @return [Array] attr_accessor :office_indices def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @also_known_as = args[:also_known_as] if args.key?(:also_known_as) @name = args[:name] if args.key?(:name) @office_indices = args[:office_indices] if args.key?(:office_indices) end end # Information about an Office held by one or more Officials. class Office include Google::Apis::Core::Hashable # The OCD ID of the division with which this office is associated. # Corresponds to the JSON property `divisionId` # @return [String] attr_accessor :division_id # The levels of government of which this office is part. There may be more than # one in cases where a jurisdiction effectively acts at two different levels of # government; for example, the mayor of the District of Columbia acts at " # locality" level, but also effectively at both "administrative-area-2" and " # administrative-area-1". # Corresponds to the JSON property `levels` # @return [Array] attr_accessor :levels # The human-readable name of the office. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # List of indices in the officials array of people who presently hold this # office. # Corresponds to the JSON property `officialIndices` # @return [Array] attr_accessor :official_indices # The roles which this office fulfills. Roles are not meant to be exhaustive, or # to exactly specify the entire set of responsibilities of a given office, but # are meant to be rough categories that are useful for general selection from or # sorting of a list of offices. # Corresponds to the JSON property `roles` # @return [Array] attr_accessor :roles # A list of sources for this office. If multiple sources are listed, the data # has been aggregated from those sources. # Corresponds to the JSON property `sources` # @return [Array] attr_accessor :sources def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @division_id = args[:division_id] if args.key?(:division_id) @levels = args[:levels] if args.key?(:levels) @name = args[:name] if args.key?(:name) @official_indices = args[:official_indices] if args.key?(:official_indices) @roles = args[:roles] if args.key?(:roles) @sources = args[:sources] if args.key?(:sources) end end # Information about a person holding an elected office. class Official include Google::Apis::Core::Hashable # Addresses at which to contact the official. # Corresponds to the JSON property `address` # @return [Array] attr_accessor :address # A list of known (social) media channels for this official. # Corresponds to the JSON property `channels` # @return [Array] attr_accessor :channels # The direct email addresses for the official. # Corresponds to the JSON property `emails` # @return [Array] attr_accessor :emails # The official's name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The full name of the party the official belongs to. # Corresponds to the JSON property `party` # @return [String] attr_accessor :party # The official's public contact phone numbers. # Corresponds to the JSON property `phones` # @return [Array] attr_accessor :phones # A URL for a photo of the official. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url # The official's public website URLs. # Corresponds to the JSON property `urls` # @return [Array] attr_accessor :urls def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @address = args[:address] if args.key?(:address) @channels = args[:channels] if args.key?(:channels) @emails = args[:emails] if args.key?(:emails) @name = args[:name] if args.key?(:name) @party = args[:party] if args.key?(:party) @phones = args[:phones] if args.key?(:phones) @photo_url = args[:photo_url] if args.key?(:photo_url) @urls = args[:urls] if args.key?(:urls) end end # A location where a voter can vote. This may be an early vote site, an election # day voting location, or a drop off location for a completed ballot. class PollingLocation include Google::Apis::Core::Hashable # A simple representation of an address. # Corresponds to the JSON property `address` # @return [Google::Apis::CivicinfoV2::SimpleAddressType] attr_accessor :address # The last date that this early vote site or drop off location may be used. This # field is not populated for polling locations. # Corresponds to the JSON property `endDate` # @return [String] attr_accessor :end_date # An ID for this object. IDs may change in future requests and should not be # cached. Access to this field requires special access that can be requested # from the Request more link on the Quotas page. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The name of the early vote site or drop off location. This field is not # populated for polling locations. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Notes about this location (e.g. accessibility ramp or entrance to use). # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # A description of when this location is open. # Corresponds to the JSON property `pollingHours` # @return [String] attr_accessor :polling_hours # A list of sources for this location. If multiple sources are listed the data # has been aggregated from those sources. # Corresponds to the JSON property `sources` # @return [Array] attr_accessor :sources # The first date that this early vote site or drop off location may be used. # This field is not populated for polling locations. # Corresponds to the JSON property `startDate` # @return [String] attr_accessor :start_date # The services provided by this early vote site or drop off location. This field # is not populated for polling locations. # Corresponds to the JSON property `voterServices` # @return [String] attr_accessor :voter_services def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @address = args[:address] if args.key?(:address) @end_date = args[:end_date] if args.key?(:end_date) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @polling_hours = args[:polling_hours] if args.key?(:polling_hours) @sources = args[:sources] if args.key?(:sources) @start_date = args[:start_date] if args.key?(:start_date) @voter_services = args[:voter_services] if args.key?(:voter_services) end end # class PostalAddress include Google::Apis::Core::Hashable # # Corresponds to the JSON property `addressLines` # @return [Array] attr_accessor :address_lines # # Corresponds to the JSON property `administrativeAreaName` # @return [String] attr_accessor :administrative_area_name # # Corresponds to the JSON property `countryName` # @return [String] attr_accessor :country_name # # Corresponds to the JSON property `countryNameCode` # @return [String] attr_accessor :country_name_code # # Corresponds to the JSON property `dependentLocalityName` # @return [String] attr_accessor :dependent_locality_name # # Corresponds to the JSON property `dependentThoroughfareLeadingType` # @return [String] attr_accessor :dependent_thoroughfare_leading_type # # Corresponds to the JSON property `dependentThoroughfareName` # @return [String] attr_accessor :dependent_thoroughfare_name # # Corresponds to the JSON property `dependentThoroughfarePostDirection` # @return [String] attr_accessor :dependent_thoroughfare_post_direction # # Corresponds to the JSON property `dependentThoroughfarePreDirection` # @return [String] attr_accessor :dependent_thoroughfare_pre_direction # # Corresponds to the JSON property `dependentThoroughfareTrailingType` # @return [String] attr_accessor :dependent_thoroughfare_trailing_type # # Corresponds to the JSON property `dependentThoroughfaresConnector` # @return [String] attr_accessor :dependent_thoroughfares_connector # # Corresponds to the JSON property `dependentThoroughfaresIndicator` # @return [String] attr_accessor :dependent_thoroughfares_indicator # # Corresponds to the JSON property `dependentThoroughfaresType` # @return [String] attr_accessor :dependent_thoroughfares_type # # Corresponds to the JSON property `firmName` # @return [String] attr_accessor :firm_name # # Corresponds to the JSON property `isDisputed` # @return [Boolean] attr_accessor :is_disputed alias_method :is_disputed?, :is_disputed # # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # # Corresponds to the JSON property `localityName` # @return [String] attr_accessor :locality_name # # Corresponds to the JSON property `postBoxNumber` # @return [String] attr_accessor :post_box_number # # Corresponds to the JSON property `postalCodeNumber` # @return [String] attr_accessor :postal_code_number # # Corresponds to the JSON property `postalCodeNumberExtension` # @return [String] attr_accessor :postal_code_number_extension # # Corresponds to the JSON property `premiseName` # @return [String] attr_accessor :premise_name # # Corresponds to the JSON property `recipientName` # @return [String] attr_accessor :recipient_name # # Corresponds to the JSON property `sortingCode` # @return [String] attr_accessor :sorting_code # # Corresponds to the JSON property `subAdministrativeAreaName` # @return [String] attr_accessor :sub_administrative_area_name # # Corresponds to the JSON property `subPremiseName` # @return [String] attr_accessor :sub_premise_name # # Corresponds to the JSON property `thoroughfareLeadingType` # @return [String] attr_accessor :thoroughfare_leading_type # # Corresponds to the JSON property `thoroughfareName` # @return [String] attr_accessor :thoroughfare_name # # Corresponds to the JSON property `thoroughfareNumber` # @return [String] attr_accessor :thoroughfare_number # # Corresponds to the JSON property `thoroughfarePostDirection` # @return [String] attr_accessor :thoroughfare_post_direction # # Corresponds to the JSON property `thoroughfarePreDirection` # @return [String] attr_accessor :thoroughfare_pre_direction # # Corresponds to the JSON property `thoroughfareTrailingType` # @return [String] attr_accessor :thoroughfare_trailing_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @address_lines = args[:address_lines] if args.key?(:address_lines) @administrative_area_name = args[:administrative_area_name] if args.key?(:administrative_area_name) @country_name = args[:country_name] if args.key?(:country_name) @country_name_code = args[:country_name_code] if args.key?(:country_name_code) @dependent_locality_name = args[:dependent_locality_name] if args.key?(:dependent_locality_name) @dependent_thoroughfare_leading_type = args[:dependent_thoroughfare_leading_type] if args.key?(:dependent_thoroughfare_leading_type) @dependent_thoroughfare_name = args[:dependent_thoroughfare_name] if args.key?(:dependent_thoroughfare_name) @dependent_thoroughfare_post_direction = args[:dependent_thoroughfare_post_direction] if args.key?(:dependent_thoroughfare_post_direction) @dependent_thoroughfare_pre_direction = args[:dependent_thoroughfare_pre_direction] if args.key?(:dependent_thoroughfare_pre_direction) @dependent_thoroughfare_trailing_type = args[:dependent_thoroughfare_trailing_type] if args.key?(:dependent_thoroughfare_trailing_type) @dependent_thoroughfares_connector = args[:dependent_thoroughfares_connector] if args.key?(:dependent_thoroughfares_connector) @dependent_thoroughfares_indicator = args[:dependent_thoroughfares_indicator] if args.key?(:dependent_thoroughfares_indicator) @dependent_thoroughfares_type = args[:dependent_thoroughfares_type] if args.key?(:dependent_thoroughfares_type) @firm_name = args[:firm_name] if args.key?(:firm_name) @is_disputed = args[:is_disputed] if args.key?(:is_disputed) @language_code = args[:language_code] if args.key?(:language_code) @locality_name = args[:locality_name] if args.key?(:locality_name) @post_box_number = args[:post_box_number] if args.key?(:post_box_number) @postal_code_number = args[:postal_code_number] if args.key?(:postal_code_number) @postal_code_number_extension = args[:postal_code_number_extension] if args.key?(:postal_code_number_extension) @premise_name = args[:premise_name] if args.key?(:premise_name) @recipient_name = args[:recipient_name] if args.key?(:recipient_name) @sorting_code = args[:sorting_code] if args.key?(:sorting_code) @sub_administrative_area_name = args[:sub_administrative_area_name] if args.key?(:sub_administrative_area_name) @sub_premise_name = args[:sub_premise_name] if args.key?(:sub_premise_name) @thoroughfare_leading_type = args[:thoroughfare_leading_type] if args.key?(:thoroughfare_leading_type) @thoroughfare_name = args[:thoroughfare_name] if args.key?(:thoroughfare_name) @thoroughfare_number = args[:thoroughfare_number] if args.key?(:thoroughfare_number) @thoroughfare_post_direction = args[:thoroughfare_post_direction] if args.key?(:thoroughfare_post_direction) @thoroughfare_pre_direction = args[:thoroughfare_pre_direction] if args.key?(:thoroughfare_pre_direction) @thoroughfare_trailing_type = args[:thoroughfare_trailing_type] if args.key?(:thoroughfare_trailing_type) end end # class RepresentativeInfoData include Google::Apis::Core::Hashable # Political geographic divisions that contain the requested address. # Corresponds to the JSON property `divisions` # @return [Hash] attr_accessor :divisions # Elected offices referenced by the divisions listed above. Will only be present # if includeOffices was true in the request. # Corresponds to the JSON property `offices` # @return [Array] attr_accessor :offices # Officials holding the offices listed above. Will only be present if # includeOffices was true in the request. # Corresponds to the JSON property `officials` # @return [Array] attr_accessor :officials def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @divisions = args[:divisions] if args.key?(:divisions) @offices = args[:offices] if args.key?(:offices) @officials = args[:officials] if args.key?(:officials) end end # A request for political geography and representative information for an # address. class RepresentativeInfoRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `contextParams` # @return [Google::Apis::CivicinfoV2::ContextParams] attr_accessor :context_params def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @context_params = args[:context_params] if args.key?(:context_params) end end # The result of a representative info lookup query. class RepresentativeInfoResponse include Google::Apis::Core::Hashable # Political geographic divisions that contain the requested address. # Corresponds to the JSON property `divisions` # @return [Hash] attr_accessor :divisions # Identifies what kind of resource this is. Value: the fixed string "civicinfo# # representativeInfoResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A simple representation of an address. # Corresponds to the JSON property `normalizedInput` # @return [Google::Apis::CivicinfoV2::SimpleAddressType] attr_accessor :normalized_input # Elected offices referenced by the divisions listed above. Will only be present # if includeOffices was true in the request. # Corresponds to the JSON property `offices` # @return [Array] attr_accessor :offices # Officials holding the offices listed above. Will only be present if # includeOffices was true in the request. # Corresponds to the JSON property `officials` # @return [Array] attr_accessor :officials def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @divisions = args[:divisions] if args.key?(:divisions) @kind = args[:kind] if args.key?(:kind) @normalized_input = args[:normalized_input] if args.key?(:normalized_input) @offices = args[:offices] if args.key?(:offices) @officials = args[:officials] if args.key?(:officials) end end # A simple representation of an address. class SimpleAddressType include Google::Apis::Core::Hashable # The city or town for the address. # Corresponds to the JSON property `city` # @return [String] attr_accessor :city # The street name and number of this address. # Corresponds to the JSON property `line1` # @return [String] attr_accessor :line1 # The second line the address, if needed. # Corresponds to the JSON property `line2` # @return [String] attr_accessor :line2 # The third line of the address, if needed. # Corresponds to the JSON property `line3` # @return [String] attr_accessor :line3 # The name of the location. # Corresponds to the JSON property `locationName` # @return [String] attr_accessor :location_name # The US two letter state abbreviation of the address. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # The US Postal Zip Code of the address. # Corresponds to the JSON property `zip` # @return [String] attr_accessor :zip def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @city = args[:city] if args.key?(:city) @line1 = args[:line1] if args.key?(:line1) @line2 = args[:line2] if args.key?(:line2) @line3 = args[:line3] if args.key?(:line3) @location_name = args[:location_name] if args.key?(:location_name) @state = args[:state] if args.key?(:state) @zip = args[:zip] if args.key?(:zip) end end # Contains information about the data source for the element containing it. class Source include Google::Apis::Core::Hashable # The name of the data source. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether this data comes from an official government source. # Corresponds to the JSON property `official` # @return [Boolean] attr_accessor :official alias_method :official?, :official def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @official = args[:official] if args.key?(:official) end end # A request for information about a voter. class VoterInfoRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `contextParams` # @return [Google::Apis::CivicinfoV2::ContextParams] attr_accessor :context_params # # Corresponds to the JSON property `voterInfoSegmentResult` # @return [Google::Apis::CivicinfoV2::VoterInfoSegmentResult] attr_accessor :voter_info_segment_result def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @context_params = args[:context_params] if args.key?(:context_params) @voter_info_segment_result = args[:voter_info_segment_result] if args.key?(:voter_info_segment_result) end end # The result of a voter info lookup query. class VoterInfoResponse include Google::Apis::Core::Hashable # Contests that will appear on the voter's ballot. # Corresponds to the JSON property `contests` # @return [Array] attr_accessor :contests # Locations where a voter is eligible to drop off a completed ballot. The voter # must have received and completed a ballot prior to arriving at the location. # The location may not have ballots available on the premises. These locations # could be open on or before election day as indicated in the pollingHours field. # Corresponds to the JSON property `dropOffLocations` # @return [Array] attr_accessor :drop_off_locations # Locations where the voter is eligible to vote early, prior to election day. # Corresponds to the JSON property `earlyVoteSites` # @return [Array] attr_accessor :early_vote_sites # Information about the election that was queried. # Corresponds to the JSON property `election` # @return [Google::Apis::CivicinfoV2::Election] attr_accessor :election # Identifies what kind of resource this is. Value: the fixed string "civicinfo# # voterInfoResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Specifies whether voters in the precinct vote only by mailing their ballots ( # with the possible option of dropping off their ballots as well). # Corresponds to the JSON property `mailOnly` # @return [Boolean] attr_accessor :mail_only alias_method :mail_only?, :mail_only # A simple representation of an address. # Corresponds to the JSON property `normalizedInput` # @return [Google::Apis::CivicinfoV2::SimpleAddressType] attr_accessor :normalized_input # If no election ID was specified in the query, and there was more than one # election with data for the given voter, this will contain information about # the other elections that could apply. # Corresponds to the JSON property `otherElections` # @return [Array] attr_accessor :other_elections # Locations where the voter is eligible to vote on election day. # Corresponds to the JSON property `pollingLocations` # @return [Array] attr_accessor :polling_locations # # Corresponds to the JSON property `precinctId` # @return [String] attr_accessor :precinct_id # Local Election Information for the state that the voter votes in. For the US, # there will only be one element in this array. # Corresponds to the JSON property `state` # @return [Array] attr_accessor :state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contests = args[:contests] if args.key?(:contests) @drop_off_locations = args[:drop_off_locations] if args.key?(:drop_off_locations) @early_vote_sites = args[:early_vote_sites] if args.key?(:early_vote_sites) @election = args[:election] if args.key?(:election) @kind = args[:kind] if args.key?(:kind) @mail_only = args[:mail_only] if args.key?(:mail_only) @normalized_input = args[:normalized_input] if args.key?(:normalized_input) @other_elections = args[:other_elections] if args.key?(:other_elections) @polling_locations = args[:polling_locations] if args.key?(:polling_locations) @precinct_id = args[:precinct_id] if args.key?(:precinct_id) @state = args[:state] if args.key?(:state) end end # class VoterInfoSegmentResult include Google::Apis::Core::Hashable # # Corresponds to the JSON property `generatedMillis` # @return [Fixnum] attr_accessor :generated_millis # # Corresponds to the JSON property `postalAddress` # @return [Google::Apis::CivicinfoV2::PostalAddress] attr_accessor :postal_address # A request for information about a voter. # Corresponds to the JSON property `request` # @return [Google::Apis::CivicinfoV2::VoterInfoRequest] attr_accessor :request # The result of a voter info lookup query. # Corresponds to the JSON property `response` # @return [Google::Apis::CivicinfoV2::VoterInfoResponse] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @generated_millis = args[:generated_millis] if args.key?(:generated_millis) @postal_address = args[:postal_address] if args.key?(:postal_address) @request = args[:request] if args.key?(:request) @response = args[:response] if args.key?(:response) end end end end end google-api-client-0.19.8/generated/google/apis/civicinfo_v2/service.rb0000644000004100000410000004312013252673043025660 0ustar www-datawww-data# 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 CivicinfoV2 # Google Civic Information API # # Provides polling places, early vote locations, contest data, election # officials, and government representatives for U.S. residential addresses. # # @example # require 'google/apis/civicinfo_v2' # # Civicinfo = Google::Apis::CivicinfoV2 # Alias the module # service = Civicinfo::CivicInfoService.new # # @see https://developers.google.com/civic-information class CivicInfoService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'civicinfo/v2/') @batch_path = 'batch/civicinfo/v2' end # Searches for political divisions by their natural name or OCD ID. # @param [Google::Apis::CivicinfoV2::DivisionSearchRequest] division_search_request_object # @param [String] query # The search query. Queries can cover any parts of a OCD ID or a human readable # division name. All words given in the query are treated as required patterns. # In addition to that, most query operators of the Apache Lucene library are # supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::CivicinfoV2::SearchDivisionResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CivicinfoV2::SearchDivisionResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_divisions(division_search_request_object = nil, query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'divisions', options) command.request_representation = Google::Apis::CivicinfoV2::DivisionSearchRequest::Representation command.request_object = division_search_request_object command.response_representation = Google::Apis::CivicinfoV2::SearchDivisionResponse::Representation command.response_class = Google::Apis::CivicinfoV2::SearchDivisionResponse command.query['query'] = query unless query.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 of available elections to query. # @param [Google::Apis::CivicinfoV2::ElectionsQueryRequest] elections_query_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::CivicinfoV2::QueryElectionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CivicinfoV2::QueryElectionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_election(elections_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'elections', options) command.request_representation = Google::Apis::CivicinfoV2::ElectionsQueryRequest::Representation command.request_object = elections_query_request_object command.response_representation = Google::Apis::CivicinfoV2::QueryElectionsResponse::Representation command.response_class = Google::Apis::CivicinfoV2::QueryElectionsResponse 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 # Looks up information relevant to a voter based on the voter's registered # address. # @param [String] address # The registered address of the voter to look up. # @param [Google::Apis::CivicinfoV2::VoterInfoRequest] voter_info_request_object # @param [Fixnum] election_id # The unique ID of the election to look up. A list of election IDs can be # obtained at https://www.googleapis.com/civicinfo/`version`/elections # @param [Boolean] official_only # If set to true, only data from official state sources will be returned. # @param [Boolean] return_all_available_data # If set to true, the query will return the success codeand include any partial # information when it is unable to determine a matching address or unable to # determine the election for electionId=0 queries. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::CivicinfoV2::VoterInfoResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CivicinfoV2::VoterInfoResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_voter_info(address, voter_info_request_object = nil, election_id: nil, official_only: nil, return_all_available_data: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'voterinfo', options) command.request_representation = Google::Apis::CivicinfoV2::VoterInfoRequest::Representation command.request_object = voter_info_request_object command.response_representation = Google::Apis::CivicinfoV2::VoterInfoResponse::Representation command.response_class = Google::Apis::CivicinfoV2::VoterInfoResponse command.query['address'] = address unless address.nil? command.query['electionId'] = election_id unless election_id.nil? command.query['officialOnly'] = official_only unless official_only.nil? command.query['returnAllAvailableData'] = return_all_available_data unless return_all_available_data.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 # Looks up political geography and representative information for a single # address. # @param [Google::Apis::CivicinfoV2::RepresentativeInfoRequest] representative_info_request_object # @param [String] address # The address to look up. May only be specified if the field ocdId is not given # in the URL. # @param [Boolean] include_offices # Whether to return information about offices and officials. If false, only the # top-level district information will be returned. # @param [Array, String] levels # A list of office levels to filter by. Only offices that serve at least one of # these levels will be returned. Divisions that don't contain a matching office # will not be returned. # @param [Array, String] roles # A list of office roles to filter by. Only offices fulfilling one of these # roles will be returned. Divisions that don't contain a matching office will # not 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::CivicinfoV2::RepresentativeInfoResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CivicinfoV2::RepresentativeInfoResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def representative_info_by_address(representative_info_request_object = nil, address: nil, include_offices: nil, levels: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'representatives', options) command.request_representation = Google::Apis::CivicinfoV2::RepresentativeInfoRequest::Representation command.request_object = representative_info_request_object command.response_representation = Google::Apis::CivicinfoV2::RepresentativeInfoResponse::Representation command.response_class = Google::Apis::CivicinfoV2::RepresentativeInfoResponse command.query['address'] = address unless address.nil? command.query['includeOffices'] = include_offices unless include_offices.nil? command.query['levels'] = levels unless levels.nil? command.query['roles'] = roles unless roles.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 # Looks up representative information for a single geographic division. # @param [String] ocd_id # The Open Civic Data division identifier of the division to look up. # @param [Google::Apis::CivicinfoV2::DivisionRepresentativeInfoRequest] division_representative_info_request_object # @param [Array, String] levels # A list of office levels to filter by. Only offices that serve at least one of # these levels will be returned. Divisions that don't contain a matching office # will not be returned. # @param [Boolean] recursive # If true, information about all divisions contained in the division requested # will be included as well. For example, if querying ocd-division/country:us/ # district:dc, this would also return all DC's wards and ANCs. # @param [Array, String] roles # A list of office roles to filter by. Only offices fulfilling one of these # roles will be returned. Divisions that don't contain a matching office will # not 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::CivicinfoV2::RepresentativeInfoData] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CivicinfoV2::RepresentativeInfoData] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def representative_info_by_division(ocd_id, division_representative_info_request_object = nil, levels: nil, recursive: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'representatives/{ocdId}', options) command.request_representation = Google::Apis::CivicinfoV2::DivisionRepresentativeInfoRequest::Representation command.request_object = division_representative_info_request_object command.response_representation = Google::Apis::CivicinfoV2::RepresentativeInfoData::Representation command.response_class = Google::Apis::CivicinfoV2::RepresentativeInfoData command.params['ocdId'] = ocd_id unless ocd_id.nil? command.query['levels'] = levels unless levels.nil? command.query['recursive'] = recursive unless recursive.nil? command.query['roles'] = roles unless roles.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 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 end end google-api-client-0.19.8/generated/google/apis/dataproc_v1.rb0000644000004100000410000000217513252673043024050 0ustar www-datawww-data# 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/dataproc_v1/service.rb' require 'google/apis/dataproc_v1/classes.rb' require 'google/apis/dataproc_v1/representations.rb' module Google module Apis # Google Cloud Dataproc API # # Manages Hadoop-based clusters and jobs on Google Cloud Platform. # # @see https://cloud.google.com/dataproc/ module DataprocV1 VERSION = 'V1' REVISION = '20180206' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end google-api-client-0.19.8/generated/google/apis/iam_v1/0000755000004100000410000000000013252673043022467 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/iam_v1/representations.rb0000644000004100000410000004164113252673043026247 0ustar www-datawww-data# 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 IamV1 class AuditConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditLogConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditableService 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 BindingDelta class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateRoleRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateServiceAccountKeyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateServiceAccountRequest 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 ListRolesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListServiceAccountKeysResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListServiceAccountsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Permission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PolicyDelta class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryAuditableServicesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryAuditableServicesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryGrantableRolesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryGrantableRolesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryTestablePermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryTestablePermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Role class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceAccountKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SignBlobRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SignBlobResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SignJwtRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SignJwtResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UndeleteRoleRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::IamV1::AuditLogConfig, decorator: Google::Apis::IamV1::AuditLogConfig::Representation property :service, as: 'service' end end class AuditData # @private class Representation < Google::Apis::Core::JsonRepresentation property :policy_delta, as: 'policyDelta', class: Google::Apis::IamV1::PolicyDelta, decorator: Google::Apis::IamV1::PolicyDelta::Representation end end class AuditLogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exempted_members, as: 'exemptedMembers' property :log_type, as: 'logType' end end class AuditableService # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation collection :members, as: 'members' property :role, as: 'role' end end class BindingDelta # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' property :member, as: 'member' property :role, as: 'role' end end class CreateRoleRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :role, as: 'role', class: Google::Apis::IamV1::Role, decorator: Google::Apis::IamV1::Role::Representation property :role_id, as: 'roleId' end end class CreateServiceAccountKeyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :key_algorithm, as: 'keyAlgorithm' property :private_key_type, as: 'privateKeyType' end end class CreateServiceAccountRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :service_account, as: 'serviceAccount', class: Google::Apis::IamV1::ServiceAccount, decorator: Google::Apis::IamV1::ServiceAccount::Representation end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ListRolesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :roles, as: 'roles', class: Google::Apis::IamV1::Role, decorator: Google::Apis::IamV1::Role::Representation end end class ListServiceAccountKeysResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :keys, as: 'keys', class: Google::Apis::IamV1::ServiceAccountKey, decorator: Google::Apis::IamV1::ServiceAccountKey::Representation end end class ListServiceAccountsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accounts, as: 'accounts', class: Google::Apis::IamV1::ServiceAccount, decorator: Google::Apis::IamV1::ServiceAccount::Representation property :next_page_token, as: 'nextPageToken' end end class Permission # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_disabled, as: 'apiDisabled' property :custom_roles_support_level, as: 'customRolesSupportLevel' property :description, as: 'description' property :name, as: 'name' property :only_in_predefined_roles, as: 'onlyInPredefinedRoles' property :stage, as: 'stage' property :title, as: 'title' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_configs, as: 'auditConfigs', class: Google::Apis::IamV1::AuditConfig, decorator: Google::Apis::IamV1::AuditConfig::Representation collection :bindings, as: 'bindings', class: Google::Apis::IamV1::Binding, decorator: Google::Apis::IamV1::Binding::Representation property :etag, :base64 => true, as: 'etag' property :version, as: 'version' end end class PolicyDelta # @private class Representation < Google::Apis::Core::JsonRepresentation collection :binding_deltas, as: 'bindingDeltas', class: Google::Apis::IamV1::BindingDelta, decorator: Google::Apis::IamV1::BindingDelta::Representation end end class QueryAuditableServicesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :full_resource_name, as: 'fullResourceName' end end class QueryAuditableServicesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :services, as: 'services', class: Google::Apis::IamV1::AuditableService, decorator: Google::Apis::IamV1::AuditableService::Representation end end class QueryGrantableRolesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :full_resource_name, as: 'fullResourceName' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' property :view, as: 'view' end end class QueryGrantableRolesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :roles, as: 'roles', class: Google::Apis::IamV1::Role, decorator: Google::Apis::IamV1::Role::Representation end end class QueryTestablePermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :full_resource_name, as: 'fullResourceName' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' end end class QueryTestablePermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :permissions, as: 'permissions', class: Google::Apis::IamV1::Permission, decorator: Google::Apis::IamV1::Permission::Representation end end class Role # @private class Representation < Google::Apis::Core::JsonRepresentation property :deleted, as: 'deleted' property :description, as: 'description' property :etag, :base64 => true, as: 'etag' collection :included_permissions, as: 'includedPermissions' property :name, as: 'name' property :stage, as: 'stage' property :title, as: 'title' end end class ServiceAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :email, as: 'email' property :etag, :base64 => true, as: 'etag' property :name, as: 'name' property :oauth2_client_id, as: 'oauth2ClientId' property :project_id, as: 'projectId' property :unique_id, as: 'uniqueId' end end class ServiceAccountKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :key_algorithm, as: 'keyAlgorithm' property :name, as: 'name' property :private_key_data, :base64 => true, as: 'privateKeyData' property :private_key_type, as: 'privateKeyType' property :public_key_data, :base64 => true, as: 'publicKeyData' property :valid_after_time, as: 'validAfterTime' property :valid_before_time, as: 'validBeforeTime' end end class SetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :policy, as: 'policy', class: Google::Apis::IamV1::Policy, decorator: Google::Apis::IamV1::Policy::Representation property :update_mask, as: 'updateMask' end end class SignBlobRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :bytes_to_sign, :base64 => true, as: 'bytesToSign' end end class SignBlobResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :key_id, as: 'keyId' property :signature, :base64 => true, as: 'signature' end end class SignJwtRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :payload, as: 'payload' end end class SignJwtResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :key_id, as: 'keyId' property :signed_jwt, as: 'signedJwt' end end class TestIamPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestIamPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class UndeleteRoleRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, :base64 => true, as: 'etag' end end end end end google-api-client-0.19.8/generated/google/apis/iam_v1/classes.rb0000644000004100000410000012736513252673043024467 0ustar www-datawww-data# 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 IamV1 # 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:foo@gmail.com" # ] # `, # ` # "log_type": "DATA_WRITE", # `, # ` # "log_type": "ADMIN_READ", # ` # ] # `, # ` # "service": "fooservice.googleapis.com" # "audit_log_configs": [ # ` # "log_type": "DATA_READ", # `, # ` # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:bar@gmail.com" # ] # ` # ] # ` # ] # ` # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and # bar@gmail.com from DATA_WRITE logging. class AuditConfig include Google::Apis::Core::Hashable # The configuration for logging of each type of permission. # Next ID: 4 # 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 # Audit log information specific to Cloud IAM. This message is serialized # as an `Any` type in the `ServiceData` message of an # `AuditLog` message. class AuditData include Google::Apis::Core::Hashable # The difference delta between two policies. # Corresponds to the JSON property `policyDelta` # @return [Google::Apis::IamV1::PolicyDelta] attr_accessor :policy_delta def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @policy_delta = args[:policy_delta] if args.key?(:policy_delta) end end # Provides the configuration for logging a type of permissions. # Example: # ` # "audit_log_configs": [ # ` # "log_type": "DATA_READ", # "exempted_members": [ # "user:foo@gmail.com" # ] # `, # ` # "log_type": "DATA_WRITE", # ` # ] # ` # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # foo@gmail.com from DATA_READ logging. class AuditLogConfig include Google::Apis::Core::Hashable # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. # Corresponds to the JSON property `exemptedMembers` # @return [Array] 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 # Contains information about an auditable service. class AuditableService include Google::Apis::Core::Hashable # Public name of the service. # For example, the service name for Cloud IAM is 'iam.googleapis.com'. # 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 # Associates `members` with a `role`. class Binding include Google::Apis::Core::Hashable # 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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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`. # Required # 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) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end # One delta entry for Binding. Each individual change (only one member in each # entry) to a binding will be a separate entry. class BindingDelta include Google::Apis::Core::Hashable # The action that was performed on a Binding. # Required # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # A single identity requesting access for a Cloud Platform resource. # Follows the same format of Binding.members. # Required # Corresponds to the JSON property `member` # @return [String] attr_accessor :member # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. # Required # 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) @action = args[:action] if args.key?(:action) @member = args[:member] if args.key?(:member) @role = args[:role] if args.key?(:role) end end # The request to create a new role. class CreateRoleRequest include Google::Apis::Core::Hashable # A role in the Identity and Access Management API. # Corresponds to the JSON property `role` # @return [Google::Apis::IamV1::Role] attr_accessor :role # The role id to use for this role. # Corresponds to the JSON property `roleId` # @return [String] attr_accessor :role_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @role = args[:role] if args.key?(:role) @role_id = args[:role_id] if args.key?(:role_id) end end # The service account key create request. class CreateServiceAccountKeyRequest include Google::Apis::Core::Hashable # Which type of key and algorithm to use for the key. # The default is currently a 2K RSA key. However this may change in the # future. # Corresponds to the JSON property `keyAlgorithm` # @return [String] attr_accessor :key_algorithm # The output format of the private key. The default value is # `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File # format. # Corresponds to the JSON property `privateKeyType` # @return [String] attr_accessor :private_key_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key_algorithm = args[:key_algorithm] if args.key?(:key_algorithm) @private_key_type = args[:private_key_type] if args.key?(:private_key_type) end end # The service account create request. class CreateServiceAccountRequest include Google::Apis::Core::Hashable # Required. The account id that is used to generate the service account # email address and a stable unique id. It is unique within a project, # must be 6-30 characters long, and match the regular expression # `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # A service account in the Identity and Access Management API. # To create a service account, specify the `project_id` and the `account_id` # for the account. The `account_id` is unique within the project, and is used # to generate the service account email address and a stable # `unique_id`. # If the account already exists, the account's resource name is returned # in the format of projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`. The caller # can use the name in other methods to access the account. # All other methods can identify the service account using the format # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from # the account. The `ACCOUNT` value can be the `email` address or the # `unique_id` of the service account. # Corresponds to the JSON property `serviceAccount` # @return [Google::Apis::IamV1::ServiceAccount] attr_accessor :service_account def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @service_account = args[:service_account] if args.key?(:service_account) 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 # The response containing the roles defined under a resource. class ListRolesResponse include Google::Apis::Core::Hashable # To retrieve the next page of results, set # `ListRolesRequest.page_token` to this value. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The Roles defined on this resource. # 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) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @roles = args[:roles] if args.key?(:roles) end end # The service account keys list response. class ListServiceAccountKeysResponse include Google::Apis::Core::Hashable # The public keys for the service account. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @keys = args[:keys] if args.key?(:keys) end end # The service account list response. class ListServiceAccountsResponse include Google::Apis::Core::Hashable # The list of matching service accounts. # Corresponds to the JSON property `accounts` # @return [Array] attr_accessor :accounts # To retrieve the next page of results, set # ListServiceAccountsRequest.page_token # to this value. # 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) @accounts = args[:accounts] if args.key?(:accounts) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # A permission which can be included by a role. class Permission include Google::Apis::Core::Hashable # The service API associated with the permission is not enabled. # Corresponds to the JSON property `apiDisabled` # @return [Boolean] attr_accessor :api_disabled alias_method :api_disabled?, :api_disabled # The current custom role support level. # Corresponds to the JSON property `customRolesSupportLevel` # @return [String] attr_accessor :custom_roles_support_level # A brief description of what this Permission is used for. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The name of this Permission. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # This permission can ONLY be used in predefined roles. # Corresponds to the JSON property `onlyInPredefinedRoles` # @return [Boolean] attr_accessor :only_in_predefined_roles alias_method :only_in_predefined_roles?, :only_in_predefined_roles # The current launch stage of the permission. # Corresponds to the JSON property `stage` # @return [String] attr_accessor :stage # The title of this Permission. # 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) @api_disabled = args[:api_disabled] if args.key?(:api_disabled) @custom_roles_support_level = args[:custom_roles_support_level] if args.key?(:custom_roles_support_level) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @only_in_predefined_roles = args[:only_in_predefined_roles] if args.key?(:only_in_predefined_roles) @stage = args[:stage] if args.key?(:stage) @title = args[:title] if args.key?(:title) end end # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). class Policy include Google::Apis::Core::Hashable # Specifies cloud audit logging configuration for this policy. # Corresponds to the JSON property `auditConfigs` # @return [Array] attr_accessor :audit_configs # Associates a list of `members` to a `role`. # `bindings` with no members will result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # Deprecated. # 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 # The difference delta between two policies. class PolicyDelta include Google::Apis::Core::Hashable # The delta for Bindings between two policies. # Corresponds to the JSON property `bindingDeltas` # @return [Array] attr_accessor :binding_deltas def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @binding_deltas = args[:binding_deltas] if args.key?(:binding_deltas) end end # A request to get the list of auditable services for a resource. class QueryAuditableServicesRequest include Google::Apis::Core::Hashable # Required. The full resource name to query from the list of auditable # services. # The name follows the Google Cloud Platform resource format. # For example, a Cloud Platform project with id `my-project` will be named # `//cloudresourcemanager.googleapis.com/projects/my-project`. # 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 # A response containing a list of auditable services for a resource. class QueryAuditableServicesResponse include Google::Apis::Core::Hashable # The auditable services for a resource. # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @services = args[:services] if args.key?(:services) end end # The grantable role query request. class QueryGrantableRolesRequest include Google::Apis::Core::Hashable # Required. The full resource name to query from the list of grantable roles. # The name follows the Google Cloud Platform resource format. # For example, a Cloud Platform project with id `my-project` will be named # `//cloudresourcemanager.googleapis.com/projects/my-project`. # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name # Optional limit on the number of roles to include in the response. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # Optional pagination token returned in an earlier # QueryGrantableRolesResponse. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token # # Corresponds to the JSON property `view` # @return [String] attr_accessor :view 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) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @view = args[:view] if args.key?(:view) end end # The grantable role query response. class QueryGrantableRolesResponse include Google::Apis::Core::Hashable # To retrieve the next page of results, set # `QueryGrantableRolesRequest.page_token` to this value. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of matching roles. # 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) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @roles = args[:roles] if args.key?(:roles) end end # A request to get permissions which can be tested on a resource. class QueryTestablePermissionsRequest include Google::Apis::Core::Hashable # Required. The full resource name to query from the list of testable # permissions. # The name follows the Google Cloud Platform resource format. # For example, a Cloud Platform project with id `my-project` will be named # `//cloudresourcemanager.googleapis.com/projects/my-project`. # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name # Optional limit on the number of permissions to include in the response. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # Optional pagination token returned in an earlier # QueryTestablePermissionsRequest. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token 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) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) end end # The response containing permissions which can be tested on a resource. class QueryTestablePermissionsResponse include Google::Apis::Core::Hashable # To retrieve the next page of results, set # `QueryTestableRolesRequest.page_token` to this value. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The Permissions testable on the requested resource. # 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) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @permissions = args[:permissions] if args.key?(:permissions) end end # A role in the Identity and Access Management API. class Role include Google::Apis::Core::Hashable # The current deleted state of the role. This field is read only. # It will be ignored in calls to CreateRole and UpdateRole. # Corresponds to the JSON property `deleted` # @return [Boolean] attr_accessor :deleted alias_method :deleted?, :deleted # Optional. A human-readable description for the role. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Used to perform a consistent read-modify-write. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # The names of the permissions this role grants when bound in an IAM policy. # Corresponds to the JSON property `includedPermissions` # @return [Array] attr_accessor :included_permissions # The name of the role. # When Role is used in CreateRole, the role name must not be set. # When Role is used in output and other input such as UpdateRole, the role # name is the complete path, e.g., roles/logging.viewer for curated roles # and organizations/`ORGANIZATION_ID`/roles/logging.viewer for custom roles. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The current launch stage of the role. # Corresponds to the JSON property `stage` # @return [String] attr_accessor :stage # Optional. A human-readable title for the role. Typically this # is limited to 100 UTF-8 bytes. # 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) @deleted = args[:deleted] if args.key?(:deleted) @description = args[:description] if args.key?(:description) @etag = args[:etag] if args.key?(:etag) @included_permissions = args[:included_permissions] if args.key?(:included_permissions) @name = args[:name] if args.key?(:name) @stage = args[:stage] if args.key?(:stage) @title = args[:title] if args.key?(:title) end end # A service account in the Identity and Access Management API. # To create a service account, specify the `project_id` and the `account_id` # for the account. The `account_id` is unique within the project, and is used # to generate the service account email address and a stable # `unique_id`. # If the account already exists, the account's resource name is returned # in the format of projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`. The caller # can use the name in other methods to access the account. # All other methods can identify the service account using the format # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from # the account. The `ACCOUNT` value can be the `email` address or the # `unique_id` of the service account. class ServiceAccount include Google::Apis::Core::Hashable # Optional. A user-specified description of the service account. Must be # fewer than 100 UTF-8 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # @OutputOnly The email address of the service account. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # Used to perform a consistent read-modify-write. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # The resource name of the service account in the following format: # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Requests using `-` as a wildcard for the `PROJECT_ID` will infer the # project from the `account` and the `ACCOUNT` value can be the `email` # address or the `unique_id` of the service account. # In responses the resource name will always be in the format # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # @OutputOnly The OAuth2 client id for the service account. # This is used in conjunction with the OAuth2 clientconfig API to make # three legged OAuth2 (3LO) flows to access the data of Google users. # Corresponds to the JSON property `oauth2ClientId` # @return [String] attr_accessor :oauth2_client_id # @OutputOnly The id of the project that owns the service account. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # @OutputOnly The unique and stable id of the service account. # Corresponds to the JSON property `uniqueId` # @return [String] attr_accessor :unique_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) @email = args[:email] if args.key?(:email) @etag = args[:etag] if args.key?(:etag) @name = args[:name] if args.key?(:name) @oauth2_client_id = args[:oauth2_client_id] if args.key?(:oauth2_client_id) @project_id = args[:project_id] if args.key?(:project_id) @unique_id = args[:unique_id] if args.key?(:unique_id) end end # Represents a service account key. # A service account has two sets of key-pairs: user-managed, and # system-managed. # User-managed key-pairs can be created and deleted by users. Users are # responsible for rotating these keys periodically to ensure security of # their service accounts. Users retain the private key of these key-pairs, # and Google retains ONLY the public key. # System-managed key-pairs are managed automatically by Google, and rotated # daily without user intervention. The private key never leaves Google's # servers to maximize security. # Public keys for all service accounts are also published at the OAuth2 # Service Account API. class ServiceAccountKey include Google::Apis::Core::Hashable # Specifies the algorithm (and possibly key size) for the key. # Corresponds to the JSON property `keyAlgorithm` # @return [String] attr_accessor :key_algorithm # The resource name of the service account key in the following format # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/`key``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The private key data. Only provided in `CreateServiceAccountKey` # responses. Make sure to keep the private key data secure because it # allows for the assertion of the service account identity. # When decoded, the private key data can be used to authenticate with # Google API client libraries and with # gcloud # auth activate-service-account. # Corresponds to the JSON property `privateKeyData` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :private_key_data # The output format for the private key. # Only provided in `CreateServiceAccountKey` responses, not # in `GetServiceAccountKey` or `ListServiceAccountKey` responses. # Google never exposes system-managed private keys, and never retains # user-managed private keys. # Corresponds to the JSON property `privateKeyType` # @return [String] attr_accessor :private_key_type # The public key data. Only provided in `GetServiceAccountKey` responses. # Corresponds to the JSON property `publicKeyData` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :public_key_data # The key can be used after this timestamp. # Corresponds to the JSON property `validAfterTime` # @return [String] attr_accessor :valid_after_time # The key can be used before this timestamp. # Corresponds to the JSON property `validBeforeTime` # @return [String] attr_accessor :valid_before_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key_algorithm = args[:key_algorithm] if args.key?(:key_algorithm) @name = args[:name] if args.key?(:name) @private_key_data = args[:private_key_data] if args.key?(:private_key_data) @private_key_type = args[:private_key_type] if args.key?(:private_key_type) @public_key_data = args[:public_key_data] if args.key?(:public_key_data) @valid_after_time = args[:valid_after_time] if args.key?(:valid_after_time) @valid_before_time = args[:valid_before_time] if args.key?(:valid_before_time) end end # Request message for `SetIamPolicy` method. class SetIamPolicyRequest include Google::Apis::Core::Hashable # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). # Corresponds to the JSON property `policy` # @return [Google::Apis::IamV1::Policy] attr_accessor :policy # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: # paths: "bindings, etag" # This field is only used by Cloud IAM. # 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 # The service account sign blob request. class SignBlobRequest include Google::Apis::Core::Hashable # The bytes to sign. # Corresponds to the JSON property `bytesToSign` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :bytes_to_sign def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bytes_to_sign = args[:bytes_to_sign] if args.key?(:bytes_to_sign) end end # The service account sign blob response. class SignBlobResponse include Google::Apis::Core::Hashable # The id of the key used to sign the blob. # Corresponds to the JSON property `keyId` # @return [String] attr_accessor :key_id # The signed blob. # Corresponds to the JSON property `signature` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :signature def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key_id = args[:key_id] if args.key?(:key_id) @signature = args[:signature] if args.key?(:signature) end end # The service account sign JWT request. class SignJwtRequest include Google::Apis::Core::Hashable # The JWT payload to sign, a JSON JWT Claim set. # Corresponds to the JSON property `payload` # @return [String] attr_accessor :payload def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @payload = args[:payload] if args.key?(:payload) end end # The service account sign JWT response. class SignJwtResponse include Google::Apis::Core::Hashable # The id of the key used to sign the JWT. # Corresponds to the JSON property `keyId` # @return [String] attr_accessor :key_id # The signed JWT. # Corresponds to the JSON property `signedJwt` # @return [String] attr_accessor :signed_jwt def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key_id = args[:key_id] if args.key?(:key_id) @signed_jwt = args[:signed_jwt] if args.key?(:signed_jwt) end end # Request message for `TestIamPermissions` method. class TestIamPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the `resource`. Permissions with # wildcards (such as '*' or 'storage.*') are not allowed. For more # information see # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permissions = args[:permissions] if args.key?(:permissions) end end # Response message for `TestIamPermissions` method. class TestIamPermissionsResponse include Google::Apis::Core::Hashable # A subset of `TestPermissionsRequest.permissions` that the caller is # allowed. # Corresponds to the JSON property `permissions` # @return [Array] 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 request to undelete an existing role. class UndeleteRoleRequest include Google::Apis::Core::Hashable # Used to perform a consistent read-modify-write. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) end end end end end google-api-client-0.19.8/generated/google/apis/iam_v1/service.rb0000644000004100000410000021546113252673043024465 0ustar www-datawww-data# 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 IamV1 # Google Identity and Access Management (IAM) API # # Manages identity and access control for Google Cloud Platform resources, # including the creation of service accounts, which you can use to authenticate # to Google and make API calls. # # @example # require 'google/apis/iam_v1' # # Iam = Google::Apis::IamV1 # Alias the module # service = Iam::IamService.new # # @see https://cloud.google.com/iam/ class IamService < 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://iam.googleapis.com/', '') @batch_path = 'batch' end # Returns a list of services that support service level audit logging # configuration for the given resource. # @param [Google::Apis::IamV1::QueryAuditableServicesRequest] query_auditable_services_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::IamV1::QueryAuditableServicesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::QueryAuditableServicesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_iam_policy_auditable_services(query_auditable_services_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/iamPolicies:queryAuditableServices', options) command.request_representation = Google::Apis::IamV1::QueryAuditableServicesRequest::Representation command.request_object = query_auditable_services_request_object command.response_representation = Google::Apis::IamV1::QueryAuditableServicesResponse::Representation command.response_class = Google::Apis::IamV1::QueryAuditableServicesResponse 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 Role. # @param [String] parent # The resource name of the parent resource in one of the following formats: # `organizations/`ORGANIZATION_ID`` # `projects/`PROJECT_ID`` # @param [Google::Apis::IamV1::CreateRoleRequest] create_role_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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_role(parent, create_role_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/roles', options) command.request_representation = Google::Apis::IamV1::CreateRoleRequest::Representation command.request_object = create_role_request_object command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role 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 # Soft deletes a role. The role is suspended and cannot be used to create new # IAM Policy Bindings. # The Role will not be included in `ListRoles()` unless `show_deleted` is set # in the `ListRolesRequest`. The Role contains the deleted boolean set. # Existing Bindings remains, but are inactive. The Role can be undeleted # within 7 days. After 7 days the Role is deleted and all Bindings associated # with the role are removed. # @param [String] name # The resource name of the role in one of the following formats: # `organizations/`ORGANIZATION_ID`/roles/`ROLE_NAME`` # `projects/`PROJECT_ID`/roles/`ROLE_NAME`` # @param [String] etag # Used to perform a consistent read-modify-write. # @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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_role(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role command.params['name'] = name unless name.nil? command.query['etag'] = etag unless etag.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 Role definition. # @param [String] name # The resource name of the role in one of the following formats: # `roles/`ROLE_NAME`` # `organizations/`ORGANIZATION_ID`/roles/`ROLE_NAME`` # `projects/`PROJECT_ID`/roles/`ROLE_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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_role(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role 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 Roles defined on a resource. # @param [String] parent # The resource name of the parent resource in one of the following formats: # `` (empty string) -- this refers to curated roles. # `organizations/`ORGANIZATION_ID`` # `projects/`PROJECT_ID`` # @param [Fixnum] page_size # Optional limit on the number of roles to include in the response. # @param [String] page_token # Optional pagination token returned in an earlier ListRolesResponse. # @param [Boolean] show_deleted # Include Roles that have been deleted. # @param [String] view # Optional view for the returned Role objects. # @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::IamV1::ListRolesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::ListRolesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_roles(parent, page_size: nil, page_token: nil, show_deleted: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/roles', options) command.response_representation = Google::Apis::IamV1::ListRolesResponse::Representation command.response_class = Google::Apis::IamV1::ListRolesResponse 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['showDeleted'] = show_deleted unless show_deleted.nil? command.query['view'] = view unless view.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 Role definition. # @param [String] name # The resource name of the role in one of the following formats: # `roles/`ROLE_NAME`` # `organizations/`ORGANIZATION_ID`/roles/`ROLE_NAME`` # `projects/`PROJECT_ID`/roles/`ROLE_NAME`` # @param [Google::Apis::IamV1::Role] role_object # @param [String] update_mask # A mask describing which fields in the Role have changed. # @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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_organization_role(name, role_object = 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::IamV1::Role::Representation command.request_object = role_object command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role 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 # Undelete a Role, bringing it back in its previous state. # @param [String] name # The resource name of the role in one of the following formats: # `organizations/`ORGANIZATION_ID`/roles/`ROLE_NAME`` # `projects/`PROJECT_ID`/roles/`ROLE_NAME`` # @param [Google::Apis::IamV1::UndeleteRoleRequest] undelete_role_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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def undelete_organization_role(name, undelete_role_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:undelete', options) command.request_representation = Google::Apis::IamV1::UndeleteRoleRequest::Representation command.request_object = undelete_role_request_object command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role 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 permissions testable on a resource. # A permission is testable if it can be tested for an identity on a resource. # @param [Google::Apis::IamV1::QueryTestablePermissionsRequest] query_testable_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::IamV1::QueryTestablePermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::QueryTestablePermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_testable_permissions(query_testable_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/permissions:queryTestablePermissions', options) command.request_representation = Google::Apis::IamV1::QueryTestablePermissionsRequest::Representation command.request_object = query_testable_permissions_request_object command.response_representation = Google::Apis::IamV1::QueryTestablePermissionsResponse::Representation command.response_class = Google::Apis::IamV1::QueryTestablePermissionsResponse 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 Role. # @param [String] parent # The resource name of the parent resource in one of the following formats: # `organizations/`ORGANIZATION_ID`` # `projects/`PROJECT_ID`` # @param [Google::Apis::IamV1::CreateRoleRequest] create_role_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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_role(parent, create_role_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/roles', options) command.request_representation = Google::Apis::IamV1::CreateRoleRequest::Representation command.request_object = create_role_request_object command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role 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 # Soft deletes a role. The role is suspended and cannot be used to create new # IAM Policy Bindings. # The Role will not be included in `ListRoles()` unless `show_deleted` is set # in the `ListRolesRequest`. The Role contains the deleted boolean set. # Existing Bindings remains, but are inactive. The Role can be undeleted # within 7 days. After 7 days the Role is deleted and all Bindings associated # with the role are removed. # @param [String] name # The resource name of the role in one of the following formats: # `organizations/`ORGANIZATION_ID`/roles/`ROLE_NAME`` # `projects/`PROJECT_ID`/roles/`ROLE_NAME`` # @param [String] etag # Used to perform a consistent read-modify-write. # @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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_role(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role command.params['name'] = name unless name.nil? command.query['etag'] = etag unless etag.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 Role definition. # @param [String] name # The resource name of the role in one of the following formats: # `roles/`ROLE_NAME`` # `organizations/`ORGANIZATION_ID`/roles/`ROLE_NAME`` # `projects/`PROJECT_ID`/roles/`ROLE_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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_role(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role 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 Roles defined on a resource. # @param [String] parent # The resource name of the parent resource in one of the following formats: # `` (empty string) -- this refers to curated roles. # `organizations/`ORGANIZATION_ID`` # `projects/`PROJECT_ID`` # @param [Fixnum] page_size # Optional limit on the number of roles to include in the response. # @param [String] page_token # Optional pagination token returned in an earlier ListRolesResponse. # @param [Boolean] show_deleted # Include Roles that have been deleted. # @param [String] view # Optional view for the returned Role objects. # @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::IamV1::ListRolesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::ListRolesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_roles(parent, page_size: nil, page_token: nil, show_deleted: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/roles', options) command.response_representation = Google::Apis::IamV1::ListRolesResponse::Representation command.response_class = Google::Apis::IamV1::ListRolesResponse 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['showDeleted'] = show_deleted unless show_deleted.nil? command.query['view'] = view unless view.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 Role definition. # @param [String] name # The resource name of the role in one of the following formats: # `roles/`ROLE_NAME`` # `organizations/`ORGANIZATION_ID`/roles/`ROLE_NAME`` # `projects/`PROJECT_ID`/roles/`ROLE_NAME`` # @param [Google::Apis::IamV1::Role] role_object # @param [String] update_mask # A mask describing which fields in the Role have changed. # @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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_role(name, role_object = 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::IamV1::Role::Representation command.request_object = role_object command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role 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 # Undelete a Role, bringing it back in its previous state. # @param [String] name # The resource name of the role in one of the following formats: # `organizations/`ORGANIZATION_ID`/roles/`ROLE_NAME`` # `projects/`PROJECT_ID`/roles/`ROLE_NAME`` # @param [Google::Apis::IamV1::UndeleteRoleRequest] undelete_role_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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def undelete_project_role(name, undelete_role_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:undelete', options) command.request_representation = Google::Apis::IamV1::UndeleteRoleRequest::Representation command.request_object = undelete_role_request_object command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role 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 ServiceAccount # and returns it. # @param [String] name # Required. The resource name of the project associated with the service # accounts, such as `projects/my-project-123`. # @param [Google::Apis::IamV1::CreateServiceAccountRequest] create_service_account_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::IamV1::ServiceAccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::ServiceAccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_service_account(name, create_service_account_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}/serviceAccounts', options) command.request_representation = Google::Apis::IamV1::CreateServiceAccountRequest::Representation command.request_object = create_service_account_request_object command.response_representation = Google::Apis::IamV1::ServiceAccount::Representation command.response_class = Google::Apis::IamV1::ServiceAccount 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 ServiceAccount. # @param [String] name # The resource name of the service account in the following format: # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from # the account. The `ACCOUNT` value can be the `email` address or the # `unique_id` of the service account. # @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::IamV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::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_service_account(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::IamV1::Empty::Representation command.response_class = Google::Apis::IamV1::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 ServiceAccount. # @param [String] name # The resource name of the service account in the following format: # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from # the account. The `ACCOUNT` value can be the `email` address or the # `unique_id` of the service account. # @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::IamV1::ServiceAccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::ServiceAccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_service_account(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::IamV1::ServiceAccount::Representation command.response_class = Google::Apis::IamV1::ServiceAccount 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 IAM access control policy for a # ServiceAccount. # @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 [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::IamV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::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_project_service_account_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options) command.response_representation = Google::Apis::IamV1::Policy::Representation command.response_class = Google::Apis::IamV1::Policy 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 # Lists ServiceAccounts for a project. # @param [String] name # Required. The resource name of the project associated with the service # accounts, such as `projects/my-project-123`. # @param [Fixnum] page_size # Optional limit on the number of service accounts to include in the # response. Further accounts can subsequently be obtained by including the # ListServiceAccountsResponse.next_page_token # in a subsequent request. # @param [String] page_token # Optional pagination token returned in an earlier # ListServiceAccountsResponse.next_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::IamV1::ListServiceAccountsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::ListServiceAccountsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_service_accounts(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/serviceAccounts', options) command.response_representation = Google::Apis::IamV1::ListServiceAccountsResponse::Representation command.response_class = Google::Apis::IamV1::ListServiceAccountsResponse command.params['name'] = name unless 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 # Sets the IAM access control policy for a # ServiceAccount. # @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::IamV1::SetIamPolicyRequest] 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::IamV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::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_account_iam_policy(resource, 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::IamV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::IamV1::Policy::Representation command.response_class = Google::Apis::IamV1::Policy 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 # Signs a blob using a service account's system-managed private key. # @param [String] name # The resource name of the service account in the following format: # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from # the account. The `ACCOUNT` value can be the `email` address or the # `unique_id` of the service account. # @param [Google::Apis::IamV1::SignBlobRequest] sign_blob_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::IamV1::SignBlobResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::SignBlobResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def sign_service_account_blob(name, sign_blob_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:signBlob', options) command.request_representation = Google::Apis::IamV1::SignBlobRequest::Representation command.request_object = sign_blob_request_object command.response_representation = Google::Apis::IamV1::SignBlobResponse::Representation command.response_class = Google::Apis::IamV1::SignBlobResponse 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 # Signs a JWT using a service account's system-managed private key. # If no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an # an expiry time of one hour by default. If you request an expiry time of # more than one hour, the request will fail. # @param [String] name # The resource name of the service account in the following format: # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from # the account. The `ACCOUNT` value can be the `email` address or the # `unique_id` of the service account. # @param [Google::Apis::IamV1::SignJwtRequest] sign_jwt_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::IamV1::SignJwtResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::SignJwtResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def sign_service_account_jwt(name, sign_jwt_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:signJwt', options) command.request_representation = Google::Apis::IamV1::SignJwtRequest::Representation command.request_object = sign_jwt_request_object command.response_representation = Google::Apis::IamV1::SignJwtResponse::Representation command.response_class = Google::Apis::IamV1::SignJwtResponse 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 # Tests the specified permissions against the IAM access control policy # for a ServiceAccount. # @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::IamV1::TestIamPermissionsRequest] 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::IamV1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_iam_permissions(resource, 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::IamV1::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::IamV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::IamV1::TestIamPermissionsResponse 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 # Updates a ServiceAccount. # Currently, only the following fields are updatable: # `display_name` . # The `etag` is mandatory. # @param [String] name # The resource name of the service account in the following format: # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Requests using `-` as a wildcard for the `PROJECT_ID` will infer the # project from the `account` and the `ACCOUNT` value can be the `email` # address or the `unique_id` of the service account. # In responses the resource name will always be in the format # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # @param [Google::Apis::IamV1::ServiceAccount] service_account_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::IamV1::ServiceAccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::ServiceAccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_service_account(name, service_account_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/{+name}', options) command.request_representation = Google::Apis::IamV1::ServiceAccount::Representation command.request_object = service_account_object command.response_representation = Google::Apis::IamV1::ServiceAccount::Representation command.response_class = Google::Apis::IamV1::ServiceAccount 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 ServiceAccountKey # and returns it. # @param [String] name # The resource name of the service account in the following format: # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from # the account. The `ACCOUNT` value can be the `email` address or the # `unique_id` of the service account. # @param [Google::Apis::IamV1::CreateServiceAccountKeyRequest] create_service_account_key_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::IamV1::ServiceAccountKey] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::ServiceAccountKey] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_service_account_key(name, create_service_account_key_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}/keys', options) command.request_representation = Google::Apis::IamV1::CreateServiceAccountKeyRequest::Representation command.request_object = create_service_account_key_request_object command.response_representation = Google::Apis::IamV1::ServiceAccountKey::Representation command.response_class = Google::Apis::IamV1::ServiceAccountKey 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 ServiceAccountKey. # @param [String] name # The resource name of the service account key in the following format: # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/`key``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from # the account. The `ACCOUNT` value can be the `email` address or the # `unique_id` of the service account. # @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::IamV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::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_service_account_key(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::IamV1::Empty::Representation command.response_class = Google::Apis::IamV1::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 the ServiceAccountKey # by key id. # @param [String] name # The resource name of the service account key in the following format: # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/`key``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from # the account. The `ACCOUNT` value can be the `email` address or the # `unique_id` of the service account. # @param [String] public_key_type # The output format of the public key requested. # X509_PEM is the default output format. # @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::IamV1::ServiceAccountKey] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::ServiceAccountKey] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_service_account_key(name, public_key_type: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::IamV1::ServiceAccountKey::Representation command.response_class = Google::Apis::IamV1::ServiceAccountKey command.params['name'] = name unless name.nil? command.query['publicKeyType'] = public_key_type unless public_key_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 ServiceAccountKeys. # @param [String] name # The resource name of the service account in the following format: # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Using `-` as a wildcard for the `PROJECT_ID`, will infer the project from # the account. The `ACCOUNT` value can be the `email` address or the # `unique_id` of the service account. # @param [Array, String] key_types # Filters the types of keys the user wants to include in the list # response. Duplicate key types are not allowed. If no key type # is provided, all keys are 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::IamV1::ListServiceAccountKeysResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::ListServiceAccountKeysResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_service_account_keys(name, key_types: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/keys', options) command.response_representation = Google::Apis::IamV1::ListServiceAccountKeysResponse::Representation command.response_class = Google::Apis::IamV1::ListServiceAccountKeysResponse command.params['name'] = name unless name.nil? command.query['keyTypes'] = key_types unless key_types.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 Role definition. # @param [String] name # The resource name of the role in one of the following formats: # `roles/`ROLE_NAME`` # `organizations/`ORGANIZATION_ID`/roles/`ROLE_NAME`` # `projects/`PROJECT_ID`/roles/`ROLE_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::IamV1::Role] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::Role] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_role(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::IamV1::Role::Representation command.response_class = Google::Apis::IamV1::Role 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 Roles defined on a resource. # @param [Fixnum] page_size # Optional limit on the number of roles to include in the response. # @param [String] page_token # Optional pagination token returned in an earlier ListRolesResponse. # @param [String] parent # The resource name of the parent resource in one of the following formats: # `` (empty string) -- this refers to curated roles. # `organizations/`ORGANIZATION_ID`` # `projects/`PROJECT_ID`` # @param [Boolean] show_deleted # Include Roles that have been deleted. # @param [String] view # Optional view for the returned Role objects. # @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::IamV1::ListRolesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::ListRolesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_roles(page_size: nil, page_token: nil, parent: nil, show_deleted: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/roles', options) command.response_representation = Google::Apis::IamV1::ListRolesResponse::Representation command.response_class = Google::Apis::IamV1::ListRolesResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parent'] = parent unless parent.nil? command.query['showDeleted'] = show_deleted unless show_deleted.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Queries roles that can be granted on a particular resource. # A role is grantable if it can be used as the role in a binding for a policy # for that resource. # @param [Google::Apis::IamV1::QueryGrantableRolesRequest] query_grantable_roles_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::IamV1::QueryGrantableRolesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IamV1::QueryGrantableRolesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_grantable_roles(query_grantable_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/roles:queryGrantableRoles', options) command.request_representation = Google::Apis::IamV1::QueryGrantableRolesRequest::Representation command.request_object = query_grantable_roles_request_object command.response_representation = Google::Apis::IamV1::QueryGrantableRolesResponse::Representation command.response_class = Google::Apis::IamV1::QueryGrantableRolesResponse 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 google-api-client-0.19.8/generated/google/apis/cloudresourcemanager_v2beta1/0000755000004100000410000000000013252673043027050 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/cloudresourcemanager_v2beta1/representations.rb0000644000004100000410000002367713252673043032641 0ustar www-datawww-data# 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 CloudresourcemanagerV2beta1 class AuditConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditLogConfig 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 Folder class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FolderOperation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FolderOperationError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListFoldersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MoveFolderRequest 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 Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectCreationStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchFoldersRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchFoldersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetIamPolicyRequest 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 TestIamPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UndeleteFolderRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::CloudresourcemanagerV2beta1::AuditLogConfig, decorator: Google::Apis::CloudresourcemanagerV2beta1::AuditLogConfig::Representation property :service, as: 'service' end end class AuditLogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exempted_members, as: 'exemptedMembers' property :log_type, as: 'logType' end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation collection :members, as: 'members' property :role, as: 'role' end end class Folder # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :display_name, as: 'displayName' property :lifecycle_state, as: 'lifecycleState' property :name, as: 'name' property :parent, as: 'parent' end end class FolderOperation # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination_parent, as: 'destinationParent' property :display_name, as: 'displayName' property :operation_type, as: 'operationType' property :source_parent, as: 'sourceParent' end end class FolderOperationError # @private class Representation < Google::Apis::Core::JsonRepresentation property :error_message_id, as: 'errorMessageId' end end class GetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ListFoldersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :folders, as: 'folders', class: Google::Apis::CloudresourcemanagerV2beta1::Folder, decorator: Google::Apis::CloudresourcemanagerV2beta1::Folder::Representation property :next_page_token, as: 'nextPageToken' end end class MoveFolderRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination_parent, as: 'destinationParent' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::CloudresourcemanagerV2beta1::Status, decorator: Google::Apis::CloudresourcemanagerV2beta1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_configs, as: 'auditConfigs', class: Google::Apis::CloudresourcemanagerV2beta1::AuditConfig, decorator: Google::Apis::CloudresourcemanagerV2beta1::AuditConfig::Representation collection :bindings, as: 'bindings', class: Google::Apis::CloudresourcemanagerV2beta1::Binding, decorator: Google::Apis::CloudresourcemanagerV2beta1::Binding::Representation property :etag, :base64 => true, as: 'etag' property :version, as: 'version' end end class ProjectCreationStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :gettable, as: 'gettable' property :ready, as: 'ready' end end class SearchFoldersRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' property :query, as: 'query' end end class SearchFoldersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :folders, as: 'folders', class: Google::Apis::CloudresourcemanagerV2beta1::Folder, decorator: Google::Apis::CloudresourcemanagerV2beta1::Folder::Representation property :next_page_token, as: 'nextPageToken' end end class SetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :policy, as: 'policy', class: Google::Apis::CloudresourcemanagerV2beta1::Policy, decorator: Google::Apis::CloudresourcemanagerV2beta1::Policy::Representation property :update_mask, as: 'updateMask' 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 TestIamPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestIamPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class UndeleteFolderRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end end end end google-api-client-0.19.8/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb0000644000004100000410000010116713252673043031040 0ustar www-datawww-data# 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 CloudresourcemanagerV2beta1 # 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:foo@gmail.com" # ] # `, # ` # "log_type": "DATA_WRITE", # `, # ` # "log_type": "ADMIN_READ", # ` # ] # `, # ` # "service": "fooservice.googleapis.com" # "audit_log_configs": [ # ` # "log_type": "DATA_READ", # `, # ` # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:bar@gmail.com" # ] # ` # ] # ` # ] # ` # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and # bar@gmail.com from DATA_WRITE logging. class AuditConfig include Google::Apis::Core::Hashable # The configuration for logging of each type of permission. # Next ID: 4 # 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:foo@gmail.com" # ] # `, # ` # "log_type": "DATA_WRITE", # ` # ] # ` # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # foo@gmail.com from DATA_READ logging. class AuditLogConfig include Google::Apis::Core::Hashable # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. # Corresponds to the JSON property `exemptedMembers` # @return [Array] 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 Binding include Google::Apis::Core::Hashable # 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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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`. # Required # 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) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end # A Folder in an Organization's resource hierarchy, used to # organize that Organization's resources. class Folder include Google::Apis::Core::Hashable # Output only. Timestamp when the Folder was created. Assigned by the server. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The folder’s display name. # A folder’s display name must be unique amongst its siblings, e.g. # no two folders with the same parent can share the same display name. # The display name must start and end with a letter or digit, may contain # letters, digits, spaces, hyphens and underscores and can be no longer # than 30 characters. This is captured by the regular expression: # [\p`L`\p`N`](`\p`L`\p`N`_- ]`0,28`[\p`L`\p`N`])?. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Output only. The lifecycle state of the folder. # Updates to the lifecycle_state must be performed via # DeleteFolder and # UndeleteFolder. # Corresponds to the JSON property `lifecycleState` # @return [String] attr_accessor :lifecycle_state # Output only. The resource name of the Folder. # Its format is `folders/`folder_id``, for example: "folders/1234". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Folder’s parent's resource name. # Updates to the folder's parent must be performed via # MoveFolder. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @display_name = args[:display_name] if args.key?(:display_name) @lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state) @name = args[:name] if args.key?(:name) @parent = args[:parent] if args.key?(:parent) end end # Metadata describing a long running folder operation class FolderOperation include Google::Apis::Core::Hashable # The resource name of the folder or organization we are either creating # the folder under or moving the folder to. # Corresponds to the JSON property `destinationParent` # @return [String] attr_accessor :destination_parent # The display name of the folder. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The type of this operation. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # The resource name of the folder's parent. # Only applicable when the operation_type is MOVE. # Corresponds to the JSON property `sourceParent` # @return [String] attr_accessor :source_parent def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @destination_parent = args[:destination_parent] if args.key?(:destination_parent) @display_name = args[:display_name] if args.key?(:display_name) @operation_type = args[:operation_type] if args.key?(:operation_type) @source_parent = args[:source_parent] if args.key?(:source_parent) end end # A classification of the Folder Operation error. class FolderOperationError include Google::Apis::Core::Hashable # The type of operation error experienced. # Corresponds to the JSON property `errorMessageId` # @return [String] attr_accessor :error_message_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_message_id = args[:error_message_id] if args.key?(:error_message_id) end end # Request message for `GetIamPolicy` method. class GetIamPolicyRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The ListFolders response message. class ListFoldersResponse include Google::Apis::Core::Hashable # A possibly paginated list of Folders that are direct descendants of # the specified parent resource. # Corresponds to the JSON property `folders` # @return [Array] attr_accessor :folders # A pagination token returned from a previous call to `ListFolders` # that indicates from where listing should continue. # This field is optional. # 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) @folders = args[:folders] if args.key?(:folders) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The MoveFolder request message. class MoveFolderRequest include Google::Apis::Core::Hashable # The resource name of the Folder or Organization to reparent # the folder under. # Must be of the form `folders/`folder_id`` or `organizations/`org_id``. # Corresponds to the JSON property `destinationParent` # @return [String] attr_accessor :destination_parent def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @destination_parent = args[:destination_parent] if args.key?(:destination_parent) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::CloudresourcemanagerV2beta1::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 have the format of `operations/some/unique/name`. # 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 # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). class Policy include Google::Apis::Core::Hashable # Specifies cloud audit logging configuration for this policy. # Corresponds to the JSON property `auditConfigs` # @return [Array] attr_accessor :audit_configs # Associates a list of `members` to a `role`. # `bindings` with no members will result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # Deprecated. # 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 # A status object which is used as the `metadata` field for the Operation # returned by CreateProject. It provides insight for when significant phases of # Project creation have completed. class ProjectCreationStatus include Google::Apis::Core::Hashable # Creation time of the project creation workflow. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # True if the project can be retrieved using GetProject. No other operations # on the project are guaranteed to work until the project creation is # complete. # Corresponds to the JSON property `gettable` # @return [Boolean] attr_accessor :gettable alias_method :gettable?, :gettable # True if the project creation process is complete. # Corresponds to the JSON property `ready` # @return [Boolean] attr_accessor :ready alias_method :ready?, :ready def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @gettable = args[:gettable] if args.key?(:gettable) @ready = args[:ready] if args.key?(:ready) end end # The request message for searching folders. class SearchFoldersRequest include Google::Apis::Core::Hashable # The maximum number of folders to return in the response. # This field is optional. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # A pagination token returned from a previous call to `SearchFolders` # that indicates from where search should continue. # This field is optional. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token # Search criteria used to select the Folders to return. # If no search criteria is specified then all accessible folders will be # returned. # Query expressions can be used to restrict results based upon displayName, # lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` # can be used along with the suffix wildcard symbol `*`. # Some example queries are: # |Query | Description| # |----- | -----------| # |displayName=Test*|Folders whose display name starts with "Test".| # |lifecycleState=ACTIVE|Folders whose lifecycleState is ACTIVE.| # |parent=folders/123|Folders whose parent is "folders/123".| # |parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose parent is " # folders/123".| # Corresponds to the JSON property `query` # @return [String] attr_accessor :query def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @query = args[:query] if args.key?(:query) end end # The response message for searching folders. class SearchFoldersResponse include Google::Apis::Core::Hashable # A possibly paginated folder search results. # the specified parent resource. # Corresponds to the JSON property `folders` # @return [Array] attr_accessor :folders # A pagination token returned from a previous call to `SearchFolders` # that indicates from where searching should continue. # This field is optional. # 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) @folders = args[:folders] if args.key?(:folders) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Request message for `SetIamPolicy` method. class SetIamPolicyRequest include Google::Apis::Core::Hashable # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). # Corresponds to the JSON property `policy` # @return [Google::Apis::CloudresourcemanagerV2beta1::Policy] attr_accessor :policy # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: # paths: "bindings, etag" # This field is only used by Cloud IAM. # 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 # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 # Request message for `TestIamPermissions` method. class TestIamPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the `resource`. Permissions with # wildcards (such as '*' or 'storage.*') are not allowed. For more # information see # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permissions = args[:permissions] if args.key?(:permissions) end end # Response message for `TestIamPermissions` method. class TestIamPermissionsResponse include Google::Apis::Core::Hashable # A subset of `TestPermissionsRequest.permissions` that the caller is # allowed. # Corresponds to the JSON property `permissions` # @return [Array] 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 UndeleteFolder request message. class UndeleteFolderRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end end end end google-api-client-0.19.8/generated/google/apis/cloudresourcemanager_v2beta1/service.rb0000644000004100000410000010006013252673043031032 0ustar www-datawww-data# 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 CloudresourcemanagerV2beta1 # Google Cloud Resource Manager API # # The Google Cloud Resource Manager API provides methods for creating, reading, # and updating project metadata. # # @example # require 'google/apis/cloudresourcemanager_v2beta1' # # Cloudresourcemanager = Google::Apis::CloudresourcemanagerV2beta1 # Alias the module # service = Cloudresourcemanager::CloudResourceManagerService.new # # @see https://cloud.google.com/resource-manager class CloudResourceManagerService < 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://cloudresourcemanager.googleapis.com/', '') @batch_path = 'batch' end # Creates a Folder in the resource hierarchy. # Returns an Operation which can be used to track the progress of the # folder creation workflow. # Upon success the Operation.response field will be populated with the # created Folder. # In order to succeed, the addition of this new Folder must not violate # the Folder naming, height or fanout constraints. # + The Folder's display_name must be distinct from all other Folder's that # share its parent. # + The addition of the Folder must not cause the active Folder hierarchy # to exceed a height of 4. Note, the full active + deleted Folder hierarchy # is allowed to reach a height of 8; this provides additional headroom when # moving folders that contain deleted folders. # + The addition of the Folder must not cause the total number of Folders # under its parent to exceed 100. # If the operation fails due to a folder constraint violation, # a PreconditionFailure explaining the violation will be returned. # If the failure occurs synchronously then the PreconditionFailure # will be returned via the Status.details field and if it occurs # asynchronously then the PreconditionFailure will be returned # via the the Operation.error field. # The caller must have `resourcemanager.folders.create` permission on the # identified parent. # @param [Google::Apis::CloudresourcemanagerV2beta1::Folder] folder_object # @param [String] parent # The resource name of the new Folder's parent. # Must be of the form `folders/`folder_id`` or `organizations/`org_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::CloudresourcemanagerV2beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::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_folder(folder_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/folders', options) command.request_representation = Google::Apis::CloudresourcemanagerV2beta1::Folder::Representation command.request_object = folder_object command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::Operation::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::Operation 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 # Requests deletion of a Folder. The Folder is moved into the # DELETE_REQUESTED state # immediately, and is deleted approximately 30 days later. This method may # only be called on an empty Folder in the # ACTIVE state, where a Folder is empty if # it doesn't contain any Folders or Projects in the # ACTIVE state. # The caller must have `resourcemanager.folders.delete` permission on the # identified folder. # @param [String] name # the resource name of the Folder to be deleted. # Must be of the form `folders/`folder_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::CloudresourcemanagerV2beta1::Folder] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::Folder] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_folder(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+name}', options) command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::Folder::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::Folder 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 # Retrieves a Folder identified by the supplied resource name. # Valid Folder resource names have the format `folders/`folder_id`` # (for example, `folders/1234`). # The caller must have `resourcemanager.folders.get` permission on the # identified folder. # @param [String] name # The resource name of the Folder to retrieve. # Must be of the form `folders/`folder_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::CloudresourcemanagerV2beta1::Folder] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::Folder] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_folder(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+name}', options) command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::Folder::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::Folder 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 access control policy for a Folder. The returned policy may be # empty if no such policy or resource exists. The `resource` field should # be the Folder's resource name, e.g. "folders/1234". # The caller must have `resourcemanager.folders.getIamPolicy` permission # on the identified folder. # @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 [Google::Apis::CloudresourcemanagerV2beta1::GetIamPolicyRequest] get_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::CloudresourcemanagerV2beta1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::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_folder_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+resource}:getIamPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV2beta1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::Policy::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::Policy 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 # Lists the Folders that are direct descendants of supplied parent resource. # List provides a strongly consistent view of the Folders underneath # the specified parent resource. # List returns Folders sorted based upon the (ascending) lexical ordering # of their display_name. # The caller must have `resourcemanager.folders.list` permission on the # identified parent. # @param [Fixnum] page_size # The maximum number of Folders to return in the response. # This field is optional. # @param [String] page_token # A pagination token returned from a previous call to `ListFolders` # that indicates where this listing should continue from. # This field is optional. # @param [String] parent # The resource name of the Organization or Folder whose Folders are # being listed. # Must be of the form `folders/`folder_id`` or `organizations/`org_id``. # Access to this method is controlled by checking the # `resourcemanager.folders.list` permission on the `parent`. # @param [Boolean] show_deleted # Controls whether Folders in the # DELETE_REQUESTED # state should be returned. Defaults to false. This field is 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::CloudresourcemanagerV2beta1::ListFoldersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::ListFoldersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_folders(page_size: nil, page_token: nil, parent: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/folders', options) command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::ListFoldersResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::ListFoldersResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parent'] = parent unless parent.nil? command.query['showDeleted'] = show_deleted unless show_deleted.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Moves a Folder under a new resource parent. # Returns an Operation which can be used to track the progress of the # folder move workflow. # Upon success the Operation.response field will be populated with the # moved Folder. # Upon failure, a FolderOperationError categorizing the failure cause will # be returned - if the failure occurs synchronously then the # FolderOperationError will be returned via the Status.details field # and if it occurs asynchronously then the FolderOperation will be returned # via the the Operation.error field. # In addition, the Operation.metadata field will be populated with a # FolderOperation message as an aid to stateless clients. # Folder moves will be rejected if they violate either the naming, height # or fanout constraints described in the # CreateFolder documentation. # The caller must have `resourcemanager.folders.move` permission on the # folder's current and proposed new parent. # @param [String] name # The resource name of the Folder to move. # Must be of the form folders/`folder_id` # @param [Google::Apis::CloudresourcemanagerV2beta1::MoveFolderRequest] move_folder_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::CloudresourcemanagerV2beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::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 move_folder(name, move_folder_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+name}:move', options) command.request_representation = Google::Apis::CloudresourcemanagerV2beta1::MoveFolderRequest::Representation command.request_object = move_folder_request_object command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::Operation::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::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 # Updates a Folder, changing its display_name. # Changes to the folder display_name will be rejected if they violate either # the display_name formatting rules or naming constraints described in the # CreateFolder documentation. # The Folder's display name must start and end with a letter or digit, # may contain letters, digits, spaces, hyphens and underscores and can be # no longer than 30 characters. This is captured by the regular expression: # [\p`L`\p`N`](`\p`L`\p`N`_- ]`0,28`[\p`L`\p`N`])?. # The caller must have `resourcemanager.folders.update` permission on the # identified folder. # If the update fails due to the unique name constraint then a # PreconditionFailure explaining this violation will be returned # in the Status.details field. # @param [String] name # Output only. The resource name of the Folder. # Its format is `folders/`folder_id``, for example: "folders/1234". # @param [Google::Apis::CloudresourcemanagerV2beta1::Folder] folder_object # @param [String] update_mask # Fields to be updated. # Only the `display_name` can 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::CloudresourcemanagerV2beta1::Folder] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::Folder] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_folder(name, folder_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta1/{+name}', options) command.request_representation = Google::Apis::CloudresourcemanagerV2beta1::Folder::Representation command.request_object = folder_object command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::Folder::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::Folder 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 # Search for folders that match specific filter criteria. # Search provides an eventually consistent view of the folders a user has # access to which meet the specified filter criteria. # This will only return folders on which the caller has the # permission `resourcemanager.folders.get`. # @param [Google::Apis::CloudresourcemanagerV2beta1::SearchFoldersRequest] search_folders_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::CloudresourcemanagerV2beta1::SearchFoldersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::SearchFoldersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_folders(search_folders_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/folders:search', options) command.request_representation = Google::Apis::CloudresourcemanagerV2beta1::SearchFoldersRequest::Representation command.request_object = search_folders_request_object command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::SearchFoldersResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::SearchFoldersResponse 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 access control policy on a Folder, replacing any existing policy. # The `resource` field should be the Folder's resource name, e.g. # "folders/1234". # The caller must have `resourcemanager.folders.setIamPolicy` permission # on the identified folder. # @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::CloudresourcemanagerV2beta1::SetIamPolicyRequest] 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::CloudresourcemanagerV2beta1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::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_folder_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+resource}:setIamPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV2beta1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::Policy::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::Policy 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 # Returns permissions that a caller has on the specified Folder. # The `resource` field should be the Folder's resource name, # e.g. "folders/1234". # There are no permissions required for making this API call. # @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::CloudresourcemanagerV2beta1::TestIamPermissionsRequest] 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::CloudresourcemanagerV2beta1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_folder_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+resource}:testIamPermissions', options) command.request_representation = Google::Apis::CloudresourcemanagerV2beta1::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::TestIamPermissionsResponse 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 # Cancels the deletion request for a Folder. This method may only be # called on a Folder in the # DELETE_REQUESTED state. # In order to succeed, the Folder's parent must be in the # ACTIVE state. # In addition, reintroducing the folder into the tree must not violate # folder naming, height and fanout constraints described in the # CreateFolder documentation. # The caller must have `resourcemanager.folders.undelete` permission on the # identified folder. # @param [String] name # The resource name of the Folder to undelete. # Must be of the form `folders/`folder_id``. # @param [Google::Apis::CloudresourcemanagerV2beta1::UndeleteFolderRequest] undelete_folder_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::CloudresourcemanagerV2beta1::Folder] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV2beta1::Folder] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def undelete_folder(name, undelete_folder_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+name}:undelete', options) command.request_representation = Google::Apis::CloudresourcemanagerV2beta1::UndeleteFolderRequest::Representation command.request_object = undelete_folder_request_object command.response_representation = Google::Apis::CloudresourcemanagerV2beta1::Folder::Representation command.response_class = Google::Apis::CloudresourcemanagerV2beta1::Folder 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 google-api-client-0.19.8/generated/google/apis/adexperiencereport_v1/0000755000004100000410000000000013252673043025611 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/adexperiencereport_v1/representations.rb0000644000004100000410000000550013252673043031363 0ustar www-datawww-data# 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 AdexperiencereportV1 class PlatformSummary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SiteSummaryResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ViolatingSitesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlatformSummary # @private class Representation < Google::Apis::Core::JsonRepresentation property :better_ads_status, as: 'betterAdsStatus' property :enforcement_time, as: 'enforcementTime' property :filter_status, as: 'filterStatus' property :last_change_time, as: 'lastChangeTime' collection :region, as: 'region' property :report_url, as: 'reportUrl' property :under_review, as: 'underReview' end end class SiteSummaryResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :desktop_summary, as: 'desktopSummary', class: Google::Apis::AdexperiencereportV1::PlatformSummary, decorator: Google::Apis::AdexperiencereportV1::PlatformSummary::Representation property :mobile_summary, as: 'mobileSummary', class: Google::Apis::AdexperiencereportV1::PlatformSummary, decorator: Google::Apis::AdexperiencereportV1::PlatformSummary::Representation property :reviewed_site, as: 'reviewedSite' end end class ViolatingSitesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :violating_sites, as: 'violatingSites', class: Google::Apis::AdexperiencereportV1::SiteSummaryResponse, decorator: Google::Apis::AdexperiencereportV1::SiteSummaryResponse::Representation end end end end end google-api-client-0.19.8/generated/google/apis/adexperiencereport_v1/classes.rb0000644000004100000410000001146313252673043027600 0ustar www-datawww-data# 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 AdexperiencereportV1 # Summary of the ad experience rating of a site for a specific platform. class PlatformSummary include Google::Apis::Core::Hashable # The status of the site reviewed for the Better Ads Standards. # Corresponds to the JSON property `betterAdsStatus` # @return [String] attr_accessor :better_ads_status # The date on which ad filtering begins. # Corresponds to the JSON property `enforcementTime` # @return [String] attr_accessor :enforcement_time # The ad filtering status of the site. # Corresponds to the JSON property `filterStatus` # @return [String] attr_accessor :filter_status # The last time that the site changed status. # Corresponds to the JSON property `lastChangeTime` # @return [String] attr_accessor :last_change_time # The assigned regions for the site and platform. # Corresponds to the JSON property `region` # @return [Array] attr_accessor :region # A link that leads to a full ad experience report. # Corresponds to the JSON property `reportUrl` # @return [String] attr_accessor :report_url # Whether the site is currently under review. # Corresponds to the JSON property `underReview` # @return [Boolean] attr_accessor :under_review alias_method :under_review?, :under_review def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @better_ads_status = args[:better_ads_status] if args.key?(:better_ads_status) @enforcement_time = args[:enforcement_time] if args.key?(:enforcement_time) @filter_status = args[:filter_status] if args.key?(:filter_status) @last_change_time = args[:last_change_time] if args.key?(:last_change_time) @region = args[:region] if args.key?(:region) @report_url = args[:report_url] if args.key?(:report_url) @under_review = args[:under_review] if args.key?(:under_review) end end # Response message for GetSiteSummary. class SiteSummaryResponse include Google::Apis::Core::Hashable # Summary of the ad experience rating of a site for a specific platform. # Corresponds to the JSON property `desktopSummary` # @return [Google::Apis::AdexperiencereportV1::PlatformSummary] attr_accessor :desktop_summary # Summary of the ad experience rating of a site for a specific platform. # Corresponds to the JSON property `mobileSummary` # @return [Google::Apis::AdexperiencereportV1::PlatformSummary] attr_accessor :mobile_summary # The name of the site reviewed. # Corresponds to the JSON property `reviewedSite` # @return [String] attr_accessor :reviewed_site def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @desktop_summary = args[:desktop_summary] if args.key?(:desktop_summary) @mobile_summary = args[:mobile_summary] if args.key?(:mobile_summary) @reviewed_site = args[:reviewed_site] if args.key?(:reviewed_site) end end # Response message for ListViolatingSites. class ViolatingSitesResponse include Google::Apis::Core::Hashable # A list of summaries of violating sites. # Corresponds to the JSON property `violatingSites` # @return [Array] attr_accessor :violating_sites def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @violating_sites = args[:violating_sites] if args.key?(:violating_sites) end end end end end google-api-client-0.19.8/generated/google/apis/adexperiencereport_v1/service.rb0000644000004100000410000001422213252673043027577 0ustar www-datawww-data# 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 AdexperiencereportV1 # Google Ad Experience Report API # # View Ad Experience Report data, and get a list of sites that have a # significant number of annoying ads. # # @example # require 'google/apis/adexperiencereport_v1' # # Adexperiencereport = Google::Apis::AdexperiencereportV1 # Alias the module # service = Adexperiencereport::AdExperienceReportService.new # # @see https://developers.google.com/ad-experience-report/ class AdExperienceReportService < 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://adexperiencereport.googleapis.com/', '') @batch_path = 'batch' end # Gets a summary of the ad experience rating of a site. # @param [String] name # The required site name. It should be the site property whose ad experiences # may have been reviewed, and it should be URL-encoded. For example, # sites/https%3A%2F%2Fwww.google.com. The server will return an error of # BAD_REQUEST if this field is not filled in. Note that if the site property # is not yet verified in Search Console, the reportUrl field returned by the # API will lead to the verification page, prompting the user to go through # that process before they can gain access to the Ad Experience 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::AdexperiencereportV1::SiteSummaryResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexperiencereportV1::SiteSummaryResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AdexperiencereportV1::SiteSummaryResponse::Representation command.response_class = Google::Apis::AdexperiencereportV1::SiteSummaryResponse 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 sites with Ad Experience Report statuses of "Failing" or "Warning". # @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::AdexperiencereportV1::ViolatingSitesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexperiencereportV1::ViolatingSitesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_violating_sites(fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/violatingSites', options) command.response_representation = Google::Apis::AdexperiencereportV1::ViolatingSitesResponse::Representation command.response_class = Google::Apis::AdexperiencereportV1::ViolatingSitesResponse 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 google-api-client-0.19.8/generated/google/apis/dlp_v2beta1.rb0000644000004100000410000000233713252673043023750 0ustar www-datawww-data# 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/dlp_v2beta1/service.rb' require 'google/apis/dlp_v2beta1/classes.rb' require 'google/apis/dlp_v2beta1/representations.rb' module Google module Apis # DLP API # # The Google Data Loss Prevention API provides methods for detection of privacy- # sensitive fragments in text, images, and Google Cloud Platform storage # repositories. # # @see https://cloud.google.com/dlp/docs/ module DlpV2beta1 VERSION = 'V2beta1' REVISION = '20180130' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end google-api-client-0.19.8/generated/google/apis/storagetransfer_v1/0000755000004100000410000000000013252673044025133 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/storagetransfer_v1/representations.rb0000644000004100000410000004035013252673044030707 0ustar www-datawww-data# 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 StoragetransferV1 class AwsAccessKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AwsS3Data 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 Empty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ErrorLogEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ErrorSummary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GcsData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleServiceAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTransferJobsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ObjectConditions 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 PauseTransferOperationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResumeTransferOperationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Schedule 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 TimeOfDay class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TransferCounters class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TransferJob class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TransferOperation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TransferOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TransferSpec class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateTransferJobRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AwsAccessKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :access_key_id, as: 'accessKeyId' property :secret_access_key, as: 'secretAccessKey' end end class AwsS3Data # @private class Representation < Google::Apis::Core::JsonRepresentation property :aws_access_key, as: 'awsAccessKey', class: Google::Apis::StoragetransferV1::AwsAccessKey, decorator: Google::Apis::StoragetransferV1::AwsAccessKey::Representation property :bucket_name, as: 'bucketName' 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 Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ErrorLogEntry # @private class Representation < Google::Apis::Core::JsonRepresentation collection :error_details, as: 'errorDetails' property :url, as: 'url' end end class ErrorSummary # @private class Representation < Google::Apis::Core::JsonRepresentation property :error_code, as: 'errorCode' property :error_count, :numeric_string => true, as: 'errorCount' collection :error_log_entries, as: 'errorLogEntries', class: Google::Apis::StoragetransferV1::ErrorLogEntry, decorator: Google::Apis::StoragetransferV1::ErrorLogEntry::Representation end end class GcsData # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_name, as: 'bucketName' end end class GoogleServiceAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_email, as: 'accountEmail' end end class HttpData # @private class Representation < Google::Apis::Core::JsonRepresentation property :list_url, as: 'listUrl' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::StoragetransferV1::Operation, decorator: Google::Apis::StoragetransferV1::Operation::Representation end end class ListTransferJobsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :transfer_jobs, as: 'transferJobs', class: Google::Apis::StoragetransferV1::TransferJob, decorator: Google::Apis::StoragetransferV1::TransferJob::Representation end end class ObjectConditions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exclude_prefixes, as: 'excludePrefixes' collection :include_prefixes, as: 'includePrefixes' property :max_time_elapsed_since_last_modification, as: 'maxTimeElapsedSinceLastModification' property :min_time_elapsed_since_last_modification, as: 'minTimeElapsedSinceLastModification' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::StoragetransferV1::Status, decorator: Google::Apis::StoragetransferV1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class PauseTransferOperationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ResumeTransferOperationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Schedule # @private class Representation < Google::Apis::Core::JsonRepresentation property :schedule_end_date, as: 'scheduleEndDate', class: Google::Apis::StoragetransferV1::Date, decorator: Google::Apis::StoragetransferV1::Date::Representation property :schedule_start_date, as: 'scheduleStartDate', class: Google::Apis::StoragetransferV1::Date, decorator: Google::Apis::StoragetransferV1::Date::Representation property :start_time_of_day, as: 'startTimeOfDay', class: Google::Apis::StoragetransferV1::TimeOfDay, decorator: Google::Apis::StoragetransferV1::TimeOfDay::Representation 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 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 TransferCounters # @private class Representation < Google::Apis::Core::JsonRepresentation property :bytes_copied_to_sink, :numeric_string => true, as: 'bytesCopiedToSink' property :bytes_deleted_from_sink, :numeric_string => true, as: 'bytesDeletedFromSink' property :bytes_deleted_from_source, :numeric_string => true, as: 'bytesDeletedFromSource' property :bytes_failed_to_delete_from_sink, :numeric_string => true, as: 'bytesFailedToDeleteFromSink' property :bytes_found_from_source, :numeric_string => true, as: 'bytesFoundFromSource' property :bytes_found_only_from_sink, :numeric_string => true, as: 'bytesFoundOnlyFromSink' property :bytes_from_source_failed, :numeric_string => true, as: 'bytesFromSourceFailed' property :bytes_from_source_skipped_by_sync, :numeric_string => true, as: 'bytesFromSourceSkippedBySync' property :objects_copied_to_sink, :numeric_string => true, as: 'objectsCopiedToSink' property :objects_deleted_from_sink, :numeric_string => true, as: 'objectsDeletedFromSink' property :objects_deleted_from_source, :numeric_string => true, as: 'objectsDeletedFromSource' property :objects_failed_to_delete_from_sink, :numeric_string => true, as: 'objectsFailedToDeleteFromSink' property :objects_found_from_source, :numeric_string => true, as: 'objectsFoundFromSource' property :objects_found_only_from_sink, :numeric_string => true, as: 'objectsFoundOnlyFromSink' property :objects_from_source_failed, :numeric_string => true, as: 'objectsFromSourceFailed' property :objects_from_source_skipped_by_sync, :numeric_string => true, as: 'objectsFromSourceSkippedBySync' end end class TransferJob # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_time, as: 'creationTime' property :deletion_time, as: 'deletionTime' property :description, as: 'description' property :last_modification_time, as: 'lastModificationTime' property :name, as: 'name' property :project_id, as: 'projectId' property :schedule, as: 'schedule', class: Google::Apis::StoragetransferV1::Schedule, decorator: Google::Apis::StoragetransferV1::Schedule::Representation property :status, as: 'status' property :transfer_spec, as: 'transferSpec', class: Google::Apis::StoragetransferV1::TransferSpec, decorator: Google::Apis::StoragetransferV1::TransferSpec::Representation end end class TransferOperation # @private class Representation < Google::Apis::Core::JsonRepresentation property :counters, as: 'counters', class: Google::Apis::StoragetransferV1::TransferCounters, decorator: Google::Apis::StoragetransferV1::TransferCounters::Representation property :end_time, as: 'endTime' collection :error_breakdowns, as: 'errorBreakdowns', class: Google::Apis::StoragetransferV1::ErrorSummary, decorator: Google::Apis::StoragetransferV1::ErrorSummary::Representation property :name, as: 'name' property :project_id, as: 'projectId' property :start_time, as: 'startTime' property :status, as: 'status' property :transfer_job_name, as: 'transferJobName' property :transfer_spec, as: 'transferSpec', class: Google::Apis::StoragetransferV1::TransferSpec, decorator: Google::Apis::StoragetransferV1::TransferSpec::Representation end end class TransferOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :delete_objects_from_source_after_transfer, as: 'deleteObjectsFromSourceAfterTransfer' property :delete_objects_unique_in_sink, as: 'deleteObjectsUniqueInSink' property :overwrite_objects_already_existing_in_sink, as: 'overwriteObjectsAlreadyExistingInSink' end end class TransferSpec # @private class Representation < Google::Apis::Core::JsonRepresentation property :aws_s3_data_source, as: 'awsS3DataSource', class: Google::Apis::StoragetransferV1::AwsS3Data, decorator: Google::Apis::StoragetransferV1::AwsS3Data::Representation property :gcs_data_sink, as: 'gcsDataSink', class: Google::Apis::StoragetransferV1::GcsData, decorator: Google::Apis::StoragetransferV1::GcsData::Representation property :gcs_data_source, as: 'gcsDataSource', class: Google::Apis::StoragetransferV1::GcsData, decorator: Google::Apis::StoragetransferV1::GcsData::Representation property :http_data_source, as: 'httpDataSource', class: Google::Apis::StoragetransferV1::HttpData, decorator: Google::Apis::StoragetransferV1::HttpData::Representation property :object_conditions, as: 'objectConditions', class: Google::Apis::StoragetransferV1::ObjectConditions, decorator: Google::Apis::StoragetransferV1::ObjectConditions::Representation property :transfer_options, as: 'transferOptions', class: Google::Apis::StoragetransferV1::TransferOptions, decorator: Google::Apis::StoragetransferV1::TransferOptions::Representation end end class UpdateTransferJobRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :project_id, as: 'projectId' property :transfer_job, as: 'transferJob', class: Google::Apis::StoragetransferV1::TransferJob, decorator: Google::Apis::StoragetransferV1::TransferJob::Representation property :update_transfer_job_field_mask, as: 'updateTransferJobFieldMask' end end end end end google-api-client-0.19.8/generated/google/apis/storagetransfer_v1/classes.rb0000644000004100000410000014431713252673044027127 0ustar www-datawww-data# 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 StoragetransferV1 # AWS access key (see # [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws- # security-credentials.html)). class AwsAccessKey include Google::Apis::Core::Hashable # AWS access key ID. # Required. # Corresponds to the JSON property `accessKeyId` # @return [String] attr_accessor :access_key_id # AWS secret access key. This field is not returned in RPC responses. # Required. # Corresponds to the JSON property `secretAccessKey` # @return [String] attr_accessor :secret_access_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @access_key_id = args[:access_key_id] if args.key?(:access_key_id) @secret_access_key = args[:secret_access_key] if args.key?(:secret_access_key) end end # An AwsS3Data can be a data source, but not a data sink. # In an AwsS3Data, an object's name is the S3 object's key name. class AwsS3Data include Google::Apis::Core::Hashable # AWS access key (see # [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws- # security-credentials.html)). # Corresponds to the JSON property `awsAccessKey` # @return [Google::Apis::StoragetransferV1::AwsAccessKey] attr_accessor :aws_access_key # S3 Bucket name (see # [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create- # bucket-get-location-example.html)). # Required. # Corresponds to the JSON property `bucketName` # @return [String] attr_accessor :bucket_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aws_access_key = args[:aws_access_key] if args.key?(:aws_access_key) @bucket_name = args[:bucket_name] if args.key?(:bucket_name) end end # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary 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/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. # 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 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 # An entry describing an error that has occurred. class ErrorLogEntry include Google::Apis::Core::Hashable # A list of messages that carry the error details. # Corresponds to the JSON property `errorDetails` # @return [Array] attr_accessor :error_details # A URL that refers to the target (a data source, a data sink, # or an object) with which the error is associated. # Required. # 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) @error_details = args[:error_details] if args.key?(:error_details) @url = args[:url] if args.key?(:url) end end # A summary of errors by error code, plus a count and sample error log # entries. class ErrorSummary include Google::Apis::Core::Hashable # Required. # Corresponds to the JSON property `errorCode` # @return [String] attr_accessor :error_code # Count of this type of error. # Required. # Corresponds to the JSON property `errorCount` # @return [Fixnum] attr_accessor :error_count # Error samples. # Corresponds to the JSON property `errorLogEntries` # @return [Array] attr_accessor :error_log_entries def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_code = args[:error_code] if args.key?(:error_code) @error_count = args[:error_count] if args.key?(:error_count) @error_log_entries = args[:error_log_entries] if args.key?(:error_log_entries) end end # In a GcsData, an object's name is the Google Cloud Storage object's name and # its `lastModificationTime` refers to the object's updated time, which changes # when the content or the metadata of the object is updated. class GcsData include Google::Apis::Core::Hashable # Google Cloud Storage bucket name (see # [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming# # requirements)). # Required. # Corresponds to the JSON property `bucketName` # @return [String] attr_accessor :bucket_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_name = args[:bucket_name] if args.key?(:bucket_name) end end # Google service account class GoogleServiceAccount include Google::Apis::Core::Hashable # Required. # Corresponds to the JSON property `accountEmail` # @return [String] attr_accessor :account_email def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_email = args[:account_email] if args.key?(:account_email) end end # An HttpData specifies a list of objects on the web to be transferred over # HTTP. The information of the objects to be transferred is contained in a # file referenced by a URL. The first line in the file must be # "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines # specify the information of the list of objects, one object per list entry. # Each entry has the following tab-delimited fields: # * HTTP URL - The location of the object. # * Length - The size of the object in bytes. # * MD5 - The base64-encoded MD5 hash of the object. # For an example of a valid TSV file, see # [Transferring data from URLs](https://cloud.google.com/storage/transfer/create- # url-list). # When transferring data based on a URL list, keep the following in mind: # * When an object located at `http(s)://hostname:port/` is # transferred # to a data sink, the name of the object at the data sink is # `/`. # * If the specified size of an object does not match the actual size of the # object fetched, the object will not be transferred. # * If the specified MD5 does not match the MD5 computed from the transferred # bytes, the object transfer will fail. For more information, see # [Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5) # * Ensure that each URL you specify is publicly accessible. For # example, in Google Cloud Storage you can # [share an object publicly] # (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get # a link to it. # * Storage Transfer Service obeys `robots.txt` rules and requires the source # HTTP server to support `Range` requests and to return a `Content-Length` # header in each response. # * [ObjectConditions](#ObjectConditions) have no effect when filtering objects # to transfer. class HttpData include Google::Apis::Core::Hashable # The URL that points to the file that stores the object list entries. # This file must allow public access. Currently, only URLs with HTTP and # HTTPS schemes are supported. # Required. # Corresponds to the JSON property `listUrl` # @return [String] attr_accessor :list_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @list_url = args[:list_url] if args.key?(:list_url) end end # The response message for Operations.ListOperations. class ListOperationsResponse 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 # Response from ListTransferJobs. class ListTransferJobsResponse include Google::Apis::Core::Hashable # The list next page token. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # A list of transfer jobs. # Corresponds to the JSON property `transferJobs` # @return [Array] attr_accessor :transfer_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) @transfer_jobs = args[:transfer_jobs] if args.key?(:transfer_jobs) end end # Conditions that determine which objects will be transferred. class ObjectConditions include Google::Apis::Core::Hashable # `excludePrefixes` must follow the requirements described for # `includePrefixes`. # The max size of `excludePrefixes` is 1000. # Corresponds to the JSON property `excludePrefixes` # @return [Array] attr_accessor :exclude_prefixes # If `includePrefixes` is specified, objects that satisfy the object # conditions must have names that start with one of the `includePrefixes` # and that do not start with any of the `excludePrefixes`. If `includePrefixes` # is not specified, all objects except those that have names starting with # one of the `excludePrefixes` must satisfy the object conditions. # Requirements: # * Each include-prefix and exclude-prefix can contain any sequence of # Unicode characters, of max length 1024 bytes when UTF8-encoded, and # must not contain Carriage Return or Line Feed characters. Wildcard # matching and regular expression matching are not supported. # * Each include-prefix and exclude-prefix must omit the leading slash. # For example, to include the `requests.gz` object in a transfer from # `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include # prefix as `logs/y=2015/requests.gz`. # * None of the include-prefix or the exclude-prefix values can be empty, # if specified. # * Each include-prefix must include a distinct portion of the object # namespace, i.e., no include-prefix may be a prefix of another # include-prefix. # * Each exclude-prefix must exclude a distinct portion of the object # namespace, i.e., no exclude-prefix may be a prefix of another # exclude-prefix. # * If `includePrefixes` is specified, then each exclude-prefix must start # with the value of a path explicitly included by `includePrefixes`. # The max size of `includePrefixes` is 1000. # Corresponds to the JSON property `includePrefixes` # @return [Array] attr_accessor :include_prefixes # `maxTimeElapsedSinceLastModification` is the complement to # `minTimeElapsedSinceLastModification`. # Corresponds to the JSON property `maxTimeElapsedSinceLastModification` # @return [String] attr_accessor :max_time_elapsed_since_last_modification # If unspecified, `minTimeElapsedSinceLastModification` takes a zero value # and `maxTimeElapsedSinceLastModification` takes the maximum possible # value of Duration. Objects that satisfy the object conditions # must either have a `lastModificationTime` greater or equal to # `NOW` - `maxTimeElapsedSinceLastModification` and less than # `NOW` - `minTimeElapsedSinceLastModification`, or not have a # `lastModificationTime`. # Corresponds to the JSON property `minTimeElapsedSinceLastModification` # @return [String] attr_accessor :min_time_elapsed_since_last_modification def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @exclude_prefixes = args[:exclude_prefixes] if args.key?(:exclude_prefixes) @include_prefixes = args[:include_prefixes] if args.key?(:include_prefixes) @max_time_elapsed_since_last_modification = args[:max_time_elapsed_since_last_modification] if args.key?(:max_time_elapsed_since_last_modification) @min_time_elapsed_since_last_modification = args[:min_time_elapsed_since_last_modification] if args.key?(:min_time_elapsed_since_last_modification) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::StoragetransferV1::Status] attr_accessor :error # Represents the transfer operation object. # 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 # have the format of `transferOperations/some/unique/name`. # 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 # Request passed to PauseTransferOperation. class PauseTransferOperationRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Request passed to ResumeTransferOperation. class ResumeTransferOperationRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Transfers can be scheduled to recur or to run just once. class Schedule include Google::Apis::Core::Hashable # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary date. Related types are google.type.TimeOfDay # and `google.protobuf.Timestamp`. # Corresponds to the JSON property `scheduleEndDate` # @return [Google::Apis::StoragetransferV1::Date] attr_accessor :schedule_end_date # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary date. Related types are google.type.TimeOfDay # and `google.protobuf.Timestamp`. # Corresponds to the JSON property `scheduleStartDate` # @return [Google::Apis::StoragetransferV1::Date] attr_accessor :schedule_start_date # 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 `startTimeOfDay` # @return [Google::Apis::StoragetransferV1::TimeOfDay] attr_accessor :start_time_of_day def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @schedule_end_date = args[:schedule_end_date] if args.key?(:schedule_end_date) @schedule_start_date = args[:schedule_start_date] if args.key?(:schedule_start_date) @start_time_of_day = args[:start_time_of_day] if args.key?(:start_time_of_day) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 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 # A collection of counters that report the progress of a transfer operation. class TransferCounters include Google::Apis::Core::Hashable # Bytes that are copied to the data sink. # Corresponds to the JSON property `bytesCopiedToSink` # @return [Fixnum] attr_accessor :bytes_copied_to_sink # Bytes that are deleted from the data sink. # Corresponds to the JSON property `bytesDeletedFromSink` # @return [Fixnum] attr_accessor :bytes_deleted_from_sink # Bytes that are deleted from the data source. # Corresponds to the JSON property `bytesDeletedFromSource` # @return [Fixnum] attr_accessor :bytes_deleted_from_source # Bytes that failed to be deleted from the data sink. # Corresponds to the JSON property `bytesFailedToDeleteFromSink` # @return [Fixnum] attr_accessor :bytes_failed_to_delete_from_sink # Bytes found in the data source that are scheduled to be transferred, # excluding any that are filtered based on object conditions or skipped due # to sync. # Corresponds to the JSON property `bytesFoundFromSource` # @return [Fixnum] attr_accessor :bytes_found_from_source # Bytes found only in the data sink that are scheduled to be deleted. # Corresponds to the JSON property `bytesFoundOnlyFromSink` # @return [Fixnum] attr_accessor :bytes_found_only_from_sink # Bytes in the data source that failed to be transferred or that failed to # be deleted after being transferred. # Corresponds to the JSON property `bytesFromSourceFailed` # @return [Fixnum] attr_accessor :bytes_from_source_failed # Bytes in the data source that are not transferred because they already # exist in the data sink. # Corresponds to the JSON property `bytesFromSourceSkippedBySync` # @return [Fixnum] attr_accessor :bytes_from_source_skipped_by_sync # Objects that are copied to the data sink. # Corresponds to the JSON property `objectsCopiedToSink` # @return [Fixnum] attr_accessor :objects_copied_to_sink # Objects that are deleted from the data sink. # Corresponds to the JSON property `objectsDeletedFromSink` # @return [Fixnum] attr_accessor :objects_deleted_from_sink # Objects that are deleted from the data source. # Corresponds to the JSON property `objectsDeletedFromSource` # @return [Fixnum] attr_accessor :objects_deleted_from_source # Objects that failed to be deleted from the data sink. # Corresponds to the JSON property `objectsFailedToDeleteFromSink` # @return [Fixnum] attr_accessor :objects_failed_to_delete_from_sink # Objects found in the data source that are scheduled to be transferred, # excluding any that are filtered based on object conditions or skipped due # to sync. # Corresponds to the JSON property `objectsFoundFromSource` # @return [Fixnum] attr_accessor :objects_found_from_source # Objects found only in the data sink that are scheduled to be deleted. # Corresponds to the JSON property `objectsFoundOnlyFromSink` # @return [Fixnum] attr_accessor :objects_found_only_from_sink # Objects in the data source that failed to be transferred or that failed # to be deleted after being transferred. # Corresponds to the JSON property `objectsFromSourceFailed` # @return [Fixnum] attr_accessor :objects_from_source_failed # Objects in the data source that are not transferred because they already # exist in the data sink. # Corresponds to the JSON property `objectsFromSourceSkippedBySync` # @return [Fixnum] attr_accessor :objects_from_source_skipped_by_sync def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bytes_copied_to_sink = args[:bytes_copied_to_sink] if args.key?(:bytes_copied_to_sink) @bytes_deleted_from_sink = args[:bytes_deleted_from_sink] if args.key?(:bytes_deleted_from_sink) @bytes_deleted_from_source = args[:bytes_deleted_from_source] if args.key?(:bytes_deleted_from_source) @bytes_failed_to_delete_from_sink = args[:bytes_failed_to_delete_from_sink] if args.key?(:bytes_failed_to_delete_from_sink) @bytes_found_from_source = args[:bytes_found_from_source] if args.key?(:bytes_found_from_source) @bytes_found_only_from_sink = args[:bytes_found_only_from_sink] if args.key?(:bytes_found_only_from_sink) @bytes_from_source_failed = args[:bytes_from_source_failed] if args.key?(:bytes_from_source_failed) @bytes_from_source_skipped_by_sync = args[:bytes_from_source_skipped_by_sync] if args.key?(:bytes_from_source_skipped_by_sync) @objects_copied_to_sink = args[:objects_copied_to_sink] if args.key?(:objects_copied_to_sink) @objects_deleted_from_sink = args[:objects_deleted_from_sink] if args.key?(:objects_deleted_from_sink) @objects_deleted_from_source = args[:objects_deleted_from_source] if args.key?(:objects_deleted_from_source) @objects_failed_to_delete_from_sink = args[:objects_failed_to_delete_from_sink] if args.key?(:objects_failed_to_delete_from_sink) @objects_found_from_source = args[:objects_found_from_source] if args.key?(:objects_found_from_source) @objects_found_only_from_sink = args[:objects_found_only_from_sink] if args.key?(:objects_found_only_from_sink) @objects_from_source_failed = args[:objects_from_source_failed] if args.key?(:objects_from_source_failed) @objects_from_source_skipped_by_sync = args[:objects_from_source_skipped_by_sync] if args.key?(:objects_from_source_skipped_by_sync) end end # This resource represents the configuration of a transfer job that runs # periodically. class TransferJob include Google::Apis::Core::Hashable # This field cannot be changed by user requests. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time # This field cannot be changed by user requests. # Corresponds to the JSON property `deletionTime` # @return [String] attr_accessor :deletion_time # A description provided by the user for the job. Its max length is 1024 # bytes when Unicode-encoded. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # This field cannot be changed by user requests. # Corresponds to the JSON property `lastModificationTime` # @return [String] attr_accessor :last_modification_time # A globally unique name assigned by Storage Transfer Service when the # job is created. This field should be left empty in requests to create a new # transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` # error. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The ID of the Google Cloud Platform Console project that owns the job. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # Transfers can be scheduled to recur or to run just once. # Corresponds to the JSON property `schedule` # @return [Google::Apis::StoragetransferV1::Schedule] attr_accessor :schedule # Status of the job. This value MUST be specified for # `CreateTransferJobRequests`. # NOTE: The effect of the new job status takes place during a subsequent job # run. For example, if you change the job status from `ENABLED` to # `DISABLED`, and an operation spawned by the transfer is running, the status # change would not affect the current operation. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Configuration for running a transfer. # Corresponds to the JSON property `transferSpec` # @return [Google::Apis::StoragetransferV1::TransferSpec] attr_accessor :transfer_spec def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_time = args[:creation_time] if args.key?(:creation_time) @deletion_time = args[:deletion_time] if args.key?(:deletion_time) @description = args[:description] if args.key?(:description) @last_modification_time = args[:last_modification_time] if args.key?(:last_modification_time) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @schedule = args[:schedule] if args.key?(:schedule) @status = args[:status] if args.key?(:status) @transfer_spec = args[:transfer_spec] if args.key?(:transfer_spec) end end # A description of the execution of a transfer. class TransferOperation include Google::Apis::Core::Hashable # A collection of counters that report the progress of a transfer operation. # Corresponds to the JSON property `counters` # @return [Google::Apis::StoragetransferV1::TransferCounters] attr_accessor :counters # End time of this transfer execution. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Summarizes errors encountered with sample error log entries. # Corresponds to the JSON property `errorBreakdowns` # @return [Array] attr_accessor :error_breakdowns # A globally unique ID assigned by the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The ID of the Google Cloud Platform Console project that owns the operation. # Required. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # Start time of this transfer execution. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Status of the transfer operation. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The name of the transfer job that triggers this transfer operation. # Corresponds to the JSON property `transferJobName` # @return [String] attr_accessor :transfer_job_name # Configuration for running a transfer. # Corresponds to the JSON property `transferSpec` # @return [Google::Apis::StoragetransferV1::TransferSpec] attr_accessor :transfer_spec def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @counters = args[:counters] if args.key?(:counters) @end_time = args[:end_time] if args.key?(:end_time) @error_breakdowns = args[:error_breakdowns] if args.key?(:error_breakdowns) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @transfer_job_name = args[:transfer_job_name] if args.key?(:transfer_job_name) @transfer_spec = args[:transfer_spec] if args.key?(:transfer_spec) end end # TransferOptions uses three boolean parameters to define the actions # to be performed on objects in a transfer. class TransferOptions include Google::Apis::Core::Hashable # Whether objects should be deleted from the source after they are # transferred to the sink. Note that this option and # `deleteObjectsUniqueInSink` are mutually exclusive. # Corresponds to the JSON property `deleteObjectsFromSourceAfterTransfer` # @return [Boolean] attr_accessor :delete_objects_from_source_after_transfer alias_method :delete_objects_from_source_after_transfer?, :delete_objects_from_source_after_transfer # Whether objects that exist only in the sink should be deleted. Note that # this option and `deleteObjectsFromSourceAfterTransfer` are mutually # exclusive. # Corresponds to the JSON property `deleteObjectsUniqueInSink` # @return [Boolean] attr_accessor :delete_objects_unique_in_sink alias_method :delete_objects_unique_in_sink?, :delete_objects_unique_in_sink # Whether overwriting objects that already exist in the sink is allowed. # Corresponds to the JSON property `overwriteObjectsAlreadyExistingInSink` # @return [Boolean] attr_accessor :overwrite_objects_already_existing_in_sink alias_method :overwrite_objects_already_existing_in_sink?, :overwrite_objects_already_existing_in_sink def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @delete_objects_from_source_after_transfer = args[:delete_objects_from_source_after_transfer] if args.key?(:delete_objects_from_source_after_transfer) @delete_objects_unique_in_sink = args[:delete_objects_unique_in_sink] if args.key?(:delete_objects_unique_in_sink) @overwrite_objects_already_existing_in_sink = args[:overwrite_objects_already_existing_in_sink] if args.key?(:overwrite_objects_already_existing_in_sink) end end # Configuration for running a transfer. class TransferSpec include Google::Apis::Core::Hashable # An AwsS3Data can be a data source, but not a data sink. # In an AwsS3Data, an object's name is the S3 object's key name. # Corresponds to the JSON property `awsS3DataSource` # @return [Google::Apis::StoragetransferV1::AwsS3Data] attr_accessor :aws_s3_data_source # In a GcsData, an object's name is the Google Cloud Storage object's name and # its `lastModificationTime` refers to the object's updated time, which changes # when the content or the metadata of the object is updated. # Corresponds to the JSON property `gcsDataSink` # @return [Google::Apis::StoragetransferV1::GcsData] attr_accessor :gcs_data_sink # In a GcsData, an object's name is the Google Cloud Storage object's name and # its `lastModificationTime` refers to the object's updated time, which changes # when the content or the metadata of the object is updated. # Corresponds to the JSON property `gcsDataSource` # @return [Google::Apis::StoragetransferV1::GcsData] attr_accessor :gcs_data_source # An HttpData specifies a list of objects on the web to be transferred over # HTTP. The information of the objects to be transferred is contained in a # file referenced by a URL. The first line in the file must be # "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines # specify the information of the list of objects, one object per list entry. # Each entry has the following tab-delimited fields: # * HTTP URL - The location of the object. # * Length - The size of the object in bytes. # * MD5 - The base64-encoded MD5 hash of the object. # For an example of a valid TSV file, see # [Transferring data from URLs](https://cloud.google.com/storage/transfer/create- # url-list). # When transferring data based on a URL list, keep the following in mind: # * When an object located at `http(s)://hostname:port/` is # transferred # to a data sink, the name of the object at the data sink is # `/`. # * If the specified size of an object does not match the actual size of the # object fetched, the object will not be transferred. # * If the specified MD5 does not match the MD5 computed from the transferred # bytes, the object transfer will fail. For more information, see # [Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5) # * Ensure that each URL you specify is publicly accessible. For # example, in Google Cloud Storage you can # [share an object publicly] # (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get # a link to it. # * Storage Transfer Service obeys `robots.txt` rules and requires the source # HTTP server to support `Range` requests and to return a `Content-Length` # header in each response. # * [ObjectConditions](#ObjectConditions) have no effect when filtering objects # to transfer. # Corresponds to the JSON property `httpDataSource` # @return [Google::Apis::StoragetransferV1::HttpData] attr_accessor :http_data_source # Conditions that determine which objects will be transferred. # Corresponds to the JSON property `objectConditions` # @return [Google::Apis::StoragetransferV1::ObjectConditions] attr_accessor :object_conditions # TransferOptions uses three boolean parameters to define the actions # to be performed on objects in a transfer. # Corresponds to the JSON property `transferOptions` # @return [Google::Apis::StoragetransferV1::TransferOptions] attr_accessor :transfer_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aws_s3_data_source = args[:aws_s3_data_source] if args.key?(:aws_s3_data_source) @gcs_data_sink = args[:gcs_data_sink] if args.key?(:gcs_data_sink) @gcs_data_source = args[:gcs_data_source] if args.key?(:gcs_data_source) @http_data_source = args[:http_data_source] if args.key?(:http_data_source) @object_conditions = args[:object_conditions] if args.key?(:object_conditions) @transfer_options = args[:transfer_options] if args.key?(:transfer_options) end end # Request passed to UpdateTransferJob. class UpdateTransferJobRequest include Google::Apis::Core::Hashable # The ID of the Google Cloud Platform Console project that owns the job. # Required. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # This resource represents the configuration of a transfer job that runs # periodically. # Corresponds to the JSON property `transferJob` # @return [Google::Apis::StoragetransferV1::TransferJob] attr_accessor :transfer_job # The field mask of the fields in `transferJob` that are to be updated in # this request. Fields in `transferJob` that can be updated are: # `description`, `transferSpec`, and `status`. To update the `transferSpec` # of the job, a complete transfer specification has to be provided. An # incomplete specification which misses any required fields will be rejected # with the error `INVALID_ARGUMENT`. # Corresponds to the JSON property `updateTransferJobFieldMask` # @return [String] attr_accessor :update_transfer_job_field_mask def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @project_id = args[:project_id] if args.key?(:project_id) @transfer_job = args[:transfer_job] if args.key?(:transfer_job) @update_transfer_job_field_mask = args[:update_transfer_job_field_mask] if args.key?(:update_transfer_job_field_mask) end end end end end google-api-client-0.19.8/generated/google/apis/storagetransfer_v1/service.rb0000644000004100000410000006457713252673044027143 0ustar www-datawww-data# 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 StoragetransferV1 # Google Storage Transfer API # # Transfers data from external data sources to a Google Cloud Storage bucket or # between Google Cloud Storage buckets. # # @example # require 'google/apis/storagetransfer_v1' # # Storagetransfer = Google::Apis::StoragetransferV1 # Alias the module # service = Storagetransfer::StoragetransferService.new # # @see https://cloud.google.com/storage/transfer class StoragetransferService < 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://storagetransfer.googleapis.com/', '') @batch_path = 'batch' end # Returns the Google service account that is used by Storage Transfer # Service to access buckets in the project where transfers # run or in other projects. Each Google service account is associated # with one Google Cloud Platform Console project. Users # should add this service account to the Google Cloud Storage bucket # ACLs to grant access to Storage Transfer Service. This service # account is created and owned by Storage Transfer Service and can # only be used by Storage Transfer Service. # @param [String] project_id # The ID of the Google Cloud Platform Console project that the Google service # account is associated with. # 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::StoragetransferV1::GoogleServiceAccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::GoogleServiceAccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_service_account(project_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/googleServiceAccounts/{projectId}', options) command.response_representation = Google::Apis::StoragetransferV1::GoogleServiceAccount::Representation command.response_class = Google::Apis::StoragetransferV1::GoogleServiceAccount 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 transfer job that runs periodically. # @param [Google::Apis::StoragetransferV1::TransferJob] transfer_job_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::StoragetransferV1::TransferJob] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::TransferJob] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_job(transfer_job_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/transferJobs', options) command.request_representation = Google::Apis::StoragetransferV1::TransferJob::Representation command.request_object = transfer_job_object command.response_representation = Google::Apis::StoragetransferV1::TransferJob::Representation command.response_class = Google::Apis::StoragetransferV1::TransferJob 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 transfer job. # @param [String] job_name # The job to get. # Required. # @param [String] project_id # The ID of the Google Cloud Platform Console project that owns the job. # 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::StoragetransferV1::TransferJob] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::TransferJob] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_job(job_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+jobName}', options) command.response_representation = Google::Apis::StoragetransferV1::TransferJob::Representation command.response_class = Google::Apis::StoragetransferV1::TransferJob command.params['jobName'] = job_name unless job_name.nil? command.query['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 # Lists transfer jobs. # @param [String] filter # A list of query parameters specified as JSON text in the form of # `"project_id":"my_project_id", # "job_names":["jobid1","jobid2",...], # "job_statuses":["status1","status2",...]`. # Since `job_names` and `job_statuses` support multiple values, their values # must be specified with array notation. `project_id` is required. `job_names` # and `job_statuses` are optional. The valid values for `job_statuses` are # case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`. # @param [Fixnum] page_size # The list page size. The max allowed value is 256. # @param [String] page_token # The 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::StoragetransferV1::ListTransferJobsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::ListTransferJobsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_jobs(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/transferJobs', options) command.response_representation = Google::Apis::StoragetransferV1::ListTransferJobsResponse::Representation command.response_class = Google::Apis::StoragetransferV1::ListTransferJobsResponse 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 transfer job. Updating a job's transfer spec does not affect # transfer operations that are running already. Updating the scheduling # of a job is not allowed. # @param [String] job_name # The name of job to update. # Required. # @param [Google::Apis::StoragetransferV1::UpdateTransferJobRequest] update_transfer_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::StoragetransferV1::TransferJob] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::TransferJob] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_job(job_name, update_transfer_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+jobName}', options) command.request_representation = Google::Apis::StoragetransferV1::UpdateTransferJobRequest::Representation command.request_object = update_transfer_job_request_object command.response_representation = Google::Apis::StoragetransferV1::TransferJob::Representation command.response_class = Google::Apis::StoragetransferV1::TransferJob command.params['jobName'] = job_name unless job_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 # Cancels a transfer. Use the get method to check whether the cancellation # succeeded or whether the operation completed despite cancellation. # @param [String] name # The name of the operation resource to be cancelled. # @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::StoragetransferV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::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 cancel_transfer_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation command.response_class = Google::Apis::StoragetransferV1::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 # This method is not supported and the server returns `UNIMPLEMENTED`. # @param [String] name # The name of the operation resource 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::StoragetransferV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::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_transfer_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation command.response_class = Google::Apis::StoragetransferV1::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 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::StoragetransferV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::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_transfer_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::StoragetransferV1::Operation::Representation command.response_class = Google::Apis::StoragetransferV1::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 # 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 value `transferOperations`. # @param [String] filter # A list of query parameters specified as JSON text in the form of `\"project_id\ # " : \"my_project_id\", \"job_names\" : [\"jobid1\", \"jobid2\",...], \" # operation_names\" : [\"opid1\", \"opid2\",...], \"transfer_statuses\":[\" # status1\", \"status2\",...]`. Since `job_names`, `operation_names`, and ` # transfer_statuses` support multiple values, they must be specified with array # notation. `job_names`, `operation_names`, and `transfer_statuses` are optional. # @param [Fixnum] page_size # The list page size. The max allowed value is 256. # @param [String] page_token # The 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::StoragetransferV1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_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}', options) command.response_representation = Google::Apis::StoragetransferV1::ListOperationsResponse::Representation command.response_class = Google::Apis::StoragetransferV1::ListOperationsResponse 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 # Pauses a transfer operation. # @param [String] name # The name of the transfer operation. # Required. # @param [Google::Apis::StoragetransferV1::PauseTransferOperationRequest] pause_transfer_operation_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::StoragetransferV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::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 pause_transfer_operation(name, pause_transfer_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:pause', options) command.request_representation = Google::Apis::StoragetransferV1::PauseTransferOperationRequest::Representation command.request_object = pause_transfer_operation_request_object command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation command.response_class = Google::Apis::StoragetransferV1::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 # Resumes a transfer operation that is paused. # @param [String] name # The name of the transfer operation. # Required. # @param [Google::Apis::StoragetransferV1::ResumeTransferOperationRequest] resume_transfer_operation_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::StoragetransferV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StoragetransferV1::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 resume_transfer_operation(name, resume_transfer_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:resume', options) command.request_representation = Google::Apis::StoragetransferV1::ResumeTransferOperationRequest::Representation command.request_object = resume_transfer_operation_request_object command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation command.response_class = Google::Apis::StoragetransferV1::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 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 google-api-client-0.19.8/generated/google/apis/sqladmin_v1beta4/0000755000004100000410000000000013252673044024452 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/sqladmin_v1beta4/representations.rb0000644000004100000410000011011013252673044030216 0ustar www-datawww-data# 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 SqladminV1beta4 class AclEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackupConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackupRun class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListBackupRunsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BinLogCoordinates class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CloneContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Database class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatabaseFlags class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatabaseInstance class Representation < Google::Apis::Core::JsonRepresentation; end class FailoverReplica class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ListDatabasesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DemoteMasterConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DemoteMasterContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DemoteMasterMySqlReplicaConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExportContext class Representation < Google::Apis::Core::JsonRepresentation; end class CsvExportOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SqlExportOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class FailoverContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Flag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListFlagsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportContext class Representation < Google::Apis::Core::JsonRepresentation; end class CsvImportOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class CloneInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesDemoteMasterRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExportInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesFailoverRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListInstancesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RestoreInstancesBackupRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesTruncateLogRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IpConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IpMapping class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LocationPreference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MaintenanceWindow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MySqlReplicaConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OnPremisesConfiguration 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 OperationError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperationErrors class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReplicaConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RestoreBackupContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Settings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SslCert class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SslCertDetail class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SslCertsCreateEphemeralRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InsertSslCertsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InsertSslCertsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListSslCertsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Tier class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTiersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TruncateLogContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class User class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListUsersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AclEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :expiration_time, as: 'expirationTime', type: DateTime property :kind, as: 'kind' property :name, as: 'name' property :value, as: 'value' end end class BackupConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :binary_log_enabled, as: 'binaryLogEnabled' property :enabled, as: 'enabled' property :kind, as: 'kind' property :replication_log_archiving_enabled, as: 'replicationLogArchivingEnabled' property :start_time, as: 'startTime' end end class BackupRun # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :end_time, as: 'endTime', type: DateTime property :enqueued_time, as: 'enqueuedTime', type: DateTime property :error, as: 'error', class: Google::Apis::SqladminV1beta4::OperationError, decorator: Google::Apis::SqladminV1beta4::OperationError::Representation property :id, :numeric_string => true, as: 'id' property :instance, as: 'instance' property :kind, as: 'kind' property :self_link, as: 'selfLink' property :start_time, as: 'startTime', type: DateTime property :status, as: 'status' property :type, as: 'type' property :window_start_time, as: 'windowStartTime', type: DateTime end end class ListBackupRunsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::SqladminV1beta4::BackupRun, decorator: Google::Apis::SqladminV1beta4::BackupRun::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class BinLogCoordinates # @private class Representation < Google::Apis::Core::JsonRepresentation property :bin_log_file_name, as: 'binLogFileName' property :bin_log_position, :numeric_string => true, as: 'binLogPosition' property :kind, as: 'kind' end end class CloneContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :bin_log_coordinates, as: 'binLogCoordinates', class: Google::Apis::SqladminV1beta4::BinLogCoordinates, decorator: Google::Apis::SqladminV1beta4::BinLogCoordinates::Representation property :destination_instance_name, as: 'destinationInstanceName' property :kind, as: 'kind' property :pitr_timestamp_ms, :numeric_string => true, as: 'pitrTimestampMs' end end class Database # @private class Representation < Google::Apis::Core::JsonRepresentation property :charset, as: 'charset' property :collation, as: 'collation' property :etag, as: 'etag' property :instance, as: 'instance' property :kind, as: 'kind' property :name, as: 'name' property :project, as: 'project' property :self_link, as: 'selfLink' end end class DatabaseFlags # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :value, as: 'value' end end class DatabaseInstance # @private class Representation < Google::Apis::Core::JsonRepresentation property :backend_type, as: 'backendType' property :connection_name, as: 'connectionName' property :current_disk_size, :numeric_string => true, as: 'currentDiskSize' property :database_version, as: 'databaseVersion' property :etag, as: 'etag' property :failover_replica, as: 'failoverReplica', class: Google::Apis::SqladminV1beta4::DatabaseInstance::FailoverReplica, decorator: Google::Apis::SqladminV1beta4::DatabaseInstance::FailoverReplica::Representation property :gce_zone, as: 'gceZone' property :instance_type, as: 'instanceType' collection :ip_addresses, as: 'ipAddresses', class: Google::Apis::SqladminV1beta4::IpMapping, decorator: Google::Apis::SqladminV1beta4::IpMapping::Representation property :ipv6_address, as: 'ipv6Address' property :kind, as: 'kind' property :master_instance_name, as: 'masterInstanceName' property :max_disk_size, :numeric_string => true, as: 'maxDiskSize' property :name, as: 'name' property :on_premises_configuration, as: 'onPremisesConfiguration', class: Google::Apis::SqladminV1beta4::OnPremisesConfiguration, decorator: Google::Apis::SqladminV1beta4::OnPremisesConfiguration::Representation property :project, as: 'project' property :region, as: 'region' property :replica_configuration, as: 'replicaConfiguration', class: Google::Apis::SqladminV1beta4::ReplicaConfiguration, decorator: Google::Apis::SqladminV1beta4::ReplicaConfiguration::Representation collection :replica_names, as: 'replicaNames' property :self_link, as: 'selfLink' property :server_ca_cert, as: 'serverCaCert', class: Google::Apis::SqladminV1beta4::SslCert, decorator: Google::Apis::SqladminV1beta4::SslCert::Representation property :service_account_email_address, as: 'serviceAccountEmailAddress' property :settings, as: 'settings', class: Google::Apis::SqladminV1beta4::Settings, decorator: Google::Apis::SqladminV1beta4::Settings::Representation property :state, as: 'state' collection :suspension_reason, as: 'suspensionReason' end class FailoverReplica # @private class Representation < Google::Apis::Core::JsonRepresentation property :available, as: 'available' property :name, as: 'name' end end end class ListDatabasesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::SqladminV1beta4::Database, decorator: Google::Apis::SqladminV1beta4::Database::Representation property :kind, as: 'kind' end end class DemoteMasterConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :mysql_replica_configuration, as: 'mysqlReplicaConfiguration', class: Google::Apis::SqladminV1beta4::DemoteMasterMySqlReplicaConfiguration, decorator: Google::Apis::SqladminV1beta4::DemoteMasterMySqlReplicaConfiguration::Representation end end class DemoteMasterContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :master_instance_name, as: 'masterInstanceName' property :replica_configuration, as: 'replicaConfiguration', class: Google::Apis::SqladminV1beta4::DemoteMasterConfiguration, decorator: Google::Apis::SqladminV1beta4::DemoteMasterConfiguration::Representation end end class DemoteMasterMySqlReplicaConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :ca_certificate, as: 'caCertificate' property :client_certificate, as: 'clientCertificate' property :client_key, as: 'clientKey' property :kind, as: 'kind' property :password, as: 'password' property :username, as: 'username' end end class ExportContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :csv_export_options, as: 'csvExportOptions', class: Google::Apis::SqladminV1beta4::ExportContext::CsvExportOptions, decorator: Google::Apis::SqladminV1beta4::ExportContext::CsvExportOptions::Representation collection :databases, as: 'databases' property :file_type, as: 'fileType' property :kind, as: 'kind' property :sql_export_options, as: 'sqlExportOptions', class: Google::Apis::SqladminV1beta4::ExportContext::SqlExportOptions, decorator: Google::Apis::SqladminV1beta4::ExportContext::SqlExportOptions::Representation property :uri, as: 'uri' end class CsvExportOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :select_query, as: 'selectQuery' end end class SqlExportOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :schema_only, as: 'schemaOnly' collection :tables, as: 'tables' end end end class FailoverContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :settings_version, :numeric_string => true, as: 'settingsVersion' end end class Flag # @private class Representation < Google::Apis::Core::JsonRepresentation collection :allowed_string_values, as: 'allowedStringValues' collection :applies_to, as: 'appliesTo' property :kind, as: 'kind' property :max_value, :numeric_string => true, as: 'maxValue' property :min_value, :numeric_string => true, as: 'minValue' property :name, as: 'name' property :requires_restart, as: 'requiresRestart' property :type, as: 'type' end end class ListFlagsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::SqladminV1beta4::Flag, decorator: Google::Apis::SqladminV1beta4::Flag::Representation property :kind, as: 'kind' end end class ImportContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :csv_import_options, as: 'csvImportOptions', class: Google::Apis::SqladminV1beta4::ImportContext::CsvImportOptions, decorator: Google::Apis::SqladminV1beta4::ImportContext::CsvImportOptions::Representation property :database, as: 'database' property :file_type, as: 'fileType' property :import_user, as: 'importUser' property :kind, as: 'kind' property :uri, as: 'uri' end class CsvImportOptions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :columns, as: 'columns' property :table, as: 'table' end end end class CloneInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :clone_context, as: 'cloneContext', class: Google::Apis::SqladminV1beta4::CloneContext, decorator: Google::Apis::SqladminV1beta4::CloneContext::Representation end end class InstancesDemoteMasterRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :demote_master_context, as: 'demoteMasterContext', class: Google::Apis::SqladminV1beta4::DemoteMasterContext, decorator: Google::Apis::SqladminV1beta4::DemoteMasterContext::Representation end end class ExportInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :export_context, as: 'exportContext', class: Google::Apis::SqladminV1beta4::ExportContext, decorator: Google::Apis::SqladminV1beta4::ExportContext::Representation end end class InstancesFailoverRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :failover_context, as: 'failoverContext', class: Google::Apis::SqladminV1beta4::FailoverContext, decorator: Google::Apis::SqladminV1beta4::FailoverContext::Representation end end class ImportInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :import_context, as: 'importContext', class: Google::Apis::SqladminV1beta4::ImportContext, decorator: Google::Apis::SqladminV1beta4::ImportContext::Representation end end class ListInstancesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::SqladminV1beta4::DatabaseInstance, decorator: Google::Apis::SqladminV1beta4::DatabaseInstance::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class RestoreInstancesBackupRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :restore_backup_context, as: 'restoreBackupContext', class: Google::Apis::SqladminV1beta4::RestoreBackupContext, decorator: Google::Apis::SqladminV1beta4::RestoreBackupContext::Representation end end class InstancesTruncateLogRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :truncate_log_context, as: 'truncateLogContext', class: Google::Apis::SqladminV1beta4::TruncateLogContext, decorator: Google::Apis::SqladminV1beta4::TruncateLogContext::Representation end end class IpConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation collection :authorized_networks, as: 'authorizedNetworks', class: Google::Apis::SqladminV1beta4::AclEntry, decorator: Google::Apis::SqladminV1beta4::AclEntry::Representation property :ipv4_enabled, as: 'ipv4Enabled' property :require_ssl, as: 'requireSsl' end end class IpMapping # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_address, as: 'ipAddress' property :time_to_retire, as: 'timeToRetire', type: DateTime property :type, as: 'type' end end class LocationPreference # @private class Representation < Google::Apis::Core::JsonRepresentation property :follow_gae_application, as: 'followGaeApplication' property :kind, as: 'kind' property :zone, as: 'zone' end end class MaintenanceWindow # @private class Representation < Google::Apis::Core::JsonRepresentation property :day, as: 'day' property :hour, as: 'hour' property :kind, as: 'kind' property :update_track, as: 'updateTrack' end end class MySqlReplicaConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :ca_certificate, as: 'caCertificate' property :client_certificate, as: 'clientCertificate' property :client_key, as: 'clientKey' property :connect_retry_interval, as: 'connectRetryInterval' property :dump_file_path, as: 'dumpFilePath' property :kind, as: 'kind' property :master_heartbeat_period, :numeric_string => true, as: 'masterHeartbeatPeriod' property :password, as: 'password' property :ssl_cipher, as: 'sslCipher' property :username, as: 'username' property :verify_server_certificate, as: 'verifyServerCertificate' end end class OnPremisesConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :host_port, as: 'hostPort' property :kind, as: 'kind' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime', type: DateTime property :error, as: 'error', class: Google::Apis::SqladminV1beta4::OperationErrors, decorator: Google::Apis::SqladminV1beta4::OperationErrors::Representation property :export_context, as: 'exportContext', class: Google::Apis::SqladminV1beta4::ExportContext, decorator: Google::Apis::SqladminV1beta4::ExportContext::Representation property :import_context, as: 'importContext', class: Google::Apis::SqladminV1beta4::ImportContext, decorator: Google::Apis::SqladminV1beta4::ImportContext::Representation property :insert_time, as: 'insertTime', type: DateTime property :kind, as: 'kind' property :name, as: 'name' property :operation_type, as: 'operationType' property :self_link, as: 'selfLink' property :start_time, as: 'startTime', type: DateTime property :status, as: 'status' property :target_id, as: 'targetId' property :target_link, as: 'targetLink' property :target_project, as: 'targetProject' property :user, as: 'user' end end class OperationError # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :kind, as: 'kind' property :message, as: 'message' end end class OperationErrors # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::SqladminV1beta4::OperationError, decorator: Google::Apis::SqladminV1beta4::OperationError::Representation property :kind, as: 'kind' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::SqladminV1beta4::Operation, decorator: Google::Apis::SqladminV1beta4::Operation::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class ReplicaConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :failover_target, as: 'failoverTarget' property :kind, as: 'kind' property :mysql_replica_configuration, as: 'mysqlReplicaConfiguration', class: Google::Apis::SqladminV1beta4::MySqlReplicaConfiguration, decorator: Google::Apis::SqladminV1beta4::MySqlReplicaConfiguration::Representation end end class RestoreBackupContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :backup_run_id, :numeric_string => true, as: 'backupRunId' property :instance_id, as: 'instanceId' property :kind, as: 'kind' end end class Settings # @private class Representation < Google::Apis::Core::JsonRepresentation property :activation_policy, as: 'activationPolicy' collection :authorized_gae_applications, as: 'authorizedGaeApplications' property :availability_type, as: 'availabilityType' property :backup_configuration, as: 'backupConfiguration', class: Google::Apis::SqladminV1beta4::BackupConfiguration, decorator: Google::Apis::SqladminV1beta4::BackupConfiguration::Representation property :crash_safe_replication_enabled, as: 'crashSafeReplicationEnabled' property :data_disk_size_gb, :numeric_string => true, as: 'dataDiskSizeGb' property :data_disk_type, as: 'dataDiskType' collection :database_flags, as: 'databaseFlags', class: Google::Apis::SqladminV1beta4::DatabaseFlags, decorator: Google::Apis::SqladminV1beta4::DatabaseFlags::Representation property :database_replication_enabled, as: 'databaseReplicationEnabled' property :ip_configuration, as: 'ipConfiguration', class: Google::Apis::SqladminV1beta4::IpConfiguration, decorator: Google::Apis::SqladminV1beta4::IpConfiguration::Representation property :kind, as: 'kind' property :location_preference, as: 'locationPreference', class: Google::Apis::SqladminV1beta4::LocationPreference, decorator: Google::Apis::SqladminV1beta4::LocationPreference::Representation property :maintenance_window, as: 'maintenanceWindow', class: Google::Apis::SqladminV1beta4::MaintenanceWindow, decorator: Google::Apis::SqladminV1beta4::MaintenanceWindow::Representation property :pricing_plan, as: 'pricingPlan' property :replication_type, as: 'replicationType' property :settings_version, :numeric_string => true, as: 'settingsVersion' property :storage_auto_resize, as: 'storageAutoResize' property :storage_auto_resize_limit, :numeric_string => true, as: 'storageAutoResizeLimit' property :tier, as: 'tier' hash :user_labels, as: 'userLabels' end end class SslCert # @private class Representation < Google::Apis::Core::JsonRepresentation property :cert, as: 'cert' property :cert_serial_number, as: 'certSerialNumber' property :common_name, as: 'commonName' property :create_time, as: 'createTime', type: DateTime property :expiration_time, as: 'expirationTime', type: DateTime property :instance, as: 'instance' property :kind, as: 'kind' property :self_link, as: 'selfLink' property :sha1_fingerprint, as: 'sha1Fingerprint' end end class SslCertDetail # @private class Representation < Google::Apis::Core::JsonRepresentation property :cert_info, as: 'certInfo', class: Google::Apis::SqladminV1beta4::SslCert, decorator: Google::Apis::SqladminV1beta4::SslCert::Representation property :cert_private_key, as: 'certPrivateKey' end end class SslCertsCreateEphemeralRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :public_key, as: 'public_key' end end class InsertSslCertsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :common_name, as: 'commonName' end end class InsertSslCertsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_cert, as: 'clientCert', class: Google::Apis::SqladminV1beta4::SslCertDetail, decorator: Google::Apis::SqladminV1beta4::SslCertDetail::Representation property :kind, as: 'kind' property :operation, as: 'operation', class: Google::Apis::SqladminV1beta4::Operation, decorator: Google::Apis::SqladminV1beta4::Operation::Representation property :server_ca_cert, as: 'serverCaCert', class: Google::Apis::SqladminV1beta4::SslCert, decorator: Google::Apis::SqladminV1beta4::SslCert::Representation end end class ListSslCertsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::SqladminV1beta4::SslCert, decorator: Google::Apis::SqladminV1beta4::SslCert::Representation property :kind, as: 'kind' end end class Tier # @private class Representation < Google::Apis::Core::JsonRepresentation property :disk_quota, :numeric_string => true, as: 'DiskQuota' property :ram, :numeric_string => true, as: 'RAM' property :kind, as: 'kind' collection :region, as: 'region' property :tier, as: 'tier' end end class ListTiersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::SqladminV1beta4::Tier, decorator: Google::Apis::SqladminV1beta4::Tier::Representation property :kind, as: 'kind' end end class TruncateLogContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :log_type, as: 'logType' end end class User # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :host, as: 'host' property :instance, as: 'instance' property :kind, as: 'kind' property :name, as: 'name' property :password, as: 'password' property :project, as: 'project' end end class ListUsersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::SqladminV1beta4::User, decorator: Google::Apis::SqladminV1beta4::User::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end end end end google-api-client-0.19.8/generated/google/apis/sqladmin_v1beta4/classes.rb0000644000004100000410000026145613252673044026452 0ustar www-datawww-data# 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 SqladminV1beta4 # An entry for an Access Control list. class AclEntry include Google::Apis::Core::Hashable # The time when this access control entry expires in RFC 3339 format, for # example 2012-11-15T16:19:00.094Z. # Corresponds to the JSON property `expirationTime` # @return [DateTime] attr_accessor :expiration_time # This is always sql#aclEntry. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # An optional label to identify this entry. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The whitelisted value for the access control list. # 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) @expiration_time = args[:expiration_time] if args.key?(:expiration_time) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @value = args[:value] if args.key?(:value) end end # Database instance backup configuration. class BackupConfiguration include Google::Apis::Core::Hashable # Whether binary log is enabled. If backup configuration is disabled, binary log # must be disabled as well. # Corresponds to the JSON property `binaryLogEnabled` # @return [Boolean] attr_accessor :binary_log_enabled alias_method :binary_log_enabled?, :binary_log_enabled # Whether this configuration is enabled. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # This is always sql#backupConfiguration. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Whether replication log archiving is enabled. Replication log archiving is # required for the point-in-time recovery (PITR) feature. PostgreSQL instances # only. # Corresponds to the JSON property `replicationLogArchivingEnabled` # @return [Boolean] attr_accessor :replication_log_archiving_enabled alias_method :replication_log_archiving_enabled?, :replication_log_archiving_enabled # Start time for the daily backup configuration in UTC timezone in the 24 hour # format - HH:MM. # 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) @binary_log_enabled = args[:binary_log_enabled] if args.key?(:binary_log_enabled) @enabled = args[:enabled] if args.key?(:enabled) @kind = args[:kind] if args.key?(:kind) @replication_log_archiving_enabled = args[:replication_log_archiving_enabled] if args.key?(:replication_log_archiving_enabled) @start_time = args[:start_time] if args.key?(:start_time) end end # A database instance backup run resource. class BackupRun include Google::Apis::Core::Hashable # The description of this run, only applicable to on-demand backups. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The time the backup operation completed in UTC timezone in RFC 3339 format, # for example 2012-11-15T16:19:00.094Z. # Corresponds to the JSON property `endTime` # @return [DateTime] attr_accessor :end_time # The time the run was enqueued in UTC timezone in RFC 3339 format, for example # 2012-11-15T16:19:00.094Z. # Corresponds to the JSON property `enqueuedTime` # @return [DateTime] attr_accessor :enqueued_time # Database instance operation error. # Corresponds to the JSON property `error` # @return [Google::Apis::SqladminV1beta4::OperationError] attr_accessor :error # A unique identifier for this backup run. Note that this is unique only within # the scope of a particular Cloud SQL instance. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Name of the database instance. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # This is always sql#backupRun. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The URI of this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The time the backup operation actually started in UTC timezone in RFC 3339 # format, for example 2012-11-15T16:19:00.094Z. # Corresponds to the JSON property `startTime` # @return [DateTime] attr_accessor :start_time # The status of this run. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The type of this run; can be either "AUTOMATED" or "ON_DEMAND". # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The start time of the backup window during which this the backup was attempted # in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. # Corresponds to the JSON property `windowStartTime` # @return [DateTime] attr_accessor :window_start_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @end_time = args[:end_time] if args.key?(:end_time) @enqueued_time = args[:enqueued_time] if args.key?(:enqueued_time) @error = args[:error] if args.key?(:error) @id = args[:id] if args.key?(:id) @instance = args[:instance] if args.key?(:instance) @kind = args[:kind] if args.key?(:kind) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @type = args[:type] if args.key?(:type) @window_start_time = args[:window_start_time] if args.key?(:window_start_time) end end # Backup run list results. class ListBackupRunsResponse include Google::Apis::Core::Hashable # A list of backup runs in reverse chronological order of the enqueued time. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # This is always sql#backupRunsList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, used to page through large result sets. Provide this # value in a subsequent request to return 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) @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) end end # Binary log coordinates. class BinLogCoordinates include Google::Apis::Core::Hashable # Name of the binary log file for a Cloud SQL instance. # Corresponds to the JSON property `binLogFileName` # @return [String] attr_accessor :bin_log_file_name # Position (offset) within the binary log file. # Corresponds to the JSON property `binLogPosition` # @return [Fixnum] attr_accessor :bin_log_position # This is always sql#binLogCoordinates. # 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) @bin_log_file_name = args[:bin_log_file_name] if args.key?(:bin_log_file_name) @bin_log_position = args[:bin_log_position] if args.key?(:bin_log_position) @kind = args[:kind] if args.key?(:kind) end end # Database instance clone context. class CloneContext include Google::Apis::Core::Hashable # Binary log coordinates. # Corresponds to the JSON property `binLogCoordinates` # @return [Google::Apis::SqladminV1beta4::BinLogCoordinates] attr_accessor :bin_log_coordinates # Name of the Cloud SQL instance to be created as a clone. # Corresponds to the JSON property `destinationInstanceName` # @return [String] attr_accessor :destination_instance_name # This is always sql#cloneContext. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The epoch timestamp, in milliseconds, of the time to which a point-in-time # recovery (PITR) is performed. PostgreSQL instances only. For MySQL instances, # use the binLogCoordinates property. # Corresponds to the JSON property `pitrTimestampMs` # @return [Fixnum] attr_accessor :pitr_timestamp_ms def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bin_log_coordinates = args[:bin_log_coordinates] if args.key?(:bin_log_coordinates) @destination_instance_name = args[:destination_instance_name] if args.key?(:destination_instance_name) @kind = args[:kind] if args.key?(:kind) @pitr_timestamp_ms = args[:pitr_timestamp_ms] if args.key?(:pitr_timestamp_ms) end end # A database resource inside a Cloud SQL instance. class Database include Google::Apis::Core::Hashable # The MySQL charset value. # Corresponds to the JSON property `charset` # @return [String] attr_accessor :charset # The MySQL collation value. # Corresponds to the JSON property `collation` # @return [String] attr_accessor :collation # HTTP 1.1 Entity tag for the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The name of the Cloud SQL instance. This does not include the project ID. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # This is always sql#database. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the database in the Cloud SQL instance. This does not include the # project ID or instance name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The project ID of the project containing the Cloud SQL database. The Google # apps domain is prefixed if applicable. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project # The URI of this 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) @charset = args[:charset] if args.key?(:charset) @collation = args[:collation] if args.key?(:collation) @etag = args[:etag] if args.key?(:etag) @instance = args[:instance] if args.key?(:instance) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @project = args[:project] if args.key?(:project) @self_link = args[:self_link] if args.key?(:self_link) end end # MySQL flags for Cloud SQL instances. class DatabaseFlags include Google::Apis::Core::Hashable # The name of the flag. These flags are passed at instance startup, so include # both MySQL server options and MySQL system variables. Flags should be # specified with underscores, not hyphens. For more information, see Configuring # MySQL Flags in the Google Cloud SQL documentation, as well as the official # MySQL documentation for server options and system variables. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The value of the flag. Booleans should be set to on for true and off for false. # This field must be omitted if the flag doesn't take a 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 # A Cloud SQL instance resource. class DatabaseInstance include Google::Apis::Core::Hashable # FIRST_GEN: Basic Cloud SQL instance that runs in a Google-managed container. # SECOND_GEN: A newer Cloud SQL backend that runs in a Compute Engine VM. # EXTERNAL: A MySQL server that is not managed by Google. # Corresponds to the JSON property `backendType` # @return [String] attr_accessor :backend_type # Connection name of the Cloud SQL instance used in connection strings. # Corresponds to the JSON property `connectionName` # @return [String] attr_accessor :connection_name # The current disk usage of the instance in bytes. This property has been # deprecated. Users should use the "cloudsql.googleapis.com/database/disk/ # bytes_used" metric in Cloud Monitoring API instead. Please see https://groups. # google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ for # details. # Corresponds to the JSON property `currentDiskSize` # @return [Fixnum] attr_accessor :current_disk_size # The database engine type and version. The databaseVersion field can not be # changed after instance creation. MySQL Second Generation instances: MYSQL_5_7 ( # default) or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6 MySQL First # Generation instances: MYSQL_5_6 (default) or MYSQL_5_5 # Corresponds to the JSON property `databaseVersion` # @return [String] attr_accessor :database_version # HTTP 1.1 Entity tag for the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The name and status of the failover replica. This property is applicable only # to Second Generation instances. # Corresponds to the JSON property `failoverReplica` # @return [Google::Apis::SqladminV1beta4::DatabaseInstance::FailoverReplica] attr_accessor :failover_replica # The Compute Engine zone that the instance is currently serving from. This # value could be different from the zone that was specified when the instance # was created if the instance has failed over to its secondary zone. # Corresponds to the JSON property `gceZone` # @return [String] attr_accessor :gce_zone # The instance type. This can be one of the following. # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. # ON_PREMISES_INSTANCE: An instance running on the customer's premises. # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica. # Corresponds to the JSON property `instanceType` # @return [String] attr_accessor :instance_type # The assigned IP addresses for the instance. # Corresponds to the JSON property `ipAddresses` # @return [Array] attr_accessor :ip_addresses # The IPv6 address assigned to the instance. This property is applicable only to # First Generation instances. # Corresponds to the JSON property `ipv6Address` # @return [String] attr_accessor :ipv6_address # This is always sql#instance. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the instance which will act as master in the replication setup. # Corresponds to the JSON property `masterInstanceName` # @return [String] attr_accessor :master_instance_name # The maximum disk size of the instance in bytes. # Corresponds to the JSON property `maxDiskSize` # @return [Fixnum] attr_accessor :max_disk_size # Name of the Cloud SQL instance. This does not include the project ID. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # On-premises instance configuration. # Corresponds to the JSON property `onPremisesConfiguration` # @return [Google::Apis::SqladminV1beta4::OnPremisesConfiguration] attr_accessor :on_premises_configuration # The project ID of the project containing the Cloud SQL instance. The Google # apps domain is prefixed if applicable. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project # The geographical region. Can be us-central (FIRST_GEN instances only), us- # central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to # us-central or us-central1 depending on the instance type (First Generation or # Second Generation). The region can not be changed after instance creation. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # Read-replica configuration for connecting to the master. # Corresponds to the JSON property `replicaConfiguration` # @return [Google::Apis::SqladminV1beta4::ReplicaConfiguration] attr_accessor :replica_configuration # The replicas of the instance. # Corresponds to the JSON property `replicaNames` # @return [Array] attr_accessor :replica_names # The URI of this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # SslCerts Resource # Corresponds to the JSON property `serverCaCert` # @return [Google::Apis::SqladminV1beta4::SslCert] attr_accessor :server_ca_cert # The service account email address assigned to the instance. This property is # applicable only to Second Generation instances. # Corresponds to the JSON property `serviceAccountEmailAddress` # @return [String] attr_accessor :service_account_email_address # Database instance settings. # Corresponds to the JSON property `settings` # @return [Google::Apis::SqladminV1beta4::Settings] attr_accessor :settings # The current serving state of the Cloud SQL instance. This can be one of the # following. # RUNNABLE: The instance is running, or is ready to run when accessed. # SUSPENDED: The instance is not available, for example due to problems with # billing. # PENDING_CREATE: The instance is being created. # MAINTENANCE: The instance is down for maintenance. # FAILED: The instance creation failed. # UNKNOWN_STATE: The state of the instance is unknown. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # If the instance state is SUSPENDED, the reason for the suspension. # Corresponds to the JSON property `suspensionReason` # @return [Array] attr_accessor :suspension_reason def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @backend_type = args[:backend_type] if args.key?(:backend_type) @connection_name = args[:connection_name] if args.key?(:connection_name) @current_disk_size = args[:current_disk_size] if args.key?(:current_disk_size) @database_version = args[:database_version] if args.key?(:database_version) @etag = args[:etag] if args.key?(:etag) @failover_replica = args[:failover_replica] if args.key?(:failover_replica) @gce_zone = args[:gce_zone] if args.key?(:gce_zone) @instance_type = args[:instance_type] if args.key?(:instance_type) @ip_addresses = args[:ip_addresses] if args.key?(:ip_addresses) @ipv6_address = args[:ipv6_address] if args.key?(:ipv6_address) @kind = args[:kind] if args.key?(:kind) @master_instance_name = args[:master_instance_name] if args.key?(:master_instance_name) @max_disk_size = args[:max_disk_size] if args.key?(:max_disk_size) @name = args[:name] if args.key?(:name) @on_premises_configuration = args[:on_premises_configuration] if args.key?(:on_premises_configuration) @project = args[:project] if args.key?(:project) @region = args[:region] if args.key?(:region) @replica_configuration = args[:replica_configuration] if args.key?(:replica_configuration) @replica_names = args[:replica_names] if args.key?(:replica_names) @self_link = args[:self_link] if args.key?(:self_link) @server_ca_cert = args[:server_ca_cert] if args.key?(:server_ca_cert) @service_account_email_address = args[:service_account_email_address] if args.key?(:service_account_email_address) @settings = args[:settings] if args.key?(:settings) @state = args[:state] if args.key?(:state) @suspension_reason = args[:suspension_reason] if args.key?(:suspension_reason) end # The name and status of the failover replica. This property is applicable only # to Second Generation instances. class FailoverReplica include Google::Apis::Core::Hashable # The availability status of the failover replica. A false status indicates that # the failover replica is out of sync. The master can only failover to the # falover replica when the status is true. # Corresponds to the JSON property `available` # @return [Boolean] attr_accessor :available alias_method :available?, :available # The name of the failover replica. If specified at instance creation, a # failover replica is created for the instance. The name doesn't include the # project ID. This property is applicable only to Second Generation instances. # 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) @available = args[:available] if args.key?(:available) @name = args[:name] if args.key?(:name) end end end # Database list response. class ListDatabasesResponse include Google::Apis::Core::Hashable # List of database resources in the instance. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # This is always sql#databasesList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # Read-replica configuration for connecting to the on-premises master. class DemoteMasterConfiguration include Google::Apis::Core::Hashable # This is always sql#demoteMasterConfiguration. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Read-replica configuration specific to MySQL databases. # Corresponds to the JSON property `mysqlReplicaConfiguration` # @return [Google::Apis::SqladminV1beta4::DemoteMasterMySqlReplicaConfiguration] attr_accessor :mysql_replica_configuration def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @mysql_replica_configuration = args[:mysql_replica_configuration] if args.key?(:mysql_replica_configuration) end end # Database instance demote master context. class DemoteMasterContext include Google::Apis::Core::Hashable # This is always sql#demoteMasterContext. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the instance which will act as on-premises master in the # replication setup. # Corresponds to the JSON property `masterInstanceName` # @return [String] attr_accessor :master_instance_name # Read-replica configuration for connecting to the on-premises master. # Corresponds to the JSON property `replicaConfiguration` # @return [Google::Apis::SqladminV1beta4::DemoteMasterConfiguration] attr_accessor :replica_configuration def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @master_instance_name = args[:master_instance_name] if args.key?(:master_instance_name) @replica_configuration = args[:replica_configuration] if args.key?(:replica_configuration) end end # Read-replica configuration specific to MySQL databases. class DemoteMasterMySqlReplicaConfiguration include Google::Apis::Core::Hashable # PEM representation of the trusted CA's x509 certificate. # Corresponds to the JSON property `caCertificate` # @return [String] attr_accessor :ca_certificate # PEM representation of the slave's x509 certificate. # Corresponds to the JSON property `clientCertificate` # @return [String] attr_accessor :client_certificate # PEM representation of the slave's private key. The corresponsing public key is # encoded in the client's certificate. The format of the slave's private key can # be either PKCS #1 or PKCS #8. # Corresponds to the JSON property `clientKey` # @return [String] attr_accessor :client_key # This is always sql#demoteMasterMysqlReplicaConfiguration. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The password for the replication connection. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # The username for the replication connection. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ca_certificate = args[:ca_certificate] if args.key?(:ca_certificate) @client_certificate = args[:client_certificate] if args.key?(:client_certificate) @client_key = args[:client_key] if args.key?(:client_key) @kind = args[:kind] if args.key?(:kind) @password = args[:password] if args.key?(:password) @username = args[:username] if args.key?(:username) end end # Database instance export context. class ExportContext include Google::Apis::Core::Hashable # Options for exporting data as CSV. # Corresponds to the JSON property `csvExportOptions` # @return [Google::Apis::SqladminV1beta4::ExportContext::CsvExportOptions] attr_accessor :csv_export_options # Databases (for example, guestbook) from which the export is made. If fileType # is SQL and no database is specified, all databases are exported. If fileType # is CSV, you can optionally specify at most one database to export. If # csvExportOptions.selectQuery also specifies the database, this field will be # ignored. # Corresponds to the JSON property `databases` # @return [Array] attr_accessor :databases # The file type for the specified uri. # SQL: The file contains SQL statements. # CSV: The file contains CSV data. # Corresponds to the JSON property `fileType` # @return [String] attr_accessor :file_type # This is always sql#exportContext. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Options for exporting data as SQL statements. # Corresponds to the JSON property `sqlExportOptions` # @return [Google::Apis::SqladminV1beta4::ExportContext::SqlExportOptions] attr_accessor :sql_export_options # The path to the file in Google Cloud Storage where the export will be stored. # The URI is in the form gs://bucketName/fileName. If the file already exists, # the requests succeeds, but the operation fails. If fileType is SQL and the # filename ends with .gz, the contents are compressed. # 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) @csv_export_options = args[:csv_export_options] if args.key?(:csv_export_options) @databases = args[:databases] if args.key?(:databases) @file_type = args[:file_type] if args.key?(:file_type) @kind = args[:kind] if args.key?(:kind) @sql_export_options = args[:sql_export_options] if args.key?(:sql_export_options) @uri = args[:uri] if args.key?(:uri) end # Options for exporting data as CSV. class CsvExportOptions include Google::Apis::Core::Hashable # The select query used to extract the data. # Corresponds to the JSON property `selectQuery` # @return [String] attr_accessor :select_query def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @select_query = args[:select_query] if args.key?(:select_query) end end # Options for exporting data as SQL statements. class SqlExportOptions include Google::Apis::Core::Hashable # Export only schemas. # Corresponds to the JSON property `schemaOnly` # @return [Boolean] attr_accessor :schema_only alias_method :schema_only?, :schema_only # Tables to export, or that were exported, from the specified database. If you # specify tables, specify one and only one database. # Corresponds to the JSON property `tables` # @return [Array] attr_accessor :tables def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @schema_only = args[:schema_only] if args.key?(:schema_only) @tables = args[:tables] if args.key?(:tables) end end end # Database instance failover context. class FailoverContext include Google::Apis::Core::Hashable # This is always sql#failoverContext. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The current settings version of this instance. Request will be rejected if # this version doesn't match the current settings version. # Corresponds to the JSON property `settingsVersion` # @return [Fixnum] attr_accessor :settings_version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @settings_version = args[:settings_version] if args.key?(:settings_version) end end # A Google Cloud SQL service flag resource. class Flag include Google::Apis::Core::Hashable # For STRING flags, a list of strings that the value can be set to. # Corresponds to the JSON property `allowedStringValues` # @return [Array] attr_accessor :allowed_string_values # The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, or # MYSQL_5_7. MYSQL_5_7 is applicable only to Second Generation instances. # Corresponds to the JSON property `appliesTo` # @return [Array] attr_accessor :applies_to # This is always sql#flag. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # For INTEGER flags, the maximum allowed value. # Corresponds to the JSON property `maxValue` # @return [Fixnum] attr_accessor :max_value # For INTEGER flags, the minimum allowed value. # Corresponds to the JSON property `minValue` # @return [Fixnum] attr_accessor :min_value # This is the name of the flag. Flag names always use underscores, not hyphens, # e.g. max_allowed_packet # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Indicates whether changing this flag will trigger a database restart. Only # applicable to Second Generation instances. # Corresponds to the JSON property `requiresRestart` # @return [Boolean] attr_accessor :requires_restart alias_method :requires_restart?, :requires_restart # The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or # NONE. NONE is used for flags which do not take a value, such as # skip_grant_tables. # 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) @allowed_string_values = args[:allowed_string_values] if args.key?(:allowed_string_values) @applies_to = args[:applies_to] if args.key?(:applies_to) @kind = args[:kind] if args.key?(:kind) @max_value = args[:max_value] if args.key?(:max_value) @min_value = args[:min_value] if args.key?(:min_value) @name = args[:name] if args.key?(:name) @requires_restart = args[:requires_restart] if args.key?(:requires_restart) @type = args[:type] if args.key?(:type) end end # Flags list response. class ListFlagsResponse include Google::Apis::Core::Hashable # List of flags. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # This is always sql#flagsList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # Database instance import context. class ImportContext include Google::Apis::Core::Hashable # Options for importing data as CSV. # Corresponds to the JSON property `csvImportOptions` # @return [Google::Apis::SqladminV1beta4::ImportContext::CsvImportOptions] attr_accessor :csv_import_options # The database (for example, guestbook) to which the import is made. If fileType # is SQL and no database is specified, it is assumed that the database is # specified in the file to be imported. If fileType is CSV, it must be specified. # Corresponds to the JSON property `database` # @return [String] attr_accessor :database # The file type for the specified uri. # SQL: The file contains SQL statements. # CSV: The file contains CSV data. # Corresponds to the JSON property `fileType` # @return [String] attr_accessor :file_type # The PostgreSQL user for this import operation. Defaults to cloudsqlsuperuser. # Used only for PostgreSQL instances. # Corresponds to the JSON property `importUser` # @return [String] attr_accessor :import_user # This is always sql#importContext. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A path to the file in Google Cloud Storage from which the import is made. The # URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are # supported when fileType is SQL. # 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) @csv_import_options = args[:csv_import_options] if args.key?(:csv_import_options) @database = args[:database] if args.key?(:database) @file_type = args[:file_type] if args.key?(:file_type) @import_user = args[:import_user] if args.key?(:import_user) @kind = args[:kind] if args.key?(:kind) @uri = args[:uri] if args.key?(:uri) end # Options for importing data as CSV. class CsvImportOptions include Google::Apis::Core::Hashable # The columns to which CSV data is imported. If not specified, all columns of # the database table are loaded with CSV data. # Corresponds to the JSON property `columns` # @return [Array] attr_accessor :columns # The table to which CSV data is imported. # Corresponds to the JSON property `table` # @return [String] attr_accessor :table def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @columns = args[:columns] if args.key?(:columns) @table = args[:table] if args.key?(:table) end end end # Database instance clone request. class CloneInstancesRequest include Google::Apis::Core::Hashable # Database instance clone context. # Corresponds to the JSON property `cloneContext` # @return [Google::Apis::SqladminV1beta4::CloneContext] attr_accessor :clone_context def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @clone_context = args[:clone_context] if args.key?(:clone_context) end end # Database demote master request. class InstancesDemoteMasterRequest include Google::Apis::Core::Hashable # Database instance demote master context. # Corresponds to the JSON property `demoteMasterContext` # @return [Google::Apis::SqladminV1beta4::DemoteMasterContext] attr_accessor :demote_master_context def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @demote_master_context = args[:demote_master_context] if args.key?(:demote_master_context) end end # Database instance export request. class ExportInstancesRequest include Google::Apis::Core::Hashable # Database instance export context. # Corresponds to the JSON property `exportContext` # @return [Google::Apis::SqladminV1beta4::ExportContext] attr_accessor :export_context def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @export_context = args[:export_context] if args.key?(:export_context) end end # Instance failover request. class InstancesFailoverRequest include Google::Apis::Core::Hashable # Database instance failover context. # Corresponds to the JSON property `failoverContext` # @return [Google::Apis::SqladminV1beta4::FailoverContext] attr_accessor :failover_context def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @failover_context = args[:failover_context] if args.key?(:failover_context) end end # Database instance import request. class ImportInstancesRequest include Google::Apis::Core::Hashable # Database instance import context. # Corresponds to the JSON property `importContext` # @return [Google::Apis::SqladminV1beta4::ImportContext] attr_accessor :import_context def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @import_context = args[:import_context] if args.key?(:import_context) end end # Database instances list response. class ListInstancesResponse include Google::Apis::Core::Hashable # List of database instance resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # This is always sql#instancesList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, used to page through large result sets. Provide this # value in a subsequent request to return 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) @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) end end # Database instance restore backup request. class RestoreInstancesBackupRequest include Google::Apis::Core::Hashable # Database instance restore from backup context. # Corresponds to the JSON property `restoreBackupContext` # @return [Google::Apis::SqladminV1beta4::RestoreBackupContext] attr_accessor :restore_backup_context def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @restore_backup_context = args[:restore_backup_context] if args.key?(:restore_backup_context) end end # Instance truncate log request. class InstancesTruncateLogRequest include Google::Apis::Core::Hashable # Database Instance truncate log context. # Corresponds to the JSON property `truncateLogContext` # @return [Google::Apis::SqladminV1beta4::TruncateLogContext] attr_accessor :truncate_log_context def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @truncate_log_context = args[:truncate_log_context] if args.key?(:truncate_log_context) end end # IP Management configuration. class IpConfiguration include Google::Apis::Core::Hashable # The list of external networks that are allowed to connect to the instance # using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168. # 100.0/24). # Corresponds to the JSON property `authorizedNetworks` # @return [Array] attr_accessor :authorized_networks # Whether the instance should be assigned an IP address or not. # Corresponds to the JSON property `ipv4Enabled` # @return [Boolean] attr_accessor :ipv4_enabled alias_method :ipv4_enabled?, :ipv4_enabled # Whether SSL connections over IP should be enforced or not. # Corresponds to the JSON property `requireSsl` # @return [Boolean] attr_accessor :require_ssl alias_method :require_ssl?, :require_ssl def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @authorized_networks = args[:authorized_networks] if args.key?(:authorized_networks) @ipv4_enabled = args[:ipv4_enabled] if args.key?(:ipv4_enabled) @require_ssl = args[:require_ssl] if args.key?(:require_ssl) end end # Database instance IP Mapping. class IpMapping include Google::Apis::Core::Hashable # The IP address assigned. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address # The due time for this IP to be retired in RFC 3339 format, for example 2012-11- # 15T16:19:00.094Z. This field is only available when the IP is scheduled to be # retired. # Corresponds to the JSON property `timeToRetire` # @return [DateTime] attr_accessor :time_to_retire # The type of this IP address. A PRIMARY address is an address that can accept # incoming connections. An OUTGOING address is the source address of connections # originating from the instance, if supported. # 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) @ip_address = args[:ip_address] if args.key?(:ip_address) @time_to_retire = args[:time_to_retire] if args.key?(:time_to_retire) @type = args[:type] if args.key?(:type) end end # Preferred location. This specifies where a Cloud SQL instance should # preferably be located, either in a specific Compute Engine zone, or co-located # with an App Engine application. Note that if the preferred location is not # available, the instance will be located as close as possible within the region. # Only one location may be specified. class LocationPreference include Google::Apis::Core::Hashable # The AppEngine application to follow, it must be in the same region as the # Cloud SQL instance. # Corresponds to the JSON property `followGaeApplication` # @return [String] attr_accessor :follow_gae_application # This is always sql#locationPreference. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.). # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @follow_gae_application = args[:follow_gae_application] if args.key?(:follow_gae_application) @kind = args[:kind] if args.key?(:kind) @zone = args[:zone] if args.key?(:zone) end end # Maintenance window. This specifies when a v2 Cloud SQL instance should # preferably be restarted for system maintenance puruposes. class MaintenanceWindow include Google::Apis::Core::Hashable # day of week (1-7), starting on Monday. # Corresponds to the JSON property `day` # @return [Fixnum] attr_accessor :day # hour of day - 0 to 23. # Corresponds to the JSON property `hour` # @return [Fixnum] attr_accessor :hour # This is always sql#maintenanceWindow. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Maintenance timing setting: canary (Earlier) or stable (Later). # Learn more. # Corresponds to the JSON property `updateTrack` # @return [String] attr_accessor :update_track def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @day = args[:day] if args.key?(:day) @hour = args[:hour] if args.key?(:hour) @kind = args[:kind] if args.key?(:kind) @update_track = args[:update_track] if args.key?(:update_track) end end # Read-replica configuration specific to MySQL databases. class MySqlReplicaConfiguration include Google::Apis::Core::Hashable # PEM representation of the trusted CA's x509 certificate. # Corresponds to the JSON property `caCertificate` # @return [String] attr_accessor :ca_certificate # PEM representation of the slave's x509 certificate. # Corresponds to the JSON property `clientCertificate` # @return [String] attr_accessor :client_certificate # PEM representation of the slave's private key. The corresponsing public key is # encoded in the client's certificate. # Corresponds to the JSON property `clientKey` # @return [String] attr_accessor :client_key # Seconds to wait between connect retries. MySQL's default is 60 seconds. # Corresponds to the JSON property `connectRetryInterval` # @return [Fixnum] attr_accessor :connect_retry_interval # Path to a SQL dump file in Google Cloud Storage from which the slave instance # is to be created. The URI is in the form gs://bucketName/fileName. Compressed # gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates # from which replication should begin. This can be accomplished by setting -- # master-data to 1 when using mysqldump. # Corresponds to the JSON property `dumpFilePath` # @return [String] attr_accessor :dump_file_path # This is always sql#mysqlReplicaConfiguration. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Interval in milliseconds between replication heartbeats. # Corresponds to the JSON property `masterHeartbeatPeriod` # @return [Fixnum] attr_accessor :master_heartbeat_period # The password for the replication connection. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # A list of permissible ciphers to use for SSL encryption. # Corresponds to the JSON property `sslCipher` # @return [String] attr_accessor :ssl_cipher # The username for the replication connection. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username # Whether or not to check the master's Common Name value in the certificate that # it sends during the SSL handshake. # Corresponds to the JSON property `verifyServerCertificate` # @return [Boolean] attr_accessor :verify_server_certificate alias_method :verify_server_certificate?, :verify_server_certificate def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ca_certificate = args[:ca_certificate] if args.key?(:ca_certificate) @client_certificate = args[:client_certificate] if args.key?(:client_certificate) @client_key = args[:client_key] if args.key?(:client_key) @connect_retry_interval = args[:connect_retry_interval] if args.key?(:connect_retry_interval) @dump_file_path = args[:dump_file_path] if args.key?(:dump_file_path) @kind = args[:kind] if args.key?(:kind) @master_heartbeat_period = args[:master_heartbeat_period] if args.key?(:master_heartbeat_period) @password = args[:password] if args.key?(:password) @ssl_cipher = args[:ssl_cipher] if args.key?(:ssl_cipher) @username = args[:username] if args.key?(:username) @verify_server_certificate = args[:verify_server_certificate] if args.key?(:verify_server_certificate) end end # On-premises instance configuration. class OnPremisesConfiguration include Google::Apis::Core::Hashable # The host and port of the on-premises instance in host:port format # Corresponds to the JSON property `hostPort` # @return [String] attr_accessor :host_port # This is always sql#onPremisesConfiguration. # 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) @host_port = args[:host_port] if args.key?(:host_port) @kind = args[:kind] if args.key?(:kind) end end # An Operations resource contains information about database instance operations # such as create, delete, and restart. Operations resources are created in # response to operations that were initiated; you never create them directly. class Operation include Google::Apis::Core::Hashable # The time this operation finished in UTC timezone in RFC 3339 format, for # example 2012-11-15T16:19:00.094Z. # Corresponds to the JSON property `endTime` # @return [DateTime] attr_accessor :end_time # Database instance operation errors list wrapper. # Corresponds to the JSON property `error` # @return [Google::Apis::SqladminV1beta4::OperationErrors] attr_accessor :error # Database instance export context. # Corresponds to the JSON property `exportContext` # @return [Google::Apis::SqladminV1beta4::ExportContext] attr_accessor :export_context # Database instance import context. # Corresponds to the JSON property `importContext` # @return [Google::Apis::SqladminV1beta4::ImportContext] attr_accessor :import_context # The time this operation was enqueued in UTC timezone in RFC 3339 format, for # example 2012-11-15T16:19:00.094Z. # Corresponds to the JSON property `insertTime` # @return [DateTime] attr_accessor :insert_time # This is always sql#operation. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # An identifier that uniquely identifies the operation. You can use this # identifier to retrieve the Operations resource that has information about the # operation. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, # IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, # CREATE_DATABASE, DELETE_DATABASE . # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # The URI of this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The time this operation actually started in UTC timezone in RFC 3339 format, # for example 2012-11-15T16:19:00.094Z. # Corresponds to the JSON property `startTime` # @return [DateTime] attr_accessor :start_time # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Name of the database instance related to this operation. # Corresponds to the JSON property `targetId` # @return [String] attr_accessor :target_id # # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link # The project ID of the target instance related to this operation. # Corresponds to the JSON property `targetProject` # @return [String] attr_accessor :target_project # The email address of the user who initiated this operation. # Corresponds to the JSON property `user` # @return [String] attr_accessor :user def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_time = args[:end_time] if args.key?(:end_time) @error = args[:error] if args.key?(:error) @export_context = args[:export_context] if args.key?(:export_context) @import_context = args[:import_context] if args.key?(:import_context) @insert_time = args[:insert_time] if args.key?(:insert_time) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @operation_type = args[:operation_type] if args.key?(:operation_type) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @target_id = args[:target_id] if args.key?(:target_id) @target_link = args[:target_link] if args.key?(:target_link) @target_project = args[:target_project] if args.key?(:target_project) @user = args[:user] if args.key?(:user) end end # Database instance operation error. class OperationError include Google::Apis::Core::Hashable # Identifies the specific error that occurred. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # This is always sql#operationError. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Additional information about the error encountered. # 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) @kind = args[:kind] if args.key?(:kind) @message = args[:message] if args.key?(:message) end end # Database instance operation errors list wrapper. class OperationErrors include Google::Apis::Core::Hashable # The list of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # This is always sql#operationErrors. # 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) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) end end # Database instance list operations response. class ListOperationsResponse include Google::Apis::Core::Hashable # List of operation resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # This is always sql#operationsList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, used to page through large result sets. Provide this # value in a subsequent request to return 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) @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) end end # Read-replica configuration for connecting to the master. class ReplicaConfiguration include Google::Apis::Core::Hashable # Specifies if the replica is the failover target. If the field is set to true # the replica will be designated as a failover replica. In case the master # instance fails, the replica instance will be promoted as the new master # instance. # Only one replica can be specified as failover target, and the replica has to # be in different zone with the master instance. # Corresponds to the JSON property `failoverTarget` # @return [Boolean] attr_accessor :failover_target alias_method :failover_target?, :failover_target # This is always sql#replicaConfiguration. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Read-replica configuration specific to MySQL databases. # Corresponds to the JSON property `mysqlReplicaConfiguration` # @return [Google::Apis::SqladminV1beta4::MySqlReplicaConfiguration] attr_accessor :mysql_replica_configuration def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @failover_target = args[:failover_target] if args.key?(:failover_target) @kind = args[:kind] if args.key?(:kind) @mysql_replica_configuration = args[:mysql_replica_configuration] if args.key?(:mysql_replica_configuration) end end # Database instance restore from backup context. class RestoreBackupContext include Google::Apis::Core::Hashable # The ID of the backup run to restore from. # Corresponds to the JSON property `backupRunId` # @return [Fixnum] attr_accessor :backup_run_id # The ID of the instance that the backup was taken from. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id # This is always sql#restoreBackupContext. # 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) @backup_run_id = args[:backup_run_id] if args.key?(:backup_run_id) @instance_id = args[:instance_id] if args.key?(:instance_id) @kind = args[:kind] if args.key?(:kind) end end # Database instance settings. class Settings include Google::Apis::Core::Hashable # The activation policy specifies when the instance is activated; it is # applicable only when the instance state is RUNNABLE. Valid values: # ALWAYS: The instance is on, and remains so even in the absence of connection # requests. # NEVER: The instance is off; it is not activated, even if a connection request # arrives. # ON_DEMAND: First Generation instances only. The instance responds to incoming # requests, and turns itself off when not in use. Instances with PER_USE pricing # turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing # turn off after 12 hours of inactivity. # Corresponds to the JSON property `activationPolicy` # @return [String] attr_accessor :activation_policy # The App Engine app IDs that can access this instance. This property is only # applicable to First Generation instances. # Corresponds to the JSON property `authorizedGaeApplications` # @return [Array] attr_accessor :authorized_gae_applications # Availability type (PostgreSQL instances only). Potential values: # ZONAL: The instance serves data from only one zone. Outages in that zone # affect data accessibility. # REGIONAL: The instance can serve data from more than one zone in a region (it # is highly available). # For more information, see Overview of the High Availability Configuration. # Corresponds to the JSON property `availabilityType` # @return [String] attr_accessor :availability_type # Database instance backup configuration. # Corresponds to the JSON property `backupConfiguration` # @return [Google::Apis::SqladminV1beta4::BackupConfiguration] attr_accessor :backup_configuration # Configuration specific to read replica instances. Indicates whether database # flags for crash-safe replication are enabled. This property is only applicable # to First Generation instances. # Corresponds to the JSON property `crashSafeReplicationEnabled` # @return [Boolean] attr_accessor :crash_safe_replication_enabled alias_method :crash_safe_replication_enabled?, :crash_safe_replication_enabled # The size of data disk, in GB. The data disk size minimum is 10GB. Applies only # to Second Generation instances. # Corresponds to the JSON property `dataDiskSizeGb` # @return [Fixnum] attr_accessor :data_disk_size_gb # The type of data disk. Only supported for Second Generation instances. The # default type is PD_SSD. Applies only to Second Generation instances. # Corresponds to the JSON property `dataDiskType` # @return [String] attr_accessor :data_disk_type # The database flags passed to the instance at startup. # Corresponds to the JSON property `databaseFlags` # @return [Array] attr_accessor :database_flags # Configuration specific to read replica instances. Indicates whether # replication is enabled or not. # Corresponds to the JSON property `databaseReplicationEnabled` # @return [Boolean] attr_accessor :database_replication_enabled alias_method :database_replication_enabled?, :database_replication_enabled # IP Management configuration. # Corresponds to the JSON property `ipConfiguration` # @return [Google::Apis::SqladminV1beta4::IpConfiguration] attr_accessor :ip_configuration # This is always sql#settings. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Preferred location. This specifies where a Cloud SQL instance should # preferably be located, either in a specific Compute Engine zone, or co-located # with an App Engine application. Note that if the preferred location is not # available, the instance will be located as close as possible within the region. # Only one location may be specified. # Corresponds to the JSON property `locationPreference` # @return [Google::Apis::SqladminV1beta4::LocationPreference] attr_accessor :location_preference # Maintenance window. This specifies when a v2 Cloud SQL instance should # preferably be restarted for system maintenance puruposes. # Corresponds to the JSON property `maintenanceWindow` # @return [Google::Apis::SqladminV1beta4::MaintenanceWindow] attr_accessor :maintenance_window # The pricing plan for this instance. This can be either PER_USE or PACKAGE. # Only PER_USE is supported for Second Generation instances. # Corresponds to the JSON property `pricingPlan` # @return [String] attr_accessor :pricing_plan # The type of replication this instance uses. This can be either ASYNCHRONOUS or # SYNCHRONOUS. This property is only applicable to First Generation instances. # Corresponds to the JSON property `replicationType` # @return [String] attr_accessor :replication_type # The version of instance settings. This is a required field for update method # to make sure concurrent updates are handled properly. During update, use the # most recent settingsVersion value for this instance and do not try to update # this value. # Corresponds to the JSON property `settingsVersion` # @return [Fixnum] attr_accessor :settings_version # Configuration to increase storage size automatically. The default value is # true. Applies only to Second Generation instances. # Corresponds to the JSON property `storageAutoResize` # @return [Boolean] attr_accessor :storage_auto_resize alias_method :storage_auto_resize?, :storage_auto_resize # The maximum size to which storage capacity can be automatically increased. The # default value is 0, which specifies that there is no limit. Applies only to # Second Generation instances. # Corresponds to the JSON property `storageAutoResizeLimit` # @return [Fixnum] attr_accessor :storage_auto_resize_limit # The tier of service for this instance, for example D1, D2. For more # information, see pricing. # Corresponds to the JSON property `tier` # @return [String] attr_accessor :tier # User-provided labels, represented as a dictionary where each label is a single # key value pair. # Corresponds to the JSON property `userLabels` # @return [Hash] attr_accessor :user_labels def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @activation_policy = args[:activation_policy] if args.key?(:activation_policy) @authorized_gae_applications = args[:authorized_gae_applications] if args.key?(:authorized_gae_applications) @availability_type = args[:availability_type] if args.key?(:availability_type) @backup_configuration = args[:backup_configuration] if args.key?(:backup_configuration) @crash_safe_replication_enabled = args[:crash_safe_replication_enabled] if args.key?(:crash_safe_replication_enabled) @data_disk_size_gb = args[:data_disk_size_gb] if args.key?(:data_disk_size_gb) @data_disk_type = args[:data_disk_type] if args.key?(:data_disk_type) @database_flags = args[:database_flags] if args.key?(:database_flags) @database_replication_enabled = args[:database_replication_enabled] if args.key?(:database_replication_enabled) @ip_configuration = args[:ip_configuration] if args.key?(:ip_configuration) @kind = args[:kind] if args.key?(:kind) @location_preference = args[:location_preference] if args.key?(:location_preference) @maintenance_window = args[:maintenance_window] if args.key?(:maintenance_window) @pricing_plan = args[:pricing_plan] if args.key?(:pricing_plan) @replication_type = args[:replication_type] if args.key?(:replication_type) @settings_version = args[:settings_version] if args.key?(:settings_version) @storage_auto_resize = args[:storage_auto_resize] if args.key?(:storage_auto_resize) @storage_auto_resize_limit = args[:storage_auto_resize_limit] if args.key?(:storage_auto_resize_limit) @tier = args[:tier] if args.key?(:tier) @user_labels = args[:user_labels] if args.key?(:user_labels) end end # SslCerts Resource class SslCert include Google::Apis::Core::Hashable # PEM representation. # Corresponds to the JSON property `cert` # @return [String] attr_accessor :cert # Serial number, as extracted from the certificate. # Corresponds to the JSON property `certSerialNumber` # @return [String] attr_accessor :cert_serial_number # User supplied name. Constrained to [a-zA-Z.-_ ]+. # Corresponds to the JSON property `commonName` # @return [String] attr_accessor :common_name # The time when the certificate was created in RFC 3339 format, for example 2012- # 11-15T16:19:00.094Z # Corresponds to the JSON property `createTime` # @return [DateTime] attr_accessor :create_time # The time when the certificate expires in RFC 3339 format, for example 2012-11- # 15T16:19:00.094Z. # Corresponds to the JSON property `expirationTime` # @return [DateTime] attr_accessor :expiration_time # Name of the database instance. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # This is always sql#sslCert. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The URI of this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Sha1 Fingerprint. # Corresponds to the JSON property `sha1Fingerprint` # @return [String] attr_accessor :sha1_fingerprint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cert = args[:cert] if args.key?(:cert) @cert_serial_number = args[:cert_serial_number] if args.key?(:cert_serial_number) @common_name = args[:common_name] if args.key?(:common_name) @create_time = args[:create_time] if args.key?(:create_time) @expiration_time = args[:expiration_time] if args.key?(:expiration_time) @instance = args[:instance] if args.key?(:instance) @kind = args[:kind] if args.key?(:kind) @self_link = args[:self_link] if args.key?(:self_link) @sha1_fingerprint = args[:sha1_fingerprint] if args.key?(:sha1_fingerprint) end end # SslCertDetail. class SslCertDetail include Google::Apis::Core::Hashable # SslCerts Resource # Corresponds to the JSON property `certInfo` # @return [Google::Apis::SqladminV1beta4::SslCert] attr_accessor :cert_info # The private key for the client cert, in pem format. Keep private in order to # protect your security. # Corresponds to the JSON property `certPrivateKey` # @return [String] attr_accessor :cert_private_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cert_info = args[:cert_info] if args.key?(:cert_info) @cert_private_key = args[:cert_private_key] if args.key?(:cert_private_key) end end # SslCerts create ephemeral certificate request. class SslCertsCreateEphemeralRequest include Google::Apis::Core::Hashable # PEM encoded public key to include in the signed certificate. # Corresponds to the JSON property `public_key` # @return [String] attr_accessor :public_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @public_key = args[:public_key] if args.key?(:public_key) end end # SslCerts insert request. class InsertSslCertsRequest include Google::Apis::Core::Hashable # User supplied name. Must be a distinct name from the other certificates for # this instance. New certificates will not be usable until the instance is # restarted. # Corresponds to the JSON property `commonName` # @return [String] attr_accessor :common_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common_name = args[:common_name] if args.key?(:common_name) end end # SslCert insert response. class InsertSslCertsResponse include Google::Apis::Core::Hashable # SslCertDetail. # Corresponds to the JSON property `clientCert` # @return [Google::Apis::SqladminV1beta4::SslCertDetail] attr_accessor :client_cert # This is always sql#sslCertsInsert. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # An Operations resource contains information about database instance operations # such as create, delete, and restart. Operations resources are created in # response to operations that were initiated; you never create them directly. # Corresponds to the JSON property `operation` # @return [Google::Apis::SqladminV1beta4::Operation] attr_accessor :operation # SslCerts Resource # Corresponds to the JSON property `serverCaCert` # @return [Google::Apis::SqladminV1beta4::SslCert] attr_accessor :server_ca_cert def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_cert = args[:client_cert] if args.key?(:client_cert) @kind = args[:kind] if args.key?(:kind) @operation = args[:operation] if args.key?(:operation) @server_ca_cert = args[:server_ca_cert] if args.key?(:server_ca_cert) end end # SslCerts list response. class ListSslCertsResponse include Google::Apis::Core::Hashable # List of client certificates for the instance. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # This is always sql#sslCertsList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # A Google Cloud SQL service tier resource. class Tier include Google::Apis::Core::Hashable # The maximum disk size of this tier in bytes. # Corresponds to the JSON property `DiskQuota` # @return [Fixnum] attr_accessor :disk_quota # The maximum RAM usage of this tier in bytes. # Corresponds to the JSON property `RAM` # @return [Fixnum] attr_accessor :ram # This is always sql#tier. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The applicable regions for this tier. # Corresponds to the JSON property `region` # @return [Array] attr_accessor :region # An identifier for the service tier, for example D1, D2 etc. For related # information, see Pricing. # Corresponds to the JSON property `tier` # @return [String] attr_accessor :tier def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disk_quota = args[:disk_quota] if args.key?(:disk_quota) @ram = args[:ram] if args.key?(:ram) @kind = args[:kind] if args.key?(:kind) @region = args[:region] if args.key?(:region) @tier = args[:tier] if args.key?(:tier) end end # Tiers list response. class ListTiersResponse include Google::Apis::Core::Hashable # List of tiers. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # This is always sql#tiersList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # Database Instance truncate log context. class TruncateLogContext include Google::Apis::Core::Hashable # This is always sql#truncateLogContext. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The type of log to truncate. Valid values are MYSQL_GENERAL_TABLE and # MYSQL_SLOW_TABLE. # 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) @kind = args[:kind] if args.key?(:kind) @log_type = args[:log_type] if args.key?(:log_type) end end # A Cloud SQL user resource. class User include Google::Apis::Core::Hashable # HTTP 1.1 Entity tag for the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The host name from which the user can connect. For insert operations, host # defaults to an empty string. For update operations, host is specified as part # of the request URL. The host name cannot be updated after insertion. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # The name of the Cloud SQL instance. This does not include the project ID. Can # be omitted for update since it is already specified on the URL. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # This is always sql#user. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the user in the Cloud SQL instance. Can be omitted for update # since it is already specified on the URL. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The password for the user. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # The project ID of the project containing the Cloud SQL database. The Google # apps domain is prefixed if applicable. Can be omitted for update since it is # already specified on the URL. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @host = args[:host] if args.key?(:host) @instance = args[:instance] if args.key?(:instance) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @password = args[:password] if args.key?(:password) @project = args[:project] if args.key?(:project) end end # User list response. class ListUsersResponse include Google::Apis::Core::Hashable # List of user resources in the instance. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # This is always sql#usersList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # An identifier that uniquely identifies the operation. You can use this # identifier to retrieve the Operations resource that has information about the # operation. # 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) @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) end end end end end google-api-client-0.19.8/generated/google/apis/sqladmin_v1beta4/service.rb0000644000004100000410000032324113252673044026444 0ustar www-datawww-data# 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 SqladminV1beta4 # Cloud SQL Administration API # # Creates and configures Cloud SQL instances, which provide fully-managed MySQL # databases. # # @example # require 'google/apis/sqladmin_v1beta4' # # Sqladmin = Google::Apis::SqladminV1beta4 # Alias the module # service = Sqladmin::SQLAdminService.new # # @see https://cloud.google.com/sql/docs/reference/latest class SQLAdminService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'sql/v1beta4/') @batch_path = 'batch/sqladmin/v1beta4' end # Deletes the backup taken by a backup run. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Fixnum] id # The ID of the Backup Run to delete. To find a Backup Run ID, use the list # method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_backup_run(project, instance, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'projects/{project}/instances/{instance}/backupRuns/{id}', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['id'] = id unless 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 resource containing information about a backup run. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Fixnum] id # The ID of this Backup Run. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::BackupRun] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::BackupRun] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_backup_run(project, instance, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/instances/{instance}/backupRuns/{id}', options) command.response_representation = Google::Apis::SqladminV1beta4::BackupRun::Representation command.response_class = Google::Apis::SqladminV1beta4::BackupRun command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['id'] = id unless 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 backup run on demand. This method is applicable only to Second # Generation instances. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::BackupRun] backup_run_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_backup_run(project, instance, backup_run_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/backupRuns', options) command.request_representation = Google::Apis::SqladminV1beta4::BackupRun::Representation command.request_object = backup_run_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 backup runs associated with a given instance and configuration in # the reverse chronological order of the enqueued time. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Fixnum] max_results # Maximum number of backup runs per response. # @param [String] page_token # A previously-returned page token representing part of the larger set of # results to view. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::ListBackupRunsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::ListBackupRunsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_backup_runs(project, instance, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/instances/{instance}/backupRuns', options) command.response_representation = Google::Apis::SqladminV1beta4::ListBackupRunsResponse::Representation command.response_class = Google::Apis::SqladminV1beta4::ListBackupRunsResponse command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.query['maxResults'] = max_results unless max_results.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 # Deletes a database from a Cloud SQL instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Database instance ID. This does not include the project ID. # @param [String] database # Name of the database to be deleted in the instance. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_database(project, instance, database, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'projects/{project}/instances/{instance}/databases/{database}', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['database'] = database unless database.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 resource containing information about a database inside a Cloud # SQL instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Database instance ID. This does not include the project ID. # @param [String] database # Name of the database in the instance. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Database] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::Database] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_database(project, instance, database, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/instances/{instance}/databases/{database}', options) command.response_representation = Google::Apis::SqladminV1beta4::Database::Representation command.response_class = Google::Apis::SqladminV1beta4::Database command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['database'] = database unless database.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 # Inserts a resource containing information about a database inside a Cloud SQL # instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Database instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::Database] database_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_database(project, instance, database_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/databases', options) command.request_representation = Google::Apis::SqladminV1beta4::Database::Representation command.request_object = database_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 databases in the specified Cloud SQL instance. # @param [String] project # Project ID of the project for which to list Cloud SQL instances. # @param [String] instance # Cloud SQL instance ID. This does not include the project 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::ListDatabasesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::ListDatabasesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_databases(project, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/instances/{instance}/databases', options) command.response_representation = Google::Apis::SqladminV1beta4::ListDatabasesResponse::Representation command.response_class = Google::Apis::SqladminV1beta4::ListDatabasesResponse command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 a resource containing information about a database inside a Cloud SQL # instance. This method supports patch semantics. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Database instance ID. This does not include the project ID. # @param [String] database # Name of the database to be updated in the instance. # @param [Google::Apis::SqladminV1beta4::Database] database_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_database(project, instance, database, database_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'projects/{project}/instances/{instance}/databases/{database}', options) command.request_representation = Google::Apis::SqladminV1beta4::Database::Representation command.request_object = database_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['database'] = database unless database.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 a resource containing information about a database inside a Cloud SQL # instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Database instance ID. This does not include the project ID. # @param [String] database # Name of the database to be updated in the instance. # @param [Google::Apis::SqladminV1beta4::Database] database_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 update_database(project, instance, database, database_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'projects/{project}/instances/{instance}/databases/{database}', options) command.request_representation = Google::Apis::SqladminV1beta4::Database::Representation command.request_object = database_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['database'] = database unless database.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 available database flags for Google Cloud SQL instances. # @param [String] database_version # Database version for flag retrieval. Flags are specific to the database # version. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::ListFlagsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::ListFlagsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_flags(database_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'flags', options) command.response_representation = Google::Apis::SqladminV1beta4::ListFlagsResponse::Representation command.response_class = Google::Apis::SqladminV1beta4::ListFlagsResponse command.query['databaseVersion'] = database_version unless database_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 Cloud SQL instance as a clone of the source instance. The API is not # ready for Second Generation instances yet. # @param [String] project # Project ID of the source as well as the clone Cloud SQL instance. # @param [String] instance # The ID of the Cloud SQL instance to be cloned (source). This does not include # the project ID. # @param [Google::Apis::SqladminV1beta4::CloneInstancesRequest] clone_instances_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_instance(project, instance, clone_instances_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/clone', options) command.request_representation = Google::Apis::SqladminV1beta4::CloneInstancesRequest::Representation command.request_object = clone_instances_request_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 a Cloud SQL instance. # @param [String] project # Project ID of the project that contains the instance to be deleted. # @param [String] instance # Cloud SQL instance ID. This does not include the project 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_instance(project, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'projects/{project}/instances/{instance}', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 # Reserved for future use. # @param [String] project # ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance name. # @param [Google::Apis::SqladminV1beta4::InstancesDemoteMasterRequest] instances_demote_master_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 demote_instance_master(project, instance, instances_demote_master_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/demoteMaster', options) command.request_representation = Google::Apis::SqladminV1beta4::InstancesDemoteMasterRequest::Representation command.request_object = instances_demote_master_request_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 # Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a # MySQL dump file. # @param [String] project # Project ID of the project that contains the instance to be exported. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::ExportInstancesRequest] export_instances_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_instance(project, instance, export_instances_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/export', options) command.request_representation = Google::Apis::SqladminV1beta4::ExportInstancesRequest::Representation command.request_object = export_instances_request_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 # Failover the instance to its failover replica instance. # @param [String] project # ID of the project that contains the read replica. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::InstancesFailoverRequest] instances_failover_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 failover_instance(project, instance, instances_failover_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/failover', options) command.request_representation = Google::Apis::SqladminV1beta4::InstancesFailoverRequest::Representation command.request_object = instances_failover_request_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 resource containing information about a Cloud SQL instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Database instance ID. This does not include the project 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::DatabaseInstance] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::DatabaseInstance] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance(project, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/instances/{instance}', options) command.response_representation = Google::Apis::SqladminV1beta4::DatabaseInstance::Representation command.response_class = Google::Apis::SqladminV1beta4::DatabaseInstance command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 # Imports data into a Cloud SQL instance from a MySQL dump file in Google Cloud # Storage. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::ImportInstancesRequest] import_instances_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 import_instance(project, instance, import_instances_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/import', options) command.request_representation = Google::Apis::SqladminV1beta4::ImportInstancesRequest::Representation command.request_object = import_instances_request_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 Cloud SQL instance. # @param [String] project # Project ID of the project to which the newly created Cloud SQL instances # should belong. # @param [Google::Apis::SqladminV1beta4::DatabaseInstance] database_instance_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_instance(project, database_instance_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances', options) command.request_representation = Google::Apis::SqladminV1beta4::DatabaseInstance::Representation command.request_object = database_instance_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.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 instances under a given project in the alphabetical order of the # instance name. # @param [String] project # Project ID of the project for which to list Cloud SQL instances. # @param [String] filter # An expression for filtering the results of the request, such as by name or # label. # @param [Fixnum] max_results # The maximum number of results to return per response. # @param [String] page_token # A previously-returned page token representing part of the larger set of # results to view. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::ListInstancesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::ListInstancesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instances(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/instances', options) command.response_representation = Google::Apis::SqladminV1beta4::ListInstancesResponse::Representation command.response_class = Google::Apis::SqladminV1beta4::ListInstancesResponse command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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 settings of a Cloud SQL instance. Caution: This is not a partial # update, so you must include values for all the settings that you want to # retain. For partial updates, use patch.. This method supports patch semantics. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::DatabaseInstance] database_instance_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_instance(project, instance, database_instance_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'projects/{project}/instances/{instance}', options) command.request_representation = Google::Apis::SqladminV1beta4::DatabaseInstance::Representation command.request_object = database_instance_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 # Promotes the read replica instance to be a stand-alone Cloud SQL instance. # @param [String] project # ID of the project that contains the read replica. # @param [String] instance # Cloud SQL read replica instance 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 promote_instance_replica(project, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/promoteReplica', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 client certificates and generates a new server SSL certificate for # the instance. The changes will not take effect until the instance is restarted. # Existing instances without a server certificate will need to call this once # to set a server certificate. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 reset_instance_ssl_config(project, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/resetSslConfig', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 # Restarts a Cloud SQL instance. # @param [String] project # Project ID of the project that contains the instance to be restarted. # @param [String] instance # Cloud SQL instance ID. This does not include the project 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 restart_instance(project, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/restart', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 # Restores a backup of a Cloud SQL instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::RestoreInstancesBackupRequest] restore_instances_backup_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 restore_instance_backup(project, instance, restore_instances_backup_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/restoreBackup', options) command.request_representation = Google::Apis::SqladminV1beta4::RestoreInstancesBackupRequest::Representation command.request_object = restore_instances_backup_request_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 # Starts the replication in the read replica instance. # @param [String] project # ID of the project that contains the read replica. # @param [String] instance # Cloud SQL read replica instance 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 start_instance_replica(project, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/startReplica', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 # Stops the replication in the read replica instance. # @param [String] project # ID of the project that contains the read replica. # @param [String] instance # Cloud SQL read replica instance 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 stop_instance_replica(project, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/stopReplica', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 # Truncate MySQL general and slow query log tables # @param [String] project # Project ID of the Cloud SQL project. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::InstancesTruncateLogRequest] instances_truncate_log_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 truncate_instance_log(project, instance, instances_truncate_log_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/truncateLog', options) command.request_representation = Google::Apis::SqladminV1beta4::InstancesTruncateLogRequest::Representation command.request_object = instances_truncate_log_request_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 settings of a Cloud SQL instance. Caution: This is not a partial # update, so you must include values for all the settings that you want to # retain. For partial updates, use patch. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::DatabaseInstance] database_instance_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 update_instance(project, instance, database_instance_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'projects/{project}/instances/{instance}', options) command.request_representation = Google::Apis::SqladminV1beta4::DatabaseInstance::Representation command.request_object = database_instance_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 instance operation that has been performed on an instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] operation # Instance operation 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/operations/{operation}', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['operation'] = operation unless operation.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 instance operations that have been performed on the given Cloud SQL # instance in the reverse chronological order of the start time. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Fixnum] max_results # Maximum number of operations per response. # @param [String] page_token # A previously-returned page token representing part of the larger set of # results to view. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operations(project, instance, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/operations', options) command.response_representation = Google::Apis::SqladminV1beta4::ListOperationsResponse::Representation command.response_class = Google::Apis::SqladminV1beta4::ListOperationsResponse command.params['project'] = project unless project.nil? command.query['instance'] = instance unless instance.nil? command.query['maxResults'] = max_results unless max_results.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 # Generates a short-lived X509 certificate containing the provided public key # and signed by a private key specific to the target instance. Users may use the # certificate to authenticate as themselves when connecting to the database. # @param [String] project # Project ID of the Cloud SQL project. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::SslCertsCreateEphemeralRequest] ssl_certs_create_ephemeral_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::SslCert] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::SslCert] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ssl_cert_ephemeral(project, instance, ssl_certs_create_ephemeral_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/createEphemeral', options) command.request_representation = Google::Apis::SqladminV1beta4::SslCertsCreateEphemeralRequest::Representation command.request_object = ssl_certs_create_ephemeral_request_object command.response_representation = Google::Apis::SqladminV1beta4::SslCert::Representation command.response_class = Google::Apis::SqladminV1beta4::SslCert command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 SSL certificate. The change will not take effect until the # instance is restarted. # @param [String] project # Project ID of the project that contains the instance to be deleted. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [String] sha1_fingerprint # Sha1 FingerPrint. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_ssl_cert(project, instance, sha1_fingerprint, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['sha1Fingerprint'] = sha1_fingerprint unless sha1_fingerprint.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 particular SSL certificate. Does not include the private key ( # required for usage). The private key must be saved from the response to # initial creation. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [String] sha1_fingerprint # Sha1 FingerPrint. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::SslCert] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::SslCert] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ssl_cert(project, instance, sha1_fingerprint, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}', options) command.response_representation = Google::Apis::SqladminV1beta4::SslCert::Representation command.response_class = Google::Apis::SqladminV1beta4::SslCert command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['sha1Fingerprint'] = sha1_fingerprint unless sha1_fingerprint.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 SSL certificate and returns it along with the private key and # server certificate authority. The new certificate will not be usable until the # instance is restarted. # @param [String] project # Project ID of the project to which the newly created Cloud SQL instances # should belong. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::InsertSslCertsRequest] insert_ssl_certs_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::InsertSslCertsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::InsertSslCertsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ssl_cert(project, instance, insert_ssl_certs_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/sslCerts', options) command.request_representation = Google::Apis::SqladminV1beta4::InsertSslCertsRequest::Representation command.request_object = insert_ssl_certs_request_object command.response_representation = Google::Apis::SqladminV1beta4::InsertSslCertsResponse::Representation command.response_class = Google::Apis::SqladminV1beta4::InsertSslCertsResponse command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 of the current SSL certificates for the instance. # @param [String] project # Project ID of the project for which to list Cloud SQL instances. # @param [String] instance # Cloud SQL instance ID. This does not include the project 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::ListSslCertsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::ListSslCertsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ssl_certs(project, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/instances/{instance}/sslCerts', options) command.response_representation = Google::Apis::SqladminV1beta4::ListSslCertsResponse::Representation command.response_class = Google::Apis::SqladminV1beta4::ListSslCertsResponse command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 available service tiers for Google Cloud SQL, for example D1, D2. # For related information, see Pricing. # @param [String] project # Project ID of the project for which to list tiers. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::ListTiersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::ListTiersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tiers(project, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/tiers', options) command.response_representation = Google::Apis::SqladminV1beta4::ListTiersResponse::Representation command.response_class = Google::Apis::SqladminV1beta4::ListTiersResponse command.params['project'] = project unless project.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 a user from a Cloud SQL instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Database instance ID. This does not include the project ID. # @param [String] host # Host of the user in the instance. # @param [String] name # Name of the user in the instance. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_user(project, instance, host, name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'projects/{project}/instances/{instance}/users', options) command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.query['host'] = host unless host.nil? command.query['name'] = name unless 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 # Creates a new user in a Cloud SQL instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Database instance ID. This does not include the project ID. # @param [Google::Apis::SqladminV1beta4::User] user_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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_user(project, instance, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'projects/{project}/instances/{instance}/users', options) command.request_representation = Google::Apis::SqladminV1beta4::User::Representation command.request_object = user_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 users in the specified Cloud SQL instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Database instance ID. This does not include the project 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::ListUsersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::ListUsersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_users(project, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{project}/instances/{instance}/users', options) command.response_representation = Google::Apis::SqladminV1beta4::ListUsersResponse::Representation command.response_class = Google::Apis::SqladminV1beta4::ListUsersResponse command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.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 user in a Cloud SQL instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance # Database instance ID. This does not include the project ID. # @param [String] host # Host of the user in the instance. # @param [String] name # Name of the user in the instance. # @param [Google::Apis::SqladminV1beta4::User] user_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SqladminV1beta4::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 update_user(project, instance, host, name, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'projects/{project}/instances/{instance}/users', options) command.request_representation = Google::Apis::SqladminV1beta4::User::Representation command.request_object = user_object command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation command.response_class = Google::Apis::SqladminV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.query['host'] = host unless host.nil? command.query['name'] = name unless 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 protected 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 end end google-api-client-0.19.8/generated/google/apis/tagmanager_v1.rb0000644000004100000410000000417313252673044024362 0ustar www-datawww-data# 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/tagmanager_v1/service.rb' require 'google/apis/tagmanager_v1/classes.rb' require 'google/apis/tagmanager_v1/representations.rb' module Google module Apis # Tag Manager API # # Accesses Tag Manager accounts and containers. # # @see https://developers.google.com/tag-manager/api/v1/ module TagmanagerV1 VERSION = 'V1' REVISION = '20171108' # Delete your Google Tag Manager containers AUTH_TAGMANAGER_DELETE_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.delete.containers' # Manage your Google Tag Manager container and its subcomponents, excluding versioning and publishing AUTH_TAGMANAGER_EDIT_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.edit.containers' # Manage your Google Tag Manager container versions AUTH_TAGMANAGER_EDIT_CONTAINERVERSIONS = 'https://www.googleapis.com/auth/tagmanager.edit.containerversions' # View and manage your Google Tag Manager accounts AUTH_TAGMANAGER_MANAGE_ACCOUNTS = 'https://www.googleapis.com/auth/tagmanager.manage.accounts' # Manage user permissions of your Google Tag Manager account and container AUTH_TAGMANAGER_MANAGE_USERS = 'https://www.googleapis.com/auth/tagmanager.manage.users' # Publish your Google Tag Manager container versions AUTH_TAGMANAGER_PUBLISH = 'https://www.googleapis.com/auth/tagmanager.publish' # View your Google Tag Manager container and its subcomponents AUTH_TAGMANAGER_READONLY = 'https://www.googleapis.com/auth/tagmanager.readonly' end end end google-api-client-0.19.8/generated/google/apis/toolresults_v1beta3.rb0000644000004100000410000000223213252673044025564 0ustar www-datawww-data# 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/toolresults_v1beta3/service.rb' require 'google/apis/toolresults_v1beta3/classes.rb' require 'google/apis/toolresults_v1beta3/representations.rb' module Google module Apis # Cloud Tool Results API # # Reads and publishes results from Firebase Test Lab. # # @see https://firebase.google.com/docs/test-lab/ module ToolresultsV1beta3 VERSION = 'V1beta3' REVISION = '20171211' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end google-api-client-0.19.8/generated/google/apis/clouduseraccounts_vm_alpha.rb0000644000004100000410000000327013252673043027256 0ustar www-datawww-data# 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/clouduseraccounts_vm_alpha/service.rb' require 'google/apis/clouduseraccounts_vm_alpha/classes.rb' require 'google/apis/clouduseraccounts_vm_alpha/representations.rb' module Google module Apis # Cloud User Accounts API # # Creates and manages users and groups for accessing Google Compute Engine # virtual machines. # # @see https://cloud.google.com/compute/docs/access/user-accounts/api/latest/ module ClouduseraccountsVmAlpha VERSION = 'VmAlpha' REVISION = '20160316' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' # Manage your Google Cloud User Accounts AUTH_CLOUD_USERACCOUNTS = 'https://www.googleapis.com/auth/cloud.useraccounts' # View your Google Cloud User Accounts AUTH_CLOUD_USERACCOUNTS_READONLY = 'https://www.googleapis.com/auth/cloud.useraccounts.readonly' end end end google-api-client-0.19.8/generated/google/apis/adexperiencereport_v1.rb0000644000004100000410000000230613252673043026137 0ustar www-datawww-data# 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/adexperiencereport_v1/service.rb' require 'google/apis/adexperiencereport_v1/classes.rb' require 'google/apis/adexperiencereport_v1/representations.rb' module Google module Apis # Google Ad Experience Report API # # View Ad Experience Report data, and get a list of sites that have a # significant number of annoying ads. # # @see https://developers.google.com/ad-experience-report/ module AdexperiencereportV1 VERSION = 'V1' REVISION = '20170918' # Test scope for access to the Zoo service AUTH_XAPI_ZOO = 'https://www.googleapis.com/auth/xapi.zoo' end end end google-api-client-0.19.8/generated/google/apis/dns_v1.rb0000644000004100000410000000306313252673043023034 0ustar www-datawww-data# 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/dns_v1/service.rb' require 'google/apis/dns_v1/classes.rb' require 'google/apis/dns_v1/representations.rb' module Google module Apis # Google Cloud DNS API # # Configures and serves authoritative DNS records. # # @see https://developers.google.com/cloud-dns module DnsV1 VERSION = 'V1' REVISION = '20170831' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' # View your DNS records hosted by Google Cloud DNS AUTH_NDEV_CLOUDDNS_READONLY = 'https://www.googleapis.com/auth/ndev.clouddns.readonly' # View and manage your DNS records hosted by Google Cloud DNS AUTH_NDEV_CLOUDDNS_READWRITE = 'https://www.googleapis.com/auth/ndev.clouddns.readwrite' end end end google-api-client-0.19.8/generated/google/apis/dfareporting_v2_8.rb0000644000004100000410000000272613252673043025171 0ustar www-datawww-data# 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/dfareporting_v2_8/service.rb' require 'google/apis/dfareporting_v2_8/classes.rb' require 'google/apis/dfareporting_v2_8/representations.rb' module Google module Apis # DCM/DFA Reporting And Trafficking API # # Manages your DoubleClick Campaign Manager ad campaigns and reports. # # @see https://developers.google.com/doubleclick-advertisers/ module DfareportingV2_8 VERSION = 'V2_8' REVISION = '20171109' # Manage DoubleClick Digital Marketing conversions AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions' # View and manage DoubleClick for Advertisers reports AUTH_DFAREPORTING = 'https://www.googleapis.com/auth/dfareporting' # View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns AUTH_DFATRAFFICKING = 'https://www.googleapis.com/auth/dfatrafficking' end end end google-api-client-0.19.8/generated/google/apis/slides_v1/0000755000004100000410000000000013252673044023205 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/slides_v1/representations.rb0000644000004100000410000026127213252673044026771 0ustar www-datawww-data# 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 SlidesV1 class AffineTransform class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AutoText class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchUpdatePresentationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchUpdatePresentationResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Bullet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ColorScheme class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ColorStop class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateImageRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateImageResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateLineRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateLineResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateParagraphBulletsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateShapeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateShapeResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateSheetsChartRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateSheetsChartResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateSlideRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateSlideResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateTableRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateTableResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateVideoRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateVideoResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CropProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteObjectRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteParagraphBulletsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteTableColumnRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteTableRowRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteTextRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Dimension class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DuplicateObjectRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DuplicateObjectResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Group class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GroupObjectsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GroupObjectsResponse 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 ImageProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InsertTableColumnsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InsertTableRowsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InsertTextRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LayoutPlaceholderIdMapping class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LayoutProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LayoutReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Line class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LineFill class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LineProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Link class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class List class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MasterProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MergeTableCellsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NestingLevel class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NotesProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OpaqueColor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OptionalColor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Outline class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OutlineFill class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Page class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PageBackgroundFill class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PageElement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PageElementProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PageProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ParagraphMarker class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ParagraphStyle class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Placeholder class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Presentation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Range class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Recolor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RefreshSheetsChartRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReplaceAllShapesWithImageRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReplaceAllShapesWithImageResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReplaceAllShapesWithSheetsChartRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReplaceAllShapesWithSheetsChartResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReplaceAllTextRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReplaceAllTextResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Request class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Response class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RgbColor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Shadow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Shape class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShapeBackgroundFill class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShapeProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SheetsChart class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SheetsChartProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Size class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SlideProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SolidFill class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StretchedPictureFill class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SubstringMatchCriteria class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Table class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableBorderCell class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableBorderFill class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableBorderProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableBorderRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableCell class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableCellBackgroundFill class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableCellLocation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableCellProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableColumnProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableRange class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TableRowProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TextContent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TextElement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TextRun class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TextStyle class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThemeColorPair class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Thumbnail class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UngroupObjectsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UnmergeTableCellsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateImagePropertiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateLinePropertiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdatePageElementAltTextRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdatePageElementTransformRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdatePagePropertiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateParagraphStyleRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateShapePropertiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateSlidesPositionRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateTableBorderPropertiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateTableCellPropertiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateTableColumnPropertiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateTableRowPropertiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateTextStyleRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateVideoPropertiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Video class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WeightedFontFamily class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WordArt class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WriteControl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AffineTransform # @private class Representation < Google::Apis::Core::JsonRepresentation property :scale_x, as: 'scaleX' property :scale_y, as: 'scaleY' property :shear_x, as: 'shearX' property :shear_y, as: 'shearY' property :translate_x, as: 'translateX' property :translate_y, as: 'translateY' property :unit, as: 'unit' end end class AutoText # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :style, as: 'style', class: Google::Apis::SlidesV1::TextStyle, decorator: Google::Apis::SlidesV1::TextStyle::Representation property :type, as: 'type' end end class BatchUpdatePresentationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :requests, as: 'requests', class: Google::Apis::SlidesV1::Request, decorator: Google::Apis::SlidesV1::Request::Representation property :write_control, as: 'writeControl', class: Google::Apis::SlidesV1::WriteControl, decorator: Google::Apis::SlidesV1::WriteControl::Representation end end class BatchUpdatePresentationResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :presentation_id, as: 'presentationId' collection :replies, as: 'replies', class: Google::Apis::SlidesV1::Response, decorator: Google::Apis::SlidesV1::Response::Representation property :write_control, as: 'writeControl', class: Google::Apis::SlidesV1::WriteControl, decorator: Google::Apis::SlidesV1::WriteControl::Representation end end class Bullet # @private class Representation < Google::Apis::Core::JsonRepresentation property :bullet_style, as: 'bulletStyle', class: Google::Apis::SlidesV1::TextStyle, decorator: Google::Apis::SlidesV1::TextStyle::Representation property :glyph, as: 'glyph' property :list_id, as: 'listId' property :nesting_level, as: 'nestingLevel' end end class ColorScheme # @private class Representation < Google::Apis::Core::JsonRepresentation collection :colors, as: 'colors', class: Google::Apis::SlidesV1::ThemeColorPair, decorator: Google::Apis::SlidesV1::ThemeColorPair::Representation end end class ColorStop # @private class Representation < Google::Apis::Core::JsonRepresentation property :alpha, as: 'alpha' property :color, as: 'color', class: Google::Apis::SlidesV1::OpaqueColor, decorator: Google::Apis::SlidesV1::OpaqueColor::Representation property :position, as: 'position' end end class CreateImageRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :element_properties, as: 'elementProperties', class: Google::Apis::SlidesV1::PageElementProperties, decorator: Google::Apis::SlidesV1::PageElementProperties::Representation property :object_id_prop, as: 'objectId' property :url, as: 'url' end end class CreateImageResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class CreateLineRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :element_properties, as: 'elementProperties', class: Google::Apis::SlidesV1::PageElementProperties, decorator: Google::Apis::SlidesV1::PageElementProperties::Representation property :line_category, as: 'lineCategory' property :object_id_prop, as: 'objectId' end end class CreateLineResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class CreateParagraphBulletsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :bullet_preset, as: 'bulletPreset' property :cell_location, as: 'cellLocation', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :object_id_prop, as: 'objectId' property :text_range, as: 'textRange', class: Google::Apis::SlidesV1::Range, decorator: Google::Apis::SlidesV1::Range::Representation end end class CreateShapeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :element_properties, as: 'elementProperties', class: Google::Apis::SlidesV1::PageElementProperties, decorator: Google::Apis::SlidesV1::PageElementProperties::Representation property :object_id_prop, as: 'objectId' property :shape_type, as: 'shapeType' end end class CreateShapeResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class CreateSheetsChartRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :chart_id, as: 'chartId' property :element_properties, as: 'elementProperties', class: Google::Apis::SlidesV1::PageElementProperties, decorator: Google::Apis::SlidesV1::PageElementProperties::Representation property :linking_mode, as: 'linkingMode' property :object_id_prop, as: 'objectId' property :spreadsheet_id, as: 'spreadsheetId' end end class CreateSheetsChartResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class CreateSlideRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :insertion_index, as: 'insertionIndex' property :object_id_prop, as: 'objectId' collection :placeholder_id_mappings, as: 'placeholderIdMappings', class: Google::Apis::SlidesV1::LayoutPlaceholderIdMapping, decorator: Google::Apis::SlidesV1::LayoutPlaceholderIdMapping::Representation property :slide_layout_reference, as: 'slideLayoutReference', class: Google::Apis::SlidesV1::LayoutReference, decorator: Google::Apis::SlidesV1::LayoutReference::Representation end end class CreateSlideResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class CreateTableRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :columns, as: 'columns' property :element_properties, as: 'elementProperties', class: Google::Apis::SlidesV1::PageElementProperties, decorator: Google::Apis::SlidesV1::PageElementProperties::Representation property :object_id_prop, as: 'objectId' property :rows, as: 'rows' end end class CreateTableResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class CreateVideoRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :element_properties, as: 'elementProperties', class: Google::Apis::SlidesV1::PageElementProperties, decorator: Google::Apis::SlidesV1::PageElementProperties::Representation property :id, as: 'id' property :object_id_prop, as: 'objectId' property :source, as: 'source' end end class CreateVideoResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class CropProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :angle, as: 'angle' property :bottom_offset, as: 'bottomOffset' property :left_offset, as: 'leftOffset' property :right_offset, as: 'rightOffset' property :top_offset, as: 'topOffset' end end class DeleteObjectRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class DeleteParagraphBulletsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cell_location, as: 'cellLocation', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :object_id_prop, as: 'objectId' property :text_range, as: 'textRange', class: Google::Apis::SlidesV1::Range, decorator: Google::Apis::SlidesV1::Range::Representation end end class DeleteTableColumnRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cell_location, as: 'cellLocation', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :table_object_id, as: 'tableObjectId' end end class DeleteTableRowRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cell_location, as: 'cellLocation', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :table_object_id, as: 'tableObjectId' end end class DeleteTextRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cell_location, as: 'cellLocation', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :object_id_prop, as: 'objectId' property :text_range, as: 'textRange', class: Google::Apis::SlidesV1::Range, decorator: Google::Apis::SlidesV1::Range::Representation end end class Dimension # @private class Representation < Google::Apis::Core::JsonRepresentation property :magnitude, as: 'magnitude' property :unit, as: 'unit' end end class DuplicateObjectRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' hash :object_ids, as: 'objectIds' end end class DuplicateObjectResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class Group # @private class Representation < Google::Apis::Core::JsonRepresentation collection :children, as: 'children', class: Google::Apis::SlidesV1::PageElement, decorator: Google::Apis::SlidesV1::PageElement::Representation end end class GroupObjectsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :children_object_ids, as: 'childrenObjectIds' property :group_object_id, as: 'groupObjectId' end end class GroupObjectsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_url, as: 'contentUrl' property :image_properties, as: 'imageProperties', class: Google::Apis::SlidesV1::ImageProperties, decorator: Google::Apis::SlidesV1::ImageProperties::Representation property :source_url, as: 'sourceUrl' end end class ImageProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :brightness, as: 'brightness' property :contrast, as: 'contrast' property :crop_properties, as: 'cropProperties', class: Google::Apis::SlidesV1::CropProperties, decorator: Google::Apis::SlidesV1::CropProperties::Representation property :link, as: 'link', class: Google::Apis::SlidesV1::Link, decorator: Google::Apis::SlidesV1::Link::Representation property :outline, as: 'outline', class: Google::Apis::SlidesV1::Outline, decorator: Google::Apis::SlidesV1::Outline::Representation property :recolor, as: 'recolor', class: Google::Apis::SlidesV1::Recolor, decorator: Google::Apis::SlidesV1::Recolor::Representation property :shadow, as: 'shadow', class: Google::Apis::SlidesV1::Shadow, decorator: Google::Apis::SlidesV1::Shadow::Representation property :transparency, as: 'transparency' end end class InsertTableColumnsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cell_location, as: 'cellLocation', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :insert_right, as: 'insertRight' property :number, as: 'number' property :table_object_id, as: 'tableObjectId' end end class InsertTableRowsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cell_location, as: 'cellLocation', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :insert_below, as: 'insertBelow' property :number, as: 'number' property :table_object_id, as: 'tableObjectId' end end class InsertTextRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cell_location, as: 'cellLocation', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :insertion_index, as: 'insertionIndex' property :object_id_prop, as: 'objectId' property :text, as: 'text' end end class LayoutPlaceholderIdMapping # @private class Representation < Google::Apis::Core::JsonRepresentation property :layout_placeholder, as: 'layoutPlaceholder', class: Google::Apis::SlidesV1::Placeholder, decorator: Google::Apis::SlidesV1::Placeholder::Representation property :layout_placeholder_object_id, as: 'layoutPlaceholderObjectId' property :object_id_prop, as: 'objectId' end end class LayoutProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :master_object_id, as: 'masterObjectId' property :name, as: 'name' end end class LayoutReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :layout_id, as: 'layoutId' property :predefined_layout, as: 'predefinedLayout' end end class Line # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_properties, as: 'lineProperties', class: Google::Apis::SlidesV1::LineProperties, decorator: Google::Apis::SlidesV1::LineProperties::Representation property :line_type, as: 'lineType' end end class LineFill # @private class Representation < Google::Apis::Core::JsonRepresentation property :solid_fill, as: 'solidFill', class: Google::Apis::SlidesV1::SolidFill, decorator: Google::Apis::SlidesV1::SolidFill::Representation end end class LineProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :dash_style, as: 'dashStyle' property :end_arrow, as: 'endArrow' property :line_fill, as: 'lineFill', class: Google::Apis::SlidesV1::LineFill, decorator: Google::Apis::SlidesV1::LineFill::Representation property :link, as: 'link', class: Google::Apis::SlidesV1::Link, decorator: Google::Apis::SlidesV1::Link::Representation property :start_arrow, as: 'startArrow' property :weight, as: 'weight', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation end end class Link # @private class Representation < Google::Apis::Core::JsonRepresentation property :page_object_id, as: 'pageObjectId' property :relative_link, as: 'relativeLink' property :slide_index, as: 'slideIndex' property :url, as: 'url' end end class List # @private class Representation < Google::Apis::Core::JsonRepresentation property :list_id, as: 'listId' hash :nesting_level, as: 'nestingLevel', class: Google::Apis::SlidesV1::NestingLevel, decorator: Google::Apis::SlidesV1::NestingLevel::Representation end end class MasterProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' end end class MergeTableCellsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' property :table_range, as: 'tableRange', class: Google::Apis::SlidesV1::TableRange, decorator: Google::Apis::SlidesV1::TableRange::Representation end end class NestingLevel # @private class Representation < Google::Apis::Core::JsonRepresentation property :bullet_style, as: 'bulletStyle', class: Google::Apis::SlidesV1::TextStyle, decorator: Google::Apis::SlidesV1::TextStyle::Representation end end class NotesProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :speaker_notes_object_id, as: 'speakerNotesObjectId' end end class OpaqueColor # @private class Representation < Google::Apis::Core::JsonRepresentation property :rgb_color, as: 'rgbColor', class: Google::Apis::SlidesV1::RgbColor, decorator: Google::Apis::SlidesV1::RgbColor::Representation property :theme_color, as: 'themeColor' end end class OptionalColor # @private class Representation < Google::Apis::Core::JsonRepresentation property :opaque_color, as: 'opaqueColor', class: Google::Apis::SlidesV1::OpaqueColor, decorator: Google::Apis::SlidesV1::OpaqueColor::Representation end end class Outline # @private class Representation < Google::Apis::Core::JsonRepresentation property :dash_style, as: 'dashStyle' property :outline_fill, as: 'outlineFill', class: Google::Apis::SlidesV1::OutlineFill, decorator: Google::Apis::SlidesV1::OutlineFill::Representation property :property_state, as: 'propertyState' property :weight, as: 'weight', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation end end class OutlineFill # @private class Representation < Google::Apis::Core::JsonRepresentation property :solid_fill, as: 'solidFill', class: Google::Apis::SlidesV1::SolidFill, decorator: Google::Apis::SlidesV1::SolidFill::Representation end end class Page # @private class Representation < Google::Apis::Core::JsonRepresentation property :layout_properties, as: 'layoutProperties', class: Google::Apis::SlidesV1::LayoutProperties, decorator: Google::Apis::SlidesV1::LayoutProperties::Representation property :master_properties, as: 'masterProperties', class: Google::Apis::SlidesV1::MasterProperties, decorator: Google::Apis::SlidesV1::MasterProperties::Representation property :notes_properties, as: 'notesProperties', class: Google::Apis::SlidesV1::NotesProperties, decorator: Google::Apis::SlidesV1::NotesProperties::Representation property :object_id_prop, as: 'objectId' collection :page_elements, as: 'pageElements', class: Google::Apis::SlidesV1::PageElement, decorator: Google::Apis::SlidesV1::PageElement::Representation property :page_properties, as: 'pageProperties', class: Google::Apis::SlidesV1::PageProperties, decorator: Google::Apis::SlidesV1::PageProperties::Representation property :page_type, as: 'pageType' property :revision_id, as: 'revisionId' property :slide_properties, as: 'slideProperties', class: Google::Apis::SlidesV1::SlideProperties, decorator: Google::Apis::SlidesV1::SlideProperties::Representation end end class PageBackgroundFill # @private class Representation < Google::Apis::Core::JsonRepresentation property :property_state, as: 'propertyState' property :solid_fill, as: 'solidFill', class: Google::Apis::SlidesV1::SolidFill, decorator: Google::Apis::SlidesV1::SolidFill::Representation property :stretched_picture_fill, as: 'stretchedPictureFill', class: Google::Apis::SlidesV1::StretchedPictureFill, decorator: Google::Apis::SlidesV1::StretchedPictureFill::Representation end end class PageElement # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :element_group, as: 'elementGroup', class: Google::Apis::SlidesV1::Group, decorator: Google::Apis::SlidesV1::Group::Representation property :image, as: 'image', class: Google::Apis::SlidesV1::Image, decorator: Google::Apis::SlidesV1::Image::Representation property :line, as: 'line', class: Google::Apis::SlidesV1::Line, decorator: Google::Apis::SlidesV1::Line::Representation property :object_id_prop, as: 'objectId' property :shape, as: 'shape', class: Google::Apis::SlidesV1::Shape, decorator: Google::Apis::SlidesV1::Shape::Representation property :sheets_chart, as: 'sheetsChart', class: Google::Apis::SlidesV1::SheetsChart, decorator: Google::Apis::SlidesV1::SheetsChart::Representation property :size, as: 'size', class: Google::Apis::SlidesV1::Size, decorator: Google::Apis::SlidesV1::Size::Representation property :table, as: 'table', class: Google::Apis::SlidesV1::Table, decorator: Google::Apis::SlidesV1::Table::Representation property :title, as: 'title' property :transform, as: 'transform', class: Google::Apis::SlidesV1::AffineTransform, decorator: Google::Apis::SlidesV1::AffineTransform::Representation property :video, as: 'video', class: Google::Apis::SlidesV1::Video, decorator: Google::Apis::SlidesV1::Video::Representation property :word_art, as: 'wordArt', class: Google::Apis::SlidesV1::WordArt, decorator: Google::Apis::SlidesV1::WordArt::Representation end end class PageElementProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :page_object_id, as: 'pageObjectId' property :size, as: 'size', class: Google::Apis::SlidesV1::Size, decorator: Google::Apis::SlidesV1::Size::Representation property :transform, as: 'transform', class: Google::Apis::SlidesV1::AffineTransform, decorator: Google::Apis::SlidesV1::AffineTransform::Representation end end class PageProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :color_scheme, as: 'colorScheme', class: Google::Apis::SlidesV1::ColorScheme, decorator: Google::Apis::SlidesV1::ColorScheme::Representation property :page_background_fill, as: 'pageBackgroundFill', class: Google::Apis::SlidesV1::PageBackgroundFill, decorator: Google::Apis::SlidesV1::PageBackgroundFill::Representation end end class ParagraphMarker # @private class Representation < Google::Apis::Core::JsonRepresentation property :bullet, as: 'bullet', class: Google::Apis::SlidesV1::Bullet, decorator: Google::Apis::SlidesV1::Bullet::Representation property :style, as: 'style', class: Google::Apis::SlidesV1::ParagraphStyle, decorator: Google::Apis::SlidesV1::ParagraphStyle::Representation end end class ParagraphStyle # @private class Representation < Google::Apis::Core::JsonRepresentation property :alignment, as: 'alignment' property :direction, as: 'direction' property :indent_end, as: 'indentEnd', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation property :indent_first_line, as: 'indentFirstLine', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation property :indent_start, as: 'indentStart', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation property :line_spacing, as: 'lineSpacing' property :space_above, as: 'spaceAbove', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation property :space_below, as: 'spaceBelow', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation property :spacing_mode, as: 'spacingMode' end end class Placeholder # @private class Representation < Google::Apis::Core::JsonRepresentation property :index, as: 'index' property :parent_object_id, as: 'parentObjectId' property :type, as: 'type' end end class Presentation # @private class Representation < Google::Apis::Core::JsonRepresentation collection :layouts, as: 'layouts', class: Google::Apis::SlidesV1::Page, decorator: Google::Apis::SlidesV1::Page::Representation property :locale, as: 'locale' collection :masters, as: 'masters', class: Google::Apis::SlidesV1::Page, decorator: Google::Apis::SlidesV1::Page::Representation property :notes_master, as: 'notesMaster', class: Google::Apis::SlidesV1::Page, decorator: Google::Apis::SlidesV1::Page::Representation property :page_size, as: 'pageSize', class: Google::Apis::SlidesV1::Size, decorator: Google::Apis::SlidesV1::Size::Representation property :presentation_id, as: 'presentationId' property :revision_id, as: 'revisionId' collection :slides, as: 'slides', class: Google::Apis::SlidesV1::Page, decorator: Google::Apis::SlidesV1::Page::Representation property :title, as: 'title' end end class Range # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_index, as: 'endIndex' property :start_index, as: 'startIndex' property :type, as: 'type' end end class Recolor # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' collection :recolor_stops, as: 'recolorStops', class: Google::Apis::SlidesV1::ColorStop, decorator: Google::Apis::SlidesV1::ColorStop::Representation end end class RefreshSheetsChartRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' end end class ReplaceAllShapesWithImageRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :contains_text, as: 'containsText', class: Google::Apis::SlidesV1::SubstringMatchCriteria, decorator: Google::Apis::SlidesV1::SubstringMatchCriteria::Representation property :image_replace_method, as: 'imageReplaceMethod' property :image_url, as: 'imageUrl' collection :page_object_ids, as: 'pageObjectIds' property :replace_method, as: 'replaceMethod' end end class ReplaceAllShapesWithImageResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :occurrences_changed, as: 'occurrencesChanged' end end class ReplaceAllShapesWithSheetsChartRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :chart_id, as: 'chartId' property :contains_text, as: 'containsText', class: Google::Apis::SlidesV1::SubstringMatchCriteria, decorator: Google::Apis::SlidesV1::SubstringMatchCriteria::Representation property :linking_mode, as: 'linkingMode' collection :page_object_ids, as: 'pageObjectIds' property :spreadsheet_id, as: 'spreadsheetId' end end class ReplaceAllShapesWithSheetsChartResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :occurrences_changed, as: 'occurrencesChanged' end end class ReplaceAllTextRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :contains_text, as: 'containsText', class: Google::Apis::SlidesV1::SubstringMatchCriteria, decorator: Google::Apis::SlidesV1::SubstringMatchCriteria::Representation collection :page_object_ids, as: 'pageObjectIds' property :replace_text, as: 'replaceText' end end class ReplaceAllTextResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :occurrences_changed, as: 'occurrencesChanged' end end class Request # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_image, as: 'createImage', class: Google::Apis::SlidesV1::CreateImageRequest, decorator: Google::Apis::SlidesV1::CreateImageRequest::Representation property :create_line, as: 'createLine', class: Google::Apis::SlidesV1::CreateLineRequest, decorator: Google::Apis::SlidesV1::CreateLineRequest::Representation property :create_paragraph_bullets, as: 'createParagraphBullets', class: Google::Apis::SlidesV1::CreateParagraphBulletsRequest, decorator: Google::Apis::SlidesV1::CreateParagraphBulletsRequest::Representation property :create_shape, as: 'createShape', class: Google::Apis::SlidesV1::CreateShapeRequest, decorator: Google::Apis::SlidesV1::CreateShapeRequest::Representation property :create_sheets_chart, as: 'createSheetsChart', class: Google::Apis::SlidesV1::CreateSheetsChartRequest, decorator: Google::Apis::SlidesV1::CreateSheetsChartRequest::Representation property :create_slide, as: 'createSlide', class: Google::Apis::SlidesV1::CreateSlideRequest, decorator: Google::Apis::SlidesV1::CreateSlideRequest::Representation property :create_table, as: 'createTable', class: Google::Apis::SlidesV1::CreateTableRequest, decorator: Google::Apis::SlidesV1::CreateTableRequest::Representation property :create_video, as: 'createVideo', class: Google::Apis::SlidesV1::CreateVideoRequest, decorator: Google::Apis::SlidesV1::CreateVideoRequest::Representation property :delete_object, as: 'deleteObject', class: Google::Apis::SlidesV1::DeleteObjectRequest, decorator: Google::Apis::SlidesV1::DeleteObjectRequest::Representation property :delete_paragraph_bullets, as: 'deleteParagraphBullets', class: Google::Apis::SlidesV1::DeleteParagraphBulletsRequest, decorator: Google::Apis::SlidesV1::DeleteParagraphBulletsRequest::Representation property :delete_table_column, as: 'deleteTableColumn', class: Google::Apis::SlidesV1::DeleteTableColumnRequest, decorator: Google::Apis::SlidesV1::DeleteTableColumnRequest::Representation property :delete_table_row, as: 'deleteTableRow', class: Google::Apis::SlidesV1::DeleteTableRowRequest, decorator: Google::Apis::SlidesV1::DeleteTableRowRequest::Representation property :delete_text, as: 'deleteText', class: Google::Apis::SlidesV1::DeleteTextRequest, decorator: Google::Apis::SlidesV1::DeleteTextRequest::Representation property :duplicate_object, as: 'duplicateObject', class: Google::Apis::SlidesV1::DuplicateObjectRequest, decorator: Google::Apis::SlidesV1::DuplicateObjectRequest::Representation property :group_objects, as: 'groupObjects', class: Google::Apis::SlidesV1::GroupObjectsRequest, decorator: Google::Apis::SlidesV1::GroupObjectsRequest::Representation property :insert_table_columns, as: 'insertTableColumns', class: Google::Apis::SlidesV1::InsertTableColumnsRequest, decorator: Google::Apis::SlidesV1::InsertTableColumnsRequest::Representation property :insert_table_rows, as: 'insertTableRows', class: Google::Apis::SlidesV1::InsertTableRowsRequest, decorator: Google::Apis::SlidesV1::InsertTableRowsRequest::Representation property :insert_text, as: 'insertText', class: Google::Apis::SlidesV1::InsertTextRequest, decorator: Google::Apis::SlidesV1::InsertTextRequest::Representation property :merge_table_cells, as: 'mergeTableCells', class: Google::Apis::SlidesV1::MergeTableCellsRequest, decorator: Google::Apis::SlidesV1::MergeTableCellsRequest::Representation property :refresh_sheets_chart, as: 'refreshSheetsChart', class: Google::Apis::SlidesV1::RefreshSheetsChartRequest, decorator: Google::Apis::SlidesV1::RefreshSheetsChartRequest::Representation property :replace_all_shapes_with_image, as: 'replaceAllShapesWithImage', class: Google::Apis::SlidesV1::ReplaceAllShapesWithImageRequest, decorator: Google::Apis::SlidesV1::ReplaceAllShapesWithImageRequest::Representation property :replace_all_shapes_with_sheets_chart, as: 'replaceAllShapesWithSheetsChart', class: Google::Apis::SlidesV1::ReplaceAllShapesWithSheetsChartRequest, decorator: Google::Apis::SlidesV1::ReplaceAllShapesWithSheetsChartRequest::Representation property :replace_all_text, as: 'replaceAllText', class: Google::Apis::SlidesV1::ReplaceAllTextRequest, decorator: Google::Apis::SlidesV1::ReplaceAllTextRequest::Representation property :ungroup_objects, as: 'ungroupObjects', class: Google::Apis::SlidesV1::UngroupObjectsRequest, decorator: Google::Apis::SlidesV1::UngroupObjectsRequest::Representation property :unmerge_table_cells, as: 'unmergeTableCells', class: Google::Apis::SlidesV1::UnmergeTableCellsRequest, decorator: Google::Apis::SlidesV1::UnmergeTableCellsRequest::Representation property :update_image_properties, as: 'updateImageProperties', class: Google::Apis::SlidesV1::UpdateImagePropertiesRequest, decorator: Google::Apis::SlidesV1::UpdateImagePropertiesRequest::Representation property :update_line_properties, as: 'updateLineProperties', class: Google::Apis::SlidesV1::UpdateLinePropertiesRequest, decorator: Google::Apis::SlidesV1::UpdateLinePropertiesRequest::Representation property :update_page_element_alt_text, as: 'updatePageElementAltText', class: Google::Apis::SlidesV1::UpdatePageElementAltTextRequest, decorator: Google::Apis::SlidesV1::UpdatePageElementAltTextRequest::Representation property :update_page_element_transform, as: 'updatePageElementTransform', class: Google::Apis::SlidesV1::UpdatePageElementTransformRequest, decorator: Google::Apis::SlidesV1::UpdatePageElementTransformRequest::Representation property :update_page_properties, as: 'updatePageProperties', class: Google::Apis::SlidesV1::UpdatePagePropertiesRequest, decorator: Google::Apis::SlidesV1::UpdatePagePropertiesRequest::Representation property :update_paragraph_style, as: 'updateParagraphStyle', class: Google::Apis::SlidesV1::UpdateParagraphStyleRequest, decorator: Google::Apis::SlidesV1::UpdateParagraphStyleRequest::Representation property :update_shape_properties, as: 'updateShapeProperties', class: Google::Apis::SlidesV1::UpdateShapePropertiesRequest, decorator: Google::Apis::SlidesV1::UpdateShapePropertiesRequest::Representation property :update_slides_position, as: 'updateSlidesPosition', class: Google::Apis::SlidesV1::UpdateSlidesPositionRequest, decorator: Google::Apis::SlidesV1::UpdateSlidesPositionRequest::Representation property :update_table_border_properties, as: 'updateTableBorderProperties', class: Google::Apis::SlidesV1::UpdateTableBorderPropertiesRequest, decorator: Google::Apis::SlidesV1::UpdateTableBorderPropertiesRequest::Representation property :update_table_cell_properties, as: 'updateTableCellProperties', class: Google::Apis::SlidesV1::UpdateTableCellPropertiesRequest, decorator: Google::Apis::SlidesV1::UpdateTableCellPropertiesRequest::Representation property :update_table_column_properties, as: 'updateTableColumnProperties', class: Google::Apis::SlidesV1::UpdateTableColumnPropertiesRequest, decorator: Google::Apis::SlidesV1::UpdateTableColumnPropertiesRequest::Representation property :update_table_row_properties, as: 'updateTableRowProperties', class: Google::Apis::SlidesV1::UpdateTableRowPropertiesRequest, decorator: Google::Apis::SlidesV1::UpdateTableRowPropertiesRequest::Representation property :update_text_style, as: 'updateTextStyle', class: Google::Apis::SlidesV1::UpdateTextStyleRequest, decorator: Google::Apis::SlidesV1::UpdateTextStyleRequest::Representation property :update_video_properties, as: 'updateVideoProperties', class: Google::Apis::SlidesV1::UpdateVideoPropertiesRequest, decorator: Google::Apis::SlidesV1::UpdateVideoPropertiesRequest::Representation end end class Response # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_image, as: 'createImage', class: Google::Apis::SlidesV1::CreateImageResponse, decorator: Google::Apis::SlidesV1::CreateImageResponse::Representation property :create_line, as: 'createLine', class: Google::Apis::SlidesV1::CreateLineResponse, decorator: Google::Apis::SlidesV1::CreateLineResponse::Representation property :create_shape, as: 'createShape', class: Google::Apis::SlidesV1::CreateShapeResponse, decorator: Google::Apis::SlidesV1::CreateShapeResponse::Representation property :create_sheets_chart, as: 'createSheetsChart', class: Google::Apis::SlidesV1::CreateSheetsChartResponse, decorator: Google::Apis::SlidesV1::CreateSheetsChartResponse::Representation property :create_slide, as: 'createSlide', class: Google::Apis::SlidesV1::CreateSlideResponse, decorator: Google::Apis::SlidesV1::CreateSlideResponse::Representation property :create_table, as: 'createTable', class: Google::Apis::SlidesV1::CreateTableResponse, decorator: Google::Apis::SlidesV1::CreateTableResponse::Representation property :create_video, as: 'createVideo', class: Google::Apis::SlidesV1::CreateVideoResponse, decorator: Google::Apis::SlidesV1::CreateVideoResponse::Representation property :duplicate_object, as: 'duplicateObject', class: Google::Apis::SlidesV1::DuplicateObjectResponse, decorator: Google::Apis::SlidesV1::DuplicateObjectResponse::Representation property :group_objects, as: 'groupObjects', class: Google::Apis::SlidesV1::GroupObjectsResponse, decorator: Google::Apis::SlidesV1::GroupObjectsResponse::Representation property :replace_all_shapes_with_image, as: 'replaceAllShapesWithImage', class: Google::Apis::SlidesV1::ReplaceAllShapesWithImageResponse, decorator: Google::Apis::SlidesV1::ReplaceAllShapesWithImageResponse::Representation property :replace_all_shapes_with_sheets_chart, as: 'replaceAllShapesWithSheetsChart', class: Google::Apis::SlidesV1::ReplaceAllShapesWithSheetsChartResponse, decorator: Google::Apis::SlidesV1::ReplaceAllShapesWithSheetsChartResponse::Representation property :replace_all_text, as: 'replaceAllText', class: Google::Apis::SlidesV1::ReplaceAllTextResponse, decorator: Google::Apis::SlidesV1::ReplaceAllTextResponse::Representation end end class RgbColor # @private class Representation < Google::Apis::Core::JsonRepresentation property :blue, as: 'blue' property :green, as: 'green' property :red, as: 'red' end end class Shadow # @private class Representation < Google::Apis::Core::JsonRepresentation property :alignment, as: 'alignment' property :alpha, as: 'alpha' property :blur_radius, as: 'blurRadius', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation property :color, as: 'color', class: Google::Apis::SlidesV1::OpaqueColor, decorator: Google::Apis::SlidesV1::OpaqueColor::Representation property :property_state, as: 'propertyState' property :rotate_with_shape, as: 'rotateWithShape' property :transform, as: 'transform', class: Google::Apis::SlidesV1::AffineTransform, decorator: Google::Apis::SlidesV1::AffineTransform::Representation property :type, as: 'type' end end class Shape # @private class Representation < Google::Apis::Core::JsonRepresentation property :placeholder, as: 'placeholder', class: Google::Apis::SlidesV1::Placeholder, decorator: Google::Apis::SlidesV1::Placeholder::Representation property :shape_properties, as: 'shapeProperties', class: Google::Apis::SlidesV1::ShapeProperties, decorator: Google::Apis::SlidesV1::ShapeProperties::Representation property :shape_type, as: 'shapeType' property :text, as: 'text', class: Google::Apis::SlidesV1::TextContent, decorator: Google::Apis::SlidesV1::TextContent::Representation end end class ShapeBackgroundFill # @private class Representation < Google::Apis::Core::JsonRepresentation property :property_state, as: 'propertyState' property :solid_fill, as: 'solidFill', class: Google::Apis::SlidesV1::SolidFill, decorator: Google::Apis::SlidesV1::SolidFill::Representation end end class ShapeProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_alignment, as: 'contentAlignment' property :link, as: 'link', class: Google::Apis::SlidesV1::Link, decorator: Google::Apis::SlidesV1::Link::Representation property :outline, as: 'outline', class: Google::Apis::SlidesV1::Outline, decorator: Google::Apis::SlidesV1::Outline::Representation property :shadow, as: 'shadow', class: Google::Apis::SlidesV1::Shadow, decorator: Google::Apis::SlidesV1::Shadow::Representation property :shape_background_fill, as: 'shapeBackgroundFill', class: Google::Apis::SlidesV1::ShapeBackgroundFill, decorator: Google::Apis::SlidesV1::ShapeBackgroundFill::Representation end end class SheetsChart # @private class Representation < Google::Apis::Core::JsonRepresentation property :chart_id, as: 'chartId' property :content_url, as: 'contentUrl' property :sheets_chart_properties, as: 'sheetsChartProperties', class: Google::Apis::SlidesV1::SheetsChartProperties, decorator: Google::Apis::SlidesV1::SheetsChartProperties::Representation property :spreadsheet_id, as: 'spreadsheetId' end end class SheetsChartProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :chart_image_properties, as: 'chartImageProperties', class: Google::Apis::SlidesV1::ImageProperties, decorator: Google::Apis::SlidesV1::ImageProperties::Representation end end class Size # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation property :width, as: 'width', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation end end class SlideProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :layout_object_id, as: 'layoutObjectId' property :master_object_id, as: 'masterObjectId' property :notes_page, as: 'notesPage', class: Google::Apis::SlidesV1::Page, decorator: Google::Apis::SlidesV1::Page::Representation end end class SolidFill # @private class Representation < Google::Apis::Core::JsonRepresentation property :alpha, as: 'alpha' property :color, as: 'color', class: Google::Apis::SlidesV1::OpaqueColor, decorator: Google::Apis::SlidesV1::OpaqueColor::Representation end end class StretchedPictureFill # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_url, as: 'contentUrl' property :size, as: 'size', class: Google::Apis::SlidesV1::Size, decorator: Google::Apis::SlidesV1::Size::Representation end end class SubstringMatchCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation property :match_case, as: 'matchCase' property :text, as: 'text' end end class Table # @private class Representation < Google::Apis::Core::JsonRepresentation property :columns, as: 'columns' collection :horizontal_border_rows, as: 'horizontalBorderRows', class: Google::Apis::SlidesV1::TableBorderRow, decorator: Google::Apis::SlidesV1::TableBorderRow::Representation property :rows, as: 'rows' collection :table_columns, as: 'tableColumns', class: Google::Apis::SlidesV1::TableColumnProperties, decorator: Google::Apis::SlidesV1::TableColumnProperties::Representation collection :table_rows, as: 'tableRows', class: Google::Apis::SlidesV1::TableRow, decorator: Google::Apis::SlidesV1::TableRow::Representation collection :vertical_border_rows, as: 'verticalBorderRows', class: Google::Apis::SlidesV1::TableBorderRow, decorator: Google::Apis::SlidesV1::TableBorderRow::Representation end end class TableBorderCell # @private class Representation < Google::Apis::Core::JsonRepresentation property :location, as: 'location', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :table_border_properties, as: 'tableBorderProperties', class: Google::Apis::SlidesV1::TableBorderProperties, decorator: Google::Apis::SlidesV1::TableBorderProperties::Representation end end class TableBorderFill # @private class Representation < Google::Apis::Core::JsonRepresentation property :solid_fill, as: 'solidFill', class: Google::Apis::SlidesV1::SolidFill, decorator: Google::Apis::SlidesV1::SolidFill::Representation end end class TableBorderProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :dash_style, as: 'dashStyle' property :table_border_fill, as: 'tableBorderFill', class: Google::Apis::SlidesV1::TableBorderFill, decorator: Google::Apis::SlidesV1::TableBorderFill::Representation property :weight, as: 'weight', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation end end class TableBorderRow # @private class Representation < Google::Apis::Core::JsonRepresentation collection :table_border_cells, as: 'tableBorderCells', class: Google::Apis::SlidesV1::TableBorderCell, decorator: Google::Apis::SlidesV1::TableBorderCell::Representation end end class TableCell # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_span, as: 'columnSpan' property :location, as: 'location', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :row_span, as: 'rowSpan' property :table_cell_properties, as: 'tableCellProperties', class: Google::Apis::SlidesV1::TableCellProperties, decorator: Google::Apis::SlidesV1::TableCellProperties::Representation property :text, as: 'text', class: Google::Apis::SlidesV1::TextContent, decorator: Google::Apis::SlidesV1::TextContent::Representation end end class TableCellBackgroundFill # @private class Representation < Google::Apis::Core::JsonRepresentation property :property_state, as: 'propertyState' property :solid_fill, as: 'solidFill', class: Google::Apis::SlidesV1::SolidFill, decorator: Google::Apis::SlidesV1::SolidFill::Representation end end class TableCellLocation # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_index, as: 'columnIndex' property :row_index, as: 'rowIndex' end end class TableCellProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_alignment, as: 'contentAlignment' property :table_cell_background_fill, as: 'tableCellBackgroundFill', class: Google::Apis::SlidesV1::TableCellBackgroundFill, decorator: Google::Apis::SlidesV1::TableCellBackgroundFill::Representation end end class TableColumnProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_width, as: 'columnWidth', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation end end class TableRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_span, as: 'columnSpan' property :location, as: 'location', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :row_span, as: 'rowSpan' end end class TableRow # @private class Representation < Google::Apis::Core::JsonRepresentation property :row_height, as: 'rowHeight', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation collection :table_cells, as: 'tableCells', class: Google::Apis::SlidesV1::TableCell, decorator: Google::Apis::SlidesV1::TableCell::Representation property :table_row_properties, as: 'tableRowProperties', class: Google::Apis::SlidesV1::TableRowProperties, decorator: Google::Apis::SlidesV1::TableRowProperties::Representation end end class TableRowProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :min_row_height, as: 'minRowHeight', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation end end class TextContent # @private class Representation < Google::Apis::Core::JsonRepresentation hash :lists, as: 'lists', class: Google::Apis::SlidesV1::List, decorator: Google::Apis::SlidesV1::List::Representation collection :text_elements, as: 'textElements', class: Google::Apis::SlidesV1::TextElement, decorator: Google::Apis::SlidesV1::TextElement::Representation end end class TextElement # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_text, as: 'autoText', class: Google::Apis::SlidesV1::AutoText, decorator: Google::Apis::SlidesV1::AutoText::Representation property :end_index, as: 'endIndex' property :paragraph_marker, as: 'paragraphMarker', class: Google::Apis::SlidesV1::ParagraphMarker, decorator: Google::Apis::SlidesV1::ParagraphMarker::Representation property :start_index, as: 'startIndex' property :text_run, as: 'textRun', class: Google::Apis::SlidesV1::TextRun, decorator: Google::Apis::SlidesV1::TextRun::Representation end end class TextRun # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :style, as: 'style', class: Google::Apis::SlidesV1::TextStyle, decorator: Google::Apis::SlidesV1::TextStyle::Representation end end class TextStyle # @private class Representation < Google::Apis::Core::JsonRepresentation property :background_color, as: 'backgroundColor', class: Google::Apis::SlidesV1::OptionalColor, decorator: Google::Apis::SlidesV1::OptionalColor::Representation property :baseline_offset, as: 'baselineOffset' property :bold, as: 'bold' property :font_family, as: 'fontFamily' property :font_size, as: 'fontSize', class: Google::Apis::SlidesV1::Dimension, decorator: Google::Apis::SlidesV1::Dimension::Representation property :foreground_color, as: 'foregroundColor', class: Google::Apis::SlidesV1::OptionalColor, decorator: Google::Apis::SlidesV1::OptionalColor::Representation property :italic, as: 'italic' property :link, as: 'link', class: Google::Apis::SlidesV1::Link, decorator: Google::Apis::SlidesV1::Link::Representation property :small_caps, as: 'smallCaps' property :strikethrough, as: 'strikethrough' property :underline, as: 'underline' property :weighted_font_family, as: 'weightedFontFamily', class: Google::Apis::SlidesV1::WeightedFontFamily, decorator: Google::Apis::SlidesV1::WeightedFontFamily::Representation end end class ThemeColorPair # @private class Representation < Google::Apis::Core::JsonRepresentation property :color, as: 'color', class: Google::Apis::SlidesV1::RgbColor, decorator: Google::Apis::SlidesV1::RgbColor::Representation property :type, as: 'type' end end class Thumbnail # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_url, as: 'contentUrl' property :height, as: 'height' property :width, as: 'width' end end class UngroupObjectsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :object_ids, as: 'objectIds' end end class UnmergeTableCellsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_id_prop, as: 'objectId' property :table_range, as: 'tableRange', class: Google::Apis::SlidesV1::TableRange, decorator: Google::Apis::SlidesV1::TableRange::Representation end end class UpdateImagePropertiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fields, as: 'fields' property :image_properties, as: 'imageProperties', class: Google::Apis::SlidesV1::ImageProperties, decorator: Google::Apis::SlidesV1::ImageProperties::Representation property :object_id_prop, as: 'objectId' end end class UpdateLinePropertiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fields, as: 'fields' property :line_properties, as: 'lineProperties', class: Google::Apis::SlidesV1::LineProperties, decorator: Google::Apis::SlidesV1::LineProperties::Representation property :object_id_prop, as: 'objectId' end end class UpdatePageElementAltTextRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :object_id_prop, as: 'objectId' property :title, as: 'title' end end class UpdatePageElementTransformRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :apply_mode, as: 'applyMode' property :object_id_prop, as: 'objectId' property :transform, as: 'transform', class: Google::Apis::SlidesV1::AffineTransform, decorator: Google::Apis::SlidesV1::AffineTransform::Representation end end class UpdatePagePropertiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fields, as: 'fields' property :object_id_prop, as: 'objectId' property :page_properties, as: 'pageProperties', class: Google::Apis::SlidesV1::PageProperties, decorator: Google::Apis::SlidesV1::PageProperties::Representation end end class UpdateParagraphStyleRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cell_location, as: 'cellLocation', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :fields, as: 'fields' property :object_id_prop, as: 'objectId' property :style, as: 'style', class: Google::Apis::SlidesV1::ParagraphStyle, decorator: Google::Apis::SlidesV1::ParagraphStyle::Representation property :text_range, as: 'textRange', class: Google::Apis::SlidesV1::Range, decorator: Google::Apis::SlidesV1::Range::Representation end end class UpdateShapePropertiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fields, as: 'fields' property :object_id_prop, as: 'objectId' property :shape_properties, as: 'shapeProperties', class: Google::Apis::SlidesV1::ShapeProperties, decorator: Google::Apis::SlidesV1::ShapeProperties::Representation end end class UpdateSlidesPositionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :insertion_index, as: 'insertionIndex' collection :slide_object_ids, as: 'slideObjectIds' end end class UpdateTableBorderPropertiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :border_position, as: 'borderPosition' property :fields, as: 'fields' property :object_id_prop, as: 'objectId' property :table_border_properties, as: 'tableBorderProperties', class: Google::Apis::SlidesV1::TableBorderProperties, decorator: Google::Apis::SlidesV1::TableBorderProperties::Representation property :table_range, as: 'tableRange', class: Google::Apis::SlidesV1::TableRange, decorator: Google::Apis::SlidesV1::TableRange::Representation end end class UpdateTableCellPropertiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fields, as: 'fields' property :object_id_prop, as: 'objectId' property :table_cell_properties, as: 'tableCellProperties', class: Google::Apis::SlidesV1::TableCellProperties, decorator: Google::Apis::SlidesV1::TableCellProperties::Representation property :table_range, as: 'tableRange', class: Google::Apis::SlidesV1::TableRange, decorator: Google::Apis::SlidesV1::TableRange::Representation end end class UpdateTableColumnPropertiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :column_indices, as: 'columnIndices' property :fields, as: 'fields' property :object_id_prop, as: 'objectId' property :table_column_properties, as: 'tableColumnProperties', class: Google::Apis::SlidesV1::TableColumnProperties, decorator: Google::Apis::SlidesV1::TableColumnProperties::Representation end end class UpdateTableRowPropertiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fields, as: 'fields' property :object_id_prop, as: 'objectId' collection :row_indices, as: 'rowIndices' property :table_row_properties, as: 'tableRowProperties', class: Google::Apis::SlidesV1::TableRowProperties, decorator: Google::Apis::SlidesV1::TableRowProperties::Representation end end class UpdateTextStyleRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cell_location, as: 'cellLocation', class: Google::Apis::SlidesV1::TableCellLocation, decorator: Google::Apis::SlidesV1::TableCellLocation::Representation property :fields, as: 'fields' property :object_id_prop, as: 'objectId' property :style, as: 'style', class: Google::Apis::SlidesV1::TextStyle, decorator: Google::Apis::SlidesV1::TextStyle::Representation property :text_range, as: 'textRange', class: Google::Apis::SlidesV1::Range, decorator: Google::Apis::SlidesV1::Range::Representation end end class UpdateVideoPropertiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fields, as: 'fields' property :object_id_prop, as: 'objectId' property :video_properties, as: 'videoProperties', class: Google::Apis::SlidesV1::VideoProperties, decorator: Google::Apis::SlidesV1::VideoProperties::Representation end end class Video # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :source, as: 'source' property :url, as: 'url' property :video_properties, as: 'videoProperties', class: Google::Apis::SlidesV1::VideoProperties, decorator: Google::Apis::SlidesV1::VideoProperties::Representation end end class VideoProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :outline, as: 'outline', class: Google::Apis::SlidesV1::Outline, decorator: Google::Apis::SlidesV1::Outline::Representation end end class WeightedFontFamily # @private class Representation < Google::Apis::Core::JsonRepresentation property :font_family, as: 'fontFamily' property :weight, as: 'weight' end end class WordArt # @private class Representation < Google::Apis::Core::JsonRepresentation property :rendered_text, as: 'renderedText' end end class WriteControl # @private class Representation < Google::Apis::Core::JsonRepresentation property :required_revision_id, as: 'requiredRevisionId' end end end end end google-api-client-0.19.8/generated/google/apis/slides_v1/classes.rb0000644000004100000410000063560713252673044025210 0ustar www-datawww-data# 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 SlidesV1 # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # to transform source coordinates (x,y) into destination coordinates (x', y') # according to: # x' x = shear_y scale_y translate_y # 1 [ 1 ] # After transformation, # x' = scale_x * x + shear_x * y + translate_x; # y' = scale_y * y + shear_y * x + translate_y; # This message is therefore composed of these six matrix elements. class AffineTransform include Google::Apis::Core::Hashable # The X coordinate scaling element. # Corresponds to the JSON property `scaleX` # @return [Float] attr_accessor :scale_x # The Y coordinate scaling element. # Corresponds to the JSON property `scaleY` # @return [Float] attr_accessor :scale_y # The X coordinate shearing element. # Corresponds to the JSON property `shearX` # @return [Float] attr_accessor :shear_x # The Y coordinate shearing element. # Corresponds to the JSON property `shearY` # @return [Float] attr_accessor :shear_y # The X coordinate translation element. # Corresponds to the JSON property `translateX` # @return [Float] attr_accessor :translate_x # The Y coordinate translation element. # Corresponds to the JSON property `translateY` # @return [Float] attr_accessor :translate_y # The units for translate elements. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @scale_x = args[:scale_x] if args.key?(:scale_x) @scale_y = args[:scale_y] if args.key?(:scale_y) @shear_x = args[:shear_x] if args.key?(:shear_x) @shear_y = args[:shear_y] if args.key?(:shear_y) @translate_x = args[:translate_x] if args.key?(:translate_x) @translate_y = args[:translate_y] if args.key?(:translate_y) @unit = args[:unit] if args.key?(:unit) end end # A TextElement kind that represents auto text. class AutoText include Google::Apis::Core::Hashable # The rendered content of this auto text, if available. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # Represents the styling that can be applied to a TextRun. # If this text is contained in a shape with a parent placeholder, then these # text styles may be # inherited from the parent. Which text styles are inherited depend on the # nesting level of lists: # * A text run in a paragraph that is not in a list will inherit its text style # from the the newline character in the paragraph at the 0 nesting level of # the list inside the parent placeholder. # * A text run in a paragraph that is in a list will inherit its text style # from the newline character in the paragraph at its corresponding nesting # level of the list inside the parent placeholder. # Inherited text styles are represented as unset fields in this message. If # text is contained in a shape without a parent placeholder, unsetting these # fields will revert the style to a value matching the defaults in the Slides # editor. # Corresponds to the JSON property `style` # @return [Google::Apis::SlidesV1::TextStyle] attr_accessor :style # The type of this auto text. # 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) @content = args[:content] if args.key?(:content) @style = args[:style] if args.key?(:style) @type = args[:type] if args.key?(:type) end end # Request message for PresentationsService.BatchUpdatePresentation. class BatchUpdatePresentationRequest include Google::Apis::Core::Hashable # A list of updates to apply to the presentation. # Corresponds to the JSON property `requests` # @return [Array] attr_accessor :requests # Provides control over how write requests are executed. # Corresponds to the JSON property `writeControl` # @return [Google::Apis::SlidesV1::WriteControl] attr_accessor :write_control def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @requests = args[:requests] if args.key?(:requests) @write_control = args[:write_control] if args.key?(:write_control) end end # Response message from a batch update. class BatchUpdatePresentationResponse include Google::Apis::Core::Hashable # The presentation the updates were applied to. # Corresponds to the JSON property `presentationId` # @return [String] attr_accessor :presentation_id # The reply of the updates. This maps 1:1 with the updates, although # replies to some requests may be empty. # Corresponds to the JSON property `replies` # @return [Array] attr_accessor :replies # Provides control over how write requests are executed. # Corresponds to the JSON property `writeControl` # @return [Google::Apis::SlidesV1::WriteControl] attr_accessor :write_control def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @presentation_id = args[:presentation_id] if args.key?(:presentation_id) @replies = args[:replies] if args.key?(:replies) @write_control = args[:write_control] if args.key?(:write_control) end end # Describes the bullet of a paragraph. class Bullet include Google::Apis::Core::Hashable # Represents the styling that can be applied to a TextRun. # If this text is contained in a shape with a parent placeholder, then these # text styles may be # inherited from the parent. Which text styles are inherited depend on the # nesting level of lists: # * A text run in a paragraph that is not in a list will inherit its text style # from the the newline character in the paragraph at the 0 nesting level of # the list inside the parent placeholder. # * A text run in a paragraph that is in a list will inherit its text style # from the newline character in the paragraph at its corresponding nesting # level of the list inside the parent placeholder. # Inherited text styles are represented as unset fields in this message. If # text is contained in a shape without a parent placeholder, unsetting these # fields will revert the style to a value matching the defaults in the Slides # editor. # Corresponds to the JSON property `bulletStyle` # @return [Google::Apis::SlidesV1::TextStyle] attr_accessor :bullet_style # The rendered bullet glyph for this paragraph. # Corresponds to the JSON property `glyph` # @return [String] attr_accessor :glyph # The ID of the list this paragraph belongs to. # Corresponds to the JSON property `listId` # @return [String] attr_accessor :list_id # The nesting level of this paragraph in the list. # Corresponds to the JSON property `nestingLevel` # @return [Fixnum] attr_accessor :nesting_level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bullet_style = args[:bullet_style] if args.key?(:bullet_style) @glyph = args[:glyph] if args.key?(:glyph) @list_id = args[:list_id] if args.key?(:list_id) @nesting_level = args[:nesting_level] if args.key?(:nesting_level) end end # The palette of predefined colors for a page. class ColorScheme include Google::Apis::Core::Hashable # The ThemeColorType and corresponding concrete color pairs. # Corresponds to the JSON property `colors` # @return [Array] attr_accessor :colors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @colors = args[:colors] if args.key?(:colors) end end # A color and position in a gradient band. class ColorStop include Google::Apis::Core::Hashable # The alpha value of this color in the gradient band. Defaults to 1.0, # fully opaque. # Corresponds to the JSON property `alpha` # @return [Float] attr_accessor :alpha # A themeable solid color value. # Corresponds to the JSON property `color` # @return [Google::Apis::SlidesV1::OpaqueColor] attr_accessor :color # The relative position of the color stop in the gradient band measured # in percentage. The value should be in the interval [0.0, 1.0]. # Corresponds to the JSON property `position` # @return [Float] attr_accessor :position def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alpha = args[:alpha] if args.key?(:alpha) @color = args[:color] if args.key?(:color) @position = args[:position] if args.key?(:position) end end # Creates an image. class CreateImageRequest include Google::Apis::Core::Hashable # Common properties for a page element. # Note: When you initially create a # PageElement, the API may modify # the values of both `size` and `transform`, but the # visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties # A user-supplied object ID. # If you specify an ID, it must be unique among all pages and page elements # in the presentation. The ID must start with an alphanumeric character or an # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters # may include those as well as a hyphen or colon (matches regex # `[a-zA-Z0-9_-:]`). # The length of the ID must not be less than 5 or greater than 50. # If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The image URL. # The image is fetched once at insertion time and a copy is stored for # display inside the presentation. Images must be less than 50MB in size, # cannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF # format. # The provided URL can be at most 2 kB in length. # 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) @element_properties = args[:element_properties] if args.key?(:element_properties) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @url = args[:url] if args.key?(:url) end end # The result of creating an image. class CreateImageResponse include Google::Apis::Core::Hashable # The object ID of the created image. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # Creates a line. class CreateLineRequest include Google::Apis::Core::Hashable # Common properties for a page element. # Note: When you initially create a # PageElement, the API may modify # the values of both `size` and `transform`, but the # visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties # The category of line to be created. # Corresponds to the JSON property `lineCategory` # @return [String] attr_accessor :line_category # A user-supplied object ID. # If you specify an ID, it must be unique among all pages and page elements # in the presentation. The ID must start with an alphanumeric character or an # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters # may include those as well as a hyphen or colon (matches regex # `[a-zA-Z0-9_-:]`). # The length of the ID must not be less than 5 or greater than 50. # If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @element_properties = args[:element_properties] if args.key?(:element_properties) @line_category = args[:line_category] if args.key?(:line_category) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # The result of creating a line. class CreateLineResponse include Google::Apis::Core::Hashable # The object ID of the created line. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # Creates bullets for all of the paragraphs that overlap with the given # text index range. # The nesting level of each paragraph will be determined by counting leading # tabs in front of each paragraph. To avoid excess space between the bullet and # the corresponding paragraph, these leading tabs are removed by this request. # This may change the indices of parts of the text. # If the paragraph immediately before paragraphs being updated is in a list # with a matching preset, the paragraphs being updated are added to that # preceding list. class CreateParagraphBulletsRequest include Google::Apis::Core::Hashable # The kinds of bullet glyphs to be used. Defaults to the # `BULLET_DISC_CIRCLE_SQUARE` preset. # Corresponds to the JSON property `bulletPreset` # @return [String] attr_accessor :bullet_preset # A location of a single table cell within a table. # Corresponds to the JSON property `cellLocation` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location # The object ID of the shape or table containing the text to add bullets to. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # Specifies a contiguous range of an indexed collection, such as characters in # text. # Corresponds to the JSON property `textRange` # @return [Google::Apis::SlidesV1::Range] attr_accessor :text_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bullet_preset = args[:bullet_preset] if args.key?(:bullet_preset) @cell_location = args[:cell_location] if args.key?(:cell_location) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @text_range = args[:text_range] if args.key?(:text_range) end end # Creates a new shape. class CreateShapeRequest include Google::Apis::Core::Hashable # Common properties for a page element. # Note: When you initially create a # PageElement, the API may modify # the values of both `size` and `transform`, but the # visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties # A user-supplied object ID. # If you specify an ID, it must be unique among all pages and page elements # in the presentation. The ID must start with an alphanumeric character or an # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters # may include those as well as a hyphen or colon (matches regex # `[a-zA-Z0-9_-:]`). # The length of the ID must not be less than 5 or greater than 50. # If empty, a unique identifier will be generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The shape type. # Corresponds to the JSON property `shapeType` # @return [String] attr_accessor :shape_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @element_properties = args[:element_properties] if args.key?(:element_properties) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @shape_type = args[:shape_type] if args.key?(:shape_type) end end # The result of creating a shape. class CreateShapeResponse include Google::Apis::Core::Hashable # The object ID of the created shape. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # Creates an embedded Google Sheets chart. # NOTE: Chart creation requires at least one of the spreadsheets.readonly, # spreadsheets, drive.readonly, or drive OAuth scopes. class CreateSheetsChartRequest include Google::Apis::Core::Hashable # The ID of the specific chart in the Google Sheets spreadsheet. # Corresponds to the JSON property `chartId` # @return [Fixnum] attr_accessor :chart_id # Common properties for a page element. # Note: When you initially create a # PageElement, the API may modify # the values of both `size` and `transform`, but the # visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties # The mode with which the chart is linked to the source spreadsheet. When # not specified, the chart will be an image that is not linked. # Corresponds to the JSON property `linkingMode` # @return [String] attr_accessor :linking_mode # A user-supplied object ID. # If specified, the ID must be unique among all pages and page elements in # the presentation. The ID should start with a word character [a-zA-Z0-9_] # and then followed by any number of the following characters [a-zA-Z0-9_-:]. # The length of the ID should not be less than 5 or greater than 50. # If empty, a unique identifier will be generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The ID of the Google Sheets spreadsheet that contains the chart. # Corresponds to the JSON property `spreadsheetId` # @return [String] attr_accessor :spreadsheet_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @chart_id = args[:chart_id] if args.key?(:chart_id) @element_properties = args[:element_properties] if args.key?(:element_properties) @linking_mode = args[:linking_mode] if args.key?(:linking_mode) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) end end # The result of creating an embedded Google Sheets chart. class CreateSheetsChartResponse include Google::Apis::Core::Hashable # The object ID of the created chart. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # Creates a new slide. class CreateSlideRequest include Google::Apis::Core::Hashable # The optional zero-based index indicating where to insert the slides. # If you don't specify an index, the new slide is created at the end. # Corresponds to the JSON property `insertionIndex` # @return [Fixnum] attr_accessor :insertion_index # A user-supplied object ID. # If you specify an ID, it must be unique among all pages and page elements # in the presentation. The ID must start with an alphanumeric character or an # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters # may include those as well as a hyphen or colon (matches regex # `[a-zA-Z0-9_-:]`). # The length of the ID must not be less than 5 or greater than 50. # If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # An optional list of object ID mappings from the placeholder(s) on the layout # to the placeholder(s) # that will be created on the new slide from that specified layout. Can only # be used when `slide_layout_reference` is specified. # Corresponds to the JSON property `placeholderIdMappings` # @return [Array] attr_accessor :placeholder_id_mappings # Slide layout reference. This may reference either: # - A predefined layout # - One of the layouts in the presentation. # Corresponds to the JSON property `slideLayoutReference` # @return [Google::Apis::SlidesV1::LayoutReference] attr_accessor :slide_layout_reference def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @insertion_index = args[:insertion_index] if args.key?(:insertion_index) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @placeholder_id_mappings = args[:placeholder_id_mappings] if args.key?(:placeholder_id_mappings) @slide_layout_reference = args[:slide_layout_reference] if args.key?(:slide_layout_reference) end end # The result of creating a slide. class CreateSlideResponse include Google::Apis::Core::Hashable # The object ID of the created slide. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # Creates a new table. class CreateTableRequest include Google::Apis::Core::Hashable # Number of columns in the table. # Corresponds to the JSON property `columns` # @return [Fixnum] attr_accessor :columns # Common properties for a page element. # Note: When you initially create a # PageElement, the API may modify # the values of both `size` and `transform`, but the # visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties # A user-supplied object ID. # If you specify an ID, it must be unique among all pages and page elements # in the presentation. The ID must start with an alphanumeric character or an # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters # may include those as well as a hyphen or colon (matches regex # `[a-zA-Z0-9_-:]`). # The length of the ID must not be less than 5 or greater than 50. # If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # Number of rows in the table. # Corresponds to the JSON property `rows` # @return [Fixnum] attr_accessor :rows def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @columns = args[:columns] if args.key?(:columns) @element_properties = args[:element_properties] if args.key?(:element_properties) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @rows = args[:rows] if args.key?(:rows) end end # The result of creating a table. class CreateTableResponse include Google::Apis::Core::Hashable # The object ID of the created table. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # Creates a video. class CreateVideoRequest include Google::Apis::Core::Hashable # Common properties for a page element. # Note: When you initially create a # PageElement, the API may modify # the values of both `size` and `transform`, but the # visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties # The video source's unique identifier for this video. # e.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0, # the ID is 7U3axjORYZ0. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A user-supplied object ID. # If you specify an ID, it must be unique among all pages and page elements # in the presentation. The ID must start with an alphanumeric character or an # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters # may include those as well as a hyphen or colon (matches regex # `[a-zA-Z0-9_-:]`). # The length of the ID must not be less than 5 or greater than 50. # If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The video source. # 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) @element_properties = args[:element_properties] if args.key?(:element_properties) @id = args[:id] if args.key?(:id) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @source = args[:source] if args.key?(:source) end end # The result of creating a video. class CreateVideoResponse include Google::Apis::Core::Hashable # The object ID of the created video. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # The crop properties of an object enclosed in a container. For example, an # Image. # The crop properties is represented by the offsets of four edges which define # a crop rectangle. The offsets are measured in percentage from the # corresponding edges of the object's original bounding rectangle towards # inside, relative to the object's original dimensions. # - If the offset is in the interval (0, 1), the corresponding edge of crop # rectangle is positioned inside of the object's original bounding rectangle. # - If the offset is negative or greater than 1, the corresponding edge of crop # rectangle is positioned outside of the object's original bounding rectangle. # - If the left edge of the crop rectangle is on the right side of its right # edge, the object will be flipped horizontally. # - If the top edge of the crop rectangle is below its bottom edge, the object # will be flipped vertically. # - If all offsets and rotation angle is 0, the object is not cropped. # After cropping, the content in the crop rectangle will be stretched to fit # its container. class CropProperties include Google::Apis::Core::Hashable # The rotation angle of the crop window around its center, in radians. # Rotation angle is applied after the offset. # Corresponds to the JSON property `angle` # @return [Float] attr_accessor :angle # The offset specifies the bottom edge of the crop rectangle that is located # above the original bounding rectangle bottom edge, relative to the object's # original height. # Corresponds to the JSON property `bottomOffset` # @return [Float] attr_accessor :bottom_offset # The offset specifies the left edge of the crop rectangle that is located to # the right of the original bounding rectangle left edge, relative to the # object's original width. # Corresponds to the JSON property `leftOffset` # @return [Float] attr_accessor :left_offset # The offset specifies the right edge of the crop rectangle that is located # to the left of the original bounding rectangle right edge, relative to the # object's original width. # Corresponds to the JSON property `rightOffset` # @return [Float] attr_accessor :right_offset # The offset specifies the top edge of the crop rectangle that is located # below the original bounding rectangle top edge, relative to the object's # original height. # Corresponds to the JSON property `topOffset` # @return [Float] attr_accessor :top_offset def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @angle = args[:angle] if args.key?(:angle) @bottom_offset = args[:bottom_offset] if args.key?(:bottom_offset) @left_offset = args[:left_offset] if args.key?(:left_offset) @right_offset = args[:right_offset] if args.key?(:right_offset) @top_offset = args[:top_offset] if args.key?(:top_offset) end end # Deletes an object, either pages or # page elements, from the # presentation. class DeleteObjectRequest include Google::Apis::Core::Hashable # The object ID of the page or page element to delete. # If after a delete operation a group contains # only 1 or no page elements, the group is also deleted. # If a placeholder is deleted on a layout, any empty inheriting shapes are # also deleted. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # Deletes bullets from all of the paragraphs that overlap with the given text # index range. # The nesting level of each paragraph will be visually preserved by adding # indent to the start of the corresponding paragraph. class DeleteParagraphBulletsRequest include Google::Apis::Core::Hashable # A location of a single table cell within a table. # Corresponds to the JSON property `cellLocation` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location # The object ID of the shape or table containing the text to delete bullets # from. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # Specifies a contiguous range of an indexed collection, such as characters in # text. # Corresponds to the JSON property `textRange` # @return [Google::Apis::SlidesV1::Range] attr_accessor :text_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cell_location = args[:cell_location] if args.key?(:cell_location) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @text_range = args[:text_range] if args.key?(:text_range) end end # Deletes a column from a table. class DeleteTableColumnRequest include Google::Apis::Core::Hashable # A location of a single table cell within a table. # Corresponds to the JSON property `cellLocation` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location # The table to delete columns from. # Corresponds to the JSON property `tableObjectId` # @return [String] attr_accessor :table_object_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cell_location = args[:cell_location] if args.key?(:cell_location) @table_object_id = args[:table_object_id] if args.key?(:table_object_id) end end # Deletes a row from a table. class DeleteTableRowRequest include Google::Apis::Core::Hashable # A location of a single table cell within a table. # Corresponds to the JSON property `cellLocation` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location # The table to delete rows from. # Corresponds to the JSON property `tableObjectId` # @return [String] attr_accessor :table_object_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cell_location = args[:cell_location] if args.key?(:cell_location) @table_object_id = args[:table_object_id] if args.key?(:table_object_id) end end # Deletes text from a shape or a table cell. class DeleteTextRequest include Google::Apis::Core::Hashable # A location of a single table cell within a table. # Corresponds to the JSON property `cellLocation` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location # The object ID of the shape or table from which the text will be deleted. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # Specifies a contiguous range of an indexed collection, such as characters in # text. # Corresponds to the JSON property `textRange` # @return [Google::Apis::SlidesV1::Range] attr_accessor :text_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cell_location = args[:cell_location] if args.key?(:cell_location) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @text_range = args[:text_range] if args.key?(:text_range) end end # A magnitude in a single direction in the specified units. class Dimension include Google::Apis::Core::Hashable # The magnitude. # Corresponds to the JSON property `magnitude` # @return [Float] attr_accessor :magnitude # The units for magnitude. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @magnitude = args[:magnitude] if args.key?(:magnitude) @unit = args[:unit] if args.key?(:unit) end end # Duplicates a slide or page element. # When duplicating a slide, the duplicate slide will be created immediately # following the specified slide. When duplicating a page element, the duplicate # will be placed on the same page at the same position as the original. class DuplicateObjectRequest include Google::Apis::Core::Hashable # The ID of the object to duplicate. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The object being duplicated may contain other objects, for example when # duplicating a slide or a group page element. This map defines how the IDs # of duplicated objects are generated: the keys are the IDs of the original # objects and its values are the IDs that will be assigned to the # corresponding duplicate object. The ID of the source object's duplicate # may be specified in this map as well, using the same value of the # `object_id` field as a key and the newly desired ID as the value. # All keys must correspond to existing IDs in the presentation. All values # must be unique in the presentation and must start with an alphanumeric # character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining # characters may include those as well as a hyphen or colon (matches regex # `[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or # greater than 50. # If any IDs of source objects are omitted from the map, a new random ID will # be assigned. If the map is empty or unset, all duplicate objects will # receive a new random ID. # Corresponds to the JSON property `objectIds` # @return [Hash] attr_accessor :object_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @object_ids = args[:object_ids] if args.key?(:object_ids) end end # The response of duplicating an object. class DuplicateObjectResponse include Google::Apis::Core::Hashable # The ID of the new duplicate object. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # A PageElement kind representing a # joined collection of PageElements. class Group include Google::Apis::Core::Hashable # The collection of elements in the group. The minimum size of a group is 2. # Corresponds to the JSON property `children` # @return [Array] attr_accessor :children def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @children = args[:children] if args.key?(:children) end end # Groups objects to create an object group. For example, groups PageElements to # create a Group on the same page as all the children. class GroupObjectsRequest include Google::Apis::Core::Hashable # The object IDs of the objects to group. # Only page elements can be grouped. There should be at least two page # elements on the same page that are not already in another group. Some page # elements, such as videos, tables and placeholder shapes cannot be grouped. # Corresponds to the JSON property `childrenObjectIds` # @return [Array] attr_accessor :children_object_ids # A user-supplied object ID for the group to be created. # If you specify an ID, it must be unique among all pages and page elements # in the presentation. The ID must start with an alphanumeric character or an # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters # may include those as well as a hyphen or colon (matches regex # `[a-zA-Z0-9_-:]`). # The length of the ID must not be less than 5 or greater than 50. # If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `groupObjectId` # @return [String] attr_accessor :group_object_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @children_object_ids = args[:children_object_ids] if args.key?(:children_object_ids) @group_object_id = args[:group_object_id] if args.key?(:group_object_id) end end # The result of grouping objects. class GroupObjectsResponse include Google::Apis::Core::Hashable # The object ID of the created group. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # A PageElement kind representing an # image. class Image include Google::Apis::Core::Hashable # An URL to an image with a default lifetime of 30 minutes. # This URL is tagged with the account of the requester. Anyone with the URL # effectively accesses the image as the original requester. Access to the # image may be lost if the presentation's sharing settings change. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url # The properties of the Image. # Corresponds to the JSON property `imageProperties` # @return [Google::Apis::SlidesV1::ImageProperties] attr_accessor :image_properties # The source URL is the URL used to insert the image. The source URL can be # empty. # Corresponds to the JSON property `sourceUrl` # @return [String] attr_accessor :source_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_url = args[:content_url] if args.key?(:content_url) @image_properties = args[:image_properties] if args.key?(:image_properties) @source_url = args[:source_url] if args.key?(:source_url) end end # The properties of the Image. class ImageProperties include Google::Apis::Core::Hashable # The brightness effect of the image. The value should be in the interval # [-1.0, 1.0], where 0 means no effect. This property is read-only. # Corresponds to the JSON property `brightness` # @return [Float] attr_accessor :brightness # The contrast effect of the image. The value should be in the interval # [-1.0, 1.0], where 0 means no effect. This property is read-only. # Corresponds to the JSON property `contrast` # @return [Float] attr_accessor :contrast # The crop properties of an object enclosed in a container. For example, an # Image. # The crop properties is represented by the offsets of four edges which define # a crop rectangle. The offsets are measured in percentage from the # corresponding edges of the object's original bounding rectangle towards # inside, relative to the object's original dimensions. # - If the offset is in the interval (0, 1), the corresponding edge of crop # rectangle is positioned inside of the object's original bounding rectangle. # - If the offset is negative or greater than 1, the corresponding edge of crop # rectangle is positioned outside of the object's original bounding rectangle. # - If the left edge of the crop rectangle is on the right side of its right # edge, the object will be flipped horizontally. # - If the top edge of the crop rectangle is below its bottom edge, the object # will be flipped vertically. # - If all offsets and rotation angle is 0, the object is not cropped. # After cropping, the content in the crop rectangle will be stretched to fit # its container. # Corresponds to the JSON property `cropProperties` # @return [Google::Apis::SlidesV1::CropProperties] attr_accessor :crop_properties # A hypertext link. # Corresponds to the JSON property `link` # @return [Google::Apis::SlidesV1::Link] attr_accessor :link # The outline of a PageElement. # If these fields are unset, they may be inherited from a parent placeholder # if it exists. If there is no parent, the fields will default to the value # used for new page elements created in the Slides editor, which may depend on # the page element kind. # Corresponds to the JSON property `outline` # @return [Google::Apis::SlidesV1::Outline] attr_accessor :outline # A recolor effect applied on an image. # Corresponds to the JSON property `recolor` # @return [Google::Apis::SlidesV1::Recolor] attr_accessor :recolor # The shadow properties of a page element. # If these fields are unset, they may be inherited from a parent placeholder # if it exists. If there is no parent, the fields will default to the value # used for new page elements created in the Slides editor, which may depend on # the page element kind. # Corresponds to the JSON property `shadow` # @return [Google::Apis::SlidesV1::Shadow] attr_accessor :shadow # The transparency effect of the image. The value should be in the interval # [0.0, 1.0], where 0 means no effect and 1 means completely transparent. # This property is read-only. # Corresponds to the JSON property `transparency` # @return [Float] attr_accessor :transparency def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @brightness = args[:brightness] if args.key?(:brightness) @contrast = args[:contrast] if args.key?(:contrast) @crop_properties = args[:crop_properties] if args.key?(:crop_properties) @link = args[:link] if args.key?(:link) @outline = args[:outline] if args.key?(:outline) @recolor = args[:recolor] if args.key?(:recolor) @shadow = args[:shadow] if args.key?(:shadow) @transparency = args[:transparency] if args.key?(:transparency) end end # Inserts columns into a table. # Other columns in the table will be resized to fit the new column. class InsertTableColumnsRequest include Google::Apis::Core::Hashable # A location of a single table cell within a table. # Corresponds to the JSON property `cellLocation` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location # Whether to insert new columns to the right of the reference cell location. # - `True`: insert to the right. # - `False`: insert to the left. # Corresponds to the JSON property `insertRight` # @return [Boolean] attr_accessor :insert_right alias_method :insert_right?, :insert_right # The number of columns to be inserted. Maximum 20 per request. # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number # The table to insert columns into. # Corresponds to the JSON property `tableObjectId` # @return [String] attr_accessor :table_object_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cell_location = args[:cell_location] if args.key?(:cell_location) @insert_right = args[:insert_right] if args.key?(:insert_right) @number = args[:number] if args.key?(:number) @table_object_id = args[:table_object_id] if args.key?(:table_object_id) end end # Inserts rows into a table. class InsertTableRowsRequest include Google::Apis::Core::Hashable # A location of a single table cell within a table. # Corresponds to the JSON property `cellLocation` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location # Whether to insert new rows below the reference cell location. # - `True`: insert below the cell. # - `False`: insert above the cell. # Corresponds to the JSON property `insertBelow` # @return [Boolean] attr_accessor :insert_below alias_method :insert_below?, :insert_below # The number of rows to be inserted. Maximum 20 per request. # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number # The table to insert rows into. # Corresponds to the JSON property `tableObjectId` # @return [String] attr_accessor :table_object_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cell_location = args[:cell_location] if args.key?(:cell_location) @insert_below = args[:insert_below] if args.key?(:insert_below) @number = args[:number] if args.key?(:number) @table_object_id = args[:table_object_id] if args.key?(:table_object_id) end end # Inserts text into a shape or a table cell. class InsertTextRequest include Google::Apis::Core::Hashable # A location of a single table cell within a table. # Corresponds to the JSON property `cellLocation` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location # The index where the text will be inserted, in Unicode code units, based # on TextElement indexes. # The index is zero-based and is computed from the start of the string. # The index may be adjusted to prevent insertions inside Unicode grapheme # clusters. In these cases, the text will be inserted immediately after the # grapheme cluster. # Corresponds to the JSON property `insertionIndex` # @return [Fixnum] attr_accessor :insertion_index # The object ID of the shape or table where the text will be inserted. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The text to be inserted. # Inserting a newline character will implicitly create a new # ParagraphMarker at that index. # The paragraph style of the new paragraph will be copied from the paragraph # at the current insertion index, including lists and bullets. # Text styles for inserted text will be determined automatically, generally # preserving the styling of neighboring text. In most cases, the text will be # added to the TextRun that exists at the # insertion index. # Some control characters (U+0000-U+0008, U+000C-U+001F) and characters # from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) # will be stripped out of the inserted text. # 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) @cell_location = args[:cell_location] if args.key?(:cell_location) @insertion_index = args[:insertion_index] if args.key?(:insertion_index) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @text = args[:text] if args.key?(:text) end end # The user-specified ID mapping for a placeholder that will be created on a # slide from a specified layout. class LayoutPlaceholderIdMapping include Google::Apis::Core::Hashable # The placeholder information that uniquely identifies a placeholder shape. # Corresponds to the JSON property `layoutPlaceholder` # @return [Google::Apis::SlidesV1::Placeholder] attr_accessor :layout_placeholder # The object ID of the placeholder on a layout that will be applied # to a slide. # Corresponds to the JSON property `layoutPlaceholderObjectId` # @return [String] attr_accessor :layout_placeholder_object_id # A user-supplied object ID for the placeholder identified above that to be # created onto a slide. # If you specify an ID, it must be unique among all pages and page elements # in the presentation. The ID must start with an alphanumeric character or an # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters # may include those as well as a hyphen or colon (matches regex # `[a-zA-Z0-9_-:]`). # The length of the ID must not be less than 5 or greater than 50. # If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @layout_placeholder = args[:layout_placeholder] if args.key?(:layout_placeholder) @layout_placeholder_object_id = args[:layout_placeholder_object_id] if args.key?(:layout_placeholder_object_id) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # The properties of Page are only # relevant for pages with page_type LAYOUT. class LayoutProperties include Google::Apis::Core::Hashable # The human-readable name of the layout. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The object ID of the master that this layout is based on. # Corresponds to the JSON property `masterObjectId` # @return [String] attr_accessor :master_object_id # The name of the layout. # 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) @master_object_id = args[:master_object_id] if args.key?(:master_object_id) @name = args[:name] if args.key?(:name) end end # Slide layout reference. This may reference either: # - A predefined layout # - One of the layouts in the presentation. class LayoutReference include Google::Apis::Core::Hashable # Layout ID: the object ID of one of the layouts in the presentation. # Corresponds to the JSON property `layoutId` # @return [String] attr_accessor :layout_id # Predefined layout. # Corresponds to the JSON property `predefinedLayout` # @return [String] attr_accessor :predefined_layout def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @layout_id = args[:layout_id] if args.key?(:layout_id) @predefined_layout = args[:predefined_layout] if args.key?(:predefined_layout) end end # A PageElement kind representing a # line, curved connector, or bent connector. class Line include Google::Apis::Core::Hashable # The properties of the Line. # When unset, these fields default to values that match the appearance of # new lines created in the Slides editor. # Corresponds to the JSON property `lineProperties` # @return [Google::Apis::SlidesV1::LineProperties] attr_accessor :line_properties # The type of the line. # Corresponds to the JSON property `lineType` # @return [String] attr_accessor :line_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @line_properties = args[:line_properties] if args.key?(:line_properties) @line_type = args[:line_type] if args.key?(:line_type) end end # The fill of the line. class LineFill include Google::Apis::Core::Hashable # A solid color fill. The page or page element is filled entirely with the # specified color value. # If any field is unset, its value may be inherited from a parent placeholder # if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @solid_fill = args[:solid_fill] if args.key?(:solid_fill) end end # The properties of the Line. # When unset, these fields default to values that match the appearance of # new lines created in the Slides editor. class LineProperties include Google::Apis::Core::Hashable # The dash style of the line. # Corresponds to the JSON property `dashStyle` # @return [String] attr_accessor :dash_style # The style of the arrow at the end of the line. # Corresponds to the JSON property `endArrow` # @return [String] attr_accessor :end_arrow # The fill of the line. # Corresponds to the JSON property `lineFill` # @return [Google::Apis::SlidesV1::LineFill] attr_accessor :line_fill # A hypertext link. # Corresponds to the JSON property `link` # @return [Google::Apis::SlidesV1::Link] attr_accessor :link # The style of the arrow at the beginning of the line. # Corresponds to the JSON property `startArrow` # @return [String] attr_accessor :start_arrow # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `weight` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :weight def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dash_style = args[:dash_style] if args.key?(:dash_style) @end_arrow = args[:end_arrow] if args.key?(:end_arrow) @line_fill = args[:line_fill] if args.key?(:line_fill) @link = args[:link] if args.key?(:link) @start_arrow = args[:start_arrow] if args.key?(:start_arrow) @weight = args[:weight] if args.key?(:weight) end end # A hypertext link. class Link include Google::Apis::Core::Hashable # If set, indicates this is a link to the specific page in this # presentation with this ID. A page with this ID may not exist. # Corresponds to the JSON property `pageObjectId` # @return [String] attr_accessor :page_object_id # If set, indicates this is a link to a slide in this presentation, # addressed by its position. # Corresponds to the JSON property `relativeLink` # @return [String] attr_accessor :relative_link # If set, indicates this is a link to the slide at this zero-based index # in the presentation. There may not be a slide at this index. # Corresponds to the JSON property `slideIndex` # @return [Fixnum] attr_accessor :slide_index # If set, indicates this is a link to the external web page at this URL. # 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) @page_object_id = args[:page_object_id] if args.key?(:page_object_id) @relative_link = args[:relative_link] if args.key?(:relative_link) @slide_index = args[:slide_index] if args.key?(:slide_index) @url = args[:url] if args.key?(:url) end end # A List describes the look and feel of bullets belonging to paragraphs # associated with a list. A paragraph that is part of a list has an implicit # reference to that list's ID. class List include Google::Apis::Core::Hashable # The ID of the list. # Corresponds to the JSON property `listId` # @return [String] attr_accessor :list_id # A map of nesting levels to the properties of bullets at the associated # level. A list has at most nine levels of nesting, so the possible values # for the keys of this map are 0 through 8, inclusive. # Corresponds to the JSON property `nestingLevel` # @return [Hash] attr_accessor :nesting_level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @list_id = args[:list_id] if args.key?(:list_id) @nesting_level = args[:nesting_level] if args.key?(:nesting_level) end end # The properties of Page that are only # relevant for pages with page_type MASTER. class MasterProperties include Google::Apis::Core::Hashable # The human-readable name of the master. # 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 # Merges cells in a Table. class MergeTableCellsRequest include Google::Apis::Core::Hashable # The object ID of the table. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # A table range represents a reference to a subset of a table. # It's important to note that the cells specified by a table range do not # necessarily form a rectangle. For example, let's say we have a 3 x 3 table # where all the cells of the last row are merged together. The table looks # like this: # # [ ] # A table range with location = (0, 0), row span = 3 and column span = 2 # specifies the following cells: # x x # [ x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::SlidesV1::TableRange] attr_accessor :table_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @table_range = args[:table_range] if args.key?(:table_range) end end # Contains properties describing the look and feel of a list bullet at a given # level of nesting. class NestingLevel include Google::Apis::Core::Hashable # Represents the styling that can be applied to a TextRun. # If this text is contained in a shape with a parent placeholder, then these # text styles may be # inherited from the parent. Which text styles are inherited depend on the # nesting level of lists: # * A text run in a paragraph that is not in a list will inherit its text style # from the the newline character in the paragraph at the 0 nesting level of # the list inside the parent placeholder. # * A text run in a paragraph that is in a list will inherit its text style # from the newline character in the paragraph at its corresponding nesting # level of the list inside the parent placeholder. # Inherited text styles are represented as unset fields in this message. If # text is contained in a shape without a parent placeholder, unsetting these # fields will revert the style to a value matching the defaults in the Slides # editor. # Corresponds to the JSON property `bulletStyle` # @return [Google::Apis::SlidesV1::TextStyle] attr_accessor :bullet_style def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bullet_style = args[:bullet_style] if args.key?(:bullet_style) end end # The properties of Page that are only # relevant for pages with page_type NOTES. class NotesProperties include Google::Apis::Core::Hashable # The object ID of the shape on this notes page that contains the speaker # notes for the corresponding slide. # The actual shape may not always exist on the notes page. Inserting text # using this object ID will automatically create the shape. In this case, the # actual shape may have different object ID. The `GetPresentation` or # `GetPage` action will always return the latest object ID. # Corresponds to the JSON property `speakerNotesObjectId` # @return [String] attr_accessor :speaker_notes_object_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @speaker_notes_object_id = args[:speaker_notes_object_id] if args.key?(:speaker_notes_object_id) end end # A themeable solid color value. class OpaqueColor include Google::Apis::Core::Hashable # An RGB color. # Corresponds to the JSON property `rgbColor` # @return [Google::Apis::SlidesV1::RgbColor] attr_accessor :rgb_color # An opaque theme color. # Corresponds to the JSON property `themeColor` # @return [String] attr_accessor :theme_color def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @rgb_color = args[:rgb_color] if args.key?(:rgb_color) @theme_color = args[:theme_color] if args.key?(:theme_color) end end # A color that can either be fully opaque or fully transparent. class OptionalColor include Google::Apis::Core::Hashable # A themeable solid color value. # Corresponds to the JSON property `opaqueColor` # @return [Google::Apis::SlidesV1::OpaqueColor] attr_accessor :opaque_color def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @opaque_color = args[:opaque_color] if args.key?(:opaque_color) end end # The outline of a PageElement. # If these fields are unset, they may be inherited from a parent placeholder # if it exists. If there is no parent, the fields will default to the value # used for new page elements created in the Slides editor, which may depend on # the page element kind. class Outline include Google::Apis::Core::Hashable # The dash style of the outline. # Corresponds to the JSON property `dashStyle` # @return [String] attr_accessor :dash_style # The fill of the outline. # Corresponds to the JSON property `outlineFill` # @return [Google::Apis::SlidesV1::OutlineFill] attr_accessor :outline_fill # The outline property state. # Updating the outline on a page element will implicitly update this field # to `RENDERED`, unless another value is specified in the same request. To # have no outline on a page element, set this field to `NOT_RENDERED`. In # this case, any other outline fields set in the same request will be # ignored. # Corresponds to the JSON property `propertyState` # @return [String] attr_accessor :property_state # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `weight` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :weight def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dash_style = args[:dash_style] if args.key?(:dash_style) @outline_fill = args[:outline_fill] if args.key?(:outline_fill) @property_state = args[:property_state] if args.key?(:property_state) @weight = args[:weight] if args.key?(:weight) end end # The fill of the outline. class OutlineFill include Google::Apis::Core::Hashable # A solid color fill. The page or page element is filled entirely with the # specified color value. # If any field is unset, its value may be inherited from a parent placeholder # if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @solid_fill = args[:solid_fill] if args.key?(:solid_fill) end end # A page in a presentation. class Page include Google::Apis::Core::Hashable # The properties of Page are only # relevant for pages with page_type LAYOUT. # Corresponds to the JSON property `layoutProperties` # @return [Google::Apis::SlidesV1::LayoutProperties] attr_accessor :layout_properties # The properties of Page that are only # relevant for pages with page_type MASTER. # Corresponds to the JSON property `masterProperties` # @return [Google::Apis::SlidesV1::MasterProperties] attr_accessor :master_properties # The properties of Page that are only # relevant for pages with page_type NOTES. # Corresponds to the JSON property `notesProperties` # @return [Google::Apis::SlidesV1::NotesProperties] attr_accessor :notes_properties # The object ID for this page. Object IDs used by # Page and # PageElement share the same namespace. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The page elements rendered on the page. # Corresponds to the JSON property `pageElements` # @return [Array] attr_accessor :page_elements # The properties of the Page. # The page will inherit properties from the parent page. Depending on the page # type the hierarchy is defined in either # SlideProperties or # LayoutProperties. # Corresponds to the JSON property `pageProperties` # @return [Google::Apis::SlidesV1::PageProperties] attr_accessor :page_properties # The type of the page. # Corresponds to the JSON property `pageType` # @return [String] attr_accessor :page_type # The revision ID of the presentation containing this page. Can be used in # update requests to assert that the presentation revision hasn't changed # since the last read operation. Only populated if the user has edit access # to the presentation. # The format of the revision ID may change over time, so it should be treated # opaquely. A returned revision ID is only guaranteed to be valid for 24 # hours after it has been returned and cannot be shared across users. If the # revision ID is unchanged between calls, then the presentation has not # changed. Conversely, a changed ID (for the same presentation and user) # usually means the presentation has been updated; however, a changed ID can # also be due to internal factors such as ID format changes. # Corresponds to the JSON property `revisionId` # @return [String] attr_accessor :revision_id # The properties of Page that are only # relevant for pages with page_type SLIDE. # Corresponds to the JSON property `slideProperties` # @return [Google::Apis::SlidesV1::SlideProperties] attr_accessor :slide_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @layout_properties = args[:layout_properties] if args.key?(:layout_properties) @master_properties = args[:master_properties] if args.key?(:master_properties) @notes_properties = args[:notes_properties] if args.key?(:notes_properties) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @page_elements = args[:page_elements] if args.key?(:page_elements) @page_properties = args[:page_properties] if args.key?(:page_properties) @page_type = args[:page_type] if args.key?(:page_type) @revision_id = args[:revision_id] if args.key?(:revision_id) @slide_properties = args[:slide_properties] if args.key?(:slide_properties) end end # The page background fill. class PageBackgroundFill include Google::Apis::Core::Hashable # The background fill property state. # Updating the fill on a page will implicitly update this field to # `RENDERED`, unless another value is specified in the same request. To # have no fill on a page, set this field to `NOT_RENDERED`. In this case, # any other fill fields set in the same request will be ignored. # Corresponds to the JSON property `propertyState` # @return [String] attr_accessor :property_state # A solid color fill. The page or page element is filled entirely with the # specified color value. # If any field is unset, its value may be inherited from a parent placeholder # if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill # The stretched picture fill. The page or page element is filled entirely with # the specified picture. The picture is stretched to fit its container. # Corresponds to the JSON property `stretchedPictureFill` # @return [Google::Apis::SlidesV1::StretchedPictureFill] attr_accessor :stretched_picture_fill def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @property_state = args[:property_state] if args.key?(:property_state) @solid_fill = args[:solid_fill] if args.key?(:solid_fill) @stretched_picture_fill = args[:stretched_picture_fill] if args.key?(:stretched_picture_fill) end end # A visual element rendered on a page. class PageElement include Google::Apis::Core::Hashable # The description of the page element. Combined with title to display alt # text. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # A PageElement kind representing a # joined collection of PageElements. # Corresponds to the JSON property `elementGroup` # @return [Google::Apis::SlidesV1::Group] attr_accessor :element_group # A PageElement kind representing an # image. # Corresponds to the JSON property `image` # @return [Google::Apis::SlidesV1::Image] attr_accessor :image # A PageElement kind representing a # line, curved connector, or bent connector. # Corresponds to the JSON property `line` # @return [Google::Apis::SlidesV1::Line] attr_accessor :line # The object ID for this page element. Object IDs used by # google.apps.slides.v1.Page and # google.apps.slides.v1.PageElement share the same namespace. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # A PageElement kind representing a # generic shape that does not have a more specific classification. # Corresponds to the JSON property `shape` # @return [Google::Apis::SlidesV1::Shape] attr_accessor :shape # A PageElement kind representing # a linked chart embedded from Google Sheets. # Corresponds to the JSON property `sheetsChart` # @return [Google::Apis::SlidesV1::SheetsChart] attr_accessor :sheets_chart # A width and height. # Corresponds to the JSON property `size` # @return [Google::Apis::SlidesV1::Size] attr_accessor :size # A PageElement kind representing a # table. # Corresponds to the JSON property `table` # @return [Google::Apis::SlidesV1::Table] attr_accessor :table # The title of the page element. Combined with description to display alt # text. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # to transform source coordinates (x,y) into destination coordinates (x', y') # according to: # x' x = shear_y scale_y translate_y # 1 [ 1 ] # After transformation, # x' = scale_x * x + shear_x * y + translate_x; # y' = scale_y * y + shear_y * x + translate_y; # This message is therefore composed of these six matrix elements. # Corresponds to the JSON property `transform` # @return [Google::Apis::SlidesV1::AffineTransform] attr_accessor :transform # A PageElement kind representing a # video. # Corresponds to the JSON property `video` # @return [Google::Apis::SlidesV1::Video] attr_accessor :video # A PageElement kind representing # word art. # Corresponds to the JSON property `wordArt` # @return [Google::Apis::SlidesV1::WordArt] attr_accessor :word_art def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @element_group = args[:element_group] if args.key?(:element_group) @image = args[:image] if args.key?(:image) @line = args[:line] if args.key?(:line) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @shape = args[:shape] if args.key?(:shape) @sheets_chart = args[:sheets_chart] if args.key?(:sheets_chart) @size = args[:size] if args.key?(:size) @table = args[:table] if args.key?(:table) @title = args[:title] if args.key?(:title) @transform = args[:transform] if args.key?(:transform) @video = args[:video] if args.key?(:video) @word_art = args[:word_art] if args.key?(:word_art) end end # Common properties for a page element. # Note: When you initially create a # PageElement, the API may modify # the values of both `size` and `transform`, but the # visual size will be unchanged. class PageElementProperties include Google::Apis::Core::Hashable # The object ID of the page where the element is located. # Corresponds to the JSON property `pageObjectId` # @return [String] attr_accessor :page_object_id # A width and height. # Corresponds to the JSON property `size` # @return [Google::Apis::SlidesV1::Size] attr_accessor :size # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # to transform source coordinates (x,y) into destination coordinates (x', y') # according to: # x' x = shear_y scale_y translate_y # 1 [ 1 ] # After transformation, # x' = scale_x * x + shear_x * y + translate_x; # y' = scale_y * y + shear_y * x + translate_y; # This message is therefore composed of these six matrix elements. # Corresponds to the JSON property `transform` # @return [Google::Apis::SlidesV1::AffineTransform] attr_accessor :transform def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @page_object_id = args[:page_object_id] if args.key?(:page_object_id) @size = args[:size] if args.key?(:size) @transform = args[:transform] if args.key?(:transform) end end # The properties of the Page. # The page will inherit properties from the parent page. Depending on the page # type the hierarchy is defined in either # SlideProperties or # LayoutProperties. class PageProperties include Google::Apis::Core::Hashable # The palette of predefined colors for a page. # Corresponds to the JSON property `colorScheme` # @return [Google::Apis::SlidesV1::ColorScheme] attr_accessor :color_scheme # The page background fill. # Corresponds to the JSON property `pageBackgroundFill` # @return [Google::Apis::SlidesV1::PageBackgroundFill] attr_accessor :page_background_fill def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @color_scheme = args[:color_scheme] if args.key?(:color_scheme) @page_background_fill = args[:page_background_fill] if args.key?(:page_background_fill) end end # A TextElement kind that represents the beginning of a new paragraph. class ParagraphMarker include Google::Apis::Core::Hashable # Describes the bullet of a paragraph. # Corresponds to the JSON property `bullet` # @return [Google::Apis::SlidesV1::Bullet] attr_accessor :bullet # Styles that apply to a whole paragraph. # If this text is contained in a shape with a parent placeholder, then these # paragraph styles may be # inherited from the parent. Which paragraph styles are inherited depend on the # nesting level of lists: # * A paragraph not in a list will inherit its paragraph style from the # paragraph at the 0 nesting level of the list inside the parent placeholder. # * A paragraph in a list will inherit its paragraph style from the paragraph # at its corresponding nesting level of the list inside the parent # placeholder. # Inherited paragraph styles are represented as unset fields in this message. # Corresponds to the JSON property `style` # @return [Google::Apis::SlidesV1::ParagraphStyle] attr_accessor :style def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bullet = args[:bullet] if args.key?(:bullet) @style = args[:style] if args.key?(:style) end end # Styles that apply to a whole paragraph. # If this text is contained in a shape with a parent placeholder, then these # paragraph styles may be # inherited from the parent. Which paragraph styles are inherited depend on the # nesting level of lists: # * A paragraph not in a list will inherit its paragraph style from the # paragraph at the 0 nesting level of the list inside the parent placeholder. # * A paragraph in a list will inherit its paragraph style from the paragraph # at its corresponding nesting level of the list inside the parent # placeholder. # Inherited paragraph styles are represented as unset fields in this message. class ParagraphStyle include Google::Apis::Core::Hashable # The text alignment for this paragraph. # Corresponds to the JSON property `alignment` # @return [String] attr_accessor :alignment # The text direction of this paragraph. If unset, the value defaults to # LEFT_TO_RIGHT since # text direction is not inherited. # Corresponds to the JSON property `direction` # @return [String] attr_accessor :direction # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `indentEnd` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :indent_end # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `indentFirstLine` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :indent_first_line # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `indentStart` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :indent_start # The amount of space between lines, as a percentage of normal, where normal # is represented as 100.0. If unset, the value is inherited from the parent. # Corresponds to the JSON property `lineSpacing` # @return [Float] attr_accessor :line_spacing # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `spaceAbove` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :space_above # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `spaceBelow` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :space_below # The spacing mode for the paragraph. # Corresponds to the JSON property `spacingMode` # @return [String] attr_accessor :spacing_mode def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alignment = args[:alignment] if args.key?(:alignment) @direction = args[:direction] if args.key?(:direction) @indent_end = args[:indent_end] if args.key?(:indent_end) @indent_first_line = args[:indent_first_line] if args.key?(:indent_first_line) @indent_start = args[:indent_start] if args.key?(:indent_start) @line_spacing = args[:line_spacing] if args.key?(:line_spacing) @space_above = args[:space_above] if args.key?(:space_above) @space_below = args[:space_below] if args.key?(:space_below) @spacing_mode = args[:spacing_mode] if args.key?(:spacing_mode) end end # The placeholder information that uniquely identifies a placeholder shape. class Placeholder include Google::Apis::Core::Hashable # The index of the placeholder. If the same placeholder types are present in # the same page, they would have different index values. # Corresponds to the JSON property `index` # @return [Fixnum] attr_accessor :index # The object ID of this shape's parent placeholder. # If unset, the parent placeholder shape does not exist, so the shape does # not inherit properties from any other shape. # Corresponds to the JSON property `parentObjectId` # @return [String] attr_accessor :parent_object_id # The type of the placeholder. # 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) @index = args[:index] if args.key?(:index) @parent_object_id = args[:parent_object_id] if args.key?(:parent_object_id) @type = args[:type] if args.key?(:type) end end # A Google Slides presentation. class Presentation include Google::Apis::Core::Hashable # The layouts in the presentation. A layout is a template that determines # how content is arranged and styled on the slides that inherit from that # layout. # Corresponds to the JSON property `layouts` # @return [Array] attr_accessor :layouts # The locale of the presentation, as an IETF BCP 47 language tag. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # The slide masters in the presentation. A slide master contains all common # page elements and the common properties for a set of layouts. They serve # three purposes: # - Placeholder shapes on a master contain the default text styles and shape # properties of all placeholder shapes on pages that use that master. # - The master page properties define the common page properties inherited by # its layouts. # - Any other shapes on the master slide will appear on all slides using that # master, regardless of their layout. # Corresponds to the JSON property `masters` # @return [Array] attr_accessor :masters # A page in a presentation. # Corresponds to the JSON property `notesMaster` # @return [Google::Apis::SlidesV1::Page] attr_accessor :notes_master # A width and height. # Corresponds to the JSON property `pageSize` # @return [Google::Apis::SlidesV1::Size] attr_accessor :page_size # The ID of the presentation. # Corresponds to the JSON property `presentationId` # @return [String] attr_accessor :presentation_id # The revision ID of the presentation. Can be used in update requests # to assert that the presentation revision hasn't changed since the last # read operation. Only populated if the user has edit access to the # presentation. # The format of the revision ID may change over time, so it should be treated # opaquely. A returned revision ID is only guaranteed to be valid for 24 # hours after it has been returned and cannot be shared across users. If the # revision ID is unchanged between calls, then the presentation has not # changed. Conversely, a changed ID (for the same presentation and user) # usually means the presentation has been updated; however, a changed ID can # also be due to internal factors such as ID format changes. # Corresponds to the JSON property `revisionId` # @return [String] attr_accessor :revision_id # The slides in the presentation. # A slide inherits properties from a slide layout. # Corresponds to the JSON property `slides` # @return [Array] attr_accessor :slides # The title of the presentation. # 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) @layouts = args[:layouts] if args.key?(:layouts) @locale = args[:locale] if args.key?(:locale) @masters = args[:masters] if args.key?(:masters) @notes_master = args[:notes_master] if args.key?(:notes_master) @page_size = args[:page_size] if args.key?(:page_size) @presentation_id = args[:presentation_id] if args.key?(:presentation_id) @revision_id = args[:revision_id] if args.key?(:revision_id) @slides = args[:slides] if args.key?(:slides) @title = args[:title] if args.key?(:title) end end # Specifies a contiguous range of an indexed collection, such as characters in # text. class Range include Google::Apis::Core::Hashable # The optional zero-based index of the end of the collection. # Required for `FIXED_RANGE` ranges. # Corresponds to the JSON property `endIndex` # @return [Fixnum] attr_accessor :end_index # The optional zero-based index of the beginning of the collection. # Required for `FIXED_RANGE` and `FROM_START_INDEX` ranges. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The type of range. # 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) @end_index = args[:end_index] if args.key?(:end_index) @start_index = args[:start_index] if args.key?(:start_index) @type = args[:type] if args.key?(:type) end end # A recolor effect applied on an image. class Recolor include Google::Apis::Core::Hashable # The name of the recolor effect. # The name is determined from the `recolor_stops` by matching the gradient # against the colors in the page's current color scheme. This property is # read-only. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The recolor effect is represented by a gradient, which is a list of color # stops. # The colors in the gradient will replace the corresponding colors at # the same position in the color palette and apply to the image. This # property is read-only. # Corresponds to the JSON property `recolorStops` # @return [Array] attr_accessor :recolor_stops def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @recolor_stops = args[:recolor_stops] if args.key?(:recolor_stops) end end # Refreshes an embedded Google Sheets chart by replacing it with the latest # version of the chart from Google Sheets. # NOTE: Refreshing charts requires at least one of the spreadsheets.readonly, # spreadsheets, drive.readonly, or drive OAuth scopes. class RefreshSheetsChartRequest include Google::Apis::Core::Hashable # The object ID of the chart to refresh. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # Replaces all shapes that match the given criteria with the provided image. class ReplaceAllShapesWithImageRequest include Google::Apis::Core::Hashable # A criteria that matches a specific string of text in a shape or table. # Corresponds to the JSON property `containsText` # @return [Google::Apis::SlidesV1::SubstringMatchCriteria] attr_accessor :contains_text # The image replace method. # If you specify both a `replace_method` and an `image_replace_method`, the # `image_replace_method` takes precedence. # If you do not specify a value for `image_replace_method`, but specify a # value for `replace_method`, then the specified `replace_method` value is # used. # If you do not specify either, then CENTER_INSIDE is used. # Corresponds to the JSON property `imageReplaceMethod` # @return [String] attr_accessor :image_replace_method # The image URL. # The image is fetched once at insertion time and a copy is stored for # display inside the presentation. Images must be less than 50MB in size, # cannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF # format. # The provided URL can be at most 2 kB in length. # Corresponds to the JSON property `imageUrl` # @return [String] attr_accessor :image_url # If non-empty, limits the matches to page elements only on the given pages. # Returns a 400 bad request error if given the page object ID of a # notes page or a # notes master, or if a # page with that object ID doesn't exist in the presentation. # Corresponds to the JSON property `pageObjectIds` # @return [Array] attr_accessor :page_object_ids # The replace method. # Deprecated: use `image_replace_method` instead. # If you specify both a `replace_method` and an `image_replace_method`, the # `image_replace_method` takes precedence. # Corresponds to the JSON property `replaceMethod` # @return [String] attr_accessor :replace_method def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contains_text = args[:contains_text] if args.key?(:contains_text) @image_replace_method = args[:image_replace_method] if args.key?(:image_replace_method) @image_url = args[:image_url] if args.key?(:image_url) @page_object_ids = args[:page_object_ids] if args.key?(:page_object_ids) @replace_method = args[:replace_method] if args.key?(:replace_method) end end # The result of replacing shapes with an image. class ReplaceAllShapesWithImageResponse include Google::Apis::Core::Hashable # The number of shapes replaced with images. # Corresponds to the JSON property `occurrencesChanged` # @return [Fixnum] attr_accessor :occurrences_changed def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @occurrences_changed = args[:occurrences_changed] if args.key?(:occurrences_changed) end end # Replaces all shapes that match the given criteria with the provided Google # Sheets chart. The chart will be scaled and centered to fit within the bounds # of the original shape. # NOTE: Replacing shapes with a chart requires at least one of the # spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes. class ReplaceAllShapesWithSheetsChartRequest include Google::Apis::Core::Hashable # The ID of the specific chart in the Google Sheets spreadsheet. # Corresponds to the JSON property `chartId` # @return [Fixnum] attr_accessor :chart_id # A criteria that matches a specific string of text in a shape or table. # Corresponds to the JSON property `containsText` # @return [Google::Apis::SlidesV1::SubstringMatchCriteria] attr_accessor :contains_text # The mode with which the chart is linked to the source spreadsheet. When # not specified, the chart will be an image that is not linked. # Corresponds to the JSON property `linkingMode` # @return [String] attr_accessor :linking_mode # If non-empty, limits the matches to page elements only on the given pages. # Returns a 400 bad request error if given the page object ID of a # notes page or a # notes master, or if a # page with that object ID doesn't exist in the presentation. # Corresponds to the JSON property `pageObjectIds` # @return [Array] attr_accessor :page_object_ids # The ID of the Google Sheets spreadsheet that contains the chart. # Corresponds to the JSON property `spreadsheetId` # @return [String] attr_accessor :spreadsheet_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @chart_id = args[:chart_id] if args.key?(:chart_id) @contains_text = args[:contains_text] if args.key?(:contains_text) @linking_mode = args[:linking_mode] if args.key?(:linking_mode) @page_object_ids = args[:page_object_ids] if args.key?(:page_object_ids) @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) end end # The result of replacing shapes with a Google Sheets chart. class ReplaceAllShapesWithSheetsChartResponse include Google::Apis::Core::Hashable # The number of shapes replaced with charts. # Corresponds to the JSON property `occurrencesChanged` # @return [Fixnum] attr_accessor :occurrences_changed def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @occurrences_changed = args[:occurrences_changed] if args.key?(:occurrences_changed) end end # Replaces all instances of text matching a criteria with replace text. class ReplaceAllTextRequest include Google::Apis::Core::Hashable # A criteria that matches a specific string of text in a shape or table. # Corresponds to the JSON property `containsText` # @return [Google::Apis::SlidesV1::SubstringMatchCriteria] attr_accessor :contains_text # If non-empty, limits the matches to page elements only on the given pages. # Returns a 400 bad request error if given the page object ID of a # notes master, # or if a page with that object ID doesn't exist in the presentation. # Corresponds to the JSON property `pageObjectIds` # @return [Array] attr_accessor :page_object_ids # The text that will replace the matched text. # Corresponds to the JSON property `replaceText` # @return [String] attr_accessor :replace_text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contains_text = args[:contains_text] if args.key?(:contains_text) @page_object_ids = args[:page_object_ids] if args.key?(:page_object_ids) @replace_text = args[:replace_text] if args.key?(:replace_text) end end # The result of replacing text. class ReplaceAllTextResponse include Google::Apis::Core::Hashable # The number of occurrences changed by replacing all text. # Corresponds to the JSON property `occurrencesChanged` # @return [Fixnum] attr_accessor :occurrences_changed def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @occurrences_changed = args[:occurrences_changed] if args.key?(:occurrences_changed) end end # A single kind of update to apply to a presentation. class Request include Google::Apis::Core::Hashable # Creates an image. # Corresponds to the JSON property `createImage` # @return [Google::Apis::SlidesV1::CreateImageRequest] attr_accessor :create_image # Creates a line. # Corresponds to the JSON property `createLine` # @return [Google::Apis::SlidesV1::CreateLineRequest] attr_accessor :create_line # Creates bullets for all of the paragraphs that overlap with the given # text index range. # The nesting level of each paragraph will be determined by counting leading # tabs in front of each paragraph. To avoid excess space between the bullet and # the corresponding paragraph, these leading tabs are removed by this request. # This may change the indices of parts of the text. # If the paragraph immediately before paragraphs being updated is in a list # with a matching preset, the paragraphs being updated are added to that # preceding list. # Corresponds to the JSON property `createParagraphBullets` # @return [Google::Apis::SlidesV1::CreateParagraphBulletsRequest] attr_accessor :create_paragraph_bullets # Creates a new shape. # Corresponds to the JSON property `createShape` # @return [Google::Apis::SlidesV1::CreateShapeRequest] attr_accessor :create_shape # Creates an embedded Google Sheets chart. # NOTE: Chart creation requires at least one of the spreadsheets.readonly, # spreadsheets, drive.readonly, or drive OAuth scopes. # Corresponds to the JSON property `createSheetsChart` # @return [Google::Apis::SlidesV1::CreateSheetsChartRequest] attr_accessor :create_sheets_chart # Creates a new slide. # Corresponds to the JSON property `createSlide` # @return [Google::Apis::SlidesV1::CreateSlideRequest] attr_accessor :create_slide # Creates a new table. # Corresponds to the JSON property `createTable` # @return [Google::Apis::SlidesV1::CreateTableRequest] attr_accessor :create_table # Creates a video. # Corresponds to the JSON property `createVideo` # @return [Google::Apis::SlidesV1::CreateVideoRequest] attr_accessor :create_video # Deletes an object, either pages or # page elements, from the # presentation. # Corresponds to the JSON property `deleteObject` # @return [Google::Apis::SlidesV1::DeleteObjectRequest] attr_accessor :delete_object # Deletes bullets from all of the paragraphs that overlap with the given text # index range. # The nesting level of each paragraph will be visually preserved by adding # indent to the start of the corresponding paragraph. # Corresponds to the JSON property `deleteParagraphBullets` # @return [Google::Apis::SlidesV1::DeleteParagraphBulletsRequest] attr_accessor :delete_paragraph_bullets # Deletes a column from a table. # Corresponds to the JSON property `deleteTableColumn` # @return [Google::Apis::SlidesV1::DeleteTableColumnRequest] attr_accessor :delete_table_column # Deletes a row from a table. # Corresponds to the JSON property `deleteTableRow` # @return [Google::Apis::SlidesV1::DeleteTableRowRequest] attr_accessor :delete_table_row # Deletes text from a shape or a table cell. # Corresponds to the JSON property `deleteText` # @return [Google::Apis::SlidesV1::DeleteTextRequest] attr_accessor :delete_text # Duplicates a slide or page element. # When duplicating a slide, the duplicate slide will be created immediately # following the specified slide. When duplicating a page element, the duplicate # will be placed on the same page at the same position as the original. # Corresponds to the JSON property `duplicateObject` # @return [Google::Apis::SlidesV1::DuplicateObjectRequest] attr_accessor :duplicate_object # Groups objects to create an object group. For example, groups PageElements to # create a Group on the same page as all the children. # Corresponds to the JSON property `groupObjects` # @return [Google::Apis::SlidesV1::GroupObjectsRequest] attr_accessor :group_objects # Inserts columns into a table. # Other columns in the table will be resized to fit the new column. # Corresponds to the JSON property `insertTableColumns` # @return [Google::Apis::SlidesV1::InsertTableColumnsRequest] attr_accessor :insert_table_columns # Inserts rows into a table. # Corresponds to the JSON property `insertTableRows` # @return [Google::Apis::SlidesV1::InsertTableRowsRequest] attr_accessor :insert_table_rows # Inserts text into a shape or a table cell. # Corresponds to the JSON property `insertText` # @return [Google::Apis::SlidesV1::InsertTextRequest] attr_accessor :insert_text # Merges cells in a Table. # Corresponds to the JSON property `mergeTableCells` # @return [Google::Apis::SlidesV1::MergeTableCellsRequest] attr_accessor :merge_table_cells # Refreshes an embedded Google Sheets chart by replacing it with the latest # version of the chart from Google Sheets. # NOTE: Refreshing charts requires at least one of the spreadsheets.readonly, # spreadsheets, drive.readonly, or drive OAuth scopes. # Corresponds to the JSON property `refreshSheetsChart` # @return [Google::Apis::SlidesV1::RefreshSheetsChartRequest] attr_accessor :refresh_sheets_chart # Replaces all shapes that match the given criteria with the provided image. # Corresponds to the JSON property `replaceAllShapesWithImage` # @return [Google::Apis::SlidesV1::ReplaceAllShapesWithImageRequest] attr_accessor :replace_all_shapes_with_image # Replaces all shapes that match the given criteria with the provided Google # Sheets chart. The chart will be scaled and centered to fit within the bounds # of the original shape. # NOTE: Replacing shapes with a chart requires at least one of the # spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes. # Corresponds to the JSON property `replaceAllShapesWithSheetsChart` # @return [Google::Apis::SlidesV1::ReplaceAllShapesWithSheetsChartRequest] attr_accessor :replace_all_shapes_with_sheets_chart # Replaces all instances of text matching a criteria with replace text. # Corresponds to the JSON property `replaceAllText` # @return [Google::Apis::SlidesV1::ReplaceAllTextRequest] attr_accessor :replace_all_text # Ungroups objects, such as groups. # Corresponds to the JSON property `ungroupObjects` # @return [Google::Apis::SlidesV1::UngroupObjectsRequest] attr_accessor :ungroup_objects # Unmerges cells in a Table. # Corresponds to the JSON property `unmergeTableCells` # @return [Google::Apis::SlidesV1::UnmergeTableCellsRequest] attr_accessor :unmerge_table_cells # Update the properties of an Image. # Corresponds to the JSON property `updateImageProperties` # @return [Google::Apis::SlidesV1::UpdateImagePropertiesRequest] attr_accessor :update_image_properties # Updates the properties of a Line. # Corresponds to the JSON property `updateLineProperties` # @return [Google::Apis::SlidesV1::UpdateLinePropertiesRequest] attr_accessor :update_line_properties # Updates the alt text title and/or description of a # page element. # Corresponds to the JSON property `updatePageElementAltText` # @return [Google::Apis::SlidesV1::UpdatePageElementAltTextRequest] attr_accessor :update_page_element_alt_text # Updates the transform of a page element. # Updating the transform of a group will change the absolute transform of the # page elements in that group, which can change their visual appearance. See # the documentation for PageElement.transform for more details. # Corresponds to the JSON property `updatePageElementTransform` # @return [Google::Apis::SlidesV1::UpdatePageElementTransformRequest] attr_accessor :update_page_element_transform # Updates the properties of a Page. # Corresponds to the JSON property `updatePageProperties` # @return [Google::Apis::SlidesV1::UpdatePagePropertiesRequest] attr_accessor :update_page_properties # Updates the styling for all of the paragraphs within a Shape or Table that # overlap with the given text index range. # Corresponds to the JSON property `updateParagraphStyle` # @return [Google::Apis::SlidesV1::UpdateParagraphStyleRequest] attr_accessor :update_paragraph_style # Update the properties of a Shape. # Corresponds to the JSON property `updateShapeProperties` # @return [Google::Apis::SlidesV1::UpdateShapePropertiesRequest] attr_accessor :update_shape_properties # Updates the position of slides in the presentation. # Corresponds to the JSON property `updateSlidesPosition` # @return [Google::Apis::SlidesV1::UpdateSlidesPositionRequest] attr_accessor :update_slides_position # Updates the properties of the table borders in a Table. # Corresponds to the JSON property `updateTableBorderProperties` # @return [Google::Apis::SlidesV1::UpdateTableBorderPropertiesRequest] attr_accessor :update_table_border_properties # Update the properties of a TableCell. # Corresponds to the JSON property `updateTableCellProperties` # @return [Google::Apis::SlidesV1::UpdateTableCellPropertiesRequest] attr_accessor :update_table_cell_properties # Updates the properties of a Table column. # Corresponds to the JSON property `updateTableColumnProperties` # @return [Google::Apis::SlidesV1::UpdateTableColumnPropertiesRequest] attr_accessor :update_table_column_properties # Updates the properties of a Table row. # Corresponds to the JSON property `updateTableRowProperties` # @return [Google::Apis::SlidesV1::UpdateTableRowPropertiesRequest] attr_accessor :update_table_row_properties # Update the styling of text in a Shape or # Table. # Corresponds to the JSON property `updateTextStyle` # @return [Google::Apis::SlidesV1::UpdateTextStyleRequest] attr_accessor :update_text_style # Update the properties of a Video. # Corresponds to the JSON property `updateVideoProperties` # @return [Google::Apis::SlidesV1::UpdateVideoPropertiesRequest] attr_accessor :update_video_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_image = args[:create_image] if args.key?(:create_image) @create_line = args[:create_line] if args.key?(:create_line) @create_paragraph_bullets = args[:create_paragraph_bullets] if args.key?(:create_paragraph_bullets) @create_shape = args[:create_shape] if args.key?(:create_shape) @create_sheets_chart = args[:create_sheets_chart] if args.key?(:create_sheets_chart) @create_slide = args[:create_slide] if args.key?(:create_slide) @create_table = args[:create_table] if args.key?(:create_table) @create_video = args[:create_video] if args.key?(:create_video) @delete_object = args[:delete_object] if args.key?(:delete_object) @delete_paragraph_bullets = args[:delete_paragraph_bullets] if args.key?(:delete_paragraph_bullets) @delete_table_column = args[:delete_table_column] if args.key?(:delete_table_column) @delete_table_row = args[:delete_table_row] if args.key?(:delete_table_row) @delete_text = args[:delete_text] if args.key?(:delete_text) @duplicate_object = args[:duplicate_object] if args.key?(:duplicate_object) @group_objects = args[:group_objects] if args.key?(:group_objects) @insert_table_columns = args[:insert_table_columns] if args.key?(:insert_table_columns) @insert_table_rows = args[:insert_table_rows] if args.key?(:insert_table_rows) @insert_text = args[:insert_text] if args.key?(:insert_text) @merge_table_cells = args[:merge_table_cells] if args.key?(:merge_table_cells) @refresh_sheets_chart = args[:refresh_sheets_chart] if args.key?(:refresh_sheets_chart) @replace_all_shapes_with_image = args[:replace_all_shapes_with_image] if args.key?(:replace_all_shapes_with_image) @replace_all_shapes_with_sheets_chart = args[:replace_all_shapes_with_sheets_chart] if args.key?(:replace_all_shapes_with_sheets_chart) @replace_all_text = args[:replace_all_text] if args.key?(:replace_all_text) @ungroup_objects = args[:ungroup_objects] if args.key?(:ungroup_objects) @unmerge_table_cells = args[:unmerge_table_cells] if args.key?(:unmerge_table_cells) @update_image_properties = args[:update_image_properties] if args.key?(:update_image_properties) @update_line_properties = args[:update_line_properties] if args.key?(:update_line_properties) @update_page_element_alt_text = args[:update_page_element_alt_text] if args.key?(:update_page_element_alt_text) @update_page_element_transform = args[:update_page_element_transform] if args.key?(:update_page_element_transform) @update_page_properties = args[:update_page_properties] if args.key?(:update_page_properties) @update_paragraph_style = args[:update_paragraph_style] if args.key?(:update_paragraph_style) @update_shape_properties = args[:update_shape_properties] if args.key?(:update_shape_properties) @update_slides_position = args[:update_slides_position] if args.key?(:update_slides_position) @update_table_border_properties = args[:update_table_border_properties] if args.key?(:update_table_border_properties) @update_table_cell_properties = args[:update_table_cell_properties] if args.key?(:update_table_cell_properties) @update_table_column_properties = args[:update_table_column_properties] if args.key?(:update_table_column_properties) @update_table_row_properties = args[:update_table_row_properties] if args.key?(:update_table_row_properties) @update_text_style = args[:update_text_style] if args.key?(:update_text_style) @update_video_properties = args[:update_video_properties] if args.key?(:update_video_properties) end end # A single response from an update. class Response include Google::Apis::Core::Hashable # The result of creating an image. # Corresponds to the JSON property `createImage` # @return [Google::Apis::SlidesV1::CreateImageResponse] attr_accessor :create_image # The result of creating a line. # Corresponds to the JSON property `createLine` # @return [Google::Apis::SlidesV1::CreateLineResponse] attr_accessor :create_line # The result of creating a shape. # Corresponds to the JSON property `createShape` # @return [Google::Apis::SlidesV1::CreateShapeResponse] attr_accessor :create_shape # The result of creating an embedded Google Sheets chart. # Corresponds to the JSON property `createSheetsChart` # @return [Google::Apis::SlidesV1::CreateSheetsChartResponse] attr_accessor :create_sheets_chart # The result of creating a slide. # Corresponds to the JSON property `createSlide` # @return [Google::Apis::SlidesV1::CreateSlideResponse] attr_accessor :create_slide # The result of creating a table. # Corresponds to the JSON property `createTable` # @return [Google::Apis::SlidesV1::CreateTableResponse] attr_accessor :create_table # The result of creating a video. # Corresponds to the JSON property `createVideo` # @return [Google::Apis::SlidesV1::CreateVideoResponse] attr_accessor :create_video # The response of duplicating an object. # Corresponds to the JSON property `duplicateObject` # @return [Google::Apis::SlidesV1::DuplicateObjectResponse] attr_accessor :duplicate_object # The result of grouping objects. # Corresponds to the JSON property `groupObjects` # @return [Google::Apis::SlidesV1::GroupObjectsResponse] attr_accessor :group_objects # The result of replacing shapes with an image. # Corresponds to the JSON property `replaceAllShapesWithImage` # @return [Google::Apis::SlidesV1::ReplaceAllShapesWithImageResponse] attr_accessor :replace_all_shapes_with_image # The result of replacing shapes with a Google Sheets chart. # Corresponds to the JSON property `replaceAllShapesWithSheetsChart` # @return [Google::Apis::SlidesV1::ReplaceAllShapesWithSheetsChartResponse] attr_accessor :replace_all_shapes_with_sheets_chart # The result of replacing text. # Corresponds to the JSON property `replaceAllText` # @return [Google::Apis::SlidesV1::ReplaceAllTextResponse] attr_accessor :replace_all_text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_image = args[:create_image] if args.key?(:create_image) @create_line = args[:create_line] if args.key?(:create_line) @create_shape = args[:create_shape] if args.key?(:create_shape) @create_sheets_chart = args[:create_sheets_chart] if args.key?(:create_sheets_chart) @create_slide = args[:create_slide] if args.key?(:create_slide) @create_table = args[:create_table] if args.key?(:create_table) @create_video = args[:create_video] if args.key?(:create_video) @duplicate_object = args[:duplicate_object] if args.key?(:duplicate_object) @group_objects = args[:group_objects] if args.key?(:group_objects) @replace_all_shapes_with_image = args[:replace_all_shapes_with_image] if args.key?(:replace_all_shapes_with_image) @replace_all_shapes_with_sheets_chart = args[:replace_all_shapes_with_sheets_chart] if args.key?(:replace_all_shapes_with_sheets_chart) @replace_all_text = args[:replace_all_text] if args.key?(:replace_all_text) end end # An RGB color. class RgbColor include Google::Apis::Core::Hashable # The blue component of the color, from 0.0 to 1.0. # Corresponds to the JSON property `blue` # @return [Float] attr_accessor :blue # The green component of the color, from 0.0 to 1.0. # Corresponds to the JSON property `green` # @return [Float] attr_accessor :green # The red component of the color, from 0.0 to 1.0. # Corresponds to the JSON property `red` # @return [Float] attr_accessor :red def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @blue = args[:blue] if args.key?(:blue) @green = args[:green] if args.key?(:green) @red = args[:red] if args.key?(:red) end end # The shadow properties of a page element. # If these fields are unset, they may be inherited from a parent placeholder # if it exists. If there is no parent, the fields will default to the value # used for new page elements created in the Slides editor, which may depend on # the page element kind. class Shadow include Google::Apis::Core::Hashable # The alignment point of the shadow, that sets the origin for translate, # scale and skew of the shadow. # Corresponds to the JSON property `alignment` # @return [String] attr_accessor :alignment # The alpha of the shadow's color, from 0.0 to 1.0. # Corresponds to the JSON property `alpha` # @return [Float] attr_accessor :alpha # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `blurRadius` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :blur_radius # A themeable solid color value. # Corresponds to the JSON property `color` # @return [Google::Apis::SlidesV1::OpaqueColor] attr_accessor :color # The shadow property state. # Updating the shadow on a page element will implicitly update this field to # `RENDERED`, unless another value is specified in the same request. To have # no shadow on a page element, set this field to `NOT_RENDERED`. In this # case, any other shadow fields set in the same request will be ignored. # Corresponds to the JSON property `propertyState` # @return [String] attr_accessor :property_state # Whether the shadow should rotate with the shape. # Corresponds to the JSON property `rotateWithShape` # @return [Boolean] attr_accessor :rotate_with_shape alias_method :rotate_with_shape?, :rotate_with_shape # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # to transform source coordinates (x,y) into destination coordinates (x', y') # according to: # x' x = shear_y scale_y translate_y # 1 [ 1 ] # After transformation, # x' = scale_x * x + shear_x * y + translate_x; # y' = scale_y * y + shear_y * x + translate_y; # This message is therefore composed of these six matrix elements. # Corresponds to the JSON property `transform` # @return [Google::Apis::SlidesV1::AffineTransform] attr_accessor :transform # The type of the shadow. # 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) @alignment = args[:alignment] if args.key?(:alignment) @alpha = args[:alpha] if args.key?(:alpha) @blur_radius = args[:blur_radius] if args.key?(:blur_radius) @color = args[:color] if args.key?(:color) @property_state = args[:property_state] if args.key?(:property_state) @rotate_with_shape = args[:rotate_with_shape] if args.key?(:rotate_with_shape) @transform = args[:transform] if args.key?(:transform) @type = args[:type] if args.key?(:type) end end # A PageElement kind representing a # generic shape that does not have a more specific classification. class Shape include Google::Apis::Core::Hashable # The placeholder information that uniquely identifies a placeholder shape. # Corresponds to the JSON property `placeholder` # @return [Google::Apis::SlidesV1::Placeholder] attr_accessor :placeholder # The properties of a Shape. # If the shape is a placeholder shape as determined by the # placeholder field, then these # properties may be inherited from a parent placeholder shape. # Determining the rendered value of the property depends on the corresponding # property_state field value. # Corresponds to the JSON property `shapeProperties` # @return [Google::Apis::SlidesV1::ShapeProperties] attr_accessor :shape_properties # The type of the shape. # Corresponds to the JSON property `shapeType` # @return [String] attr_accessor :shape_type # The general text content. The text must reside in a compatible shape (e.g. # text box or rectangle) or a table cell in a page. # Corresponds to the JSON property `text` # @return [Google::Apis::SlidesV1::TextContent] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @placeholder = args[:placeholder] if args.key?(:placeholder) @shape_properties = args[:shape_properties] if args.key?(:shape_properties) @shape_type = args[:shape_type] if args.key?(:shape_type) @text = args[:text] if args.key?(:text) end end # The shape background fill. class ShapeBackgroundFill include Google::Apis::Core::Hashable # The background fill property state. # Updating the fill on a shape will implicitly update this field to # `RENDERED`, unless another value is specified in the same request. To # have no fill on a shape, set this field to `NOT_RENDERED`. In this case, # any other fill fields set in the same request will be ignored. # Corresponds to the JSON property `propertyState` # @return [String] attr_accessor :property_state # A solid color fill. The page or page element is filled entirely with the # specified color value. # If any field is unset, its value may be inherited from a parent placeholder # if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @property_state = args[:property_state] if args.key?(:property_state) @solid_fill = args[:solid_fill] if args.key?(:solid_fill) end end # The properties of a Shape. # If the shape is a placeholder shape as determined by the # placeholder field, then these # properties may be inherited from a parent placeholder shape. # Determining the rendered value of the property depends on the corresponding # property_state field value. class ShapeProperties include Google::Apis::Core::Hashable # The alignment of the content in the shape. If unspecified, # the alignment is inherited from a parent placeholder if it exists. If the # shape has no parent, the default alignment matches the alignment for new # shapes created in the Slides editor. # Corresponds to the JSON property `contentAlignment` # @return [String] attr_accessor :content_alignment # A hypertext link. # Corresponds to the JSON property `link` # @return [Google::Apis::SlidesV1::Link] attr_accessor :link # The outline of a PageElement. # If these fields are unset, they may be inherited from a parent placeholder # if it exists. If there is no parent, the fields will default to the value # used for new page elements created in the Slides editor, which may depend on # the page element kind. # Corresponds to the JSON property `outline` # @return [Google::Apis::SlidesV1::Outline] attr_accessor :outline # The shadow properties of a page element. # If these fields are unset, they may be inherited from a parent placeholder # if it exists. If there is no parent, the fields will default to the value # used for new page elements created in the Slides editor, which may depend on # the page element kind. # Corresponds to the JSON property `shadow` # @return [Google::Apis::SlidesV1::Shadow] attr_accessor :shadow # The shape background fill. # Corresponds to the JSON property `shapeBackgroundFill` # @return [Google::Apis::SlidesV1::ShapeBackgroundFill] attr_accessor :shape_background_fill def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_alignment = args[:content_alignment] if args.key?(:content_alignment) @link = args[:link] if args.key?(:link) @outline = args[:outline] if args.key?(:outline) @shadow = args[:shadow] if args.key?(:shadow) @shape_background_fill = args[:shape_background_fill] if args.key?(:shape_background_fill) end end # A PageElement kind representing # a linked chart embedded from Google Sheets. class SheetsChart include Google::Apis::Core::Hashable # The ID of the specific chart in the Google Sheets spreadsheet that is # embedded. # Corresponds to the JSON property `chartId` # @return [Fixnum] attr_accessor :chart_id # The URL of an image of the embedded chart, with a default lifetime of 30 # minutes. This URL is tagged with the account of the requester. Anyone with # the URL effectively accesses the image as the original requester. Access to # the image may be lost if the presentation's sharing settings change. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url # The properties of the SheetsChart. # Corresponds to the JSON property `sheetsChartProperties` # @return [Google::Apis::SlidesV1::SheetsChartProperties] attr_accessor :sheets_chart_properties # The ID of the Google Sheets spreadsheet that contains the source chart. # Corresponds to the JSON property `spreadsheetId` # @return [String] attr_accessor :spreadsheet_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @chart_id = args[:chart_id] if args.key?(:chart_id) @content_url = args[:content_url] if args.key?(:content_url) @sheets_chart_properties = args[:sheets_chart_properties] if args.key?(:sheets_chart_properties) @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) end end # The properties of the SheetsChart. class SheetsChartProperties include Google::Apis::Core::Hashable # The properties of the Image. # Corresponds to the JSON property `chartImageProperties` # @return [Google::Apis::SlidesV1::ImageProperties] attr_accessor :chart_image_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @chart_image_properties = args[:chart_image_properties] if args.key?(:chart_image_properties) end end # A width and height. class Size include Google::Apis::Core::Hashable # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `height` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :height # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `width` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @width = args[:width] if args.key?(:width) end end # The properties of Page that are only # relevant for pages with page_type SLIDE. class SlideProperties include Google::Apis::Core::Hashable # The object ID of the layout that this slide is based on. # Corresponds to the JSON property `layoutObjectId` # @return [String] attr_accessor :layout_object_id # The object ID of the master that this slide is based on. # Corresponds to the JSON property `masterObjectId` # @return [String] attr_accessor :master_object_id # A page in a presentation. # Corresponds to the JSON property `notesPage` # @return [Google::Apis::SlidesV1::Page] attr_accessor :notes_page def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @layout_object_id = args[:layout_object_id] if args.key?(:layout_object_id) @master_object_id = args[:master_object_id] if args.key?(:master_object_id) @notes_page = args[:notes_page] if args.key?(:notes_page) end end # A solid color fill. The page or page element is filled entirely with the # specified color value. # If any field is unset, its value may be inherited from a parent placeholder # if it exists. class SolidFill include Google::Apis::Core::Hashable # The fraction of this `color` that should be applied to the pixel. # That is, the final pixel color is defined by the equation: # pixel color = alpha * (color) + (1.0 - alpha) * (background color) # This means that a value of 1.0 corresponds to a solid color, whereas # a value of 0.0 corresponds to a completely transparent color. # Corresponds to the JSON property `alpha` # @return [Float] attr_accessor :alpha # A themeable solid color value. # Corresponds to the JSON property `color` # @return [Google::Apis::SlidesV1::OpaqueColor] attr_accessor :color def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alpha = args[:alpha] if args.key?(:alpha) @color = args[:color] if args.key?(:color) end end # The stretched picture fill. The page or page element is filled entirely with # the specified picture. The picture is stretched to fit its container. class StretchedPictureFill include Google::Apis::Core::Hashable # Reading the content_url: # An URL to a picture with a default lifetime of 30 minutes. # This URL is tagged with the account of the requester. Anyone with the URL # effectively accesses the picture as the original requester. Access to the # picture may be lost if the presentation's sharing settings change. # Writing the content_url: # The picture is fetched once at insertion time and a copy is stored for # display inside the presentation. Pictures must be less than 50MB in size, # cannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF # format. # The provided URL can be at most 2 kB in length. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url # A width and height. # Corresponds to the JSON property `size` # @return [Google::Apis::SlidesV1::Size] attr_accessor :size def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_url = args[:content_url] if args.key?(:content_url) @size = args[:size] if args.key?(:size) end end # A criteria that matches a specific string of text in a shape or table. class SubstringMatchCriteria include Google::Apis::Core::Hashable # Indicates whether the search should respect case: # - `True`: the search is case sensitive. # - `False`: the search is case insensitive. # Corresponds to the JSON property `matchCase` # @return [Boolean] attr_accessor :match_case alias_method :match_case?, :match_case # The text to search for in the shape or table. # 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) @match_case = args[:match_case] if args.key?(:match_case) @text = args[:text] if args.key?(:text) end end # A PageElement kind representing a # table. class Table include Google::Apis::Core::Hashable # Number of columns in the table. # Corresponds to the JSON property `columns` # @return [Fixnum] attr_accessor :columns # Properties of horizontal cell borders. # A table's horizontal cell borders are represented as a grid. The grid has # one more row than the number of rows in the table and the same number of # columns as the table. For example, if the table is 3 x 3, its horizontal # borders will be represented as a grid with 4 rows and 3 columns. # Corresponds to the JSON property `horizontalBorderRows` # @return [Array] attr_accessor :horizontal_border_rows # Number of rows in the table. # Corresponds to the JSON property `rows` # @return [Fixnum] attr_accessor :rows # Properties of each column. # Corresponds to the JSON property `tableColumns` # @return [Array] attr_accessor :table_columns # Properties and contents of each row. # Cells that span multiple rows are contained in only one of these rows and # have a row_span greater # than 1. # Corresponds to the JSON property `tableRows` # @return [Array] attr_accessor :table_rows # Properties of vertical cell borders. # A table's vertical cell borders are represented as a grid. The grid has the # same number of rows as the table and one more column than the number of # columns in the table. For example, if the table is 3 x 3, its vertical # borders will be represented as a grid with 3 rows and 4 columns. # Corresponds to the JSON property `verticalBorderRows` # @return [Array] attr_accessor :vertical_border_rows def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @columns = args[:columns] if args.key?(:columns) @horizontal_border_rows = args[:horizontal_border_rows] if args.key?(:horizontal_border_rows) @rows = args[:rows] if args.key?(:rows) @table_columns = args[:table_columns] if args.key?(:table_columns) @table_rows = args[:table_rows] if args.key?(:table_rows) @vertical_border_rows = args[:vertical_border_rows] if args.key?(:vertical_border_rows) end end # The properties of each border cell. class TableBorderCell include Google::Apis::Core::Hashable # A location of a single table cell within a table. # Corresponds to the JSON property `location` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :location # The border styling properties of the # TableBorderCell. # Corresponds to the JSON property `tableBorderProperties` # @return [Google::Apis::SlidesV1::TableBorderProperties] attr_accessor :table_border_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @location = args[:location] if args.key?(:location) @table_border_properties = args[:table_border_properties] if args.key?(:table_border_properties) end end # The fill of the border. class TableBorderFill include Google::Apis::Core::Hashable # A solid color fill. The page or page element is filled entirely with the # specified color value. # If any field is unset, its value may be inherited from a parent placeholder # if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @solid_fill = args[:solid_fill] if args.key?(:solid_fill) end end # The border styling properties of the # TableBorderCell. class TableBorderProperties include Google::Apis::Core::Hashable # The dash style of the border. # Corresponds to the JSON property `dashStyle` # @return [String] attr_accessor :dash_style # The fill of the border. # Corresponds to the JSON property `tableBorderFill` # @return [Google::Apis::SlidesV1::TableBorderFill] attr_accessor :table_border_fill # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `weight` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :weight def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dash_style = args[:dash_style] if args.key?(:dash_style) @table_border_fill = args[:table_border_fill] if args.key?(:table_border_fill) @weight = args[:weight] if args.key?(:weight) end end # Contents of each border row in a table. class TableBorderRow include Google::Apis::Core::Hashable # Properties of each border cell. When a border's adjacent table cells are # merged, it is not included in the response. # Corresponds to the JSON property `tableBorderCells` # @return [Array] attr_accessor :table_border_cells def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @table_border_cells = args[:table_border_cells] if args.key?(:table_border_cells) end end # Properties and contents of each table cell. class TableCell include Google::Apis::Core::Hashable # Column span of the cell. # Corresponds to the JSON property `columnSpan` # @return [Fixnum] attr_accessor :column_span # A location of a single table cell within a table. # Corresponds to the JSON property `location` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :location # Row span of the cell. # Corresponds to the JSON property `rowSpan` # @return [Fixnum] attr_accessor :row_span # The properties of the TableCell. # Corresponds to the JSON property `tableCellProperties` # @return [Google::Apis::SlidesV1::TableCellProperties] attr_accessor :table_cell_properties # The general text content. The text must reside in a compatible shape (e.g. # text box or rectangle) or a table cell in a page. # Corresponds to the JSON property `text` # @return [Google::Apis::SlidesV1::TextContent] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_span = args[:column_span] if args.key?(:column_span) @location = args[:location] if args.key?(:location) @row_span = args[:row_span] if args.key?(:row_span) @table_cell_properties = args[:table_cell_properties] if args.key?(:table_cell_properties) @text = args[:text] if args.key?(:text) end end # The table cell background fill. class TableCellBackgroundFill include Google::Apis::Core::Hashable # The background fill property state. # Updating the fill on a table cell will implicitly update this field # to `RENDERED`, unless another value is specified in the same request. To # have no fill on a table cell, set this field to `NOT_RENDERED`. In this # case, any other fill fields set in the same request will be ignored. # Corresponds to the JSON property `propertyState` # @return [String] attr_accessor :property_state # A solid color fill. The page or page element is filled entirely with the # specified color value. # If any field is unset, its value may be inherited from a parent placeholder # if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @property_state = args[:property_state] if args.key?(:property_state) @solid_fill = args[:solid_fill] if args.key?(:solid_fill) end end # A location of a single table cell within a table. class TableCellLocation include Google::Apis::Core::Hashable # The 0-based column index. # Corresponds to the JSON property `columnIndex` # @return [Fixnum] attr_accessor :column_index # The 0-based row index. # Corresponds to the JSON property `rowIndex` # @return [Fixnum] attr_accessor :row_index def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_index = args[:column_index] if args.key?(:column_index) @row_index = args[:row_index] if args.key?(:row_index) end end # The properties of the TableCell. class TableCellProperties include Google::Apis::Core::Hashable # The alignment of the content in the table cell. The default alignment # matches the alignment for newly created table cells in the Slides editor. # Corresponds to the JSON property `contentAlignment` # @return [String] attr_accessor :content_alignment # The table cell background fill. # Corresponds to the JSON property `tableCellBackgroundFill` # @return [Google::Apis::SlidesV1::TableCellBackgroundFill] attr_accessor :table_cell_background_fill def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_alignment = args[:content_alignment] if args.key?(:content_alignment) @table_cell_background_fill = args[:table_cell_background_fill] if args.key?(:table_cell_background_fill) end end # Properties of each column in a table. class TableColumnProperties include Google::Apis::Core::Hashable # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `columnWidth` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :column_width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_width = args[:column_width] if args.key?(:column_width) end end # A table range represents a reference to a subset of a table. # It's important to note that the cells specified by a table range do not # necessarily form a rectangle. For example, let's say we have a 3 x 3 table # where all the cells of the last row are merged together. The table looks # like this: # # [ ] # A table range with location = (0, 0), row span = 3 and column span = 2 # specifies the following cells: # x x # [ x ] class TableRange include Google::Apis::Core::Hashable # The column span of the table range. # Corresponds to the JSON property `columnSpan` # @return [Fixnum] attr_accessor :column_span # A location of a single table cell within a table. # Corresponds to the JSON property `location` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :location # The row span of the table range. # Corresponds to the JSON property `rowSpan` # @return [Fixnum] attr_accessor :row_span def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_span = args[:column_span] if args.key?(:column_span) @location = args[:location] if args.key?(:location) @row_span = args[:row_span] if args.key?(:row_span) end end # Properties and contents of each row in a table. class TableRow include Google::Apis::Core::Hashable # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `rowHeight` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :row_height # Properties and contents of each cell. # Cells that span multiple columns are represented only once with a # column_span greater # than 1. As a result, the length of this collection does not always match # the number of columns of the entire table. # Corresponds to the JSON property `tableCells` # @return [Array] attr_accessor :table_cells # Properties of each row in a table. # Corresponds to the JSON property `tableRowProperties` # @return [Google::Apis::SlidesV1::TableRowProperties] attr_accessor :table_row_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @row_height = args[:row_height] if args.key?(:row_height) @table_cells = args[:table_cells] if args.key?(:table_cells) @table_row_properties = args[:table_row_properties] if args.key?(:table_row_properties) end end # Properties of each row in a table. class TableRowProperties include Google::Apis::Core::Hashable # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `minRowHeight` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :min_row_height def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @min_row_height = args[:min_row_height] if args.key?(:min_row_height) end end # The general text content. The text must reside in a compatible shape (e.g. # text box or rectangle) or a table cell in a page. class TextContent include Google::Apis::Core::Hashable # The bulleted lists contained in this text, keyed by list ID. # Corresponds to the JSON property `lists` # @return [Hash] attr_accessor :lists # The text contents broken down into its component parts, including styling # information. This property is read-only. # Corresponds to the JSON property `textElements` # @return [Array] attr_accessor :text_elements def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @lists = args[:lists] if args.key?(:lists) @text_elements = args[:text_elements] if args.key?(:text_elements) end end # A TextElement describes the content of a range of indices in the text content # of a Shape or TableCell. class TextElement include Google::Apis::Core::Hashable # A TextElement kind that represents auto text. # Corresponds to the JSON property `autoText` # @return [Google::Apis::SlidesV1::AutoText] attr_accessor :auto_text # The zero-based end index of this text element, exclusive, in Unicode code # units. # Corresponds to the JSON property `endIndex` # @return [Fixnum] attr_accessor :end_index # A TextElement kind that represents the beginning of a new paragraph. # Corresponds to the JSON property `paragraphMarker` # @return [Google::Apis::SlidesV1::ParagraphMarker] attr_accessor :paragraph_marker # The zero-based start index of this text element, in Unicode code units. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # A TextElement kind that represents a run of text that all has the same # styling. # Corresponds to the JSON property `textRun` # @return [Google::Apis::SlidesV1::TextRun] attr_accessor :text_run def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_text = args[:auto_text] if args.key?(:auto_text) @end_index = args[:end_index] if args.key?(:end_index) @paragraph_marker = args[:paragraph_marker] if args.key?(:paragraph_marker) @start_index = args[:start_index] if args.key?(:start_index) @text_run = args[:text_run] if args.key?(:text_run) end end # A TextElement kind that represents a run of text that all has the same # styling. class TextRun include Google::Apis::Core::Hashable # The text of this run. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # Represents the styling that can be applied to a TextRun. # If this text is contained in a shape with a parent placeholder, then these # text styles may be # inherited from the parent. Which text styles are inherited depend on the # nesting level of lists: # * A text run in a paragraph that is not in a list will inherit its text style # from the the newline character in the paragraph at the 0 nesting level of # the list inside the parent placeholder. # * A text run in a paragraph that is in a list will inherit its text style # from the newline character in the paragraph at its corresponding nesting # level of the list inside the parent placeholder. # Inherited text styles are represented as unset fields in this message. If # text is contained in a shape without a parent placeholder, unsetting these # fields will revert the style to a value matching the defaults in the Slides # editor. # Corresponds to the JSON property `style` # @return [Google::Apis::SlidesV1::TextStyle] attr_accessor :style def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content = args[:content] if args.key?(:content) @style = args[:style] if args.key?(:style) end end # Represents the styling that can be applied to a TextRun. # If this text is contained in a shape with a parent placeholder, then these # text styles may be # inherited from the parent. Which text styles are inherited depend on the # nesting level of lists: # * A text run in a paragraph that is not in a list will inherit its text style # from the the newline character in the paragraph at the 0 nesting level of # the list inside the parent placeholder. # * A text run in a paragraph that is in a list will inherit its text style # from the newline character in the paragraph at its corresponding nesting # level of the list inside the parent placeholder. # Inherited text styles are represented as unset fields in this message. If # text is contained in a shape without a parent placeholder, unsetting these # fields will revert the style to a value matching the defaults in the Slides # editor. class TextStyle include Google::Apis::Core::Hashable # A color that can either be fully opaque or fully transparent. # Corresponds to the JSON property `backgroundColor` # @return [Google::Apis::SlidesV1::OptionalColor] attr_accessor :background_color # The text's vertical offset from its normal position. # Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically # rendered in a smaller font size, computed based on the `font_size` field. # The `font_size` itself is not affected by changes in this field. # Corresponds to the JSON property `baselineOffset` # @return [String] attr_accessor :baseline_offset # Whether or not the text is rendered as bold. # Corresponds to the JSON property `bold` # @return [Boolean] attr_accessor :bold alias_method :bold?, :bold # The font family of the text. # The font family can be any font from the Font menu in Slides or from # [Google Fonts] (https://fonts.google.com/). If the font name is # unrecognized, the text is rendered in `Arial`. # Some fonts can affect the weight of the text. If an update request # specifies values for both `font_family` and `bold`, the explicitly-set # `bold` value is used. # Corresponds to the JSON property `fontFamily` # @return [String] attr_accessor :font_family # A magnitude in a single direction in the specified units. # Corresponds to the JSON property `fontSize` # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :font_size # A color that can either be fully opaque or fully transparent. # Corresponds to the JSON property `foregroundColor` # @return [Google::Apis::SlidesV1::OptionalColor] attr_accessor :foreground_color # Whether or not the text is italicized. # Corresponds to the JSON property `italic` # @return [Boolean] attr_accessor :italic alias_method :italic?, :italic # A hypertext link. # Corresponds to the JSON property `link` # @return [Google::Apis::SlidesV1::Link] attr_accessor :link # Whether or not the text is in small capital letters. # Corresponds to the JSON property `smallCaps` # @return [Boolean] attr_accessor :small_caps alias_method :small_caps?, :small_caps # Whether or not the text is struck through. # Corresponds to the JSON property `strikethrough` # @return [Boolean] attr_accessor :strikethrough alias_method :strikethrough?, :strikethrough # Whether or not the text is underlined. # Corresponds to the JSON property `underline` # @return [Boolean] attr_accessor :underline alias_method :underline?, :underline # Represents a font family and weight used to style a TextRun. # Corresponds to the JSON property `weightedFontFamily` # @return [Google::Apis::SlidesV1::WeightedFontFamily] attr_accessor :weighted_font_family def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @background_color = args[:background_color] if args.key?(:background_color) @baseline_offset = args[:baseline_offset] if args.key?(:baseline_offset) @bold = args[:bold] if args.key?(:bold) @font_family = args[:font_family] if args.key?(:font_family) @font_size = args[:font_size] if args.key?(:font_size) @foreground_color = args[:foreground_color] if args.key?(:foreground_color) @italic = args[:italic] if args.key?(:italic) @link = args[:link] if args.key?(:link) @small_caps = args[:small_caps] if args.key?(:small_caps) @strikethrough = args[:strikethrough] if args.key?(:strikethrough) @underline = args[:underline] if args.key?(:underline) @weighted_font_family = args[:weighted_font_family] if args.key?(:weighted_font_family) end end # A pair mapping a theme color type to the concrete color it represents. class ThemeColorPair include Google::Apis::Core::Hashable # An RGB color. # Corresponds to the JSON property `color` # @return [Google::Apis::SlidesV1::RgbColor] attr_accessor :color # The type of the theme color. # 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) @color = args[:color] if args.key?(:color) @type = args[:type] if args.key?(:type) end end # The thumbnail of a page. class Thumbnail include Google::Apis::Core::Hashable # The content URL of the thumbnail image. # The URL to the image has a default lifetime of 30 minutes. # This URL is tagged with the account of the requester. Anyone with the URL # effectively accesses the image as the original requester. Access to the # image may be lost if the presentation's sharing settings change. # The mime type of the thumbnail image is the same as specified in the # `GetPageThumbnailRequest`. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url # The positive height in pixels of the thumbnail image. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # The positive width in pixels of the thumbnail image. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_url = args[:content_url] if args.key?(:content_url) @height = args[:height] if args.key?(:height) @width = args[:width] if args.key?(:width) end end # Ungroups objects, such as groups. class UngroupObjectsRequest include Google::Apis::Core::Hashable # The object IDs of the objects to ungroup. # Only groups that are not inside other # groups can be ungrouped. All the groups # should be on the same page. The group itself is deleted. The visual sizes # and positions of all the children are preserved. # Corresponds to the JSON property `objectIds` # @return [Array] attr_accessor :object_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_ids = args[:object_ids] if args.key?(:object_ids) end end # Unmerges cells in a Table. class UnmergeTableCellsRequest include Google::Apis::Core::Hashable # The object ID of the table. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # A table range represents a reference to a subset of a table. # It's important to note that the cells specified by a table range do not # necessarily form a rectangle. For example, let's say we have a 3 x 3 table # where all the cells of the last row are merged together. The table looks # like this: # # [ ] # A table range with location = (0, 0), row span = 3 and column span = 2 # specifies the following cells: # x x # [ x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::SlidesV1::TableRange] attr_accessor :table_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @table_range = args[:table_range] if args.key?(:table_range) end end # Update the properties of an Image. class UpdateImagePropertiesRequest include Google::Apis::Core::Hashable # The fields that should be updated. # At least one field must be specified. The root `imageProperties` is # implied and should not be specified. A single `"*"` can be used as # short-hand for listing every field. # For example to update the image outline color, set `fields` to # `"outline.outlineFill.solidFill.color"`. # To reset a property to its default value, include its field name in the # field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The properties of the Image. # Corresponds to the JSON property `imageProperties` # @return [Google::Apis::SlidesV1::ImageProperties] attr_accessor :image_properties # The object ID of the image the updates are applied to. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fields = args[:fields] if args.key?(:fields) @image_properties = args[:image_properties] if args.key?(:image_properties) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # Updates the properties of a Line. class UpdateLinePropertiesRequest include Google::Apis::Core::Hashable # The fields that should be updated. # At least one field must be specified. The root `lineProperties` is # implied and should not be specified. A single `"*"` can be used as # short-hand for listing every field. # For example to update the line solid fill color, set `fields` to # `"lineFill.solidFill.color"`. # To reset a property to its default value, include its field name in the # field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The properties of the Line. # When unset, these fields default to values that match the appearance of # new lines created in the Slides editor. # Corresponds to the JSON property `lineProperties` # @return [Google::Apis::SlidesV1::LineProperties] attr_accessor :line_properties # The object ID of the line the update is applied to. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fields = args[:fields] if args.key?(:fields) @line_properties = args[:line_properties] if args.key?(:line_properties) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) end end # Updates the alt text title and/or description of a # page element. class UpdatePageElementAltTextRequest include Google::Apis::Core::Hashable # The updated alt text description of the page element. If unset the existing # value will be maintained. The description is exposed to screen readers # and other accessibility interfaces. Only use human readable values related # to the content of the page element. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The object ID of the page element the updates are applied to. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The updated alt text title of the page element. If unset the # existing value will be maintained. The title is exposed to screen readers # and other accessibility interfaces. Only use human readable values related # to the content of the page element. # 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) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @title = args[:title] if args.key?(:title) end end # Updates the transform of a page element. # Updating the transform of a group will change the absolute transform of the # page elements in that group, which can change their visual appearance. See # the documentation for PageElement.transform for more details. class UpdatePageElementTransformRequest include Google::Apis::Core::Hashable # The apply mode of the transform update. # Corresponds to the JSON property `applyMode` # @return [String] attr_accessor :apply_mode # The object ID of the page element to update. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # to transform source coordinates (x,y) into destination coordinates (x', y') # according to: # x' x = shear_y scale_y translate_y # 1 [ 1 ] # After transformation, # x' = scale_x * x + shear_x * y + translate_x; # y' = scale_y * y + shear_y * x + translate_y; # This message is therefore composed of these six matrix elements. # Corresponds to the JSON property `transform` # @return [Google::Apis::SlidesV1::AffineTransform] attr_accessor :transform def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @apply_mode = args[:apply_mode] if args.key?(:apply_mode) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @transform = args[:transform] if args.key?(:transform) end end # Updates the properties of a Page. class UpdatePagePropertiesRequest include Google::Apis::Core::Hashable # The fields that should be updated. # At least one field must be specified. The root `pageProperties` is # implied and should not be specified. A single `"*"` can be used as # short-hand for listing every field. # For example to update the page background solid fill color, set `fields` # to `"pageBackgroundFill.solidFill.color"`. # To reset a property to its default value, include its field name in the # field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The object ID of the page the update is applied to. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The properties of the Page. # The page will inherit properties from the parent page. Depending on the page # type the hierarchy is defined in either # SlideProperties or # LayoutProperties. # Corresponds to the JSON property `pageProperties` # @return [Google::Apis::SlidesV1::PageProperties] attr_accessor :page_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fields = args[:fields] if args.key?(:fields) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @page_properties = args[:page_properties] if args.key?(:page_properties) end end # Updates the styling for all of the paragraphs within a Shape or Table that # overlap with the given text index range. class UpdateParagraphStyleRequest include Google::Apis::Core::Hashable # A location of a single table cell within a table. # Corresponds to the JSON property `cellLocation` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location # The fields that should be updated. # At least one field must be specified. The root `style` is implied and # should not be specified. A single `"*"` can be used as short-hand for # listing every field. # For example, to update the paragraph alignment, set `fields` to # `"alignment"`. # To reset a property to its default value, include its field name in the # field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The object ID of the shape or table with the text to be styled. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # Styles that apply to a whole paragraph. # If this text is contained in a shape with a parent placeholder, then these # paragraph styles may be # inherited from the parent. Which paragraph styles are inherited depend on the # nesting level of lists: # * A paragraph not in a list will inherit its paragraph style from the # paragraph at the 0 nesting level of the list inside the parent placeholder. # * A paragraph in a list will inherit its paragraph style from the paragraph # at its corresponding nesting level of the list inside the parent # placeholder. # Inherited paragraph styles are represented as unset fields in this message. # Corresponds to the JSON property `style` # @return [Google::Apis::SlidesV1::ParagraphStyle] attr_accessor :style # Specifies a contiguous range of an indexed collection, such as characters in # text. # Corresponds to the JSON property `textRange` # @return [Google::Apis::SlidesV1::Range] attr_accessor :text_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cell_location = args[:cell_location] if args.key?(:cell_location) @fields = args[:fields] if args.key?(:fields) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @style = args[:style] if args.key?(:style) @text_range = args[:text_range] if args.key?(:text_range) end end # Update the properties of a Shape. class UpdateShapePropertiesRequest include Google::Apis::Core::Hashable # The fields that should be updated. # At least one field must be specified. The root `shapeProperties` is # implied and should not be specified. A single `"*"` can be used as # short-hand for listing every field. # For example to update the shape background solid fill color, set `fields` # to `"shapeBackgroundFill.solidFill.color"`. # To reset a property to its default value, include its field name in the # field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The object ID of the shape the updates are applied to. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The properties of a Shape. # If the shape is a placeholder shape as determined by the # placeholder field, then these # properties may be inherited from a parent placeholder shape. # Determining the rendered value of the property depends on the corresponding # property_state field value. # Corresponds to the JSON property `shapeProperties` # @return [Google::Apis::SlidesV1::ShapeProperties] attr_accessor :shape_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fields = args[:fields] if args.key?(:fields) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @shape_properties = args[:shape_properties] if args.key?(:shape_properties) end end # Updates the position of slides in the presentation. class UpdateSlidesPositionRequest include Google::Apis::Core::Hashable # The index where the slides should be inserted, based on the slide # arrangement before the move takes place. Must be between zero and the # number of slides in the presentation, inclusive. # Corresponds to the JSON property `insertionIndex` # @return [Fixnum] attr_accessor :insertion_index # The IDs of the slides in the presentation that should be moved. # The slides in this list must be in existing presentation order, without # duplicates. # Corresponds to the JSON property `slideObjectIds` # @return [Array] attr_accessor :slide_object_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @insertion_index = args[:insertion_index] if args.key?(:insertion_index) @slide_object_ids = args[:slide_object_ids] if args.key?(:slide_object_ids) end end # Updates the properties of the table borders in a Table. class UpdateTableBorderPropertiesRequest include Google::Apis::Core::Hashable # The border position in the table range the updates should apply to. If a # border position is not specified, the updates will apply to all borders in # the table range. # Corresponds to the JSON property `borderPosition` # @return [String] attr_accessor :border_position # The fields that should be updated. # At least one field must be specified. The root `tableBorderProperties` is # implied and should not be specified. A single `"*"` can be used as # short-hand for listing every field. # For example to update the table border solid fill color, set # `fields` to `"tableBorderFill.solidFill.color"`. # To reset a property to its default value, include its field name in the # field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The object ID of the table. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The border styling properties of the # TableBorderCell. # Corresponds to the JSON property `tableBorderProperties` # @return [Google::Apis::SlidesV1::TableBorderProperties] attr_accessor :table_border_properties # A table range represents a reference to a subset of a table. # It's important to note that the cells specified by a table range do not # necessarily form a rectangle. For example, let's say we have a 3 x 3 table # where all the cells of the last row are merged together. The table looks # like this: # # [ ] # A table range with location = (0, 0), row span = 3 and column span = 2 # specifies the following cells: # x x # [ x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::SlidesV1::TableRange] attr_accessor :table_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @border_position = args[:border_position] if args.key?(:border_position) @fields = args[:fields] if args.key?(:fields) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @table_border_properties = args[:table_border_properties] if args.key?(:table_border_properties) @table_range = args[:table_range] if args.key?(:table_range) end end # Update the properties of a TableCell. class UpdateTableCellPropertiesRequest include Google::Apis::Core::Hashable # The fields that should be updated. # At least one field must be specified. The root `tableCellProperties` is # implied and should not be specified. A single `"*"` can be used as # short-hand for listing every field. # For example to update the table cell background solid fill color, set # `fields` to `"tableCellBackgroundFill.solidFill.color"`. # To reset a property to its default value, include its field name in the # field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The object ID of the table. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The properties of the TableCell. # Corresponds to the JSON property `tableCellProperties` # @return [Google::Apis::SlidesV1::TableCellProperties] attr_accessor :table_cell_properties # A table range represents a reference to a subset of a table. # It's important to note that the cells specified by a table range do not # necessarily form a rectangle. For example, let's say we have a 3 x 3 table # where all the cells of the last row are merged together. The table looks # like this: # # [ ] # A table range with location = (0, 0), row span = 3 and column span = 2 # specifies the following cells: # x x # [ x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::SlidesV1::TableRange] attr_accessor :table_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fields = args[:fields] if args.key?(:fields) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @table_cell_properties = args[:table_cell_properties] if args.key?(:table_cell_properties) @table_range = args[:table_range] if args.key?(:table_range) end end # Updates the properties of a Table column. class UpdateTableColumnPropertiesRequest include Google::Apis::Core::Hashable # The list of zero-based indices specifying which columns to update. If no # indices are provided, all columns in the table will be updated. # Corresponds to the JSON property `columnIndices` # @return [Array] attr_accessor :column_indices # The fields that should be updated. # At least one field must be specified. The root `tableColumnProperties` is # implied and should not be specified. A single `"*"` can be used as # short-hand for listing every field. # For example to update the column width, set `fields` to `"column_width"`. # If '"column_width"' is included in the field mask but the property is left # unset, the column width will default to 406,400 EMU (32 points). # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The object ID of the table. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # Properties of each column in a table. # Corresponds to the JSON property `tableColumnProperties` # @return [Google::Apis::SlidesV1::TableColumnProperties] attr_accessor :table_column_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_indices = args[:column_indices] if args.key?(:column_indices) @fields = args[:fields] if args.key?(:fields) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @table_column_properties = args[:table_column_properties] if args.key?(:table_column_properties) end end # Updates the properties of a Table row. class UpdateTableRowPropertiesRequest include Google::Apis::Core::Hashable # The fields that should be updated. # At least one field must be specified. The root `tableRowProperties` is # implied and should not be specified. A single `"*"` can be used as # short-hand for listing every field. # For example to update the minimum row height, set `fields` to # `"min_row_height"`. # If '"min_row_height"' is included in the field mask but the property is # left unset, the minimum row height will default to 0. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The object ID of the table. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The list of zero-based indices specifying which rows to update. If no # indices are provided, all rows in the table will be updated. # Corresponds to the JSON property `rowIndices` # @return [Array] attr_accessor :row_indices # Properties of each row in a table. # Corresponds to the JSON property `tableRowProperties` # @return [Google::Apis::SlidesV1::TableRowProperties] attr_accessor :table_row_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fields = args[:fields] if args.key?(:fields) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @row_indices = args[:row_indices] if args.key?(:row_indices) @table_row_properties = args[:table_row_properties] if args.key?(:table_row_properties) end end # Update the styling of text in a Shape or # Table. class UpdateTextStyleRequest include Google::Apis::Core::Hashable # A location of a single table cell within a table. # Corresponds to the JSON property `cellLocation` # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location # The fields that should be updated. # At least one field must be specified. The root `style` is implied and # should not be specified. A single `"*"` can be used as short-hand for # listing every field. # For example, to update the text style to bold, set `fields` to `"bold"`. # To reset a property to its default value, include its field name in the # field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The object ID of the shape or table with the text to be styled. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # Represents the styling that can be applied to a TextRun. # If this text is contained in a shape with a parent placeholder, then these # text styles may be # inherited from the parent. Which text styles are inherited depend on the # nesting level of lists: # * A text run in a paragraph that is not in a list will inherit its text style # from the the newline character in the paragraph at the 0 nesting level of # the list inside the parent placeholder. # * A text run in a paragraph that is in a list will inherit its text style # from the newline character in the paragraph at its corresponding nesting # level of the list inside the parent placeholder. # Inherited text styles are represented as unset fields in this message. If # text is contained in a shape without a parent placeholder, unsetting these # fields will revert the style to a value matching the defaults in the Slides # editor. # Corresponds to the JSON property `style` # @return [Google::Apis::SlidesV1::TextStyle] attr_accessor :style # Specifies a contiguous range of an indexed collection, such as characters in # text. # Corresponds to the JSON property `textRange` # @return [Google::Apis::SlidesV1::Range] attr_accessor :text_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cell_location = args[:cell_location] if args.key?(:cell_location) @fields = args[:fields] if args.key?(:fields) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @style = args[:style] if args.key?(:style) @text_range = args[:text_range] if args.key?(:text_range) end end # Update the properties of a Video. class UpdateVideoPropertiesRequest include Google::Apis::Core::Hashable # The fields that should be updated. # At least one field must be specified. The root `videoProperties` is # implied and should not be specified. A single `"*"` can be used as # short-hand for listing every field. # For example to update the video outline color, set `fields` to # `"outline.outlineFill.solidFill.color"`. # To reset a property to its default value, include its field name in the # field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields # The object ID of the video the updates are applied to. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # The properties of the Video. # Corresponds to the JSON property `videoProperties` # @return [Google::Apis::SlidesV1::VideoProperties] attr_accessor :video_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fields = args[:fields] if args.key?(:fields) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @video_properties = args[:video_properties] if args.key?(:video_properties) end end # A PageElement kind representing a # video. class Video include Google::Apis::Core::Hashable # The video source's unique identifier for this video. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The video source. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source # An URL to a video. The URL is valid as long as the source video # exists and sharing settings do not change. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The properties of the Video. # Corresponds to the JSON property `videoProperties` # @return [Google::Apis::SlidesV1::VideoProperties] attr_accessor :video_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @source = args[:source] if args.key?(:source) @url = args[:url] if args.key?(:url) @video_properties = args[:video_properties] if args.key?(:video_properties) end end # The properties of the Video. class VideoProperties include Google::Apis::Core::Hashable # The outline of a PageElement. # If these fields are unset, they may be inherited from a parent placeholder # if it exists. If there is no parent, the fields will default to the value # used for new page elements created in the Slides editor, which may depend on # the page element kind. # Corresponds to the JSON property `outline` # @return [Google::Apis::SlidesV1::Outline] attr_accessor :outline def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @outline = args[:outline] if args.key?(:outline) end end # Represents a font family and weight used to style a TextRun. class WeightedFontFamily include Google::Apis::Core::Hashable # The font family of the text. # The font family can be any font from the Font menu in Slides or from # [Google Fonts] (https://fonts.google.com/). If the font name is # unrecognized, the text is rendered in `Arial`. # Corresponds to the JSON property `fontFamily` # @return [String] attr_accessor :font_family # The rendered weight of the text. This field can have any value that is a # multiple of `100` between `100` and `900`, inclusive. This range # corresponds to the numerical values described in the CSS 2.1 # Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font- # boldness), # with non-numerical values disallowed. Weights greater than or equal to # `700` are considered bold, and weights less than `700`are not bold. The # default value is `400` ("normal"). # Corresponds to the JSON property `weight` # @return [Fixnum] attr_accessor :weight def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @font_family = args[:font_family] if args.key?(:font_family) @weight = args[:weight] if args.key?(:weight) end end # A PageElement kind representing # word art. class WordArt include Google::Apis::Core::Hashable # The text rendered as word art. # Corresponds to the JSON property `renderedText` # @return [String] attr_accessor :rendered_text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @rendered_text = args[:rendered_text] if args.key?(:rendered_text) end end # Provides control over how write requests are executed. class WriteControl include Google::Apis::Core::Hashable # The revision ID of the presentation required for the write request. If # specified and the `required_revision_id` doesn't exactly match the # presentation's current `revision_id`, the request will not be processed and # will return a 400 bad request error. # Corresponds to the JSON property `requiredRevisionId` # @return [String] attr_accessor :required_revision_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @required_revision_id = args[:required_revision_id] if args.key?(:required_revision_id) end end end end end google-api-client-0.19.8/generated/google/apis/slides_v1/service.rb0000644000004100000410000003374513252673044025206 0ustar www-datawww-data# 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 SlidesV1 # Google Slides API # # An API for creating and editing Google Slides presentations. # # @example # require 'google/apis/slides_v1' # # Slides = Google::Apis::SlidesV1 # Alias the module # service = Slides::SlidesService.new # # @see https://developers.google.com/slides/ class SlidesService < 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://slides.googleapis.com/', '') @batch_path = 'batch' end # Applies one or more updates to the presentation. # Each request is validated before # being applied. If any request is not valid, then the entire request will # fail and nothing will be applied. # Some requests have replies to # give you some information about how they are applied. Other requests do # not need to return information; these each return an empty reply. # The order of replies matches that of the requests. # For example, suppose you call batchUpdate with four updates, and only the # third one returns information. The response would have two empty replies: # the reply to the third request, and another empty reply, in that order. # Because other users may be editing the presentation, the presentation # might not exactly reflect your changes: your changes may # be altered with respect to collaborator changes. If there are no # collaborators, the presentation should reflect your changes. In any case, # the updates in your request are guaranteed to be applied together # atomically. # @param [String] presentation_id # The presentation to apply the updates to. # @param [Google::Apis::SlidesV1::BatchUpdatePresentationRequest] batch_update_presentation_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::SlidesV1::BatchUpdatePresentationResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SlidesV1::BatchUpdatePresentationResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_update_presentation(presentation_id, batch_update_presentation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/presentations/{presentationId}:batchUpdate', options) command.request_representation = Google::Apis::SlidesV1::BatchUpdatePresentationRequest::Representation command.request_object = batch_update_presentation_request_object command.response_representation = Google::Apis::SlidesV1::BatchUpdatePresentationResponse::Representation command.response_class = Google::Apis::SlidesV1::BatchUpdatePresentationResponse command.params['presentationId'] = presentation_id unless presentation_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 presentation using the title given in the request. Other # fields in the request are ignored. # Returns the created presentation. # @param [Google::Apis::SlidesV1::Presentation] presentation_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::SlidesV1::Presentation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SlidesV1::Presentation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_presentation(presentation_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/presentations', options) command.request_representation = Google::Apis::SlidesV1::Presentation::Representation command.request_object = presentation_object command.response_representation = Google::Apis::SlidesV1::Presentation::Representation command.response_class = Google::Apis::SlidesV1::Presentation 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 version of the specified presentation. # @param [String] presentation_id # The ID of the presentation to retrieve. # @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::SlidesV1::Presentation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SlidesV1::Presentation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_presentation(presentation_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/presentations/{+presentationId}', options) command.response_representation = Google::Apis::SlidesV1::Presentation::Representation command.response_class = Google::Apis::SlidesV1::Presentation command.params['presentationId'] = presentation_id unless presentation_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 the latest version of the specified page in the presentation. # @param [String] presentation_id # The ID of the presentation to retrieve. # @param [String] page_object_id # The object ID of the page to retrieve. # @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::SlidesV1::Page] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SlidesV1::Page] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_presentation_page(presentation_id, page_object_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/presentations/{presentationId}/pages/{pageObjectId}', options) command.response_representation = Google::Apis::SlidesV1::Page::Representation command.response_class = Google::Apis::SlidesV1::Page command.params['presentationId'] = presentation_id unless presentation_id.nil? command.params['pageObjectId'] = page_object_id unless page_object_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 # Generates a thumbnail of the latest version of the specified page in the # presentation and returns a URL to the thumbnail image. # This request counts as an [expensive read request](/slides/limits) for # quota purposes. # @param [String] presentation_id # The ID of the presentation to retrieve. # @param [String] page_object_id # The object ID of the page whose thumbnail to retrieve. # @param [String] thumbnail_properties_mime_type # The optional mime type of the thumbnail image. # If you don't specify the mime type, the default mime type will be PNG. # @param [String] thumbnail_properties_thumbnail_size # The optional thumbnail image size. # If you don't specify the size, the server chooses a default size of the # image. # @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::SlidesV1::Thumbnail] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SlidesV1::Thumbnail] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_presentation_page_thumbnail(presentation_id, page_object_id, thumbnail_properties_mime_type: nil, thumbnail_properties_thumbnail_size: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail', options) command.response_representation = Google::Apis::SlidesV1::Thumbnail::Representation command.response_class = Google::Apis::SlidesV1::Thumbnail command.params['presentationId'] = presentation_id unless presentation_id.nil? command.params['pageObjectId'] = page_object_id unless page_object_id.nil? command.query['thumbnailProperties.mimeType'] = thumbnail_properties_mime_type unless thumbnail_properties_mime_type.nil? command.query['thumbnailProperties.thumbnailSize'] = thumbnail_properties_thumbnail_size unless thumbnail_properties_thumbnail_size.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 google-api-client-0.19.8/generated/google/apis/sourcerepo_v1.rb0000644000004100000410000000306113252673044024435 0ustar www-datawww-data# 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/sourcerepo_v1/service.rb' require 'google/apis/sourcerepo_v1/classes.rb' require 'google/apis/sourcerepo_v1/representations.rb' module Google module Apis # Cloud Source Repositories API # # Access source code repositories hosted by Google. # # @see https://cloud.google.com/source-repositories/docs/apis module SourcerepoV1 VERSION = 'V1' REVISION = '20171215' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # Manage your source code repositories AUTH_SOURCE_FULL_CONTROL = 'https://www.googleapis.com/auth/source.full_control' # View the contents of your source code repositories AUTH_SOURCE_READ_ONLY = 'https://www.googleapis.com/auth/source.read_only' # Manage the contents of your source code repositories AUTH_SOURCE_READ_WRITE = 'https://www.googleapis.com/auth/source.read_write' end end end google-api-client-0.19.8/generated/google/apis/blogger_v2.rb0000644000004100000410000000210413252673043023665 0ustar www-datawww-data# 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/blogger_v2/service.rb' require 'google/apis/blogger_v2/classes.rb' require 'google/apis/blogger_v2/representations.rb' module Google module Apis # Blogger API # # API for access to the data within Blogger. # # @see https://developers.google.com/blogger/docs/2.0/json/getting_started module BloggerV2 VERSION = 'V2' REVISION = '20150422' # Manage your Blogger account AUTH_BLOGGER = 'https://www.googleapis.com/auth/blogger' end end end google-api-client-0.19.8/generated/google/apis/cloudfunctions_v1beta2/0000755000004100000410000000000013252673043025676 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/cloudfunctions_v1beta2/representations.rb0000644000004100000410000002676613252673043031471 0ustar www-datawww-data# 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 CloudfunctionsV1beta2 class CallFunctionRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CallFunctionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CloudFunction class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventTrigger class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FailurePolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GenerateDownloadUrlRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GenerateDownloadUrlResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GenerateUploadUrlRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GenerateUploadUrlResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpsTrigger class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListFunctionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLocationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Location 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 OperationMetadataV1 class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperationMetadataV1Beta2 class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Retry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SourceRepository 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 CallFunctionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, as: 'data' end end class CallFunctionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :error, as: 'error' property :execution_id, as: 'executionId' property :result, as: 'result' end end class CloudFunction # @private class Representation < Google::Apis::Core::JsonRepresentation property :available_memory_mb, as: 'availableMemoryMb' property :entry_point, as: 'entryPoint' property :event_trigger, as: 'eventTrigger', class: Google::Apis::CloudfunctionsV1beta2::EventTrigger, decorator: Google::Apis::CloudfunctionsV1beta2::EventTrigger::Representation property :https_trigger, as: 'httpsTrigger', class: Google::Apis::CloudfunctionsV1beta2::HttpsTrigger, decorator: Google::Apis::CloudfunctionsV1beta2::HttpsTrigger::Representation hash :labels, as: 'labels' property :latest_operation, as: 'latestOperation' property :name, as: 'name' property :service_account, as: 'serviceAccount' property :source_archive_url, as: 'sourceArchiveUrl' property :source_repository, as: 'sourceRepository', class: Google::Apis::CloudfunctionsV1beta2::SourceRepository, decorator: Google::Apis::CloudfunctionsV1beta2::SourceRepository::Representation property :source_repository_url, as: 'sourceRepositoryUrl' property :source_upload_url, as: 'sourceUploadUrl' property :status, as: 'status' property :timeout, as: 'timeout' property :update_time, as: 'updateTime' property :version_id, :numeric_string => true, as: 'versionId' end end class EventTrigger # @private class Representation < Google::Apis::Core::JsonRepresentation property :event_type, as: 'eventType' property :failure_policy, as: 'failurePolicy', class: Google::Apis::CloudfunctionsV1beta2::FailurePolicy, decorator: Google::Apis::CloudfunctionsV1beta2::FailurePolicy::Representation property :resource, as: 'resource' property :service, as: 'service' end end class FailurePolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :retry, as: 'retry', class: Google::Apis::CloudfunctionsV1beta2::Retry, decorator: Google::Apis::CloudfunctionsV1beta2::Retry::Representation end end class GenerateDownloadUrlRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :version_id, :numeric_string => true, as: 'versionId' end end class GenerateDownloadUrlResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :download_url, as: 'downloadUrl' end end class GenerateUploadUrlRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GenerateUploadUrlResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :upload_url, as: 'uploadUrl' end end class HttpsTrigger # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class ListFunctionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :functions, as: 'functions', class: Google::Apis::CloudfunctionsV1beta2::CloudFunction, decorator: Google::Apis::CloudfunctionsV1beta2::CloudFunction::Representation property :next_page_token, as: 'nextPageToken' end end class ListLocationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :locations, as: 'locations', class: Google::Apis::CloudfunctionsV1beta2::Location, decorator: Google::Apis::CloudfunctionsV1beta2::Location::Representation property :next_page_token, as: 'nextPageToken' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::CloudfunctionsV1beta2::Operation, decorator: Google::Apis::CloudfunctionsV1beta2::Operation::Representation end end class Location # @private class Representation < Google::Apis::Core::JsonRepresentation hash :labels, as: 'labels' property :location_id, as: 'locationId' hash :metadata, as: 'metadata' property :name, as: 'name' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::CloudfunctionsV1beta2::Status, decorator: Google::Apis::CloudfunctionsV1beta2::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class OperationMetadataV1 # @private class Representation < Google::Apis::Core::JsonRepresentation hash :request, as: 'request' property :target, as: 'target' property :type, as: 'type' property :update_time, as: 'updateTime' property :version_id, :numeric_string => true, as: 'versionId' end end class OperationMetadataV1Beta2 # @private class Representation < Google::Apis::Core::JsonRepresentation hash :request, as: 'request' property :target, as: 'target' property :type, as: 'type' property :update_time, as: 'updateTime' property :version_id, :numeric_string => true, as: 'versionId' end end class Retry # @private class Representation < Google::Apis::Core::JsonRepresentation end end class SourceRepository # @private class Representation < Google::Apis::Core::JsonRepresentation property :branch, as: 'branch' property :deployed_revision, as: 'deployedRevision' property :repository_url, as: 'repositoryUrl' property :revision, as: 'revision' property :source_path, as: 'sourcePath' property :tag, as: 'tag' 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 google-api-client-0.19.8/generated/google/apis/cloudfunctions_v1beta2/classes.rb0000644000004100000410000010516413252673043027667 0ustar www-datawww-data# 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 CloudfunctionsV1beta2 # Request for the `CallFunction` method. class CallFunctionRequest include Google::Apis::Core::Hashable # Input to be passed to the function. # Corresponds to the JSON property `data` # @return [String] 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 # Response of `CallFunction` method. class CallFunctionResponse include Google::Apis::Core::Hashable # Either system or user-function generated error. Set if execution # was not successful. # Corresponds to the JSON property `error` # @return [String] attr_accessor :error # Execution id of function invocation. # Corresponds to the JSON property `executionId` # @return [String] attr_accessor :execution_id # Result populated for successful execution of synchronous function. Will # not be populated if function does not return a result through context. # Corresponds to the JSON property `result` # @return [String] attr_accessor :result def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error = args[:error] if args.key?(:error) @execution_id = args[:execution_id] if args.key?(:execution_id) @result = args[:result] if args.key?(:result) end end # Describes a Cloud Function that contains user computation executed in # response to an event. It encapsulate function and triggers configurations. class CloudFunction include Google::Apis::Core::Hashable # The amount of memory in MB available for a function. # Defaults to 256MB. # Corresponds to the JSON property `availableMemoryMb` # @return [Fixnum] attr_accessor :available_memory_mb # The name of the function (as defined in source code) that will be # executed. Defaults to the resource name suffix, if not specified. For # backward compatibility, if function with given name is not found, then the # system will try to use function named "function". # For Node.js this is name of a function exported by the module specified # in `source_location`. # Corresponds to the JSON property `entryPoint` # @return [String] attr_accessor :entry_point # Describes EventTrigger, used to request events be sent from another # service. # Corresponds to the JSON property `eventTrigger` # @return [Google::Apis::CloudfunctionsV1beta2::EventTrigger] attr_accessor :event_trigger # Describes HTTPSTrigger, could be used to connect web hooks to function. # Corresponds to the JSON property `httpsTrigger` # @return [Google::Apis::CloudfunctionsV1beta2::HttpsTrigger] attr_accessor :https_trigger # Labels associated with this Cloud Function. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Output only. Name of the most recent operation modifying the function. If # the function status is `DEPLOYING` or `DELETING`, then it points to the # active operation. # Corresponds to the JSON property `latestOperation` # @return [String] attr_accessor :latest_operation # A user-defined name of the function. Function names must be unique # globally and match pattern `projects/*/locations/*/functions/*` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The service account of the function. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account # The Google Cloud Storage URL, starting with gs://, pointing to the zip # archive which contains the function. # Corresponds to the JSON property `sourceArchiveUrl` # @return [String] attr_accessor :source_archive_url # Describes the location of the function source in a remote repository. # Corresponds to the JSON property `sourceRepository` # @return [Google::Apis::CloudfunctionsV1beta2::SourceRepository] attr_accessor :source_repository # The URL pointing to the hosted repository where the function is defined. # There are supported Cloud Source Repository URLs in the following # formats: # To refer to a specific commit: # `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` # To refer to a moveable alias (branch): # `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/ # paths/*` # In particular, to refer to HEAD use `master` moveable alias. # To refer to a specific fixed alias (tag): # `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/ # *` # You may omit `paths/*` if you want to use the main directory. # Corresponds to the JSON property `sourceRepositoryUrl` # @return [String] attr_accessor :source_repository_url # The Google Cloud Storage signed URL used for source uploading, generated # by google.cloud.functions.v1beta2.GenerateUploadUrl # Corresponds to the JSON property `sourceUploadUrl` # @return [String] attr_accessor :source_upload_url # Output only. Status of the function deployment. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The function execution timeout. Execution is considered failed and # can be terminated if the function is not completed at the end of the # timeout period. Defaults to 60 seconds. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout # Output only. The last update timestamp of a Cloud Function. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Output only. # The version identifier of the Cloud Function. Each deployment attempt # results in a new version of a function being created. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @available_memory_mb = args[:available_memory_mb] if args.key?(:available_memory_mb) @entry_point = args[:entry_point] if args.key?(:entry_point) @event_trigger = args[:event_trigger] if args.key?(:event_trigger) @https_trigger = args[:https_trigger] if args.key?(:https_trigger) @labels = args[:labels] if args.key?(:labels) @latest_operation = args[:latest_operation] if args.key?(:latest_operation) @name = args[:name] if args.key?(:name) @service_account = args[:service_account] if args.key?(:service_account) @source_archive_url = args[:source_archive_url] if args.key?(:source_archive_url) @source_repository = args[:source_repository] if args.key?(:source_repository) @source_repository_url = args[:source_repository_url] if args.key?(:source_repository_url) @source_upload_url = args[:source_upload_url] if args.key?(:source_upload_url) @status = args[:status] if args.key?(:status) @timeout = args[:timeout] if args.key?(:timeout) @update_time = args[:update_time] if args.key?(:update_time) @version_id = args[:version_id] if args.key?(:version_id) end end # Describes EventTrigger, used to request events be sent from another # service. class EventTrigger include Google::Apis::Core::Hashable # `event_type` names contain the service that is sending an event and the # kind of event that was fired. Must be of the form # `providers/*/eventTypes/*` e.g. Directly handle a Message published to # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`. # Handle an object changing in Google Cloud Storage: # `providers/cloud.storage/eventTypes/object.change` # Handle a write to the Firebase Realtime Database: # `providers/google.firebase.database/eventTypes/ref.write` # Corresponds to the JSON property `eventType` # @return [String] attr_accessor :event_type # Describes the policy in case of function's execution failure. # If empty, then defaults to ignoring failures (i.e. not retrying them). # Corresponds to the JSON property `failurePolicy` # @return [Google::Apis::CloudfunctionsV1beta2::FailurePolicy] attr_accessor :failure_policy # Which instance of the source's service should send events. E.g. for Pub/Sub # this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud # Storage this would be a bucket at `projects/*/buckets/*`. For any source # that only supports one instance per-project, this should be the name of the # project (`projects/*`) # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource # The hostname of the service that should be observed. # If no string is provided, the default service implementing the API will # be used. For example, `storage.googleapis.com` is the default for all # event types in the `google.storage` namespace. # 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) @event_type = args[:event_type] if args.key?(:event_type) @failure_policy = args[:failure_policy] if args.key?(:failure_policy) @resource = args[:resource] if args.key?(:resource) @service = args[:service] if args.key?(:service) end end # Describes the policy in case of function's execution failure. # If empty, then defaults to ignoring failures (i.e. not retrying them). class FailurePolicy include Google::Apis::Core::Hashable # Describes the retry policy in case of function's execution failure. # A function execution will be retried on any failure. # A failed execution will be retried up to 7 days with an exponential backoff # (capped at 10 seconds). # Retried execution is charged as any other execution. # Corresponds to the JSON property `retry` # @return [Google::Apis::CloudfunctionsV1beta2::Retry] attr_accessor :retry def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @retry = args[:retry] if args.key?(:retry) end end # Request of `GenerateDownloadUrl` method. class GenerateDownloadUrlRequest include Google::Apis::Core::Hashable # The optional version of function. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @version_id = args[:version_id] if args.key?(:version_id) end end # Response of `GenerateDownloadUrl` method. class GenerateDownloadUrlResponse include Google::Apis::Core::Hashable # The generated Google Cloud Storage signed URL that should be used for # function source code download. # Corresponds to the JSON property `downloadUrl` # @return [String] attr_accessor :download_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @download_url = args[:download_url] if args.key?(:download_url) end end # Request of `GenerateUploadUrl` method. class GenerateUploadUrlRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Response of `GenerateUploadUrl` method. class GenerateUploadUrlResponse include Google::Apis::Core::Hashable # The generated Google Cloud Storage signed URL that should be used for a # function source code upload. The uploaded file should be a zip archive # which contains a function. # Corresponds to the JSON property `uploadUrl` # @return [String] attr_accessor :upload_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @upload_url = args[:upload_url] if args.key?(:upload_url) end end # Describes HTTPSTrigger, could be used to connect web hooks to function. class HttpsTrigger include Google::Apis::Core::Hashable # Output only. The deployed url for the function. # 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 # Response for the `ListFunctions` method. class ListFunctionsResponse include Google::Apis::Core::Hashable # The functions that match the request. # Corresponds to the JSON property `functions` # @return [Array] attr_accessor :functions # If not empty, indicates that there may be more functions that match # the request; this value should be passed in a new # google.cloud.functions.v1beta2.ListFunctionsRequest # to get more functions. # 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) @functions = args[:functions] if args.key?(:functions) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Locations.ListLocations. class ListLocationsResponse include Google::Apis::Core::Hashable # A list of locations that matches the specified filter in the request. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # The standard List next-page token. # 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) @locations = args[:locations] if args.key?(:locations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Operations.ListOperations. class ListOperationsResponse 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 # A resource that represents Google Cloud Platform location. class Location include Google::Apis::Core::Hashable # Cross-service attributes for the location. For example # `"cloud.googleapis.com/region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The canonical id for this location. For example: `"us-east1"`. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Service-specific metadata. For example the available capacity at the given # location. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # Resource name for the location, which may vary between implementations. # For example: `"projects/example-project/locations/us-east1"` # 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) @labels = args[:labels] if args.key?(:labels) @location_id = args[:location_id] if args.key?(:location_id) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::CloudfunctionsV1beta2::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 have the format of `operations/some/unique/name`. # 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 # Metadata describing an Operation class OperationMetadataV1 include Google::Apis::Core::Hashable # The original request that started the operation. # Corresponds to the JSON property `request` # @return [Hash] attr_accessor :request # Target of the operation - for example # projects/project-1/locations/region-1/functions/function-1 # Corresponds to the JSON property `target` # @return [String] attr_accessor :target # Type of operation. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The last update timestamp of the operation. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Version id of the function created or updated by an API call. # This field is only pupulated for Create and Update operations. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @request = args[:request] if args.key?(:request) @target = args[:target] if args.key?(:target) @type = args[:type] if args.key?(:type) @update_time = args[:update_time] if args.key?(:update_time) @version_id = args[:version_id] if args.key?(:version_id) end end # Metadata describing an Operation class OperationMetadataV1Beta2 include Google::Apis::Core::Hashable # The original request that started the operation. # Corresponds to the JSON property `request` # @return [Hash] attr_accessor :request # Target of the operation - for example # projects/project-1/locations/region-1/functions/function-1 # Corresponds to the JSON property `target` # @return [String] attr_accessor :target # Type of operation. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The last update timestamp of the operation. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Version id of the function created or updated by an API call. # This field is only pupulated for Create and Update operations. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @request = args[:request] if args.key?(:request) @target = args[:target] if args.key?(:target) @type = args[:type] if args.key?(:type) @update_time = args[:update_time] if args.key?(:update_time) @version_id = args[:version_id] if args.key?(:version_id) end end # Describes the retry policy in case of function's execution failure. # A function execution will be retried on any failure. # A failed execution will be retried up to 7 days with an exponential backoff # (capped at 10 seconds). # Retried execution is charged as any other execution. class Retry include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Describes the location of the function source in a remote repository. class SourceRepository include Google::Apis::Core::Hashable # The name of the branch from which the function should be fetched. # Corresponds to the JSON property `branch` # @return [String] attr_accessor :branch # Output only. The id of the revision that was resolved at the moment of # function creation or update. For example when a user deployed from a # branch, it will be the revision id of the latest change on this branch at # that time. If user deployed from revision then this value will be always # equal to the revision specified by the user. # Corresponds to the JSON property `deployedRevision` # @return [String] attr_accessor :deployed_revision # URL to the hosted repository where the function is defined. Only paths in # https://source.developers.google.com domain are supported. The path should # contain the name of the repository. # Corresponds to the JSON property `repositoryUrl` # @return [String] attr_accessor :repository_url # The id of the revision that captures the state of the repository from # which the function should be fetched. # Corresponds to the JSON property `revision` # @return [String] attr_accessor :revision # The path within the repository where the function is defined. The path # should point to the directory where Cloud Functions files are located. Use # "/" if the function is defined directly in the root directory of a # repository. # Corresponds to the JSON property `sourcePath` # @return [String] attr_accessor :source_path # The name of the tag that captures the state of the repository from # which the function should be fetched. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @branch = args[:branch] if args.key?(:branch) @deployed_revision = args[:deployed_revision] if args.key?(:deployed_revision) @repository_url = args[:repository_url] if args.key?(:repository_url) @revision = args[:revision] if args.key?(:revision) @source_path = args[:source_path] if args.key?(:source_path) @tag = args[:tag] if args.key?(:tag) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 google-api-client-0.19.8/generated/google/apis/cloudfunctions_v1beta2/service.rb0000644000004100000410000006733713252673043027703 0ustar www-datawww-data# 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 CloudfunctionsV1beta2 # Google Cloud Functions API # # API for managing lightweight user-provided functions executed in response to # events. # # @example # require 'google/apis/cloudfunctions_v1beta2' # # Cloudfunctions = Google::Apis::CloudfunctionsV1beta2 # Alias the module # service = Cloudfunctions::CloudFunctionsService.new # # @see https://cloud.google.com/functions class CloudFunctionsService < 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://cloudfunctions.googleapis.com/', '') @batch_path = 'batch' 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::CloudfunctionsV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::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_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::CloudfunctionsV1beta2::Operation::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::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 # 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] filter # The standard list filter. # @param [String] name # The name of the operation's parent resource. # @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::CloudfunctionsV1beta2::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/operations', options) command.response_representation = Google::Apis::CloudfunctionsV1beta2::ListOperationsResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::ListOperationsResponse command.query['filter'] = filter unless filter.nil? command.query['name'] = name unless 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 # Lists information about the supported locations for this service. # @param [String] name # The resource that owns the locations collection, if applicable. # @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::CloudfunctionsV1beta2::ListLocationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::ListLocationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+name}/locations', options) command.response_representation = Google::Apis::CloudfunctionsV1beta2::ListLocationsResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::ListLocationsResponse 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 # Invokes synchronously deployed function. To be used for testing, very # limited traffic allowed. # @param [String] name # The name of the function to be called. # @param [Google::Apis::CloudfunctionsV1beta2::CallFunctionRequest] call_function_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::CloudfunctionsV1beta2::CallFunctionResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::CallFunctionResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def call_function(name, call_function_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+name}:call', options) command.request_representation = Google::Apis::CloudfunctionsV1beta2::CallFunctionRequest::Representation command.request_object = call_function_request_object command.response_representation = Google::Apis::CloudfunctionsV1beta2::CallFunctionResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::CallFunctionResponse 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 new function. If a function with the given name already exists in # the specified project, the long running operation will return # `ALREADY_EXISTS` error. # @param [String] location # The project and location in which the function should be created, specified # in the format `projects/*/locations/*` # @param [Google::Apis::CloudfunctionsV1beta2::CloudFunction] cloud_function_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::CloudfunctionsV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::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_location_function(location, cloud_function_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+location}/functions', options) command.request_representation = Google::Apis::CloudfunctionsV1beta2::CloudFunction::Representation command.request_object = cloud_function_object command.response_representation = Google::Apis::CloudfunctionsV1beta2::Operation::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::Operation command.params['location'] = location unless location.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 function with the given name from the specified project. If the # given function is used by some trigger, the trigger will be updated to # remove this function. # @param [String] name # The name of the function which should 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::CloudfunctionsV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::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_project_location_function(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::CloudfunctionsV1beta2::Operation::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::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 # Returns a signed URL for downloading deployed function source code. # The URL is only valid for a limited period and should be used within # minutes after generation. # For more information about the signed URL usage see: # https://cloud.google.com/storage/docs/access-control/signed-urls # @param [String] name # The name of function for which source code Google Cloud Storage signed # URL should be generated. # @param [Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlRequest] generate_download_url_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::CloudfunctionsV1beta2::GenerateDownloadUrlResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_function_download_url(name, generate_download_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+name}:generateDownloadUrl', options) command.request_representation = Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlRequest::Representation command.request_object = generate_download_url_request_object command.response_representation = Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlResponse 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 signed URL for uploading a function source code. # For more information about the signed URL usage see: # https://cloud.google.com/storage/docs/access-control/signed-urls # Once the function source code upload is complete, the used signed # URL should be provided in CreateFunction or UpdateFunction request # as a reference to the function source code. # When uploading source code to the generated signed URL, please follow # these restrictions: # * Source file type should be a zip file. # * Source file size should not exceed 100MB limit. # When making a HTTP PUT request, these two headers need to be specified: # * `content-type: application/zip` # * `x-google-content-length-range: 0,104857600` # @param [String] parent # The project and location in which the Google Cloud Storage signed URL # should be generated, specified in the format `projects/*/locations/*`. # @param [Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlRequest] generate_upload_url_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::CloudfunctionsV1beta2::GenerateUploadUrlResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_function_upload_url(parent, generate_upload_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+parent}/functions:generateUploadUrl', options) command.request_representation = Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlRequest::Representation command.request_object = generate_upload_url_request_object command.response_representation = Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlResponse 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 # Returns a function with the given name from the requested project. # @param [String] name # The name of the function which details should be obtained. # @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::CloudfunctionsV1beta2::CloudFunction] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::CloudFunction] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_function(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::CloudfunctionsV1beta2::CloudFunction::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::CloudFunction 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 functions that belong to the requested project. # @param [String] location # The project and location from which the function should be listed, # specified in the format `projects/*/locations/*` # If you want to list functions in all locations, use "-" in place of a # location. # @param [Fixnum] page_size # Maximum number of functions to return per call. # @param [String] page_token # The value returned by the last # `ListFunctionsResponse`; indicates that # this is a continuation of a prior `ListFunctions` call, and that the # system should return the next page of data. # @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::CloudfunctionsV1beta2::ListFunctionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::ListFunctionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_functions(location, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+location}/functions', options) command.response_representation = Google::Apis::CloudfunctionsV1beta2::ListFunctionsResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::ListFunctionsResponse command.params['location'] = location unless location.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 existing function. # @param [String] name # The name of the function to be updated. # @param [Google::Apis::CloudfunctionsV1beta2::CloudFunction] cloud_function_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::CloudfunctionsV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1beta2::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 update_project_location_function(name, cloud_function_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta2/{+name}', options) command.request_representation = Google::Apis::CloudfunctionsV1beta2::CloudFunction::Representation command.request_object = cloud_function_object command.response_representation = Google::Apis::CloudfunctionsV1beta2::Operation::Representation command.response_class = Google::Apis::CloudfunctionsV1beta2::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 google-api-client-0.19.8/generated/google/apis/cloudbilling_v1/0000755000004100000410000000000013252673043024370 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/cloudbilling_v1/representations.rb0000644000004100000410000002215413252673043030146 0ustar www-datawww-data# Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'date' require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module CloudbillingV1 class AggregationInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BillingAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Category class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListBillingAccountsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListProjectBillingInfoResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListServicesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListSkusResponse 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 PricingExpression class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PricingInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectBillingInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Service class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Sku class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TierRate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AggregationInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :aggregation_count, as: 'aggregationCount' property :aggregation_interval, as: 'aggregationInterval' property :aggregation_level, as: 'aggregationLevel' end end class BillingAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :name, as: 'name' property :open, as: 'open' end end class Category # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource_family, as: 'resourceFamily' property :resource_group, as: 'resourceGroup' property :service_display_name, as: 'serviceDisplayName' property :usage_type, as: 'usageType' end end class ListBillingAccountsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :billing_accounts, as: 'billingAccounts', class: Google::Apis::CloudbillingV1::BillingAccount, decorator: Google::Apis::CloudbillingV1::BillingAccount::Representation property :next_page_token, as: 'nextPageToken' end end class ListProjectBillingInfoResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :project_billing_info, as: 'projectBillingInfo', class: Google::Apis::CloudbillingV1::ProjectBillingInfo, decorator: Google::Apis::CloudbillingV1::ProjectBillingInfo::Representation end end class ListServicesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :services, as: 'services', class: Google::Apis::CloudbillingV1::Service, decorator: Google::Apis::CloudbillingV1::Service::Representation end end class ListSkusResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :skus, as: 'skus', class: Google::Apis::CloudbillingV1::Sku, decorator: Google::Apis::CloudbillingV1::Sku::Representation 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 PricingExpression # @private class Representation < Google::Apis::Core::JsonRepresentation property :base_unit, as: 'baseUnit' property :base_unit_conversion_factor, as: 'baseUnitConversionFactor' property :base_unit_description, as: 'baseUnitDescription' property :display_quantity, as: 'displayQuantity' collection :tiered_rates, as: 'tieredRates', class: Google::Apis::CloudbillingV1::TierRate, decorator: Google::Apis::CloudbillingV1::TierRate::Representation property :usage_unit, as: 'usageUnit' property :usage_unit_description, as: 'usageUnitDescription' end end class PricingInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :aggregation_info, as: 'aggregationInfo', class: Google::Apis::CloudbillingV1::AggregationInfo, decorator: Google::Apis::CloudbillingV1::AggregationInfo::Representation property :currency_conversion_rate, as: 'currencyConversionRate' property :effective_time, as: 'effectiveTime' property :pricing_expression, as: 'pricingExpression', class: Google::Apis::CloudbillingV1::PricingExpression, decorator: Google::Apis::CloudbillingV1::PricingExpression::Representation property :summary, as: 'summary' end end class ProjectBillingInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :billing_account_name, as: 'billingAccountName' property :billing_enabled, as: 'billingEnabled' property :name, as: 'name' property :project_id, as: 'projectId' end end class Service # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :name, as: 'name' property :service_id, as: 'serviceId' end end class Sku # @private class Representation < Google::Apis::Core::JsonRepresentation property :category, as: 'category', class: Google::Apis::CloudbillingV1::Category, decorator: Google::Apis::CloudbillingV1::Category::Representation property :description, as: 'description' property :name, as: 'name' collection :pricing_info, as: 'pricingInfo', class: Google::Apis::CloudbillingV1::PricingInfo, decorator: Google::Apis::CloudbillingV1::PricingInfo::Representation property :service_provider_name, as: 'serviceProviderName' collection :service_regions, as: 'serviceRegions' property :sku_id, as: 'skuId' end end class TierRate # @private class Representation < Google::Apis::Core::JsonRepresentation property :start_usage_amount, as: 'startUsageAmount' property :unit_price, as: 'unitPrice', class: Google::Apis::CloudbillingV1::Money, decorator: Google::Apis::CloudbillingV1::Money::Representation end end end end end google-api-client-0.19.8/generated/google/apis/cloudbilling_v1/classes.rb0000644000004100000410000006013713252673043026361 0ustar www-datawww-data# Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'date' require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module CloudbillingV1 # Represents the aggregation level and interval for pricing of a single SKU. class AggregationInfo include Google::Apis::Core::Hashable # The number of intervals to aggregate over. # Example: If aggregation_level is "DAILY" and aggregation_count is 14, # aggregation will be over 14 days. # Corresponds to the JSON property `aggregationCount` # @return [Fixnum] attr_accessor :aggregation_count # # Corresponds to the JSON property `aggregationInterval` # @return [String] attr_accessor :aggregation_interval # # Corresponds to the JSON property `aggregationLevel` # @return [String] attr_accessor :aggregation_level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aggregation_count = args[:aggregation_count] if args.key?(:aggregation_count) @aggregation_interval = args[:aggregation_interval] if args.key?(:aggregation_interval) @aggregation_level = args[:aggregation_level] if args.key?(:aggregation_level) end end # A billing account in [Google Cloud # Console](https://console.cloud.google.com/). You can assign a billing account # to one or more projects. class BillingAccount include Google::Apis::Core::Hashable # The display name given to the billing account, such as `My Billing # Account`. This name is displayed in the Google Cloud Console. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The resource name of the billing account. The resource name has the form # `billingAccounts/`billing_account_id``. For example, # `billingAccounts/012345-567890-ABCDEF` would be the resource name for # billing account `012345-567890-ABCDEF`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # True if the billing account is open, and will therefore be charged for any # usage on associated projects. False if the billing account is closed, and # therefore projects associated with it will be unable to use paid services. # Corresponds to the JSON property `open` # @return [Boolean] attr_accessor :open alias_method :open?, :open def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @name = args[:name] if args.key?(:name) @open = args[:open] if args.key?(:open) end end # Represents the category hierarchy of a SKU. class Category include Google::Apis::Core::Hashable # The type of product the SKU refers to. # Example: "Compute", "Storage", "Network", "ApplicationServices" etc. # Corresponds to the JSON property `resourceFamily` # @return [String] attr_accessor :resource_family # A group classification for related SKUs. # Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc. # Corresponds to the JSON property `resourceGroup` # @return [String] attr_accessor :resource_group # The display name of the service this SKU belongs to. # Corresponds to the JSON property `serviceDisplayName` # @return [String] attr_accessor :service_display_name # Represents how the SKU is consumed. # Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc. # Corresponds to the JSON property `usageType` # @return [String] attr_accessor :usage_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource_family = args[:resource_family] if args.key?(:resource_family) @resource_group = args[:resource_group] if args.key?(:resource_group) @service_display_name = args[:service_display_name] if args.key?(:service_display_name) @usage_type = args[:usage_type] if args.key?(:usage_type) end end # Response message for `ListBillingAccounts`. class ListBillingAccountsResponse include Google::Apis::Core::Hashable # A list of billing accounts. # Corresponds to the JSON property `billingAccounts` # @return [Array] attr_accessor :billing_accounts # A token to retrieve the next page of results. To retrieve the next page, # call `ListBillingAccounts` again with the `page_token` field set to this # value. This field is empty if there are no more results to retrieve. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @billing_accounts = args[:billing_accounts] if args.key?(:billing_accounts) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Request message for `ListProjectBillingInfoResponse`. class ListProjectBillingInfoResponse include Google::Apis::Core::Hashable # A token to retrieve the next page of results. To retrieve the next page, # call `ListProjectBillingInfo` again with the `page_token` field set to this # value. This field is empty if there are no more results to retrieve. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # A list of `ProjectBillingInfo` resources representing the projects # associated with the billing account. # Corresponds to the JSON property `projectBillingInfo` # @return [Array] attr_accessor :project_billing_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @project_billing_info = args[:project_billing_info] if args.key?(:project_billing_info) end end # Response message for `ListServices`. class ListServicesResponse include Google::Apis::Core::Hashable # A token to retrieve the next page of results. To retrieve the next page, # call `ListServices` again with the `page_token` field set to this # value. This field is empty if there are no more results to retrieve. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # A list of services. # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @services = args[:services] if args.key?(:services) end end # Response message for `ListSkus`. class ListSkusResponse include Google::Apis::Core::Hashable # A token to retrieve the next page of results. To retrieve the next page, # call `ListSkus` again with the `page_token` field set to this # value. This field is empty if there are no more results to retrieve. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of public SKUs of the given service. # Corresponds to the JSON property `skus` # @return [Array] attr_accessor :skus def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @skus = args[:skus] if args.key?(:skus) end end # Represents an amount of money with its currency type. class Money include Google::Apis::Core::Hashable # The 3-letter currency code defined in ISO 4217. # Corresponds to the JSON property `currencyCode` # @return [String] attr_accessor :currency_code # Number of nano (10^-9) units of the amount. # The value must be between -999,999,999 and +999,999,999 inclusive. # If `units` is positive, `nanos` must be positive or zero. # If `units` is zero, `nanos` can be positive, zero, or negative. # If `units` is negative, `nanos` must be negative or zero. # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos # The whole units of the amount. # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. # Corresponds to the JSON property `units` # @return [Fixnum] attr_accessor :units def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @currency_code = args[:currency_code] if args.key?(:currency_code) @nanos = args[:nanos] if args.key?(:nanos) @units = args[:units] if args.key?(:units) end end # Expresses a mathematical pricing formula. For Example:- # `usage_unit: GBy` # `tiered_rates:` # `[start_usage_amount: 20, unit_price: $10]` # `[start_usage_amount: 100, unit_price: $5]` # The above expresses a pricing formula where the first 20GB is free, the # next 80GB is priced at $10 per GB followed by $5 per GB for additional # usage. class PricingExpression include Google::Apis::Core::Hashable # The base unit for the SKU which is the unit used in usage exports. # Example: "By" # Corresponds to the JSON property `baseUnit` # @return [String] attr_accessor :base_unit # Conversion factor for converting from price per usage_unit to price per # base_unit, and start_usage_amount to start_usage_amount in base_unit. # unit_price / base_unit_conversion_factor = price per base_unit. # start_usage_amount * base_unit_conversion_factor = start_usage_amount in # base_unit. # Corresponds to the JSON property `baseUnitConversionFactor` # @return [Float] attr_accessor :base_unit_conversion_factor # The base unit in human readable form. # Example: "byte". # Corresponds to the JSON property `baseUnitDescription` # @return [String] attr_accessor :base_unit_description # The recommended quantity of units for displaying pricing info. When # displaying pricing info it is recommended to display: # (unit_price * display_quantity) per display_quantity usage_unit. # This field does not affect the pricing formula and is for display purposes # only. # Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and # the display_quantity is "1000" then the recommended way of displaying the # pricing info is "0.10 USD per 1000 GB" # Corresponds to the JSON property `displayQuantity` # @return [Float] attr_accessor :display_quantity # The list of tiered rates for this pricing. The total cost is computed by # applying each of the tiered rates on usage. This repeated list is sorted # by ascending order of start_usage_amount. # Corresponds to the JSON property `tieredRates` # @return [Array] attr_accessor :tiered_rates # The short hand for unit of usage this pricing is specified in. # Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte". # Corresponds to the JSON property `usageUnit` # @return [String] attr_accessor :usage_unit # The unit of usage in human readable form. # Example: "gibi byte". # Corresponds to the JSON property `usageUnitDescription` # @return [String] attr_accessor :usage_unit_description def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @base_unit = args[:base_unit] if args.key?(:base_unit) @base_unit_conversion_factor = args[:base_unit_conversion_factor] if args.key?(:base_unit_conversion_factor) @base_unit_description = args[:base_unit_description] if args.key?(:base_unit_description) @display_quantity = args[:display_quantity] if args.key?(:display_quantity) @tiered_rates = args[:tiered_rates] if args.key?(:tiered_rates) @usage_unit = args[:usage_unit] if args.key?(:usage_unit) @usage_unit_description = args[:usage_unit_description] if args.key?(:usage_unit_description) end end # Represents the pricing information for a SKU at a single point of time. class PricingInfo include Google::Apis::Core::Hashable # Represents the aggregation level and interval for pricing of a single SKU. # Corresponds to the JSON property `aggregationInfo` # @return [Google::Apis::CloudbillingV1::AggregationInfo] attr_accessor :aggregation_info # Conversion rate used for currency conversion, from USD to the currency # specified in the request. This includes any surcharge collected for billing # in non USD currency. If a currency is not specified in the request this # defaults to 1.0. # Example: USD * currency_conversion_rate = JPY # Corresponds to the JSON property `currencyConversionRate` # @return [Float] attr_accessor :currency_conversion_rate # The timestamp from which this pricing was effective within the requested # time range. This is guaranteed to be greater than or equal to the # start_time field in the request and less than the end_time field in the # request. If a time range was not specified in the request this field will # be equivalent to a time within the last 12 hours, indicating the latest # pricing info. # Corresponds to the JSON property `effectiveTime` # @return [String] attr_accessor :effective_time # Expresses a mathematical pricing formula. For Example:- # `usage_unit: GBy` # `tiered_rates:` # `[start_usage_amount: 20, unit_price: $10]` # `[start_usage_amount: 100, unit_price: $5]` # The above expresses a pricing formula where the first 20GB is free, the # next 80GB is priced at $10 per GB followed by $5 per GB for additional # usage. # Corresponds to the JSON property `pricingExpression` # @return [Google::Apis::CloudbillingV1::PricingExpression] attr_accessor :pricing_expression # An optional human readable summary of the pricing information, has a # maximum length of 256 characters. # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aggregation_info = args[:aggregation_info] if args.key?(:aggregation_info) @currency_conversion_rate = args[:currency_conversion_rate] if args.key?(:currency_conversion_rate) @effective_time = args[:effective_time] if args.key?(:effective_time) @pricing_expression = args[:pricing_expression] if args.key?(:pricing_expression) @summary = args[:summary] if args.key?(:summary) end end # Encapsulation of billing information for a Cloud Console project. A project # has at most one associated billing account at a time (but a billing account # can be assigned to multiple projects). class ProjectBillingInfo include Google::Apis::Core::Hashable # The resource name of the billing account associated with the project, if # any. For example, `billingAccounts/012345-567890-ABCDEF`. # Corresponds to the JSON property `billingAccountName` # @return [String] attr_accessor :billing_account_name # True if the project is associated with an open billing account, to which # usage on the project is charged. False if the project is associated with a # closed billing account, or no billing account at all, and therefore cannot # use paid services. This field is read-only. # Corresponds to the JSON property `billingEnabled` # @return [Boolean] attr_accessor :billing_enabled alias_method :billing_enabled?, :billing_enabled # The resource name for the `ProjectBillingInfo`; has the form # `projects/`project_id`/billingInfo`. For example, the resource name for the # billing information for project `tokyo-rain-123` would be # `projects/tokyo-rain-123/billingInfo`. This field is read-only. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The ID of the project that this `ProjectBillingInfo` represents, such as # `tokyo-rain-123`. This is a convenience field so that you don't need to # parse the `name` field to obtain a project ID. This field is read-only. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @billing_account_name = args[:billing_account_name] if args.key?(:billing_account_name) @billing_enabled = args[:billing_enabled] if args.key?(:billing_enabled) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) end end # Encapsulates a single service in Google Cloud Platform. class Service include Google::Apis::Core::Hashable # A human readable display name for this service. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The resource name for the service. # Example: "services/DA34-426B-A397" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The identifier for the service. # Example: "DA34-426B-A397" # Corresponds to the JSON property `serviceId` # @return [String] attr_accessor :service_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @name = args[:name] if args.key?(:name) @service_id = args[:service_id] if args.key?(:service_id) end end # Encapsulates a single SKU in Google Cloud Platform class Sku include Google::Apis::Core::Hashable # Represents the category hierarchy of a SKU. # Corresponds to the JSON property `category` # @return [Google::Apis::CloudbillingV1::Category] attr_accessor :category # A human readable description of the SKU, has a maximum length of 256 # characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The resource name for the SKU. # Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A timeline of pricing info for this SKU in chronological order. # Corresponds to the JSON property `pricingInfo` # @return [Array] attr_accessor :pricing_info # Identifies the service provider. # This is 'Google' for first party services in Google Cloud Platform. # Corresponds to the JSON property `serviceProviderName` # @return [String] attr_accessor :service_provider_name # List of service regions this SKU is offered at. # Example: "asia-east1" # Service regions can be found at https://cloud.google.com/about/locations/ # Corresponds to the JSON property `serviceRegions` # @return [Array] attr_accessor :service_regions # The identifier for the SKU. # Example: "AA95-CD31-42FE" # Corresponds to the JSON property `skuId` # @return [String] attr_accessor :sku_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @category = args[:category] if args.key?(:category) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @pricing_info = args[:pricing_info] if args.key?(:pricing_info) @service_provider_name = args[:service_provider_name] if args.key?(:service_provider_name) @service_regions = args[:service_regions] if args.key?(:service_regions) @sku_id = args[:sku_id] if args.key?(:sku_id) end end # The price rate indicating starting usage and its corresponding price. class TierRate include Google::Apis::Core::Hashable # Usage is priced at this rate only after this amount. # Example: start_usage_amount of 10 indicates that the usage will be priced # at the unit_price after the first 10 usage_units. # Corresponds to the JSON property `startUsageAmount` # @return [Float] attr_accessor :start_usage_amount # Represents an amount of money with its currency type. # Corresponds to the JSON property `unitPrice` # @return [Google::Apis::CloudbillingV1::Money] attr_accessor :unit_price def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @start_usage_amount = args[:start_usage_amount] if args.key?(:start_usage_amount) @unit_price = args[:unit_price] if args.key?(:unit_price) end end end end end google-api-client-0.19.8/generated/google/apis/cloudbilling_v1/service.rb0000644000004100000410000005210213252673043026355 0ustar www-datawww-data# 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 CloudbillingV1 # Google Cloud Billing API # # Allows developers to manage billing for their Google Cloud Platform projects # programmatically. # # @example # require 'google/apis/cloudbilling_v1' # # Cloudbilling = Google::Apis::CloudbillingV1 # Alias the module # service = Cloudbilling::CloudbillingService.new # # @see https://cloud.google.com/billing/ class CloudbillingService < 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://cloudbilling.googleapis.com/', '') @batch_path = 'batch' end # Gets information about a billing account. The current authenticated user # must be an [owner of the billing # account](https://support.google.com/cloud/answer/4430947). # @param [String] name # The resource name of the billing account to retrieve. For example, # `billingAccounts/012345-567890-ABCDEF`. # @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::CloudbillingV1::BillingAccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbillingV1::BillingAccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_billing_account(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudbillingV1::BillingAccount::Representation command.response_class = Google::Apis::CloudbillingV1::BillingAccount 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 billing accounts that the current authenticated user # [owns](https://support.google.com/cloud/answer/4430947). # @param [Fixnum] page_size # Requested page size. The maximum page size is 100; this is also the # default. # @param [String] page_token # A token identifying a page of results to return. This should be a # `next_page_token` value returned from a previous `ListBillingAccounts` # call. If unspecified, the first page of results 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::CloudbillingV1::ListBillingAccountsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbillingV1::ListBillingAccountsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_billing_accounts(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/billingAccounts', options) command.response_representation = Google::Apis::CloudbillingV1::ListBillingAccountsResponse::Representation command.response_class = Google::Apis::CloudbillingV1::ListBillingAccountsResponse 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 # Lists the projects associated with a billing account. The current # authenticated user must have the "billing.resourceAssociations.list" IAM # permission, which is often given to billing account # [viewers](https://support.google.com/cloud/answer/4430947). # @param [String] name # The resource name of the billing account associated with the projects that # you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. # @param [Fixnum] page_size # Requested page size. The maximum page size is 100; this is also the # default. # @param [String] page_token # A token identifying a page of results to be returned. This should be a # `next_page_token` value returned from a previous `ListProjectBillingInfo` # call. If unspecified, the first page of results 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::CloudbillingV1::ListProjectBillingInfoResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbillingV1::ListProjectBillingInfoResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_billing_account_projects(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/projects', options) command.response_representation = Google::Apis::CloudbillingV1::ListProjectBillingInfoResponse::Representation command.response_class = Google::Apis::CloudbillingV1::ListProjectBillingInfoResponse command.params['name'] = name unless 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 # Gets the billing information for a project. The current authenticated user # must have [permission to view the # project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo # ). # @param [String] name # The resource name of the project for which billing information is # retrieved. For example, `projects/tokyo-rain-123`. # @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::CloudbillingV1::ProjectBillingInfo] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbillingV1::ProjectBillingInfo] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_billing_info(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/billingInfo', options) command.response_representation = Google::Apis::CloudbillingV1::ProjectBillingInfo::Representation command.response_class = Google::Apis::CloudbillingV1::ProjectBillingInfo 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 # Sets or updates the billing account associated with a project. You specify # the new billing account by setting the `billing_account_name` in the # `ProjectBillingInfo` resource to the resource name of a billing account. # Associating a project with an open billing account enables billing on the # project and allows charges for resource usage. If the project already had a # billing account, this method changes the billing account used for resource # usage charges. # *Note:* Incurred charges that have not yet been reported in the transaction # history of the Google Cloud Console may be billed to the new billing # account, even if the charge occurred before the new billing account was # assigned to the project. # The current authenticated user must have ownership privileges for both the # [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo # ) and the [billing # account](https://support.google.com/cloud/answer/4430947). # You can disable billing on the project by setting the # `billing_account_name` field to empty. This action disassociates the # current billing account from the project. Any billable activity of your # in-use services will stop, and your application could stop functioning as # expected. Any unbilled charges to date will be billed to the previously # associated account. The current authenticated user must be either an owner # of the project or an owner of the billing account for the project. # Note that associating a project with a *closed* billing account will have # much the same effect as disabling billing on the project: any paid # resources used by the project will be shut down. Thus, unless you wish to # disable billing, you should always call this method with the name of an # *open* billing account. # @param [String] name # The resource name of the project associated with the billing information # that you want to update. For example, `projects/tokyo-rain-123`. # @param [Google::Apis::CloudbillingV1::ProjectBillingInfo] project_billing_info_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::CloudbillingV1::ProjectBillingInfo] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbillingV1::ProjectBillingInfo] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_billing_info(name, project_billing_info_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/{+name}/billingInfo', options) command.request_representation = Google::Apis::CloudbillingV1::ProjectBillingInfo::Representation command.request_object = project_billing_info_object command.response_representation = Google::Apis::CloudbillingV1::ProjectBillingInfo::Representation command.response_class = Google::Apis::CloudbillingV1::ProjectBillingInfo 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 public cloud services. # @param [Fixnum] page_size # Requested page size. Defaults to 5000. # @param [String] page_token # A token identifying a page of results to return. This should be a # `next_page_token` value returned from a previous `ListServices` # call. If unspecified, the first page of results 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::CloudbillingV1::ListServicesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbillingV1::ListServicesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_services(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/services', options) command.response_representation = Google::Apis::CloudbillingV1::ListServicesResponse::Representation command.response_class = Google::Apis::CloudbillingV1::ListServicesResponse 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 # Lists all publicly available SKUs for a given cloud service. # @param [String] parent # The name of the service. # Example: "services/DA34-426B-A397" # @param [String] currency_code # The ISO 4217 currency code for the pricing info in the response proto. # Will use the conversion rate as of start_time. # Optional. If not specified USD will be used. # @param [String] end_time # Optional exclusive end time of the time range for which the pricing # versions will be returned. Timestamps in the future are not allowed. # The time range has to be within a single calendar month in # America/Los_Angeles timezone. Time range as a whole is optional. If not # specified, the latest pricing will be returned (up to 12 hours old at # most). # @param [Fixnum] page_size # Requested page size. Defaults to 5000. # @param [String] page_token # A token identifying a page of results to return. This should be a # `next_page_token` value returned from a previous `ListSkus` # call. If unspecified, the first page of results is returned. # @param [String] start_time # Optional inclusive start time of the time range for which the pricing # versions will be returned. Timestamps in the future are not allowed. # The time range has to be within a single calendar month in # America/Los_Angeles timezone. Time range as a whole is optional. If not # specified, the latest pricing will be returned (up to 12 hours old at # most). # @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::CloudbillingV1::ListSkusResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbillingV1::ListSkusResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_skus(parent, currency_code: nil, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/skus', options) command.response_representation = Google::Apis::CloudbillingV1::ListSkusResponse::Representation command.response_class = Google::Apis::CloudbillingV1::ListSkusResponse command.params['parent'] = parent unless parent.nil? command.query['currencyCode'] = currency_code unless currency_code.nil? command.query['endTime'] = end_time unless end_time.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['startTime'] = start_time unless start_time.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 google-api-client-0.19.8/generated/google/apis/pagespeedonline_v2/0000755000004100000410000000000013252673044025065 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/pagespeedonline_v2/representations.rb0000644000004100000410000002637313252673044030652 0ustar www-datawww-data# 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 PagespeedonlineV2 class FormatString class Representation < Google::Apis::Core::JsonRepresentation; end class Arg class Representation < Google::Apis::Core::JsonRepresentation; end class Rect class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SecondaryRect 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 Image class Representation < Google::Apis::Core::JsonRepresentation; end class PageRect class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Result class Representation < Google::Apis::Core::JsonRepresentation; end class FormattedResults class Representation < Google::Apis::Core::JsonRepresentation; end class RuleResult class Representation < Google::Apis::Core::JsonRepresentation; end class UrlBlock class Representation < Google::Apis::Core::JsonRepresentation; end class Url 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 include Google::Apis::Core::JsonObjectSupport end class PageStats class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RuleGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Version class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class FormatString # @private class Representation < Google::Apis::Core::JsonRepresentation collection :args, as: 'args', class: Google::Apis::PagespeedonlineV2::FormatString::Arg, decorator: Google::Apis::PagespeedonlineV2::FormatString::Arg::Representation property :format, as: 'format' end class Arg # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' collection :rects, as: 'rects', class: Google::Apis::PagespeedonlineV2::FormatString::Arg::Rect, decorator: Google::Apis::PagespeedonlineV2::FormatString::Arg::Rect::Representation collection :secondary_rects, as: 'secondary_rects', class: Google::Apis::PagespeedonlineV2::FormatString::Arg::SecondaryRect, decorator: Google::Apis::PagespeedonlineV2::FormatString::Arg::SecondaryRect::Representation property :type, as: 'type' property :value, as: 'value' end class Rect # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :left, as: 'left' property :top, as: 'top' property :width, as: 'width' end end class SecondaryRect # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :left, as: 'left' property :top, as: 'top' property :width, as: 'width' end end end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, :base64 => true, as: 'data' property :height, as: 'height' property :key, as: 'key' property :mime_type, as: 'mime_type' property :page_rect, as: 'page_rect', class: Google::Apis::PagespeedonlineV2::Image::PageRect, decorator: Google::Apis::PagespeedonlineV2::Image::PageRect::Representation property :width, as: 'width' end class PageRect # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :left, as: 'left' property :top, as: 'top' property :width, as: 'width' end end end class Result # @private class Representation < Google::Apis::Core::JsonRepresentation property :captcha_result, as: 'captchaResult' property :formatted_results, as: 'formattedResults', class: Google::Apis::PagespeedonlineV2::Result::FormattedResults, decorator: Google::Apis::PagespeedonlineV2::Result::FormattedResults::Representation property :id, as: 'id' collection :invalid_rules, as: 'invalidRules' property :kind, as: 'kind' property :page_stats, as: 'pageStats', class: Google::Apis::PagespeedonlineV2::Result::PageStats, decorator: Google::Apis::PagespeedonlineV2::Result::PageStats::Representation property :response_code, as: 'responseCode' hash :rule_groups, as: 'ruleGroups', class: Google::Apis::PagespeedonlineV2::Result::RuleGroup, decorator: Google::Apis::PagespeedonlineV2::Result::RuleGroup::Representation property :screenshot, as: 'screenshot', class: Google::Apis::PagespeedonlineV2::Image, decorator: Google::Apis::PagespeedonlineV2::Image::Representation property :title, as: 'title' property :version, as: 'version', class: Google::Apis::PagespeedonlineV2::Result::Version, decorator: Google::Apis::PagespeedonlineV2::Result::Version::Representation end class FormattedResults # @private class Representation < Google::Apis::Core::JsonRepresentation property :locale, as: 'locale' hash :rule_results, as: 'ruleResults', class: Google::Apis::PagespeedonlineV2::Result::FormattedResults::RuleResult, decorator: Google::Apis::PagespeedonlineV2::Result::FormattedResults::RuleResult::Representation end class RuleResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :groups, as: 'groups' property :localized_rule_name, as: 'localizedRuleName' property :rule_impact, as: 'ruleImpact' property :summary, as: 'summary', class: Google::Apis::PagespeedonlineV2::FormatString, decorator: Google::Apis::PagespeedonlineV2::FormatString::Representation collection :url_blocks, as: 'urlBlocks', class: Google::Apis::PagespeedonlineV2::Result::FormattedResults::RuleResult::UrlBlock, decorator: Google::Apis::PagespeedonlineV2::Result::FormattedResults::RuleResult::UrlBlock::Representation end class UrlBlock # @private class Representation < Google::Apis::Core::JsonRepresentation property :header, as: 'header', class: Google::Apis::PagespeedonlineV2::FormatString, decorator: Google::Apis::PagespeedonlineV2::FormatString::Representation collection :urls, as: 'urls', class: Google::Apis::PagespeedonlineV2::Result::FormattedResults::RuleResult::UrlBlock::Url, decorator: Google::Apis::PagespeedonlineV2::Result::FormattedResults::RuleResult::UrlBlock::Url::Representation end class Url # @private class Representation < Google::Apis::Core::JsonRepresentation collection :details, as: 'details', class: Google::Apis::PagespeedonlineV2::FormatString, decorator: Google::Apis::PagespeedonlineV2::FormatString::Representation property :result, as: 'result', class: Google::Apis::PagespeedonlineV2::FormatString, decorator: Google::Apis::PagespeedonlineV2::FormatString::Representation end end end end end class PageStats # @private class Representation < Google::Apis::Core::JsonRepresentation property :css_response_bytes, :numeric_string => true, as: 'cssResponseBytes' property :flash_response_bytes, :numeric_string => true, as: 'flashResponseBytes' property :html_response_bytes, :numeric_string => true, as: 'htmlResponseBytes' property :image_response_bytes, :numeric_string => true, as: 'imageResponseBytes' property :javascript_response_bytes, :numeric_string => true, as: 'javascriptResponseBytes' property :number_css_resources, as: 'numberCssResources' property :number_hosts, as: 'numberHosts' property :number_js_resources, as: 'numberJsResources' property :number_resources, as: 'numberResources' property :number_static_resources, as: 'numberStaticResources' property :other_response_bytes, :numeric_string => true, as: 'otherResponseBytes' property :text_response_bytes, :numeric_string => true, as: 'textResponseBytes' property :total_request_bytes, :numeric_string => true, as: 'totalRequestBytes' end end class RuleGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :score, as: 'score' end end class Version # @private class Representation < Google::Apis::Core::JsonRepresentation property :major, as: 'major' property :minor, as: 'minor' end end end end end end google-api-client-0.19.8/generated/google/apis/pagespeedonline_v2/classes.rb0000644000004100000410000006120113252673044027047 0ustar www-datawww-data# 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 PagespeedonlineV2 # class FormatString include Google::Apis::Core::Hashable # List of arguments for the format string. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args # A localized format string with ``FOO`` placeholders, where 'FOO' is the key of # the argument whose value should be substituted. For HYPERLINK arguments, the # format string will instead contain ``BEGIN_FOO`` and ``END_FOO`` for the # argument with key 'FOO'. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @args = args[:args] if args.key?(:args) @format = args[:format] if args.key?(:format) end # class Arg include Google::Apis::Core::Hashable # The placeholder key for this arg, as a string. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # The screen rectangles being referred to, with dimensions measured in CSS # pixels. This is only ever used for SNAPSHOT_RECT arguments. If this is absent # for a SNAPSHOT_RECT argument, it means that that argument refers to the entire # snapshot. # Corresponds to the JSON property `rects` # @return [Array] attr_accessor :rects # Secondary screen rectangles being referred to, with dimensions measured in CSS # pixels. This is only ever used for SNAPSHOT_RECT arguments. # Corresponds to the JSON property `secondary_rects` # @return [Array] attr_accessor :secondary_rects # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, # VERBATIM_STRING, PERCENTAGE, HYPERLINK, or SNAPSHOT_RECT. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Argument value, as a localized string. # 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) @rects = args[:rects] if args.key?(:rects) @secondary_rects = args[:secondary_rects] if args.key?(:secondary_rects) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end # class Rect include Google::Apis::Core::Hashable # The height of the rect. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # The left coordinate of the rect, in page coordinates. # Corresponds to the JSON property `left` # @return [Fixnum] attr_accessor :left # The top coordinate of the rect, in page coordinates. # Corresponds to the JSON property `top` # @return [Fixnum] attr_accessor :top # The width of the rect. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @left = args[:left] if args.key?(:left) @top = args[:top] if args.key?(:top) @width = args[:width] if args.key?(:width) end end # class SecondaryRect include Google::Apis::Core::Hashable # The height of the rect. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # The left coordinate of the rect, in page coordinates. # Corresponds to the JSON property `left` # @return [Fixnum] attr_accessor :left # The top coordinate of the rect, in page coordinates. # Corresponds to the JSON property `top` # @return [Fixnum] attr_accessor :top # The width of the rect. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @left = args[:left] if args.key?(:left) @top = args[:top] if args.key?(:top) @width = args[:width] if args.key?(:width) end end end end # class Image include Google::Apis::Core::Hashable # Image data base64 encoded. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data # Height of screenshot in pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Unique string key, if any, identifying this image. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # Mime type of image data (e.g. "image/jpeg"). # Corresponds to the JSON property `mime_type` # @return [String] attr_accessor :mime_type # The region of the page that is captured by this image, with dimensions # measured in CSS pixels. # Corresponds to the JSON property `page_rect` # @return [Google::Apis::PagespeedonlineV2::Image::PageRect] attr_accessor :page_rect # Width of screenshot in pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data = args[:data] if args.key?(:data) @height = args[:height] if args.key?(:height) @key = args[:key] if args.key?(:key) @mime_type = args[:mime_type] if args.key?(:mime_type) @page_rect = args[:page_rect] if args.key?(:page_rect) @width = args[:width] if args.key?(:width) end # The region of the page that is captured by this image, with dimensions # measured in CSS pixels. class PageRect include Google::Apis::Core::Hashable # The height of the rect. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # The left coordinate of the rect, in page coordinates. # Corresponds to the JSON property `left` # @return [Fixnum] attr_accessor :left # The top coordinate of the rect, in page coordinates. # Corresponds to the JSON property `top` # @return [Fixnum] attr_accessor :top # The width of the rect. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @left = args[:left] if args.key?(:left) @top = args[:top] if args.key?(:top) @width = args[:width] if args.key?(:width) end end end # class Result include Google::Apis::Core::Hashable # The captcha verify result # Corresponds to the JSON property `captchaResult` # @return [String] attr_accessor :captcha_result # Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed # rule instantiated and run by the server. # Corresponds to the JSON property `formattedResults` # @return [Google::Apis::PagespeedonlineV2::Result::FormattedResults] attr_accessor :formatted_results # Canonicalized and final URL for the document, after following page redirects ( # if any). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # List of rules that were specified in the request, but which the server did not # know how to instantiate. # Corresponds to the JSON property `invalidRules` # @return [Array] attr_accessor :invalid_rules # Kind of result. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Summary statistics for the page, such as number of JavaScript bytes, number of # HTML bytes, etc. # Corresponds to the JSON property `pageStats` # @return [Google::Apis::PagespeedonlineV2::Result::PageStats] attr_accessor :page_stats # Response code for the document. 200 indicates a normal page load. 4xx/5xx # indicates an error. # Corresponds to the JSON property `responseCode` # @return [Fixnum] attr_accessor :response_code # A map with one entry for each rule group in these results. # Corresponds to the JSON property `ruleGroups` # @return [Hash] attr_accessor :rule_groups # Base64-encoded screenshot of the page that was analyzed. # Corresponds to the JSON property `screenshot` # @return [Google::Apis::PagespeedonlineV2::Image] attr_accessor :screenshot # Title of the page, as displayed in the browser's title bar. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The version of PageSpeed used to generate these results. # Corresponds to the JSON property `version` # @return [Google::Apis::PagespeedonlineV2::Result::Version] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @captcha_result = args[:captcha_result] if args.key?(:captcha_result) @formatted_results = args[:formatted_results] if args.key?(:formatted_results) @id = args[:id] if args.key?(:id) @invalid_rules = args[:invalid_rules] if args.key?(:invalid_rules) @kind = args[:kind] if args.key?(:kind) @page_stats = args[:page_stats] if args.key?(:page_stats) @response_code = args[:response_code] if args.key?(:response_code) @rule_groups = args[:rule_groups] if args.key?(:rule_groups) @screenshot = args[:screenshot] if args.key?(:screenshot) @title = args[:title] if args.key?(:title) @version = args[:version] if args.key?(:version) end # Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed # rule instantiated and run by the server. class FormattedResults include Google::Apis::Core::Hashable # The locale of the formattedResults, e.g. "en_US". # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # Dictionary of formatted rule results, with one entry for each PageSpeed rule # instantiated and run by the server. # Corresponds to the JSON property `ruleResults` # @return [Hash] attr_accessor :rule_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @locale = args[:locale] if args.key?(:locale) @rule_results = args[:rule_results] if args.key?(:rule_results) end # The enum-like identifier for this rule. For instance "EnableKeepAlive" or " # AvoidCssImport". Not localized. class RuleResult include Google::Apis::Core::Hashable # List of rule groups that this rule belongs to. Each entry in the list is one # of "SPEED" or "USABILITY". # Corresponds to the JSON property `groups` # @return [Array] attr_accessor :groups # Localized name of the rule, intended for presentation to a user. # Corresponds to the JSON property `localizedRuleName` # @return [String] attr_accessor :localized_rule_name # The impact (unbounded floating point value) that implementing the suggestions # for this rule would have on making the page faster. Impact is comparable # between rules to determine which rule's suggestions would have a higher or # lower impact on making a page faster. For instance, if enabling compression # would save 1MB, while optimizing images would save 500kB, the enable # compression rule would have 2x the impact of the image optimization rule, all # other things being equal. # Corresponds to the JSON property `ruleImpact` # @return [Float] attr_accessor :rule_impact # A brief summary description for the rule, indicating at a high level what # should be done to follow the rule and what benefit can be gained by doing so. # Corresponds to the JSON property `summary` # @return [Google::Apis::PagespeedonlineV2::FormatString] attr_accessor :summary # List of blocks of URLs. Each block may contain a heading and a list of URLs. # Each URL may optionally include additional details. # Corresponds to the JSON property `urlBlocks` # @return [Array] attr_accessor :url_blocks def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @groups = args[:groups] if args.key?(:groups) @localized_rule_name = args[:localized_rule_name] if args.key?(:localized_rule_name) @rule_impact = args[:rule_impact] if args.key?(:rule_impact) @summary = args[:summary] if args.key?(:summary) @url_blocks = args[:url_blocks] if args.key?(:url_blocks) end # class UrlBlock include Google::Apis::Core::Hashable # Heading to be displayed with the list of URLs. # Corresponds to the JSON property `header` # @return [Google::Apis::PagespeedonlineV2::FormatString] attr_accessor :header # List of entries that provide information about URLs in the url block. Optional. # Corresponds to the JSON property `urls` # @return [Array] attr_accessor :urls def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @header = args[:header] if args.key?(:header) @urls = args[:urls] if args.key?(:urls) end # class Url include Google::Apis::Core::Hashable # List of entries that provide additional details about a single URL. Optional. # Corresponds to the JSON property `details` # @return [Array] attr_accessor :details # A format string that gives information about the URL, and a list of arguments # for that format string. # Corresponds to the JSON property `result` # @return [Google::Apis::PagespeedonlineV2::FormatString] attr_accessor :result def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @details = args[:details] if args.key?(:details) @result = args[:result] if args.key?(:result) end end end end end # Summary statistics for the page, such as number of JavaScript bytes, number of # HTML bytes, etc. class PageStats include Google::Apis::Core::Hashable # Number of uncompressed response bytes for CSS resources on the page. # Corresponds to the JSON property `cssResponseBytes` # @return [Fixnum] attr_accessor :css_response_bytes # Number of response bytes for flash resources on the page. # Corresponds to the JSON property `flashResponseBytes` # @return [Fixnum] attr_accessor :flash_response_bytes # Number of uncompressed response bytes for the main HTML document and all # iframes on the page. # Corresponds to the JSON property `htmlResponseBytes` # @return [Fixnum] attr_accessor :html_response_bytes # Number of response bytes for image resources on the page. # Corresponds to the JSON property `imageResponseBytes` # @return [Fixnum] attr_accessor :image_response_bytes # Number of uncompressed response bytes for JS resources on the page. # Corresponds to the JSON property `javascriptResponseBytes` # @return [Fixnum] attr_accessor :javascript_response_bytes # Number of CSS resources referenced by the page. # Corresponds to the JSON property `numberCssResources` # @return [Fixnum] attr_accessor :number_css_resources # Number of unique hosts referenced by the page. # Corresponds to the JSON property `numberHosts` # @return [Fixnum] attr_accessor :number_hosts # Number of JavaScript resources referenced by the page. # Corresponds to the JSON property `numberJsResources` # @return [Fixnum] attr_accessor :number_js_resources # Number of HTTP resources loaded by the page. # Corresponds to the JSON property `numberResources` # @return [Fixnum] attr_accessor :number_resources # Number of static (i.e. cacheable) resources on the page. # Corresponds to the JSON property `numberStaticResources` # @return [Fixnum] attr_accessor :number_static_resources # Number of response bytes for other resources on the page. # Corresponds to the JSON property `otherResponseBytes` # @return [Fixnum] attr_accessor :other_response_bytes # Number of uncompressed response bytes for text resources not covered by other # statistics (i.e non-HTML, non-script, non-CSS resources) on the page. # Corresponds to the JSON property `textResponseBytes` # @return [Fixnum] attr_accessor :text_response_bytes # Total size of all request bytes sent by the page. # Corresponds to the JSON property `totalRequestBytes` # @return [Fixnum] attr_accessor :total_request_bytes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @css_response_bytes = args[:css_response_bytes] if args.key?(:css_response_bytes) @flash_response_bytes = args[:flash_response_bytes] if args.key?(:flash_response_bytes) @html_response_bytes = args[:html_response_bytes] if args.key?(:html_response_bytes) @image_response_bytes = args[:image_response_bytes] if args.key?(:image_response_bytes) @javascript_response_bytes = args[:javascript_response_bytes] if args.key?(:javascript_response_bytes) @number_css_resources = args[:number_css_resources] if args.key?(:number_css_resources) @number_hosts = args[:number_hosts] if args.key?(:number_hosts) @number_js_resources = args[:number_js_resources] if args.key?(:number_js_resources) @number_resources = args[:number_resources] if args.key?(:number_resources) @number_static_resources = args[:number_static_resources] if args.key?(:number_static_resources) @other_response_bytes = args[:other_response_bytes] if args.key?(:other_response_bytes) @text_response_bytes = args[:text_response_bytes] if args.key?(:text_response_bytes) @total_request_bytes = args[:total_request_bytes] if args.key?(:total_request_bytes) end end # The name of this rule group: one of "SPEED" or "USABILITY". class RuleGroup include Google::Apis::Core::Hashable # The score (0-100) for this rule group, which indicates how much better a page # could be in that category (e.g. how much faster, or how much more usable). A # high score indicates little room for improvement, while a lower score # indicates more room for improvement. # Corresponds to the JSON property `score` # @return [Fixnum] attr_accessor :score def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @score = args[:score] if args.key?(:score) end end # The version of PageSpeed used to generate these results. class Version include Google::Apis::Core::Hashable # The major version number of PageSpeed used to generate these results. # Corresponds to the JSON property `major` # @return [Fixnum] attr_accessor :major # The minor version number of PageSpeed used to generate these results. # Corresponds to the JSON property `minor` # @return [Fixnum] attr_accessor :minor def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @major = args[:major] if args.key?(:major) @minor = args[:minor] if args.key?(:minor) end end end end end end google-api-client-0.19.8/generated/google/apis/pagespeedonline_v2/service.rb0000644000004100000410000001310413252673044027051 0ustar www-datawww-data# 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 PagespeedonlineV2 # PageSpeed Insights API # # Analyzes the performance of a web page and provides tailored suggestions to # make that page faster. # # @example # require 'google/apis/pagespeedonline_v2' # # Pagespeedonline = Google::Apis::PagespeedonlineV2 # Alias the module # service = Pagespeedonline::PagespeedonlineService.new # # @see https://developers.google.com/speed/docs/insights/v2/getting-started class PagespeedonlineService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'pagespeedonline/v2/') @batch_path = 'batch/pagespeedonline/v2' end # Runs PageSpeed analysis on the page at the specified URL, and returns # PageSpeed scores, a list of suggestions to make that page faster, and other # information. # @param [String] url # The URL to fetch and analyze # @param [Boolean] filter_third_party_resources # Indicates if third party resources should be filtered out before PageSpeed # analysis. # @param [String] locale # The locale used to localize formatted results # @param [Array, String] rule # A PageSpeed rule to run; if none are given, all rules are run # @param [Boolean] screenshot # Indicates if binary data containing a screenshot should be included # @param [String] strategy # The analysis strategy to use # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PagespeedonlineV2::Result] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PagespeedonlineV2::Result] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def run_pagespeed(url, filter_third_party_resources: nil, locale: nil, rule: nil, screenshot: nil, strategy: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'runPagespeed', options) command.response_representation = Google::Apis::PagespeedonlineV2::Result::Representation command.response_class = Google::Apis::PagespeedonlineV2::Result command.query['filter_third_party_resources'] = filter_third_party_resources unless filter_third_party_resources.nil? command.query['locale'] = locale unless locale.nil? command.query['rule'] = rule unless rule.nil? command.query['screenshot'] = screenshot unless screenshot.nil? command.query['strategy'] = strategy unless strategy.nil? command.query['url'] = url unless url.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 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 end end google-api-client-0.19.8/generated/google/apis/prediction_v1_3/0000755000004100000410000000000013252673044024304 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/prediction_v1_3/representations.rb0000644000004100000410000001141513252673044030060 0ustar www-datawww-data# 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 PredictionV1_3 class Input class Representation < Google::Apis::Core::JsonRepresentation; end class Input class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Output class Representation < Google::Apis::Core::JsonRepresentation; end class OutputMulti class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Training class Representation < Google::Apis::Core::JsonRepresentation; end class ModelInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Update class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Input # @private class Representation < Google::Apis::Core::JsonRepresentation property :input, as: 'input', class: Google::Apis::PredictionV1_3::Input::Input, decorator: Google::Apis::PredictionV1_3::Input::Input::Representation end class Input # @private class Representation < Google::Apis::Core::JsonRepresentation collection :csv_instance, as: 'csvInstance' end end end class Output # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :output_label, as: 'outputLabel' collection :output_multi, as: 'outputMulti', class: Google::Apis::PredictionV1_3::Output::OutputMulti, decorator: Google::Apis::PredictionV1_3::Output::OutputMulti::Representation property :output_value, as: 'outputValue' property :self_link, as: 'selfLink' end class OutputMulti # @private class Representation < Google::Apis::Core::JsonRepresentation property :label, as: 'label' property :score, as: 'score' end end end class Training # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :model_info, as: 'modelInfo', class: Google::Apis::PredictionV1_3::Training::ModelInfo, decorator: Google::Apis::PredictionV1_3::Training::ModelInfo::Representation property :self_link, as: 'selfLink' property :training_status, as: 'trainingStatus' collection :utility, as: 'utility' end class ModelInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :class_weighted_accuracy, as: 'classWeightedAccuracy' property :classification_accuracy, as: 'classificationAccuracy' hash :confusion_matrix, as: 'confusionMatrix' hash :confusion_matrix_row_totals, as: 'confusionMatrixRowTotals' property :mean_squared_error, as: 'meanSquaredError' property :model_type, as: 'modelType' property :number_classes, :numeric_string => true, as: 'numberClasses' property :number_instances, :numeric_string => true, as: 'numberInstances' end end end class Update # @private class Representation < Google::Apis::Core::JsonRepresentation property :class_label, as: 'classLabel' collection :csv_instance, as: 'csvInstance' end end end end end google-api-client-0.19.8/generated/google/apis/prediction_v1_3/classes.rb0000644000004100000410000002474413252673044026301 0ustar www-datawww-data# 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 PredictionV1_3 # class Input include Google::Apis::Core::Hashable # Input to the model for a prediction # Corresponds to the JSON property `input` # @return [Google::Apis::PredictionV1_3::Input::Input] attr_accessor :input def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @input = args[:input] if args.key?(:input) end # Input to the model for a prediction class Input include Google::Apis::Core::Hashable # A list of input features, these can be strings or doubles. # Corresponds to the JSON property `csvInstance` # @return [Array] attr_accessor :csv_instance def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @csv_instance = args[:csv_instance] if args.key?(:csv_instance) end end end # class Output include Google::Apis::Core::Hashable # The unique name for the predictive model. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # What kind of resource this is. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The most likely class [Categorical models only]. # Corresponds to the JSON property `outputLabel` # @return [String] attr_accessor :output_label # A list of classes with their estimated probabilities [Categorical models only]. # Corresponds to the JSON property `outputMulti` # @return [Array] attr_accessor :output_multi # The estimated regression value [Regression models only]. # Corresponds to the JSON property `outputValue` # @return [Float] attr_accessor :output_value # A URL to re-request this 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @output_label = args[:output_label] if args.key?(:output_label) @output_multi = args[:output_multi] if args.key?(:output_multi) @output_value = args[:output_value] if args.key?(:output_value) @self_link = args[:self_link] if args.key?(:self_link) end # class OutputMulti include Google::Apis::Core::Hashable # The class label. # Corresponds to the JSON property `label` # @return [String] attr_accessor :label # The probability of the class. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @label = args[:label] if args.key?(:label) @score = args[:score] if args.key?(:score) end end end # class Training include Google::Apis::Core::Hashable # The unique name for the predictive model. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # What kind of resource this is. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Model metadata. # Corresponds to the JSON property `modelInfo` # @return [Google::Apis::PredictionV1_3::Training::ModelInfo] attr_accessor :model_info # A URL to re-request this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The current status of the training job. This can be one of following: RUNNING; # DONE; ERROR; ERROR: TRAINING JOB NOT FOUND # Corresponds to the JSON property `trainingStatus` # @return [String] attr_accessor :training_status # A class weighting function, which allows the importance weights for classes to # be specified [Categorical models only]. # Corresponds to the JSON property `utility` # @return [Array>] attr_accessor :utility def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @model_info = args[:model_info] if args.key?(:model_info) @self_link = args[:self_link] if args.key?(:self_link) @training_status = args[:training_status] if args.key?(:training_status) @utility = args[:utility] if args.key?(:utility) end # Model metadata. class ModelInfo include Google::Apis::Core::Hashable # Estimated accuracy of model taking utility weights into account [Categorical # models only]. # Corresponds to the JSON property `classWeightedAccuracy` # @return [Float] attr_accessor :class_weighted_accuracy # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, # based on the amount and quality of the training data, of the estimated # prediction accuracy. You can use this is a guide to decide whether the results # are accurate enough for your needs. This estimate will be more reliable if # your real input data is similar to your training data [Categorical models only] # . # Corresponds to the JSON property `classificationAccuracy` # @return [Float] attr_accessor :classification_accuracy # An output confusion matrix. This shows an estimate for how this model will do # in predictions. This is first indexed by the true class label. For each true # class label, this provides a pair `predicted_label, count`, where count is the # estimated number of times the model will predict the predicted label given the # true label. Will not output if more then 100 classes [Categorical models only]. # Corresponds to the JSON property `confusionMatrix` # @return [Hash>] attr_accessor :confusion_matrix # A list of the confusion matrix row totals # Corresponds to the JSON property `confusionMatrixRowTotals` # @return [Hash] attr_accessor :confusion_matrix_row_totals # An estimated mean squared error. The can be used to measure the quality of the # predicted model [Regression models only]. # Corresponds to the JSON property `meanSquaredError` # @return [Float] attr_accessor :mean_squared_error # Type of predictive model (CLASSIFICATION or REGRESSION) # Corresponds to the JSON property `modelType` # @return [String] attr_accessor :model_type # Number of classes in the trained model [Categorical models only]. # Corresponds to the JSON property `numberClasses` # @return [Fixnum] attr_accessor :number_classes # Number of valid data instances used in the trained model. # Corresponds to the JSON property `numberInstances` # @return [Fixnum] attr_accessor :number_instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @class_weighted_accuracy = args[:class_weighted_accuracy] if args.key?(:class_weighted_accuracy) @classification_accuracy = args[:classification_accuracy] if args.key?(:classification_accuracy) @confusion_matrix = args[:confusion_matrix] if args.key?(:confusion_matrix) @confusion_matrix_row_totals = args[:confusion_matrix_row_totals] if args.key?(:confusion_matrix_row_totals) @mean_squared_error = args[:mean_squared_error] if args.key?(:mean_squared_error) @model_type = args[:model_type] if args.key?(:model_type) @number_classes = args[:number_classes] if args.key?(:number_classes) @number_instances = args[:number_instances] if args.key?(:number_instances) end end end # class Update include Google::Apis::Core::Hashable # The true class label of this instance # Corresponds to the JSON property `classLabel` # @return [String] attr_accessor :class_label # The input features for this instance # Corresponds to the JSON property `csvInstance` # @return [Array] attr_accessor :csv_instance def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @class_label = args[:class_label] if args.key?(:class_label) @csv_instance = args[:csv_instance] if args.key?(:csv_instance) end end end end end google-api-client-0.19.8/generated/google/apis/prediction_v1_3/service.rb0000644000004100000410000003602513252673044026277 0ustar www-datawww-data# 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 PredictionV1_3 # Prediction API # # Lets you access a cloud hosted machine learning service that makes it easy to # build smart apps # # @example # require 'google/apis/prediction_v1_3' # # Prediction = Google::Apis::PredictionV1_3 # Alias the module # service = Prediction::PredictionService.new # # @see https://developers.google.com/prediction/docs/developer-guide class PredictionService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'prediction/v1.3/') @batch_path = 'batch/prediction/v1.3' end # Submit input and request an output against a hosted model # @param [String] hosted_model_name # The name of a hosted model # @param [Google::Apis::PredictionV1_3::Input] input_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PredictionV1_3::Output] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PredictionV1_3::Output] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def predict_hostedmodel(hosted_model_name, input_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'hostedmodels/{hostedModelName}/predict', options) command.request_representation = Google::Apis::PredictionV1_3::Input::Representation command.request_object = input_object command.response_representation = Google::Apis::PredictionV1_3::Output::Representation command.response_class = Google::Apis::PredictionV1_3::Output command.params['hostedModelName'] = hosted_model_name unless hosted_model_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 # Delete a trained model # @param [String] data # mybucket/mydata resource in Google Storage # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_training(data, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'training/{data}', options) command.params['data'] = data unless data.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 # Check training status of your model # @param [String] data # mybucket/mydata resource in Google Storage # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PredictionV1_3::Training] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PredictionV1_3::Training] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_training(data, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'training/{data}', options) command.response_representation = Google::Apis::PredictionV1_3::Training::Representation command.response_class = Google::Apis::PredictionV1_3::Training command.params['data'] = data unless data.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 # Begin training your model # @param [Google::Apis::PredictionV1_3::Training] training_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PredictionV1_3::Training] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PredictionV1_3::Training] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_training(training_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'training', options) command.request_representation = Google::Apis::PredictionV1_3::Training::Representation command.request_object = training_object command.response_representation = Google::Apis::PredictionV1_3::Training::Representation command.response_class = Google::Apis::PredictionV1_3::Training 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 # Submit data and request a prediction # @param [String] data # mybucket/mydata resource in Google Storage # @param [Google::Apis::PredictionV1_3::Input] input_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PredictionV1_3::Output] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PredictionV1_3::Output] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def predict_training(data, input_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'training/{data}/predict', options) command.request_representation = Google::Apis::PredictionV1_3::Input::Representation command.request_object = input_object command.response_representation = Google::Apis::PredictionV1_3::Output::Representation command.response_class = Google::Apis::PredictionV1_3::Output command.params['data'] = data unless data.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 # Add new data to a trained model # @param [String] data # mybucket/mydata resource in Google Storage # @param [Google::Apis::PredictionV1_3::Update] update_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PredictionV1_3::Training] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PredictionV1_3::Training] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_training(data, update_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'training/{data}', options) command.request_representation = Google::Apis::PredictionV1_3::Update::Representation command.request_object = update_object command.response_representation = Google::Apis::PredictionV1_3::Training::Representation command.response_class = Google::Apis::PredictionV1_3::Training command.params['data'] = data unless data.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 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 end end google-api-client-0.19.8/generated/google/apis/genomics_v1/0000755000004100000410000000000013252673043023525 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/genomics_v1/representations.rb0000644000004100000410000013106413252673043027304 0ustar www-datawww-data# 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 GenomicsV1 class Annotation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnnotationSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchCreateAnnotationsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchCreateAnnotationsResponse 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 CallSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CancelOperationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CigarUnit class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClinicalCondition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CodingSequence class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ComputeEngine class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CoverageBucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Dataset 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 Entry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Exon class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Experiment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExportReadGroupSetRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExportVariantSetRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExternalId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportReadGroupSetsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportReadGroupSetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportVariantsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportVariantsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinearAlignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListBasesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListCoverageBucketsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDatasetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MergeVariantsRequest 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 OperationEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Position class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Program class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Range class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Read class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReadGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReadGroupSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Reference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReferenceBound class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReferenceSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RuntimeMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchAnnotationSetsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchAnnotationSetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchAnnotationsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchAnnotationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchCallSetsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchCallSetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchReadGroupSetsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchReadGroupSetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchReadsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchReadsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchReferenceSetsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchReferenceSetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchReferencesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchReferencesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchVariantSetsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchVariantSetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchVariantsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchVariantsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetIamPolicyRequest 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 TestIamPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Transcript class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UndeleteDatasetRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Variant class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VariantAnnotation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VariantCall class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VariantSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VariantSetMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Annotation # @private class Representation < Google::Apis::Core::JsonRepresentation property :annotation_set_id, as: 'annotationSetId' property :end, :numeric_string => true, as: 'end' property :id, as: 'id' hash :info, as: 'info', :class => Array do include Representable::JSON::Collection items end property :name, as: 'name' property :reference_id, as: 'referenceId' property :reference_name, as: 'referenceName' property :reverse_strand, as: 'reverseStrand' property :start, :numeric_string => true, as: 'start' property :transcript, as: 'transcript', class: Google::Apis::GenomicsV1::Transcript, decorator: Google::Apis::GenomicsV1::Transcript::Representation property :type, as: 'type' property :variant, as: 'variant', class: Google::Apis::GenomicsV1::VariantAnnotation, decorator: Google::Apis::GenomicsV1::VariantAnnotation::Representation end end class AnnotationSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :dataset_id, as: 'datasetId' property :id, as: 'id' hash :info, as: 'info', :class => Array do include Representable::JSON::Collection items end property :name, as: 'name' property :reference_set_id, as: 'referenceSetId' property :source_uri, as: 'sourceUri' property :type, as: 'type' end end class BatchCreateAnnotationsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :annotations, as: 'annotations', class: Google::Apis::GenomicsV1::Annotation, decorator: Google::Apis::GenomicsV1::Annotation::Representation property :request_id, as: 'requestId' end end class BatchCreateAnnotationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::GenomicsV1::Entry, decorator: Google::Apis::GenomicsV1::Entry::Representation end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation collection :members, as: 'members' property :role, as: 'role' end end class CallSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :created, :numeric_string => true, as: 'created' property :id, as: 'id' hash :info, as: 'info', :class => Array do include Representable::JSON::Collection items end property :name, as: 'name' property :sample_id, as: 'sampleId' collection :variant_set_ids, as: 'variantSetIds' end end class CancelOperationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class CigarUnit # @private class Representation < Google::Apis::Core::JsonRepresentation property :operation, as: 'operation' property :operation_length, :numeric_string => true, as: 'operationLength' property :reference_sequence, as: 'referenceSequence' end end class ClinicalCondition # @private class Representation < Google::Apis::Core::JsonRepresentation property :concept_id, as: 'conceptId' collection :external_ids, as: 'externalIds', class: Google::Apis::GenomicsV1::ExternalId, decorator: Google::Apis::GenomicsV1::ExternalId::Representation collection :names, as: 'names' property :omim_id, as: 'omimId' end end class CodingSequence # @private class Representation < Google::Apis::Core::JsonRepresentation property :end, :numeric_string => true, as: 'end' property :start, :numeric_string => true, as: 'start' end end class ComputeEngine # @private class Representation < Google::Apis::Core::JsonRepresentation collection :disk_names, as: 'diskNames' property :instance_name, as: 'instanceName' property :machine_type, as: 'machineType' property :zone, as: 'zone' end end class CoverageBucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :mean_coverage, as: 'meanCoverage' property :range, as: 'range', class: Google::Apis::GenomicsV1::Range, decorator: Google::Apis::GenomicsV1::Range::Representation end end class Dataset # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :id, as: 'id' property :name, as: 'name' property :project_id, as: 'projectId' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Entry # @private class Representation < Google::Apis::Core::JsonRepresentation property :annotation, as: 'annotation', class: Google::Apis::GenomicsV1::Annotation, decorator: Google::Apis::GenomicsV1::Annotation::Representation property :status, as: 'status', class: Google::Apis::GenomicsV1::Status, decorator: Google::Apis::GenomicsV1::Status::Representation end end class Exon # @private class Representation < Google::Apis::Core::JsonRepresentation property :end, :numeric_string => true, as: 'end' property :frame, as: 'frame' property :start, :numeric_string => true, as: 'start' end end class Experiment # @private class Representation < Google::Apis::Core::JsonRepresentation property :instrument_model, as: 'instrumentModel' property :library_id, as: 'libraryId' property :platform_unit, as: 'platformUnit' property :sequencing_center, as: 'sequencingCenter' end end class ExportReadGroupSetRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :export_uri, as: 'exportUri' property :project_id, as: 'projectId' collection :reference_names, as: 'referenceNames' end end class ExportVariantSetRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :bigquery_dataset, as: 'bigqueryDataset' property :bigquery_table, as: 'bigqueryTable' collection :call_set_ids, as: 'callSetIds' property :format, as: 'format' property :project_id, as: 'projectId' end end class ExternalId # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :source_name, as: 'sourceName' end end class GetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ImportReadGroupSetsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :dataset_id, as: 'datasetId' property :partition_strategy, as: 'partitionStrategy' property :reference_set_id, as: 'referenceSetId' collection :source_uris, as: 'sourceUris' end end class ImportReadGroupSetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :read_group_set_ids, as: 'readGroupSetIds' end end class ImportVariantsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :format, as: 'format' hash :info_merge_config, as: 'infoMergeConfig' property :normalize_reference_names, as: 'normalizeReferenceNames' collection :source_uris, as: 'sourceUris' property :variant_set_id, as: 'variantSetId' end end class ImportVariantsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :call_set_ids, as: 'callSetIds' end end class LinearAlignment # @private class Representation < Google::Apis::Core::JsonRepresentation collection :cigar, as: 'cigar', class: Google::Apis::GenomicsV1::CigarUnit, decorator: Google::Apis::GenomicsV1::CigarUnit::Representation property :mapping_quality, as: 'mappingQuality' property :position, as: 'position', class: Google::Apis::GenomicsV1::Position, decorator: Google::Apis::GenomicsV1::Position::Representation end end class ListBasesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' property :offset, :numeric_string => true, as: 'offset' property :sequence, as: 'sequence' end end class ListCoverageBucketsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_width, :numeric_string => true, as: 'bucketWidth' collection :coverage_buckets, as: 'coverageBuckets', class: Google::Apis::GenomicsV1::CoverageBucket, decorator: Google::Apis::GenomicsV1::CoverageBucket::Representation property :next_page_token, as: 'nextPageToken' end end class ListDatasetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :datasets, as: 'datasets', class: Google::Apis::GenomicsV1::Dataset, decorator: Google::Apis::GenomicsV1::Dataset::Representation property :next_page_token, as: 'nextPageToken' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::GenomicsV1::Operation, decorator: Google::Apis::GenomicsV1::Operation::Representation end end class MergeVariantsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation hash :info_merge_config, as: 'infoMergeConfig' property :variant_set_id, as: 'variantSetId' collection :variants, as: 'variants', class: Google::Apis::GenomicsV1::Variant, decorator: Google::Apis::GenomicsV1::Variant::Representation end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::GenomicsV1::Status, decorator: Google::Apis::GenomicsV1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class OperationEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :end_time, as: 'endTime' property :start_time, as: 'startTime' end end class OperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_id, as: 'clientId' property :create_time, as: 'createTime' property :end_time, as: 'endTime' collection :events, as: 'events', class: Google::Apis::GenomicsV1::OperationEvent, decorator: Google::Apis::GenomicsV1::OperationEvent::Representation hash :labels, as: 'labels' property :project_id, as: 'projectId' hash :request, as: 'request' hash :runtime_metadata, as: 'runtimeMetadata' property :start_time, as: 'startTime' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :bindings, as: 'bindings', class: Google::Apis::GenomicsV1::Binding, decorator: Google::Apis::GenomicsV1::Binding::Representation property :etag, :base64 => true, as: 'etag' property :version, as: 'version' end end class Position # @private class Representation < Google::Apis::Core::JsonRepresentation property :position, :numeric_string => true, as: 'position' property :reference_name, as: 'referenceName' property :reverse_strand, as: 'reverseStrand' end end class Program # @private class Representation < Google::Apis::Core::JsonRepresentation property :command_line, as: 'commandLine' property :id, as: 'id' property :name, as: 'name' property :prev_program_id, as: 'prevProgramId' property :version, as: 'version' end end class Range # @private class Representation < Google::Apis::Core::JsonRepresentation property :end, :numeric_string => true, as: 'end' property :reference_name, as: 'referenceName' property :start, :numeric_string => true, as: 'start' end end class Read # @private class Representation < Google::Apis::Core::JsonRepresentation collection :aligned_quality, as: 'alignedQuality' property :aligned_sequence, as: 'alignedSequence' property :alignment, as: 'alignment', class: Google::Apis::GenomicsV1::LinearAlignment, decorator: Google::Apis::GenomicsV1::LinearAlignment::Representation property :duplicate_fragment, as: 'duplicateFragment' property :failed_vendor_quality_checks, as: 'failedVendorQualityChecks' property :fragment_length, as: 'fragmentLength' property :fragment_name, as: 'fragmentName' property :id, as: 'id' hash :info, as: 'info', :class => Array do include Representable::JSON::Collection items end property :next_mate_position, as: 'nextMatePosition', class: Google::Apis::GenomicsV1::Position, decorator: Google::Apis::GenomicsV1::Position::Representation property :number_reads, as: 'numberReads' property :proper_placement, as: 'properPlacement' property :read_group_id, as: 'readGroupId' property :read_group_set_id, as: 'readGroupSetId' property :read_number, as: 'readNumber' property :secondary_alignment, as: 'secondaryAlignment' property :supplementary_alignment, as: 'supplementaryAlignment' end end class ReadGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :dataset_id, as: 'datasetId' property :description, as: 'description' property :experiment, as: 'experiment', class: Google::Apis::GenomicsV1::Experiment, decorator: Google::Apis::GenomicsV1::Experiment::Representation property :id, as: 'id' hash :info, as: 'info', :class => Array do include Representable::JSON::Collection items end property :name, as: 'name' property :predicted_insert_size, as: 'predictedInsertSize' collection :programs, as: 'programs', class: Google::Apis::GenomicsV1::Program, decorator: Google::Apis::GenomicsV1::Program::Representation property :reference_set_id, as: 'referenceSetId' property :sample_id, as: 'sampleId' end end class ReadGroupSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :dataset_id, as: 'datasetId' property :filename, as: 'filename' property :id, as: 'id' hash :info, as: 'info', :class => Array do include Representable::JSON::Collection items end property :name, as: 'name' collection :read_groups, as: 'readGroups', class: Google::Apis::GenomicsV1::ReadGroup, decorator: Google::Apis::GenomicsV1::ReadGroup::Representation property :reference_set_id, as: 'referenceSetId' end end class Reference # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :length, :numeric_string => true, as: 'length' property :md5checksum, as: 'md5checksum' property :name, as: 'name' property :ncbi_taxon_id, as: 'ncbiTaxonId' collection :source_accessions, as: 'sourceAccessions' property :source_uri, as: 'sourceUri' end end class ReferenceBound # @private class Representation < Google::Apis::Core::JsonRepresentation property :reference_name, as: 'referenceName' property :upper_bound, :numeric_string => true, as: 'upperBound' end end class ReferenceSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :assembly_id, as: 'assemblyId' property :description, as: 'description' property :id, as: 'id' property :md5checksum, as: 'md5checksum' property :ncbi_taxon_id, as: 'ncbiTaxonId' collection :reference_ids, as: 'referenceIds' collection :source_accessions, as: 'sourceAccessions' property :source_uri, as: 'sourceUri' end end class RuntimeMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :compute_engine, as: 'computeEngine', class: Google::Apis::GenomicsV1::ComputeEngine, decorator: Google::Apis::GenomicsV1::ComputeEngine::Representation end end class SearchAnnotationSetsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dataset_ids, as: 'datasetIds' property :name, as: 'name' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' property :reference_set_id, as: 'referenceSetId' collection :types, as: 'types' end end class SearchAnnotationSetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :annotation_sets, as: 'annotationSets', class: Google::Apis::GenomicsV1::AnnotationSet, decorator: Google::Apis::GenomicsV1::AnnotationSet::Representation property :next_page_token, as: 'nextPageToken' end end class SearchAnnotationsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :annotation_set_ids, as: 'annotationSetIds' property :end, :numeric_string => true, as: 'end' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' property :reference_id, as: 'referenceId' property :reference_name, as: 'referenceName' property :start, :numeric_string => true, as: 'start' end end class SearchAnnotationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :annotations, as: 'annotations', class: Google::Apis::GenomicsV1::Annotation, decorator: Google::Apis::GenomicsV1::Annotation::Representation property :next_page_token, as: 'nextPageToken' end end class SearchCallSetsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' collection :variant_set_ids, as: 'variantSetIds' end end class SearchCallSetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :call_sets, as: 'callSets', class: Google::Apis::GenomicsV1::CallSet, decorator: Google::Apis::GenomicsV1::CallSet::Representation property :next_page_token, as: 'nextPageToken' end end class SearchReadGroupSetsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dataset_ids, as: 'datasetIds' property :name, as: 'name' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' end end class SearchReadGroupSetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :read_group_sets, as: 'readGroupSets', class: Google::Apis::GenomicsV1::ReadGroupSet, decorator: Google::Apis::GenomicsV1::ReadGroupSet::Representation end end class SearchReadsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :end, :numeric_string => true, as: 'end' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' collection :read_group_ids, as: 'readGroupIds' collection :read_group_set_ids, as: 'readGroupSetIds' property :reference_name, as: 'referenceName' property :start, :numeric_string => true, as: 'start' end end class SearchReadsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :alignments, as: 'alignments', class: Google::Apis::GenomicsV1::Read, decorator: Google::Apis::GenomicsV1::Read::Representation property :next_page_token, as: 'nextPageToken' end end class SearchReferenceSetsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accessions, as: 'accessions' property :assembly_id, as: 'assemblyId' collection :md5checksums, as: 'md5checksums' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' end end class SearchReferenceSetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :reference_sets, as: 'referenceSets', class: Google::Apis::GenomicsV1::ReferenceSet, decorator: Google::Apis::GenomicsV1::ReferenceSet::Representation end end class SearchReferencesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accessions, as: 'accessions' collection :md5checksums, as: 'md5checksums' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' property :reference_set_id, as: 'referenceSetId' end end class SearchReferencesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :references, as: 'references', class: Google::Apis::GenomicsV1::Reference, decorator: Google::Apis::GenomicsV1::Reference::Representation end end class SearchVariantSetsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dataset_ids, as: 'datasetIds' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' end end class SearchVariantSetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :variant_sets, as: 'variantSets', class: Google::Apis::GenomicsV1::VariantSet, decorator: Google::Apis::GenomicsV1::VariantSet::Representation end end class SearchVariantsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :call_set_ids, as: 'callSetIds' property :end, :numeric_string => true, as: 'end' property :max_calls, as: 'maxCalls' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' property :reference_name, as: 'referenceName' property :start, :numeric_string => true, as: 'start' property :variant_name, as: 'variantName' collection :variant_set_ids, as: 'variantSetIds' end end class SearchVariantsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :variants, as: 'variants', class: Google::Apis::GenomicsV1::Variant, decorator: Google::Apis::GenomicsV1::Variant::Representation end end class SetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :policy, as: 'policy', class: Google::Apis::GenomicsV1::Policy, decorator: Google::Apis::GenomicsV1::Policy::Representation 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 TestIamPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestIamPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class Transcript # @private class Representation < Google::Apis::Core::JsonRepresentation property :coding_sequence, as: 'codingSequence', class: Google::Apis::GenomicsV1::CodingSequence, decorator: Google::Apis::GenomicsV1::CodingSequence::Representation collection :exons, as: 'exons', class: Google::Apis::GenomicsV1::Exon, decorator: Google::Apis::GenomicsV1::Exon::Representation property :gene_id, as: 'geneId' end end class UndeleteDatasetRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Variant # @private class Representation < Google::Apis::Core::JsonRepresentation collection :alternate_bases, as: 'alternateBases' collection :calls, as: 'calls', class: Google::Apis::GenomicsV1::VariantCall, decorator: Google::Apis::GenomicsV1::VariantCall::Representation property :created, :numeric_string => true, as: 'created' property :end, :numeric_string => true, as: 'end' collection :filter, as: 'filter' property :id, as: 'id' hash :info, as: 'info', :class => Array do include Representable::JSON::Collection items end collection :names, as: 'names' property :quality, as: 'quality' property :reference_bases, as: 'referenceBases' property :reference_name, as: 'referenceName' property :start, :numeric_string => true, as: 'start' property :variant_set_id, as: 'variantSetId' end end class VariantAnnotation # @private class Representation < Google::Apis::Core::JsonRepresentation property :alternate_bases, as: 'alternateBases' property :clinical_significance, as: 'clinicalSignificance' collection :conditions, as: 'conditions', class: Google::Apis::GenomicsV1::ClinicalCondition, decorator: Google::Apis::GenomicsV1::ClinicalCondition::Representation property :effect, as: 'effect' property :gene_id, as: 'geneId' collection :transcript_ids, as: 'transcriptIds' property :type, as: 'type' end end class VariantCall # @private class Representation < Google::Apis::Core::JsonRepresentation property :call_set_id, as: 'callSetId' property :call_set_name, as: 'callSetName' collection :genotype, as: 'genotype' collection :genotype_likelihood, as: 'genotypeLikelihood' hash :info, as: 'info', :class => Array do include Representable::JSON::Collection items end property :phaseset, as: 'phaseset' end end class VariantSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :dataset_id, as: 'datasetId' property :description, as: 'description' property :id, as: 'id' collection :metadata, as: 'metadata', class: Google::Apis::GenomicsV1::VariantSetMetadata, decorator: Google::Apis::GenomicsV1::VariantSetMetadata::Representation property :name, as: 'name' collection :reference_bounds, as: 'referenceBounds', class: Google::Apis::GenomicsV1::ReferenceBound, decorator: Google::Apis::GenomicsV1::ReferenceBound::Representation property :reference_set_id, as: 'referenceSetId' end end class VariantSetMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :id, as: 'id' hash :info, as: 'info', :class => Array do include Representable::JSON::Collection items end property :key, as: 'key' property :number, as: 'number' property :type, as: 'type' property :value, as: 'value' end end end end end google-api-client-0.19.8/generated/google/apis/genomics_v1/classes.rb0000644000004100000410000043566213252673043025527 0ustar www-datawww-data# 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 GenomicsV1 # An annotation describes a region of reference genome. The value of an # annotation may be one of several canonical types, supplemented by arbitrary # info tags. An annotation is not inherently associated with a specific # sample or individual (though a client could choose to use annotations in # this way). Example canonical annotation types are `GENE` and # `VARIANT`. class Annotation include Google::Apis::Core::Hashable # The annotation set to which this annotation belongs. # Corresponds to the JSON property `annotationSetId` # @return [String] attr_accessor :annotation_set_id # The end position of the range on the reference, 0-based exclusive. # Corresponds to the JSON property `end` # @return [Fixnum] attr_accessor :end # The server-generated annotation ID, unique across all annotations. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A map of additional read alignment information. This must be of the form # map (string key mapping to a list of string values). # Corresponds to the JSON property `info` # @return [Hash>] attr_accessor :info # The display name of this annotation. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The ID of the Google Genomics reference associated with this range. # Corresponds to the JSON property `referenceId` # @return [String] attr_accessor :reference_id # The display name corresponding to the reference specified by # `referenceId`, for example `chr1`, `1`, or `chrX`. # Corresponds to the JSON property `referenceName` # @return [String] attr_accessor :reference_name # Whether this range refers to the reverse strand, as opposed to the forward # strand. Note that regardless of this field, the start/end position of the # range always refer to the forward strand. # Corresponds to the JSON property `reverseStrand` # @return [Boolean] attr_accessor :reverse_strand alias_method :reverse_strand?, :reverse_strand # The start position of the range on the reference, 0-based inclusive. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start # A transcript represents the assertion that a particular region of the # reference genome may be transcribed as RNA. # Corresponds to the JSON property `transcript` # @return [Google::Apis::GenomicsV1::Transcript] attr_accessor :transcript # The data type for this annotation. Must match the containing annotation # set's type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # A variant annotation, which describes the effect of a variant on the # genome, the coding sequence, and/or higher level consequences at the # organism level e.g. pathogenicity. This field is only set for annotations # of type `VARIANT`. # Corresponds to the JSON property `variant` # @return [Google::Apis::GenomicsV1::VariantAnnotation] attr_accessor :variant def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @annotation_set_id = args[:annotation_set_id] if args.key?(:annotation_set_id) @end = args[:end] if args.key?(:end) @id = args[:id] if args.key?(:id) @info = args[:info] if args.key?(:info) @name = args[:name] if args.key?(:name) @reference_id = args[:reference_id] if args.key?(:reference_id) @reference_name = args[:reference_name] if args.key?(:reference_name) @reverse_strand = args[:reverse_strand] if args.key?(:reverse_strand) @start = args[:start] if args.key?(:start) @transcript = args[:transcript] if args.key?(:transcript) @type = args[:type] if args.key?(:type) @variant = args[:variant] if args.key?(:variant) end end # An annotation set is a logical grouping of annotations that share consistent # type information and provenance. Examples of annotation sets include 'all # genes from refseq', and 'all variant annotations from ClinVar'. class AnnotationSet include Google::Apis::Core::Hashable # The dataset to which this annotation set belongs. # Corresponds to the JSON property `datasetId` # @return [String] attr_accessor :dataset_id # The server-generated annotation set ID, unique across all annotation sets. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A map of additional read alignment information. This must be of the form # map (string key mapping to a list of string values). # Corresponds to the JSON property `info` # @return [Hash>] attr_accessor :info # The display name for this annotation set. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The ID of the reference set that defines the coordinate space for this # set's annotations. # Corresponds to the JSON property `referenceSetId` # @return [String] attr_accessor :reference_set_id # The source URI describing the file from which this annotation set was # generated, if any. # Corresponds to the JSON property `sourceUri` # @return [String] attr_accessor :source_uri # The type of annotations contained within this set. # 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) @dataset_id = args[:dataset_id] if args.key?(:dataset_id) @id = args[:id] if args.key?(:id) @info = args[:info] if args.key?(:info) @name = args[:name] if args.key?(:name) @reference_set_id = args[:reference_set_id] if args.key?(:reference_set_id) @source_uri = args[:source_uri] if args.key?(:source_uri) @type = args[:type] if args.key?(:type) end end # class BatchCreateAnnotationsRequest include Google::Apis::Core::Hashable # The annotations to be created. At most 4096 can be specified in a single # request. # Corresponds to the JSON property `annotations` # @return [Array] attr_accessor :annotations # A unique request ID which enables the server to detect duplicated requests. # If provided, duplicated requests will result in the same response; if not # provided, duplicated requests may result in duplicated data. For a given # annotation set, callers should not reuse `request_id`s when writing # different batches of annotations - behavior in this case is undefined. # A common approach is to use a UUID. For batch jobs where worker crashes are # a possibility, consider using some unique variant of a worker or run ID. # Corresponds to the JSON property `requestId` # @return [String] attr_accessor :request_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @annotations = args[:annotations] if args.key?(:annotations) @request_id = args[:request_id] if args.key?(:request_id) end end # class BatchCreateAnnotationsResponse include Google::Apis::Core::Hashable # The resulting per-annotation entries, ordered consistently with the # original request. # 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) @entries = args[:entries] if args.key?(:entries) end end # Associates `members` with a `role`. class Binding include Google::Apis::Core::Hashable # 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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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`. # Required # 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) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end # A call set is a collection of variant calls, typically for one sample. It # belongs to a variant set. # For more genomics resource definitions, see [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) class CallSet include Google::Apis::Core::Hashable # The date this call set was created in milliseconds from the epoch. # Corresponds to the JSON property `created` # @return [Fixnum] attr_accessor :created # The server-generated call set ID, unique across all call sets. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A map of additional call set information. This must be of the form # map (string key mapping to a list of string values). # Corresponds to the JSON property `info` # @return [Hash>] attr_accessor :info # The call set name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The sample ID this call set corresponds to. # Corresponds to the JSON property `sampleId` # @return [String] attr_accessor :sample_id # The IDs of the variant sets this call set belongs to. This field must # have exactly length one, as a call set belongs to a single variant set. # This field is repeated for compatibility with the # [GA4GH 0.5.1 # API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/ # variants.avdl#L76). # Corresponds to the JSON property `variantSetIds` # @return [Array] attr_accessor :variant_set_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @created = args[:created] if args.key?(:created) @id = args[:id] if args.key?(:id) @info = args[:info] if args.key?(:info) @name = args[:name] if args.key?(:name) @sample_id = args[:sample_id] if args.key?(:sample_id) @variant_set_ids = args[:variant_set_ids] if args.key?(:variant_set_ids) end end # The request message for Operations.CancelOperation. class CancelOperationRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # A single CIGAR operation. class CigarUnit include Google::Apis::Core::Hashable # # Corresponds to the JSON property `operation` # @return [String] attr_accessor :operation # The number of genomic bases that the operation runs for. Required. # Corresponds to the JSON property `operationLength` # @return [Fixnum] attr_accessor :operation_length # `referenceSequence` is only used at mismatches # (`SEQUENCE_MISMATCH`) and deletions (`DELETE`). # Filling this field replaces SAM's MD tag. If the relevant information is # not available, this field is unset. # Corresponds to the JSON property `referenceSequence` # @return [String] attr_accessor :reference_sequence def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @operation = args[:operation] if args.key?(:operation) @operation_length = args[:operation_length] if args.key?(:operation_length) @reference_sequence = args[:reference_sequence] if args.key?(:reference_sequence) end end # class ClinicalCondition include Google::Apis::Core::Hashable # The MedGen concept id associated with this gene. # Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/ # Corresponds to the JSON property `conceptId` # @return [String] attr_accessor :concept_id # The set of external IDs for this condition. # Corresponds to the JSON property `externalIds` # @return [Array] attr_accessor :external_ids # A set of names for the condition. # Corresponds to the JSON property `names` # @return [Array] attr_accessor :names # The OMIM id for this condition. # Search for these IDs at http://omim.org/ # Corresponds to the JSON property `omimId` # @return [String] attr_accessor :omim_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @concept_id = args[:concept_id] if args.key?(:concept_id) @external_ids = args[:external_ids] if args.key?(:external_ids) @names = args[:names] if args.key?(:names) @omim_id = args[:omim_id] if args.key?(:omim_id) end end # class CodingSequence include Google::Apis::Core::Hashable # The end of the coding sequence on this annotation's reference sequence, # 0-based exclusive. Note that this position is relative to the reference # start, and *not* the containing annotation start. # Corresponds to the JSON property `end` # @return [Fixnum] attr_accessor :end # The start of the coding sequence on this annotation's reference sequence, # 0-based inclusive. Note that this position is relative to the reference # start, and *not* the containing annotation start. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end = args[:end] if args.key?(:end) @start = args[:start] if args.key?(:start) end end # Describes a Compute Engine resource that is being managed by a running # pipeline. class ComputeEngine include Google::Apis::Core::Hashable # The names of the disks that were created for this pipeline. # Corresponds to the JSON property `diskNames` # @return [Array] attr_accessor :disk_names # The instance on which the operation is running. # Corresponds to the JSON property `instanceName` # @return [String] attr_accessor :instance_name # The machine type of the instance. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type # The availability zone in which the instance resides. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disk_names = args[:disk_names] if args.key?(:disk_names) @instance_name = args[:instance_name] if args.key?(:instance_name) @machine_type = args[:machine_type] if args.key?(:machine_type) @zone = args[:zone] if args.key?(:zone) end end # A bucket over which read coverage has been precomputed. A bucket corresponds # to a specific range of the reference sequence. class CoverageBucket include Google::Apis::Core::Hashable # The average number of reads which are aligned to each individual # reference base in this bucket. # Corresponds to the JSON property `meanCoverage` # @return [Float] attr_accessor :mean_coverage # A 0-based half-open genomic coordinate range for search requests. # Corresponds to the JSON property `range` # @return [Google::Apis::GenomicsV1::Range] attr_accessor :range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @mean_coverage = args[:mean_coverage] if args.key?(:mean_coverage) @range = args[:range] if args.key?(:range) end end # A Dataset is a collection of genomic data. # For more genomics resource definitions, see [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) class Dataset include Google::Apis::Core::Hashable # The time this dataset was created, in seconds from the epoch. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The server-generated dataset ID, unique across all datasets. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The dataset name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Cloud project ID that this dataset belongs to. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) 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 # class Entry include Google::Apis::Core::Hashable # An annotation describes a region of reference genome. The value of an # annotation may be one of several canonical types, supplemented by arbitrary # info tags. An annotation is not inherently associated with a specific # sample or individual (though a client could choose to use annotations in # this way). Example canonical annotation types are `GENE` and # `VARIANT`. # Corresponds to the JSON property `annotation` # @return [Google::Apis::GenomicsV1::Annotation] attr_accessor :annotation # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `status` # @return [Google::Apis::GenomicsV1::Status] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @annotation = args[:annotation] if args.key?(:annotation) @status = args[:status] if args.key?(:status) end end # class Exon include Google::Apis::Core::Hashable # The end position of the exon on this annotation's reference sequence, # 0-based exclusive. Note that this is relative to the reference start, and # *not* the containing annotation start. # Corresponds to the JSON property `end` # @return [Fixnum] attr_accessor :end # The frame of this exon. Contains a value of 0, 1, or 2, which indicates # the offset of the first coding base of the exon within the reading frame # of the coding DNA sequence, if any. This field is dependent on the # strandedness of this annotation (see # Annotation.reverse_strand). # For forward stranded annotations, this offset is relative to the # exon.start. For reverse # strand annotations, this offset is relative to the # exon.end `- 1`. # Unset if this exon does not intersect the coding sequence. Upon creation # of a transcript, the frame must be populated for all or none of the # coding exons. # Corresponds to the JSON property `frame` # @return [Fixnum] attr_accessor :frame # The start position of the exon on this annotation's reference sequence, # 0-based inclusive. Note that this is relative to the reference start, and # **not** the containing annotation start. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end = args[:end] if args.key?(:end) @frame = args[:frame] if args.key?(:frame) @start = args[:start] if args.key?(:start) end end # class Experiment include Google::Apis::Core::Hashable # The instrument model used as part of this experiment. This maps to # sequencing technology in the SAM spec. # Corresponds to the JSON property `instrumentModel` # @return [String] attr_accessor :instrument_model # A client-supplied library identifier; a library is a collection of DNA # fragments which have been prepared for sequencing from a sample. This # field is important for quality control as error or bias can be introduced # during sample preparation. # Corresponds to the JSON property `libraryId` # @return [String] attr_accessor :library_id # The platform unit used as part of this experiment, for example # flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the # @RG PU field in the SAM spec. # Corresponds to the JSON property `platformUnit` # @return [String] attr_accessor :platform_unit # The sequencing center used as part of this experiment. # Corresponds to the JSON property `sequencingCenter` # @return [String] attr_accessor :sequencing_center def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instrument_model = args[:instrument_model] if args.key?(:instrument_model) @library_id = args[:library_id] if args.key?(:library_id) @platform_unit = args[:platform_unit] if args.key?(:platform_unit) @sequencing_center = args[:sequencing_center] if args.key?(:sequencing_center) end end # The read group set export request. class ExportReadGroupSetRequest include Google::Apis::Core::Hashable # Required. A Google Cloud Storage URI for the exported BAM file. # The currently authenticated user must have write access to the new file. # An error will be returned if the URI already contains data. # Corresponds to the JSON property `exportUri` # @return [String] attr_accessor :export_uri # Required. The Google Cloud project ID that owns this # export. The caller must have WRITE access to this project. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The reference names to export. If this is not specified, all reference # sequences, including unmapped reads, are exported. # Use `*` to export only unmapped reads. # Corresponds to the JSON property `referenceNames` # @return [Array] attr_accessor :reference_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @export_uri = args[:export_uri] if args.key?(:export_uri) @project_id = args[:project_id] if args.key?(:project_id) @reference_names = args[:reference_names] if args.key?(:reference_names) end end # The variant data export request. class ExportVariantSetRequest include Google::Apis::Core::Hashable # Required. The BigQuery dataset to export data to. This dataset must already # exist. Note that this is distinct from the Genomics concept of "dataset". # Corresponds to the JSON property `bigqueryDataset` # @return [String] attr_accessor :bigquery_dataset # Required. The BigQuery table to export data to. # If the table doesn't exist, it will be created. If it already exists, it # will be overwritten. # Corresponds to the JSON property `bigqueryTable` # @return [String] attr_accessor :bigquery_table # If provided, only variant call information from the specified call sets # will be exported. By default all variant calls are exported. # Corresponds to the JSON property `callSetIds` # @return [Array] attr_accessor :call_set_ids # The format for the exported data. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # Required. The Google Cloud project ID that owns the destination # BigQuery dataset. The caller must have WRITE access to this project. This # project will also own the resulting export job. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bigquery_dataset = args[:bigquery_dataset] if args.key?(:bigquery_dataset) @bigquery_table = args[:bigquery_table] if args.key?(:bigquery_table) @call_set_ids = args[:call_set_ids] if args.key?(:call_set_ids) @format = args[:format] if args.key?(:format) @project_id = args[:project_id] if args.key?(:project_id) end end # class ExternalId include Google::Apis::Core::Hashable # The id used by the source of this data. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The name of the source of this data. # Corresponds to the JSON property `sourceName` # @return [String] attr_accessor :source_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @source_name = args[:source_name] if args.key?(:source_name) end end # Request message for `GetIamPolicy` method. class GetIamPolicyRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The read group set import request. class ImportReadGroupSetsRequest include Google::Apis::Core::Hashable # Required. The ID of the dataset these read group sets will belong to. The # caller must have WRITE permissions to this dataset. # Corresponds to the JSON property `datasetId` # @return [String] attr_accessor :dataset_id # The partition strategy describes how read groups are partitioned into read # group sets. # Corresponds to the JSON property `partitionStrategy` # @return [String] attr_accessor :partition_strategy # The reference set to which the imported read group sets are aligned to, if # any. The reference names of this reference set must be a superset of those # found in the imported file headers. If no reference set id is provided, a # best effort is made to associate with a matching reference set. # Corresponds to the JSON property `referenceSetId` # @return [String] attr_accessor :reference_set_id # A list of URIs pointing at [BAM # files](https://samtools.github.io/hts-specs/SAMv1.pdf) # in Google Cloud Storage. # Those URIs can include wildcards (*), but do not add or remove # matching files before import has completed. # Note that Google Cloud Storage object listing is only eventually # consistent: files added may be not be immediately visible to # everyone. Thus, if using a wildcard it is preferable not to start # the import immediately after the files are created. # Corresponds to the JSON property `sourceUris` # @return [Array] attr_accessor :source_uris def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dataset_id = args[:dataset_id] if args.key?(:dataset_id) @partition_strategy = args[:partition_strategy] if args.key?(:partition_strategy) @reference_set_id = args[:reference_set_id] if args.key?(:reference_set_id) @source_uris = args[:source_uris] if args.key?(:source_uris) end end # The read group set import response. class ImportReadGroupSetsResponse include Google::Apis::Core::Hashable # IDs of the read group sets that were created. # Corresponds to the JSON property `readGroupSetIds` # @return [Array] attr_accessor :read_group_set_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @read_group_set_ids = args[:read_group_set_ids] if args.key?(:read_group_set_ids) end end # The variant data import request. class ImportVariantsRequest include Google::Apis::Core::Hashable # The format of the variant data being imported. If unspecified, defaults to # to `VCF`. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # A mapping between info field keys and the InfoMergeOperations to # be performed on them. This is plumbed down to the MergeVariantRequests # generated by the resulting import job. # Corresponds to the JSON property `infoMergeConfig` # @return [Hash] attr_accessor :info_merge_config # Convert reference names to the canonical representation. # hg19 haploytypes (those reference names containing "_hap") # are not modified in any way. # All other reference names are modified according to the following rules: # The reference name is capitalized. # The "chr" prefix is dropped for all autosomes and sex chromsomes. # For example "chr17" becomes "17" and "chrX" becomes "X". # All mitochondrial chromosomes ("chrM", "chrMT", etc) become "MT". # Corresponds to the JSON property `normalizeReferenceNames` # @return [Boolean] attr_accessor :normalize_reference_names alias_method :normalize_reference_names?, :normalize_reference_names # A list of URIs referencing variant files in Google Cloud Storage. URIs can # include wildcards [as described # here](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). # Note that recursive wildcards ('**') are not supported. # Corresponds to the JSON property `sourceUris` # @return [Array] attr_accessor :source_uris # Required. The variant set to which variant data should be imported. # Corresponds to the JSON property `variantSetId` # @return [String] attr_accessor :variant_set_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @format = args[:format] if args.key?(:format) @info_merge_config = args[:info_merge_config] if args.key?(:info_merge_config) @normalize_reference_names = args[:normalize_reference_names] if args.key?(:normalize_reference_names) @source_uris = args[:source_uris] if args.key?(:source_uris) @variant_set_id = args[:variant_set_id] if args.key?(:variant_set_id) end end # The variant data import response. class ImportVariantsResponse include Google::Apis::Core::Hashable # IDs of the call sets created during the import. # Corresponds to the JSON property `callSetIds` # @return [Array] attr_accessor :call_set_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @call_set_ids = args[:call_set_ids] if args.key?(:call_set_ids) end end # A linear alignment can be represented by one CIGAR string. Describes the # mapped position and local alignment of the read to the reference. class LinearAlignment include Google::Apis::Core::Hashable # Represents the local alignment of this sequence (alignment matches, indels, # etc) against the reference. # Corresponds to the JSON property `cigar` # @return [Array] attr_accessor :cigar # The mapping quality of this alignment. Represents how likely # the read maps to this position as opposed to other locations. # Specifically, this is -10 log10 Pr(mapping position is wrong), rounded to # the nearest integer. # Corresponds to the JSON property `mappingQuality` # @return [Fixnum] attr_accessor :mapping_quality # An abstraction for referring to a genomic position, in relation to some # already known reference. For now, represents a genomic position as a # reference name, a base number on that reference (0-based), and a # determination of forward or reverse strand. # Corresponds to the JSON property `position` # @return [Google::Apis::GenomicsV1::Position] attr_accessor :position def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cigar = args[:cigar] if args.key?(:cigar) @mapping_quality = args[:mapping_quality] if args.key?(:mapping_quality) @position = args[:position] if args.key?(:position) end end # class ListBasesResponse include Google::Apis::Core::Hashable # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The offset position (0-based) of the given `sequence` from the # start of this `Reference`. This value will differ for each page # in a paginated request. # Corresponds to the JSON property `offset` # @return [Fixnum] attr_accessor :offset # A substring of the bases that make up this reference. # Corresponds to the JSON property `sequence` # @return [String] attr_accessor :sequence 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) @offset = args[:offset] if args.key?(:offset) @sequence = args[:sequence] if args.key?(:sequence) end end # class ListCoverageBucketsResponse include Google::Apis::Core::Hashable # The length of each coverage bucket in base pairs. Note that buckets at the # end of a reference sequence may be shorter. This value is omitted if the # bucket width is infinity (the default behaviour, with no range or # `targetBucketWidth`). # Corresponds to the JSON property `bucketWidth` # @return [Fixnum] attr_accessor :bucket_width # The coverage buckets. The list of buckets is sparse; a bucket with 0 # overlapping reads is not returned. A bucket never crosses more than one # reference sequence. Each bucket has width `bucketWidth`, unless # its end is the end of the reference sequence. # Corresponds to the JSON property `coverageBuckets` # @return [Array] attr_accessor :coverage_buckets # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional 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) @bucket_width = args[:bucket_width] if args.key?(:bucket_width) @coverage_buckets = args[:coverage_buckets] if args.key?(:coverage_buckets) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The dataset list response. class ListDatasetsResponse include Google::Apis::Core::Hashable # The list of matching Datasets. # Corresponds to the JSON property `datasets` # @return [Array] attr_accessor :datasets # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional 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) @datasets = args[:datasets] if args.key?(:datasets) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Operations.ListOperations. class ListOperationsResponse 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 # class MergeVariantsRequest include Google::Apis::Core::Hashable # A mapping between info field keys and the InfoMergeOperations to # be performed on them. # Corresponds to the JSON property `infoMergeConfig` # @return [Hash] attr_accessor :info_merge_config # The destination variant set. # Corresponds to the JSON property `variantSetId` # @return [String] attr_accessor :variant_set_id # The variants to be merged with existing variants. # Corresponds to the JSON property `variants` # @return [Array] attr_accessor :variants def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @info_merge_config = args[:info_merge_config] if args.key?(:info_merge_config) @variant_set_id = args[:variant_set_id] if args.key?(:variant_set_id) @variants = args[:variants] if args.key?(:variants) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::GenomicsV1::Status] attr_accessor :error # An OperationMetadata object. This will always be returned with the Operation. # 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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL- # qzoWAgEw` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If # importing Variants, an ImportVariantsResponse is returned. For pipelines and # exports, an Empty response is returned. # 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 # An event that occurred during an Operation. class OperationEvent include Google::Apis::Core::Hashable # Required description of event. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional time of when event finished. An event can have a start time and no # finish time. If an event has a finish time, there must be a start time. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Optional time of when event started. # 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) @description = args[:description] if args.key?(:description) @end_time = args[:end_time] if args.key?(:end_time) @start_time = args[:start_time] if args.key?(:start_time) end end # Metadata describing an Operation. class OperationMetadata include Google::Apis::Core::Hashable # This field is deprecated. Use `labels` instead. Optionally provided by the # caller when submitting the request that creates the operation. # Corresponds to the JSON property `clientId` # @return [String] attr_accessor :client_id # The time at which the job was submitted to the Genomics service. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The time at which the job stopped running. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Optional event messages that were generated during the job's execution. # This also contains any warnings that were generated during import # or export. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events # Optionally provided by the caller when submitting the request that creates # the operation. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The Google Cloud Project in which the job is scoped. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The original request that started the operation. Note that this will be in # current version of the API. If the operation was started with v1beta2 API # and a GetOperation is performed on v1 API, a v1 request will be returned. # Corresponds to the JSON property `request` # @return [Hash] attr_accessor :request # Runtime metadata on this Operation. # Corresponds to the JSON property `runtimeMetadata` # @return [Hash] attr_accessor :runtime_metadata # The time at which the job began to run. # 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) @client_id = args[:client_id] if args.key?(:client_id) @create_time = args[:create_time] if args.key?(:create_time) @end_time = args[:end_time] if args.key?(:end_time) @events = args[:events] if args.key?(:events) @labels = args[:labels] if args.key?(:labels) @project_id = args[:project_id] if args.key?(:project_id) @request = args[:request] if args.key?(:request) @runtime_metadata = args[:runtime_metadata] if args.key?(:runtime_metadata) @start_time = args[:start_time] if args.key?(:start_time) end end # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). class Policy include Google::Apis::Core::Hashable # Associates a list of `members` to a `role`. # `bindings` with no members will result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # Deprecated. # 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) @bindings = args[:bindings] if args.key?(:bindings) @etag = args[:etag] if args.key?(:etag) @version = args[:version] if args.key?(:version) end end # An abstraction for referring to a genomic position, in relation to some # already known reference. For now, represents a genomic position as a # reference name, a base number on that reference (0-based), and a # determination of forward or reverse strand. class Position include Google::Apis::Core::Hashable # The 0-based offset from the start of the forward strand for that reference. # Corresponds to the JSON property `position` # @return [Fixnum] attr_accessor :position # The name of the reference in whatever reference set is being used. # Corresponds to the JSON property `referenceName` # @return [String] attr_accessor :reference_name # Whether this position is on the reverse strand, as opposed to the forward # strand. # Corresponds to the JSON property `reverseStrand` # @return [Boolean] attr_accessor :reverse_strand alias_method :reverse_strand?, :reverse_strand def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @position = args[:position] if args.key?(:position) @reference_name = args[:reference_name] if args.key?(:reference_name) @reverse_strand = args[:reverse_strand] if args.key?(:reverse_strand) end end # class Program include Google::Apis::Core::Hashable # The command line used to run this program. # Corresponds to the JSON property `commandLine` # @return [String] attr_accessor :command_line # The user specified locally unique ID of the program. Used along with # `prevProgramId` to define an ordering between programs. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The display name of the program. This is typically the colloquial name of # the tool used, for example 'bwa' or 'picard'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The ID of the program run before this one. # Corresponds to the JSON property `prevProgramId` # @return [String] attr_accessor :prev_program_id # The version of the program run. # 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) @command_line = args[:command_line] if args.key?(:command_line) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @prev_program_id = args[:prev_program_id] if args.key?(:prev_program_id) @version = args[:version] if args.key?(:version) end end # A 0-based half-open genomic coordinate range for search requests. class Range include Google::Apis::Core::Hashable # The end position of the range on the reference, 0-based exclusive. # Corresponds to the JSON property `end` # @return [Fixnum] attr_accessor :end # The reference sequence name, for example `chr1`, # `1`, or `chrX`. # Corresponds to the JSON property `referenceName` # @return [String] attr_accessor :reference_name # The start position of the range on the reference, 0-based inclusive. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end = args[:end] if args.key?(:end) @reference_name = args[:reference_name] if args.key?(:reference_name) @start = args[:start] if args.key?(:start) end end # A read alignment describes a linear alignment of a string of DNA to a # reference sequence, in addition to metadata # about the fragment (the molecule of DNA sequenced) and the read (the bases # which were read by the sequencer). A read is equivalent to a line in a SAM # file. A read belongs to exactly one read group and exactly one # read group set. # For more genomics resource definitions, see [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # ### Reverse-stranded reads # Mapped reads (reads having a non-null `alignment`) can be aligned to either # the forward or the reverse strand of their associated reference. Strandedness # of a mapped read is encoded by `alignment.position.reverseStrand`. # If we consider the reference to be a forward-stranded coordinate space of # `[0, reference.length)` with `0` as the left-most position and # `reference.length` as the right-most position, reads are always aligned left # to right. That is, `alignment.position.position` always refers to the # left-most reference coordinate and `alignment.cigar` describes the alignment # of this read to the reference from left to right. All per-base fields such as # `alignedSequence` and `alignedQuality` share this same left-to-right # orientation; this is true of reads which are aligned to either strand. For # reverse-stranded reads, this means that `alignedSequence` is the reverse # complement of the bases that were originally reported by the sequencing # machine. # ### Generating a reference-aligned sequence string # When interacting with mapped reads, it's often useful to produce a string # representing the local alignment of the read to reference. The following # pseudocode demonstrates one way of doing this: # out = "" # offset = 0 # for c in read.alignment.cigar ` # switch c.operation ` # case "ALIGNMENT_MATCH", "SEQUENCE_MATCH", "SEQUENCE_MISMATCH": # out += read.alignedSequence[offset:offset+c.operationLength] # offset += c.operationLength # break # case "CLIP_SOFT", "INSERT": # offset += c.operationLength # break # case "PAD": # out += repeat("*", c.operationLength) # break # case "DELETE": # out += repeat("-", c.operationLength) # break # case "SKIP": # out += repeat(" ", c.operationLength) # break # case "CLIP_HARD": # break # ` # ` # return out # ### Converting to SAM's CIGAR string # The following pseudocode generates a SAM CIGAR string from the # `cigar` field. Note that this is a lossy conversion # (`cigar.referenceSequence` is lost). # cigarMap = ` # "ALIGNMENT_MATCH": "M", # "INSERT": "I", # "DELETE": "D", # "SKIP": "N", # "CLIP_SOFT": "S", # "CLIP_HARD": "H", # "PAD": "P", # "SEQUENCE_MATCH": "=", # "SEQUENCE_MISMATCH": "X", # ` # cigarStr = "" # for c in read.alignment.cigar ` # cigarStr += c.operationLength + cigarMap[c.operation] # ` # return cigarStr class Read include Google::Apis::Core::Hashable # The quality of the read sequence contained in this alignment record # (equivalent to QUAL in SAM). # `alignedSequence` and `alignedQuality` may be shorter than the full read # sequence and quality. This will occur if the alignment is part of a # chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR # for this read will begin/end with a hard clip operator that will indicate # the length of the excised sequence. # Corresponds to the JSON property `alignedQuality` # @return [Array] attr_accessor :aligned_quality # The bases of the read sequence contained in this alignment record, # **without CIGAR operations applied** (equivalent to SEQ in SAM). # `alignedSequence` and `alignedQuality` may be # shorter than the full read sequence and quality. This will occur if the # alignment is part of a chimeric alignment, or if the read was trimmed. When # this occurs, the CIGAR for this read will begin/end with a hard clip # operator that will indicate the length of the excised sequence. # Corresponds to the JSON property `alignedSequence` # @return [String] attr_accessor :aligned_sequence # A linear alignment can be represented by one CIGAR string. Describes the # mapped position and local alignment of the read to the reference. # Corresponds to the JSON property `alignment` # @return [Google::Apis::GenomicsV1::LinearAlignment] attr_accessor :alignment # The fragment is a PCR or optical duplicate (SAM flag 0x400). # Corresponds to the JSON property `duplicateFragment` # @return [Boolean] attr_accessor :duplicate_fragment alias_method :duplicate_fragment?, :duplicate_fragment # Whether this read did not pass filters, such as platform or vendor quality # controls (SAM flag 0x200). # Corresponds to the JSON property `failedVendorQualityChecks` # @return [Boolean] attr_accessor :failed_vendor_quality_checks alias_method :failed_vendor_quality_checks?, :failed_vendor_quality_checks # The observed length of the fragment, equivalent to TLEN in SAM. # Corresponds to the JSON property `fragmentLength` # @return [Fixnum] attr_accessor :fragment_length # The fragment name. Equivalent to QNAME (query template name) in SAM. # Corresponds to the JSON property `fragmentName` # @return [String] attr_accessor :fragment_name # The server-generated read ID, unique across all reads. This is different # from the `fragmentName`. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A map of additional read alignment information. This must be of the form # map (string key mapping to a list of string values). # Corresponds to the JSON property `info` # @return [Hash>] attr_accessor :info # An abstraction for referring to a genomic position, in relation to some # already known reference. For now, represents a genomic position as a # reference name, a base number on that reference (0-based), and a # determination of forward or reverse strand. # Corresponds to the JSON property `nextMatePosition` # @return [Google::Apis::GenomicsV1::Position] attr_accessor :next_mate_position # The number of reads in the fragment (extension to SAM flag 0x1). # Corresponds to the JSON property `numberReads` # @return [Fixnum] attr_accessor :number_reads # The orientation and the distance between reads from the fragment are # consistent with the sequencing protocol (SAM flag 0x2). # Corresponds to the JSON property `properPlacement` # @return [Boolean] attr_accessor :proper_placement alias_method :proper_placement?, :proper_placement # The ID of the read group this read belongs to. A read belongs to exactly # one read group. This is a server-generated ID which is distinct from SAM's # RG tag (for that value, see # ReadGroup.name). # Corresponds to the JSON property `readGroupId` # @return [String] attr_accessor :read_group_id # The ID of the read group set this read belongs to. A read belongs to # exactly one read group set. # Corresponds to the JSON property `readGroupSetId` # @return [String] attr_accessor :read_group_set_id # The read number in sequencing. 0-based and less than numberReads. This # field replaces SAM flag 0x40 and 0x80. # Corresponds to the JSON property `readNumber` # @return [Fixnum] attr_accessor :read_number # Whether this alignment is secondary. Equivalent to SAM flag 0x100. # A secondary alignment represents an alternative to the primary alignment # for this read. Aligners may return secondary alignments if a read can map # ambiguously to multiple coordinates in the genome. By convention, each read # has one and only one alignment where both `secondaryAlignment` # and `supplementaryAlignment` are false. # Corresponds to the JSON property `secondaryAlignment` # @return [Boolean] attr_accessor :secondary_alignment alias_method :secondary_alignment?, :secondary_alignment # Whether this alignment is supplementary. Equivalent to SAM flag 0x800. # Supplementary alignments are used in the representation of a chimeric # alignment. In a chimeric alignment, a read is split into multiple # linear alignments that map to different reference contigs. The first # linear alignment in the read will be designated as the representative # alignment; the remaining linear alignments will be designated as # supplementary alignments. These alignments may have different mapping # quality scores. In each linear alignment in a chimeric alignment, the read # will be hard clipped. The `alignedSequence` and # `alignedQuality` fields in the alignment record will only # represent the bases for its respective linear alignment. # Corresponds to the JSON property `supplementaryAlignment` # @return [Boolean] attr_accessor :supplementary_alignment alias_method :supplementary_alignment?, :supplementary_alignment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aligned_quality = args[:aligned_quality] if args.key?(:aligned_quality) @aligned_sequence = args[:aligned_sequence] if args.key?(:aligned_sequence) @alignment = args[:alignment] if args.key?(:alignment) @duplicate_fragment = args[:duplicate_fragment] if args.key?(:duplicate_fragment) @failed_vendor_quality_checks = args[:failed_vendor_quality_checks] if args.key?(:failed_vendor_quality_checks) @fragment_length = args[:fragment_length] if args.key?(:fragment_length) @fragment_name = args[:fragment_name] if args.key?(:fragment_name) @id = args[:id] if args.key?(:id) @info = args[:info] if args.key?(:info) @next_mate_position = args[:next_mate_position] if args.key?(:next_mate_position) @number_reads = args[:number_reads] if args.key?(:number_reads) @proper_placement = args[:proper_placement] if args.key?(:proper_placement) @read_group_id = args[:read_group_id] if args.key?(:read_group_id) @read_group_set_id = args[:read_group_set_id] if args.key?(:read_group_set_id) @read_number = args[:read_number] if args.key?(:read_number) @secondary_alignment = args[:secondary_alignment] if args.key?(:secondary_alignment) @supplementary_alignment = args[:supplementary_alignment] if args.key?(:supplementary_alignment) end end # A read group is all the data that's processed the same way by the sequencer. class ReadGroup include Google::Apis::Core::Hashable # The dataset to which this read group belongs. # Corresponds to the JSON property `datasetId` # @return [String] attr_accessor :dataset_id # A free-form text description of this read group. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The experiment used to generate this read group. # Corresponds to the JSON property `experiment` # @return [Google::Apis::GenomicsV1::Experiment] attr_accessor :experiment # The server-generated read group ID, unique for all read groups. # Note: This is different than the @RG ID field in the SAM spec. For that # value, see name. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A map of additional read group information. This must be of the form # map (string key mapping to a list of string values). # Corresponds to the JSON property `info` # @return [Hash>] attr_accessor :info # The read group name. This corresponds to the @RG ID field in the SAM spec. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The predicted insert size of this read group. The insert size is the length # the sequenced DNA fragment from end-to-end, not including the adapters. # Corresponds to the JSON property `predictedInsertSize` # @return [Fixnum] attr_accessor :predicted_insert_size # The programs used to generate this read group. Programs are always # identical for all read groups within a read group set. For this reason, # only the first read group in a returned set will have this field # populated. # Corresponds to the JSON property `programs` # @return [Array] attr_accessor :programs # The reference set the reads in this read group are aligned to. # Corresponds to the JSON property `referenceSetId` # @return [String] attr_accessor :reference_set_id # A client-supplied sample identifier for the reads in this read group. # Corresponds to the JSON property `sampleId` # @return [String] attr_accessor :sample_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dataset_id = args[:dataset_id] if args.key?(:dataset_id) @description = args[:description] if args.key?(:description) @experiment = args[:experiment] if args.key?(:experiment) @id = args[:id] if args.key?(:id) @info = args[:info] if args.key?(:info) @name = args[:name] if args.key?(:name) @predicted_insert_size = args[:predicted_insert_size] if args.key?(:predicted_insert_size) @programs = args[:programs] if args.key?(:programs) @reference_set_id = args[:reference_set_id] if args.key?(:reference_set_id) @sample_id = args[:sample_id] if args.key?(:sample_id) end end # A read group set is a logical collection of read groups, which are # collections of reads produced by a sequencer. A read group set typically # models reads corresponding to one sample, sequenced one way, and aligned one # way. # * A read group set belongs to one dataset. # * A read group belongs to one read group set. # * A read belongs to one read group. # For more genomics resource definitions, see [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) class ReadGroupSet include Google::Apis::Core::Hashable # The dataset to which this read group set belongs. # Corresponds to the JSON property `datasetId` # @return [String] attr_accessor :dataset_id # The filename of the original source file for this read group set, if any. # Corresponds to the JSON property `filename` # @return [String] attr_accessor :filename # The server-generated read group set ID, unique for all read group sets. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A map of additional read group set information. # Corresponds to the JSON property `info` # @return [Hash>] attr_accessor :info # The read group set name. By default this will be initialized to the sample # name of the sequenced data contained in this set. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The read groups in this set. There are typically 1-10 read groups in a read # group set. # Corresponds to the JSON property `readGroups` # @return [Array] attr_accessor :read_groups # The reference set to which the reads in this read group set are aligned. # Corresponds to the JSON property `referenceSetId` # @return [String] attr_accessor :reference_set_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dataset_id = args[:dataset_id] if args.key?(:dataset_id) @filename = args[:filename] if args.key?(:filename) @id = args[:id] if args.key?(:id) @info = args[:info] if args.key?(:info) @name = args[:name] if args.key?(:name) @read_groups = args[:read_groups] if args.key?(:read_groups) @reference_set_id = args[:reference_set_id] if args.key?(:reference_set_id) end end # A reference is a canonical assembled DNA sequence, intended to act as a # reference coordinate space for other genomic annotations. A single reference # might represent the human chromosome 1 or mitochandrial DNA, for instance. A # reference belongs to one or more reference sets. # For more genomics resource definitions, see [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) class Reference include Google::Apis::Core::Hashable # The server-generated reference ID, unique across all references. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The length of this reference's sequence. # Corresponds to the JSON property `length` # @return [Fixnum] attr_accessor :length # MD5 of the upper-case sequence excluding all whitespace characters (this # is equivalent to SQ:M5 in SAM). This value is represented in lower case # hexadecimal format. # Corresponds to the JSON property `md5checksum` # @return [String] attr_accessor :md5checksum # The name of this reference, for example `22`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human. # Corresponds to the JSON property `ncbiTaxonId` # @return [Fixnum] attr_accessor :ncbi_taxon_id # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally # with a version number, for example `GCF_000001405.26`. # Corresponds to the JSON property `sourceAccessions` # @return [Array] attr_accessor :source_accessions # The URI from which the sequence was obtained. Typically specifies a FASTA # format file. # Corresponds to the JSON property `sourceUri` # @return [String] attr_accessor :source_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @length = args[:length] if args.key?(:length) @md5checksum = args[:md5checksum] if args.key?(:md5checksum) @name = args[:name] if args.key?(:name) @ncbi_taxon_id = args[:ncbi_taxon_id] if args.key?(:ncbi_taxon_id) @source_accessions = args[:source_accessions] if args.key?(:source_accessions) @source_uri = args[:source_uri] if args.key?(:source_uri) end end # ReferenceBound records an upper bound for the starting coordinate of # variants in a particular reference. class ReferenceBound include Google::Apis::Core::Hashable # The name of the reference associated with this reference bound. # Corresponds to the JSON property `referenceName` # @return [String] attr_accessor :reference_name # An upper bound (inclusive) on the starting coordinate of any # variant in the reference sequence. # Corresponds to the JSON property `upperBound` # @return [Fixnum] attr_accessor :upper_bound def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @reference_name = args[:reference_name] if args.key?(:reference_name) @upper_bound = args[:upper_bound] if args.key?(:upper_bound) end end # A reference set is a set of references which typically comprise a reference # assembly for a species, such as `GRCh38` which is representative # of the human genome. A reference set defines a common coordinate space for # comparing reference-aligned experimental data. A reference set contains 1 or # more references. # For more genomics resource definitions, see [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) class ReferenceSet include Google::Apis::Core::Hashable # Public id of this reference set, such as `GRCh37`. # Corresponds to the JSON property `assemblyId` # @return [String] attr_accessor :assembly_id # Free text description of this reference set. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The server-generated reference set ID, unique across all reference sets. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Order-independent MD5 checksum which identifies this reference set. The # checksum is computed by sorting all lower case hexidecimal string # `reference.md5checksum` (for all reference in this set) in # ascending lexicographic order, concatenating, and taking the MD5 of that # value. The resulting value is represented in lower case hexadecimal format. # Corresponds to the JSON property `md5checksum` # @return [String] attr_accessor :md5checksum # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) # indicating the species which this reference set is intended to model. Note # that contained references may specify a different `ncbiTaxonId`, as # assemblies may contain reference sequences which do not belong to the # modeled species, for example EBV in a human reference genome. # Corresponds to the JSON property `ncbiTaxonId` # @return [Fixnum] attr_accessor :ncbi_taxon_id # The IDs of the reference objects that are part of this set. # `Reference.md5checksum` must be unique within this set. # Corresponds to the JSON property `referenceIds` # @return [Array] attr_accessor :reference_ids # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally # with a version number, for example `NC_000001.11`. # Corresponds to the JSON property `sourceAccessions` # @return [Array] attr_accessor :source_accessions # The URI from which the references were obtained. # Corresponds to the JSON property `sourceUri` # @return [String] attr_accessor :source_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @assembly_id = args[:assembly_id] if args.key?(:assembly_id) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @md5checksum = args[:md5checksum] if args.key?(:md5checksum) @ncbi_taxon_id = args[:ncbi_taxon_id] if args.key?(:ncbi_taxon_id) @reference_ids = args[:reference_ids] if args.key?(:reference_ids) @source_accessions = args[:source_accessions] if args.key?(:source_accessions) @source_uri = args[:source_uri] if args.key?(:source_uri) end end # Runtime metadata that will be populated in the # runtimeMetadata # field of the Operation associated with a RunPipeline execution. class RuntimeMetadata include Google::Apis::Core::Hashable # Describes a Compute Engine resource that is being managed by a running # pipeline. # Corresponds to the JSON property `computeEngine` # @return [Google::Apis::GenomicsV1::ComputeEngine] attr_accessor :compute_engine def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @compute_engine = args[:compute_engine] if args.key?(:compute_engine) end end # class SearchAnnotationSetsRequest include Google::Apis::Core::Hashable # Required. The dataset IDs to search within. Caller must have `READ` access # to these datasets. # Corresponds to the JSON property `datasetIds` # @return [Array] attr_accessor :dataset_ids # Only return annotations sets for which a substring of the name matches this # string (case insensitive). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The maximum number of results to return in a single page. If unspecified, # defaults to 128. The maximum value is 1024. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token # If specified, only annotation sets associated with the given reference set # are returned. # Corresponds to the JSON property `referenceSetId` # @return [String] attr_accessor :reference_set_id # If specified, only annotation sets that have any of these types are # returned. # Corresponds to the JSON property `types` # @return [Array] attr_accessor :types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dataset_ids = args[:dataset_ids] if args.key?(:dataset_ids) @name = args[:name] if args.key?(:name) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @reference_set_id = args[:reference_set_id] if args.key?(:reference_set_id) @types = args[:types] if args.key?(:types) end end # class SearchAnnotationSetsResponse include Google::Apis::Core::Hashable # The matching annotation sets. # Corresponds to the JSON property `annotationSets` # @return [Array] attr_accessor :annotation_sets # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional 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) @annotation_sets = args[:annotation_sets] if args.key?(:annotation_sets) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # class SearchAnnotationsRequest include Google::Apis::Core::Hashable # Required. The annotation sets to search within. The caller must have # `READ` access to these annotation sets. # All queried annotation sets must have the same type. # Corresponds to the JSON property `annotationSetIds` # @return [Array] attr_accessor :annotation_set_ids # The end position of the range on the reference, 0-based exclusive. If # referenceId or # referenceName # must be specified, Defaults to the length of the reference. # Corresponds to the JSON property `end` # @return [Fixnum] attr_accessor :end # The maximum number of results to return in a single page. If unspecified, # defaults to 256. The maximum value is 2048. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token # The ID of the reference to query. # Corresponds to the JSON property `referenceId` # @return [String] attr_accessor :reference_id # The name of the reference to query, within the reference set associated # with this query. # Corresponds to the JSON property `referenceName` # @return [String] attr_accessor :reference_name # The start position of the range on the reference, 0-based inclusive. If # specified, # referenceId or # referenceName # must be specified. Defaults to 0. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @annotation_set_ids = args[:annotation_set_ids] if args.key?(:annotation_set_ids) @end = args[:end] if args.key?(:end) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @reference_id = args[:reference_id] if args.key?(:reference_id) @reference_name = args[:reference_name] if args.key?(:reference_name) @start = args[:start] if args.key?(:start) end end # class SearchAnnotationsResponse include Google::Apis::Core::Hashable # The matching annotations. # Corresponds to the JSON property `annotations` # @return [Array] attr_accessor :annotations # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional 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) @annotations = args[:annotations] if args.key?(:annotations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The call set search request. class SearchCallSetsRequest include Google::Apis::Core::Hashable # Only return call sets for which a substring of the name matches this # string. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The maximum number of results to return in a single page. If unspecified, # defaults to 1024. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token # Restrict the query to call sets within the given variant sets. At least one # ID must be provided. # Corresponds to the JSON property `variantSetIds` # @return [Array] attr_accessor :variant_set_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @variant_set_ids = args[:variant_set_ids] if args.key?(:variant_set_ids) end end # The call set search response. class SearchCallSetsResponse include Google::Apis::Core::Hashable # The list of matching call sets. # Corresponds to the JSON property `callSets` # @return [Array] attr_accessor :call_sets # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional 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) @call_sets = args[:call_sets] if args.key?(:call_sets) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The read group set search request. class SearchReadGroupSetsRequest include Google::Apis::Core::Hashable # Restricts this query to read group sets within the given datasets. At least # one ID must be provided. # Corresponds to the JSON property `datasetIds` # @return [Array] attr_accessor :dataset_ids # Only return read group sets for which a substring of the name matches this # string. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The maximum number of results to return in a single page. If unspecified, # defaults to 256. The maximum value is 1024. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dataset_ids = args[:dataset_ids] if args.key?(:dataset_ids) @name = args[:name] if args.key?(:name) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) end end # The read group set search response. class SearchReadGroupSetsResponse include Google::Apis::Core::Hashable # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of matching read group sets. # Corresponds to the JSON property `readGroupSets` # @return [Array] attr_accessor :read_group_sets 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) @read_group_sets = args[:read_group_sets] if args.key?(:read_group_sets) end end # The read search request. class SearchReadsRequest include Google::Apis::Core::Hashable # The end position of the range on the reference, 0-based exclusive. If # specified, `referenceName` must also be specified. # Corresponds to the JSON property `end` # @return [Fixnum] attr_accessor :end # The maximum number of results to return in a single page. If unspecified, # defaults to 256. The maximum value is 2048. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token # The IDs of the read groups within which to search for reads. All specified # read groups must belong to the same read group sets. Must specify one of # `readGroupSetIds` or `readGroupIds`. # Corresponds to the JSON property `readGroupIds` # @return [Array] attr_accessor :read_group_ids # The IDs of the read groups sets within which to search for reads. All # specified read group sets must be aligned against a common set of reference # sequences; this defines the genomic coordinates for the query. Must specify # one of `readGroupSetIds` or `readGroupIds`. # Corresponds to the JSON property `readGroupSetIds` # @return [Array] attr_accessor :read_group_set_ids # The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to # `*`, only unmapped reads are returned. If unspecified, all reads (mapped # and unmapped) are returned. # Corresponds to the JSON property `referenceName` # @return [String] attr_accessor :reference_name # The start position of the range on the reference, 0-based inclusive. If # specified, `referenceName` must also be specified. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end = args[:end] if args.key?(:end) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @read_group_ids = args[:read_group_ids] if args.key?(:read_group_ids) @read_group_set_ids = args[:read_group_set_ids] if args.key?(:read_group_set_ids) @reference_name = args[:reference_name] if args.key?(:reference_name) @start = args[:start] if args.key?(:start) end end # The read search response. class SearchReadsResponse include Google::Apis::Core::Hashable # The list of matching alignments sorted by mapped genomic coordinate, # if any, ascending in position within the same reference. Unmapped reads, # which have no position, are returned contiguously and are sorted in # ascending lexicographic order by fragment name. # Corresponds to the JSON property `alignments` # @return [Array] attr_accessor :alignments # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional 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) @alignments = args[:alignments] if args.key?(:alignments) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # class SearchReferenceSetsRequest include Google::Apis::Core::Hashable # If present, return reference sets for which a prefix of any of # sourceAccessions # match any of these strings. Accession numbers typically have a main number # and a version, for example `NC_000001.11`. # Corresponds to the JSON property `accessions` # @return [Array] attr_accessor :accessions # If present, return reference sets for which a substring of their # `assemblyId` matches this string (case insensitive). # Corresponds to the JSON property `assemblyId` # @return [String] attr_accessor :assembly_id # If present, return reference sets for which the # md5checksum matches exactly. # Corresponds to the JSON property `md5checksums` # @return [Array] attr_accessor :md5checksums # The maximum number of results to return in a single page. If unspecified, # defaults to 1024. The maximum value is 4096. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accessions = args[:accessions] if args.key?(:accessions) @assembly_id = args[:assembly_id] if args.key?(:assembly_id) @md5checksums = args[:md5checksums] if args.key?(:md5checksums) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) end end # class SearchReferenceSetsResponse include Google::Apis::Core::Hashable # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The matching references sets. # Corresponds to the JSON property `referenceSets` # @return [Array] attr_accessor :reference_sets 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) @reference_sets = args[:reference_sets] if args.key?(:reference_sets) end end # class SearchReferencesRequest include Google::Apis::Core::Hashable # If present, return references for which a prefix of any of # sourceAccessions match # any of these strings. Accession numbers typically have a main number and a # version, for example `GCF_000001405.26`. # Corresponds to the JSON property `accessions` # @return [Array] attr_accessor :accessions # If present, return references for which the # md5checksum matches exactly. # Corresponds to the JSON property `md5checksums` # @return [Array] attr_accessor :md5checksums # The maximum number of results to return in a single page. If unspecified, # defaults to 1024. The maximum value is 4096. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token # If present, return only references which belong to this reference set. # Corresponds to the JSON property `referenceSetId` # @return [String] attr_accessor :reference_set_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accessions = args[:accessions] if args.key?(:accessions) @md5checksums = args[:md5checksums] if args.key?(:md5checksums) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @reference_set_id = args[:reference_set_id] if args.key?(:reference_set_id) end end # class SearchReferencesResponse include Google::Apis::Core::Hashable # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The matching references. # Corresponds to the JSON property `references` # @return [Array] attr_accessor :references 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) @references = args[:references] if args.key?(:references) end end # The search variant sets request. class SearchVariantSetsRequest include Google::Apis::Core::Hashable # Exactly one dataset ID must be provided here. Only variant sets which # belong to this dataset will be returned. # Corresponds to the JSON property `datasetIds` # @return [Array] attr_accessor :dataset_ids # The maximum number of results to return in a single page. If unspecified, # defaults to 1024. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dataset_ids = args[:dataset_ids] if args.key?(:dataset_ids) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) end end # The search variant sets response. class SearchVariantSetsResponse include Google::Apis::Core::Hashable # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The variant sets belonging to the requested dataset. # Corresponds to the JSON property `variantSets` # @return [Array] attr_accessor :variant_sets 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) @variant_sets = args[:variant_sets] if args.key?(:variant_sets) end end # The variant search request. class SearchVariantsRequest include Google::Apis::Core::Hashable # Only return variant calls which belong to call sets with these ids. # Leaving this blank returns all variant calls. If a variant has no # calls belonging to any of these call sets, it won't be returned at all. # Corresponds to the JSON property `callSetIds` # @return [Array] attr_accessor :call_set_ids # The end of the window, 0-based exclusive. If unspecified or 0, defaults to # the length of the reference. # Corresponds to the JSON property `end` # @return [Fixnum] attr_accessor :end # The maximum number of calls to return in a single page. Note that this # limit may be exceeded in the event that a matching variant contains more # calls than the requested maximum. If unspecified, defaults to 5000. The # maximum value is 10000. # Corresponds to the JSON property `maxCalls` # @return [Fixnum] attr_accessor :max_calls # The maximum number of variants to return in a single page. If unspecified, # defaults to 5000. The maximum value is 10000. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token # Required. Only return variants in this reference sequence. # Corresponds to the JSON property `referenceName` # @return [String] attr_accessor :reference_name # The beginning of the window (0-based, inclusive) for which # overlapping variants should be returned. If unspecified, defaults to 0. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start # Only return variants which have exactly this name. # Corresponds to the JSON property `variantName` # @return [String] attr_accessor :variant_name # At most one variant set ID must be provided. Only variants from this # variant set will be returned. If omitted, a call set id must be included in # the request. # Corresponds to the JSON property `variantSetIds` # @return [Array] attr_accessor :variant_set_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @call_set_ids = args[:call_set_ids] if args.key?(:call_set_ids) @end = args[:end] if args.key?(:end) @max_calls = args[:max_calls] if args.key?(:max_calls) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @reference_name = args[:reference_name] if args.key?(:reference_name) @start = args[:start] if args.key?(:start) @variant_name = args[:variant_name] if args.key?(:variant_name) @variant_set_ids = args[:variant_set_ids] if args.key?(:variant_set_ids) end end # The variant search response. class SearchVariantsResponse include Google::Apis::Core::Hashable # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of # results. This field will be empty if there aren't any additional results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of matching Variants. # Corresponds to the JSON property `variants` # @return [Array] attr_accessor :variants 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) @variants = args[:variants] if args.key?(:variants) end end # Request message for `SetIamPolicy` method. class SetIamPolicyRequest include Google::Apis::Core::Hashable # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). # Corresponds to the JSON property `policy` # @return [Google::Apis::GenomicsV1::Policy] attr_accessor :policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @policy = args[:policy] if args.key?(:policy) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 # Request message for `TestIamPermissions` method. class TestIamPermissionsRequest include Google::Apis::Core::Hashable # REQUIRED: The set of permissions to check for the 'resource'. # Permissions with wildcards (such as '*' or 'storage.*') are not allowed. # Allowed permissions are: # * `genomics.datasets.create` # * `genomics.datasets.delete` # * `genomics.datasets.get` # * `genomics.datasets.list` # * `genomics.datasets.update` # * `genomics.datasets.getIamPolicy` # * `genomics.datasets.setIamPolicy` # 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 TestIamPermissionsResponse 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 # A transcript represents the assertion that a particular region of the # reference genome may be transcribed as RNA. class Transcript include Google::Apis::Core::Hashable # The range of the coding sequence for this transcript, if any. To determine # the exact ranges of coding sequence, intersect this range with those of the # exons, if any. If there are any # exons, the # codingSequence must start # and end within them. # Note that in some cases, the reference genome will not exactly match the # observed mRNA transcript e.g. due to variance in the source genome from # reference. In these cases, # exon.frame will not necessarily # match the expected reference reading frame and coding exon reference bases # cannot necessarily be concatenated to produce the original transcript mRNA. # Corresponds to the JSON property `codingSequence` # @return [Google::Apis::GenomicsV1::CodingSequence] attr_accessor :coding_sequence # The exons that compose # this transcript. This field should be unset for genomes where transcript # splicing does not occur, for example prokaryotes. # Introns are regions of the transcript that are not included in the # spliced RNA product. Though not explicitly modeled here, intron ranges can # be deduced; all regions of this transcript that are not exons are introns. # Exonic sequences do not necessarily code for a translational product # (amino acids). Only the regions of exons bounded by the # codingSequence correspond # to coding DNA sequence. # Exons are ordered by start position and may not overlap. # Corresponds to the JSON property `exons` # @return [Array] attr_accessor :exons # The annotation ID of the gene from which this transcript is transcribed. # Corresponds to the JSON property `geneId` # @return [String] attr_accessor :gene_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @coding_sequence = args[:coding_sequence] if args.key?(:coding_sequence) @exons = args[:exons] if args.key?(:exons) @gene_id = args[:gene_id] if args.key?(:gene_id) end end # class UndeleteDatasetRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # A variant represents a change in DNA sequence relative to a reference # sequence. For example, a variant could represent a SNP or an insertion. # Variants belong to a variant set. # For more genomics resource definitions, see [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Each of the calls on a variant represent a determination of genotype with # respect to that variant. For example, a call might assign probability of 0.32 # to the occurrence of a SNP named rs1234 in a sample named NA12345. A call # belongs to a call set, which contains related calls typically from one # sample. class Variant include Google::Apis::Core::Hashable # The bases that appear instead of the reference bases. # Corresponds to the JSON property `alternateBases` # @return [Array] attr_accessor :alternate_bases # The variant calls for this particular variant. Each one represents the # determination of genotype with respect to this variant. # Corresponds to the JSON property `calls` # @return [Array] attr_accessor :calls # The date this variant was created, in milliseconds from the epoch. # Corresponds to the JSON property `created` # @return [Fixnum] attr_accessor :created # The end position (0-based) of this variant. This corresponds to the first # base after the last base in the reference allele. So, the length of # the reference allele is (end - start). This is useful for variants # that don't explicitly give alternate bases, for example large deletions. # Corresponds to the JSON property `end` # @return [Fixnum] attr_accessor :end # A list of filters (normally quality filters) this variant has failed. # `PASS` indicates this variant has passed all filters. # Corresponds to the JSON property `filter` # @return [Array] attr_accessor :filter # The server-generated variant ID, unique across all variants. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A map of additional variant information. This must be of the form # map (string key mapping to a list of string values). # Corresponds to the JSON property `info` # @return [Hash>] attr_accessor :info # Names for the variant, for example a RefSNP ID. # Corresponds to the JSON property `names` # @return [Array] attr_accessor :names # A measure of how likely this variant is to be real. # A higher value is better. # Corresponds to the JSON property `quality` # @return [Float] attr_accessor :quality # The reference bases for this variant. They start at the given # position. # Corresponds to the JSON property `referenceBases` # @return [String] attr_accessor :reference_bases # The reference on which this variant occurs. # (such as `chr20` or `X`) # Corresponds to the JSON property `referenceName` # @return [String] attr_accessor :reference_name # The position at which this variant occurs (0-based). # This corresponds to the first base of the string of reference bases. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start # The ID of the variant set this variant belongs to. # Corresponds to the JSON property `variantSetId` # @return [String] attr_accessor :variant_set_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alternate_bases = args[:alternate_bases] if args.key?(:alternate_bases) @calls = args[:calls] if args.key?(:calls) @created = args[:created] if args.key?(:created) @end = args[:end] if args.key?(:end) @filter = args[:filter] if args.key?(:filter) @id = args[:id] if args.key?(:id) @info = args[:info] if args.key?(:info) @names = args[:names] if args.key?(:names) @quality = args[:quality] if args.key?(:quality) @reference_bases = args[:reference_bases] if args.key?(:reference_bases) @reference_name = args[:reference_name] if args.key?(:reference_name) @start = args[:start] if args.key?(:start) @variant_set_id = args[:variant_set_id] if args.key?(:variant_set_id) end end # class VariantAnnotation include Google::Apis::Core::Hashable # The alternate allele for this variant. If multiple alternate alleles # exist at this location, create a separate variant for each one, as they # may represent distinct conditions. # Corresponds to the JSON property `alternateBases` # @return [String] attr_accessor :alternate_bases # Describes the clinical significance of a variant. # It is adapted from the ClinVar controlled vocabulary for clinical # significance described at: # http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/ # Corresponds to the JSON property `clinicalSignificance` # @return [String] attr_accessor :clinical_significance # The set of conditions associated with this variant. # A condition describes the way a variant influences human health. # Corresponds to the JSON property `conditions` # @return [Array] attr_accessor :conditions # Effect of the variant on the coding sequence. # Corresponds to the JSON property `effect` # @return [String] attr_accessor :effect # Google annotation ID of the gene affected by this variant. This should # be provided when the variant is created. # Corresponds to the JSON property `geneId` # @return [String] attr_accessor :gene_id # Google annotation IDs of the transcripts affected by this variant. These # should be provided when the variant is created. # Corresponds to the JSON property `transcriptIds` # @return [Array] attr_accessor :transcript_ids # Type has been adapted from ClinVar's list of variant types. # 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) @alternate_bases = args[:alternate_bases] if args.key?(:alternate_bases) @clinical_significance = args[:clinical_significance] if args.key?(:clinical_significance) @conditions = args[:conditions] if args.key?(:conditions) @effect = args[:effect] if args.key?(:effect) @gene_id = args[:gene_id] if args.key?(:gene_id) @transcript_ids = args[:transcript_ids] if args.key?(:transcript_ids) @type = args[:type] if args.key?(:type) end end # A call represents the determination of genotype with respect to a particular # variant. It may include associated information such as quality and phasing. # For example, a call might assign a probability of 0.32 to the occurrence of # a SNP named rs1234 in a call set with the name NA12345. class VariantCall include Google::Apis::Core::Hashable # The ID of the call set this variant call belongs to. # Corresponds to the JSON property `callSetId` # @return [String] attr_accessor :call_set_id # The name of the call set this variant call belongs to. # Corresponds to the JSON property `callSetName` # @return [String] attr_accessor :call_set_name # The genotype of this variant call. Each value represents either the value # of the `referenceBases` field or a 1-based index into # `alternateBases`. If a variant had a `referenceBases` # value of `T` and an `alternateBases` # value of `["A", "C"]`, and the `genotype` was # `[2, 1]`, that would mean the call # represented the heterozygous value `CA` for this variant. # If the `genotype` was instead `[0, 1]`, the # represented value would be `TA`. Ordering of the # genotype values is important if the `phaseset` is present. # If a genotype is not called (that is, a `.` is present in the # GT string) -1 is returned. # Corresponds to the JSON property `genotype` # @return [Array] attr_accessor :genotype # The genotype likelihoods for this variant call. Each array entry # represents how likely a specific genotype is for this call. The value # ordering is defined by the GL tag in the VCF spec. # If Phred-scaled genotype likelihood scores (PL) are available and # log10(P) genotype likelihood scores (GL) are not, PL scores are converted # to GL scores. If both are available, PL scores are stored in `info`. # Corresponds to the JSON property `genotypeLikelihood` # @return [Array] attr_accessor :genotype_likelihood # A map of additional variant call information. This must be of the form # map (string key mapping to a list of string values). # Corresponds to the JSON property `info` # @return [Hash>] attr_accessor :info # If this field is present, this variant call's genotype ordering implies # the phase of the bases and is consistent with any other variant calls in # the same reference sequence which have the same phaseset value. # When importing data from VCF, if the genotype data was phased but no # phase set was specified this field will be set to `*`. # Corresponds to the JSON property `phaseset` # @return [String] attr_accessor :phaseset def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @call_set_id = args[:call_set_id] if args.key?(:call_set_id) @call_set_name = args[:call_set_name] if args.key?(:call_set_name) @genotype = args[:genotype] if args.key?(:genotype) @genotype_likelihood = args[:genotype_likelihood] if args.key?(:genotype_likelihood) @info = args[:info] if args.key?(:info) @phaseset = args[:phaseset] if args.key?(:phaseset) end end # A variant set is a collection of call sets and variants. It contains summary # statistics of those contents. A variant set belongs to a dataset. # For more genomics resource definitions, see [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) class VariantSet include Google::Apis::Core::Hashable # The dataset to which this variant set belongs. # Corresponds to the JSON property `datasetId` # @return [String] attr_accessor :dataset_id # A textual description of this variant set. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The server-generated variant set ID, unique across all variant sets. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The metadata associated with this variant set. # Corresponds to the JSON property `metadata` # @return [Array] attr_accessor :metadata # User-specified, mutable name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A list of all references used by the variants in a variant set # with associated coordinate upper bounds for each one. # Corresponds to the JSON property `referenceBounds` # @return [Array] attr_accessor :reference_bounds # The reference set to which the variant set is mapped. The reference set # describes the alignment provenance of the variant set, while the # `referenceBounds` describe the shape of the actual variant data. The # reference set's reference names are a superset of those found in the # `referenceBounds`. # For example, given a variant set that is mapped to the GRCh38 reference set # and contains a single variant on reference 'X', `referenceBounds` would # contain only an entry for 'X', while the associated reference set # enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. # Corresponds to the JSON property `referenceSetId` # @return [String] attr_accessor :reference_set_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dataset_id = args[:dataset_id] if args.key?(:dataset_id) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @reference_bounds = args[:reference_bounds] if args.key?(:reference_bounds) @reference_set_id = args[:reference_set_id] if args.key?(:reference_set_id) end end # Metadata describes a single piece of variant call metadata. # These data include a top level key and either a single value string (value) # or a list of key-value pairs (info.) # Value and info are mutually exclusive. class VariantSetMetadata include Google::Apis::Core::Hashable # A textual description of this metadata. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # User-provided ID field, not enforced by this API. # Two or more pieces of structured metadata with identical # id and key fields are considered equivalent. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Remaining structured metadata key-value pairs. This must be of the form # map (string key mapping to a list of string values). # Corresponds to the JSON property `info` # @return [Hash>] attr_accessor :info # The top-level key. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # The number of values that can be included in a field described by this # metadata. # Corresponds to the JSON property `number` # @return [String] attr_accessor :number # The type of data. Possible types include: Integer, Float, # Flag, Character, and String. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The value field for simple metadata # 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) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @info = args[:info] if args.key?(:info) @key = args[:key] if args.key?(:key) @number = args[:number] if args.key?(:number) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end end end end google-api-client-0.19.8/generated/google/apis/genomics_v1/service.rb0000644000004100000410000040752413252673043025526 0ustar www-datawww-data# 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 GenomicsV1 # Genomics API # # Upload, process, query, and search Genomics data in the cloud. # # @example # require 'google/apis/genomics_v1' # # Genomics = Google::Apis::GenomicsV1 # Alias the module # service = Genomics::GenomicsService.new # # @see https://cloud.google.com/genomics class GenomicsService < 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://genomics.googleapis.com/', '') @batch_path = 'batch' end # Creates one or more new annotations atomically. All annotations must # belong to the same annotation set. Caller must have WRITE # permission for this annotation set. For optimal performance, batch # positionally adjacent annotations together. # If the request has a systemic issue, such as an attempt to write to # an inaccessible annotation set, the entire RPC will fail accordingly. For # lesser data issues, when possible an error will be isolated to the # corresponding batch entry in the response; the remaining well formed # annotations will be created normally. # For details on the requirements for each individual annotation resource, # see # CreateAnnotation. # @param [Google::Apis::GenomicsV1::BatchCreateAnnotationsRequest] batch_create_annotations_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::GenomicsV1::BatchCreateAnnotationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::BatchCreateAnnotationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_annotations(batch_create_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/annotations:batchCreate', options) command.request_representation = Google::Apis::GenomicsV1::BatchCreateAnnotationsRequest::Representation command.request_object = batch_create_annotations_request_object command.response_representation = Google::Apis::GenomicsV1::BatchCreateAnnotationsResponse::Representation command.response_class = Google::Apis::GenomicsV1::BatchCreateAnnotationsResponse 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 annotation. Caller must have WRITE permission # for the associated annotation set. # The following fields are required: # * annotationSetId # * referenceName or # referenceId # ### Transcripts # For annotations of type TRANSCRIPT, the following fields of # transcript must be provided: # * exons.start # * exons.end # All other fields may be optionally specified, unless documented as being # server-generated (for example, the `id` field). The annotated # range must be no longer than 100Mbp (mega base pairs). See the # Annotation resource # for additional restrictions on each field. # @param [Google::Apis::GenomicsV1::Annotation] annotation_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::GenomicsV1::Annotation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Annotation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_annotation(annotation_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/annotations', options) command.request_representation = Google::Apis::GenomicsV1::Annotation::Representation command.request_object = annotation_object command.response_representation = Google::Apis::GenomicsV1::Annotation::Representation command.response_class = Google::Apis::GenomicsV1::Annotation 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 annotation. Caller must have WRITE permission for # the associated annotation set. # @param [String] annotation_id # The ID of the annotation 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::GenomicsV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_annotation(annotation_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/annotations/{annotationId}', options) command.response_representation = Google::Apis::GenomicsV1::Empty::Representation command.response_class = Google::Apis::GenomicsV1::Empty command.params['annotationId'] = annotation_id unless annotation_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 annotation. Caller must have READ permission # for the associated annotation set. # @param [String] annotation_id # The ID of the annotation to be retrieved. # @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::GenomicsV1::Annotation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Annotation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_annotation(annotation_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/annotations/{annotationId}', options) command.response_representation = Google::Apis::GenomicsV1::Annotation::Representation command.response_class = Google::Apis::GenomicsV1::Annotation command.params['annotationId'] = annotation_id unless annotation_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 # Searches for annotations that match the given criteria. Results are # ordered by genomic coordinate (by reference sequence, then position). # Annotations with equivalent genomic coordinates are returned in an # unspecified order. This order is consistent, such that two queries for the # same content (regardless of page size) yield annotations in the same order # across their respective streams of paginated responses. Caller must have # READ permission for the queried annotation sets. # @param [Google::Apis::GenomicsV1::SearchAnnotationsRequest] search_annotations_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::GenomicsV1::SearchAnnotationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::SearchAnnotationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_annotations(search_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/annotations/search', options) command.request_representation = Google::Apis::GenomicsV1::SearchAnnotationsRequest::Representation command.request_object = search_annotations_request_object command.response_representation = Google::Apis::GenomicsV1::SearchAnnotationsResponse::Representation command.response_class = Google::Apis::GenomicsV1::SearchAnnotationsResponse 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 annotation. Caller must have # WRITE permission for the associated dataset. # @param [String] annotation_id # The ID of the annotation to be updated. # @param [Google::Apis::GenomicsV1::Annotation] annotation_object # @param [String] update_mask # An optional mask specifying which fields to update. Mutable fields are # name, # variant, # transcript, and # info. If unspecified, all mutable # fields will 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::GenomicsV1::Annotation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Annotation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_annotation(annotation_id, annotation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/annotations/{annotationId}', options) command.request_representation = Google::Apis::GenomicsV1::Annotation::Representation command.request_object = annotation_object command.response_representation = Google::Apis::GenomicsV1::Annotation::Representation command.response_class = Google::Apis::GenomicsV1::Annotation command.params['annotationId'] = annotation_id unless annotation_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 annotation set. Caller must have WRITE permission for the # associated dataset. # The following fields are required: # * datasetId # * referenceSetId # All other fields may be optionally specified, unless documented as being # server-generated (for example, the `id` field). # @param [Google::Apis::GenomicsV1::AnnotationSet] annotation_set_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::GenomicsV1::AnnotationSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::AnnotationSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_annotation_set(annotation_set_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/annotationsets', options) command.request_representation = Google::Apis::GenomicsV1::AnnotationSet::Representation command.request_object = annotation_set_object command.response_representation = Google::Apis::GenomicsV1::AnnotationSet::Representation command.response_class = Google::Apis::GenomicsV1::AnnotationSet 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 annotation set. Caller must have WRITE permission # for the associated annotation set. # @param [String] annotation_set_id # The ID of the annotation set 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::GenomicsV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_annotationset(annotation_set_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/annotationsets/{annotationSetId}', options) command.response_representation = Google::Apis::GenomicsV1::Empty::Representation command.response_class = Google::Apis::GenomicsV1::Empty command.params['annotationSetId'] = annotation_set_id unless annotation_set_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 annotation set. Caller must have READ permission for # the associated dataset. # @param [String] annotation_set_id # The ID of the annotation set to be retrieved. # @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::GenomicsV1::AnnotationSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::AnnotationSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_annotation_set(annotation_set_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/annotationsets/{annotationSetId}', options) command.response_representation = Google::Apis::GenomicsV1::AnnotationSet::Representation command.response_class = Google::Apis::GenomicsV1::AnnotationSet command.params['annotationSetId'] = annotation_set_id unless annotation_set_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 # Searches for annotation sets that match the given criteria. Annotation sets # are returned in an unspecified order. This order is consistent, such that # two queries for the same content (regardless of page size) yield annotation # sets in the same order across their respective streams of paginated # responses. Caller must have READ permission for the queried datasets. # @param [Google::Apis::GenomicsV1::SearchAnnotationSetsRequest] search_annotation_sets_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::GenomicsV1::SearchAnnotationSetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::SearchAnnotationSetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_annotationset_annotation_sets(search_annotation_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/annotationsets/search', options) command.request_representation = Google::Apis::GenomicsV1::SearchAnnotationSetsRequest::Representation command.request_object = search_annotation_sets_request_object command.response_representation = Google::Apis::GenomicsV1::SearchAnnotationSetsResponse::Representation command.response_class = Google::Apis::GenomicsV1::SearchAnnotationSetsResponse 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 annotation set. The update must respect all mutability # restrictions and other invariants described on the annotation set resource. # Caller must have WRITE permission for the associated dataset. # @param [String] annotation_set_id # The ID of the annotation set to be updated. # @param [Google::Apis::GenomicsV1::AnnotationSet] annotation_set_object # @param [String] update_mask # An optional mask specifying which fields to update. Mutable fields are # name, # source_uri, and # info. If unspecified, all # mutable fields will 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::GenomicsV1::AnnotationSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::AnnotationSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_annotationset(annotation_set_id, annotation_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/annotationsets/{annotationSetId}', options) command.request_representation = Google::Apis::GenomicsV1::AnnotationSet::Representation command.request_object = annotation_set_object command.response_representation = Google::Apis::GenomicsV1::AnnotationSet::Representation command.response_class = Google::Apis::GenomicsV1::AnnotationSet command.params['annotationSetId'] = annotation_set_id unless annotation_set_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 call set. # For the definitions of call sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [Google::Apis::GenomicsV1::CallSet] call_set_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::GenomicsV1::CallSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::CallSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_call_set(call_set_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/callsets', options) command.request_representation = Google::Apis::GenomicsV1::CallSet::Representation command.request_object = call_set_object command.response_representation = Google::Apis::GenomicsV1::CallSet::Representation command.response_class = Google::Apis::GenomicsV1::CallSet 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 call set. # For the definitions of call sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] call_set_id # The ID of the call set 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::GenomicsV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_call_set(call_set_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/callsets/{callSetId}', options) command.response_representation = Google::Apis::GenomicsV1::Empty::Representation command.response_class = Google::Apis::GenomicsV1::Empty command.params['callSetId'] = call_set_id unless call_set_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 call set by ID. # For the definitions of call sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] call_set_id # The ID of the call set. # @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::GenomicsV1::CallSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::CallSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_call_set(call_set_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/callsets/{callSetId}', options) command.response_representation = Google::Apis::GenomicsV1::CallSet::Representation command.response_class = Google::Apis::GenomicsV1::CallSet command.params['callSetId'] = call_set_id unless call_set_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 a call set. # For the definitions of call sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # This method supports patch semantics. # @param [String] call_set_id # The ID of the call set to be updated. # @param [Google::Apis::GenomicsV1::CallSet] call_set_object # @param [String] update_mask # An optional mask specifying which fields to update. At this time, the only # mutable field is name. The only # acceptable value is "name". If unspecified, all mutable fields will 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::GenomicsV1::CallSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::CallSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_call_set(call_set_id, call_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/callsets/{callSetId}', options) command.request_representation = Google::Apis::GenomicsV1::CallSet::Representation command.request_object = call_set_object command.response_representation = Google::Apis::GenomicsV1::CallSet::Representation command.response_class = Google::Apis::GenomicsV1::CallSet command.params['callSetId'] = call_set_id unless call_set_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 list of call sets matching the criteria. # For the definitions of call sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Implements # [GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5. # 1/src/main/resources/avro/variantmethods.avdl#L178). # @param [Google::Apis::GenomicsV1::SearchCallSetsRequest] search_call_sets_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::GenomicsV1::SearchCallSetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::SearchCallSetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_call_sets(search_call_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/callsets/search', options) command.request_representation = Google::Apis::GenomicsV1::SearchCallSetsRequest::Representation command.request_object = search_call_sets_request_object command.response_representation = Google::Apis::GenomicsV1::SearchCallSetsResponse::Representation command.response_class = Google::Apis::GenomicsV1::SearchCallSetsResponse 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 dataset. # For the definitions of datasets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [Google::Apis::GenomicsV1::Dataset] dataset_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::GenomicsV1::Dataset] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Dataset] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dataset(dataset_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/datasets', options) command.request_representation = Google::Apis::GenomicsV1::Dataset::Representation command.request_object = dataset_object command.response_representation = Google::Apis::GenomicsV1::Dataset::Representation command.response_class = Google::Apis::GenomicsV1::Dataset 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 dataset and all of its contents (all read group sets, # reference sets, variant sets, call sets, annotation sets, etc.) # This is reversible (up to one week after the deletion) via # the # datasets.undelete # operation. # For the definitions of datasets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] dataset_id # The ID of the dataset 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::GenomicsV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_dataset(dataset_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/datasets/{datasetId}', options) command.response_representation = Google::Apis::GenomicsV1::Empty::Representation command.response_class = Google::Apis::GenomicsV1::Empty command.params['datasetId'] = dataset_id unless dataset_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 dataset by ID. # For the definitions of datasets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] dataset_id # The ID of the dataset. # @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::GenomicsV1::Dataset] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Dataset] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dataset(dataset_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/datasets/{datasetId}', options) command.response_representation = Google::Apis::GenomicsV1::Dataset::Representation command.response_class = Google::Apis::GenomicsV1::Dataset command.params['datasetId'] = dataset_id unless dataset_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 the access control policy for the dataset. This is empty if the # policy or resource does not exist. # See Getting a # Policy for more information. # For the definitions of datasets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] resource # REQUIRED: The resource for which policy is being specified. Format is # `datasets/`. # @param [Google::Apis::GenomicsV1::GetIamPolicyRequest] get_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::GenomicsV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_dataset_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options) command.request_representation = Google::Apis::GenomicsV1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::GenomicsV1::Policy::Representation command.response_class = Google::Apis::GenomicsV1::Policy 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 # Lists datasets within a project. # For the definitions of datasets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [Fixnum] page_size # The maximum number of results to return in a single page. If unspecified, # defaults to 50. The maximum value is 1024. # @param [String] page_token # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # @param [String] project_id # Required. The Google Cloud project ID to list datasets for. # @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::GenomicsV1::ListDatasetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::ListDatasetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_datasets(page_size: nil, page_token: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/datasets', options) command.response_representation = Google::Apis::GenomicsV1::ListDatasetsResponse::Representation command.response_class = Google::Apis::GenomicsV1::ListDatasetsResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['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 # Updates a dataset. # For the definitions of datasets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # This method supports patch semantics. # @param [String] dataset_id # The ID of the dataset to be updated. # @param [Google::Apis::GenomicsV1::Dataset] dataset_object # @param [String] update_mask # An optional mask specifying which fields to update. At this time, the only # mutable field is name. The only # acceptable value is "name". If unspecified, all mutable fields will 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::GenomicsV1::Dataset] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Dataset] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dataset(dataset_id, dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/datasets/{datasetId}', options) command.request_representation = Google::Apis::GenomicsV1::Dataset::Representation command.request_object = dataset_object command.response_representation = Google::Apis::GenomicsV1::Dataset::Representation command.response_class = Google::Apis::GenomicsV1::Dataset command.params['datasetId'] = dataset_id unless dataset_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 # Sets the access control policy on the specified dataset. Replaces any # existing policy. # For the definitions of datasets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # See Setting a # Policy for more information. # @param [String] resource # REQUIRED: The resource for which policy is being specified. Format is # `datasets/`. # @param [Google::Apis::GenomicsV1::SetIamPolicyRequest] 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::GenomicsV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_dataset_iam_policy(resource, 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::GenomicsV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::GenomicsV1::Policy::Representation command.response_class = Google::Apis::GenomicsV1::Policy 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 # Returns permissions that a caller has on the specified resource. # See Testing # Permissions for more information. # For the definitions of datasets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] resource # REQUIRED: The resource for which policy is being specified. Format is # `datasets/`. # @param [Google::Apis::GenomicsV1::TestIamPermissionsRequest] 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::GenomicsV1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dataset_iam_permissions(resource, 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::GenomicsV1::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::GenomicsV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::GenomicsV1::TestIamPermissionsResponse 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 # Undeletes a dataset by restoring a dataset which was deleted via this API. # For the definitions of datasets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # This operation is only possible for a week after the deletion occurred. # @param [String] dataset_id # The ID of the dataset to be undeleted. # @param [Google::Apis::GenomicsV1::UndeleteDatasetRequest] undelete_dataset_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::GenomicsV1::Dataset] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Dataset] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def undelete_dataset(dataset_id, undelete_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/datasets/{datasetId}:undelete', options) command.request_representation = Google::Apis::GenomicsV1::UndeleteDatasetRequest::Representation command.request_object = undelete_dataset_request_object command.response_representation = Google::Apis::GenomicsV1::Dataset::Representation command.response_class = Google::Apis::GenomicsV1::Dataset command.params['datasetId'] = dataset_id unless dataset_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 # Starts asynchronous cancellation on a long-running operation. The server makes # a best effort to cancel the operation, but success is not guaranteed. Clients # may use Operations.GetOperation or Operations.ListOperations to check whether # the cancellation succeeded or the operation completed despite cancellation. # @param [String] name # The name of the operation resource to be cancelled. # @param [Google::Apis::GenomicsV1::CancelOperationRequest] cancel_operation_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::GenomicsV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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 cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.request_representation = Google::Apis::GenomicsV1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::GenomicsV1::Empty::Representation command.response_class = Google::Apis::GenomicsV1::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 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::GenomicsV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::GenomicsV1::Operation::Representation command.response_class = Google::Apis::GenomicsV1::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 # Lists operations that match the specified filter in the request. # @param [String] name # The name of the operation's parent resource. # @param [String] filter # A string for filtering Operations. # The following filter fields are supported: # * projectId: Required. Corresponds to # OperationMetadata.projectId. # * createTime: The time this job was created, in seconds from the # [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` # operators. # * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only # one status may be specified. # * labels.key where key is a label key. # Examples: # * `projectId = my-project AND createTime >= 1432140000` # * `projectId = my-project AND createTime >= 1432140000 AND createTime <= # 1432150000 AND status = RUNNING` # * `projectId = my-project AND labels.color = *` # * `projectId = my-project AND labels.color = red` # @param [Fixnum] page_size # The maximum number of results to return. If unspecified, defaults to # 256. The maximum value is 2048. # @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::GenomicsV1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_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}', options) command.response_representation = Google::Apis::GenomicsV1::ListOperationsResponse::Representation command.response_class = Google::Apis::GenomicsV1::ListOperationsResponse 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 # Deletes a read group set. # For the definitions of read group sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] read_group_set_id # The ID of the read group set to be deleted. The caller must have WRITE # permissions to the dataset associated with this read group set. # @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::GenomicsV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_read_group_set(read_group_set_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/readgroupsets/{readGroupSetId}', options) command.response_representation = Google::Apis::GenomicsV1::Empty::Representation command.response_class = Google::Apis::GenomicsV1::Empty command.params['readGroupSetId'] = read_group_set_id unless read_group_set_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 # Exports a read group set to a BAM file in Google Cloud Storage. # For the definitions of read group sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Note that currently there may be some differences between exported BAM # files and the original BAM file at the time of import. See # ImportReadGroupSets # for caveats. # @param [String] read_group_set_id # Required. The ID of the read group set to export. The caller must have # READ access to this read group set. # @param [Google::Apis::GenomicsV1::ExportReadGroupSetRequest] export_read_group_set_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::GenomicsV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_read_group_sets(read_group_set_id, export_read_group_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/readgroupsets/{readGroupSetId}:export', options) command.request_representation = Google::Apis::GenomicsV1::ExportReadGroupSetRequest::Representation command.request_object = export_read_group_set_request_object command.response_representation = Google::Apis::GenomicsV1::Operation::Representation command.response_class = Google::Apis::GenomicsV1::Operation command.params['readGroupSetId'] = read_group_set_id unless read_group_set_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 read group set by ID. # For the definitions of read group sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] read_group_set_id # The ID of the read group set. # @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::GenomicsV1::ReadGroupSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::ReadGroupSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_read_group_set(read_group_set_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/readgroupsets/{readGroupSetId}', options) command.response_representation = Google::Apis::GenomicsV1::ReadGroupSet::Representation command.response_class = Google::Apis::GenomicsV1::ReadGroupSet command.params['readGroupSetId'] = read_group_set_id unless read_group_set_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 read group sets by asynchronously importing the provided # information. # For the definitions of read group sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # The caller must have WRITE permissions to the dataset. # ## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import # - Tags will be converted to strings - tag types are not preserved # - Comments (`@CO`) in the input file header will not be preserved # - Original header order of references (`@SQ`) will not be preserved # - Any reverse stranded unmapped reads will be reverse complemented, and # their qualities (also the "BQ" and "OQ" tags, if any) will be reversed # - Unmapped reads will be stripped of positional information (reference name # and position) # @param [Google::Apis::GenomicsV1::ImportReadGroupSetsRequest] import_read_group_sets_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::GenomicsV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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 import_read_group_sets(import_read_group_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/readgroupsets:import', options) command.request_representation = Google::Apis::GenomicsV1::ImportReadGroupSetsRequest::Representation command.request_object = import_read_group_sets_request_object command.response_representation = Google::Apis::GenomicsV1::Operation::Representation command.response_class = Google::Apis::GenomicsV1::Operation 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 read group set. # For the definitions of read group sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # This method supports patch semantics. # @param [String] read_group_set_id # The ID of the read group set to be updated. The caller must have WRITE # permissions to the dataset associated with this read group set. # @param [Google::Apis::GenomicsV1::ReadGroupSet] read_group_set_object # @param [String] update_mask # An optional mask specifying which fields to update. Supported fields: # * name. # * referenceSetId. # Leaving `updateMask` unset is equivalent to specifying all mutable # fields. # @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::GenomicsV1::ReadGroupSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::ReadGroupSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_read_group_set(read_group_set_id, read_group_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/readgroupsets/{readGroupSetId}', options) command.request_representation = Google::Apis::GenomicsV1::ReadGroupSet::Representation command.request_object = read_group_set_object command.response_representation = Google::Apis::GenomicsV1::ReadGroupSet::Representation command.response_class = Google::Apis::GenomicsV1::ReadGroupSet command.params['readGroupSetId'] = read_group_set_id unless read_group_set_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 # Searches for read group sets matching the criteria. # For the definitions of read group sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Implements # [GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/ # v0.5.1/src/main/resources/avro/readmethods.avdl#L135). # @param [Google::Apis::GenomicsV1::SearchReadGroupSetsRequest] search_read_group_sets_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::GenomicsV1::SearchReadGroupSetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::SearchReadGroupSetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_read_group_sets(search_read_group_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/readgroupsets/search', options) command.request_representation = Google::Apis::GenomicsV1::SearchReadGroupSetsRequest::Representation command.request_object = search_read_group_sets_request_object command.response_representation = Google::Apis::GenomicsV1::SearchReadGroupSetsResponse::Representation command.response_class = Google::Apis::GenomicsV1::SearchReadGroupSetsResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Lists fixed width coverage buckets for a read group set, each of which # correspond to a range of a reference sequence. Each bucket summarizes # coverage information across its corresponding genomic range. # For the definitions of read group sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Coverage is defined as the number of reads which are aligned to a given # base in the reference sequence. Coverage buckets are available at several # precomputed bucket widths, enabling retrieval of various coverage 'zoom # levels'. The caller must have READ permissions for the target read group # set. # @param [String] read_group_set_id # Required. The ID of the read group set over which coverage is requested. # @param [Fixnum] end_ # The end position of the range on the reference, 0-based exclusive. If # specified, `referenceName` must also be specified. If unset or 0, defaults # to the length of the reference. # @param [Fixnum] page_size # The maximum number of results to return in a single page. If unspecified, # defaults to 1024. The maximum value is 2048. # @param [String] page_token # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # @param [String] reference_name # The name of the reference to query, within the reference set associated # with this query. Optional. # @param [Fixnum] start # The start position of the range on the reference, 0-based inclusive. If # specified, `referenceName` must also be specified. Defaults to 0. # @param [Fixnum] target_bucket_width # The desired width of each reported coverage bucket in base pairs. This # will be rounded down to the nearest precomputed bucket width; the value # of which is returned as `bucketWidth` in the response. Defaults # to infinity (each bucket spans an entire reference sequence) or the length # of the target range, if specified. The smallest precomputed # `bucketWidth` is currently 2048 base pairs; this is subject to # change. # @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::GenomicsV1::ListCoverageBucketsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::ListCoverageBucketsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_coverage_buckets(read_group_set_id, end_: nil, page_size: nil, page_token: nil, reference_name: nil, start: nil, target_bucket_width: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/readgroupsets/{readGroupSetId}/coveragebuckets', options) command.response_representation = Google::Apis::GenomicsV1::ListCoverageBucketsResponse::Representation command.response_class = Google::Apis::GenomicsV1::ListCoverageBucketsResponse command.params['readGroupSetId'] = read_group_set_id unless read_group_set_id.nil? command.query['end'] = end_ unless end_.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['referenceName'] = reference_name unless reference_name.nil? command.query['start'] = start unless start.nil? command.query['targetBucketWidth'] = target_bucket_width unless target_bucket_width.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 list of reads for one or more read group sets. # For the definitions of read group sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Reads search operates over a genomic coordinate space of reference sequence # & position defined over the reference sequences to which the requested # read group sets are aligned. # If a target positional range is specified, search returns all reads whose # alignment to the reference genome overlap the range. A query which # specifies only read group set IDs yields all reads in those read group # sets, including unmapped reads. # All reads returned (including reads on subsequent pages) are ordered by # genomic coordinate (by reference sequence, then position). Reads with # equivalent genomic coordinates are returned in an unspecified order. This # order is consistent, such that two queries for the same content (regardless # of page size) yield reads in the same order across their respective streams # of paginated responses. # Implements # [GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/ # src/main/resources/avro/readmethods.avdl#L85). # @param [Google::Apis::GenomicsV1::SearchReadsRequest] search_reads_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::GenomicsV1::SearchReadsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::SearchReadsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_reads(search_reads_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/reads/search', options) command.request_representation = Google::Apis::GenomicsV1::SearchReadsRequest::Representation command.request_object = search_reads_request_object command.response_representation = Google::Apis::GenomicsV1::SearchReadsResponse::Representation command.response_class = Google::Apis::GenomicsV1::SearchReadsResponse 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. # For the definitions of references and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Implements # [GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/ # src/main/resources/avro/referencemethods.avdl#L158). # @param [String] reference_id # The ID of the reference. # @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::GenomicsV1::Reference] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Reference] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reference(reference_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/references/{referenceId}', options) command.response_representation = Google::Apis::GenomicsV1::Reference::Representation command.response_class = Google::Apis::GenomicsV1::Reference command.params['referenceId'] = reference_id unless reference_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 # Searches for references which match the given criteria. # For the definitions of references and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Implements # [GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0. # 5.1/src/main/resources/avro/referencemethods.avdl#L146). # @param [Google::Apis::GenomicsV1::SearchReferencesRequest] search_references_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::GenomicsV1::SearchReferencesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::SearchReferencesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_references(search_references_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/references/search', options) command.request_representation = Google::Apis::GenomicsV1::SearchReferencesRequest::Representation command.request_object = search_references_request_object command.response_representation = Google::Apis::GenomicsV1::SearchReferencesResponse::Representation command.response_class = Google::Apis::GenomicsV1::SearchReferencesResponse 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 bases in a reference, optionally restricted to a range. # For the definitions of references and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Implements # [GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0. # 5.1/src/main/resources/avro/referencemethods.avdl#L221). # @param [String] reference_id # The ID of the reference. # @param [Fixnum] end_position # The end position (0-based, exclusive) of this query. Defaults to the length # of this reference. # @param [Fixnum] page_size # The maximum number of bases to return in a single page. If unspecified, # defaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base # pairs). # @param [String] page_token # The continuation token, which is used to page through large result sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. # @param [Fixnum] start_position # The start position (0-based) of this query. Defaults to 0. # @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::GenomicsV1::ListBasesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::ListBasesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reference_bases(reference_id, end_position: nil, page_size: nil, page_token: nil, start_position: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/references/{referenceId}/bases', options) command.response_representation = Google::Apis::GenomicsV1::ListBasesResponse::Representation command.response_class = Google::Apis::GenomicsV1::ListBasesResponse command.params['referenceId'] = reference_id unless reference_id.nil? command.query['end'] = end_position unless end_position.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['start'] = start_position unless start_position.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 set. # For the definitions of references and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Implements # [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5. # 1/src/main/resources/avro/referencemethods.avdl#L83). # @param [String] reference_set_id # The ID of the reference set. # @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::GenomicsV1::ReferenceSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::ReferenceSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reference_set(reference_set_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/referencesets/{referenceSetId}', options) command.response_representation = Google::Apis::GenomicsV1::ReferenceSet::Representation command.response_class = Google::Apis::GenomicsV1::ReferenceSet command.params['referenceSetId'] = reference_set_id unless reference_set_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 # Searches for reference sets which match the given criteria. # For the definitions of references and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Implements # [GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/ # v0.5.1/src/main/resources/avro/referencemethods.avdl#L71) # @param [Google::Apis::GenomicsV1::SearchReferenceSetsRequest] search_reference_sets_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::GenomicsV1::SearchReferenceSetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::SearchReferenceSetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_reference_sets(search_reference_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/referencesets/search', options) command.request_representation = Google::Apis::GenomicsV1::SearchReferenceSetsRequest::Representation command.request_object = search_reference_sets_request_object command.response_representation = Google::Apis::GenomicsV1::SearchReferenceSetsResponse::Representation command.response_class = Google::Apis::GenomicsV1::SearchReferenceSetsResponse 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 variant. # For the definitions of variants and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [Google::Apis::GenomicsV1::Variant] variant_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::GenomicsV1::Variant] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Variant] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_variant(variant_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/variants', options) command.request_representation = Google::Apis::GenomicsV1::Variant::Representation command.request_object = variant_object command.response_representation = Google::Apis::GenomicsV1::Variant::Representation command.response_class = Google::Apis::GenomicsV1::Variant 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 variant. # For the definitions of variants and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] variant_id # The ID of the variant 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::GenomicsV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_variant(variant_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/variants/{variantId}', options) command.response_representation = Google::Apis::GenomicsV1::Empty::Representation command.response_class = Google::Apis::GenomicsV1::Empty command.params['variantId'] = variant_id unless variant_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 variant by ID. # For the definitions of variants and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] variant_id # The ID of the variant. # @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::GenomicsV1::Variant] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Variant] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_variant(variant_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/variants/{variantId}', options) command.response_representation = Google::Apis::GenomicsV1::Variant::Representation command.response_class = Google::Apis::GenomicsV1::Variant command.params['variantId'] = variant_id unless variant_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 variant data by asynchronously importing the provided information. # For the definitions of variant sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # The variants for import will be merged with any existing variant that # matches its reference sequence, start, end, reference bases, and # alternative bases. If no such variant exists, a new one will be created. # When variants are merged, the call information from the new variant # is added to the existing variant, and Variant info fields are merged # as specified in # infoMergeConfig. # As a special case, for single-sample VCF files, QUAL and FILTER fields will # be moved to the call level; these are sometimes interpreted in a # call-specific context. # Imported VCF headers are appended to the metadata already in a variant set. # @param [Google::Apis::GenomicsV1::ImportVariantsRequest] import_variants_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::GenomicsV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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 import_variants(import_variants_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/variants:import', options) command.request_representation = Google::Apis::GenomicsV1::ImportVariantsRequest::Representation command.request_object = import_variants_request_object command.response_representation = Google::Apis::GenomicsV1::Operation::Representation command.response_class = Google::Apis::GenomicsV1::Operation command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Merges the given variants with existing variants. # For the definitions of variants and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Each variant will be # merged with an existing variant that matches its reference sequence, # start, end, reference bases, and alternative bases. If no such variant # exists, a new one will be created. # When variants are merged, the call information from the new variant # is added to the existing variant. Variant info fields are merged as # specified in the # infoMergeConfig # field of the MergeVariantsRequest. # Please exercise caution when using this method! It is easy to introduce # mistakes in existing variants and difficult to back out of them. For # example, # suppose you were trying to merge a new variant with an existing one and # both # variants contain calls that belong to callsets with the same callset ID. # // Existing variant - irrelevant fields trimmed for clarity # ` # "variantSetId": "10473108253681171589", # "referenceName": "1", # "start": "10582", # "referenceBases": "G", # "alternateBases": [ # "A" # ], # "calls": [ # ` # "callSetId": "10473108253681171589-0", # "callSetName": "CALLSET0", # "genotype": [ # 0, # 1 # ], # ` # ] # ` # // New variant with conflicting call information # ` # "variantSetId": "10473108253681171589", # "referenceName": "1", # "start": "10582", # "referenceBases": "G", # "alternateBases": [ # "A" # ], # "calls": [ # ` # "callSetId": "10473108253681171589-0", # "callSetName": "CALLSET0", # "genotype": [ # 1, # 1 # ], # ` # ] # ` # The resulting merged variant would overwrite the existing calls with those # from the new variant: # ` # "variantSetId": "10473108253681171589", # "referenceName": "1", # "start": "10582", # "referenceBases": "G", # "alternateBases": [ # "A" # ], # "calls": [ # ` # "callSetId": "10473108253681171589-0", # "callSetName": "CALLSET0", # "genotype": [ # 1, # 1 # ], # ` # ] # ` # This may be the desired outcome, but it is up to the user to determine if # if that is indeed the case. # @param [Google::Apis::GenomicsV1::MergeVariantsRequest] merge_variants_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::GenomicsV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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 merge_variants(merge_variants_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/variants:merge', options) command.request_representation = Google::Apis::GenomicsV1::MergeVariantsRequest::Representation command.request_object = merge_variants_request_object command.response_representation = Google::Apis::GenomicsV1::Empty::Representation command.response_class = Google::Apis::GenomicsV1::Empty 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 variant. # For the definitions of variants and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # This method supports patch semantics. Returns the modified variant without # its calls. # @param [String] variant_id # The ID of the variant to be updated. # @param [Google::Apis::GenomicsV1::Variant] variant_object # @param [String] update_mask # An optional mask specifying which fields to update. At this time, mutable # fields are names and # info. Acceptable values are "names" and # "info". If unspecified, all mutable fields will 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::GenomicsV1::Variant] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::Variant] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_variant(variant_id, variant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/variants/{variantId}', options) command.request_representation = Google::Apis::GenomicsV1::Variant::Representation command.request_object = variant_object command.response_representation = Google::Apis::GenomicsV1::Variant::Representation command.response_class = Google::Apis::GenomicsV1::Variant command.params['variantId'] = variant_id unless variant_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 list of variants matching the criteria. # For the definitions of variants and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Implements # [GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5. # 1/src/main/resources/avro/variantmethods.avdl#L126). # @param [Google::Apis::GenomicsV1::SearchVariantsRequest] search_variants_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::GenomicsV1::SearchVariantsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::SearchVariantsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_variants(search_variants_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/variants/search', options) command.request_representation = Google::Apis::GenomicsV1::SearchVariantsRequest::Representation command.request_object = search_variants_request_object command.response_representation = Google::Apis::GenomicsV1::SearchVariantsResponse::Representation command.response_class = Google::Apis::GenomicsV1::SearchVariantsResponse 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 variant set. # For the definitions of variant sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # The provided variant set must have a valid `datasetId` set - all other # fields are optional. Note that the `id` field will be ignored, as this is # assigned by the server. # @param [Google::Apis::GenomicsV1::VariantSet] variant_set_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::GenomicsV1::VariantSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::VariantSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_variantset(variant_set_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/variantsets', options) command.request_representation = Google::Apis::GenomicsV1::VariantSet::Representation command.request_object = variant_set_object command.response_representation = Google::Apis::GenomicsV1::VariantSet::Representation command.response_class = Google::Apis::GenomicsV1::VariantSet 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 variant set including all variants, call sets, and calls within. # This is not reversible. # For the definitions of variant sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] variant_set_id # The ID of the variant set 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::GenomicsV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_variantset(variant_set_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/variantsets/{variantSetId}', options) command.response_representation = Google::Apis::GenomicsV1::Empty::Representation command.response_class = Google::Apis::GenomicsV1::Empty command.params['variantSetId'] = variant_set_id unless variant_set_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 # Exports variant set data to an external destination. # For the definitions of variant sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] variant_set_id # Required. The ID of the variant set that contains variant data which # should be exported. The caller must have READ access to this variant set. # @param [Google::Apis::GenomicsV1::ExportVariantSetRequest] export_variant_set_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::GenomicsV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::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_variant_set(variant_set_id, export_variant_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/variantsets/{variantSetId}:export', options) command.request_representation = Google::Apis::GenomicsV1::ExportVariantSetRequest::Representation command.request_object = export_variant_set_request_object command.response_representation = Google::Apis::GenomicsV1::Operation::Representation command.response_class = Google::Apis::GenomicsV1::Operation command.params['variantSetId'] = variant_set_id unless variant_set_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 variant set by ID. # For the definitions of variant sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] variant_set_id # Required. The ID of the variant set. # @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::GenomicsV1::VariantSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::VariantSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_variantset(variant_set_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/variantsets/{variantSetId}', options) command.response_representation = Google::Apis::GenomicsV1::VariantSet::Representation command.response_class = Google::Apis::GenomicsV1::VariantSet command.params['variantSetId'] = variant_set_id unless variant_set_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 a variant set using patch semantics. # For the definitions of variant sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # @param [String] variant_set_id # The ID of the variant to be updated (must already exist). # @param [Google::Apis::GenomicsV1::VariantSet] variant_set_object # @param [String] update_mask # An optional mask specifying which fields to update. Supported fields: # * metadata. # * name. # * description. # Leaving `updateMask` unset is equivalent to specifying all mutable # fields. # @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::GenomicsV1::VariantSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::VariantSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_variantset(variant_set_id, variant_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/variantsets/{variantSetId}', options) command.request_representation = Google::Apis::GenomicsV1::VariantSet::Representation command.request_object = variant_set_object command.response_representation = Google::Apis::GenomicsV1::VariantSet::Representation command.response_class = Google::Apis::GenomicsV1::VariantSet command.params['variantSetId'] = variant_set_id unless variant_set_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 # Returns a list of all variant sets matching search criteria. # For the definitions of variant sets and other genomics resources, see # [Fundamentals of Google # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) # Implements # [GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0. # 5.1/src/main/resources/avro/variantmethods.avdl#L49). # @param [Google::Apis::GenomicsV1::SearchVariantSetsRequest] search_variant_sets_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::GenomicsV1::SearchVariantSetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GenomicsV1::SearchVariantSetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_variant_sets(search_variant_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/variantsets/search', options) command.request_representation = Google::Apis::GenomicsV1::SearchVariantSetsRequest::Representation command.request_object = search_variant_sets_request_object command.response_representation = Google::Apis::GenomicsV1::SearchVariantSetsResponse::Representation command.response_class = Google::Apis::GenomicsV1::SearchVariantSetsResponse 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 google-api-client-0.19.8/generated/google/apis/doubleclickbidmanager_v1/0000755000004100000410000000000013252673043026213 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/doubleclickbidmanager_v1/representations.rb0000644000004100000410000003301013252673043031762 0ustar www-datawww-data# 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 DoubleclickbidmanagerV1 class DownloadLineItemsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DownloadLineItemsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DownloadRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DownloadResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FilterPair class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListQueriesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListReportsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Parameters class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Query class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuerySchedule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Report class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportFailure class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RowStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RunQueryRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UploadLineItemsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UploadLineItemsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UploadStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DownloadLineItemsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :file_spec, as: 'fileSpec' collection :filter_ids, as: 'filterIds' property :filter_type, as: 'filterType' property :format, as: 'format' end end class DownloadLineItemsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_items, as: 'lineItems' end end class DownloadRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :file_types, as: 'fileTypes' collection :filter_ids, as: 'filterIds' property :filter_type, as: 'filterType' property :version, as: 'version' end end class DownloadResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :ad_groups, as: 'adGroups' property :ads, as: 'ads' property :campaigns, as: 'campaigns' property :insertion_orders, as: 'insertionOrders' property :line_items, as: 'lineItems' end end class FilterPair # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' property :value, as: 'value' end end class ListQueriesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :queries, as: 'queries', class: Google::Apis::DoubleclickbidmanagerV1::Query, decorator: Google::Apis::DoubleclickbidmanagerV1::Query::Representation end end class ListReportsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :reports, as: 'reports', class: Google::Apis::DoubleclickbidmanagerV1::Report, decorator: Google::Apis::DoubleclickbidmanagerV1::Report::Representation end end class Parameters # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filters, as: 'filters', class: Google::Apis::DoubleclickbidmanagerV1::FilterPair, decorator: Google::Apis::DoubleclickbidmanagerV1::FilterPair::Representation collection :group_bys, as: 'groupBys' property :include_invite_data, as: 'includeInviteData' collection :metrics, as: 'metrics' property :type, as: 'type' end end class Query # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :metadata, as: 'metadata', class: Google::Apis::DoubleclickbidmanagerV1::QueryMetadata, decorator: Google::Apis::DoubleclickbidmanagerV1::QueryMetadata::Representation property :params, as: 'params', class: Google::Apis::DoubleclickbidmanagerV1::Parameters, decorator: Google::Apis::DoubleclickbidmanagerV1::Parameters::Representation property :query_id, :numeric_string => true, as: 'queryId' property :report_data_end_time_ms, :numeric_string => true, as: 'reportDataEndTimeMs' property :report_data_start_time_ms, :numeric_string => true, as: 'reportDataStartTimeMs' property :schedule, as: 'schedule', class: Google::Apis::DoubleclickbidmanagerV1::QuerySchedule, decorator: Google::Apis::DoubleclickbidmanagerV1::QuerySchedule::Representation property :timezone_code, as: 'timezoneCode' end end class QueryMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :data_range, as: 'dataRange' property :format, as: 'format' property :google_cloud_storage_path_for_latest_report, as: 'googleCloudStoragePathForLatestReport' property :google_drive_path_for_latest_report, as: 'googleDrivePathForLatestReport' property :latest_report_run_time_ms, :numeric_string => true, as: 'latestReportRunTimeMs' property :locale, as: 'locale' property :report_count, as: 'reportCount' property :running, as: 'running' property :send_notification, as: 'sendNotification' collection :share_email_address, as: 'shareEmailAddress' property :title, as: 'title' end end class QuerySchedule # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time_ms, :numeric_string => true, as: 'endTimeMs' property :frequency, as: 'frequency' property :next_run_minute_of_day, as: 'nextRunMinuteOfDay' property :next_run_timezone_code, as: 'nextRunTimezoneCode' end end class Report # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key', class: Google::Apis::DoubleclickbidmanagerV1::ReportKey, decorator: Google::Apis::DoubleclickbidmanagerV1::ReportKey::Representation property :metadata, as: 'metadata', class: Google::Apis::DoubleclickbidmanagerV1::ReportMetadata, decorator: Google::Apis::DoubleclickbidmanagerV1::ReportMetadata::Representation property :params, as: 'params', class: Google::Apis::DoubleclickbidmanagerV1::Parameters, decorator: Google::Apis::DoubleclickbidmanagerV1::Parameters::Representation end end class ReportFailure # @private class Representation < Google::Apis::Core::JsonRepresentation property :error_code, as: 'errorCode' end end class ReportKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :query_id, :numeric_string => true, as: 'queryId' property :report_id, :numeric_string => true, as: 'reportId' end end class ReportMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :google_cloud_storage_path, as: 'googleCloudStoragePath' property :report_data_end_time_ms, :numeric_string => true, as: 'reportDataEndTimeMs' property :report_data_start_time_ms, :numeric_string => true, as: 'reportDataStartTimeMs' property :status, as: 'status', class: Google::Apis::DoubleclickbidmanagerV1::ReportStatus, decorator: Google::Apis::DoubleclickbidmanagerV1::ReportStatus::Representation end end class ReportStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :failure, as: 'failure', class: Google::Apis::DoubleclickbidmanagerV1::ReportFailure, decorator: Google::Apis::DoubleclickbidmanagerV1::ReportFailure::Representation property :finish_time_ms, :numeric_string => true, as: 'finishTimeMs' property :format, as: 'format' property :state, as: 'state' end end class RowStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :changed, as: 'changed' property :entity_id, :numeric_string => true, as: 'entityId' property :entity_name, as: 'entityName' collection :errors, as: 'errors' property :persisted, as: 'persisted' property :row_number, as: 'rowNumber' end end class RunQueryRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :data_range, as: 'dataRange' property :report_data_end_time_ms, :numeric_string => true, as: 'reportDataEndTimeMs' property :report_data_start_time_ms, :numeric_string => true, as: 'reportDataStartTimeMs' property :timezone_code, as: 'timezoneCode' end end class UploadLineItemsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :dry_run, as: 'dryRun' property :format, as: 'format' property :line_items, as: 'lineItems' end end class UploadLineItemsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :upload_status, as: 'uploadStatus', class: Google::Apis::DoubleclickbidmanagerV1::UploadStatus, decorator: Google::Apis::DoubleclickbidmanagerV1::UploadStatus::Representation end end class UploadStatus # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors' collection :row_status, as: 'rowStatus', class: Google::Apis::DoubleclickbidmanagerV1::RowStatus, decorator: Google::Apis::DoubleclickbidmanagerV1::RowStatus::Representation end end end end end google-api-client-0.19.8/generated/google/apis/doubleclickbidmanager_v1/classes.rb0000644000004100000410000007122313252673043030202 0ustar www-datawww-data# 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 DoubleclickbidmanagerV1 # Request to fetch stored line items. class DownloadLineItemsRequest include Google::Apis::Core::Hashable # File specification (column names, types, order) in which the line items will # be returned. Default to EWF. # Corresponds to the JSON property `fileSpec` # @return [String] attr_accessor :file_spec # Ids of the specified filter type used to filter line items to fetch. If # omitted, all the line items will be returned. # Corresponds to the JSON property `filterIds` # @return [Array] attr_accessor :filter_ids # Filter type used to filter line items to fetch. # Corresponds to the JSON property `filterType` # @return [String] attr_accessor :filter_type # Format in which the line items will be returned. Default to CSV. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file_spec = args[:file_spec] if args.key?(:file_spec) @filter_ids = args[:filter_ids] if args.key?(:filter_ids) @filter_type = args[:filter_type] if args.key?(:filter_type) @format = args[:format] if args.key?(:format) end end # Download line items response. class DownloadLineItemsResponse include Google::Apis::Core::Hashable # Retrieved line items in CSV format. For more information about file formats, # see Entity Write File Format. # Corresponds to the JSON property `lineItems` # @return [String] attr_accessor :line_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @line_items = args[:line_items] if args.key?(:line_items) end end # Request to fetch stored insertion orders, line items, TrueView ad groups and # ads. class DownloadRequest include Google::Apis::Core::Hashable # File types that will be returned. # Corresponds to the JSON property `fileTypes` # @return [Array] attr_accessor :file_types # The IDs of the specified filter type. This is used to filter entities to fetch. # At least one ID must be specified. Only one ID is allowed for the # ADVERTISER_ID filter type. For INSERTION_ORDER_ID or LINE_ITEM_ID filter types, # all IDs must be from the same Advertiser. # Corresponds to the JSON property `filterIds` # @return [Array] attr_accessor :filter_ids # Filter type used to filter line items to fetch. # Corresponds to the JSON property `filterType` # @return [String] attr_accessor :filter_type # SDF Version (column names, types, order) in which the entities will be # returned. Default to 3. # 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) @file_types = args[:file_types] if args.key?(:file_types) @filter_ids = args[:filter_ids] if args.key?(:filter_ids) @filter_type = args[:filter_type] if args.key?(:filter_type) @version = args[:version] if args.key?(:version) end end # Download response. class DownloadResponse include Google::Apis::Core::Hashable # Retrieved ad groups in SDF format. # Corresponds to the JSON property `adGroups` # @return [String] attr_accessor :ad_groups # Retrieved ads in SDF format. # Corresponds to the JSON property `ads` # @return [String] attr_accessor :ads # Retrieved campaigns in SDF format. # Corresponds to the JSON property `campaigns` # @return [String] attr_accessor :campaigns # Retrieved insertion orders in SDF format. # Corresponds to the JSON property `insertionOrders` # @return [String] attr_accessor :insertion_orders # Retrieved line items in SDF format. # Corresponds to the JSON property `lineItems` # @return [String] attr_accessor :line_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_groups = args[:ad_groups] if args.key?(:ad_groups) @ads = args[:ads] if args.key?(:ads) @campaigns = args[:campaigns] if args.key?(:campaigns) @insertion_orders = args[:insertion_orders] if args.key?(:insertion_orders) @line_items = args[:line_items] if args.key?(:line_items) end end # Filter used to match traffic data in your report. class FilterPair include Google::Apis::Core::Hashable # Filter type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Filter 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) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end # List queries response. class ListQueriesResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # doubleclickbidmanager#listQueriesResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Retrieved queries. # 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) @kind = args[:kind] if args.key?(:kind) @queries = args[:queries] if args.key?(:queries) end end # List reports response. class ListReportsResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # doubleclickbidmanager#listReportsResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Retrieved reports. # Corresponds to the JSON property `reports` # @return [Array] attr_accessor :reports def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @reports = args[:reports] if args.key?(:reports) end end # Parameters of a query or report. class Parameters include Google::Apis::Core::Hashable # Filters used to match traffic data in your report. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters # Data is grouped by the filters listed in this field. # Corresponds to the JSON property `groupBys` # @return [Array] attr_accessor :group_bys # Whether to include data from Invite Media. # Corresponds to the JSON property `includeInviteData` # @return [Boolean] attr_accessor :include_invite_data alias_method :include_invite_data?, :include_invite_data # Metrics to include as columns in your report. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Report 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) @filters = args[:filters] if args.key?(:filters) @group_bys = args[:group_bys] if args.key?(:group_bys) @include_invite_data = args[:include_invite_data] if args.key?(:include_invite_data) @metrics = args[:metrics] if args.key?(:metrics) @type = args[:type] if args.key?(:type) end end # Represents a query. class Query include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # doubleclickbidmanager#query". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Query metadata. # Corresponds to the JSON property `metadata` # @return [Google::Apis::DoubleclickbidmanagerV1::QueryMetadata] attr_accessor :metadata # Parameters of a query or report. # Corresponds to the JSON property `params` # @return [Google::Apis::DoubleclickbidmanagerV1::Parameters] attr_accessor :params # Query ID. # Corresponds to the JSON property `queryId` # @return [Fixnum] attr_accessor :query_id # The ending time for the data that is shown in the report. Note, # reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and # ignored otherwise. # Corresponds to the JSON property `reportDataEndTimeMs` # @return [Fixnum] attr_accessor :report_data_end_time_ms # The starting time for the data that is shown in the report. Note, # reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and # ignored otherwise. # Corresponds to the JSON property `reportDataStartTimeMs` # @return [Fixnum] attr_accessor :report_data_start_time_ms # Information on how frequently and when to run a query. # Corresponds to the JSON property `schedule` # @return [Google::Apis::DoubleclickbidmanagerV1::QuerySchedule] attr_accessor :schedule # Canonical timezone code for report data time. Defaults to America/New_York. # Corresponds to the JSON property `timezoneCode` # @return [String] attr_accessor :timezone_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @metadata = args[:metadata] if args.key?(:metadata) @params = args[:params] if args.key?(:params) @query_id = args[:query_id] if args.key?(:query_id) @report_data_end_time_ms = args[:report_data_end_time_ms] if args.key?(:report_data_end_time_ms) @report_data_start_time_ms = args[:report_data_start_time_ms] if args.key?(:report_data_start_time_ms) @schedule = args[:schedule] if args.key?(:schedule) @timezone_code = args[:timezone_code] if args.key?(:timezone_code) end end # Query metadata. class QueryMetadata include Google::Apis::Core::Hashable # Range of report data. # Corresponds to the JSON property `dataRange` # @return [String] attr_accessor :data_range # Format of the generated report. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # The path to the location in Google Cloud Storage where the latest report is # stored. # Corresponds to the JSON property `googleCloudStoragePathForLatestReport` # @return [String] attr_accessor :google_cloud_storage_path_for_latest_report # The path in Google Drive for the latest report. # Corresponds to the JSON property `googleDrivePathForLatestReport` # @return [String] attr_accessor :google_drive_path_for_latest_report # The time when the latest report started to run. # Corresponds to the JSON property `latestReportRunTimeMs` # @return [Fixnum] attr_accessor :latest_report_run_time_ms # Locale of the generated reports. Valid values are cs CZECH de GERMAN en # ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR # BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh- # TW TAIWAN_CHINESE # An locale string not in the list above will generate reports in English. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # Number of reports that have been generated for the query. # Corresponds to the JSON property `reportCount` # @return [Fixnum] attr_accessor :report_count # Whether the latest report is currently running. # Corresponds to the JSON property `running` # @return [Boolean] attr_accessor :running alias_method :running?, :running # Whether to send an email notification when a report is ready. Default to false. # Corresponds to the JSON property `sendNotification` # @return [Boolean] attr_accessor :send_notification alias_method :send_notification?, :send_notification # List of email addresses which are sent email notifications when the report is # finished. Separate from sendNotification. # Corresponds to the JSON property `shareEmailAddress` # @return [Array] attr_accessor :share_email_address # Query title. It is used to name the reports generated from this query. # 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) @data_range = args[:data_range] if args.key?(:data_range) @format = args[:format] if args.key?(:format) @google_cloud_storage_path_for_latest_report = args[:google_cloud_storage_path_for_latest_report] if args.key?(:google_cloud_storage_path_for_latest_report) @google_drive_path_for_latest_report = args[:google_drive_path_for_latest_report] if args.key?(:google_drive_path_for_latest_report) @latest_report_run_time_ms = args[:latest_report_run_time_ms] if args.key?(:latest_report_run_time_ms) @locale = args[:locale] if args.key?(:locale) @report_count = args[:report_count] if args.key?(:report_count) @running = args[:running] if args.key?(:running) @send_notification = args[:send_notification] if args.key?(:send_notification) @share_email_address = args[:share_email_address] if args.key?(:share_email_address) @title = args[:title] if args.key?(:title) end end # Information on how frequently and when to run a query. class QuerySchedule include Google::Apis::Core::Hashable # Datetime to periodically run the query until. # Corresponds to the JSON property `endTimeMs` # @return [Fixnum] attr_accessor :end_time_ms # How often the query is run. # Corresponds to the JSON property `frequency` # @return [String] attr_accessor :frequency # Time of day at which a new report will be generated, represented as minutes # past midnight. Range is 0 to 1439. Only applies to scheduled reports. # Corresponds to the JSON property `nextRunMinuteOfDay` # @return [Fixnum] attr_accessor :next_run_minute_of_day # Canonical timezone code for report generation time. Defaults to America/ # New_York. # Corresponds to the JSON property `nextRunTimezoneCode` # @return [String] attr_accessor :next_run_timezone_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_time_ms = args[:end_time_ms] if args.key?(:end_time_ms) @frequency = args[:frequency] if args.key?(:frequency) @next_run_minute_of_day = args[:next_run_minute_of_day] if args.key?(:next_run_minute_of_day) @next_run_timezone_code = args[:next_run_timezone_code] if args.key?(:next_run_timezone_code) end end # Represents a report. class Report include Google::Apis::Core::Hashable # Key used to identify a report. # Corresponds to the JSON property `key` # @return [Google::Apis::DoubleclickbidmanagerV1::ReportKey] attr_accessor :key # Report metadata. # Corresponds to the JSON property `metadata` # @return [Google::Apis::DoubleclickbidmanagerV1::ReportMetadata] attr_accessor :metadata # Parameters of a query or report. # Corresponds to the JSON property `params` # @return [Google::Apis::DoubleclickbidmanagerV1::Parameters] attr_accessor :params def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key = args[:key] if args.key?(:key) @metadata = args[:metadata] if args.key?(:metadata) @params = args[:params] if args.key?(:params) end end # An explanation of a report failure. class ReportFailure include Google::Apis::Core::Hashable # Error code that shows why the report was not created. # Corresponds to the JSON property `errorCode` # @return [String] attr_accessor :error_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_code = args[:error_code] if args.key?(:error_code) end end # Key used to identify a report. class ReportKey include Google::Apis::Core::Hashable # Query ID. # Corresponds to the JSON property `queryId` # @return [Fixnum] attr_accessor :query_id # Report ID. # Corresponds to the JSON property `reportId` # @return [Fixnum] attr_accessor :report_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @query_id = args[:query_id] if args.key?(:query_id) @report_id = args[:report_id] if args.key?(:report_id) end end # Report metadata. class ReportMetadata include Google::Apis::Core::Hashable # The path to the location in Google Cloud Storage where the report is stored. # Corresponds to the JSON property `googleCloudStoragePath` # @return [String] attr_accessor :google_cloud_storage_path # The ending time for the data that is shown in the report. # Corresponds to the JSON property `reportDataEndTimeMs` # @return [Fixnum] attr_accessor :report_data_end_time_ms # The starting time for the data that is shown in the report. # Corresponds to the JSON property `reportDataStartTimeMs` # @return [Fixnum] attr_accessor :report_data_start_time_ms # Report status. # Corresponds to the JSON property `status` # @return [Google::Apis::DoubleclickbidmanagerV1::ReportStatus] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @google_cloud_storage_path = args[:google_cloud_storage_path] if args.key?(:google_cloud_storage_path) @report_data_end_time_ms = args[:report_data_end_time_ms] if args.key?(:report_data_end_time_ms) @report_data_start_time_ms = args[:report_data_start_time_ms] if args.key?(:report_data_start_time_ms) @status = args[:status] if args.key?(:status) end end # Report status. class ReportStatus include Google::Apis::Core::Hashable # An explanation of a report failure. # Corresponds to the JSON property `failure` # @return [Google::Apis::DoubleclickbidmanagerV1::ReportFailure] attr_accessor :failure # The time when this report either completed successfully or failed. # Corresponds to the JSON property `finishTimeMs` # @return [Fixnum] attr_accessor :finish_time_ms # The file type of the report. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # The state of the report. # 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) @failure = args[:failure] if args.key?(:failure) @finish_time_ms = args[:finish_time_ms] if args.key?(:finish_time_ms) @format = args[:format] if args.key?(:format) @state = args[:state] if args.key?(:state) end end # Represents the upload status of a row in the request. class RowStatus include Google::Apis::Core::Hashable # Whether the stored entity is changed as a result of upload. # Corresponds to the JSON property `changed` # @return [Boolean] attr_accessor :changed alias_method :changed?, :changed # Entity Id. # Corresponds to the JSON property `entityId` # @return [Fixnum] attr_accessor :entity_id # Entity name. # Corresponds to the JSON property `entityName` # @return [String] attr_accessor :entity_name # Reasons why the entity can't be uploaded. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # Whether the entity is persisted. # Corresponds to the JSON property `persisted` # @return [Boolean] attr_accessor :persisted alias_method :persisted?, :persisted # Row number. # Corresponds to the JSON property `rowNumber` # @return [Fixnum] attr_accessor :row_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @changed = args[:changed] if args.key?(:changed) @entity_id = args[:entity_id] if args.key?(:entity_id) @entity_name = args[:entity_name] if args.key?(:entity_name) @errors = args[:errors] if args.key?(:errors) @persisted = args[:persisted] if args.key?(:persisted) @row_number = args[:row_number] if args.key?(:row_number) end end # Request to run a stored query to generate a report. class RunQueryRequest include Google::Apis::Core::Hashable # Report data range used to generate the report. # Corresponds to the JSON property `dataRange` # @return [String] attr_accessor :data_range # The ending time for the data that is shown in the report. Note, # reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored # otherwise. # Corresponds to the JSON property `reportDataEndTimeMs` # @return [Fixnum] attr_accessor :report_data_end_time_ms # The starting time for the data that is shown in the report. Note, # reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored # otherwise. # Corresponds to the JSON property `reportDataStartTimeMs` # @return [Fixnum] attr_accessor :report_data_start_time_ms # Canonical timezone code for report data time. Defaults to America/New_York. # Corresponds to the JSON property `timezoneCode` # @return [String] attr_accessor :timezone_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data_range = args[:data_range] if args.key?(:data_range) @report_data_end_time_ms = args[:report_data_end_time_ms] if args.key?(:report_data_end_time_ms) @report_data_start_time_ms = args[:report_data_start_time_ms] if args.key?(:report_data_start_time_ms) @timezone_code = args[:timezone_code] if args.key?(:timezone_code) end end # Request to upload line items. class UploadLineItemsRequest include Google::Apis::Core::Hashable # Set to true to get upload status without actually persisting the line items. # Corresponds to the JSON property `dryRun` # @return [Boolean] attr_accessor :dry_run alias_method :dry_run?, :dry_run # Format the line items are in. Default to CSV. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # Line items in CSV to upload. Refer to Entity Write File Format for more # information on file format. # Corresponds to the JSON property `lineItems` # @return [String] attr_accessor :line_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dry_run = args[:dry_run] if args.key?(:dry_run) @format = args[:format] if args.key?(:format) @line_items = args[:line_items] if args.key?(:line_items) end end # Upload line items response. class UploadLineItemsResponse include Google::Apis::Core::Hashable # Represents the status of upload. # Corresponds to the JSON property `uploadStatus` # @return [Google::Apis::DoubleclickbidmanagerV1::UploadStatus] attr_accessor :upload_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @upload_status = args[:upload_status] if args.key?(:upload_status) end end # Represents the status of upload. class UploadStatus include Google::Apis::Core::Hashable # Reasons why upload can't be completed. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # Per-row upload status. # Corresponds to the JSON property `rowStatus` # @return [Array] attr_accessor :row_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) @row_status = args[:row_status] if args.key?(:row_status) end end end end end google-api-client-0.19.8/generated/google/apis/doubleclickbidmanager_v1/service.rb0000644000004100000410000005255513252673043030214 0ustar www-datawww-data# 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 DoubleclickbidmanagerV1 # DoubleClick Bid Manager API # # API for viewing and managing your reports in DoubleClick Bid Manager. # # @example # require 'google/apis/doubleclickbidmanager_v1' # # Doubleclickbidmanager = Google::Apis::DoubleclickbidmanagerV1 # Alias the module # service = Doubleclickbidmanager::DoubleClickBidManagerService.new # # @see https://developers.google.com/bid-manager/ class DoubleClickBidManagerService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'doubleclickbidmanager/v1/') @batch_path = 'batch/doubleclickbidmanager/v1' end # Retrieves line items in CSV format. TrueView line items are not supported. # @param [Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsRequest] download_line_items_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def download_line_items(download_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'lineitems/downloadlineitems', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsRequest::Representation command.request_object = download_line_items_request_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse 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 line items in CSV format. TrueView line items are not supported. # @param [Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsRequest] upload_line_items_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_line_items(upload_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'lineitems/uploadlineitems', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsRequest::Representation command.request_object = upload_line_items_request_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse 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 query. # @param [Google::Apis::DoubleclickbidmanagerV1::Query] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::Query] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DoubleclickbidmanagerV1::Query] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_query(query_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'query', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation command.request_object = query_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1::Query 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 a stored query as well as the associated stored reports. # @param [Fixnum] query_id # Query ID 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 deletequery(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'query/{queryId}', options) command.params['queryId'] = query_id unless query_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 stored query. # @param [Fixnum] query_id # Query ID to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::Query] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DoubleclickbidmanagerV1::Query] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_query(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'query/{queryId}', options) command.response_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1::Query command.params['queryId'] = query_id unless query_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 stored queries. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_queries(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'queries', options) command.response_representation = Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse 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 # Runs a stored query to generate a report. # @param [Fixnum] query_id # Query ID to run. # @param [Google::Apis::DoubleclickbidmanagerV1::RunQueryRequest] run_query_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 run_query(query_id, run_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'query/{queryId}', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1::RunQueryRequest::Representation command.request_object = run_query_request_object command.params['queryId'] = query_id unless query_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 stored reports. # @param [Fixnum] query_id # Query ID with which the reports are associated. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reports(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'queries/{queryId}/reports', options) command.response_representation = Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse command.params['queryId'] = query_id unless query_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 entities in SDF format. # @param [Google::Apis::DoubleclickbidmanagerV1::DownloadRequest] download_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DoubleclickbidmanagerV1::DownloadResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DoubleclickbidmanagerV1::DownloadResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def download_sdf(download_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'sdf/download', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadRequest::Representation command.request_object = download_request_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadResponse::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1::DownloadResponse 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 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 end end google-api-client-0.19.8/generated/google/apis/plus_v1/0000755000004100000410000000000013252673044022705 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/plus_v1/representations.rb0000644000004100000410000010536513252673044026471 0ustar www-datawww-data# 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 PlusV1 class Acl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Activity class Representation < Google::Apis::Core::JsonRepresentation; end class Actor class Representation < Google::Apis::Core::JsonRepresentation; end class ClientSpecificActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end class YoutubeActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Image class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Name class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Verification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Object class Representation < Google::Apis::Core::JsonRepresentation; end class Actor class Representation < Google::Apis::Core::JsonRepresentation; end class ClientSpecificActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end class YoutubeActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Image class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Verification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Attachment class Representation < Google::Apis::Core::JsonRepresentation; end class Embed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FullImage 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 Thumbnail class Representation < Google::Apis::Core::JsonRepresentation; end class Image 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 Plusoners class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Replies class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Resharers class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Provider class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ActivityFeed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Comment class Representation < Google::Apis::Core::JsonRepresentation; end class Actor class Representation < Google::Apis::Core::JsonRepresentation; end class ClientSpecificActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end class YoutubeActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Image class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Verification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class InReplyTo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Object class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Plusoners class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class CommentFeed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PeopleFeed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Person class Representation < Google::Apis::Core::JsonRepresentation; end class AgeRange class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Cover class Representation < Google::Apis::Core::JsonRepresentation; end class CoverInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CoverPhoto class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Email 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 Name class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Organization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacesLived class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Url class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Place class Representation < Google::Apis::Core::JsonRepresentation; end class Address class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Position class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class PlusAclentryResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Acl # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' collection :items, as: 'items', class: Google::Apis::PlusV1::PlusAclentryResource, decorator: Google::Apis::PlusV1::PlusAclentryResource::Representation property :kind, as: 'kind' end end class Activity # @private class Representation < Google::Apis::Core::JsonRepresentation property :access, as: 'access', class: Google::Apis::PlusV1::Acl, decorator: Google::Apis::PlusV1::Acl::Representation property :actor, as: 'actor', class: Google::Apis::PlusV1::Activity::Actor, decorator: Google::Apis::PlusV1::Activity::Actor::Representation property :address, as: 'address' property :annotation, as: 'annotation' property :crosspost_source, as: 'crosspostSource' property :etag, as: 'etag' property :geocode, as: 'geocode' property :id, as: 'id' property :kind, as: 'kind' property :location, as: 'location', class: Google::Apis::PlusV1::Place, decorator: Google::Apis::PlusV1::Place::Representation property :object, as: 'object', class: Google::Apis::PlusV1::Activity::Object, decorator: Google::Apis::PlusV1::Activity::Object::Representation property :place_id, as: 'placeId' property :place_name, as: 'placeName' property :provider, as: 'provider', class: Google::Apis::PlusV1::Activity::Provider, decorator: Google::Apis::PlusV1::Activity::Provider::Representation property :published, as: 'published', type: DateTime property :radius, as: 'radius' property :title, as: 'title' property :updated, as: 'updated', type: DateTime property :url, as: 'url' property :verb, as: 'verb' end class Actor # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_specific_actor_info, as: 'clientSpecificActorInfo', class: Google::Apis::PlusV1::Activity::Actor::ClientSpecificActorInfo, decorator: Google::Apis::PlusV1::Activity::Actor::ClientSpecificActorInfo::Representation property :display_name, as: 'displayName' property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusV1::Activity::Actor::Image, decorator: Google::Apis::PlusV1::Activity::Actor::Image::Representation property :name, as: 'name', class: Google::Apis::PlusV1::Activity::Actor::Name, decorator: Google::Apis::PlusV1::Activity::Actor::Name::Representation property :url, as: 'url' property :verification, as: 'verification', class: Google::Apis::PlusV1::Activity::Actor::Verification, decorator: Google::Apis::PlusV1::Activity::Actor::Verification::Representation end class ClientSpecificActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :youtube_actor_info, as: 'youtubeActorInfo', class: Google::Apis::PlusV1::Activity::Actor::ClientSpecificActorInfo::YoutubeActorInfo, decorator: Google::Apis::PlusV1::Activity::Actor::ClientSpecificActorInfo::YoutubeActorInfo::Representation end class YoutubeActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' end end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class Name # @private class Representation < Google::Apis::Core::JsonRepresentation property :family_name, as: 'familyName' property :given_name, as: 'givenName' end end class Verification # @private class Representation < Google::Apis::Core::JsonRepresentation property :ad_hoc_verified, as: 'adHocVerified' end end end class Object # @private class Representation < Google::Apis::Core::JsonRepresentation property :actor, as: 'actor', class: Google::Apis::PlusV1::Activity::Object::Actor, decorator: Google::Apis::PlusV1::Activity::Object::Actor::Representation collection :attachments, as: 'attachments', class: Google::Apis::PlusV1::Activity::Object::Attachment, decorator: Google::Apis::PlusV1::Activity::Object::Attachment::Representation property :content, as: 'content' property :id, as: 'id' property :object_type, as: 'objectType' property :original_content, as: 'originalContent' property :plusoners, as: 'plusoners', class: Google::Apis::PlusV1::Activity::Object::Plusoners, decorator: Google::Apis::PlusV1::Activity::Object::Plusoners::Representation property :replies, as: 'replies', class: Google::Apis::PlusV1::Activity::Object::Replies, decorator: Google::Apis::PlusV1::Activity::Object::Replies::Representation property :resharers, as: 'resharers', class: Google::Apis::PlusV1::Activity::Object::Resharers, decorator: Google::Apis::PlusV1::Activity::Object::Resharers::Representation property :url, as: 'url' end class Actor # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_specific_actor_info, as: 'clientSpecificActorInfo', class: Google::Apis::PlusV1::Activity::Object::Actor::ClientSpecificActorInfo, decorator: Google::Apis::PlusV1::Activity::Object::Actor::ClientSpecificActorInfo::Representation property :display_name, as: 'displayName' property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusV1::Activity::Object::Actor::Image, decorator: Google::Apis::PlusV1::Activity::Object::Actor::Image::Representation property :url, as: 'url' property :verification, as: 'verification', class: Google::Apis::PlusV1::Activity::Object::Actor::Verification, decorator: Google::Apis::PlusV1::Activity::Object::Actor::Verification::Representation end class ClientSpecificActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :youtube_actor_info, as: 'youtubeActorInfo', class: Google::Apis::PlusV1::Activity::Object::Actor::ClientSpecificActorInfo::YoutubeActorInfo, decorator: Google::Apis::PlusV1::Activity::Object::Actor::ClientSpecificActorInfo::YoutubeActorInfo::Representation end class YoutubeActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' end end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class Verification # @private class Representation < Google::Apis::Core::JsonRepresentation property :ad_hoc_verified, as: 'adHocVerified' end end end class Attachment # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :display_name, as: 'displayName' property :embed, as: 'embed', class: Google::Apis::PlusV1::Activity::Object::Attachment::Embed, decorator: Google::Apis::PlusV1::Activity::Object::Attachment::Embed::Representation property :full_image, as: 'fullImage', class: Google::Apis::PlusV1::Activity::Object::Attachment::FullImage, decorator: Google::Apis::PlusV1::Activity::Object::Attachment::FullImage::Representation property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusV1::Activity::Object::Attachment::Image, decorator: Google::Apis::PlusV1::Activity::Object::Attachment::Image::Representation property :object_type, as: 'objectType' collection :thumbnails, as: 'thumbnails', class: Google::Apis::PlusV1::Activity::Object::Attachment::Thumbnail, decorator: Google::Apis::PlusV1::Activity::Object::Attachment::Thumbnail::Representation property :url, as: 'url' end class Embed # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' property :url, as: 'url' end end class FullImage # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :type, as: 'type' property :url, as: 'url' property :width, as: 'width' end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :type, as: 'type' property :url, as: 'url' property :width, as: 'width' end end class Thumbnail # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :image, as: 'image', class: Google::Apis::PlusV1::Activity::Object::Attachment::Thumbnail::Image, decorator: Google::Apis::PlusV1::Activity::Object::Attachment::Thumbnail::Image::Representation property :url, as: 'url' end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :type, as: 'type' property :url, as: 'url' property :width, as: 'width' end end end end class Plusoners # @private class Representation < Google::Apis::Core::JsonRepresentation property :self_link, as: 'selfLink' property :total_items, as: 'totalItems' end end class Replies # @private class Representation < Google::Apis::Core::JsonRepresentation property :self_link, as: 'selfLink' property :total_items, as: 'totalItems' end end class Resharers # @private class Representation < Google::Apis::Core::JsonRepresentation property :self_link, as: 'selfLink' property :total_items, as: 'totalItems' end end end class Provider # @private class Representation < Google::Apis::Core::JsonRepresentation property :title, as: 'title' end end end class ActivityFeed # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::PlusV1::Activity, decorator: Google::Apis::PlusV1::Activity::Representation property :kind, as: 'kind' property :next_link, as: 'nextLink' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :title, as: 'title' property :updated, as: 'updated', type: DateTime end end class Comment # @private class Representation < Google::Apis::Core::JsonRepresentation property :actor, as: 'actor', class: Google::Apis::PlusV1::Comment::Actor, decorator: Google::Apis::PlusV1::Comment::Actor::Representation property :etag, as: 'etag' property :id, as: 'id' collection :in_reply_to, as: 'inReplyTo', class: Google::Apis::PlusV1::Comment::InReplyTo, decorator: Google::Apis::PlusV1::Comment::InReplyTo::Representation property :kind, as: 'kind' property :object, as: 'object', class: Google::Apis::PlusV1::Comment::Object, decorator: Google::Apis::PlusV1::Comment::Object::Representation property :plusoners, as: 'plusoners', class: Google::Apis::PlusV1::Comment::Plusoners, decorator: Google::Apis::PlusV1::Comment::Plusoners::Representation property :published, as: 'published', type: DateTime property :self_link, as: 'selfLink' property :updated, as: 'updated', type: DateTime property :verb, as: 'verb' end class Actor # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_specific_actor_info, as: 'clientSpecificActorInfo', class: Google::Apis::PlusV1::Comment::Actor::ClientSpecificActorInfo, decorator: Google::Apis::PlusV1::Comment::Actor::ClientSpecificActorInfo::Representation property :display_name, as: 'displayName' property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusV1::Comment::Actor::Image, decorator: Google::Apis::PlusV1::Comment::Actor::Image::Representation property :url, as: 'url' property :verification, as: 'verification', class: Google::Apis::PlusV1::Comment::Actor::Verification, decorator: Google::Apis::PlusV1::Comment::Actor::Verification::Representation end class ClientSpecificActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :youtube_actor_info, as: 'youtubeActorInfo', class: Google::Apis::PlusV1::Comment::Actor::ClientSpecificActorInfo::YoutubeActorInfo, decorator: Google::Apis::PlusV1::Comment::Actor::ClientSpecificActorInfo::YoutubeActorInfo::Representation end class YoutubeActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' end end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class Verification # @private class Representation < Google::Apis::Core::JsonRepresentation property :ad_hoc_verified, as: 'adHocVerified' end end end class InReplyTo # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :url, as: 'url' end end class Object # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :object_type, as: 'objectType' property :original_content, as: 'originalContent' end end class Plusoners # @private class Representation < Google::Apis::Core::JsonRepresentation property :total_items, as: 'totalItems' end end end class CommentFeed # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::PlusV1::Comment, decorator: Google::Apis::PlusV1::Comment::Representation property :kind, as: 'kind' property :next_link, as: 'nextLink' property :next_page_token, as: 'nextPageToken' property :title, as: 'title' property :updated, as: 'updated', type: DateTime end end class PeopleFeed # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::PlusV1::Person, decorator: Google::Apis::PlusV1::Person::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :title, as: 'title' property :total_items, as: 'totalItems' end end class Person # @private class Representation < Google::Apis::Core::JsonRepresentation property :about_me, as: 'aboutMe' property :age_range, as: 'ageRange', class: Google::Apis::PlusV1::Person::AgeRange, decorator: Google::Apis::PlusV1::Person::AgeRange::Representation property :birthday, as: 'birthday' property :bragging_rights, as: 'braggingRights' property :circled_by_count, as: 'circledByCount' property :cover, as: 'cover', class: Google::Apis::PlusV1::Person::Cover, decorator: Google::Apis::PlusV1::Person::Cover::Representation property :current_location, as: 'currentLocation' property :display_name, as: 'displayName' property :domain, as: 'domain' collection :emails, as: 'emails', class: Google::Apis::PlusV1::Person::Email, decorator: Google::Apis::PlusV1::Person::Email::Representation property :etag, as: 'etag' property :gender, as: 'gender' property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusV1::Person::Image, decorator: Google::Apis::PlusV1::Person::Image::Representation property :is_plus_user, as: 'isPlusUser' property :kind, as: 'kind' property :language, as: 'language' property :name, as: 'name', class: Google::Apis::PlusV1::Person::Name, decorator: Google::Apis::PlusV1::Person::Name::Representation property :nickname, as: 'nickname' property :object_type, as: 'objectType' property :occupation, as: 'occupation' collection :organizations, as: 'organizations', class: Google::Apis::PlusV1::Person::Organization, decorator: Google::Apis::PlusV1::Person::Organization::Representation collection :places_lived, as: 'placesLived', class: Google::Apis::PlusV1::Person::PlacesLived, decorator: Google::Apis::PlusV1::Person::PlacesLived::Representation property :plus_one_count, as: 'plusOneCount' property :relationship_status, as: 'relationshipStatus' property :skills, as: 'skills' property :tagline, as: 'tagline' property :url, as: 'url' collection :urls, as: 'urls', class: Google::Apis::PlusV1::Person::Url, decorator: Google::Apis::PlusV1::Person::Url::Representation property :verified, as: 'verified' end class AgeRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :max, as: 'max' property :min, as: 'min' end end class Cover # @private class Representation < Google::Apis::Core::JsonRepresentation property :cover_info, as: 'coverInfo', class: Google::Apis::PlusV1::Person::Cover::CoverInfo, decorator: Google::Apis::PlusV1::Person::Cover::CoverInfo::Representation property :cover_photo, as: 'coverPhoto', class: Google::Apis::PlusV1::Person::Cover::CoverPhoto, decorator: Google::Apis::PlusV1::Person::Cover::CoverPhoto::Representation property :layout, as: 'layout' end class CoverInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :left_image_offset, as: 'leftImageOffset' property :top_image_offset, as: 'topImageOffset' end end class CoverPhoto # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :url, as: 'url' property :width, as: 'width' end end end class Email # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' property :value, as: 'value' end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :is_default, as: 'isDefault' property :url, as: 'url' end end class Name # @private class Representation < Google::Apis::Core::JsonRepresentation property :family_name, as: 'familyName' property :formatted, as: 'formatted' property :given_name, as: 'givenName' property :honorific_prefix, as: 'honorificPrefix' property :honorific_suffix, as: 'honorificSuffix' property :middle_name, as: 'middleName' end end class Organization # @private class Representation < Google::Apis::Core::JsonRepresentation property :department, as: 'department' property :description, as: 'description' property :end_date, as: 'endDate' property :location, as: 'location' property :name, as: 'name' property :primary, as: 'primary' property :start_date, as: 'startDate' property :title, as: 'title' property :type, as: 'type' end end class PlacesLived # @private class Representation < Google::Apis::Core::JsonRepresentation property :primary, as: 'primary' property :value, as: 'value' end end class Url # @private class Representation < Google::Apis::Core::JsonRepresentation property :label, as: 'label' property :type, as: 'type' property :value, as: 'value' end end end class Place # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address', class: Google::Apis::PlusV1::Place::Address, decorator: Google::Apis::PlusV1::Place::Address::Representation property :display_name, as: 'displayName' property :id, as: 'id' property :kind, as: 'kind' property :position, as: 'position', class: Google::Apis::PlusV1::Place::Position, decorator: Google::Apis::PlusV1::Place::Position::Representation end class Address # @private class Representation < Google::Apis::Core::JsonRepresentation property :formatted, as: 'formatted' end end class Position # @private class Representation < Google::Apis::Core::JsonRepresentation property :latitude, as: 'latitude' property :longitude, as: 'longitude' end end end class PlusAclentryResource # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :id, as: 'id' property :type, as: 'type' end end end end end google-api-client-0.19.8/generated/google/apis/plus_v1/classes.rb0000644000004100000410000023303513252673044024675 0ustar www-datawww-data# 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 PlusV1 # class Acl include Google::Apis::Core::Hashable # Description of the access granted, suitable for display. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The list of access entries. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies this resource as a collection of access controls. Value: "plus#acl". # 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) @description = args[:description] if args.key?(:description) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class Activity include Google::Apis::Core::Hashable # Identifies who has access to see this activity. # Corresponds to the JSON property `access` # @return [Google::Apis::PlusV1::Acl] attr_accessor :access # The person who performed this activity. # Corresponds to the JSON property `actor` # @return [Google::Apis::PlusV1::Activity::Actor] attr_accessor :actor # Street address where this activity occurred. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Additional content added by the person who shared this activity, applicable # only when resharing an activity. # Corresponds to the JSON property `annotation` # @return [String] attr_accessor :annotation # If this activity is a crosspost from another system, this property specifies # the ID of the original activity. # Corresponds to the JSON property `crosspostSource` # @return [String] attr_accessor :crosspost_source # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Latitude and longitude where this activity occurred. Format is latitude # followed by longitude, space separated. # Corresponds to the JSON property `geocode` # @return [String] attr_accessor :geocode # The ID of this activity. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies this resource as an activity. Value: "plus#activity". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The location where this activity occurred. # Corresponds to the JSON property `location` # @return [Google::Apis::PlusV1::Place] attr_accessor :location # The object of this activity. # Corresponds to the JSON property `object` # @return [Google::Apis::PlusV1::Activity::Object] attr_accessor :object # ID of the place where this activity occurred. # Corresponds to the JSON property `placeId` # @return [String] attr_accessor :place_id # Name of the place where this activity occurred. # Corresponds to the JSON property `placeName` # @return [String] attr_accessor :place_name # The service provider that initially published this activity. # Corresponds to the JSON property `provider` # @return [Google::Apis::PlusV1::Activity::Provider] attr_accessor :provider # The time at which this activity was initially published. Formatted as an RFC # 3339 timestamp. # Corresponds to the JSON property `published` # @return [DateTime] attr_accessor :published # Radius, in meters, of the region where this activity occurred, centered at the # latitude and longitude identified in geocode. # Corresponds to the JSON property `radius` # @return [String] attr_accessor :radius # Title of this activity. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The time at which this activity was last updated. Formatted as an RFC 3339 # timestamp. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # The link to this activity. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # This activity's verb, which indicates the action that was performed. Possible # values include, but are not limited to, the following values: # - "post" - Publish content to the stream. # - "share" - Reshare an activity. # 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) @access = args[:access] if args.key?(:access) @actor = args[:actor] if args.key?(:actor) @address = args[:address] if args.key?(:address) @annotation = args[:annotation] if args.key?(:annotation) @crosspost_source = args[:crosspost_source] if args.key?(:crosspost_source) @etag = args[:etag] if args.key?(:etag) @geocode = args[:geocode] if args.key?(:geocode) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @location = args[:location] if args.key?(:location) @object = args[:object] if args.key?(:object) @place_id = args[:place_id] if args.key?(:place_id) @place_name = args[:place_name] if args.key?(:place_name) @provider = args[:provider] if args.key?(:provider) @published = args[:published] if args.key?(:published) @radius = args[:radius] if args.key?(:radius) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) @url = args[:url] if args.key?(:url) @verb = args[:verb] if args.key?(:verb) end # The person who performed this activity. class Actor include Google::Apis::Core::Hashable # Actor info specific to particular clients. # Corresponds to the JSON property `clientSpecificActorInfo` # @return [Google::Apis::PlusV1::Activity::Actor::ClientSpecificActorInfo] attr_accessor :client_specific_actor_info # The name of the actor, suitable for display. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The ID of the actor's Person resource. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The image representation of the actor. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusV1::Activity::Actor::Image] attr_accessor :image # An object representation of the individual components of name. # Corresponds to the JSON property `name` # @return [Google::Apis::PlusV1::Activity::Actor::Name] attr_accessor :name # The link to the actor's Google profile. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Verification status of actor. # Corresponds to the JSON property `verification` # @return [Google::Apis::PlusV1::Activity::Actor::Verification] attr_accessor :verification def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_specific_actor_info = args[:client_specific_actor_info] if args.key?(:client_specific_actor_info) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @name = args[:name] if args.key?(:name) @url = args[:url] if args.key?(:url) @verification = args[:verification] if args.key?(:verification) end # Actor info specific to particular clients. class ClientSpecificActorInfo include Google::Apis::Core::Hashable # Actor info specific to YouTube clients. # Corresponds to the JSON property `youtubeActorInfo` # @return [Google::Apis::PlusV1::Activity::Actor::ClientSpecificActorInfo::YoutubeActorInfo] attr_accessor :youtube_actor_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @youtube_actor_info = args[:youtube_actor_info] if args.key?(:youtube_actor_info) end # Actor info specific to YouTube clients. class YoutubeActorInfo include Google::Apis::Core::Hashable # ID of the YouTube channel owned by the Actor. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel_id = args[:channel_id] if args.key?(:channel_id) end end end # The image representation of the actor. class Image include Google::Apis::Core::Hashable # The URL of the actor's profile photo. To resize the image and crop it to a # square, append the query string ?sz=x, where x is the dimension in pixels of # each side. # 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 # An object representation of the individual components of name. class Name include Google::Apis::Core::Hashable # The family name ("last name") of the actor. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name # The given name ("first name") of the actor. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @family_name = args[:family_name] if args.key?(:family_name) @given_name = args[:given_name] if args.key?(:given_name) end end # Verification status of actor. class Verification include Google::Apis::Core::Hashable # Verification for one-time or manual processes. # Corresponds to the JSON property `adHocVerified` # @return [String] attr_accessor :ad_hoc_verified def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_hoc_verified = args[:ad_hoc_verified] if args.key?(:ad_hoc_verified) end end end # The object of this activity. class Object include Google::Apis::Core::Hashable # If this activity's object is itself another activity, such as when a person # reshares an activity, this property specifies the original activity's actor. # Corresponds to the JSON property `actor` # @return [Google::Apis::PlusV1::Activity::Object::Actor] attr_accessor :actor # The media objects attached to this activity. # Corresponds to the JSON property `attachments` # @return [Array] attr_accessor :attachments # The HTML-formatted content, which is suitable for display. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The ID of the object. When resharing an activity, this is the ID of the # activity that is being reshared. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the object. Possible values include, but are not limited to, the # following values: # - "note" - Textual content. # - "activity" - A Google+ activity. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # The content (text) as provided by the author, which is stored without any HTML # formatting. When creating or updating an activity, this value must be supplied # as plain text in the request. # Corresponds to the JSON property `originalContent` # @return [String] attr_accessor :original_content # People who +1'd this activity. # Corresponds to the JSON property `plusoners` # @return [Google::Apis::PlusV1::Activity::Object::Plusoners] attr_accessor :plusoners # Comments in reply to this activity. # Corresponds to the JSON property `replies` # @return [Google::Apis::PlusV1::Activity::Object::Replies] attr_accessor :replies # People who reshared this activity. # Corresponds to the JSON property `resharers` # @return [Google::Apis::PlusV1::Activity::Object::Resharers] attr_accessor :resharers # The URL that points to the linked resource. # 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) @actor = args[:actor] if args.key?(:actor) @attachments = args[:attachments] if args.key?(:attachments) @content = args[:content] if args.key?(:content) @id = args[:id] if args.key?(:id) @object_type = args[:object_type] if args.key?(:object_type) @original_content = args[:original_content] if args.key?(:original_content) @plusoners = args[:plusoners] if args.key?(:plusoners) @replies = args[:replies] if args.key?(:replies) @resharers = args[:resharers] if args.key?(:resharers) @url = args[:url] if args.key?(:url) end # If this activity's object is itself another activity, such as when a person # reshares an activity, this property specifies the original activity's actor. class Actor include Google::Apis::Core::Hashable # Actor info specific to particular clients. # Corresponds to the JSON property `clientSpecificActorInfo` # @return [Google::Apis::PlusV1::Activity::Object::Actor::ClientSpecificActorInfo] attr_accessor :client_specific_actor_info # The original actor's name, which is suitable for display. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # ID of the original actor. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The image representation of the original actor. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusV1::Activity::Object::Actor::Image] attr_accessor :image # A link to the original actor's Google profile. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Verification status of actor. # Corresponds to the JSON property `verification` # @return [Google::Apis::PlusV1::Activity::Object::Actor::Verification] attr_accessor :verification def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_specific_actor_info = args[:client_specific_actor_info] if args.key?(:client_specific_actor_info) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @url = args[:url] if args.key?(:url) @verification = args[:verification] if args.key?(:verification) end # Actor info specific to particular clients. class ClientSpecificActorInfo include Google::Apis::Core::Hashable # Actor info specific to YouTube clients. # Corresponds to the JSON property `youtubeActorInfo` # @return [Google::Apis::PlusV1::Activity::Object::Actor::ClientSpecificActorInfo::YoutubeActorInfo] attr_accessor :youtube_actor_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @youtube_actor_info = args[:youtube_actor_info] if args.key?(:youtube_actor_info) end # Actor info specific to YouTube clients. class YoutubeActorInfo include Google::Apis::Core::Hashable # ID of the YouTube channel owned by the Actor. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel_id = args[:channel_id] if args.key?(:channel_id) end end end # The image representation of the original actor. class Image include Google::Apis::Core::Hashable # A URL that points to a thumbnail photo of the original actor. # 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 # Verification status of actor. class Verification include Google::Apis::Core::Hashable # Verification for one-time or manual processes. # Corresponds to the JSON property `adHocVerified` # @return [String] attr_accessor :ad_hoc_verified def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_hoc_verified = args[:ad_hoc_verified] if args.key?(:ad_hoc_verified) end end end # class Attachment include Google::Apis::Core::Hashable # If the attachment is an article, this property contains a snippet of text from # the article. It can also include descriptions for other types. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The title of the attachment, such as a photo caption or an article title. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # If the attachment is a video, the embeddable link. # Corresponds to the JSON property `embed` # @return [Google::Apis::PlusV1::Activity::Object::Attachment::Embed] attr_accessor :embed # The full image URL for photo attachments. # Corresponds to the JSON property `fullImage` # @return [Google::Apis::PlusV1::Activity::Object::Attachment::FullImage] attr_accessor :full_image # The ID of the attachment. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The preview image for photos or videos. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusV1::Activity::Object::Attachment::Image] attr_accessor :image # The type of media object. Possible values include, but are not limited to, the # following values: # - "photo" - A photo. # - "album" - A photo album. # - "video" - A video. # - "article" - An article, specified by a link. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # If the attachment is an album, this property is a list of potential additional # thumbnails from the album. # Corresponds to the JSON property `thumbnails` # @return [Array] attr_accessor :thumbnails # The link to the attachment, which should be of type text/html. # 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) @content = args[:content] if args.key?(:content) @display_name = args[:display_name] if args.key?(:display_name) @embed = args[:embed] if args.key?(:embed) @full_image = args[:full_image] if args.key?(:full_image) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @object_type = args[:object_type] if args.key?(:object_type) @thumbnails = args[:thumbnails] if args.key?(:thumbnails) @url = args[:url] if args.key?(:url) end # If the attachment is a video, the embeddable link. class Embed include Google::Apis::Core::Hashable # Media type of the link. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # URL of the link. # 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 # The full image URL for photo attachments. class FullImage include Google::Apis::Core::Hashable # The height, in pixels, of the linked resource. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Media type of the link. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # URL of the image. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width, in pixels, of the linked resource. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end # The preview image for photos or videos. class Image include Google::Apis::Core::Hashable # The height, in pixels, of the linked resource. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Media type of the link. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Image URL. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width, in pixels, of the linked resource. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end # class Thumbnail include Google::Apis::Core::Hashable # Potential name of the thumbnail. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Image resource. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusV1::Activity::Object::Attachment::Thumbnail::Image] attr_accessor :image # URL of the webpage containing 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) @description = args[:description] if args.key?(:description) @image = args[:image] if args.key?(:image) @url = args[:url] if args.key?(:url) end # Image resource. class Image include Google::Apis::Core::Hashable # The height, in pixels, of the linked resource. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Media type of the link. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Image url. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width, in pixels, of the linked resource. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end end end # People who +1'd this activity. class Plusoners include Google::Apis::Core::Hashable # The URL for the collection of people who +1'd this activity. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Total number of people who +1'd this activity. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @self_link = args[:self_link] if args.key?(:self_link) @total_items = args[:total_items] if args.key?(:total_items) end end # Comments in reply to this activity. class Replies include Google::Apis::Core::Hashable # The URL for the collection of comments in reply to this activity. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Total number of comments on this activity. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @self_link = args[:self_link] if args.key?(:self_link) @total_items = args[:total_items] if args.key?(:total_items) end end # People who reshared this activity. class Resharers include Google::Apis::Core::Hashable # The URL for the collection of resharers. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Total number of people who reshared this activity. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @self_link = args[:self_link] if args.key?(:self_link) @total_items = args[:total_items] if args.key?(:total_items) end end end # The service provider that initially published this activity. class Provider include Google::Apis::Core::Hashable # Name of the service provider. # 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) @title = args[:title] if args.key?(:title) end end end # class ActivityFeed include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of this collection of activities. Deprecated. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The activities in this page of results. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies this resource as a collection of activities. Value: "plus# # activityFeed". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to the next page of activities. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Link to this activity resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The title of this collection of activities, which is a truncated portion of # the content. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The time at which this collection of activities was last updated. Formatted as # an RFC 3339 timestamp. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) end end # class Comment include Google::Apis::Core::Hashable # The person who posted this comment. # Corresponds to the JSON property `actor` # @return [Google::Apis::PlusV1::Comment::Actor] attr_accessor :actor # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of this comment. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The activity this comment replied to. # Corresponds to the JSON property `inReplyTo` # @return [Array] attr_accessor :in_reply_to # Identifies this resource as a comment. Value: "plus#comment". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The object of this comment. # Corresponds to the JSON property `object` # @return [Google::Apis::PlusV1::Comment::Object] attr_accessor :object # People who +1'd this comment. # Corresponds to the JSON property `plusoners` # @return [Google::Apis::PlusV1::Comment::Plusoners] attr_accessor :plusoners # The time at which this comment was initially published. Formatted as an RFC # 3339 timestamp. # Corresponds to the JSON property `published` # @return [DateTime] attr_accessor :published # Link to this comment resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The time at which this comment was last updated. Formatted as an RFC 3339 # timestamp. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # This comment's verb, indicating what action was performed. Possible values are: # # - "post" - Publish content to the stream. # 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) @actor = args[:actor] if args.key?(:actor) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @in_reply_to = args[:in_reply_to] if args.key?(:in_reply_to) @kind = args[:kind] if args.key?(:kind) @object = args[:object] if args.key?(:object) @plusoners = args[:plusoners] if args.key?(:plusoners) @published = args[:published] if args.key?(:published) @self_link = args[:self_link] if args.key?(:self_link) @updated = args[:updated] if args.key?(:updated) @verb = args[:verb] if args.key?(:verb) end # The person who posted this comment. class Actor include Google::Apis::Core::Hashable # Actor info specific to particular clients. # Corresponds to the JSON property `clientSpecificActorInfo` # @return [Google::Apis::PlusV1::Comment::Actor::ClientSpecificActorInfo] attr_accessor :client_specific_actor_info # The name of this actor, suitable for display. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The ID of the actor. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The image representation of this actor. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusV1::Comment::Actor::Image] attr_accessor :image # A link to the Person resource for this actor. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Verification status of actor. # Corresponds to the JSON property `verification` # @return [Google::Apis::PlusV1::Comment::Actor::Verification] attr_accessor :verification def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_specific_actor_info = args[:client_specific_actor_info] if args.key?(:client_specific_actor_info) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @url = args[:url] if args.key?(:url) @verification = args[:verification] if args.key?(:verification) end # Actor info specific to particular clients. class ClientSpecificActorInfo include Google::Apis::Core::Hashable # Actor info specific to YouTube clients. # Corresponds to the JSON property `youtubeActorInfo` # @return [Google::Apis::PlusV1::Comment::Actor::ClientSpecificActorInfo::YoutubeActorInfo] attr_accessor :youtube_actor_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @youtube_actor_info = args[:youtube_actor_info] if args.key?(:youtube_actor_info) end # Actor info specific to YouTube clients. class YoutubeActorInfo include Google::Apis::Core::Hashable # ID of the YouTube channel owned by the Actor. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel_id = args[:channel_id] if args.key?(:channel_id) end end end # The image representation of this actor. class Image include Google::Apis::Core::Hashable # The URL of the actor's profile photo. To resize the image and crop it to a # square, append the query string ?sz=x, where x is the dimension in pixels of # each side. # 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 # Verification status of actor. class Verification include Google::Apis::Core::Hashable # Verification for one-time or manual processes. # Corresponds to the JSON property `adHocVerified` # @return [String] attr_accessor :ad_hoc_verified def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_hoc_verified = args[:ad_hoc_verified] if args.key?(:ad_hoc_verified) end end end # class InReplyTo include Google::Apis::Core::Hashable # The ID of the activity. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The URL of the activity. # 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) @url = args[:url] if args.key?(:url) end end # The object of this comment. class Object include Google::Apis::Core::Hashable # The HTML-formatted content, suitable for display. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The object type of this comment. Possible values are: # - "comment" - A comment in reply to an activity. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # The content (text) as provided by the author, stored without any HTML # formatting. When creating or updating a comment, this value must be supplied # as plain text in the request. # Corresponds to the JSON property `originalContent` # @return [String] attr_accessor :original_content def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content = args[:content] if args.key?(:content) @object_type = args[:object_type] if args.key?(:object_type) @original_content = args[:original_content] if args.key?(:original_content) end end # People who +1'd this comment. class Plusoners include Google::Apis::Core::Hashable # Total number of people who +1'd this comment. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @total_items = args[:total_items] if args.key?(:total_items) end end end # class CommentFeed include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of this collection of comments. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The comments in this page of results. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies this resource as a collection of comments. Value: "plus#commentFeed" # . # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to the next page of activities. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The title of this collection of comments. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The time at which this collection of comments was last updated. Formatted as # an RFC 3339 timestamp. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) end end # class PeopleFeed include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The people in this page of results. Each item includes the id, displayName, # image, and url for the person. To retrieve additional profile data, see the # people.get method. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies this resource as a collection of people. Value: "plus#peopleFeed". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Link to this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The title of this collection of people. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The total number of people available in this list. The number of people in a # response might be smaller due to paging. This might not be set for all # collections. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @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) @title = args[:title] if args.key?(:title) @total_items = args[:total_items] if args.key?(:total_items) end end # class Person include Google::Apis::Core::Hashable # A short biography for this person. # Corresponds to the JSON property `aboutMe` # @return [String] attr_accessor :about_me # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 # or older. Age is determined from the user's birthday using Western age # reckoning. # Corresponds to the JSON property `ageRange` # @return [Google::Apis::PlusV1::Person::AgeRange] attr_accessor :age_range # The person's date of birth, represented as YYYY-MM-DD. # Corresponds to the JSON property `birthday` # @return [String] attr_accessor :birthday # The "bragging rights" line of this person. # Corresponds to the JSON property `braggingRights` # @return [String] attr_accessor :bragging_rights # For followers who are visible, the number of people who have added this person # or page to a circle. # Corresponds to the JSON property `circledByCount` # @return [Fixnum] attr_accessor :circled_by_count # The cover photo content. # Corresponds to the JSON property `cover` # @return [Google::Apis::PlusV1::Person::Cover] attr_accessor :cover # (this field is not currently used) # Corresponds to the JSON property `currentLocation` # @return [String] attr_accessor :current_location # The name of this person, which is suitable for display. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The hosted domain name for the user's Google Apps account. For instance, # example.com. The plus.profile.emails.read or email scope is needed to get this # domain name. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # A list of email addresses that this person has, including their Google account # email address, and the public verified email addresses on their Google+ # profile. The plus.profile.emails.read scope is needed to retrieve these email # addresses, or the email scope can be used to retrieve just the Google account # email address. # Corresponds to the JSON property `emails` # @return [Array] attr_accessor :emails # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The person's gender. Possible values include, but are not limited to, the # following values: # - "male" - Male gender. # - "female" - Female gender. # - "other" - Other. # Corresponds to the JSON property `gender` # @return [String] attr_accessor :gender # The ID of this person. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The representation of the person's profile photo. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusV1::Person::Image] attr_accessor :image # Whether this user has signed up for Google+. # Corresponds to the JSON property `isPlusUser` # @return [Boolean] attr_accessor :is_plus_user alias_method :is_plus_user?, :is_plus_user # Identifies this resource as a person. Value: "plus#person". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The user's preferred language for rendering. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # An object representation of the individual components of a person's name. # Corresponds to the JSON property `name` # @return [Google::Apis::PlusV1::Person::Name] attr_accessor :name # The nickname of this person. # Corresponds to the JSON property `nickname` # @return [String] attr_accessor :nickname # Type of person within Google+. Possible values include, but are not limited to, # the following values: # - "person" - represents an actual person. # - "page" - represents a page. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # The occupation of this person. # Corresponds to the JSON property `occupation` # @return [String] attr_accessor :occupation # A list of current or past organizations with which this person is associated. # Corresponds to the JSON property `organizations` # @return [Array] attr_accessor :organizations # A list of places where this person has lived. # Corresponds to the JSON property `placesLived` # @return [Array] attr_accessor :places_lived # If a Google+ Page, the number of people who have +1'd this page. # Corresponds to the JSON property `plusOneCount` # @return [Fixnum] attr_accessor :plus_one_count # The person's relationship status. Possible values include, but are not limited # to, the following values: # - "single" - Person is single. # - "in_a_relationship" - Person is in a relationship. # - "engaged" - Person is engaged. # - "married" - Person is married. # - "its_complicated" - The relationship is complicated. # - "open_relationship" - Person is in an open relationship. # - "widowed" - Person is widowed. # - "in_domestic_partnership" - Person is in a domestic partnership. # - "in_civil_union" - Person is in a civil union. # Corresponds to the JSON property `relationshipStatus` # @return [String] attr_accessor :relationship_status # The person's skills. # Corresponds to the JSON property `skills` # @return [String] attr_accessor :skills # The brief description (tagline) of this person. # Corresponds to the JSON property `tagline` # @return [String] attr_accessor :tagline # The URL of this person's profile. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # A list of URLs for this person. # Corresponds to the JSON property `urls` # @return [Array] attr_accessor :urls # Whether the person or Google+ Page has been verified. # Corresponds to the JSON property `verified` # @return [Boolean] attr_accessor :verified alias_method :verified?, :verified def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @about_me = args[:about_me] if args.key?(:about_me) @age_range = args[:age_range] if args.key?(:age_range) @birthday = args[:birthday] if args.key?(:birthday) @bragging_rights = args[:bragging_rights] if args.key?(:bragging_rights) @circled_by_count = args[:circled_by_count] if args.key?(:circled_by_count) @cover = args[:cover] if args.key?(:cover) @current_location = args[:current_location] if args.key?(:current_location) @display_name = args[:display_name] if args.key?(:display_name) @domain = args[:domain] if args.key?(:domain) @emails = args[:emails] if args.key?(:emails) @etag = args[:etag] if args.key?(:etag) @gender = args[:gender] if args.key?(:gender) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @is_plus_user = args[:is_plus_user] if args.key?(:is_plus_user) @kind = args[:kind] if args.key?(:kind) @language = args[:language] if args.key?(:language) @name = args[:name] if args.key?(:name) @nickname = args[:nickname] if args.key?(:nickname) @object_type = args[:object_type] if args.key?(:object_type) @occupation = args[:occupation] if args.key?(:occupation) @organizations = args[:organizations] if args.key?(:organizations) @places_lived = args[:places_lived] if args.key?(:places_lived) @plus_one_count = args[:plus_one_count] if args.key?(:plus_one_count) @relationship_status = args[:relationship_status] if args.key?(:relationship_status) @skills = args[:skills] if args.key?(:skills) @tagline = args[:tagline] if args.key?(:tagline) @url = args[:url] if args.key?(:url) @urls = args[:urls] if args.key?(:urls) @verified = args[:verified] if args.key?(:verified) end # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 # or older. Age is determined from the user's birthday using Western age # reckoning. class AgeRange include Google::Apis::Core::Hashable # The age range's upper bound, if any. Possible values include, but are not # limited to, the following: # - "17" - for age 17 # - "20" - for age 20 # Corresponds to the JSON property `max` # @return [Fixnum] attr_accessor :max # The age range's lower bound, if any. Possible values include, but are not # limited to, the following: # - "21" - for age 21 # - "18" - for age 18 # Corresponds to the JSON property `min` # @return [Fixnum] attr_accessor :min def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max = args[:max] if args.key?(:max) @min = args[:min] if args.key?(:min) end end # The cover photo content. class Cover include Google::Apis::Core::Hashable # Extra information about the cover photo. # Corresponds to the JSON property `coverInfo` # @return [Google::Apis::PlusV1::Person::Cover::CoverInfo] attr_accessor :cover_info # The person's primary cover image. # Corresponds to the JSON property `coverPhoto` # @return [Google::Apis::PlusV1::Person::Cover::CoverPhoto] attr_accessor :cover_photo # The layout of the cover art. Possible values include, but are not limited to, # the following values: # - "banner" - One large image banner. # Corresponds to the JSON property `layout` # @return [String] attr_accessor :layout def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cover_info = args[:cover_info] if args.key?(:cover_info) @cover_photo = args[:cover_photo] if args.key?(:cover_photo) @layout = args[:layout] if args.key?(:layout) end # Extra information about the cover photo. class CoverInfo include Google::Apis::Core::Hashable # The difference between the left position of the cover image and the actual # displayed cover image. Only valid for banner layout. # Corresponds to the JSON property `leftImageOffset` # @return [Fixnum] attr_accessor :left_image_offset # The difference between the top position of the cover image and the actual # displayed cover image. Only valid for banner layout. # Corresponds to the JSON property `topImageOffset` # @return [Fixnum] attr_accessor :top_image_offset def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @left_image_offset = args[:left_image_offset] if args.key?(:left_image_offset) @top_image_offset = args[:top_image_offset] if args.key?(:top_image_offset) end end # The person's primary cover image. class CoverPhoto include Google::Apis::Core::Hashable # The height of the image. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # The URL of the image. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width of the image. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end end # class Email include Google::Apis::Core::Hashable # The type of address. Possible values include, but are not limited to, the # following values: # - "account" - Google account email address. # - "home" - Home email address. # - "work" - Work email address. # - "other" - Other. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The email address. # 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) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end # The representation of the person's profile photo. class Image include Google::Apis::Core::Hashable # Whether the person's profile photo is the default one # Corresponds to the JSON property `isDefault` # @return [Boolean] attr_accessor :is_default alias_method :is_default?, :is_default # The URL of the person's profile photo. To resize the image and crop it to a # square, append the query string ?sz=x, where x is the dimension in pixels of # each side. # 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) @is_default = args[:is_default] if args.key?(:is_default) @url = args[:url] if args.key?(:url) end end # An object representation of the individual components of a person's name. class Name include Google::Apis::Core::Hashable # The family name (last name) of this person. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name # The full name of this person, including middle names, suffixes, etc. # Corresponds to the JSON property `formatted` # @return [String] attr_accessor :formatted # The given name (first name) of this person. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name # The honorific prefixes (such as "Dr." or "Mrs.") for this person. # Corresponds to the JSON property `honorificPrefix` # @return [String] attr_accessor :honorific_prefix # The honorific suffixes (such as "Jr.") for this person. # Corresponds to the JSON property `honorificSuffix` # @return [String] attr_accessor :honorific_suffix # The middle name of this person. # Corresponds to the JSON property `middleName` # @return [String] attr_accessor :middle_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @family_name = args[:family_name] if args.key?(:family_name) @formatted = args[:formatted] if args.key?(:formatted) @given_name = args[:given_name] if args.key?(:given_name) @honorific_prefix = args[:honorific_prefix] if args.key?(:honorific_prefix) @honorific_suffix = args[:honorific_suffix] if args.key?(:honorific_suffix) @middle_name = args[:middle_name] if args.key?(:middle_name) end end # class Organization include Google::Apis::Core::Hashable # The department within the organization. Deprecated. # Corresponds to the JSON property `department` # @return [String] attr_accessor :department # A short description of the person's role in this organization. Deprecated. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The date that the person left this organization. # Corresponds to the JSON property `endDate` # @return [String] attr_accessor :end_date # The location of this organization. Deprecated. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The name of the organization. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # If "true", indicates this organization is the person's primary one, which is # typically interpreted as the current one. # Corresponds to the JSON property `primary` # @return [Boolean] attr_accessor :primary alias_method :primary?, :primary # The date that the person joined this organization. # Corresponds to the JSON property `startDate` # @return [String] attr_accessor :start_date # The person's job title or role within the organization. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The type of organization. Possible values include, but are not limited to, the # following values: # - "work" - Work. # - "school" - School. # 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) @department = args[:department] if args.key?(:department) @description = args[:description] if args.key?(:description) @end_date = args[:end_date] if args.key?(:end_date) @location = args[:location] if args.key?(:location) @name = args[:name] if args.key?(:name) @primary = args[:primary] if args.key?(:primary) @start_date = args[:start_date] if args.key?(:start_date) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) end end # class PlacesLived include Google::Apis::Core::Hashable # If "true", this place of residence is this person's primary residence. # Corresponds to the JSON property `primary` # @return [Boolean] attr_accessor :primary alias_method :primary?, :primary # A place where this person has lived. For example: "Seattle, WA", "Near Toronto" # . # 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) @primary = args[:primary] if args.key?(:primary) @value = args[:value] if args.key?(:value) end end # class Url include Google::Apis::Core::Hashable # The label of the URL. # Corresponds to the JSON property `label` # @return [String] attr_accessor :label # The type of URL. Possible values include, but are not limited to, the # following values: # - "otherProfile" - URL for another profile. # - "contributor" - URL to a site for which this person is a contributor. # - "website" - URL for this Google+ Page's primary website. # - "other" - Other URL. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The URL 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) @label = args[:label] if args.key?(:label) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end end # class Place include Google::Apis::Core::Hashable # The physical address of the place. # Corresponds to the JSON property `address` # @return [Google::Apis::PlusV1::Place::Address] attr_accessor :address # The display name of the place. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The id of the place. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies this resource as a place. Value: "plus#place". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The position of the place. # Corresponds to the JSON property `position` # @return [Google::Apis::PlusV1::Place::Position] attr_accessor :position def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @address = args[:address] if args.key?(:address) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @position = args[:position] if args.key?(:position) end # The physical address of the place. class Address include Google::Apis::Core::Hashable # The formatted address for display. # Corresponds to the JSON property `formatted` # @return [String] attr_accessor :formatted def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @formatted = args[:formatted] if args.key?(:formatted) end end # The position of the place. class Position include Google::Apis::Core::Hashable # The latitude of this position. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude # The longitude of this position. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @latitude = args[:latitude] if args.key?(:latitude) @longitude = args[:longitude] if args.key?(:longitude) end end end # class PlusAclentryResource include Google::Apis::Core::Hashable # A descriptive name for this entry. Suitable for display. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The ID of the entry. For entries of type "person" or "circle", this is the ID # of the resource. For other types, this property is not set. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of entry describing to whom access is granted. Possible values are: # - "person" - Access to an individual. # - "circle" - Access to members of a circle. # - "myCircles" - Access to members of all the person's circles. # - "extendedCircles" - Access to members of all the person's circles, plus all # of the people in their circles. # - "domain" - Access to members of the person's Google Apps domain. # - "public" - Access to anyone on the web. # 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) @id = args[:id] if args.key?(:id) @type = args[:type] if args.key?(:type) end end end end end google-api-client-0.19.8/generated/google/apis/plus_v1/service.rb0000644000004100000410000006445313252673044024706 0ustar www-datawww-data# 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 PlusV1 # Google+ API # # Builds on top of the Google+ platform. # # @example # require 'google/apis/plus_v1' # # Plus = Google::Apis::PlusV1 # Alias the module # service = Plus::PlusService.new # # @see https://developers.google.com/+/api/ class PlusService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'plus/v1/') @batch_path = 'batch/plus/v1' end # Get an activity. # @param [String] activity_id # The ID of the activity to get. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusV1::Activity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusV1::Activity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity(activity_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities/{activityId}', options) command.response_representation = Google::Apis::PlusV1::Activity::Representation command.response_class = Google::Apis::PlusV1::Activity command.params['activityId'] = activity_id unless activity_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 # List all of the activities in the specified collection for a particular user. # @param [String] user_id # The ID of the user to get activities for. The special value "me" can be used # to indicate the authenticated user. # @param [String] collection # The collection of activities to list. # @param [Fixnum] max_results # The maximum number of activities to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusV1::ActivityFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusV1::ActivityFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activities(user_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}/activities/{collection}', options) command.response_representation = Google::Apis::PlusV1::ActivityFeed::Representation command.response_class = Google::Apis::PlusV1::ActivityFeed command.params['userId'] = user_id unless user_id.nil? command.params['collection'] = collection unless collection.nil? command.query['maxResults'] = max_results unless max_results.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 # Search public activities. # @param [String] query # Full-text search query string. # @param [String] language # Specify the preferred language to search with. See search language codes for # available values. # @param [Fixnum] max_results # The maximum number of activities to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] order_by # Specifies how to order search results. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. This token can be of any length. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusV1::ActivityFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusV1::ActivityFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_activities(query, language: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities', options) command.response_representation = Google::Apis::PlusV1::ActivityFeed::Representation command.response_class = Google::Apis::PlusV1::ActivityFeed command.query['language'] = language unless language.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['query'] = query unless query.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 # Get a comment. # @param [String] comment_id # The ID of the comment to get. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusV1::Comment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusV1::Comment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_comment(comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'comments/{commentId}', options) command.response_representation = Google::Apis::PlusV1::Comment::Representation command.response_class = Google::Apis::PlusV1::Comment command.params['commentId'] = comment_id unless comment_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 # List all of the comments for an activity. # @param [String] activity_id # The ID of the activity to get comments for. # @param [Fixnum] max_results # The maximum number of comments to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. # @param [String] sort_order # The order in which to sort the list of comments. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusV1::CommentFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusV1::CommentFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_comments(activity_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities/{activityId}/comments', options) command.response_representation = Google::Apis::PlusV1::CommentFeed::Representation command.response_class = Google::Apis::PlusV1::CommentFeed command.params['activityId'] = activity_id unless activity_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortOrder'] = sort_order unless sort_order.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 # Get a person's profile. If your app uses scope https://www.googleapis.com/auth/ # plus.login, this method is guaranteed to return ageRange and language. # @param [String] user_id # The ID of the person to get the profile for. The special value "me" can be # used to indicate the authenticated user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusV1::Person] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusV1::Person] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_person(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}', options) command.response_representation = Google::Apis::PlusV1::Person::Representation command.response_class = Google::Apis::PlusV1::Person command.params['userId'] = user_id unless user_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 # List all of the people in the specified collection. # @param [String] user_id # Get the collection of people for the person identified. Use "me" to indicate # the authenticated user. # @param [String] collection # The collection of people to list. # @param [Fixnum] max_results # The maximum number of people to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] order_by # The order to return people in. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusV1::PeopleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusV1::PeopleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_people(user_id, collection, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}/people/{collection}', options) command.response_representation = Google::Apis::PlusV1::PeopleFeed::Representation command.response_class = Google::Apis::PlusV1::PeopleFeed command.params['userId'] = user_id unless user_id.nil? command.params['collection'] = collection unless collection.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['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 of the people in the specified collection for a particular activity. # @param [String] activity_id # The ID of the activity to get the list of people for. # @param [String] collection # The collection of people to list. # @param [Fixnum] max_results # The maximum number of people to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusV1::PeopleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusV1::PeopleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_people_by_activity(activity_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities/{activityId}/people/{collection}', options) command.response_representation = Google::Apis::PlusV1::PeopleFeed::Representation command.response_class = Google::Apis::PlusV1::PeopleFeed command.params['activityId'] = activity_id unless activity_id.nil? command.params['collection'] = collection unless collection.nil? command.query['maxResults'] = max_results unless max_results.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 # Search all public profiles. # @param [String] query # Specify a query string for full text search of public text in all profiles. # @param [String] language # Specify the preferred language to search with. See search language codes for # available values. # @param [Fixnum] max_results # The maximum number of people to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. This token can be of any length. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusV1::PeopleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusV1::PeopleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_people(query, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people', options) command.response_representation = Google::Apis::PlusV1::PeopleFeed::Representation command.response_class = Google::Apis::PlusV1::PeopleFeed command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['query'] = query unless query.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 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 end end google-api-client-0.19.8/generated/google/apis/clouduseraccounts_vm_beta/0000755000004100000410000000000013252673043026555 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/clouduseraccounts_vm_beta/representations.rb0000644000004100000410000003120313252673043032326 0ustar www-datawww-data# 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 ClouduseraccountsVmBeta class AuthorizedKeysView class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Group class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GroupList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GroupsAddMemberRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GroupsRemoveMemberRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinuxAccountViews class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinuxGetAuthorizedKeysViewResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinuxGetLinuxAccountViewsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinuxGroupView class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinuxUserView class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Operation class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport 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 OperationList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PublicKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class User class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthorizedKeysView # @private class Representation < Google::Apis::Core::JsonRepresentation collection :keys, as: 'keys' property :sudoer, as: 'sudoer' end end class Group # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' collection :members, as: 'members' property :name, as: 'name' property :self_link, as: 'selfLink' end end class GroupList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ClouduseraccountsVmBeta::Group, decorator: Google::Apis::ClouduseraccountsVmBeta::Group::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end class GroupsAddMemberRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :users, as: 'users' end end class GroupsRemoveMemberRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :users, as: 'users' end end class LinuxAccountViews # @private class Representation < Google::Apis::Core::JsonRepresentation collection :group_views, as: 'groupViews', class: Google::Apis::ClouduseraccountsVmBeta::LinuxGroupView, decorator: Google::Apis::ClouduseraccountsVmBeta::LinuxGroupView::Representation property :kind, as: 'kind' collection :user_views, as: 'userViews', class: Google::Apis::ClouduseraccountsVmBeta::LinuxUserView, decorator: Google::Apis::ClouduseraccountsVmBeta::LinuxUserView::Representation end end class LinuxGetAuthorizedKeysViewResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource, as: 'resource', class: Google::Apis::ClouduseraccountsVmBeta::AuthorizedKeysView, decorator: Google::Apis::ClouduseraccountsVmBeta::AuthorizedKeysView::Representation end end class LinuxGetLinuxAccountViewsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource, as: 'resource', class: Google::Apis::ClouduseraccountsVmBeta::LinuxAccountViews, decorator: Google::Apis::ClouduseraccountsVmBeta::LinuxAccountViews::Representation end end class LinuxGroupView # @private class Representation < Google::Apis::Core::JsonRepresentation property :gid, as: 'gid' property :group_name, as: 'groupName' collection :members, as: 'members' end end class LinuxUserView # @private class Representation < Google::Apis::Core::JsonRepresentation property :gecos, as: 'gecos' property :gid, as: 'gid' property :home_directory, as: 'homeDirectory' property :shell, as: 'shell' property :uid, as: 'uid' property :username, as: 'username' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_operation_id, as: 'clientOperationId' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :end_time, as: 'endTime' property :error, as: 'error', class: Google::Apis::ClouduseraccountsVmBeta::Operation::Error, decorator: Google::Apis::ClouduseraccountsVmBeta::Operation::Error::Representation property :http_error_message, as: 'httpErrorMessage' property :http_error_status_code, as: 'httpErrorStatusCode' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' property :kind, as: 'kind' property :name, as: 'name' property :operation_type, as: 'operationType' property :progress, as: 'progress' property :region, as: 'region' property :self_link, as: 'selfLink' property :start_time, as: 'startTime' property :status, as: 'status' property :status_message, as: 'statusMessage' property :target_id, :numeric_string => true, as: 'targetId' property :target_link, as: 'targetLink' property :user, as: 'user' collection :warnings, as: 'warnings', class: Google::Apis::ClouduseraccountsVmBeta::Operation::Warning, decorator: Google::Apis::ClouduseraccountsVmBeta::Operation::Warning::Representation property :zone, as: 'zone' end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::ClouduseraccountsVmBeta::Operation::Error::Error, decorator: Google::Apis::ClouduseraccountsVmBeta::Operation::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ClouduseraccountsVmBeta::Operation::Warning::Datum, decorator: Google::Apis::ClouduseraccountsVmBeta::Operation::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 OperationList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ClouduseraccountsVmBeta::Operation, decorator: Google::Apis::ClouduseraccountsVmBeta::Operation::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end class PublicKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :expiration_timestamp, as: 'expirationTimestamp' property :fingerprint, as: 'fingerprint' property :key, as: 'key' end end class User # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' collection :groups, as: 'groups' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :owner, as: 'owner' collection :public_keys, as: 'publicKeys', class: Google::Apis::ClouduseraccountsVmBeta::PublicKey, decorator: Google::Apis::ClouduseraccountsVmBeta::PublicKey::Representation property :self_link, as: 'selfLink' end end class UserList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ClouduseraccountsVmBeta::User, decorator: Google::Apis::ClouduseraccountsVmBeta::User::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end end end end google-api-client-0.19.8/generated/google/apis/clouduseraccounts_vm_beta/classes.rb0000644000004100000410000007713513252673043030554 0ustar www-datawww-data# 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 ClouduseraccountsVmBeta # A list of authorized public keys for a user account. class AuthorizedKeysView include Google::Apis::Core::Hashable # [Output Only] The list of authorized public keys in SSH format. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys # [Output Only] Whether the user has the ability to elevate on the instance that # requested the authorized keys. # Corresponds to the JSON property `sudoer` # @return [Boolean] attr_accessor :sudoer alias_method :sudoer?, :sudoer def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @keys = args[:keys] if args.key?(:keys) @sudoer = args[:sudoer] if args.key?(:sudoer) end end # A Group resource. class Group include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always clouduseraccounts#group for groups. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] A list of URLs to User resources who belong to the group. Users # may only be members of groups in the same project. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members # Name of the resource; provided by the client when the resource is created. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [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) @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) @members = args[:members] if args.key?(:members) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) end end # class GroupList 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 # [Output Only] A list of Group resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists # of groups. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] A token used to continue a truncated list request. # 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 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) end end # class GroupsAddMemberRequest include Google::Apis::Core::Hashable # Fully-qualified URLs of the User resources to add. # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @users = args[:users] if args.key?(:users) end end # class GroupsRemoveMemberRequest include Google::Apis::Core::Hashable # Fully-qualified URLs of the User resources to remove. # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @users = args[:users] if args.key?(:users) end end # A list of all Linux accounts for this project. This API is only used by # Compute Engine virtual machines to get information about user accounts for a # project or instance. Linux resources are read-only views into users and groups # managed by the Compute Engine Accounts API. class LinuxAccountViews include Google::Apis::Core::Hashable # [Output Only] A list of all groups within a project. # Corresponds to the JSON property `groupViews` # @return [Array] attr_accessor :group_views # [Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews # for Linux resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] A list of all users within a project. # Corresponds to the JSON property `userViews` # @return [Array] attr_accessor :user_views def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @group_views = args[:group_views] if args.key?(:group_views) @kind = args[:kind] if args.key?(:kind) @user_views = args[:user_views] if args.key?(:user_views) end end # class LinuxGetAuthorizedKeysViewResponse include Google::Apis::Core::Hashable # A list of authorized public keys for a user account. # Corresponds to the JSON property `resource` # @return [Google::Apis::ClouduseraccountsVmBeta::AuthorizedKeysView] attr_accessor :resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource = args[:resource] if args.key?(:resource) end end # class LinuxGetLinuxAccountViewsResponse include Google::Apis::Core::Hashable # A list of all Linux accounts for this project. This API is only used by # Compute Engine virtual machines to get information about user accounts for a # project or instance. Linux resources are read-only views into users and groups # managed by the Compute Engine Accounts API. # Corresponds to the JSON property `resource` # @return [Google::Apis::ClouduseraccountsVmBeta::LinuxAccountViews] attr_accessor :resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource = args[:resource] if args.key?(:resource) end end # A detailed view of a Linux group. class LinuxGroupView include Google::Apis::Core::Hashable # [Output Only] The Group ID. # Corresponds to the JSON property `gid` # @return [Fixnum] attr_accessor :gid # [Output Only] Group name. # Corresponds to the JSON property `groupName` # @return [String] attr_accessor :group_name # [Output Only] List of user accounts that belong to the group. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @gid = args[:gid] if args.key?(:gid) @group_name = args[:group_name] if args.key?(:group_name) @members = args[:members] if args.key?(:members) end end # A detailed view of a Linux user account. class LinuxUserView include Google::Apis::Core::Hashable # [Output Only] The GECOS (user information) entry for this account. # Corresponds to the JSON property `gecos` # @return [String] attr_accessor :gecos # [Output Only] User's default group ID. # Corresponds to the JSON property `gid` # @return [Fixnum] attr_accessor :gid # [Output Only] The path to the home directory for this account. # Corresponds to the JSON property `homeDirectory` # @return [String] attr_accessor :home_directory # [Output Only] The path to the login shell for this account. # Corresponds to the JSON property `shell` # @return [String] attr_accessor :shell # [Output Only] User ID. # Corresponds to the JSON property `uid` # @return [Fixnum] attr_accessor :uid # [Output Only] The username of the account. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @gecos = args[:gecos] if args.key?(:gecos) @gid = args[:gid] if args.key?(:gid) @home_directory = args[:home_directory] if args.key?(:home_directory) @shell = args[:shell] if args.key?(:shell) @uid = args[:uid] if args.key?(:uid) @username = args[:username] if args.key?(:username) end end # An Operation resource, used to manage asynchronous API requests. class Operation include Google::Apis::Core::Hashable # [Output Only] Reserved for future use. # Corresponds to the JSON property `clientOperationId` # @return [String] attr_accessor :client_operation_id # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] A textual description of the operation, which is set when the # operation is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The time that this operation was completed. This value is in # RFC3339 text format. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # [Output Only] If errors are generated during processing of the operation, this # field will be populated. # Corresponds to the JSON property `error` # @return [Google::Apis::ClouduseraccountsVmBeta::Operation::Error] attr_accessor :error # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as NOT FOUND. # Corresponds to the JSON property `httpErrorMessage` # @return [String] attr_accessor :http_error_message # [Output Only] If the operation fails, this field contains the HTTP error # status code that was returned. For example, a 404 means the resource was not # found. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] attr_accessor :http_error_status_code # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The time that this operation was requested. This value is in # RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # [Output Only] Type of the resource. Always compute#operation for Operation # resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] The type of operation, such as insert, update, or delete, and so # on. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # [Output Only] An optional progress indicator that ranges from 0 to 100. There # is no requirement that this be linear or support any granularity of operations. # This should not be used to guess when the operation will be complete. This # number should monotonically increase as the operation progresses. # Corresponds to the JSON property `progress` # @return [Fixnum] attr_accessor :progress # [Output Only] The URL of the region where the operation resides. Only # available when performing regional operations. # 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 # [Output Only] The time that this operation was started by the server. This # value is in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # [Output Only] The status of the operation, which can be one of the following: # PENDING, RUNNING, or DONE. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional textual description of the current status of the # operation. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # [Output Only] The unique target ID, which identifies a specific incarnation of # the target resource. # Corresponds to the JSON property `targetId` # @return [Fixnum] attr_accessor :target_id # [Output Only] The URL of the resource that the operation modifies. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link # [Output Only] User who requested the operation, for example: user@example.com. # Corresponds to the JSON property `user` # @return [String] attr_accessor :user # [Output Only] If warning messages are generated during processing of the # operation, this field will be populated. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings # [Output Only] The URL of the zone where the operation resides. Only available # when performing per-zone operations. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @end_time = args[:end_time] if args.key?(:end_time) @error = args[:error] if args.key?(:error) @http_error_message = args[:http_error_message] if args.key?(:http_error_message) @http_error_status_code = args[:http_error_status_code] if args.key?(:http_error_status_code) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @operation_type = args[:operation_type] if args.key?(:operation_type) @progress = args[:progress] if args.key?(:progress) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @target_id = args[:target_id] if args.key?(:target_id) @target_link = args[:target_link] if args.key?(:target_link) @user = args[:user] if args.key?(:user) @warnings = args[:warnings] if args.key?(:warnings) @zone = args[:zone] if args.key?(:zone) end # [Output Only] If errors are generated during processing of the operation, this # field will be populated. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end # 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 # Contains a list of Operation resources. class OperationList include Google::Apis::Core::Hashable # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # [Output Only] A list of Operation resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#operations for Operations # resource. # 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 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) end end # A public key for authenticating to guests. class PublicKey include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 # text format. If not provided, the public key never expires. # Corresponds to the JSON property `expirationTimestamp` # @return [String] attr_accessor :expiration_timestamp # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 # digest of the public key. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # Public key text in SSH format, defined by RFC4253 section 6.6. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @expiration_timestamp = args[:expiration_timestamp] if args.key?(:expiration_timestamp) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @key = args[:key] if args.key?(:key) end end # A User resource. class User include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] A list of URLs to Group resources who contain the user. Users # are only members of groups in the same project. # Corresponds to the JSON property `groups` # @return [Array] attr_accessor :groups # [Output Only] Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always clouduseraccounts#user for users. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of the resource; provided by the client when the resource is created. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Email address of account's owner. This account will be validated to make sure # it exists. The email can belong to any domain, but it must be tied to a Google # account. # Corresponds to the JSON property `owner` # @return [String] attr_accessor :owner # [Output Only] Public keys that this user may use to login. # Corresponds to the JSON property `publicKeys` # @return [Array] attr_accessor :public_keys # [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) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @groups = args[:groups] if args.key?(:groups) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @owner = args[:owner] if args.key?(:owner) @public_keys = args[:public_keys] if args.key?(:public_keys) @self_link = args[:self_link] if args.key?(:self_link) end end # class UserList 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 # [Output Only] A list of User resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always clouduseraccounts#userList for lists of # users. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] A token used to continue a truncated list request. # 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 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) end end end end end google-api-client-0.19.8/generated/google/apis/clouduseraccounts_vm_beta/service.rb0000644000004100000410000015613513252673043030555 0ustar www-datawww-data# 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 ClouduseraccountsVmBeta # Cloud User Accounts API # # Creates and manages users and groups for accessing Google Compute Engine # virtual machines. # # @example # require 'google/apis/clouduseraccounts_vm_beta' # # Clouduseraccounts = Google::Apis::ClouduseraccountsVmBeta # Alias the module # service = Clouduseraccounts::CloudUserAccountsService.new # # @see https://cloud.google.com/compute/docs/access/user-accounts/api/latest/ class CloudUserAccountsService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'clouduseraccounts/vm_beta/projects/') @batch_path = 'batch/clouduseraccounts/vm_beta' end # Deletes the specified operation resource. # @param [String] project # Project ID for this request. # @param [String] operation # Name of the Operations resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_global_accounts_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/operations/{operation}', options) command.params['project'] = project unless project.nil? command.params['operation'] = operation unless operation.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 the specified operation resource. # @param [String] project # Project ID for this request. # @param [String] operation # Name of the Operations resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::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_global_accounts_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations/{operation}', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::Operation command.params['project'] = project unless project.nil? command.params['operation'] = operation unless operation.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 the list of operation resources contained within the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` # expression`. Your `expression` must be in the format: field_name # comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use filter=name ne example-instance. # Compute Engine Beta API Only: If you use filtering in the Beta API, you can # also filter on nested fields. For example, you could filter on instances that # have set the scheduling.automaticRestart field to true. In particular, use # filtering on nested fields to take advantage of instance labels to organize # and filter results based on label values. # The Beta API also supports filtering on multiple expressions by providing each # separate expression within parentheses. For example, (scheduling. # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are # treated as AND expressions, meaning that resources must match all expressions # to pass the filters. # @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. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::OperationList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::OperationList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_global_accounts_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::OperationList::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::OperationList command.params['project'] = project unless project.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['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 # Adds users to the specified group. # @param [String] project # Project ID for this request. # @param [String] group_name # Name of the group for this request. # @param [Google::Apis::ClouduseraccountsVmBeta::GroupsAddMemberRequest] groups_add_member_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::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 add_group_member(project, group_name, groups_add_member_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/groups/{groupName}/addMember', options) command.request_representation = Google::Apis::ClouduseraccountsVmBeta::GroupsAddMemberRequest::Representation command.request_object = groups_add_member_request_object command.response_representation = Google::Apis::ClouduseraccountsVmBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::Operation command.params['project'] = project unless project.nil? command.params['groupName'] = group_name unless group_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 # Deletes the specified Group resource. # @param [String] project # Project ID for this request. # @param [String] group_name # Name of the Group resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::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_group(project, group_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/groups/{groupName}', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::Operation command.params['project'] = project unless project.nil? command.params['groupName'] = group_name unless group_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 # Returns the specified Group resource. # @param [String] project # Project ID for this request. # @param [String] group_name # Name of the Group resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::Group] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::Group] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(project, group_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/groups/{groupName}', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::Group::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::Group command.params['project'] = project unless project.nil? command.params['groupName'] = group_name unless group_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 # Creates a Group resource in the specified project using the data included in # the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ClouduseraccountsVmBeta::Group] group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::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_group(project, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/groups', options) command.request_representation = Google::Apis::ClouduseraccountsVmBeta::Group::Representation command.request_object = group_object command.response_representation = Google::Apis::ClouduseraccountsVmBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::Operation command.params['project'] = project unless project.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 the list of groups contained within the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` # expression`. Your `expression` must be in the format: field_name # comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use filter=name ne example-instance. # Compute Engine Beta API Only: If you use filtering in the Beta API, you can # also filter on nested fields. For example, you could filter on instances that # have set the scheduling.automaticRestart field to true. In particular, use # filtering on nested fields to take advantage of instance labels to organize # and filter results based on label values. # The Beta API also supports filtering on multiple expressions by providing each # separate expression within parentheses. For example, (scheduling. # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are # treated as AND expressions, meaning that resources must match all expressions # to pass the filters. # @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. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::GroupList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::GroupList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_groups(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/groups', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::GroupList::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::GroupList command.params['project'] = project unless project.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['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 # Removes users from the specified group. # @param [String] project # Project ID for this request. # @param [String] group_name # Name of the group for this request. # @param [Google::Apis::ClouduseraccountsVmBeta::GroupsRemoveMemberRequest] groups_remove_member_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::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 remove_group_member(project, group_name, groups_remove_member_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/groups/{groupName}/removeMember', options) command.request_representation = Google::Apis::ClouduseraccountsVmBeta::GroupsRemoveMemberRequest::Representation command.request_object = groups_remove_member_request_object command.response_representation = Google::Apis::ClouduseraccountsVmBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::Operation command.params['project'] = project unless project.nil? command.params['groupName'] = group_name unless group_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 # Returns a list of authorized public keys for a specific user account. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [String] user # The user account for which you want to get a list of authorized public keys. # @param [String] instance # The fully-qualified URL of the virtual machine requesting the view. # @param [Boolean] login # Whether the view was requested as part of a user-initiated login. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::LinuxGetAuthorizedKeysViewResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::LinuxGetAuthorizedKeysViewResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_linux_authorized_keys_view(project, zone, user, instance, login: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/authorizedKeysView/{user}', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::LinuxGetAuthorizedKeysViewResponse::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::LinuxGetAuthorizedKeysViewResponse command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['user'] = user unless user.nil? command.query['instance'] = instance unless instance.nil? command.query['login'] = login unless login.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 user accounts for an instance within a specific project. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [String] instance # The fully-qualified URL of the virtual machine requesting the views. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` # expression`. Your `expression` must be in the format: field_name # comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use filter=name ne example-instance. # Compute Engine Beta API Only: If you use filtering in the Beta API, you can # also filter on nested fields. For example, you could filter on instances that # have set the scheduling.automaticRestart field to true. In particular, use # filtering on nested fields to take advantage of instance labels to organize # and filter results based on label values. # The Beta API also supports filtering on multiple expressions by providing each # separate expression within parentheses. For example, (scheduling. # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are # treated as AND expressions, meaning that resources must match all expressions # to pass the filters. # @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. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::LinuxGetLinuxAccountViewsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::LinuxGetLinuxAccountViewsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_linux_linux_account_views(project, zone, instance, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/linuxAccountViews', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::LinuxGetLinuxAccountViewsResponse::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::LinuxGetLinuxAccountViewsResponse command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.query['filter'] = filter unless filter.nil? command.query['instance'] = instance unless instance.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['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 # Adds a public key to the specified User resource with the data included in the # request. # @param [String] project # Project ID for this request. # @param [String] user # Name of the user for this request. # @param [Google::Apis::ClouduseraccountsVmBeta::PublicKey] public_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::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 add_user_public_key(project, user, public_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/users/{user}/addPublicKey', options) command.request_representation = Google::Apis::ClouduseraccountsVmBeta::PublicKey::Representation command.request_object = public_key_object command.response_representation = Google::Apis::ClouduseraccountsVmBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::Operation command.params['project'] = project unless project.nil? command.params['user'] = user unless user.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 User resource. # @param [String] project # Project ID for this request. # @param [String] user # Name of the user resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::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_user(project, user, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/users/{user}', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::Operation command.params['project'] = project unless project.nil? command.params['user'] = user unless user.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 User resource. # @param [String] project # Project ID for this request. # @param [String] user # Name of the user resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::User] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::User] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user(project, user, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/users/{user}', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::User::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::User command.params['project'] = project unless project.nil? command.params['user'] = user unless user.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 User resource in the specified project using the data included in # the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ClouduseraccountsVmBeta::User] user_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::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_user(project, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/users', options) command.request_representation = Google::Apis::ClouduseraccountsVmBeta::User::Representation command.request_object = user_object command.response_representation = Google::Apis::ClouduseraccountsVmBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::Operation command.params['project'] = project unless project.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 users contained within the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` # expression`. Your `expression` must be in the format: field_name # comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use filter=name ne example-instance. # Compute Engine Beta API Only: If you use filtering in the Beta API, you can # also filter on nested fields. For example, you could filter on instances that # have set the scheduling.automaticRestart field to true. In particular, use # filtering on nested fields to take advantage of instance labels to organize # and filter results based on label values. # The Beta API also supports filtering on multiple expressions by providing each # separate expression within parentheses. For example, (scheduling. # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are # treated as AND expressions, meaning that resources must match all expressions # to pass the filters. # @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. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::UserList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::UserList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_users(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/users', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::UserList::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::UserList command.params['project'] = project unless project.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['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 # Removes the specified public key from the user. # @param [String] project # Project ID for this request. # @param [String] user # Name of the user for this request. # @param [String] fingerprint # The fingerprint of the public key to delete. Public keys are identified by # their fingerprint, which is defined by RFC4716 to be the MD5 digest of the # public 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsVmBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsVmBeta::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 remove_user_public_key(project, user, fingerprint, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/users/{user}/removePublicKey', options) command.response_representation = Google::Apis::ClouduseraccountsVmBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsVmBeta::Operation command.params['project'] = project unless project.nil? command.params['user'] = user unless user.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 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 end end google-api-client-0.19.8/generated/google/apis/cloudbuild_v1/0000755000004100000410000000000013252673043024047 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/cloudbuild_v1/representations.rb0000644000004100000410000003671113252673043027631 0ustar www-datawww-data# 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 CloudbuildV1 class Build class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BuildOperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BuildOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BuildStep class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BuildTrigger class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BuiltImage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CancelBuildRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CancelOperationRequest 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 FileHashes class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HashProp class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListBuildTriggersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListBuildsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse 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 RepoSource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Results class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RetryBuildRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Secret class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Source class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SourceProvenance 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 StorageSource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TimeSpan class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Volume class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Build # @private class Representation < Google::Apis::Core::JsonRepresentation property :build_trigger_id, as: 'buildTriggerId' property :create_time, as: 'createTime' property :finish_time, as: 'finishTime' property :id, as: 'id' collection :images, as: 'images' property :log_url, as: 'logUrl' property :logs_bucket, as: 'logsBucket' property :options, as: 'options', class: Google::Apis::CloudbuildV1::BuildOptions, decorator: Google::Apis::CloudbuildV1::BuildOptions::Representation property :project_id, as: 'projectId' property :results, as: 'results', class: Google::Apis::CloudbuildV1::Results, decorator: Google::Apis::CloudbuildV1::Results::Representation collection :secrets, as: 'secrets', class: Google::Apis::CloudbuildV1::Secret, decorator: Google::Apis::CloudbuildV1::Secret::Representation property :source, as: 'source', class: Google::Apis::CloudbuildV1::Source, decorator: Google::Apis::CloudbuildV1::Source::Representation property :source_provenance, as: 'sourceProvenance', class: Google::Apis::CloudbuildV1::SourceProvenance, decorator: Google::Apis::CloudbuildV1::SourceProvenance::Representation property :start_time, as: 'startTime' property :status, as: 'status' property :status_detail, as: 'statusDetail' collection :steps, as: 'steps', class: Google::Apis::CloudbuildV1::BuildStep, decorator: Google::Apis::CloudbuildV1::BuildStep::Representation hash :substitutions, as: 'substitutions' collection :tags, as: 'tags' property :timeout, as: 'timeout' hash :timing, as: 'timing', class: Google::Apis::CloudbuildV1::TimeSpan, decorator: Google::Apis::CloudbuildV1::TimeSpan::Representation end end class BuildOperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :build, as: 'build', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation end end class BuildOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :disk_size_gb, :numeric_string => true, as: 'diskSizeGb' property :log_streaming_option, as: 'logStreamingOption' property :machine_type, as: 'machineType' property :requested_verify_option, as: 'requestedVerifyOption' collection :source_provenance_hash, as: 'sourceProvenanceHash' property :substitution_option, as: 'substitutionOption' end end class BuildStep # @private class Representation < Google::Apis::Core::JsonRepresentation collection :args, as: 'args' property :dir, as: 'dir' property :entrypoint, as: 'entrypoint' collection :env, as: 'env' property :id, as: 'id' property :name, as: 'name' collection :secret_env, as: 'secretEnv' property :timing, as: 'timing', class: Google::Apis::CloudbuildV1::TimeSpan, decorator: Google::Apis::CloudbuildV1::TimeSpan::Representation collection :volumes, as: 'volumes', class: Google::Apis::CloudbuildV1::Volume, decorator: Google::Apis::CloudbuildV1::Volume::Representation collection :wait_for, as: 'waitFor' end end class BuildTrigger # @private class Representation < Google::Apis::Core::JsonRepresentation property :build, as: 'build', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation property :create_time, as: 'createTime' property :description, as: 'description' property :disabled, as: 'disabled' property :filename, as: 'filename' property :id, as: 'id' hash :substitutions, as: 'substitutions' property :trigger_template, as: 'triggerTemplate', class: Google::Apis::CloudbuildV1::RepoSource, decorator: Google::Apis::CloudbuildV1::RepoSource::Representation end end class BuiltImage # @private class Representation < Google::Apis::Core::JsonRepresentation property :digest, as: 'digest' property :name, as: 'name' property :push_timing, as: 'pushTiming', class: Google::Apis::CloudbuildV1::TimeSpan, decorator: Google::Apis::CloudbuildV1::TimeSpan::Representation end end class CancelBuildRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class CancelOperationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class FileHashes # @private class Representation < Google::Apis::Core::JsonRepresentation collection :file_hash, as: 'fileHash', class: Google::Apis::CloudbuildV1::HashProp, decorator: Google::Apis::CloudbuildV1::HashProp::Representation end end class HashProp # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' property :value, :base64 => true, as: 'value' end end class ListBuildTriggersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :triggers, as: 'triggers', class: Google::Apis::CloudbuildV1::BuildTrigger, decorator: Google::Apis::CloudbuildV1::BuildTrigger::Representation end end class ListBuildsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :builds, as: 'builds', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation property :next_page_token, as: 'nextPageToken' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::CloudbuildV1::Operation, decorator: Google::Apis::CloudbuildV1::Operation::Representation end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::CloudbuildV1::Status, decorator: Google::Apis::CloudbuildV1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class RepoSource # @private class Representation < Google::Apis::Core::JsonRepresentation property :branch_name, as: 'branchName' property :commit_sha, as: 'commitSha' property :dir, as: 'dir' property :project_id, as: 'projectId' property :repo_name, as: 'repoName' property :tag_name, as: 'tagName' end end class Results # @private class Representation < Google::Apis::Core::JsonRepresentation collection :build_step_images, as: 'buildStepImages' collection :images, as: 'images', class: Google::Apis::CloudbuildV1::BuiltImage, decorator: Google::Apis::CloudbuildV1::BuiltImage::Representation end end class RetryBuildRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Secret # @private class Representation < Google::Apis::Core::JsonRepresentation property :kms_key_name, as: 'kmsKeyName' hash :secret_env, as: 'secretEnv' end end class Source # @private class Representation < Google::Apis::Core::JsonRepresentation property :repo_source, as: 'repoSource', class: Google::Apis::CloudbuildV1::RepoSource, decorator: Google::Apis::CloudbuildV1::RepoSource::Representation property :storage_source, as: 'storageSource', class: Google::Apis::CloudbuildV1::StorageSource, decorator: Google::Apis::CloudbuildV1::StorageSource::Representation end end class SourceProvenance # @private class Representation < Google::Apis::Core::JsonRepresentation hash :file_hashes, as: 'fileHashes', class: Google::Apis::CloudbuildV1::FileHashes, decorator: Google::Apis::CloudbuildV1::FileHashes::Representation property :resolved_repo_source, as: 'resolvedRepoSource', class: Google::Apis::CloudbuildV1::RepoSource, decorator: Google::Apis::CloudbuildV1::RepoSource::Representation property :resolved_storage_source, as: 'resolvedStorageSource', class: Google::Apis::CloudbuildV1::StorageSource, decorator: Google::Apis::CloudbuildV1::StorageSource::Representation 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 StorageSource # @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 TimeSpan # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime' property :start_time, as: 'startTime' end end class Volume # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :path, as: 'path' end end end end end google-api-client-0.19.8/generated/google/apis/cloudbuild_v1/classes.rb0000644000004100000410000013535713252673043026047 0ustar www-datawww-data# 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 CloudbuildV1 # A build resource in the Container Builder API. # At a high level, a Build describes where to find source code, how to build # it (for example, the builder image to run on the source), and what tag to # apply to the built image when it is pushed to Google Container Registry. # Fields can include the following variables which will be expanded when the # build is created: # - $PROJECT_ID: the project ID of the build. # - $BUILD_ID: the autogenerated ID of the build. # - $REPO_NAME: the source repository name specified by RepoSource. # - $BRANCH_NAME: the branch name specified by RepoSource. # - $TAG_NAME: the tag name specified by RepoSource. # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or # resolved from the specified branch or tag. # - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. class Build include Google::Apis::Core::Hashable # The ID of the BuildTrigger that triggered this build, if it was # triggered automatically. # @OutputOnly # Corresponds to the JSON property `buildTriggerId` # @return [String] attr_accessor :build_trigger_id # Time at which the request to create the build was received. # @OutputOnly # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Time at which execution of the build was finished. # The difference between finish_time and start_time is the duration of the # build's execution. # @OutputOnly # Corresponds to the JSON property `finishTime` # @return [String] attr_accessor :finish_time # Unique identifier of the build. # @OutputOnly # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A list of images to be pushed upon the successful completion of all build # steps. # The images will be pushed using the builder service account's credentials. # The digests of the pushed images will be stored in the Build resource's # results field. # If any of the images fail to be pushed, the build is marked FAILURE. # Corresponds to the JSON property `images` # @return [Array] attr_accessor :images # URL to logs for this build in Google Cloud Console. # @OutputOnly # Corresponds to the JSON property `logUrl` # @return [String] attr_accessor :log_url # Google Cloud Storage bucket where logs should be written (see # [Bucket Name # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements) # ). # Logs file names will be of the format `$`logs_bucket`/log-$`build_id`.txt`. # Corresponds to the JSON property `logsBucket` # @return [String] attr_accessor :logs_bucket # Optional arguments to enable specific features of builds. # Corresponds to the JSON property `options` # @return [Google::Apis::CloudbuildV1::BuildOptions] attr_accessor :options # ID of the project. # @OutputOnly. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # Results describes the artifacts created by the build pipeline. # Corresponds to the JSON property `results` # @return [Google::Apis::CloudbuildV1::Results] attr_accessor :results # Secrets to decrypt using Cloud KMS. # Corresponds to the JSON property `secrets` # @return [Array] attr_accessor :secrets # Source describes the location of the source in a supported storage # service. # Corresponds to the JSON property `source` # @return [Google::Apis::CloudbuildV1::Source] attr_accessor :source # Provenance of the source. Ways to find the original source, or verify that # some source was used for this build. # Corresponds to the JSON property `sourceProvenance` # @return [Google::Apis::CloudbuildV1::SourceProvenance] attr_accessor :source_provenance # Time at which execution of the build was started. # @OutputOnly # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Status of the build. # @OutputOnly # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Customer-readable message about the current status. # @OutputOnly # Corresponds to the JSON property `statusDetail` # @return [String] attr_accessor :status_detail # Describes the operations to be performed on the workspace. # Corresponds to the JSON property `steps` # @return [Array] attr_accessor :steps # Substitutions data for Build resource. # Corresponds to the JSON property `substitutions` # @return [Hash] attr_accessor :substitutions # Tags for annotation of a Build. These are not docker tags. # Corresponds to the JSON property `tags` # @return [Array] attr_accessor :tags # Amount of time that this build should be allowed to run, to second # granularity. If this amount of time elapses, work on the build will cease # and the build status will be TIMEOUT. # Default time is ten minutes. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout # Stores timing information for phases of the build. Valid keys are: # * BUILD: time to execute all build steps # * PUSH: time to push all specified images. # * FETCHSOURCE: time to fetch source. # If the build does not specify source, or does not specify images, # these keys will not be included. # @OutputOnly # Corresponds to the JSON property `timing` # @return [Hash] attr_accessor :timing def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @build_trigger_id = args[:build_trigger_id] if args.key?(:build_trigger_id) @create_time = args[:create_time] if args.key?(:create_time) @finish_time = args[:finish_time] if args.key?(:finish_time) @id = args[:id] if args.key?(:id) @images = args[:images] if args.key?(:images) @log_url = args[:log_url] if args.key?(:log_url) @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket) @options = args[:options] if args.key?(:options) @project_id = args[:project_id] if args.key?(:project_id) @results = args[:results] if args.key?(:results) @secrets = args[:secrets] if args.key?(:secrets) @source = args[:source] if args.key?(:source) @source_provenance = args[:source_provenance] if args.key?(:source_provenance) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @status_detail = args[:status_detail] if args.key?(:status_detail) @steps = args[:steps] if args.key?(:steps) @substitutions = args[:substitutions] if args.key?(:substitutions) @tags = args[:tags] if args.key?(:tags) @timeout = args[:timeout] if args.key?(:timeout) @timing = args[:timing] if args.key?(:timing) end end # Metadata for build operations. class BuildOperationMetadata include Google::Apis::Core::Hashable # A build resource in the Container Builder API. # At a high level, a Build describes where to find source code, how to build # it (for example, the builder image to run on the source), and what tag to # apply to the built image when it is pushed to Google Container Registry. # Fields can include the following variables which will be expanded when the # build is created: # - $PROJECT_ID: the project ID of the build. # - $BUILD_ID: the autogenerated ID of the build. # - $REPO_NAME: the source repository name specified by RepoSource. # - $BRANCH_NAME: the branch name specified by RepoSource. # - $TAG_NAME: the tag name specified by RepoSource. # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or # resolved from the specified branch or tag. # - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. # Corresponds to the JSON property `build` # @return [Google::Apis::CloudbuildV1::Build] attr_accessor :build def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @build = args[:build] if args.key?(:build) end end # Optional arguments to enable specific features of builds. class BuildOptions include Google::Apis::Core::Hashable # Requested disk size for the VM that runs the build. Note that this is *NOT* # "disk free"; some of the space will be used by the operating system and # build utilities. Also note that this is the minimum disk size that will be # allocated for the build -- the build may run with a larger disk than # requested. At present, the maximum disk size is 1000GB; builds that request # more than the maximum are rejected with an error. # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] attr_accessor :disk_size_gb # LogStreamingOption to define build log streaming behavior to Google Cloud # Storage. # Corresponds to the JSON property `logStreamingOption` # @return [String] attr_accessor :log_streaming_option # Compute Engine machine type on which to run the build. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type # Requested verifiability options. # Corresponds to the JSON property `requestedVerifyOption` # @return [String] attr_accessor :requested_verify_option # Requested hash for SourceProvenance. # Corresponds to the JSON property `sourceProvenanceHash` # @return [Array] attr_accessor :source_provenance_hash # SubstitutionOption to allow unmatch substitutions. # Corresponds to the JSON property `substitutionOption` # @return [String] attr_accessor :substitution_option def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) @log_streaming_option = args[:log_streaming_option] if args.key?(:log_streaming_option) @machine_type = args[:machine_type] if args.key?(:machine_type) @requested_verify_option = args[:requested_verify_option] if args.key?(:requested_verify_option) @source_provenance_hash = args[:source_provenance_hash] if args.key?(:source_provenance_hash) @substitution_option = args[:substitution_option] if args.key?(:substitution_option) end end # BuildStep describes a step to perform in the build pipeline. class BuildStep include Google::Apis::Core::Hashable # A list of arguments that will be presented to the step when it is started. # If the image used to run the step's container has an entrypoint, these args # will be used as arguments to that entrypoint. If the image does not define # an entrypoint, the first element in args will be used as the entrypoint, # and the remainder will be used as arguments. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args # Working directory to use when running this step's container. # If this value is a relative path, it is relative to the build's working # directory. If this value is absolute, it may be outside the build's working # directory, in which case the contents of the path may not be persisted # across build step executions, unless a volume for that path is specified. # If the build specifies a RepoSource with dir and a step with a dir which # specifies an absolute path, the RepoSource dir is ignored for the step's # execution. # Corresponds to the JSON property `dir` # @return [String] attr_accessor :dir # Optional entrypoint to be used instead of the build step image's default # If unset, the image's default will be used. # Corresponds to the JSON property `entrypoint` # @return [String] attr_accessor :entrypoint # A list of environment variable definitions to be used when running a step. # The elements are of the form "KEY=VALUE" for the environment variable "KEY" # being given the value "VALUE". # Corresponds to the JSON property `env` # @return [Array] attr_accessor :env # Optional unique identifier for this build step, used in wait_for to # reference this build step as a dependency. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The name of the container image that will run this particular build step. # If the image is already available in the host's Docker daemon's cache, it # will be run directly. If not, the host will attempt to pull the image # first, using the builder service account's credentials if necessary. # The Docker daemon's cache will already have the latest versions of all of # the officially supported build steps # ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/ # GoogleCloudPlatform/cloud-builders)). # The Docker daemon will also have cached many of the layers for some popular # images, like "ubuntu", "debian", but they will be refreshed at the time you # attempt to use them. # If you built an image in a previous build step, it will be stored in the # host's Docker daemon's cache and is available to use as the name for a # later build step. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A list of environment variables which are encrypted using a Cloud KMS # crypto key. These values must be specified in the build's secrets. # Corresponds to the JSON property `secretEnv` # @return [Array] attr_accessor :secret_env # Stores start and end times for a build execution phase. # Corresponds to the JSON property `timing` # @return [Google::Apis::CloudbuildV1::TimeSpan] attr_accessor :timing # List of volumes to mount into the build step. # Each volume will be created as an empty volume prior to execution of the # build step. Upon completion of the build, volumes and their contents will # be discarded. # Using a named volume in only one step is not valid as it is indicative # of a mis-configured build request. # Corresponds to the JSON property `volumes` # @return [Array] attr_accessor :volumes # The ID(s) of the step(s) that this build step depends on. # This build step will not start until all the build steps in wait_for # have completed successfully. If wait_for is empty, this build step will # start when all previous build steps in the Build.Steps list have completed # successfully. # Corresponds to the JSON property `waitFor` # @return [Array] attr_accessor :wait_for def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @args = args[:args] if args.key?(:args) @dir = args[:dir] if args.key?(:dir) @entrypoint = args[:entrypoint] if args.key?(:entrypoint) @env = args[:env] if args.key?(:env) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @secret_env = args[:secret_env] if args.key?(:secret_env) @timing = args[:timing] if args.key?(:timing) @volumes = args[:volumes] if args.key?(:volumes) @wait_for = args[:wait_for] if args.key?(:wait_for) end end # Configuration for an automated build in response to source repository # changes. class BuildTrigger include Google::Apis::Core::Hashable # A build resource in the Container Builder API. # At a high level, a Build describes where to find source code, how to build # it (for example, the builder image to run on the source), and what tag to # apply to the built image when it is pushed to Google Container Registry. # Fields can include the following variables which will be expanded when the # build is created: # - $PROJECT_ID: the project ID of the build. # - $BUILD_ID: the autogenerated ID of the build. # - $REPO_NAME: the source repository name specified by RepoSource. # - $BRANCH_NAME: the branch name specified by RepoSource. # - $TAG_NAME: the tag name specified by RepoSource. # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or # resolved from the specified branch or tag. # - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. # Corresponds to the JSON property `build` # @return [Google::Apis::CloudbuildV1::Build] attr_accessor :build # Time when the trigger was created. # @OutputOnly # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Human-readable description of this trigger. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # If true, the trigger will never result in a build. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled alias_method :disabled?, :disabled # Path, from the source root, to a file whose contents is used for the # template. # Corresponds to the JSON property `filename` # @return [String] attr_accessor :filename # Unique identifier of the trigger. # @OutputOnly # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Substitutions data for Build resource. # Corresponds to the JSON property `substitutions` # @return [Hash] attr_accessor :substitutions # RepoSource describes the location of the source in a Google Cloud Source # Repository. # Corresponds to the JSON property `triggerTemplate` # @return [Google::Apis::CloudbuildV1::RepoSource] attr_accessor :trigger_template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @build = args[:build] if args.key?(:build) @create_time = args[:create_time] if args.key?(:create_time) @description = args[:description] if args.key?(:description) @disabled = args[:disabled] if args.key?(:disabled) @filename = args[:filename] if args.key?(:filename) @id = args[:id] if args.key?(:id) @substitutions = args[:substitutions] if args.key?(:substitutions) @trigger_template = args[:trigger_template] if args.key?(:trigger_template) end end # BuiltImage describes an image built by the pipeline. class BuiltImage include Google::Apis::Core::Hashable # Docker Registry 2.0 digest. # Corresponds to the JSON property `digest` # @return [String] attr_accessor :digest # Name used to push the container image to Google Container Registry, as # presented to `docker push`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Stores start and end times for a build execution phase. # Corresponds to the JSON property `pushTiming` # @return [Google::Apis::CloudbuildV1::TimeSpan] attr_accessor :push_timing def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @digest = args[:digest] if args.key?(:digest) @name = args[:name] if args.key?(:name) @push_timing = args[:push_timing] if args.key?(:push_timing) end end # Request to cancel an ongoing build. class CancelBuildRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The request message for Operations.CancelOperation. class CancelOperationRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) 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 # Container message for hashes of byte content of files, used in # SourceProvenance messages to verify integrity of source input to the build. class FileHashes include Google::Apis::Core::Hashable # Collection of file hashes. # Corresponds to the JSON property `fileHash` # @return [Array] attr_accessor :file_hash def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file_hash = args[:file_hash] if args.key?(:file_hash) end end # Container message for hash values. class HashProp include Google::Apis::Core::Hashable # The type of hash that was performed. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The hash value. # Corresponds to the JSON property `value` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] 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 # Response containing existing BuildTriggers. class ListBuildTriggersResponse include Google::Apis::Core::Hashable # BuildTriggers for the project, sorted by create_time descending. # Corresponds to the JSON property `triggers` # @return [Array] attr_accessor :triggers def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @triggers = args[:triggers] if args.key?(:triggers) end end # Response including listed builds. class ListBuildsResponse include Google::Apis::Core::Hashable # Builds will be sorted by create_time, descending. # Corresponds to the JSON property `builds` # @return [Array] attr_accessor :builds # Token to receive 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) @builds = args[:builds] if args.key?(:builds) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Operations.ListOperations. class ListOperationsResponse 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 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::CloudbuildV1::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 have the format of `operations/some/unique/name`. # 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 # RepoSource describes the location of the source in a Google Cloud Source # Repository. class RepoSource include Google::Apis::Core::Hashable # Name of the branch to build. # Corresponds to the JSON property `branchName` # @return [String] attr_accessor :branch_name # Explicit commit SHA to build. # Corresponds to the JSON property `commitSha` # @return [String] attr_accessor :commit_sha # Directory, relative to the source root, in which to run the build. # This must be a relative path. If a step's dir is specified and is an # absolute path, this value is ignored for that step's execution. # Corresponds to the JSON property `dir` # @return [String] attr_accessor :dir # ID of the project that owns the repo. If omitted, the project ID requesting # the build is assumed. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # Name of the repo. If omitted, the name "default" is assumed. # Corresponds to the JSON property `repoName` # @return [String] attr_accessor :repo_name # Name of the tag to build. # Corresponds to the JSON property `tagName` # @return [String] attr_accessor :tag_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @branch_name = args[:branch_name] if args.key?(:branch_name) @commit_sha = args[:commit_sha] if args.key?(:commit_sha) @dir = args[:dir] if args.key?(:dir) @project_id = args[:project_id] if args.key?(:project_id) @repo_name = args[:repo_name] if args.key?(:repo_name) @tag_name = args[:tag_name] if args.key?(:tag_name) end end # Results describes the artifacts created by the build pipeline. class Results include Google::Apis::Core::Hashable # List of build step digests, in order corresponding to build step indices. # Corresponds to the JSON property `buildStepImages` # @return [Array] attr_accessor :build_step_images # Images that were built as a part of the build. # 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) @build_step_images = args[:build_step_images] if args.key?(:build_step_images) @images = args[:images] if args.key?(:images) end end # RetryBuildRequest specifies a build to retry. class RetryBuildRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Secret pairs a set of secret environment variables containing encrypted # values with the Cloud KMS key to use to decrypt the value. class Secret include Google::Apis::Core::Hashable # Cloud KMS key name to use to decrypt these envs. # Corresponds to the JSON property `kmsKeyName` # @return [String] attr_accessor :kms_key_name # Map of environment variable name to its encrypted value. # Secret environment variables must be unique across all of a build's # secrets, and must be used by at least one build step. Values can be at most # 1 KB in size. There can be at most ten secret values across all of a # build's secrets. # Corresponds to the JSON property `secretEnv` # @return [Hash] attr_accessor :secret_env def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name) @secret_env = args[:secret_env] if args.key?(:secret_env) end end # Source describes the location of the source in a supported storage # service. class Source include Google::Apis::Core::Hashable # RepoSource describes the location of the source in a Google Cloud Source # Repository. # Corresponds to the JSON property `repoSource` # @return [Google::Apis::CloudbuildV1::RepoSource] attr_accessor :repo_source # StorageSource describes the location of the source in an archive file in # Google Cloud Storage. # Corresponds to the JSON property `storageSource` # @return [Google::Apis::CloudbuildV1::StorageSource] attr_accessor :storage_source def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @repo_source = args[:repo_source] if args.key?(:repo_source) @storage_source = args[:storage_source] if args.key?(:storage_source) end end # Provenance of the source. Ways to find the original source, or verify that # some source was used for this build. class SourceProvenance include Google::Apis::Core::Hashable # Hash(es) of the build source, which can be used to verify that the original # source integrity was maintained in the build. Note that FileHashes will # only be populated if BuildOptions has requested a SourceProvenanceHash. # The keys to this map are file paths used as build source and the values # contain the hash values for those files. # If the build source came in a single package such as a gzipped tarfile # (.tar.gz), the FileHash will be for the single path to that file. # @OutputOnly # Corresponds to the JSON property `fileHashes` # @return [Hash] attr_accessor :file_hashes # RepoSource describes the location of the source in a Google Cloud Source # Repository. # Corresponds to the JSON property `resolvedRepoSource` # @return [Google::Apis::CloudbuildV1::RepoSource] attr_accessor :resolved_repo_source # StorageSource describes the location of the source in an archive file in # Google Cloud Storage. # Corresponds to the JSON property `resolvedStorageSource` # @return [Google::Apis::CloudbuildV1::StorageSource] attr_accessor :resolved_storage_source def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file_hashes = args[:file_hashes] if args.key?(:file_hashes) @resolved_repo_source = args[:resolved_repo_source] if args.key?(:resolved_repo_source) @resolved_storage_source = args[:resolved_storage_source] if args.key?(:resolved_storage_source) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 # StorageSource describes the location of the source in an archive file in # Google Cloud Storage. class StorageSource include Google::Apis::Core::Hashable # Google Cloud Storage bucket containing source (see # [Bucket Name # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements) # ). # Corresponds to the JSON property `bucket` # @return [String] attr_accessor :bucket # Google Cloud Storage generation for the object. If the generation is # omitted, the latest generation will be used. # Corresponds to the JSON property `generation` # @return [Fixnum] attr_accessor :generation # Google Cloud Storage object containing source. # This object must be a gzipped archive file (.tar.gz) containing source to # build. # 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 # Stores start and end times for a build execution phase. class TimeSpan include Google::Apis::Core::Hashable # End of time span. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Start of time span. # 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 # Volume describes a Docker container volume which is mounted into build steps # in order to persist files across build step execution. class Volume include Google::Apis::Core::Hashable # Name of the volume to mount. # Volume names must be unique per build step and must be valid names for # Docker volumes. Each named volume must be used by at least two build steps. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Path at which to mount the volume. # Paths must be absolute and cannot conflict with other volume paths on the # same build step or with certain reserved volume paths. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @path = args[:path] if args.key?(:path) end end end end end google-api-client-0.19.8/generated/google/apis/cloudbuild_v1/service.rb0000644000004100000410000010363713252673043026046 0ustar www-datawww-data# 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 CloudbuildV1 # Google Cloud Container Builder API # # Builds container images in the cloud. # # @example # require 'google/apis/cloudbuild_v1' # # Cloudbuild = Google::Apis::CloudbuildV1 # Alias the module # service = Cloudbuild::CloudBuildService.new # # @see https://cloud.google.com/container-builder/docs/ class CloudBuildService < 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://cloudbuild.googleapis.com/', '') @batch_path = 'batch' end # Starts asynchronous cancellation on a long-running operation. The server # makes a best effort to cancel the operation, but success is not # guaranteed. If the server doesn't support this method, it returns # `google.rpc.Code.UNIMPLEMENTED`. Clients can use # Operations.GetOperation or # other methods to check whether the cancellation succeeded or whether the # operation completed despite cancellation. On successful cancellation, # the operation is not deleted; instead, it becomes an operation with # an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. # @param [Google::Apis::CloudbuildV1::CancelOperationRequest] cancel_operation_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::CloudbuildV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::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 cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.request_representation = Google::Apis::CloudbuildV1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::CloudbuildV1::Empty::Representation command.response_class = Google::Apis::CloudbuildV1::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 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::CloudbuildV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::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_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation command.response_class = Google::Apis::CloudbuildV1::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 # 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::CloudbuildV1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_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}', options) command.response_representation = Google::Apis::CloudbuildV1::ListOperationsResponse::Representation command.response_class = Google::Apis::CloudbuildV1::ListOperationsResponse 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 # Cancels a requested build in progress. # @param [String] project_id # ID of the project. # @param [String] id # ID of the build. # @param [Google::Apis::CloudbuildV1::CancelBuildRequest] cancel_build_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::CloudbuildV1::Build] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::Build] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_build(project_id, id, cancel_build_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{projectId}/builds/{id}:cancel', options) command.request_representation = Google::Apis::CloudbuildV1::CancelBuildRequest::Representation command.request_object = cancel_build_request_object command.response_representation = Google::Apis::CloudbuildV1::Build::Representation command.response_class = Google::Apis::CloudbuildV1::Build command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless 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 # Starts a build with the specified configuration. # The long-running Operation returned by this method will include the ID of # the build, which can be passed to GetBuild to determine its status (e.g., # success or failure). # @param [String] project_id # ID of the project. # @param [Google::Apis::CloudbuildV1::Build] build_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::CloudbuildV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::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_build(project_id, build_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{projectId}/builds', options) command.request_representation = Google::Apis::CloudbuildV1::Build::Representation command.request_object = build_object command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation command.response_class = Google::Apis::CloudbuildV1::Operation 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 # Returns information about a previously requested build. # The Build that is returned includes its status (e.g., success or failure, # or in-progress), and timing information. # @param [String] project_id # ID of the project. # @param [String] id # ID of the build. # @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::CloudbuildV1::Build] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::Build] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_build(project_id, id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{projectId}/builds/{id}', options) command.response_representation = Google::Apis::CloudbuildV1::Build::Representation command.response_class = Google::Apis::CloudbuildV1::Build command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless 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 previously requested builds. # Previously requested builds may still be in-progress, or may have finished # successfully or unsuccessfully. # @param [String] project_id # ID of the project. # @param [String] filter # The raw filter text to constrain the results. # @param [Fixnum] page_size # Number of results to return in the list. # @param [String] page_token # Token to provide to skip to a particular spot 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::CloudbuildV1::ListBuildsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::ListBuildsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_builds(project_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{projectId}/builds', options) command.response_representation = Google::Apis::CloudbuildV1::ListBuildsResponse::Representation command.response_class = Google::Apis::CloudbuildV1::ListBuildsResponse command.params['projectId'] = project_id unless project_id.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 new build based on the given build. # This API creates a new build using the original build request, which may # or may not result in an identical build. # For triggered builds: # * Triggered builds resolve to a precise revision, so a retry of a triggered # build will result in a build that uses the same revision. # For non-triggered builds that specify RepoSource: # * If the original build built from the tip of a branch, the retried build # will build from the tip of that branch, which may not be the same revision # as the original build. # * If the original build specified a commit sha or revision ID, the retried # build will use the identical source. # For builds that specify StorageSource: # * If the original build pulled source from Cloud Storage without specifying # the generation of the object, the new build will use the current object, # which may be different from the original build source. # * If the original build pulled source from Cloud Storage and specified the # generation of the object, the new build will attempt to use the same # object, which may or may not be available depending on the bucket's # lifecycle management settings. # @param [String] project_id # ID of the project. # @param [String] id # Build ID of the original build. # @param [Google::Apis::CloudbuildV1::RetryBuildRequest] retry_build_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::CloudbuildV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::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 retry_build(project_id, id, retry_build_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{projectId}/builds/{id}:retry', options) command.request_representation = Google::Apis::CloudbuildV1::RetryBuildRequest::Representation command.request_object = retry_build_request_object command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation command.response_class = Google::Apis::CloudbuildV1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless 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 BuildTrigger. # This API is experimental. # @param [String] project_id # ID of the project for which to configure automatic builds. # @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_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::CloudbuildV1::BuildTrigger] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::BuildTrigger] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_trigger(project_id, build_trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{projectId}/triggers', options) command.request_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation command.request_object = build_trigger_object command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation command.response_class = Google::Apis::CloudbuildV1::BuildTrigger 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 # Deletes an BuildTrigger by its project ID and trigger ID. # This API is experimental. # @param [String] project_id # ID of the project that owns the trigger. # @param [String] trigger_id # ID of the BuildTrigger 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::CloudbuildV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::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_trigger(project_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/projects/{projectId}/triggers/{triggerId}', options) command.response_representation = Google::Apis::CloudbuildV1::Empty::Representation command.response_class = Google::Apis::CloudbuildV1::Empty command.params['projectId'] = project_id unless project_id.nil? command.params['triggerId'] = trigger_id unless trigger_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 information about a BuildTrigger. # This API is experimental. # @param [String] project_id # ID of the project that owns the trigger. # @param [String] trigger_id # ID of the BuildTrigger to get. # @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::CloudbuildV1::BuildTrigger] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::BuildTrigger] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_trigger(project_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{projectId}/triggers/{triggerId}', options) command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation command.response_class = Google::Apis::CloudbuildV1::BuildTrigger command.params['projectId'] = project_id unless project_id.nil? command.params['triggerId'] = trigger_id unless trigger_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 existing BuildTrigger. # This API is experimental. # @param [String] project_id # ID of the project for which to list BuildTriggers. # @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::CloudbuildV1::ListBuildTriggersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::ListBuildTriggersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_triggers(project_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{projectId}/triggers', options) command.response_representation = Google::Apis::CloudbuildV1::ListBuildTriggersResponse::Representation command.response_class = Google::Apis::CloudbuildV1::ListBuildTriggersResponse 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 # Updates an BuildTrigger by its project ID and trigger ID. # This API is experimental. # @param [String] project_id # ID of the project that owns the trigger. # @param [String] trigger_id # ID of the BuildTrigger to update. # @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_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::CloudbuildV1::BuildTrigger] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::BuildTrigger] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_trigger(project_id, trigger_id, build_trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/projects/{projectId}/triggers/{triggerId}', options) command.request_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation command.request_object = build_trigger_object command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation command.response_class = Google::Apis::CloudbuildV1::BuildTrigger command.params['projectId'] = project_id unless project_id.nil? command.params['triggerId'] = trigger_id unless trigger_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 # Runs a BuildTrigger at a particular source revision. # @param [String] project_id # ID of the project. # @param [String] trigger_id # ID of the trigger. # @param [Google::Apis::CloudbuildV1::RepoSource] repo_source_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::CloudbuildV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudbuildV1::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 run_project_trigger(project_id, trigger_id, repo_source_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{projectId}/triggers/{triggerId}:run', options) command.request_representation = Google::Apis::CloudbuildV1::RepoSource::Representation command.request_object = repo_source_object command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation command.response_class = Google::Apis::CloudbuildV1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['triggerId'] = trigger_id unless trigger_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 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 google-api-client-0.19.8/generated/google/apis/clouderrorreporting_v1beta1/0000755000004100000410000000000013252673043026750 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/clouderrorreporting_v1beta1/representations.rb0000644000004100000410000002426513252673043032533 0ustar www-datawww-data# 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 ClouderrorreportingV1beta1 class DeleteEventsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ErrorContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ErrorEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ErrorGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ErrorGroupStats class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpRequestContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListEventsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListGroupStatsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportErrorEventResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportedErrorEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SourceLocation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SourceReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TimedCount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TrackingIssue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteEventsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ErrorContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :http_request, as: 'httpRequest', class: Google::Apis::ClouderrorreportingV1beta1::HttpRequestContext, decorator: Google::Apis::ClouderrorreportingV1beta1::HttpRequestContext::Representation property :report_location, as: 'reportLocation', class: Google::Apis::ClouderrorreportingV1beta1::SourceLocation, decorator: Google::Apis::ClouderrorreportingV1beta1::SourceLocation::Representation collection :source_references, as: 'sourceReferences', class: Google::Apis::ClouderrorreportingV1beta1::SourceReference, decorator: Google::Apis::ClouderrorreportingV1beta1::SourceReference::Representation property :user, as: 'user' end end class ErrorEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :context, as: 'context', class: Google::Apis::ClouderrorreportingV1beta1::ErrorContext, decorator: Google::Apis::ClouderrorreportingV1beta1::ErrorContext::Representation property :event_time, as: 'eventTime' property :message, as: 'message' property :service_context, as: 'serviceContext', class: Google::Apis::ClouderrorreportingV1beta1::ServiceContext, decorator: Google::Apis::ClouderrorreportingV1beta1::ServiceContext::Representation end end class ErrorGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :group_id, as: 'groupId' property :name, as: 'name' collection :tracking_issues, as: 'trackingIssues', class: Google::Apis::ClouderrorreportingV1beta1::TrackingIssue, decorator: Google::Apis::ClouderrorreportingV1beta1::TrackingIssue::Representation end end class ErrorGroupStats # @private class Representation < Google::Apis::Core::JsonRepresentation collection :affected_services, as: 'affectedServices', class: Google::Apis::ClouderrorreportingV1beta1::ServiceContext, decorator: Google::Apis::ClouderrorreportingV1beta1::ServiceContext::Representation property :affected_users_count, :numeric_string => true, as: 'affectedUsersCount' property :count, :numeric_string => true, as: 'count' property :first_seen_time, as: 'firstSeenTime' property :group, as: 'group', class: Google::Apis::ClouderrorreportingV1beta1::ErrorGroup, decorator: Google::Apis::ClouderrorreportingV1beta1::ErrorGroup::Representation property :last_seen_time, as: 'lastSeenTime' property :num_affected_services, as: 'numAffectedServices' property :representative, as: 'representative', class: Google::Apis::ClouderrorreportingV1beta1::ErrorEvent, decorator: Google::Apis::ClouderrorreportingV1beta1::ErrorEvent::Representation collection :timed_counts, as: 'timedCounts', class: Google::Apis::ClouderrorreportingV1beta1::TimedCount, decorator: Google::Apis::ClouderrorreportingV1beta1::TimedCount::Representation end end class HttpRequestContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :method_prop, as: 'method' property :referrer, as: 'referrer' property :remote_ip, as: 'remoteIp' property :response_status_code, as: 'responseStatusCode' property :url, as: 'url' property :user_agent, as: 'userAgent' end end class ListEventsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :error_events, as: 'errorEvents', class: Google::Apis::ClouderrorreportingV1beta1::ErrorEvent, decorator: Google::Apis::ClouderrorreportingV1beta1::ErrorEvent::Representation property :next_page_token, as: 'nextPageToken' property :time_range_begin, as: 'timeRangeBegin' end end class ListGroupStatsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :error_group_stats, as: 'errorGroupStats', class: Google::Apis::ClouderrorreportingV1beta1::ErrorGroupStats, decorator: Google::Apis::ClouderrorreportingV1beta1::ErrorGroupStats::Representation property :next_page_token, as: 'nextPageToken' property :time_range_begin, as: 'timeRangeBegin' end end class ReportErrorEventResponse # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ReportedErrorEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :context, as: 'context', class: Google::Apis::ClouderrorreportingV1beta1::ErrorContext, decorator: Google::Apis::ClouderrorreportingV1beta1::ErrorContext::Representation property :event_time, as: 'eventTime' property :message, as: 'message' property :service_context, as: 'serviceContext', class: Google::Apis::ClouderrorreportingV1beta1::ServiceContext, decorator: Google::Apis::ClouderrorreportingV1beta1::ServiceContext::Representation end end class ServiceContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource_type, as: 'resourceType' property :service, as: 'service' property :version, as: 'version' end end class SourceLocation # @private class Representation < Google::Apis::Core::JsonRepresentation property :file_path, as: 'filePath' property :function_name, as: 'functionName' property :line_number, as: 'lineNumber' end end class SourceReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :repository, as: 'repository' property :revision_id, as: 'revisionId' end end class TimedCount # @private class Representation < Google::Apis::Core::JsonRepresentation property :count, :numeric_string => true, as: 'count' property :end_time, as: 'endTime' property :start_time, as: 'startTime' end end class TrackingIssue # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end end end end google-api-client-0.19.8/generated/google/apis/clouderrorreporting_v1beta1/classes.rb0000644000004100000410000006343613252673043030746 0ustar www-datawww-data# 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 ClouderrorreportingV1beta1 # Response message for deleting error events. class DeleteEventsResponse include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # A description of the context in which an error occurred. # This data should be provided by the application when reporting an error, # unless the # error report has been generated automatically from Google App Engine logs. class ErrorContext include Google::Apis::Core::Hashable # HTTP request data that is related to a reported error. # This data should be provided by the application when reporting an error, # unless the # error report has been generated automatically from Google App Engine logs. # Corresponds to the JSON property `httpRequest` # @return [Google::Apis::ClouderrorreportingV1beta1::HttpRequestContext] attr_accessor :http_request # Indicates a location in the source code of the service for which errors are # reported. `functionName` must be provided by the application when reporting # an error, unless the error report contains a `message` with a supported # exception stack trace. All fields are optional for the later case. # Corresponds to the JSON property `reportLocation` # @return [Google::Apis::ClouderrorreportingV1beta1::SourceLocation] attr_accessor :report_location # Source code that was used to build the executable which has # caused the given error message. # Corresponds to the JSON property `sourceReferences` # @return [Array] attr_accessor :source_references # The user who caused or was affected by the crash. # This can be a user ID, an email address, or an arbitrary token that # uniquely identifies the user. # When sending an error report, leave this field empty if the user was not # logged in. In this case the # Error Reporting system will use other data, such as remote IP address, to # distinguish affected users. See `affected_users_count` in # `ErrorGroupStats`. # Corresponds to the JSON property `user` # @return [String] attr_accessor :user def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @http_request = args[:http_request] if args.key?(:http_request) @report_location = args[:report_location] if args.key?(:report_location) @source_references = args[:source_references] if args.key?(:source_references) @user = args[:user] if args.key?(:user) end end # An error event which is returned by the Error Reporting system. class ErrorEvent include Google::Apis::Core::Hashable # A description of the context in which an error occurred. # This data should be provided by the application when reporting an error, # unless the # error report has been generated automatically from Google App Engine logs. # Corresponds to the JSON property `context` # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorContext] attr_accessor :context # Time when the event occurred as provided in the error report. # If the report did not contain a timestamp, the time the error was received # by the Error Reporting system is used. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time # The stack trace that was reported or logged by the service. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message # Describes a running service that sends errors. # Its version changes over time and multiple versions can run in parallel. # Corresponds to the JSON property `serviceContext` # @return [Google::Apis::ClouderrorreportingV1beta1::ServiceContext] attr_accessor :service_context def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @context = args[:context] if args.key?(:context) @event_time = args[:event_time] if args.key?(:event_time) @message = args[:message] if args.key?(:message) @service_context = args[:service_context] if args.key?(:service_context) end end # Description of a group of similar error events. class ErrorGroup include Google::Apis::Core::Hashable # Group IDs are unique for a given project. If the same kind of error # occurs in different service contexts, it will receive the same group ID. # Corresponds to the JSON property `groupId` # @return [String] attr_accessor :group_id # The group resource name. # Example: projects/my-project-123/groups/my-groupid # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Associated tracking issues. # Corresponds to the JSON property `trackingIssues` # @return [Array] attr_accessor :tracking_issues def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @group_id = args[:group_id] if args.key?(:group_id) @name = args[:name] if args.key?(:name) @tracking_issues = args[:tracking_issues] if args.key?(:tracking_issues) end end # Data extracted for a specific group based on certain filter criteria, # such as a given time period and/or service filter. class ErrorGroupStats include Google::Apis::Core::Hashable # Service contexts with a non-zero error count for the given filter # criteria. This list can be truncated if multiple services are affected. # Refer to `num_affected_services` for the total count. # Corresponds to the JSON property `affectedServices` # @return [Array] attr_accessor :affected_services # Approximate number of affected users in the given group that # match the filter criteria. # Users are distinguished by data in the `ErrorContext` of the # individual error events, such as their login name or their remote # IP address in case of HTTP requests. # The number of affected users can be zero even if the number of # errors is non-zero if no data was provided from which the # affected user could be deduced. # Users are counted based on data in the request # context that was provided in the error report. If more users are # implicitly affected, such as due to a crash of the whole service, # this is not reflected here. # Corresponds to the JSON property `affectedUsersCount` # @return [Fixnum] attr_accessor :affected_users_count # Approximate total number of events in the given group that match # the filter criteria. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # Approximate first occurrence that was ever seen for this group # and which matches the given filter criteria, ignoring the # time_range that was specified in the request. # Corresponds to the JSON property `firstSeenTime` # @return [String] attr_accessor :first_seen_time # Description of a group of similar error events. # Corresponds to the JSON property `group` # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] attr_accessor :group # Approximate last occurrence that was ever seen for this group and # which matches the given filter criteria, ignoring the time_range # that was specified in the request. # Corresponds to the JSON property `lastSeenTime` # @return [String] attr_accessor :last_seen_time # The total number of services with a non-zero error count for the given # filter criteria. # Corresponds to the JSON property `numAffectedServices` # @return [Fixnum] attr_accessor :num_affected_services # An error event which is returned by the Error Reporting system. # Corresponds to the JSON property `representative` # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorEvent] attr_accessor :representative # Approximate number of occurrences over time. # Timed counts returned by ListGroups are guaranteed to be: # - Inside the requested time interval # - Non-overlapping, and # - Ordered by ascending time. # Corresponds to the JSON property `timedCounts` # @return [Array] attr_accessor :timed_counts def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @affected_services = args[:affected_services] if args.key?(:affected_services) @affected_users_count = args[:affected_users_count] if args.key?(:affected_users_count) @count = args[:count] if args.key?(:count) @first_seen_time = args[:first_seen_time] if args.key?(:first_seen_time) @group = args[:group] if args.key?(:group) @last_seen_time = args[:last_seen_time] if args.key?(:last_seen_time) @num_affected_services = args[:num_affected_services] if args.key?(:num_affected_services) @representative = args[:representative] if args.key?(:representative) @timed_counts = args[:timed_counts] if args.key?(:timed_counts) end end # HTTP request data that is related to a reported error. # This data should be provided by the application when reporting an error, # unless the # error report has been generated automatically from Google App Engine logs. class HttpRequestContext include Google::Apis::Core::Hashable # The type of HTTP request, such as `GET`, `POST`, etc. # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # The referrer information that is provided with the request. # Corresponds to the JSON property `referrer` # @return [String] attr_accessor :referrer # The IP address from which the request originated. # This can be IPv4, IPv6, or a token which is derived from the # IP address, depending on the data that has been provided # in the error report. # Corresponds to the JSON property `remoteIp` # @return [String] attr_accessor :remote_ip # The HTTP response status code for the request. # Corresponds to the JSON property `responseStatusCode` # @return [Fixnum] attr_accessor :response_status_code # The URL of the request. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The user agent information that is provided with the request. # Corresponds to the JSON property `userAgent` # @return [String] attr_accessor :user_agent def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @method_prop = args[:method_prop] if args.key?(:method_prop) @referrer = args[:referrer] if args.key?(:referrer) @remote_ip = args[:remote_ip] if args.key?(:remote_ip) @response_status_code = args[:response_status_code] if args.key?(:response_status_code) @url = args[:url] if args.key?(:url) @user_agent = args[:user_agent] if args.key?(:user_agent) end end # Contains a set of requested error events. class ListEventsResponse include Google::Apis::Core::Hashable # The error events which match the given request. # Corresponds to the JSON property `errorEvents` # @return [Array] attr_accessor :error_events # If non-empty, more results are available. # Pass this token, along with the same query parameters as the first # request, to view the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The timestamp specifies the start time to which the request was restricted. # Corresponds to the JSON property `timeRangeBegin` # @return [String] attr_accessor :time_range_begin def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_events = args[:error_events] if args.key?(:error_events) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @time_range_begin = args[:time_range_begin] if args.key?(:time_range_begin) end end # Contains a set of requested error group stats. class ListGroupStatsResponse include Google::Apis::Core::Hashable # The error group stats which match the given request. # Corresponds to the JSON property `errorGroupStats` # @return [Array] attr_accessor :error_group_stats # If non-empty, more results are available. # Pass this token, along with the same query parameters as the first # request, to view the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The timestamp specifies the start time to which the request was restricted. # The start time is set based on the requested time range. It may be adjusted # to a later time if a project has exceeded the storage quota and older data # has been deleted. # Corresponds to the JSON property `timeRangeBegin` # @return [String] attr_accessor :time_range_begin def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_group_stats = args[:error_group_stats] if args.key?(:error_group_stats) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @time_range_begin = args[:time_range_begin] if args.key?(:time_range_begin) end end # Response for reporting an individual error event. # Data may be added to this message in the future. class ReportErrorEventResponse include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # An error event which is reported to the Error Reporting system. class ReportedErrorEvent include Google::Apis::Core::Hashable # A description of the context in which an error occurred. # This data should be provided by the application when reporting an error, # unless the # error report has been generated automatically from Google App Engine logs. # Corresponds to the JSON property `context` # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorContext] attr_accessor :context # [Optional] Time when the event occurred. # If not provided, the time when the event was received by the # Error Reporting system will be used. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time # [Required] The error message. # If no `context.reportLocation` is provided, the message must contain a # header (typically consisting of the exception type name and an error # message) and an exception stack trace in one of the supported programming # languages and formats. # Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. # Supported stack trace formats are: # * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https:/ # /docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28% # 29). # * **Python**: Must be the return value of [`traceback.format_exc()`](https:// # docs.python.org/2/library/traceback.html#traceback.format_exc). # * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/ # v8/wiki/Stack-Trace-API) # as returned by V8. # * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https:// # ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). # * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn. # microsoft.com/en-us/library/system.exception.tostring.aspx). # * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)` # and contain the result of [`(string)$exception`](http://php.net/manual/en/ # exception.tostring.php). # * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/ # pkg/runtime/debug/#Stack). # Corresponds to the JSON property `message` # @return [String] attr_accessor :message # Describes a running service that sends errors. # Its version changes over time and multiple versions can run in parallel. # Corresponds to the JSON property `serviceContext` # @return [Google::Apis::ClouderrorreportingV1beta1::ServiceContext] attr_accessor :service_context def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @context = args[:context] if args.key?(:context) @event_time = args[:event_time] if args.key?(:event_time) @message = args[:message] if args.key?(:message) @service_context = args[:service_context] if args.key?(:service_context) end end # Describes a running service that sends errors. # Its version changes over time and multiple versions can run in parallel. class ServiceContext include Google::Apis::Core::Hashable # Type of the MonitoredResource. List of possible values: # https://cloud.google.com/monitoring/api/resources # Value is set automatically for incoming errors and must not be set when # reporting errors. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type # An identifier of the service, such as the name of the # executable, job, or Google App Engine service name. This field is expected # to have a low number of values that are relatively stable over time, as # opposed to `version`, which can be changed whenever new code is deployed. # Contains the service name for error reports extracted from Google # App Engine logs or `default` if the App Engine default service is used. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service # Represents the source code version that the developer provided, # which could represent a version label or a Git SHA-1 hash, for example. # For App Engine standard environment, the version is set to the version of # the app. # 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) @resource_type = args[:resource_type] if args.key?(:resource_type) @service = args[:service] if args.key?(:service) @version = args[:version] if args.key?(:version) end end # Indicates a location in the source code of the service for which errors are # reported. `functionName` must be provided by the application when reporting # an error, unless the error report contains a `message` with a supported # exception stack trace. All fields are optional for the later case. class SourceLocation include Google::Apis::Core::Hashable # The source code filename, which can include a truncated relative # path, or a full path from a production machine. # Corresponds to the JSON property `filePath` # @return [String] attr_accessor :file_path # Human-readable name of a function or method. # The value can include optional context like the class or package name. # For example, `my.package.MyClass.method` in case of Java. # Corresponds to the JSON property `functionName` # @return [String] attr_accessor :function_name # 1-based. 0 indicates that the line number is unknown. # Corresponds to the JSON property `lineNumber` # @return [Fixnum] attr_accessor :line_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file_path = args[:file_path] if args.key?(:file_path) @function_name = args[:function_name] if args.key?(:function_name) @line_number = args[:line_number] if args.key?(:line_number) end end # A reference to a particular snapshot of the source tree used to build and # deploy an application. class SourceReference include Google::Apis::Core::Hashable # Optional. A URI string identifying the repository. # Example: "https://github.com/GoogleCloudPlatform/kubernetes.git" # Corresponds to the JSON property `repository` # @return [String] attr_accessor :repository # The canonical and persistent identifier of the deployed revision. # Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" # Corresponds to the JSON property `revisionId` # @return [String] attr_accessor :revision_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @repository = args[:repository] if args.key?(:repository) @revision_id = args[:revision_id] if args.key?(:revision_id) end end # The number of errors in a given time period. # All numbers are approximate since the error events are sampled # before counting them. class TimedCount include Google::Apis::Core::Hashable # Approximate number of occurrences in the given time period. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # End of the time period to which `count` refers (excluded). # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Start of the time period to which `count` refers (included). # 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) @count = args[:count] if args.key?(:count) @end_time = args[:end_time] if args.key?(:end_time) @start_time = args[:start_time] if args.key?(:start_time) end end # Information related to tracking the progress on resolving the error. class TrackingIssue include Google::Apis::Core::Hashable # A URL pointing to a related entry in an issue tracking system. # Example: https://github.com/user/project/issues/4 # 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 end end end google-api-client-0.19.8/generated/google/apis/clouderrorreporting_v1beta1/service.rb0000644000004100000410000005137113252673043030744 0ustar www-datawww-data# 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 ClouderrorreportingV1beta1 # Stackdriver Error Reporting API # # Groups and counts similar errors from cloud services and applications, reports # new errors, and provides access to error groups and their associated errors. # # @example # require 'google/apis/clouderrorreporting_v1beta1' # # Clouderrorreporting = Google::Apis::ClouderrorreportingV1beta1 # Alias the module # service = Clouderrorreporting::ClouderrorreportingService.new # # @see https://cloud.google.com/error-reporting/ class ClouderrorreportingService < 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://clouderrorreporting.googleapis.com/', '') @batch_path = 'batch' end # Deletes all error events of a given project. # @param [String] project_name # [Required] The resource name of the Google Cloud Platform project. Written # as `projects/` plus the # [Google Cloud Platform project # ID](https://support.google.com/cloud/answer/6158840). # Example: `projects/my-project-123`. # @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::ClouderrorreportingV1beta1::DeleteEventsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouderrorreportingV1beta1::DeleteEventsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_events(project_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+projectName}/events', options) command.response_representation = Google::Apis::ClouderrorreportingV1beta1::DeleteEventsResponse::Representation command.response_class = Google::Apis::ClouderrorreportingV1beta1::DeleteEventsResponse command.params['projectName'] = project_name unless project_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 specified events. # @param [String] project_name # [Required] The resource name of the Google Cloud Platform project. Written # as `projects/` plus the # [Google Cloud Platform project # ID](https://support.google.com/cloud/answer/6158840). # Example: `projects/my-project-123`. # @param [String] group_id # [Required] The group for which events shall be returned. # @param [Fixnum] page_size # [Optional] The maximum number of results to return per response. # @param [String] page_token # [Optional] A `next_page_token` provided by a previous response. # @param [String] service_filter_resource_type # [Optional] The exact value to match against # [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ # ServiceContext#FIELDS.resource_type). # @param [String] service_filter_service # [Optional] The exact value to match against # [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ # ServiceContext#FIELDS.service). # @param [String] service_filter_version # [Optional] The exact value to match against # [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ # ServiceContext#FIELDS.version). # @param [String] time_range_period # Restricts the query to the specified time range. # @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::ClouderrorreportingV1beta1::ListEventsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouderrorreportingV1beta1::ListEventsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_events(project_name, group_id: nil, page_size: nil, page_token: nil, service_filter_resource_type: nil, service_filter_service: nil, service_filter_version: nil, time_range_period: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+projectName}/events', options) command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ListEventsResponse::Representation command.response_class = Google::Apis::ClouderrorreportingV1beta1::ListEventsResponse command.params['projectName'] = project_name unless project_name.nil? command.query['groupId'] = group_id unless group_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['serviceFilter.resourceType'] = service_filter_resource_type unless service_filter_resource_type.nil? command.query['serviceFilter.service'] = service_filter_service unless service_filter_service.nil? command.query['serviceFilter.version'] = service_filter_version unless service_filter_version.nil? command.query['timeRange.period'] = time_range_period unless time_range_period.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Report an individual error event. # This endpoint accepts either an OAuth token, # or an # API key # for authentication. To use an API key, append it to the URL as the value of # a `key` parameter. For example: # 
POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-
        # project/events:report?key=123ABC456
# @param [String] project_name # [Required] The resource name of the Google Cloud Platform project. Written # as `projects/` plus the # [Google Cloud Platform project ID](https://support.google.com/cloud/answer/ # 6158840). # Example: `projects/my-project-123`. # @param [Google::Apis::ClouderrorreportingV1beta1::ReportedErrorEvent] reported_error_event_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::ClouderrorreportingV1beta1::ReportErrorEventResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouderrorreportingV1beta1::ReportErrorEventResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def report_project_event(project_name, reported_error_event_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+projectName}/events:report', options) command.request_representation = Google::Apis::ClouderrorreportingV1beta1::ReportedErrorEvent::Representation command.request_object = reported_error_event_object command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ReportErrorEventResponse::Representation command.response_class = Google::Apis::ClouderrorreportingV1beta1::ReportErrorEventResponse command.params['projectName'] = project_name unless project_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 specified groups. # @param [String] project_name # [Required] The resource name of the Google Cloud Platform project. Written # as projects/ plus the # Google Cloud # Platform project ID. # Example: projects/my-project-123. # @param [String] alignment # [Optional] The alignment of the timed counts to be returned. # Default is `ALIGNMENT_EQUAL_AT_END`. # @param [String] alignment_time # [Optional] Time where the timed counts shall be aligned if rounded # alignment is chosen. Default is 00:00 UTC. # @param [Array, String] group_id # [Optional] List all ErrorGroupStats with these IDs. # @param [String] order # [Optional] The sort order in which the results are returned. # Default is `COUNT_DESC`. # @param [Fixnum] page_size # [Optional] The maximum number of results to return per response. # Default is 20. # @param [String] page_token # [Optional] A `next_page_token` provided by a previous response. To view # additional results, pass this token along with the identical query # parameters as the first request. # @param [String] service_filter_resource_type # [Optional] The exact value to match against # [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ # ServiceContext#FIELDS.resource_type). # @param [String] service_filter_service # [Optional] The exact value to match against # [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ # ServiceContext#FIELDS.service). # @param [String] service_filter_version # [Optional] The exact value to match against # [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ # ServiceContext#FIELDS.version). # @param [String] time_range_period # Restricts the query to the specified time range. # @param [String] timed_count_duration # [Optional] The preferred duration for a single returned `TimedCount`. # If not set, no timed counts are 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::ClouderrorreportingV1beta1::ListGroupStatsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouderrorreportingV1beta1::ListGroupStatsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group_stats(project_name, alignment: nil, alignment_time: nil, group_id: nil, order: nil, page_size: nil, page_token: nil, service_filter_resource_type: nil, service_filter_service: nil, service_filter_version: nil, time_range_period: nil, timed_count_duration: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+projectName}/groupStats', options) command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ListGroupStatsResponse::Representation command.response_class = Google::Apis::ClouderrorreportingV1beta1::ListGroupStatsResponse command.params['projectName'] = project_name unless project_name.nil? command.query['alignment'] = alignment unless alignment.nil? command.query['alignmentTime'] = alignment_time unless alignment_time.nil? command.query['groupId'] = group_id unless group_id.nil? command.query['order'] = order unless order.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['serviceFilter.resourceType'] = service_filter_resource_type unless service_filter_resource_type.nil? command.query['serviceFilter.service'] = service_filter_service unless service_filter_service.nil? command.query['serviceFilter.version'] = service_filter_version unless service_filter_version.nil? command.query['timeRange.period'] = time_range_period unless time_range_period.nil? command.query['timedCountDuration'] = timed_count_duration unless timed_count_duration.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 specified group. # @param [String] group_name # [Required] The group resource name. Written as # projects/projectID/groups/group_name. # Call # # groupStats.list to return a list of groups belonging to # this project. # Example: projects/my-project-123/groups/my-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::ClouderrorreportingV1beta1::ErrorGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(group_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+groupName}', options) command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup::Representation command.response_class = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup command.params['groupName'] = group_name unless group_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 # Replace the data for the specified group. # Fails if the group does not exist. # @param [String] name # The group resource name. # Example: projects/my-project-123/groups/my-groupid # @param [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] error_group_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::ClouderrorreportingV1beta1::ErrorGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_group(name, error_group_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta1/{+name}', options) command.request_representation = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup::Representation command.request_object = error_group_object command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup::Representation command.response_class = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup 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 google-api-client-0.19.8/generated/google/apis/appengine_v1/0000755000004100000410000000000013252673043023667 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/appengine_v1/representations.rb0000644000004100000410000012323113252673043027443 0ustar www-datawww-data# 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 AppengineV1 class ApiConfigHandler class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApiEndpointHandler class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Application class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthorizedCertificate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthorizedDomain class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AutomaticScaling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BasicScaling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchUpdateIngressRulesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchUpdateIngressRulesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CertificateRawData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContainerInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CpuUtilization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateVersionMetadataV1Alpha class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateVersionMetadataV1Beta class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DebugInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Deployment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DiskUtilization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DomainMapping 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 EndpointsApiService class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ErrorHandler class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FeatureSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FileInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FirewallRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HealthCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IdentityAwareProxy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Instance class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Library class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAuthorizedCertificatesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAuthorizedDomainsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDomainMappingsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListIngressRulesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListInstancesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLocationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListServicesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListVersionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LivenessCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Location class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LocationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManualScaling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Network class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkUtilization 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 OperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperationMetadataV1 class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperationMetadataV1Alpha class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperationMetadataV1Beta class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperationMetadataV1Beta5 class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReadinessCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RepairApplicationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RequestUtilization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceRecord class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Resources class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ScriptHandler class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Service class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SslSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StandardSchedulerSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StaticFilesHandler 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 TrafficSplit class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlDispatchRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlMap class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Version class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Volume class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ZipInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApiConfigHandler # @private class Representation < Google::Apis::Core::JsonRepresentation property :auth_fail_action, as: 'authFailAction' property :login, as: 'login' property :script, as: 'script' property :security_level, as: 'securityLevel' property :url, as: 'url' end end class ApiEndpointHandler # @private class Representation < Google::Apis::Core::JsonRepresentation property :script_path, as: 'scriptPath' end end class Application # @private class Representation < Google::Apis::Core::JsonRepresentation property :auth_domain, as: 'authDomain' property :code_bucket, as: 'codeBucket' property :default_bucket, as: 'defaultBucket' property :default_cookie_expiration, as: 'defaultCookieExpiration' property :default_hostname, as: 'defaultHostname' collection :dispatch_rules, as: 'dispatchRules', class: Google::Apis::AppengineV1::UrlDispatchRule, decorator: Google::Apis::AppengineV1::UrlDispatchRule::Representation property :feature_settings, as: 'featureSettings', class: Google::Apis::AppengineV1::FeatureSettings, decorator: Google::Apis::AppengineV1::FeatureSettings::Representation property :gcr_domain, as: 'gcrDomain' property :iap, as: 'iap', class: Google::Apis::AppengineV1::IdentityAwareProxy, decorator: Google::Apis::AppengineV1::IdentityAwareProxy::Representation property :id, as: 'id' property :location_id, as: 'locationId' property :name, as: 'name' property :serving_status, as: 'servingStatus' end end class AuthorizedCertificate # @private class Representation < Google::Apis::Core::JsonRepresentation property :certificate_raw_data, as: 'certificateRawData', class: Google::Apis::AppengineV1::CertificateRawData, decorator: Google::Apis::AppengineV1::CertificateRawData::Representation property :display_name, as: 'displayName' property :domain_mappings_count, as: 'domainMappingsCount' collection :domain_names, as: 'domainNames' property :expire_time, as: 'expireTime' property :id, as: 'id' property :name, as: 'name' collection :visible_domain_mappings, as: 'visibleDomainMappings' end end class AuthorizedDomain # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :name, as: 'name' end end class AutomaticScaling # @private class Representation < Google::Apis::Core::JsonRepresentation property :cool_down_period, as: 'coolDownPeriod' property :cpu_utilization, as: 'cpuUtilization', class: Google::Apis::AppengineV1::CpuUtilization, decorator: Google::Apis::AppengineV1::CpuUtilization::Representation property :disk_utilization, as: 'diskUtilization', class: Google::Apis::AppengineV1::DiskUtilization, decorator: Google::Apis::AppengineV1::DiskUtilization::Representation property :max_concurrent_requests, as: 'maxConcurrentRequests' property :max_idle_instances, as: 'maxIdleInstances' property :max_pending_latency, as: 'maxPendingLatency' property :max_total_instances, as: 'maxTotalInstances' property :min_idle_instances, as: 'minIdleInstances' property :min_pending_latency, as: 'minPendingLatency' property :min_total_instances, as: 'minTotalInstances' property :network_utilization, as: 'networkUtilization', class: Google::Apis::AppengineV1::NetworkUtilization, decorator: Google::Apis::AppengineV1::NetworkUtilization::Representation property :request_utilization, as: 'requestUtilization', class: Google::Apis::AppengineV1::RequestUtilization, decorator: Google::Apis::AppengineV1::RequestUtilization::Representation property :standard_scheduler_settings, as: 'standardSchedulerSettings', class: Google::Apis::AppengineV1::StandardSchedulerSettings, decorator: Google::Apis::AppengineV1::StandardSchedulerSettings::Representation end end class BasicScaling # @private class Representation < Google::Apis::Core::JsonRepresentation property :idle_timeout, as: 'idleTimeout' property :max_instances, as: 'maxInstances' end end class BatchUpdateIngressRulesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ingress_rules, as: 'ingressRules', class: Google::Apis::AppengineV1::FirewallRule, decorator: Google::Apis::AppengineV1::FirewallRule::Representation end end class BatchUpdateIngressRulesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ingress_rules, as: 'ingressRules', class: Google::Apis::AppengineV1::FirewallRule, decorator: Google::Apis::AppengineV1::FirewallRule::Representation end end class CertificateRawData # @private class Representation < Google::Apis::Core::JsonRepresentation property :private_key, as: 'privateKey' property :public_certificate, as: 'publicCertificate' end end class ContainerInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :image, as: 'image' end end class CpuUtilization # @private class Representation < Google::Apis::Core::JsonRepresentation property :aggregation_window_length, as: 'aggregationWindowLength' property :target_utilization, as: 'targetUtilization' end end class CreateVersionMetadataV1Alpha # @private class Representation < Google::Apis::Core::JsonRepresentation property :cloud_build_id, as: 'cloudBuildId' end end class CreateVersionMetadataV1Beta # @private class Representation < Google::Apis::Core::JsonRepresentation property :cloud_build_id, as: 'cloudBuildId' end end class DebugInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :ssh_key, as: 'sshKey' end end class Deployment # @private class Representation < Google::Apis::Core::JsonRepresentation property :container, as: 'container', class: Google::Apis::AppengineV1::ContainerInfo, decorator: Google::Apis::AppengineV1::ContainerInfo::Representation hash :files, as: 'files', class: Google::Apis::AppengineV1::FileInfo, decorator: Google::Apis::AppengineV1::FileInfo::Representation property :zip, as: 'zip', class: Google::Apis::AppengineV1::ZipInfo, decorator: Google::Apis::AppengineV1::ZipInfo::Representation end end class DiskUtilization # @private class Representation < Google::Apis::Core::JsonRepresentation property :target_read_bytes_per_second, as: 'targetReadBytesPerSecond' property :target_read_ops_per_second, as: 'targetReadOpsPerSecond' property :target_write_bytes_per_second, as: 'targetWriteBytesPerSecond' property :target_write_ops_per_second, as: 'targetWriteOpsPerSecond' end end class DomainMapping # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :name, as: 'name' collection :resource_records, as: 'resourceRecords', class: Google::Apis::AppengineV1::ResourceRecord, decorator: Google::Apis::AppengineV1::ResourceRecord::Representation property :ssl_settings, as: 'sslSettings', class: Google::Apis::AppengineV1::SslSettings, decorator: Google::Apis::AppengineV1::SslSettings::Representation end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class EndpointsApiService # @private class Representation < Google::Apis::Core::JsonRepresentation property :config_id, as: 'configId' property :name, as: 'name' end end class ErrorHandler # @private class Representation < Google::Apis::Core::JsonRepresentation property :error_code, as: 'errorCode' property :mime_type, as: 'mimeType' property :static_file, as: 'staticFile' end end class FeatureSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :split_health_checks, as: 'splitHealthChecks' end end class FileInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :mime_type, as: 'mimeType' property :sha1_sum, as: 'sha1Sum' property :source_url, as: 'sourceUrl' end end class FirewallRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' property :description, as: 'description' property :priority, as: 'priority' property :source_range, as: 'sourceRange' end end class HealthCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :check_interval, as: 'checkInterval' property :disable_health_check, as: 'disableHealthCheck' property :healthy_threshold, as: 'healthyThreshold' property :host, as: 'host' property :restart_threshold, as: 'restartThreshold' property :timeout, as: 'timeout' property :unhealthy_threshold, as: 'unhealthyThreshold' end end class IdentityAwareProxy # @private class Representation < Google::Apis::Core::JsonRepresentation property :enabled, as: 'enabled' property :oauth2_client_id, as: 'oauth2ClientId' property :oauth2_client_secret, as: 'oauth2ClientSecret' property :oauth2_client_secret_sha256, as: 'oauth2ClientSecretSha256' end end class Instance # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_engine_release, as: 'appEngineRelease' property :availability, as: 'availability' property :average_latency, as: 'averageLatency' property :errors, as: 'errors' property :id, as: 'id' property :memory_usage, :numeric_string => true, as: 'memoryUsage' property :name, as: 'name' property :qps, as: 'qps' property :requests, as: 'requests' property :start_time, as: 'startTime' property :vm_debug_enabled, as: 'vmDebugEnabled' property :vm_id, as: 'vmId' property :vm_ip, as: 'vmIp' property :vm_name, as: 'vmName' property :vm_status, as: 'vmStatus' property :vm_zone_name, as: 'vmZoneName' end end class Library # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :version, as: 'version' end end class ListAuthorizedCertificatesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :certificates, as: 'certificates', class: Google::Apis::AppengineV1::AuthorizedCertificate, decorator: Google::Apis::AppengineV1::AuthorizedCertificate::Representation property :next_page_token, as: 'nextPageToken' end end class ListAuthorizedDomainsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :domains, as: 'domains', class: Google::Apis::AppengineV1::AuthorizedDomain, decorator: Google::Apis::AppengineV1::AuthorizedDomain::Representation property :next_page_token, as: 'nextPageToken' end end class ListDomainMappingsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :domain_mappings, as: 'domainMappings', class: Google::Apis::AppengineV1::DomainMapping, decorator: Google::Apis::AppengineV1::DomainMapping::Representation property :next_page_token, as: 'nextPageToken' end end class ListIngressRulesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ingress_rules, as: 'ingressRules', class: Google::Apis::AppengineV1::FirewallRule, decorator: Google::Apis::AppengineV1::FirewallRule::Representation property :next_page_token, as: 'nextPageToken' end end class ListInstancesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances', class: Google::Apis::AppengineV1::Instance, decorator: Google::Apis::AppengineV1::Instance::Representation property :next_page_token, as: 'nextPageToken' end end class ListLocationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :locations, as: 'locations', class: Google::Apis::AppengineV1::Location, decorator: Google::Apis::AppengineV1::Location::Representation property :next_page_token, as: 'nextPageToken' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::AppengineV1::Operation, decorator: Google::Apis::AppengineV1::Operation::Representation end end class ListServicesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :services, as: 'services', class: Google::Apis::AppengineV1::Service, decorator: Google::Apis::AppengineV1::Service::Representation end end class ListVersionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :versions, as: 'versions', class: Google::Apis::AppengineV1::Version, decorator: Google::Apis::AppengineV1::Version::Representation end end class LivenessCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :check_interval, as: 'checkInterval' property :failure_threshold, as: 'failureThreshold' property :host, as: 'host' property :initial_delay, as: 'initialDelay' property :path, as: 'path' property :success_threshold, as: 'successThreshold' property :timeout, as: 'timeout' end end class Location # @private class Representation < Google::Apis::Core::JsonRepresentation hash :labels, as: 'labels' property :location_id, as: 'locationId' hash :metadata, as: 'metadata' property :name, as: 'name' end end class LocationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :flexible_environment_available, as: 'flexibleEnvironmentAvailable' property :standard_environment_available, as: 'standardEnvironmentAvailable' end end class ManualScaling # @private class Representation < Google::Apis::Core::JsonRepresentation property :instances, as: 'instances' end end class Network # @private class Representation < Google::Apis::Core::JsonRepresentation collection :forwarded_ports, as: 'forwardedPorts' property :instance_tag, as: 'instanceTag' property :name, as: 'name' property :subnetwork_name, as: 'subnetworkName' end end class NetworkUtilization # @private class Representation < Google::Apis::Core::JsonRepresentation property :target_received_bytes_per_second, as: 'targetReceivedBytesPerSecond' property :target_received_packets_per_second, as: 'targetReceivedPacketsPerSecond' property :target_sent_bytes_per_second, as: 'targetSentBytesPerSecond' property :target_sent_packets_per_second, as: 'targetSentPacketsPerSecond' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::AppengineV1::Status, decorator: Google::Apis::AppengineV1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class OperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime' property :insert_time, as: 'insertTime' property :method_prop, as: 'method' property :operation_type, as: 'operationType' property :target, as: 'target' property :user, as: 'user' end end class OperationMetadataV1 # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime' property :ephemeral_message, as: 'ephemeralMessage' property :insert_time, as: 'insertTime' property :method_prop, as: 'method' property :target, as: 'target' property :user, as: 'user' collection :warning, as: 'warning' end end class OperationMetadataV1Alpha # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_version_metadata, as: 'createVersionMetadata', class: Google::Apis::AppengineV1::CreateVersionMetadataV1Alpha, decorator: Google::Apis::AppengineV1::CreateVersionMetadataV1Alpha::Representation property :end_time, as: 'endTime' property :ephemeral_message, as: 'ephemeralMessage' property :insert_time, as: 'insertTime' property :method_prop, as: 'method' property :target, as: 'target' property :user, as: 'user' collection :warning, as: 'warning' end end class OperationMetadataV1Beta # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_version_metadata, as: 'createVersionMetadata', class: Google::Apis::AppengineV1::CreateVersionMetadataV1Beta, decorator: Google::Apis::AppengineV1::CreateVersionMetadataV1Beta::Representation property :end_time, as: 'endTime' property :ephemeral_message, as: 'ephemeralMessage' property :insert_time, as: 'insertTime' property :method_prop, as: 'method' property :target, as: 'target' property :user, as: 'user' collection :warning, as: 'warning' end end class OperationMetadataV1Beta5 # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime' property :insert_time, as: 'insertTime' property :method_prop, as: 'method' property :target, as: 'target' property :user, as: 'user' end end class ReadinessCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_start_timeout, as: 'appStartTimeout' property :check_interval, as: 'checkInterval' property :failure_threshold, as: 'failureThreshold' property :host, as: 'host' property :path, as: 'path' property :success_threshold, as: 'successThreshold' property :timeout, as: 'timeout' end end class RepairApplicationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class RequestUtilization # @private class Representation < Google::Apis::Core::JsonRepresentation property :target_concurrent_requests, as: 'targetConcurrentRequests' property :target_request_count_per_second, as: 'targetRequestCountPerSecond' end end class ResourceRecord # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :rrdata, as: 'rrdata' property :type, as: 'type' end end class Resources # @private class Representation < Google::Apis::Core::JsonRepresentation property :cpu, as: 'cpu' property :disk_gb, as: 'diskGb' property :memory_gb, as: 'memoryGb' collection :volumes, as: 'volumes', class: Google::Apis::AppengineV1::Volume, decorator: Google::Apis::AppengineV1::Volume::Representation end end class ScriptHandler # @private class Representation < Google::Apis::Core::JsonRepresentation property :script_path, as: 'scriptPath' end end class Service # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :name, as: 'name' property :split, as: 'split', class: Google::Apis::AppengineV1::TrafficSplit, decorator: Google::Apis::AppengineV1::TrafficSplit::Representation end end class SslSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :certificate_id, as: 'certificateId' end end class StandardSchedulerSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_instances, as: 'maxInstances' property :min_instances, as: 'minInstances' property :target_cpu_utilization, as: 'targetCpuUtilization' property :target_throughput_utilization, as: 'targetThroughputUtilization' end end class StaticFilesHandler # @private class Representation < Google::Apis::Core::JsonRepresentation property :application_readable, as: 'applicationReadable' property :expiration, as: 'expiration' hash :http_headers, as: 'httpHeaders' property :mime_type, as: 'mimeType' property :path, as: 'path' property :require_matching_file, as: 'requireMatchingFile' property :upload_path_regex, as: 'uploadPathRegex' 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 TrafficSplit # @private class Representation < Google::Apis::Core::JsonRepresentation hash :allocations, as: 'allocations' property :shard_by, as: 'shardBy' end end class UrlDispatchRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :domain, as: 'domain' property :path, as: 'path' property :service, as: 'service' end end class UrlMap # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_endpoint, as: 'apiEndpoint', class: Google::Apis::AppengineV1::ApiEndpointHandler, decorator: Google::Apis::AppengineV1::ApiEndpointHandler::Representation property :auth_fail_action, as: 'authFailAction' property :login, as: 'login' property :redirect_http_response_code, as: 'redirectHttpResponseCode' property :script, as: 'script', class: Google::Apis::AppengineV1::ScriptHandler, decorator: Google::Apis::AppengineV1::ScriptHandler::Representation property :security_level, as: 'securityLevel' property :static_files, as: 'staticFiles', class: Google::Apis::AppengineV1::StaticFilesHandler, decorator: Google::Apis::AppengineV1::StaticFilesHandler::Representation property :url_regex, as: 'urlRegex' end end class Version # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_config, as: 'apiConfig', class: Google::Apis::AppengineV1::ApiConfigHandler, decorator: Google::Apis::AppengineV1::ApiConfigHandler::Representation property :automatic_scaling, as: 'automaticScaling', class: Google::Apis::AppengineV1::AutomaticScaling, decorator: Google::Apis::AppengineV1::AutomaticScaling::Representation property :basic_scaling, as: 'basicScaling', class: Google::Apis::AppengineV1::BasicScaling, decorator: Google::Apis::AppengineV1::BasicScaling::Representation hash :beta_settings, as: 'betaSettings' property :create_time, as: 'createTime' property :created_by, as: 'createdBy' property :default_expiration, as: 'defaultExpiration' property :deployment, as: 'deployment', class: Google::Apis::AppengineV1::Deployment, decorator: Google::Apis::AppengineV1::Deployment::Representation property :disk_usage_bytes, :numeric_string => true, as: 'diskUsageBytes' property :endpoints_api_service, as: 'endpointsApiService', class: Google::Apis::AppengineV1::EndpointsApiService, decorator: Google::Apis::AppengineV1::EndpointsApiService::Representation property :env, as: 'env' hash :env_variables, as: 'envVariables' collection :error_handlers, as: 'errorHandlers', class: Google::Apis::AppengineV1::ErrorHandler, decorator: Google::Apis::AppengineV1::ErrorHandler::Representation collection :handlers, as: 'handlers', class: Google::Apis::AppengineV1::UrlMap, decorator: Google::Apis::AppengineV1::UrlMap::Representation property :health_check, as: 'healthCheck', class: Google::Apis::AppengineV1::HealthCheck, decorator: Google::Apis::AppengineV1::HealthCheck::Representation property :id, as: 'id' collection :inbound_services, as: 'inboundServices' property :instance_class, as: 'instanceClass' collection :libraries, as: 'libraries', class: Google::Apis::AppengineV1::Library, decorator: Google::Apis::AppengineV1::Library::Representation property :liveness_check, as: 'livenessCheck', class: Google::Apis::AppengineV1::LivenessCheck, decorator: Google::Apis::AppengineV1::LivenessCheck::Representation property :manual_scaling, as: 'manualScaling', class: Google::Apis::AppengineV1::ManualScaling, decorator: Google::Apis::AppengineV1::ManualScaling::Representation property :name, as: 'name' property :network, as: 'network', class: Google::Apis::AppengineV1::Network, decorator: Google::Apis::AppengineV1::Network::Representation property :nobuild_files_regex, as: 'nobuildFilesRegex' property :readiness_check, as: 'readinessCheck', class: Google::Apis::AppengineV1::ReadinessCheck, decorator: Google::Apis::AppengineV1::ReadinessCheck::Representation property :resources, as: 'resources', class: Google::Apis::AppengineV1::Resources, decorator: Google::Apis::AppengineV1::Resources::Representation property :runtime, as: 'runtime' property :runtime_api_version, as: 'runtimeApiVersion' property :runtime_channel, as: 'runtimeChannel' property :serving_status, as: 'servingStatus' property :threadsafe, as: 'threadsafe' property :version_url, as: 'versionUrl' property :vm, as: 'vm' collection :zones, as: 'zones' end end class Volume # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :size_gb, as: 'sizeGb' property :volume_type, as: 'volumeType' end end class ZipInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :files_count, as: 'filesCount' property :source_url, as: 'sourceUrl' end end end end end google-api-client-0.19.8/generated/google/apis/appengine_v1/classes.rb0000644000004100000410000035635313252673043025670 0ustar www-datawww-data# 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 AppengineV1 # Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/ # endpoints/) configuration for API handlers. class ApiConfigHandler include Google::Apis::Core::Hashable # Action to take when users access resources that require authentication. # Defaults to redirect. # Corresponds to the JSON property `authFailAction` # @return [String] attr_accessor :auth_fail_action # Level of login required to access this resource. Defaults to optional. # Corresponds to the JSON property `login` # @return [String] attr_accessor :login # Path to the script from the application root directory. # Corresponds to the JSON property `script` # @return [String] attr_accessor :script # Security (HTTPS) enforcement for this URL. # Corresponds to the JSON property `securityLevel` # @return [String] attr_accessor :security_level # URL to serve the endpoint at. # 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) @auth_fail_action = args[:auth_fail_action] if args.key?(:auth_fail_action) @login = args[:login] if args.key?(:login) @script = args[:script] if args.key?(:script) @security_level = args[:security_level] if args.key?(:security_level) @url = args[:url] if args.key?(:url) end end # Uses Google Cloud Endpoints to handle requests. class ApiEndpointHandler include Google::Apis::Core::Hashable # Path to the script from the application root directory. # Corresponds to the JSON property `scriptPath` # @return [String] attr_accessor :script_path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @script_path = args[:script_path] if args.key?(:script_path) end end # An Application resource contains the top-level configuration of an App Engine # application. class Application include Google::Apis::Core::Hashable # Google Apps authentication domain that controls which users can access this # application.Defaults to open access for any Google Account. # Corresponds to the JSON property `authDomain` # @return [String] attr_accessor :auth_domain # Google Cloud Storage bucket that can be used for storing files associated with # this application. This bucket is associated with the application and can be # used by the gcloud deployment commands.@OutputOnly # Corresponds to the JSON property `codeBucket` # @return [String] attr_accessor :code_bucket # Google Cloud Storage bucket that can be used by this application to store # content.@OutputOnly # Corresponds to the JSON property `defaultBucket` # @return [String] attr_accessor :default_bucket # Cookie expiration policy for this application. # Corresponds to the JSON property `defaultCookieExpiration` # @return [String] attr_accessor :default_cookie_expiration # Hostname used to reach this application, as resolved by App Engine.@OutputOnly # Corresponds to the JSON property `defaultHostname` # @return [String] attr_accessor :default_hostname # HTTP path dispatch rules for requests to the application that do not # explicitly target a service or version. Rules are order-dependent. Up to 20 # dispatch rules can be supported.@OutputOnly # Corresponds to the JSON property `dispatchRules` # @return [Array] attr_accessor :dispatch_rules # The feature specific settings to be used in the application. These define # behaviors that are user configurable. # Corresponds to the JSON property `featureSettings` # @return [Google::Apis::AppengineV1::FeatureSettings] attr_accessor :feature_settings # The Google Container Registry domain used for storing managed build docker # images for this application. # Corresponds to the JSON property `gcrDomain` # @return [String] attr_accessor :gcr_domain # Identity-Aware Proxy # Corresponds to the JSON property `iap` # @return [Google::Apis::AppengineV1::IdentityAwareProxy] attr_accessor :iap # Identifier of the Application resource. This identifier is equivalent to the # project ID of the Google Cloud Platform project where you want to deploy your # application. Example: myapp. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Location from which this application runs. Application instances run out of # the data centers in the specified location, which is also where all of the # application's end user content is stored.Defaults to us-central1.View the list # of supported locations (https://cloud.google.com/appengine/docs/locations). # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Full path to the Application resource in the API. Example: apps/myapp.@ # OutputOnly # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Serving status of this application. # Corresponds to the JSON property `servingStatus` # @return [String] attr_accessor :serving_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auth_domain = args[:auth_domain] if args.key?(:auth_domain) @code_bucket = args[:code_bucket] if args.key?(:code_bucket) @default_bucket = args[:default_bucket] if args.key?(:default_bucket) @default_cookie_expiration = args[:default_cookie_expiration] if args.key?(:default_cookie_expiration) @default_hostname = args[:default_hostname] if args.key?(:default_hostname) @dispatch_rules = args[:dispatch_rules] if args.key?(:dispatch_rules) @feature_settings = args[:feature_settings] if args.key?(:feature_settings) @gcr_domain = args[:gcr_domain] if args.key?(:gcr_domain) @iap = args[:iap] if args.key?(:iap) @id = args[:id] if args.key?(:id) @location_id = args[:location_id] if args.key?(:location_id) @name = args[:name] if args.key?(:name) @serving_status = args[:serving_status] if args.key?(:serving_status) end end # An SSL certificate that a user has been authorized to administer. A user is # authorized to administer any certificate that applies to one of their # authorized domains. class AuthorizedCertificate include Google::Apis::Core::Hashable # An SSL certificate obtained from a certificate authority. # Corresponds to the JSON property `certificateRawData` # @return [Google::Apis::AppengineV1::CertificateRawData] attr_accessor :certificate_raw_data # The user-specified display name of the certificate. This is not guaranteed to # be unique. Example: My Certificate. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Aggregate count of the domain mappings with this certificate mapped. This # count includes domain mappings on applications for which the user does not # have VIEWER permissions.Only returned by GET or LIST requests when # specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly # Corresponds to the JSON property `domainMappingsCount` # @return [Fixnum] attr_accessor :domain_mappings_count # Topmost applicable domains of this certificate. This certificate applies to # these domains and their subdomains. Example: example.com.@OutputOnly # Corresponds to the JSON property `domainNames` # @return [Array] attr_accessor :domain_names # The time when this certificate expires. To update the renewal time on this # certificate, upload an SSL certificate with a different expiration time using # AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time # Relative name of the certificate. This is a unique value autogenerated on # AuthorizedCertificate resource creation. Example: 12345.@OutputOnly # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Full path to the AuthorizedCertificate resource in the API. Example: apps/ # myapp/authorizedCertificates/12345.@OutputOnly # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The full paths to user visible Domain Mapping resources that have this # certificate mapped. Example: apps/myapp/domainMappings/example.com.This may # not represent the full list of mapped domain mappings if the user does not # have VIEWER permissions on all of the applications that have this certificate # mapped. See domain_mappings_count for a complete count.Only returned by GET or # LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@ # OutputOnly # Corresponds to the JSON property `visibleDomainMappings` # @return [Array] attr_accessor :visible_domain_mappings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @certificate_raw_data = args[:certificate_raw_data] if args.key?(:certificate_raw_data) @display_name = args[:display_name] if args.key?(:display_name) @domain_mappings_count = args[:domain_mappings_count] if args.key?(:domain_mappings_count) @domain_names = args[:domain_names] if args.key?(:domain_names) @expire_time = args[:expire_time] if args.key?(:expire_time) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @visible_domain_mappings = args[:visible_domain_mappings] if args.key?(:visible_domain_mappings) end end # A domain that a user has been authorized to administer. To authorize use of a # domain, verify ownership via Webmaster Central (https://www.google.com/ # webmasters/verification/home). class AuthorizedDomain include Google::Apis::Core::Hashable # Fully qualified domain name of the domain authorized for use. Example: example. # com. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/ # authorizedDomains/example.com.@OutputOnly # 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) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) end end # Automatic scaling is based on request rate, response latencies, and other # application metrics. class AutomaticScaling include Google::Apis::Core::Hashable # Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/ # autoscaler/) should wait between changes to the number of virtual machines. # Only applicable in the App Engine flexible environment. # Corresponds to the JSON property `coolDownPeriod` # @return [String] attr_accessor :cool_down_period # Target scaling by CPU usage. # Corresponds to the JSON property `cpuUtilization` # @return [Google::Apis::AppengineV1::CpuUtilization] attr_accessor :cpu_utilization # Target scaling by disk usage. Only applicable in the App Engine flexible # environment. # Corresponds to the JSON property `diskUtilization` # @return [Google::Apis::AppengineV1::DiskUtilization] attr_accessor :disk_utilization # Number of concurrent requests an automatic scaling instance can accept before # the scheduler spawns a new instance.Defaults to a runtime-specific value. # Corresponds to the JSON property `maxConcurrentRequests` # @return [Fixnum] attr_accessor :max_concurrent_requests # Maximum number of idle instances that should be maintained for this version. # Corresponds to the JSON property `maxIdleInstances` # @return [Fixnum] attr_accessor :max_idle_instances # Maximum amount of time that a request should wait in the pending queue before # starting a new instance to handle it. # Corresponds to the JSON property `maxPendingLatency` # @return [String] attr_accessor :max_pending_latency # Maximum number of instances that should be started to handle requests for this # version. # Corresponds to the JSON property `maxTotalInstances` # @return [Fixnum] attr_accessor :max_total_instances # Minimum number of idle instances that should be maintained for this version. # Only applicable for the default version of a service. # Corresponds to the JSON property `minIdleInstances` # @return [Fixnum] attr_accessor :min_idle_instances # Minimum amount of time a request should wait in the pending queue before # starting a new instance to handle it. # Corresponds to the JSON property `minPendingLatency` # @return [String] attr_accessor :min_pending_latency # Minimum number of running instances that should be maintained for this version. # Corresponds to the JSON property `minTotalInstances` # @return [Fixnum] attr_accessor :min_total_instances # Target scaling by network usage. Only applicable in the App Engine flexible # environment. # Corresponds to the JSON property `networkUtilization` # @return [Google::Apis::AppengineV1::NetworkUtilization] attr_accessor :network_utilization # Target scaling by request utilization. Only applicable in the App Engine # flexible environment. # Corresponds to the JSON property `requestUtilization` # @return [Google::Apis::AppengineV1::RequestUtilization] attr_accessor :request_utilization # Scheduler settings for standard environment. # Corresponds to the JSON property `standardSchedulerSettings` # @return [Google::Apis::AppengineV1::StandardSchedulerSettings] attr_accessor :standard_scheduler_settings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cool_down_period = args[:cool_down_period] if args.key?(:cool_down_period) @cpu_utilization = args[:cpu_utilization] if args.key?(:cpu_utilization) @disk_utilization = args[:disk_utilization] if args.key?(:disk_utilization) @max_concurrent_requests = args[:max_concurrent_requests] if args.key?(:max_concurrent_requests) @max_idle_instances = args[:max_idle_instances] if args.key?(:max_idle_instances) @max_pending_latency = args[:max_pending_latency] if args.key?(:max_pending_latency) @max_total_instances = args[:max_total_instances] if args.key?(:max_total_instances) @min_idle_instances = args[:min_idle_instances] if args.key?(:min_idle_instances) @min_pending_latency = args[:min_pending_latency] if args.key?(:min_pending_latency) @min_total_instances = args[:min_total_instances] if args.key?(:min_total_instances) @network_utilization = args[:network_utilization] if args.key?(:network_utilization) @request_utilization = args[:request_utilization] if args.key?(:request_utilization) @standard_scheduler_settings = args[:standard_scheduler_settings] if args.key?(:standard_scheduler_settings) end end # A service with basic scaling will create an instance when the application # receives a request. The instance will be turned down when the app becomes idle. # Basic scaling is ideal for work that is intermittent or driven by user # activity. class BasicScaling include Google::Apis::Core::Hashable # Duration of time after the last request that an instance must wait before the # instance is shut down. # Corresponds to the JSON property `idleTimeout` # @return [String] attr_accessor :idle_timeout # Maximum number of instances to create for this version. # Corresponds to the JSON property `maxInstances` # @return [Fixnum] attr_accessor :max_instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @idle_timeout = args[:idle_timeout] if args.key?(:idle_timeout) @max_instances = args[:max_instances] if args.key?(:max_instances) end end # Request message for Firewall.BatchUpdateIngressRules. class BatchUpdateIngressRulesRequest include Google::Apis::Core::Hashable # A list of FirewallRules to replace the existing set. # Corresponds to the JSON property `ingressRules` # @return [Array] attr_accessor :ingress_rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ingress_rules = args[:ingress_rules] if args.key?(:ingress_rules) end end # Response message for Firewall.UpdateAllIngressRules. class BatchUpdateIngressRulesResponse include Google::Apis::Core::Hashable # The full list of ingress FirewallRules for this application. # Corresponds to the JSON property `ingressRules` # @return [Array] attr_accessor :ingress_rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ingress_rules = args[:ingress_rules] if args.key?(:ingress_rules) end end # An SSL certificate obtained from a certificate authority. class CertificateRawData include Google::Apis::Core::Hashable # Unencrypted PEM encoded RSA private key. This field is set once on certificate # creation and then encrypted. The key size must be 2048 bits or fewer. Must # include the header and footer. Example: 
 -----BEGIN RSA PRIVATE KEY----- <
        # unencrypted_key_value> -----END RSA PRIVATE KEY-----
@InputOnly # Corresponds to the JSON property `privateKey` # @return [String] attr_accessor :private_key # PEM encoded x.509 public key certificate. This field is set once on # certificate creation. Must include the header and footer. Example: 
 -----
        # BEGIN CERTIFICATE-----  -----END CERTIFICATE-----
# Corresponds to the JSON property `publicCertificate` # @return [String] attr_accessor :public_certificate def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @private_key = args[:private_key] if args.key?(:private_key) @public_certificate = args[:public_certificate] if args.key?(:public_certificate) end end # Docker image that is used to create a container and start a VM instance for # the version that you deploy. Only applicable for instances running in the App # Engine flexible environment. class ContainerInfo include Google::Apis::Core::Hashable # URI to the hosted container image in Google Container Registry. The URI must # be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/ # image:tag" or "gcr.io/my-project/image@digest" # Corresponds to the JSON property `image` # @return [String] 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 # Target scaling by CPU usage. class CpuUtilization include Google::Apis::Core::Hashable # Period of time over which CPU utilization is calculated. # Corresponds to the JSON property `aggregationWindowLength` # @return [String] attr_accessor :aggregation_window_length # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. # Corresponds to the JSON property `targetUtilization` # @return [Float] attr_accessor :target_utilization def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aggregation_window_length = args[:aggregation_window_length] if args.key?(:aggregation_window_length) @target_utilization = args[:target_utilization] if args.key?(:target_utilization) end end # Metadata for the given google.longrunning.Operation during a google.appengine. # v1alpha.CreateVersionRequest. class CreateVersionMetadataV1Alpha include Google::Apis::Core::Hashable # The Cloud Build ID if one was created as part of the version create. @ # OutputOnly # Corresponds to the JSON property `cloudBuildId` # @return [String] attr_accessor :cloud_build_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cloud_build_id = args[:cloud_build_id] if args.key?(:cloud_build_id) end end # Metadata for the given google.longrunning.Operation during a google.appengine. # v1beta.CreateVersionRequest. class CreateVersionMetadataV1Beta include Google::Apis::Core::Hashable # The Cloud Build ID if one was created as part of the version create. @ # OutputOnly # Corresponds to the JSON property `cloudBuildId` # @return [String] attr_accessor :cloud_build_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cloud_build_id = args[:cloud_build_id] if args.key?(:cloud_build_id) end end # Request message for Instances.DebugInstance. class DebugInstanceRequest include Google::Apis::Core::Hashable # Public SSH key to add to the instance. Examples: # [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] # [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh `"userName":"[USERNAME]","expireOn":" # [EXPIRE_TIME]"`For more information, see Adding and Removing SSH Keys (https:// # cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). # Corresponds to the JSON property `sshKey` # @return [String] attr_accessor :ssh_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ssh_key = args[:ssh_key] if args.key?(:ssh_key) end end # Code and application artifacts used to deploy a version to App Engine. class Deployment include Google::Apis::Core::Hashable # Docker image that is used to create a container and start a VM instance for # the version that you deploy. Only applicable for instances running in the App # Engine flexible environment. # Corresponds to the JSON property `container` # @return [Google::Apis::AppengineV1::ContainerInfo] attr_accessor :container # Manifest of the files stored in Google Cloud Storage that are included as part # of this version. All files must be readable using the credentials supplied # with this call. # Corresponds to the JSON property `files` # @return [Hash] attr_accessor :files # The zip file information for a zip deployment. # Corresponds to the JSON property `zip` # @return [Google::Apis::AppengineV1::ZipInfo] attr_accessor :zip def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @container = args[:container] if args.key?(:container) @files = args[:files] if args.key?(:files) @zip = args[:zip] if args.key?(:zip) end end # Target scaling by disk usage. Only applicable in the App Engine flexible # environment. class DiskUtilization include Google::Apis::Core::Hashable # Target bytes read per second. # Corresponds to the JSON property `targetReadBytesPerSecond` # @return [Fixnum] attr_accessor :target_read_bytes_per_second # Target ops read per seconds. # Corresponds to the JSON property `targetReadOpsPerSecond` # @return [Fixnum] attr_accessor :target_read_ops_per_second # Target bytes written per second. # Corresponds to the JSON property `targetWriteBytesPerSecond` # @return [Fixnum] attr_accessor :target_write_bytes_per_second # Target ops written per second. # Corresponds to the JSON property `targetWriteOpsPerSecond` # @return [Fixnum] attr_accessor :target_write_ops_per_second def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @target_read_bytes_per_second = args[:target_read_bytes_per_second] if args.key?(:target_read_bytes_per_second) @target_read_ops_per_second = args[:target_read_ops_per_second] if args.key?(:target_read_ops_per_second) @target_write_bytes_per_second = args[:target_write_bytes_per_second] if args.key?(:target_write_bytes_per_second) @target_write_ops_per_second = args[:target_write_ops_per_second] if args.key?(:target_write_ops_per_second) end end # A domain serving an App Engine application. class DomainMapping include Google::Apis::Core::Hashable # Relative name of the domain serving the application. Example: example.com. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Full path to the DomainMapping resource in the API. Example: apps/myapp/ # domainMapping/example.com.@OutputOnly # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The resource records required to configure this domain mapping. These records # must be added to the domain's DNS configuration in order to serve the # application via this domain mapping.@OutputOnly # Corresponds to the JSON property `resourceRecords` # @return [Array] attr_accessor :resource_records # SSL configuration for a DomainMapping resource. # Corresponds to the JSON property `sslSettings` # @return [Google::Apis::AppengineV1::SslSettings] attr_accessor :ssl_settings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @resource_records = args[:resource_records] if args.key?(:resource_records) @ssl_settings = args[:ssl_settings] if args.key?(:ssl_settings) 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 # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The # Endpoints API Service provides tooling for serving Open API and gRPC endpoints # via an NGINX proxy.The fields here refer to the name and configuration id of a # "service" resource in the Service Management API (https://cloud.google.com/ # service-management/overview). class EndpointsApiService include Google::Apis::Core::Hashable # Endpoints service configuration id as specified by the Service Management API. # For example "2016-09-19r1" # Corresponds to the JSON property `configId` # @return [String] attr_accessor :config_id # Endpoints service name which is the name of the "service" resource in the # Service Management API. For example "myapi.endpoints.myproject.cloud.goog" # 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) @config_id = args[:config_id] if args.key?(:config_id) @name = args[:name] if args.key?(:name) end end # Custom static error page to be served when an error occurs. class ErrorHandler include Google::Apis::Core::Hashable # Error condition this handler applies to. # Corresponds to the JSON property `errorCode` # @return [String] attr_accessor :error_code # MIME type of file. Defaults to text/html. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type # Static file content to be served for this error. # Corresponds to the JSON property `staticFile` # @return [String] attr_accessor :static_file def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_code = args[:error_code] if args.key?(:error_code) @mime_type = args[:mime_type] if args.key?(:mime_type) @static_file = args[:static_file] if args.key?(:static_file) end end # The feature specific settings to be used in the application. These define # behaviors that are user configurable. class FeatureSettings include Google::Apis::Core::Hashable # Boolean value indicating if split health checks should be used instead of the # legacy health checks. At an app.yaml level, this means defaulting to ' # readiness_check' and 'liveness_check' values instead of 'health_check' ones. # Once the legacy 'health_check' behavior is deprecated, and this value is # always true, this setting can be removed. # Corresponds to the JSON property `splitHealthChecks` # @return [Boolean] attr_accessor :split_health_checks alias_method :split_health_checks?, :split_health_checks def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @split_health_checks = args[:split_health_checks] if args.key?(:split_health_checks) end end # Single source file that is part of the version to be deployed. Each source # file that is deployed must be specified separately. class FileInfo include Google::Apis::Core::Hashable # The MIME type of the file.Defaults to the value from Google Cloud Storage. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type # The SHA1 hash of the file, in hex. # Corresponds to the JSON property `sha1Sum` # @return [String] attr_accessor :sha1_sum # URL source to use to fetch this file. Must be a URL to a resource in Google # Cloud Storage in the form 'http(s)://storage.googleapis.com//'. # Corresponds to the JSON property `sourceUrl` # @return [String] attr_accessor :source_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @mime_type = args[:mime_type] if args.key?(:mime_type) @sha1_sum = args[:sha1_sum] if args.key?(:sha1_sum) @source_url = args[:source_url] if args.key?(:source_url) end end # A single firewall rule that is evaluated against incoming traffic and provides # an action to take on matched requests. class FirewallRule include Google::Apis::Core::Hashable # The action to take on matched requests. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # An optional string description of this rule. This field has a maximum length # of 100 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule # evaluation. Rules with the lowest priority are evaluated first.A default rule # at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous # rule matches. Only the action of this rule can be modified by the user. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority # 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. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001: # db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.

Truncation will be # silently performed on addresses which are not properly truncated. For example, # 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, # 2001:db8::1/32 is accepted as the same address as 2001:db8::/32. # Corresponds to the JSON property `sourceRange` # @return [String] attr_accessor :source_range 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) @priority = args[:priority] if args.key?(:priority) @source_range = args[:source_range] if args.key?(:source_range) end end # Health checking configuration for VM instances. Unhealthy instances are killed # and replaced with new instances. Only applicable for instances in App Engine # flexible environment. class HealthCheck include Google::Apis::Core::Hashable # Interval between health checks. # Corresponds to the JSON property `checkInterval` # @return [String] attr_accessor :check_interval # Whether to explicitly disable health checks for this instance. # Corresponds to the JSON property `disableHealthCheck` # @return [Boolean] attr_accessor :disable_health_check alias_method :disable_health_check?, :disable_health_check # Number of consecutive successful health checks required before receiving # traffic. # Corresponds to the JSON property `healthyThreshold` # @return [Fixnum] attr_accessor :healthy_threshold # Host header to send when performing an HTTP health check. Example: "myapp. # appspot.com" # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # Number of consecutive failed health checks required before an instance is # restarted. # Corresponds to the JSON property `restartThreshold` # @return [Fixnum] attr_accessor :restart_threshold # Time before the health check is considered failed. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout # Number of consecutive failed health checks required before removing traffic. # Corresponds to the JSON property `unhealthyThreshold` # @return [Fixnum] attr_accessor :unhealthy_threshold def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @check_interval = args[:check_interval] if args.key?(:check_interval) @disable_health_check = args[:disable_health_check] if args.key?(:disable_health_check) @healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold) @host = args[:host] if args.key?(:host) @restart_threshold = args[:restart_threshold] if args.key?(:restart_threshold) @timeout = args[:timeout] if args.key?(:timeout) @unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold) end end # Identity-Aware Proxy class IdentityAwareProxy include Google::Apis::Core::Hashable # Whether the serving infrastructure will authenticate and authorize all # incoming requests.If true, the oauth2_client_id and oauth2_client_secret # fields must be non-empty. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # OAuth2 client ID to use for the authentication flow. # Corresponds to the JSON property `oauth2ClientId` # @return [String] attr_accessor :oauth2_client_id # OAuth2 client secret to use for the authentication flow.For security reasons, # this value cannot be retrieved via the API. Instead, the SHA-256 hash of the # value is returned in the oauth2_client_secret_sha256 field.@InputOnly # Corresponds to the JSON property `oauth2ClientSecret` # @return [String] attr_accessor :oauth2_client_secret # Hex-encoded SHA-256 hash of the client secret.@OutputOnly # Corresponds to the JSON property `oauth2ClientSecretSha256` # @return [String] attr_accessor :oauth2_client_secret_sha256 def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enabled = args[:enabled] if args.key?(:enabled) @oauth2_client_id = args[:oauth2_client_id] if args.key?(:oauth2_client_id) @oauth2_client_secret = args[:oauth2_client_secret] if args.key?(:oauth2_client_secret) @oauth2_client_secret_sha256 = args[:oauth2_client_secret_sha256] if args.key?(:oauth2_client_secret_sha256) end end # An Instance resource is the computing unit that App Engine uses to # automatically scale an application. class Instance include Google::Apis::Core::Hashable # App Engine release this instance is running on.@OutputOnly # Corresponds to the JSON property `appEngineRelease` # @return [String] attr_accessor :app_engine_release # Availability of the instance.@OutputOnly # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability # Average latency (ms) over the last minute.@OutputOnly # Corresponds to the JSON property `averageLatency` # @return [Fixnum] attr_accessor :average_latency # Number of errors since this instance was started.@OutputOnly # Corresponds to the JSON property `errors` # @return [Fixnum] attr_accessor :errors # Relative name of the instance within the version. Example: instance-1.@ # OutputOnly # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Total memory in use (bytes).@OutputOnly # Corresponds to the JSON property `memoryUsage` # @return [Fixnum] attr_accessor :memory_usage # Full path to the Instance resource in the API. Example: apps/myapp/services/ # default/versions/v1/instances/instance-1.@OutputOnly # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Average queries per second (QPS) over the last minute.@OutputOnly # Corresponds to the JSON property `qps` # @return [Float] attr_accessor :qps # Number of requests since this instance was started.@OutputOnly # Corresponds to the JSON property `requests` # @return [Fixnum] attr_accessor :requests # Time that this instance was started.@OutputOnly # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Whether this instance is in debug mode. Only applicable for instances in App # Engine flexible environment.@OutputOnly # Corresponds to the JSON property `vmDebugEnabled` # @return [Boolean] attr_accessor :vm_debug_enabled alias_method :vm_debug_enabled?, :vm_debug_enabled # Virtual machine ID of this instance. Only applicable for instances in App # Engine flexible environment.@OutputOnly # Corresponds to the JSON property `vmId` # @return [String] attr_accessor :vm_id # The IP address of this instance. Only applicable for instances in App Engine # flexible environment.@OutputOnly # Corresponds to the JSON property `vmIp` # @return [String] attr_accessor :vm_ip # Name of the virtual machine where this instance lives. Only applicable for # instances in App Engine flexible environment.@OutputOnly # Corresponds to the JSON property `vmName` # @return [String] attr_accessor :vm_name # Status of the virtual machine where this instance lives. Only applicable for # instances in App Engine flexible environment.@OutputOnly # Corresponds to the JSON property `vmStatus` # @return [String] attr_accessor :vm_status # Zone where the virtual machine is located. Only applicable for instances in # App Engine flexible environment.@OutputOnly # Corresponds to the JSON property `vmZoneName` # @return [String] attr_accessor :vm_zone_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @app_engine_release = args[:app_engine_release] if args.key?(:app_engine_release) @availability = args[:availability] if args.key?(:availability) @average_latency = args[:average_latency] if args.key?(:average_latency) @errors = args[:errors] if args.key?(:errors) @id = args[:id] if args.key?(:id) @memory_usage = args[:memory_usage] if args.key?(:memory_usage) @name = args[:name] if args.key?(:name) @qps = args[:qps] if args.key?(:qps) @requests = args[:requests] if args.key?(:requests) @start_time = args[:start_time] if args.key?(:start_time) @vm_debug_enabled = args[:vm_debug_enabled] if args.key?(:vm_debug_enabled) @vm_id = args[:vm_id] if args.key?(:vm_id) @vm_ip = args[:vm_ip] if args.key?(:vm_ip) @vm_name = args[:vm_name] if args.key?(:vm_name) @vm_status = args[:vm_status] if args.key?(:vm_status) @vm_zone_name = args[:vm_zone_name] if args.key?(:vm_zone_name) end end # Third-party Python runtime library that is required by the application. class Library include Google::Apis::Core::Hashable # Name of the library. Example: "django". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Version of the library to select, or "latest". # 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) @name = args[:name] if args.key?(:name) @version = args[:version] if args.key?(:version) end end # Response message for AuthorizedCertificates.ListAuthorizedCertificates. class ListAuthorizedCertificatesResponse include Google::Apis::Core::Hashable # The SSL certificates the user is authorized to administer. # Corresponds to the JSON property `certificates` # @return [Array] attr_accessor :certificates # Continuation token for fetching 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) @certificates = args[:certificates] if args.key?(:certificates) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for AuthorizedDomains.ListAuthorizedDomains. class ListAuthorizedDomainsResponse include Google::Apis::Core::Hashable # The authorized domains belonging to the user. # Corresponds to the JSON property `domains` # @return [Array] attr_accessor :domains # Continuation token for fetching 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) @domains = args[:domains] if args.key?(:domains) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for DomainMappings.ListDomainMappings. class ListDomainMappingsResponse include Google::Apis::Core::Hashable # The domain mappings for the application. # Corresponds to the JSON property `domainMappings` # @return [Array] attr_accessor :domain_mappings # Continuation token for fetching 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) @domain_mappings = args[:domain_mappings] if args.key?(:domain_mappings) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for Firewall.ListIngressRules. class ListIngressRulesResponse include Google::Apis::Core::Hashable # The ingress FirewallRules for this application. # Corresponds to the JSON property `ingressRules` # @return [Array] attr_accessor :ingress_rules # Continuation token for fetching 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) @ingress_rules = args[:ingress_rules] if args.key?(:ingress_rules) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for Instances.ListInstances. class ListInstancesResponse include Google::Apis::Core::Hashable # The instances belonging to the requested version. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances # Continuation token for fetching 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) @instances = args[:instances] if args.key?(:instances) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Locations.ListLocations. class ListLocationsResponse include Google::Apis::Core::Hashable # A list of locations that matches the specified filter in the request. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # The standard List next-page token. # 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) @locations = args[:locations] if args.key?(:locations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Operations.ListOperations. class ListOperationsResponse 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 # Response message for Services.ListServices. class ListServicesResponse include Google::Apis::Core::Hashable # Continuation token for fetching the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The services belonging to the requested application. # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @services = args[:services] if args.key?(:services) end end # Response message for Versions.ListVersions. class ListVersionsResponse include Google::Apis::Core::Hashable # Continuation token for fetching the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The versions belonging to the requested service. # Corresponds to the JSON property `versions` # @return [Array] attr_accessor :versions 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) @versions = args[:versions] if args.key?(:versions) end end # Health checking configuration for VM instances. Unhealthy instances are killed # and replaced with new instances. class LivenessCheck include Google::Apis::Core::Hashable # Interval between health checks. # Corresponds to the JSON property `checkInterval` # @return [String] attr_accessor :check_interval # Number of consecutive failed checks required before considering the VM # unhealthy. # Corresponds to the JSON property `failureThreshold` # @return [Fixnum] attr_accessor :failure_threshold # Host header to send when performing a HTTP Liveness check. Example: "myapp. # appspot.com" # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # The initial delay before starting to execute the checks. # Corresponds to the JSON property `initialDelay` # @return [String] attr_accessor :initial_delay # The request path. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # Number of consecutive successful checks required before considering the VM # healthy. # Corresponds to the JSON property `successThreshold` # @return [Fixnum] attr_accessor :success_threshold # Time before the check is considered failed. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @check_interval = args[:check_interval] if args.key?(:check_interval) @failure_threshold = args[:failure_threshold] if args.key?(:failure_threshold) @host = args[:host] if args.key?(:host) @initial_delay = args[:initial_delay] if args.key?(:initial_delay) @path = args[:path] if args.key?(:path) @success_threshold = args[:success_threshold] if args.key?(:success_threshold) @timeout = args[:timeout] if args.key?(:timeout) end end # A resource that represents Google Cloud Platform location. class Location include Google::Apis::Core::Hashable # Cross-service attributes for the location. For example # `"cloud.googleapis.com/region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The canonical id for this location. For example: "us-east1". # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Service-specific metadata. For example the available capacity at the given # location. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # Resource name for the location, which may vary between implementations. For # example: "projects/example-project/locations/us-east1" # 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) @labels = args[:labels] if args.key?(:labels) @location_id = args[:location_id] if args.key?(:location_id) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) end end # Metadata for the given google.cloud.location.Location. class LocationMetadata include Google::Apis::Core::Hashable # App Engine flexible environment is available in the given location.@OutputOnly # Corresponds to the JSON property `flexibleEnvironmentAvailable` # @return [Boolean] attr_accessor :flexible_environment_available alias_method :flexible_environment_available?, :flexible_environment_available # App Engine standard environment is available in the given location.@OutputOnly # Corresponds to the JSON property `standardEnvironmentAvailable` # @return [Boolean] attr_accessor :standard_environment_available alias_method :standard_environment_available?, :standard_environment_available def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @flexible_environment_available = args[:flexible_environment_available] if args.key?(:flexible_environment_available) @standard_environment_available = args[:standard_environment_available] if args.key?(:standard_environment_available) end end # A service with manual scaling runs continuously, allowing you to perform # complex initialization and rely on the state of its memory over time. class ManualScaling include Google::Apis::Core::Hashable # Number of instances to assign to the service at the start. This number can # later be altered by using the Modules API (https://cloud.google.com/appengine/ # docs/python/modules/functions) set_num_instances() function. # Corresponds to the JSON property `instances` # @return [Fixnum] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # Extra network settings. Only applicable in the App Engine flexible environment. class Network include Google::Apis::Core::Hashable # List of ports, or port pairs, to forward from the virtual machine to the # application container. Only applicable in the App Engine flexible environment. # Corresponds to the JSON property `forwardedPorts` # @return [Array] attr_accessor :forwarded_ports # Tag to apply to the instance during creation. Only applicable in the App # Engine flexible environment. # Corresponds to the JSON property `instanceTag` # @return [String] attr_accessor :instance_tag # Google Compute Engine network where the virtual machines are created. Specify # the short name, not the resource path.Defaults to default. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Google Cloud Platform sub-network where the virtual machines are created. # Specify the short name, not the resource path.If a subnetwork name is # specified, a network name will also be required unless it is for the default # network. # If the network that the instance is being created in is a Legacy network, then # the IP address is allocated from the IPv4Range. # If the network that the instance is being created in is an auto Subnet Mode # Network, then only network name should be specified (not the subnetwork_name) # and the IP address is created from the IPCidrRange of the subnetwork that # exists in that zone for that network. # If the network that the instance is being created in is a custom Subnet Mode # Network, then the subnetwork_name must be specified and the IP address is # created from the IPCidrRange of the subnetwork.If specified, the subnetwork # must exist in the same region as the App Engine flexible environment # application. # Corresponds to the JSON property `subnetworkName` # @return [String] attr_accessor :subnetwork_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @forwarded_ports = args[:forwarded_ports] if args.key?(:forwarded_ports) @instance_tag = args[:instance_tag] if args.key?(:instance_tag) @name = args[:name] if args.key?(:name) @subnetwork_name = args[:subnetwork_name] if args.key?(:subnetwork_name) end end # Target scaling by network usage. Only applicable in the App Engine flexible # environment. class NetworkUtilization include Google::Apis::Core::Hashable # Target bytes received per second. # Corresponds to the JSON property `targetReceivedBytesPerSecond` # @return [Fixnum] attr_accessor :target_received_bytes_per_second # Target packets received per second. # Corresponds to the JSON property `targetReceivedPacketsPerSecond` # @return [Fixnum] attr_accessor :target_received_packets_per_second # Target bytes sent per second. # Corresponds to the JSON property `targetSentBytesPerSecond` # @return [Fixnum] attr_accessor :target_sent_bytes_per_second # Target packets sent per second. # Corresponds to the JSON property `targetSentPacketsPerSecond` # @return [Fixnum] attr_accessor :target_sent_packets_per_second def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @target_received_bytes_per_second = args[:target_received_bytes_per_second] if args.key?(:target_received_bytes_per_second) @target_received_packets_per_second = args[:target_received_packets_per_second] if args.key?(:target_received_packets_per_second) @target_sent_bytes_per_second = args[:target_sent_bytes_per_second] if args.key?(:target_sent_bytes_per_second) @target_sent_packets_per_second = args[:target_sent_packets_per_second] if args.key?(:target_sent_packets_per_second) 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). The error model is designed to be: # Simple to use and understand for most users # Flexible enough to meet unexpected needsOverviewThe Status message contains # three pieces of data: error code, error message, and error details. The error # code should be an enum value of google.rpc.Code, but it may accept additional # error codes if needed. The error message should be a developer-facing English # message that helps developers understand and resolve the error. If a localized # user-facing error message is needed, put the localized message in the error # details or localize it in the client. The optional error details may contain # arbitrary information about the error. There is a predefined set of error # detail types in the package google.rpc that can be used for common error # conditions.Language mappingThe Status message is the logical representation of # the error model, but it is not necessarily the actual wire format. When the # Status message is exposed in different client libraries and different wire # protocols, it can be mapped differently. For example, it will likely be mapped # to some exceptions in Java, but more likely mapped to some error codes in C. # Other usesThe error model and the Status message can be used in a variety of # environments, either with or without APIs, to provide a consistent developer # experience across different environments.Example uses of this error model # include: # Partial errors. If a service needs to return partial errors to the client, it # may embed the Status in the normal response to indicate the partial errors. # Workflow errors. A typical workflow has multiple steps. Each step may have a # Status message for error reporting. # Batch operations. If a client uses batch request and batch response, the # Status message should be used directly inside batch response, one for each # error sub-response. # Asynchronous operations. If an API call embeds asynchronous operation results # in its response, the status of those operations should be represented directly # using the Status message. # Logging. If some API errors are stored in logs, the message Status could be # used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::AppengineV1::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 # have the format of operations/some/unique/name. # 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 # Metadata for the given google.longrunning.Operation. class OperationMetadata include Google::Apis::Core::Hashable # Timestamp that this operation completed.@OutputOnly # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Timestamp that this operation was created.@OutputOnly # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # API method that initiated this operation. Example: google.appengine.v1beta4. # Version.CreateVersion.@OutputOnly # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # Type of this operation. Deprecated, use method field instead. Example: " # create_version".@OutputOnly # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # Name of the resource that this operation is acting on. Example: apps/myapp/ # modules/default.@OutputOnly # Corresponds to the JSON property `target` # @return [String] attr_accessor :target # User who requested this operation.@OutputOnly # Corresponds to the JSON property `user` # @return [String] attr_accessor :user def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_time = args[:end_time] if args.key?(:end_time) @insert_time = args[:insert_time] if args.key?(:insert_time) @method_prop = args[:method_prop] if args.key?(:method_prop) @operation_type = args[:operation_type] if args.key?(:operation_type) @target = args[:target] if args.key?(:target) @user = args[:user] if args.key?(:user) end end # Metadata for the given google.longrunning.Operation. class OperationMetadataV1 include Google::Apis::Core::Hashable # Time that this operation completed.@OutputOnly # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Ephemeral message that may change every time the operation is polled. @ # OutputOnly # Corresponds to the JSON property `ephemeralMessage` # @return [String] attr_accessor :ephemeral_message # Time that this operation was created.@OutputOnly # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # API method that initiated this operation. Example: google.appengine.v1. # Versions.CreateVersion.@OutputOnly # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # Name of the resource that this operation is acting on. Example: apps/myapp/ # services/default.@OutputOnly # Corresponds to the JSON property `target` # @return [String] attr_accessor :target # User who requested this operation.@OutputOnly # Corresponds to the JSON property `user` # @return [String] attr_accessor :user # Durable messages that persist on every operation poll. @OutputOnly # Corresponds to the JSON property `warning` # @return [Array] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_time = args[:end_time] if args.key?(:end_time) @ephemeral_message = args[:ephemeral_message] if args.key?(:ephemeral_message) @insert_time = args[:insert_time] if args.key?(:insert_time) @method_prop = args[:method_prop] if args.key?(:method_prop) @target = args[:target] if args.key?(:target) @user = args[:user] if args.key?(:user) @warning = args[:warning] if args.key?(:warning) end end # Metadata for the given google.longrunning.Operation. class OperationMetadataV1Alpha include Google::Apis::Core::Hashable # Metadata for the given google.longrunning.Operation during a google.appengine. # v1alpha.CreateVersionRequest. # Corresponds to the JSON property `createVersionMetadata` # @return [Google::Apis::AppengineV1::CreateVersionMetadataV1Alpha] attr_accessor :create_version_metadata # Time that this operation completed.@OutputOnly # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Ephemeral message that may change every time the operation is polled. @ # OutputOnly # Corresponds to the JSON property `ephemeralMessage` # @return [String] attr_accessor :ephemeral_message # Time that this operation was created.@OutputOnly # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # API method that initiated this operation. Example: google.appengine.v1alpha. # Versions.CreateVersion.@OutputOnly # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # Name of the resource that this operation is acting on. Example: apps/myapp/ # services/default.@OutputOnly # Corresponds to the JSON property `target` # @return [String] attr_accessor :target # User who requested this operation.@OutputOnly # Corresponds to the JSON property `user` # @return [String] attr_accessor :user # Durable messages that persist on every operation poll. @OutputOnly # Corresponds to the JSON property `warning` # @return [Array] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_version_metadata = args[:create_version_metadata] if args.key?(:create_version_metadata) @end_time = args[:end_time] if args.key?(:end_time) @ephemeral_message = args[:ephemeral_message] if args.key?(:ephemeral_message) @insert_time = args[:insert_time] if args.key?(:insert_time) @method_prop = args[:method_prop] if args.key?(:method_prop) @target = args[:target] if args.key?(:target) @user = args[:user] if args.key?(:user) @warning = args[:warning] if args.key?(:warning) end end # Metadata for the given google.longrunning.Operation. class OperationMetadataV1Beta include Google::Apis::Core::Hashable # Metadata for the given google.longrunning.Operation during a google.appengine. # v1beta.CreateVersionRequest. # Corresponds to the JSON property `createVersionMetadata` # @return [Google::Apis::AppengineV1::CreateVersionMetadataV1Beta] attr_accessor :create_version_metadata # Time that this operation completed.@OutputOnly # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Ephemeral message that may change every time the operation is polled. @ # OutputOnly # Corresponds to the JSON property `ephemeralMessage` # @return [String] attr_accessor :ephemeral_message # Time that this operation was created.@OutputOnly # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # API method that initiated this operation. Example: google.appengine.v1beta. # Versions.CreateVersion.@OutputOnly # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # Name of the resource that this operation is acting on. Example: apps/myapp/ # services/default.@OutputOnly # Corresponds to the JSON property `target` # @return [String] attr_accessor :target # User who requested this operation.@OutputOnly # Corresponds to the JSON property `user` # @return [String] attr_accessor :user # Durable messages that persist on every operation poll. @OutputOnly # Corresponds to the JSON property `warning` # @return [Array] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_version_metadata = args[:create_version_metadata] if args.key?(:create_version_metadata) @end_time = args[:end_time] if args.key?(:end_time) @ephemeral_message = args[:ephemeral_message] if args.key?(:ephemeral_message) @insert_time = args[:insert_time] if args.key?(:insert_time) @method_prop = args[:method_prop] if args.key?(:method_prop) @target = args[:target] if args.key?(:target) @user = args[:user] if args.key?(:user) @warning = args[:warning] if args.key?(:warning) end end # Metadata for the given google.longrunning.Operation. class OperationMetadataV1Beta5 include Google::Apis::Core::Hashable # Timestamp that this operation completed.@OutputOnly # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Timestamp that this operation was created.@OutputOnly # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # API method name that initiated this operation. Example: google.appengine. # v1beta5.Version.CreateVersion.@OutputOnly # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # Name of the resource that this operation is acting on. Example: apps/myapp/ # services/default.@OutputOnly # Corresponds to the JSON property `target` # @return [String] attr_accessor :target # User who requested this operation.@OutputOnly # Corresponds to the JSON property `user` # @return [String] attr_accessor :user def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_time = args[:end_time] if args.key?(:end_time) @insert_time = args[:insert_time] if args.key?(:insert_time) @method_prop = args[:method_prop] if args.key?(:method_prop) @target = args[:target] if args.key?(:target) @user = args[:user] if args.key?(:user) end end # Readiness checking configuration for VM instances. Unhealthy instances are # removed from traffic rotation. class ReadinessCheck include Google::Apis::Core::Hashable # A maximum time limit on application initialization, measured from moment the # application successfully replies to a healthcheck until it is ready to serve # traffic. # Corresponds to the JSON property `appStartTimeout` # @return [String] attr_accessor :app_start_timeout # Interval between health checks. # Corresponds to the JSON property `checkInterval` # @return [String] attr_accessor :check_interval # Number of consecutive failed checks required before removing traffic. # Corresponds to the JSON property `failureThreshold` # @return [Fixnum] attr_accessor :failure_threshold # Host header to send when performing a HTTP Readiness check. Example: "myapp. # appspot.com" # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # The request path. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # Number of consecutive successful checks required before receiving traffic. # Corresponds to the JSON property `successThreshold` # @return [Fixnum] attr_accessor :success_threshold # Time before the check is considered failed. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @app_start_timeout = args[:app_start_timeout] if args.key?(:app_start_timeout) @check_interval = args[:check_interval] if args.key?(:check_interval) @failure_threshold = args[:failure_threshold] if args.key?(:failure_threshold) @host = args[:host] if args.key?(:host) @path = args[:path] if args.key?(:path) @success_threshold = args[:success_threshold] if args.key?(:success_threshold) @timeout = args[:timeout] if args.key?(:timeout) end end # Request message for 'Applications.RepairApplication'. class RepairApplicationRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Target scaling by request utilization. Only applicable in the App Engine # flexible environment. class RequestUtilization include Google::Apis::Core::Hashable # Target number of concurrent requests. # Corresponds to the JSON property `targetConcurrentRequests` # @return [Fixnum] attr_accessor :target_concurrent_requests # Target requests per second. # Corresponds to the JSON property `targetRequestCountPerSecond` # @return [Fixnum] attr_accessor :target_request_count_per_second def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @target_concurrent_requests = args[:target_concurrent_requests] if args.key?(:target_concurrent_requests) @target_request_count_per_second = args[:target_request_count_per_second] if args.key?(:target_request_count_per_second) end end # A DNS resource record. class ResourceRecord include Google::Apis::Core::Hashable # Relative name of the object affected by this record. Only applicable for CNAME # records. Example: 'www'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Data for this record. Values vary by record type, as defined in RFC 1035 ( # section 5) and RFC 1034 (section 3.6.1). # Corresponds to the JSON property `rrdata` # @return [String] attr_accessor :rrdata # Resource record type. Example: AAAA. # 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) @rrdata = args[:rrdata] if args.key?(:rrdata) @type = args[:type] if args.key?(:type) end end # Machine resources for a version. class Resources include Google::Apis::Core::Hashable # Number of CPU cores needed. # Corresponds to the JSON property `cpu` # @return [Float] attr_accessor :cpu # Disk size (GB) needed. # Corresponds to the JSON property `diskGb` # @return [Float] attr_accessor :disk_gb # Memory (GB) needed. # Corresponds to the JSON property `memoryGb` # @return [Float] attr_accessor :memory_gb # User specified volumes. # Corresponds to the JSON property `volumes` # @return [Array] attr_accessor :volumes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cpu = args[:cpu] if args.key?(:cpu) @disk_gb = args[:disk_gb] if args.key?(:disk_gb) @memory_gb = args[:memory_gb] if args.key?(:memory_gb) @volumes = args[:volumes] if args.key?(:volumes) end end # Executes a script to handle the request that matches the URL pattern. class ScriptHandler include Google::Apis::Core::Hashable # Path to the script from the application root directory. # Corresponds to the JSON property `scriptPath` # @return [String] attr_accessor :script_path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @script_path = args[:script_path] if args.key?(:script_path) end end # A Service resource is a logical component of an application that can share # state and communicate in a secure fashion with other services. For example, an # application that handles customer requests might include separate services to # handle tasks such as backend data analysis or API requests from mobile devices. # Each service has a collection of versions that define a specific set of code # used to implement the functionality of that service. class Service include Google::Apis::Core::Hashable # Relative name of the service within the application. Example: default.@ # OutputOnly # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Full path to the Service resource in the API. Example: apps/myapp/services/ # default.@OutputOnly # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Traffic routing configuration for versions within a single service. Traffic # splits define how traffic directed to the service is assigned to versions. # Corresponds to the JSON property `split` # @return [Google::Apis::AppengineV1::TrafficSplit] attr_accessor :split def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @split = args[:split] if args.key?(:split) end end # SSL configuration for a DomainMapping resource. class SslSettings include Google::Apis::Core::Hashable # ID of the AuthorizedCertificate resource configuring SSL for the application. # Clearing this field will remove SSL support. Example: 12345. # Corresponds to the JSON property `certificateId` # @return [String] attr_accessor :certificate_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @certificate_id = args[:certificate_id] if args.key?(:certificate_id) end end # Scheduler settings for standard environment. class StandardSchedulerSettings include Google::Apis::Core::Hashable # Maximum number of instances to run for this version. Set to zero to disable # max_instances configuration. # Corresponds to the JSON property `maxInstances` # @return [Fixnum] attr_accessor :max_instances # Minimum number of instances to run for this version. Set to zero to disable # min_instances configuration. # Corresponds to the JSON property `minInstances` # @return [Fixnum] attr_accessor :min_instances # Target CPU utilization ratio to maintain when scaling. # Corresponds to the JSON property `targetCpuUtilization` # @return [Float] attr_accessor :target_cpu_utilization # Target throughput utilization ratio to maintain when scaling # Corresponds to the JSON property `targetThroughputUtilization` # @return [Float] attr_accessor :target_throughput_utilization def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_instances = args[:max_instances] if args.key?(:max_instances) @min_instances = args[:min_instances] if args.key?(:min_instances) @target_cpu_utilization = args[:target_cpu_utilization] if args.key?(:target_cpu_utilization) @target_throughput_utilization = args[:target_throughput_utilization] if args.key?(:target_throughput_utilization) end end # Files served directly to the user for a given URL, such as images, CSS # stylesheets, or JavaScript source files. Static file handlers describe which # files in the application directory are static files, and which URLs serve them. class StaticFilesHandler include Google::Apis::Core::Hashable # Whether files should also be uploaded as code data. By default, files declared # in static file handlers are uploaded as static data and are only served to end # users; they cannot be read by the application. If enabled, uploads are charged # against both your code and static data storage resource quotas. # Corresponds to the JSON property `applicationReadable` # @return [Boolean] attr_accessor :application_readable alias_method :application_readable?, :application_readable # Time a static file served by this handler should be cached by web proxies and # browsers. # Corresponds to the JSON property `expiration` # @return [String] attr_accessor :expiration # HTTP headers to use for all responses from these URLs. # Corresponds to the JSON property `httpHeaders` # @return [Hash] attr_accessor :http_headers # MIME type used to serve all files served by this handler.Defaults to file- # specific MIME types, which are derived from each file's filename extension. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type # Path to the static files matched by the URL pattern, from the application root # directory. The path can refer to text matched in groupings in the URL pattern. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # Whether this handler should match the request if the file referenced by the # handler does not exist. # Corresponds to the JSON property `requireMatchingFile` # @return [Boolean] attr_accessor :require_matching_file alias_method :require_matching_file?, :require_matching_file # Regular expression that matches the file paths for all files that should be # referenced by this handler. # Corresponds to the JSON property `uploadPathRegex` # @return [String] attr_accessor :upload_path_regex def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @application_readable = args[:application_readable] if args.key?(:application_readable) @expiration = args[:expiration] if args.key?(:expiration) @http_headers = args[:http_headers] if args.key?(:http_headers) @mime_type = args[:mime_type] if args.key?(:mime_type) @path = args[:path] if args.key?(:path) @require_matching_file = args[:require_matching_file] if args.key?(:require_matching_file) @upload_path_regex = args[:upload_path_regex] if args.key?(:upload_path_regex) 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). The error model is designed to be: # Simple to use and understand for most users # Flexible enough to meet unexpected needsOverviewThe Status message contains # three pieces of data: error code, error message, and error details. The error # code should be an enum value of google.rpc.Code, but it may accept additional # error codes if needed. The error message should be a developer-facing English # message that helps developers understand and resolve the error. If a localized # user-facing error message is needed, put the localized message in the error # details or localize it in the client. The optional error details may contain # arbitrary information about the error. There is a predefined set of error # detail types in the package google.rpc that can be used for common error # conditions.Language mappingThe Status message is the logical representation of # the error model, but it is not necessarily the actual wire format. When the # Status message is exposed in different client libraries and different wire # protocols, it can be mapped differently. For example, it will likely be mapped # to some exceptions in Java, but more likely mapped to some error codes in C. # Other usesThe error model and the Status message can be used in a variety of # environments, either with or without APIs, to provide a consistent developer # experience across different environments.Example uses of this error model # include: # Partial errors. If a service needs to return partial errors to the client, it # may embed the Status in the normal response to indicate the partial errors. # Workflow errors. A typical workflow has multiple steps. Each step may have a # Status message for error reporting. # Batch operations. If a client uses batch request and batch response, the # Status message should be used directly inside batch response, one for each # error sub-response. # Asynchronous operations. If an API call embeds asynchronous operation results # in its response, the status of those operations should be represented directly # using the Status message. # Logging. If some API errors are stored in logs, the message Status could be # used directly after any stripping needed for security/privacy reasons. class Status 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 # Traffic routing configuration for versions within a single service. Traffic # splits define how traffic directed to the service is assigned to versions. class TrafficSplit include Google::Apis::Core::Hashable # Mapping from version IDs within the service to fractional (0.000, 1] # allocations of traffic for that version. Each version can be specified only # once, but some versions in the service may not have any traffic allocation. # Services that have traffic allocated cannot be deleted until either the # service is deleted or their traffic allocation is removed. Allocations must # sum to 1. Up to two decimal place precision is supported for IP-based splits # and up to three decimal places is supported for cookie-based splits. # Corresponds to the JSON property `allocations` # @return [Hash] attr_accessor :allocations # Mechanism used to determine which version a request is sent to. The traffic # selection algorithm will be stable for either type until allocations are # changed. # Corresponds to the JSON property `shardBy` # @return [String] attr_accessor :shard_by def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allocations = args[:allocations] if args.key?(:allocations) @shard_by = args[:shard_by] if args.key?(:shard_by) end end # Rules to match an HTTP request and dispatch that request to a service. class UrlDispatchRule include Google::Apis::Core::Hashable # Domain name to match against. The wildcard "*" is supported if specified # before a period: "*.".Defaults to matching all domains: "*". # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # Pathname within the host. Must start with a "/". A single "*" can be included # at the end of the path.The sum of the lengths of the domain and path may not # exceed 100 characters. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # Resource ID of a service in this application that should serve the matched # request. The service must already exist. Example: default. # 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) @domain = args[:domain] if args.key?(:domain) @path = args[:path] if args.key?(:path) @service = args[:service] if args.key?(:service) end end # URL pattern and description of how the URL should be handled. App Engine can # handle URLs by executing application code or by serving static files uploaded # with the version, such as images, CSS, or JavaScript. class UrlMap include Google::Apis::Core::Hashable # Uses Google Cloud Endpoints to handle requests. # Corresponds to the JSON property `apiEndpoint` # @return [Google::Apis::AppengineV1::ApiEndpointHandler] attr_accessor :api_endpoint # Action to take when users access resources that require authentication. # Defaults to redirect. # Corresponds to the JSON property `authFailAction` # @return [String] attr_accessor :auth_fail_action # Level of login required to access this resource. # Corresponds to the JSON property `login` # @return [String] attr_accessor :login # 30x code to use when performing redirects for the secure field. Defaults to # 302. # Corresponds to the JSON property `redirectHttpResponseCode` # @return [String] attr_accessor :redirect_http_response_code # Executes a script to handle the request that matches the URL pattern. # Corresponds to the JSON property `script` # @return [Google::Apis::AppengineV1::ScriptHandler] attr_accessor :script # Security (HTTPS) enforcement for this URL. # Corresponds to the JSON property `securityLevel` # @return [String] attr_accessor :security_level # Files served directly to the user for a given URL, such as images, CSS # stylesheets, or JavaScript source files. Static file handlers describe which # files in the application directory are static files, and which URLs serve them. # Corresponds to the JSON property `staticFiles` # @return [Google::Apis::AppengineV1::StaticFilesHandler] attr_accessor :static_files # URL prefix. Uses regular expression syntax, which means regexp special # characters must be escaped, but should not contain groupings. All URLs that # begin with this prefix are handled by this handler, using the portion of the # URL after the prefix as part of the file path. # Corresponds to the JSON property `urlRegex` # @return [String] attr_accessor :url_regex def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @api_endpoint = args[:api_endpoint] if args.key?(:api_endpoint) @auth_fail_action = args[:auth_fail_action] if args.key?(:auth_fail_action) @login = args[:login] if args.key?(:login) @redirect_http_response_code = args[:redirect_http_response_code] if args.key?(:redirect_http_response_code) @script = args[:script] if args.key?(:script) @security_level = args[:security_level] if args.key?(:security_level) @static_files = args[:static_files] if args.key?(:static_files) @url_regex = args[:url_regex] if args.key?(:url_regex) end end # A Version resource is a specific set of source code and configuration files # that are deployed into a service. class Version include Google::Apis::Core::Hashable # Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/ # endpoints/) configuration for API handlers. # Corresponds to the JSON property `apiConfig` # @return [Google::Apis::AppengineV1::ApiConfigHandler] attr_accessor :api_config # Automatic scaling is based on request rate, response latencies, and other # application metrics. # Corresponds to the JSON property `automaticScaling` # @return [Google::Apis::AppengineV1::AutomaticScaling] attr_accessor :automatic_scaling # A service with basic scaling will create an instance when the application # receives a request. The instance will be turned down when the app becomes idle. # Basic scaling is ideal for work that is intermittent or driven by user # activity. # Corresponds to the JSON property `basicScaling` # @return [Google::Apis::AppengineV1::BasicScaling] attr_accessor :basic_scaling # Metadata settings that are supplied to this version to enable beta runtime # features. # Corresponds to the JSON property `betaSettings` # @return [Hash] attr_accessor :beta_settings # Time that this version was created.@OutputOnly # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Email address of the user who created this version.@OutputOnly # Corresponds to the JSON property `createdBy` # @return [String] attr_accessor :created_by # Duration that static files should be cached by web proxies and browsers. Only # applicable if the corresponding StaticFilesHandler (https://cloud.google.com/ # appengine/docs/admin-api/reference/rest/v1/apps.services.versions# # staticfileshandler) does not specify its own expiration time.Only returned in # GET requests if view=FULL is set. # Corresponds to the JSON property `defaultExpiration` # @return [String] attr_accessor :default_expiration # Code and application artifacts used to deploy a version to App Engine. # Corresponds to the JSON property `deployment` # @return [Google::Apis::AppengineV1::Deployment] attr_accessor :deployment # Total size in bytes of all the files that are included in this version and # currently hosted on the App Engine disk.@OutputOnly # Corresponds to the JSON property `diskUsageBytes` # @return [Fixnum] attr_accessor :disk_usage_bytes # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The # Endpoints API Service provides tooling for serving Open API and gRPC endpoints # via an NGINX proxy.The fields here refer to the name and configuration id of a # "service" resource in the Service Management API (https://cloud.google.com/ # service-management/overview). # Corresponds to the JSON property `endpointsApiService` # @return [Google::Apis::AppengineV1::EndpointsApiService] attr_accessor :endpoints_api_service # App Engine execution environment for this version.Defaults to standard. # Corresponds to the JSON property `env` # @return [String] attr_accessor :env # Environment variables available to the application.Only returned in GET # requests if view=FULL is set. # Corresponds to the JSON property `envVariables` # @return [Hash] attr_accessor :env_variables # Custom static error pages. Limited to 10KB per page.Only returned in GET # requests if view=FULL is set. # Corresponds to the JSON property `errorHandlers` # @return [Array] attr_accessor :error_handlers # An ordered list of URL-matching patterns that should be applied to incoming # requests. The first matching URL handles the request and other request # handlers are not attempted.Only returned in GET requests if view=FULL is set. # Corresponds to the JSON property `handlers` # @return [Array] attr_accessor :handlers # Health checking configuration for VM instances. Unhealthy instances are killed # and replaced with new instances. Only applicable for instances in App Engine # flexible environment. # Corresponds to the JSON property `healthCheck` # @return [Google::Apis::AppengineV1::HealthCheck] attr_accessor :health_check # Relative name of the version within the service. Example: v1. Version names # can contain only lowercase letters, numbers, or hyphens. Reserved names: " # default", "latest", and any name with the prefix "ah-". # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Before an application can receive email or XMPP messages, the application must # be configured to enable the service. # Corresponds to the JSON property `inboundServices` # @return [Array] attr_accessor :inbound_services # Instance class that is used to run this version. Valid values are: # AutomaticScaling: F1, F2, F4, F4_1G # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for # AutomaticScaling and B1 for ManualScaling or BasicScaling. # Corresponds to the JSON property `instanceClass` # @return [String] attr_accessor :instance_class # Configuration for third-party Python runtime libraries that are required by # the application.Only returned in GET requests if view=FULL is set. # Corresponds to the JSON property `libraries` # @return [Array] attr_accessor :libraries # Health checking configuration for VM instances. Unhealthy instances are killed # and replaced with new instances. # Corresponds to the JSON property `livenessCheck` # @return [Google::Apis::AppengineV1::LivenessCheck] attr_accessor :liveness_check # A service with manual scaling runs continuously, allowing you to perform # complex initialization and rely on the state of its memory over time. # Corresponds to the JSON property `manualScaling` # @return [Google::Apis::AppengineV1::ManualScaling] attr_accessor :manual_scaling # Full path to the Version resource in the API. Example: apps/myapp/services/ # default/versions/v1.@OutputOnly # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Extra network settings. Only applicable in the App Engine flexible environment. # Corresponds to the JSON property `network` # @return [Google::Apis::AppengineV1::Network] attr_accessor :network # Files that match this pattern will not be built into this version. Only # applicable for Go runtimes.Only returned in GET requests if view=FULL is set. # Corresponds to the JSON property `nobuildFilesRegex` # @return [String] attr_accessor :nobuild_files_regex # Readiness checking configuration for VM instances. Unhealthy instances are # removed from traffic rotation. # Corresponds to the JSON property `readinessCheck` # @return [Google::Apis::AppengineV1::ReadinessCheck] attr_accessor :readiness_check # Machine resources for a version. # Corresponds to the JSON property `resources` # @return [Google::Apis::AppengineV1::Resources] attr_accessor :resources # Desired runtime. Example: python27. # Corresponds to the JSON property `runtime` # @return [String] attr_accessor :runtime # The version of the API in the given runtime environment. Please see the app. # yaml reference for valid values at https://cloud.google.com/appengine/docs/ # standard//config/appref # Corresponds to the JSON property `runtimeApiVersion` # @return [String] attr_accessor :runtime_api_version # The channel of the runtime to use. Only available for some runtimes. Defaults # to the default channel. # Corresponds to the JSON property `runtimeChannel` # @return [String] attr_accessor :runtime_channel # Current serving status of this version. Only the versions with a SERVING # status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an # invalid value. Defaults to SERVING. # Corresponds to the JSON property `servingStatus` # @return [String] attr_accessor :serving_status # Whether multiple requests can be dispatched to this version at once. # Corresponds to the JSON property `threadsafe` # @return [Boolean] attr_accessor :threadsafe alias_method :threadsafe?, :threadsafe # Serving URL for this version. Example: "https://myversion-dot-myservice-dot- # myapp.appspot.com"@OutputOnly # Corresponds to the JSON property `versionUrl` # @return [String] attr_accessor :version_url # Whether to deploy this version in a container on a virtual machine. # Corresponds to the JSON property `vm` # @return [Boolean] attr_accessor :vm alias_method :vm?, :vm # The Google Compute Engine zones that are supported by this version in the App # Engine flexible environment. # 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) @api_config = args[:api_config] if args.key?(:api_config) @automatic_scaling = args[:automatic_scaling] if args.key?(:automatic_scaling) @basic_scaling = args[:basic_scaling] if args.key?(:basic_scaling) @beta_settings = args[:beta_settings] if args.key?(:beta_settings) @create_time = args[:create_time] if args.key?(:create_time) @created_by = args[:created_by] if args.key?(:created_by) @default_expiration = args[:default_expiration] if args.key?(:default_expiration) @deployment = args[:deployment] if args.key?(:deployment) @disk_usage_bytes = args[:disk_usage_bytes] if args.key?(:disk_usage_bytes) @endpoints_api_service = args[:endpoints_api_service] if args.key?(:endpoints_api_service) @env = args[:env] if args.key?(:env) @env_variables = args[:env_variables] if args.key?(:env_variables) @error_handlers = args[:error_handlers] if args.key?(:error_handlers) @handlers = args[:handlers] if args.key?(:handlers) @health_check = args[:health_check] if args.key?(:health_check) @id = args[:id] if args.key?(:id) @inbound_services = args[:inbound_services] if args.key?(:inbound_services) @instance_class = args[:instance_class] if args.key?(:instance_class) @libraries = args[:libraries] if args.key?(:libraries) @liveness_check = args[:liveness_check] if args.key?(:liveness_check) @manual_scaling = args[:manual_scaling] if args.key?(:manual_scaling) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @nobuild_files_regex = args[:nobuild_files_regex] if args.key?(:nobuild_files_regex) @readiness_check = args[:readiness_check] if args.key?(:readiness_check) @resources = args[:resources] if args.key?(:resources) @runtime = args[:runtime] if args.key?(:runtime) @runtime_api_version = args[:runtime_api_version] if args.key?(:runtime_api_version) @runtime_channel = args[:runtime_channel] if args.key?(:runtime_channel) @serving_status = args[:serving_status] if args.key?(:serving_status) @threadsafe = args[:threadsafe] if args.key?(:threadsafe) @version_url = args[:version_url] if args.key?(:version_url) @vm = args[:vm] if args.key?(:vm) @zones = args[:zones] if args.key?(:zones) end end # Volumes mounted within the app container. Only applicable in the App Engine # flexible environment. class Volume include Google::Apis::Core::Hashable # Unique name for the volume. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Volume size in gigabytes. # Corresponds to the JSON property `sizeGb` # @return [Float] attr_accessor :size_gb # Underlying volume type, e.g. 'tmpfs'. # Corresponds to the JSON property `volumeType` # @return [String] attr_accessor :volume_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @size_gb = args[:size_gb] if args.key?(:size_gb) @volume_type = args[:volume_type] if args.key?(:volume_type) end end # The zip file information for a zip deployment. class ZipInfo include Google::Apis::Core::Hashable # An estimate of the number of files in a zip for a zip deployment. If set, must # be greater than or equal to the actual number of files. Used for optimizing # performance; if not provided, deployment may be slow. # Corresponds to the JSON property `filesCount` # @return [Fixnum] attr_accessor :files_count # URL of the zip file to deploy from. Must be a URL to a resource in Google # Cloud Storage in the form 'http(s)://storage.googleapis.com//'. # Corresponds to the JSON property `sourceUrl` # @return [String] attr_accessor :source_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @files_count = args[:files_count] if args.key?(:files_count) @source_url = args[:source_url] if args.key?(:source_url) end end end end end google-api-client-0.19.8/generated/google/apis/appengine_v1/service.rb0000644000004100000410000027707413252673043025675 0ustar www-datawww-data# 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 AppengineV1 # Google App Engine Admin API # # The App Engine Admin API enables developers to provision and manage their App # Engine applications. # # @example # require 'google/apis/appengine_v1' # # Appengine = Google::Apis::AppengineV1 # Alias the module # service = Appengine::AppengineService.new # # @see https://cloud.google.com/appengine/docs/admin-api/ class AppengineService < 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://appengine.googleapis.com/', '') @batch_path = 'batch' end # Creates an App Engine application for a Google Cloud Platform project. # Required fields: # id - The ID of the target Cloud Platform project. # location - The region (https://cloud.google.com/appengine/docs/locations) # where you want the App Engine application located.For more information about # App Engine applications, see Managing Projects, Applications, and Billing ( # https://cloud.google.com/appengine/docs/standard/python/console/). # @param [Google::Apis::AppengineV1::Application] application_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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app(application_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/apps', options) command.request_representation = Google::Apis::AppengineV1::Application::Representation command.request_object = application_object command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation 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 an application. # @param [String] apps_id # Part of `name`. Name of the Application resource to get. Example: apps/myapp. # @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::AppengineV1::Application] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::Application] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app(apps_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}', options) command.response_representation = Google::Apis::AppengineV1::Application::Representation command.response_class = Google::Apis::AppengineV1::Application command.params['appsId'] = apps_id unless apps_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 the specified Application resource. You can update the following # fields: # auth_domain - Google authentication domain for controlling user access to the # application. # default_cookie_expiration - Cookie expiration policy for the application. # @param [String] apps_id # Part of `name`. Name of the Application resource to update. Example: apps/ # myapp. # @param [Google::Apis::AppengineV1::Application] application_object # @param [String] update_mask # Standard field mask for the set of fields to 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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app(apps_id, application_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/apps/{appsId}', options) command.request_representation = Google::Apis::AppengineV1::Application::Representation command.request_object = application_object command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_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 # Recreates the required App Engine features for the specified App Engine # application, for example a Cloud Storage bucket or App Engine service account. # Use this method if you receive an error message about a missing feature, for # example, Error retrieving the App Engine service account. # @param [String] apps_id # Part of `name`. Name of the application to repair. Example: apps/myapp # @param [Google::Apis::AppengineV1::RepairApplicationRequest] repair_application_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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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 repair_application(apps_id, repair_application_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/apps/{appsId}:repair', options) command.request_representation = Google::Apis::AppengineV1::RepairApplicationRequest::Representation command.request_object = repair_application_request_object command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_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 # Uploads the specified SSL certificate. # @param [String] apps_id # Part of `parent`. Name of the parent Application resource. Example: apps/myapp. # @param [Google::Apis::AppengineV1::AuthorizedCertificate] authorized_certificate_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::AppengineV1::AuthorizedCertificate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::AuthorizedCertificate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_authorized_certificate(apps_id, authorized_certificate_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/apps/{appsId}/authorizedCertificates', options) command.request_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation command.request_object = authorized_certificate_object command.response_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation command.response_class = Google::Apis::AppengineV1::AuthorizedCertificate command.params['appsId'] = apps_id unless apps_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 the specified SSL certificate. # @param [String] apps_id # Part of `name`. Name of the resource to delete. Example: apps/myapp/ # authorizedCertificates/12345. # @param [String] authorized_certificates_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_authorized_certificate(apps_id, authorized_certificates_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', options) command.response_representation = Google::Apis::AppengineV1::Empty::Representation command.response_class = Google::Apis::AppengineV1::Empty command.params['appsId'] = apps_id unless apps_id.nil? command.params['authorizedCertificatesId'] = authorized_certificates_id unless authorized_certificates_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 the specified SSL certificate. # @param [String] apps_id # Part of `name`. Name of the resource requested. Example: apps/myapp/ # authorizedCertificates/12345. # @param [String] authorized_certificates_id # Part of `name`. See documentation of `appsId`. # @param [String] view # Controls the set of fields returned in the GET 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::AppengineV1::AuthorizedCertificate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::AuthorizedCertificate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_authorized_certificate(apps_id, authorized_certificates_id, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', options) command.response_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation command.response_class = Google::Apis::AppengineV1::AuthorizedCertificate command.params['appsId'] = apps_id unless apps_id.nil? command.params['authorizedCertificatesId'] = authorized_certificates_id unless authorized_certificates_id.nil? command.query['view'] = view unless view.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 SSL certificates the user is authorized to administer. # @param [String] apps_id # Part of `parent`. Name of the parent Application resource. Example: apps/myapp. # @param [Fixnum] page_size # Maximum results to return per page. # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] view # Controls the set of fields returned in the LIST 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::AppengineV1::ListAuthorizedCertificatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::ListAuthorizedCertificatesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_authorized_certificates(apps_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/authorizedCertificates', options) command.response_representation = Google::Apis::AppengineV1::ListAuthorizedCertificatesResponse::Representation command.response_class = Google::Apis::AppengineV1::ListAuthorizedCertificatesResponse command.params['appsId'] = apps_id unless apps_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['view'] = view unless view.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 specified SSL certificate. To renew a certificate and maintain its # existing domain mappings, update certificate_data with a new certificate. The # new certificate must be applicable to the same domains as the original # certificate. The certificate display_name may also be updated. # @param [String] apps_id # Part of `name`. Name of the resource to update. Example: apps/myapp/ # authorizedCertificates/12345. # @param [String] authorized_certificates_id # Part of `name`. See documentation of `appsId`. # @param [Google::Apis::AppengineV1::AuthorizedCertificate] authorized_certificate_object # @param [String] update_mask # Standard field mask for the set of fields to be updated. Updates are only # supported on the certificate_raw_data and display_name fields. # @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::AppengineV1::AuthorizedCertificate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::AuthorizedCertificate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_authorized_certificate(apps_id, authorized_certificates_id, authorized_certificate_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}', options) command.request_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation command.request_object = authorized_certificate_object command.response_representation = Google::Apis::AppengineV1::AuthorizedCertificate::Representation command.response_class = Google::Apis::AppengineV1::AuthorizedCertificate command.params['appsId'] = apps_id unless apps_id.nil? command.params['authorizedCertificatesId'] = authorized_certificates_id unless authorized_certificates_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 # Lists all domains the user is authorized to administer. # @param [String] apps_id # Part of `parent`. Name of the parent Application resource. Example: apps/myapp. # @param [Fixnum] page_size # Maximum results to return per page. # @param [String] page_token # Continuation token for fetching the next page of results. # @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::AppengineV1::ListAuthorizedDomainsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::ListAuthorizedDomainsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_authorized_domains(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/authorizedDomains', options) command.response_representation = Google::Apis::AppengineV1::ListAuthorizedDomainsResponse::Representation command.response_class = Google::Apis::AppengineV1::ListAuthorizedDomainsResponse command.params['appsId'] = apps_id unless apps_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 # Maps a domain to an application. A user must be authorized to administer a # domain in order to map it to an application. For a list of available # authorized domains, see AuthorizedDomains.ListAuthorizedDomains. # @param [String] apps_id # Part of `parent`. Name of the parent Application resource. Example: apps/myapp. # @param [Google::Apis::AppengineV1::DomainMapping] domain_mapping_object # @param [String] override_strategy # Whether the domain creation should override any existing mappings for this # domain. By default, overrides are rejected. # @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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_domain_mapping(apps_id, domain_mapping_object = nil, override_strategy: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/apps/{appsId}/domainMappings', options) command.request_representation = Google::Apis::AppengineV1::DomainMapping::Representation command.request_object = domain_mapping_object command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.query['overrideStrategy'] = override_strategy unless override_strategy.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 specified domain mapping. A user must be authorized to administer # the associated domain in order to delete a DomainMapping resource. # @param [String] apps_id # Part of `name`. Name of the resource to delete. Example: apps/myapp/ # domainMappings/example.com. # @param [String] domain_mappings_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_domain_mapping(apps_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/apps/{appsId}/domainMappings/{domainMappingsId}', options) command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['domainMappingsId'] = domain_mappings_id unless domain_mappings_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 the specified domain mapping. # @param [String] apps_id # Part of `name`. Name of the resource requested. Example: apps/myapp/ # domainMappings/example.com. # @param [String] domain_mappings_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::DomainMapping] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::DomainMapping] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_domain_mapping(apps_id, domain_mappings_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/domainMappings/{domainMappingsId}', options) command.response_representation = Google::Apis::AppengineV1::DomainMapping::Representation command.response_class = Google::Apis::AppengineV1::DomainMapping command.params['appsId'] = apps_id unless apps_id.nil? command.params['domainMappingsId'] = domain_mappings_id unless domain_mappings_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 domain mappings on an application. # @param [String] apps_id # Part of `parent`. Name of the parent Application resource. Example: apps/myapp. # @param [Fixnum] page_size # Maximum results to return per page. # @param [String] page_token # Continuation token for fetching the next page of results. # @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::AppengineV1::ListDomainMappingsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::ListDomainMappingsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_domain_mappings(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/domainMappings', options) command.response_representation = Google::Apis::AppengineV1::ListDomainMappingsResponse::Representation command.response_class = Google::Apis::AppengineV1::ListDomainMappingsResponse command.params['appsId'] = apps_id unless apps_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 the specified domain mapping. To map an SSL certificate to a domain # mapping, update certificate_id to point to an AuthorizedCertificate resource. # A user must be authorized to administer the associated domain in order to # update a DomainMapping resource. # @param [String] apps_id # Part of `name`. Name of the resource to update. Example: apps/myapp/ # domainMappings/example.com. # @param [String] domain_mappings_id # Part of `name`. See documentation of `appsId`. # @param [Google::Apis::AppengineV1::DomainMapping] domain_mapping_object # @param [String] update_mask # Standard field mask for the set of fields to 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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_domain_mapping(apps_id, domain_mappings_id, domain_mapping_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/apps/{appsId}/domainMappings/{domainMappingsId}', options) command.request_representation = Google::Apis::AppengineV1::DomainMapping::Representation command.request_object = domain_mapping_object command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['domainMappingsId'] = domain_mappings_id unless domain_mappings_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 # Replaces the entire firewall ruleset in one bulk operation. This overrides and # replaces the rules of an existing firewall with the new rules.If the final # rule does not match traffic with the '*' wildcard IP range, then an "allow all" # rule is explicitly added to the end of the list. # @param [String] apps_id # Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/ # firewall/ingressRules. # @param [Google::Apis::AppengineV1::BatchUpdateIngressRulesRequest] batch_update_ingress_rules_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::AppengineV1::BatchUpdateIngressRulesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::BatchUpdateIngressRulesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_update_ingress_rules(apps_id, batch_update_ingress_rules_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/apps/{appsId}/firewall/ingressRules:batchUpdate', options) command.request_representation = Google::Apis::AppengineV1::BatchUpdateIngressRulesRequest::Representation command.request_object = batch_update_ingress_rules_request_object command.response_representation = Google::Apis::AppengineV1::BatchUpdateIngressRulesResponse::Representation command.response_class = Google::Apis::AppengineV1::BatchUpdateIngressRulesResponse command.params['appsId'] = apps_id unless apps_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 firewall rule for the application. # @param [String] apps_id # Part of `parent`. Name of the parent Firewall collection in which to create a # new rule. Example: apps/myapp/firewall/ingressRules. # @param [Google::Apis::AppengineV1::FirewallRule] firewall_rule_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::AppengineV1::FirewallRule] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::FirewallRule] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_firewall_ingress_rule(apps_id, firewall_rule_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/apps/{appsId}/firewall/ingressRules', options) command.request_representation = Google::Apis::AppengineV1::FirewallRule::Representation command.request_object = firewall_rule_object command.response_representation = Google::Apis::AppengineV1::FirewallRule::Representation command.response_class = Google::Apis::AppengineV1::FirewallRule command.params['appsId'] = apps_id unless apps_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 the specified firewall rule. # @param [String] apps_id # Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/ # firewall/ingressRules/100. # @param [String] ingress_rules_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_firewall_ingress_rule(apps_id, ingress_rules_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}', options) command.response_representation = Google::Apis::AppengineV1::Empty::Representation command.response_class = Google::Apis::AppengineV1::Empty command.params['appsId'] = apps_id unless apps_id.nil? command.params['ingressRulesId'] = ingress_rules_id unless ingress_rules_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 the specified firewall rule. # @param [String] apps_id # Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/ # firewall/ingressRules/100. # @param [String] ingress_rules_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::FirewallRule] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::FirewallRule] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_firewall_ingress_rule(apps_id, ingress_rules_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}', options) command.response_representation = Google::Apis::AppengineV1::FirewallRule::Representation command.response_class = Google::Apis::AppengineV1::FirewallRule command.params['appsId'] = apps_id unless apps_id.nil? command.params['ingressRulesId'] = ingress_rules_id unless ingress_rules_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 firewall rules of an application. # @param [String] apps_id # Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/ # myapp/firewall/ingressRules. # @param [String] matching_address # A valid IP Address. If set, only rules matching this address will be returned. # The first returned rule will be the rule that fires on requests from this IP. # @param [Fixnum] page_size # Maximum results to return per page. # @param [String] page_token # Continuation token for fetching the next page of results. # @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::AppengineV1::ListIngressRulesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::ListIngressRulesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_firewall_ingress_rules(apps_id, matching_address: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/firewall/ingressRules', options) command.response_representation = Google::Apis::AppengineV1::ListIngressRulesResponse::Representation command.response_class = Google::Apis::AppengineV1::ListIngressRulesResponse command.params['appsId'] = apps_id unless apps_id.nil? command.query['matchingAddress'] = matching_address unless matching_address.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 the specified firewall rule. # @param [String] apps_id # Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/ # firewall/ingressRules/100. # @param [String] ingress_rules_id # Part of `name`. See documentation of `appsId`. # @param [Google::Apis::AppengineV1::FirewallRule] firewall_rule_object # @param [String] update_mask # Standard field mask for the set of fields to 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::AppengineV1::FirewallRule] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::FirewallRule] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_firewall_ingress_rule(apps_id, ingress_rules_id, firewall_rule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}', options) command.request_representation = Google::Apis::AppengineV1::FirewallRule::Representation command.request_object = firewall_rule_object command.response_representation = Google::Apis::AppengineV1::FirewallRule::Representation command.response_class = Google::Apis::AppengineV1::FirewallRule command.params['appsId'] = apps_id unless apps_id.nil? command.params['ingressRulesId'] = ingress_rules_id unless ingress_rules_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 # Get information about a location. # @param [String] apps_id # Part of `name`. Resource name for the location. # @param [String] locations_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::Location] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::Location] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_location(apps_id, locations_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/locations/{locationsId}', options) command.response_representation = Google::Apis::AppengineV1::Location::Representation command.response_class = Google::Apis::AppengineV1::Location command.params['appsId'] = apps_id unless apps_id.nil? command.params['locationsId'] = locations_id unless locations_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 information about the supported locations for this service. # @param [String] apps_id # Part of `name`. The resource that owns the locations collection, if applicable. # @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::AppengineV1::ListLocationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::ListLocationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_locations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/locations', options) command.response_representation = Google::Apis::AppengineV1::ListLocationsResponse::Representation command.response_class = Google::Apis::AppengineV1::ListLocationsResponse command.params['appsId'] = apps_id unless apps_id.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 # 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] apps_id # Part of `name`. The name of the operation resource. # @param [String] operations_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_operation(apps_id, operations_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/operations/{operationsId}', options) command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['operationsId'] = operations_id unless operations_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 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] apps_id # Part of `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::AppengineV1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_operations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/operations', options) command.response_representation = Google::Apis::AppengineV1::ListOperationsResponse::Representation command.response_class = Google::Apis::AppengineV1::ListOperationsResponse command.params['appsId'] = apps_id unless apps_id.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 # Deletes the specified service and all enclosed versions. # @param [String] apps_id # Part of `name`. Name of the resource requested. Example: apps/myapp/services/ # default. # @param [String] services_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_service(apps_id, services_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/apps/{appsId}/services/{servicesId}', options) command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_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 the current configuration of the specified service. # @param [String] apps_id # Part of `name`. Name of the resource requested. Example: apps/myapp/services/ # default. # @param [String] services_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::Service] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::Service] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_service(apps_id, services_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/services/{servicesId}', options) command.response_representation = Google::Apis::AppengineV1::Service::Representation command.response_class = Google::Apis::AppengineV1::Service command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_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 all the services in the application. # @param [String] apps_id # Part of `parent`. Name of the parent Application resource. Example: apps/myapp. # @param [Fixnum] page_size # Maximum results to return per page. # @param [String] page_token # Continuation token for fetching the next page of results. # @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::AppengineV1::ListServicesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::ListServicesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_services(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/services', options) command.response_representation = Google::Apis::AppengineV1::ListServicesResponse::Representation command.response_class = Google::Apis::AppengineV1::ListServicesResponse command.params['appsId'] = apps_id unless apps_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 the configuration of the specified service. # @param [String] apps_id # Part of `name`. Name of the resource to update. Example: apps/myapp/services/ # default. # @param [String] services_id # Part of `name`. See documentation of `appsId`. # @param [Google::Apis::AppengineV1::Service] service_object # @param [Boolean] migrate_traffic # Set to true to gradually shift traffic to one or more versions that you # specify. By default, traffic is shifted immediately. For gradual traffic # migration, the target versions must be located within instances that are # configured for both warmup requests (https://cloud.google.com/appengine/docs/ # admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and # automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/ # rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy # (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps. # services#shardby) field in the Service resource. Gradual traffic migration is # not supported in the App Engine flexible environment. For examples, see # Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin- # api/migrating-splitting-traffic). # @param [String] update_mask # Standard field mask for the set of fields to 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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_service(apps_id, services_id, service_object = nil, migrate_traffic: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/apps/{appsId}/services/{servicesId}', options) command.request_representation = Google::Apis::AppengineV1::Service::Representation command.request_object = service_object command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_id.nil? command.query['migrateTraffic'] = migrate_traffic unless migrate_traffic.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 # Deploys code and resource files to a new version. # @param [String] apps_id # Part of `parent`. Name of the parent resource to create this version under. # Example: apps/myapp/services/default. # @param [String] services_id # Part of `parent`. See documentation of `appsId`. # @param [Google::Apis::AppengineV1::Version] version_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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_service_version(apps_id, services_id, version_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/apps/{appsId}/services/{servicesId}/versions', options) command.request_representation = Google::Apis::AppengineV1::Version::Representation command.request_object = version_object command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_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 existing Version resource. # @param [String] apps_id # Part of `name`. Name of the resource requested. Example: apps/myapp/services/ # default/versions/v1. # @param [String] services_id # Part of `name`. See documentation of `appsId`. # @param [String] versions_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_service_version(apps_id, services_id, versions_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options) command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_id.nil? command.params['versionsId'] = versions_id unless versions_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 the specified Version resource. By default, only a BASIC_VIEW will be # returned. Specify the FULL_VIEW parameter to get the full resource. # @param [String] apps_id # Part of `name`. Name of the resource requested. Example: apps/myapp/services/ # default/versions/v1. # @param [String] services_id # Part of `name`. See documentation of `appsId`. # @param [String] versions_id # Part of `name`. See documentation of `appsId`. # @param [String] view # Controls the set of fields returned in the Get 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::AppengineV1::Version] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::Version] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_service_version(apps_id, services_id, versions_id, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options) command.response_representation = Google::Apis::AppengineV1::Version::Representation command.response_class = Google::Apis::AppengineV1::Version command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_id.nil? command.params['versionsId'] = versions_id unless versions_id.nil? command.query['view'] = view unless view.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 versions of a service. # @param [String] apps_id # Part of `parent`. Name of the parent Service resource. Example: apps/myapp/ # services/default. # @param [String] services_id # Part of `parent`. See documentation of `appsId`. # @param [Fixnum] page_size # Maximum results to return per page. # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] view # Controls the set of fields returned in the List 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::AppengineV1::ListVersionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::ListVersionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_service_versions(apps_id, services_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/services/{servicesId}/versions', options) command.response_representation = Google::Apis::AppengineV1::ListVersionsResponse::Representation command.response_class = Google::Apis::AppengineV1::ListVersionsResponse command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['view'] = view unless view.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 specified Version resource. You can specify the following fields # depending on the App Engine environment and type of scaling that the version # resource uses: # serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/ # rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version # resources that use basic scaling, manual scaling, or run in the App Engine # flexible environment. # instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/ # rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version # resources that run in the App Engine standard environment. # automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/ # admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS. # automatic_scaling): For Version resources that use automatic scaling and run # in the App Engine standard environment. # automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/ # admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS. # automatic_scaling): For Version resources that use automatic scaling and run # in the App Engine standard environment. # automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/ # admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS. # automatic_scaling): For Version resources that use automatic scaling and run # in the App Engine flexible environment. # automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/ # admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS. # automatic_scaling): For Version resources that use automatic scaling and run # in the App Engine flexible environment. # automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/ # docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS. # automatic_scaling): For Version resources that use automatic scaling and run # in the App Engine flexible environment. # automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/ # appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version. # FIELDS.automatic_scaling): For Version resources that use automatic scaling # and run in the App Engine flexible environment. # @param [String] apps_id # Part of `name`. Name of the resource to update. Example: apps/myapp/services/ # default/versions/1. # @param [String] services_id # Part of `name`. See documentation of `appsId`. # @param [String] versions_id # Part of `name`. See documentation of `appsId`. # @param [Google::Apis::AppengineV1::Version] version_object # @param [String] update_mask # Standard field mask for the set of fields to 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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_service_version(apps_id, services_id, versions_id, version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options) command.request_representation = Google::Apis::AppengineV1::Version::Representation command.request_object = version_object command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_id.nil? command.params['versionsId'] = versions_id unless versions_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 # Enables debugging on a VM instance. This allows you to use the SSH command to # connect to the virtual machine where the instance lives. While in "debug mode", # the instance continues to serve live traffic. You should delete the instance # when you are done debugging and then allow the system to take over and # determine if another instance should be started.Only applicable for instances # in App Engine flexible environment. # @param [String] apps_id # Part of `name`. Name of the resource requested. Example: apps/myapp/services/ # default/versions/v1/instances/instance-1. # @param [String] services_id # Part of `name`. See documentation of `appsId`. # @param [String] versions_id # Part of `name`. See documentation of `appsId`. # @param [String] instances_id # Part of `name`. See documentation of `appsId`. # @param [Google::Apis::AppengineV1::DebugInstanceRequest] debug_instance_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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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 debug_instance(apps_id, services_id, versions_id, instances_id, debug_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug', options) command.request_representation = Google::Apis::AppengineV1::DebugInstanceRequest::Representation command.request_object = debug_instance_request_object command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_id.nil? command.params['versionsId'] = versions_id unless versions_id.nil? command.params['instancesId'] = instances_id unless instances_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 # Stops a running instance. # @param [String] apps_id # Part of `name`. Name of the resource requested. Example: apps/myapp/services/ # default/versions/v1/instances/instance-1. # @param [String] services_id # Part of `name`. See documentation of `appsId`. # @param [String] versions_id # Part of `name`. See documentation of `appsId`. # @param [String] instances_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::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_app_service_version_instance(apps_id, services_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}', options) command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_id.nil? command.params['versionsId'] = versions_id unless versions_id.nil? command.params['instancesId'] = instances_id unless instances_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 instance information. # @param [String] apps_id # Part of `name`. Name of the resource requested. Example: apps/myapp/services/ # default/versions/v1/instances/instance-1. # @param [String] services_id # Part of `name`. See documentation of `appsId`. # @param [String] versions_id # Part of `name`. See documentation of `appsId`. # @param [String] instances_id # Part of `name`. See documentation of `appsId`. # @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::AppengineV1::Instance] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::Instance] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_service_version_instance(apps_id, services_id, versions_id, instances_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}', options) command.response_representation = Google::Apis::AppengineV1::Instance::Representation command.response_class = Google::Apis::AppengineV1::Instance command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_id.nil? command.params['versionsId'] = versions_id unless versions_id.nil? command.params['instancesId'] = instances_id unless instances_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 instances of a version.Tip: To aggregate details about instances # over time, see the Stackdriver Monitoring API (https://cloud.google.com/ # monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). # @param [String] apps_id # Part of `parent`. Name of the parent Version resource. Example: apps/myapp/ # services/default/versions/v1. # @param [String] services_id # Part of `parent`. See documentation of `appsId`. # @param [String] versions_id # Part of `parent`. See documentation of `appsId`. # @param [Fixnum] page_size # Maximum results to return per page. # @param [String] page_token # Continuation token for fetching the next page of results. # @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::AppengineV1::ListInstancesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AppengineV1::ListInstancesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app_service_version_instances(apps_id, services_id, versions_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances', options) command.response_representation = Google::Apis::AppengineV1::ListInstancesResponse::Representation command.response_class = Google::Apis::AppengineV1::ListInstancesResponse command.params['appsId'] = apps_id unless apps_id.nil? command.params['servicesId'] = services_id unless services_id.nil? command.params['versionsId'] = versions_id unless versions_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 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 google-api-client-0.19.8/generated/google/apis/fitness_v1.rb0000644000004100000410000000731513252673043023727 0ustar www-datawww-data# 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/fitness_v1/service.rb' require 'google/apis/fitness_v1/classes.rb' require 'google/apis/fitness_v1/representations.rb' module Google module Apis # Fitness # # Stores and accesses user data in the fitness store from apps on any platform. # # @see https://developers.google.com/fit/rest/ module FitnessV1 VERSION = 'V1' REVISION = '20170922' # View your activity information in Google Fit AUTH_FITNESS_ACTIVITY_READ = 'https://www.googleapis.com/auth/fitness.activity.read' # View and store your activity information in Google Fit AUTH_FITNESS_ACTIVITY_WRITE = 'https://www.googleapis.com/auth/fitness.activity.write' # View blood glucose data in Google Fit AUTH_FITNESS_BLOOD_GLUCOSE_READ = 'https://www.googleapis.com/auth/fitness.blood_glucose.read' # View and store blood glucose data in Google Fit AUTH_FITNESS_BLOOD_GLUCOSE_WRITE = 'https://www.googleapis.com/auth/fitness.blood_glucose.write' # View blood pressure data in Google Fit AUTH_FITNESS_BLOOD_PRESSURE_READ = 'https://www.googleapis.com/auth/fitness.blood_pressure.read' # View and store blood pressure data in Google Fit AUTH_FITNESS_BLOOD_PRESSURE_WRITE = 'https://www.googleapis.com/auth/fitness.blood_pressure.write' # View body sensor information in Google Fit AUTH_FITNESS_BODY_READ = 'https://www.googleapis.com/auth/fitness.body.read' # View and store body sensor data in Google Fit AUTH_FITNESS_BODY_WRITE = 'https://www.googleapis.com/auth/fitness.body.write' # View body temperature data in Google Fit AUTH_FITNESS_BODY_TEMPERATURE_READ = 'https://www.googleapis.com/auth/fitness.body_temperature.read' # View and store body temperature data in Google Fit AUTH_FITNESS_BODY_TEMPERATURE_WRITE = 'https://www.googleapis.com/auth/fitness.body_temperature.write' # View your stored location data in Google Fit AUTH_FITNESS_LOCATION_READ = 'https://www.googleapis.com/auth/fitness.location.read' # View and store your location data in Google Fit AUTH_FITNESS_LOCATION_WRITE = 'https://www.googleapis.com/auth/fitness.location.write' # View nutrition information in Google Fit AUTH_FITNESS_NUTRITION_READ = 'https://www.googleapis.com/auth/fitness.nutrition.read' # View and store nutrition information in Google Fit AUTH_FITNESS_NUTRITION_WRITE = 'https://www.googleapis.com/auth/fitness.nutrition.write' # View oxygen saturation data in Google Fit AUTH_FITNESS_OXYGEN_SATURATION_READ = 'https://www.googleapis.com/auth/fitness.oxygen_saturation.read' # View and store oxygen saturation data in Google Fit AUTH_FITNESS_OXYGEN_SATURATION_WRITE = 'https://www.googleapis.com/auth/fitness.oxygen_saturation.write' # View reproductive health data in Google Fit AUTH_FITNESS_REPRODUCTIVE_HEALTH_READ = 'https://www.googleapis.com/auth/fitness.reproductive_health.read' # View and store reproductive health data in Google Fit AUTH_FITNESS_REPRODUCTIVE_HEALTH_WRITE = 'https://www.googleapis.com/auth/fitness.reproductive_health.write' end end end google-api-client-0.19.8/generated/google/apis/adexchangebuyer_v1_3.rb0000644000004100000410000000237413252673043025634 0ustar www-datawww-data# 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/adexchangebuyer_v1_3/service.rb' require 'google/apis/adexchangebuyer_v1_3/classes.rb' require 'google/apis/adexchangebuyer_v1_3/representations.rb' module Google module Apis # Ad Exchange Buyer API # # Accesses your bidding-account information, submits creatives for validation, # finds available direct deals, and retrieves performance reports. # # @see https://developers.google.com/ad-exchange/buyer-rest module AdexchangebuyerV1_3 VERSION = 'V1_3' REVISION = '20170810' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' end end end google-api-client-0.19.8/generated/google/apis/oslogin_v1alpha/0000755000004100000410000000000013252673044024402 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/oslogin_v1alpha/representations.rb0000644000004100000410000000706713252673044030166 0ustar www-datawww-data# 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 OsloginV1alpha class Empty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportSshPublicKeyResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LoginProfile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PosixAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SshPublicKey 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 ImportSshPublicKeyResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :login_profile, as: 'loginProfile', class: Google::Apis::OsloginV1alpha::LoginProfile, decorator: Google::Apis::OsloginV1alpha::LoginProfile::Representation end end class LoginProfile # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' collection :posix_accounts, as: 'posixAccounts', class: Google::Apis::OsloginV1alpha::PosixAccount, decorator: Google::Apis::OsloginV1alpha::PosixAccount::Representation hash :ssh_public_keys, as: 'sshPublicKeys', class: Google::Apis::OsloginV1alpha::SshPublicKey, decorator: Google::Apis::OsloginV1alpha::SshPublicKey::Representation end end class PosixAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :gecos, as: 'gecos' property :gid, :numeric_string => true, as: 'gid' property :home_directory, as: 'homeDirectory' property :primary, as: 'primary' property :shell, as: 'shell' property :system_id, as: 'systemId' property :uid, :numeric_string => true, as: 'uid' property :username, as: 'username' end end class SshPublicKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :expiration_time_usec, :numeric_string => true, as: 'expirationTimeUsec' property :fingerprint, as: 'fingerprint' property :key, as: 'key' end end end end end google-api-client-0.19.8/generated/google/apis/oslogin_v1alpha/classes.rb0000644000004100000410000001561213252673044026371 0ustar www-datawww-data# 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 OsloginV1alpha # 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 response message for importing an SSH public key. class ImportSshPublicKeyResponse include Google::Apis::Core::Hashable # The user profile information used for logging in to a virtual machine on # Google Compute Engine. # Corresponds to the JSON property `loginProfile` # @return [Google::Apis::OsloginV1alpha::LoginProfile] attr_accessor :login_profile def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @login_profile = args[:login_profile] if args.key?(:login_profile) end end # The user profile information used for logging in to a virtual machine on # Google Compute Engine. class LoginProfile include Google::Apis::Core::Hashable # A unique user ID. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The list of POSIX accounts associated with the user. # Corresponds to the JSON property `posixAccounts` # @return [Array] attr_accessor :posix_accounts # A map from SSH public key fingerprint to the associated key object. # Corresponds to the JSON property `sshPublicKeys` # @return [Hash] attr_accessor :ssh_public_keys def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @posix_accounts = args[:posix_accounts] if args.key?(:posix_accounts) @ssh_public_keys = args[:ssh_public_keys] if args.key?(:ssh_public_keys) end end # The POSIX account information associated with a Google account. class PosixAccount include Google::Apis::Core::Hashable # Output only. A POSIX account identifier. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # The GECOS (user information) entry for this account. # Corresponds to the JSON property `gecos` # @return [String] attr_accessor :gecos # The default group ID. # Corresponds to the JSON property `gid` # @return [Fixnum] attr_accessor :gid # The path to the home directory for this account. # Corresponds to the JSON property `homeDirectory` # @return [String] attr_accessor :home_directory # Only one POSIX account can be marked as primary. # Corresponds to the JSON property `primary` # @return [Boolean] attr_accessor :primary alias_method :primary?, :primary # The path to the logic shell for this account. # Corresponds to the JSON property `shell` # @return [String] attr_accessor :shell # System identifier for which account the username or uid applies to. # By default, the empty value is used. # Corresponds to the JSON property `systemId` # @return [String] attr_accessor :system_id # The user ID. # Corresponds to the JSON property `uid` # @return [Fixnum] attr_accessor :uid # The username of the POSIX account. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @gecos = args[:gecos] if args.key?(:gecos) @gid = args[:gid] if args.key?(:gid) @home_directory = args[:home_directory] if args.key?(:home_directory) @primary = args[:primary] if args.key?(:primary) @shell = args[:shell] if args.key?(:shell) @system_id = args[:system_id] if args.key?(:system_id) @uid = args[:uid] if args.key?(:uid) @username = args[:username] if args.key?(:username) end end # The SSH public key information associated with a Google account. class SshPublicKey include Google::Apis::Core::Hashable # An expiration time in microseconds since epoch. # Corresponds to the JSON property `expirationTimeUsec` # @return [Fixnum] attr_accessor :expiration_time_usec # Output only. The SHA-256 fingerprint of the SSH public key. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # Public key text in SSH format, defined by # RFC4253 # section 6.6. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expiration_time_usec = args[:expiration_time_usec] if args.key?(:expiration_time_usec) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @key = args[:key] if args.key?(:key) end end end end end google-api-client-0.19.8/generated/google/apis/oslogin_v1alpha/service.rb0000644000004100000410000003470213252673044026375 0ustar www-datawww-data# 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 OsloginV1alpha # Google Cloud OS Login API # # Manages OS login configuration for Google account users. # # @example # require 'google/apis/oslogin_v1alpha' # # Oslogin = Google::Apis::OsloginV1alpha # Alias the module # service = Oslogin::CloudOSLoginService.new # # @see https://cloud.google.com/compute/docs/oslogin/rest/ class CloudOSLoginService < 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://oslogin.googleapis.com/', '') @batch_path = 'batch' end # Retrieves the profile information used for logging in to a virtual machine # on Google Compute Engine. # @param [String] name # The unique ID for the user in format `users/`user``. # @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::OsloginV1alpha::LoginProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1alpha::LoginProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_login_profile(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/{+name}/loginProfile', options) command.response_representation = Google::Apis::OsloginV1alpha::LoginProfile::Representation command.response_class = Google::Apis::OsloginV1alpha::LoginProfile 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 SSH public key and returns the profile information. Default POSIX # account information is set when no username and UID exist as part of the # login profile. # @param [String] parent # The unique ID for the user in format `users/`user``. # @param [Google::Apis::OsloginV1alpha::SshPublicKey] ssh_public_key_object # @param [String] project_id # The project ID of the Google Cloud Platform 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::OsloginV1alpha::ImportSshPublicKeyResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1alpha::ImportSshPublicKeyResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def import_user_ssh_public_key(parent, ssh_public_key_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha/{+parent}:importSshPublicKey', options) command.request_representation = Google::Apis::OsloginV1alpha::SshPublicKey::Representation command.request_object = ssh_public_key_object command.response_representation = Google::Apis::OsloginV1alpha::ImportSshPublicKeyResponse::Representation command.response_class = Google::Apis::OsloginV1alpha::ImportSshPublicKeyResponse command.params['parent'] = parent unless parent.nil? command.query['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 # Deletes a POSIX account. # @param [String] name # A reference to the POSIX account to update. POSIX accounts are identified # by the project ID they are associated with. A reference to the POSIX # account is in format `users/`user`/projects/`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::OsloginV1alpha::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1alpha::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_user_project(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1alpha/{+name}', options) command.response_representation = Google::Apis::OsloginV1alpha::Empty::Representation command.response_class = Google::Apis::OsloginV1alpha::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 # Deletes an SSH public key. # @param [String] name # The fingerprint of the public key to update. Public keys are identified by # their SHA-256 fingerprint. The fingerprint of the public key is in format # `users/`user`/sshPublicKeys/`fingerprint``. # @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::OsloginV1alpha::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1alpha::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_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1alpha/{+name}', options) command.response_representation = Google::Apis::OsloginV1alpha::Empty::Representation command.response_class = Google::Apis::OsloginV1alpha::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 # Retrieves an SSH public key. # @param [String] name # The fingerprint of the public key to retrieve. Public keys are identified # by their SHA-256 fingerprint. The fingerprint of the public key is in # format `users/`user`/sshPublicKeys/`fingerprint``. # @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::OsloginV1alpha::SshPublicKey] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1alpha::SshPublicKey] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/{+name}', options) command.response_representation = Google::Apis::OsloginV1alpha::SshPublicKey::Representation command.response_class = Google::Apis::OsloginV1alpha::SshPublicKey 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 SSH public key and returns the profile information. This method # supports patch semantics. # @param [String] name # The fingerprint of the public key to update. Public keys are identified by # their SHA-256 fingerprint. The fingerprint of the public key is in format # `users/`user`/sshPublicKeys/`fingerprint``. # @param [Google::Apis::OsloginV1alpha::SshPublicKey] ssh_public_key_object # @param [String] update_mask # Mask to control which fields get updated. Updates all if not present. # @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::OsloginV1alpha::SshPublicKey] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1alpha::SshPublicKey] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_ssh_public_key(name, ssh_public_key_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1alpha/{+name}', options) command.request_representation = Google::Apis::OsloginV1alpha::SshPublicKey::Representation command.request_object = ssh_public_key_object command.response_representation = Google::Apis::OsloginV1alpha::SshPublicKey::Representation command.response_class = Google::Apis::OsloginV1alpha::SshPublicKey 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 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 google-api-client-0.19.8/generated/google/apis/oslogin_v1beta.rb0000644000004100000410000000306613252673044024562 0ustar www-datawww-data# 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/oslogin_v1beta/service.rb' require 'google/apis/oslogin_v1beta/classes.rb' require 'google/apis/oslogin_v1beta/representations.rb' module Google module Apis # Google Cloud OS Login API # # Manages OS login configuration for Google account users. # # @see https://cloud.google.com/compute/docs/oslogin/rest/ module OsloginV1beta VERSION = 'V1beta' REVISION = '20180117' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' # View and manage your Google Compute Engine resources AUTH_COMPUTE = 'https://www.googleapis.com/auth/compute' # View your Google Compute Engine resources AUTH_COMPUTE_READONLY = 'https://www.googleapis.com/auth/compute.readonly' end end end google-api-client-0.19.8/generated/google/apis/container_v1beta1/0000755000004100000410000000000013252673043024620 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/container_v1beta1/representations.rb0000644000004100000410000011063113252673043030374 0ustar www-datawww-data# 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 ContainerV1beta1 class AcceleratorConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AddonsConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AutoUpgradeOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CancelOperationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CidrBlock class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClientCertificateConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Cluster class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClusterUpdate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompleteIpRotationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateClusterRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateNodePoolRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DailyMaintenanceWindow 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 HorizontalPodAutoscaling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpLoadBalancing class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IpAllocationPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class KubernetesDashboard class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LegacyAbac class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListClustersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListNodePoolsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MaintenancePolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MaintenanceWindow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MasterAuth class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MasterAuthorizedNetworksConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkPolicyConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NodeConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NodeManagement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NodePool class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NodePoolAutoscaling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NodeTaint 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 PodSecurityPolicyConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RollbackNodePoolUpgradeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServerConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetAddonsConfigRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetLabelsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetLegacyAbacRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetLocationsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetLoggingServiceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetMaintenancePolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetMasterAuthRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetMonitoringServiceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetNetworkPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetNodePoolAutoscalingRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetNodePoolManagementRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetNodePoolSizeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StartIpRotationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateClusterRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateMasterRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateNodePoolRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WorkloadMetadataConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AcceleratorConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :accelerator_count, :numeric_string => true, as: 'acceleratorCount' property :accelerator_type, as: 'acceleratorType' end end class AddonsConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :horizontal_pod_autoscaling, as: 'horizontalPodAutoscaling', class: Google::Apis::ContainerV1beta1::HorizontalPodAutoscaling, decorator: Google::Apis::ContainerV1beta1::HorizontalPodAutoscaling::Representation property :http_load_balancing, as: 'httpLoadBalancing', class: Google::Apis::ContainerV1beta1::HttpLoadBalancing, decorator: Google::Apis::ContainerV1beta1::HttpLoadBalancing::Representation property :kubernetes_dashboard, as: 'kubernetesDashboard', class: Google::Apis::ContainerV1beta1::KubernetesDashboard, decorator: Google::Apis::ContainerV1beta1::KubernetesDashboard::Representation property :network_policy_config, as: 'networkPolicyConfig', class: Google::Apis::ContainerV1beta1::NetworkPolicyConfig, decorator: Google::Apis::ContainerV1beta1::NetworkPolicyConfig::Representation end end class AutoUpgradeOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_upgrade_start_time, as: 'autoUpgradeStartTime' property :description, as: 'description' end end class CancelOperationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :operation_id, as: 'operationId' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class CidrBlock # @private class Representation < Google::Apis::Core::JsonRepresentation property :cidr_block, as: 'cidrBlock' property :display_name, as: 'displayName' end end class ClientCertificateConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :issue_client_certificate, as: 'issueClientCertificate' end end class Cluster # @private class Representation < Google::Apis::Core::JsonRepresentation property :addons_config, as: 'addonsConfig', class: Google::Apis::ContainerV1beta1::AddonsConfig, decorator: Google::Apis::ContainerV1beta1::AddonsConfig::Representation property :cluster_ipv4_cidr, as: 'clusterIpv4Cidr' property :create_time, as: 'createTime' property :current_master_version, as: 'currentMasterVersion' property :current_node_count, as: 'currentNodeCount' property :current_node_version, as: 'currentNodeVersion' property :description, as: 'description' property :enable_kubernetes_alpha, as: 'enableKubernetesAlpha' property :endpoint, as: 'endpoint' property :expire_time, as: 'expireTime' property :initial_cluster_version, as: 'initialClusterVersion' property :initial_node_count, as: 'initialNodeCount' collection :instance_group_urls, as: 'instanceGroupUrls' property :ip_allocation_policy, as: 'ipAllocationPolicy', class: Google::Apis::ContainerV1beta1::IpAllocationPolicy, decorator: Google::Apis::ContainerV1beta1::IpAllocationPolicy::Representation property :label_fingerprint, as: 'labelFingerprint' property :legacy_abac, as: 'legacyAbac', class: Google::Apis::ContainerV1beta1::LegacyAbac, decorator: Google::Apis::ContainerV1beta1::LegacyAbac::Representation property :location, as: 'location' collection :locations, as: 'locations' property :logging_service, as: 'loggingService' property :maintenance_policy, as: 'maintenancePolicy', class: Google::Apis::ContainerV1beta1::MaintenancePolicy, decorator: Google::Apis::ContainerV1beta1::MaintenancePolicy::Representation property :master_auth, as: 'masterAuth', class: Google::Apis::ContainerV1beta1::MasterAuth, decorator: Google::Apis::ContainerV1beta1::MasterAuth::Representation property :master_authorized_networks_config, as: 'masterAuthorizedNetworksConfig', class: Google::Apis::ContainerV1beta1::MasterAuthorizedNetworksConfig, decorator: Google::Apis::ContainerV1beta1::MasterAuthorizedNetworksConfig::Representation property :monitoring_service, as: 'monitoringService' property :name, as: 'name' property :network, as: 'network' property :network_policy, as: 'networkPolicy', class: Google::Apis::ContainerV1beta1::NetworkPolicy, decorator: Google::Apis::ContainerV1beta1::NetworkPolicy::Representation property :node_config, as: 'nodeConfig', class: Google::Apis::ContainerV1beta1::NodeConfig, decorator: Google::Apis::ContainerV1beta1::NodeConfig::Representation property :node_ipv4_cidr_size, as: 'nodeIpv4CidrSize' collection :node_pools, as: 'nodePools', class: Google::Apis::ContainerV1beta1::NodePool, decorator: Google::Apis::ContainerV1beta1::NodePool::Representation property :pod_security_policy_config, as: 'podSecurityPolicyConfig', class: Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig, decorator: Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig::Representation hash :resource_labels, as: 'resourceLabels' property :self_link, as: 'selfLink' property :services_ipv4_cidr, as: 'servicesIpv4Cidr' property :status, as: 'status' property :status_message, as: 'statusMessage' property :subnetwork, as: 'subnetwork' property :zone, as: 'zone' end end class ClusterUpdate # @private class Representation < Google::Apis::Core::JsonRepresentation property :desired_addons_config, as: 'desiredAddonsConfig', class: Google::Apis::ContainerV1beta1::AddonsConfig, decorator: Google::Apis::ContainerV1beta1::AddonsConfig::Representation property :desired_image_type, as: 'desiredImageType' collection :desired_locations, as: 'desiredLocations' property :desired_master_authorized_networks_config, as: 'desiredMasterAuthorizedNetworksConfig', class: Google::Apis::ContainerV1beta1::MasterAuthorizedNetworksConfig, decorator: Google::Apis::ContainerV1beta1::MasterAuthorizedNetworksConfig::Representation property :desired_master_version, as: 'desiredMasterVersion' property :desired_monitoring_service, as: 'desiredMonitoringService' property :desired_node_pool_autoscaling, as: 'desiredNodePoolAutoscaling', class: Google::Apis::ContainerV1beta1::NodePoolAutoscaling, decorator: Google::Apis::ContainerV1beta1::NodePoolAutoscaling::Representation property :desired_node_pool_id, as: 'desiredNodePoolId' property :desired_node_version, as: 'desiredNodeVersion' property :desired_pod_security_policy_config, as: 'desiredPodSecurityPolicyConfig', class: Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig, decorator: Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig::Representation end end class CompleteIpRotationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :name, as: 'name' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class CreateClusterRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster, as: 'cluster', class: Google::Apis::ContainerV1beta1::Cluster, decorator: Google::Apis::ContainerV1beta1::Cluster::Representation property :parent, as: 'parent' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class CreateNodePoolRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :node_pool, as: 'nodePool', class: Google::Apis::ContainerV1beta1::NodePool, decorator: Google::Apis::ContainerV1beta1::NodePool::Representation property :parent, as: 'parent' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class DailyMaintenanceWindow # @private class Representation < Google::Apis::Core::JsonRepresentation property :duration, as: 'duration' property :start_time, as: 'startTime' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class HorizontalPodAutoscaling # @private class Representation < Google::Apis::Core::JsonRepresentation property :disabled, as: 'disabled' end end class HttpLoadBalancing # @private class Representation < Google::Apis::Core::JsonRepresentation property :disabled, as: 'disabled' end end class IpAllocationPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_route_overlap, as: 'allowRouteOverlap' property :cluster_ipv4_cidr, as: 'clusterIpv4Cidr' property :cluster_ipv4_cidr_block, as: 'clusterIpv4CidrBlock' property :cluster_secondary_range_name, as: 'clusterSecondaryRangeName' property :create_subnetwork, as: 'createSubnetwork' property :node_ipv4_cidr, as: 'nodeIpv4Cidr' property :node_ipv4_cidr_block, as: 'nodeIpv4CidrBlock' property :services_ipv4_cidr, as: 'servicesIpv4Cidr' property :services_ipv4_cidr_block, as: 'servicesIpv4CidrBlock' property :services_secondary_range_name, as: 'servicesSecondaryRangeName' property :subnetwork_name, as: 'subnetworkName' property :use_ip_aliases, as: 'useIpAliases' end end class KubernetesDashboard # @private class Representation < Google::Apis::Core::JsonRepresentation property :disabled, as: 'disabled' end end class LegacyAbac # @private class Representation < Google::Apis::Core::JsonRepresentation property :enabled, as: 'enabled' end end class ListClustersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :clusters, as: 'clusters', class: Google::Apis::ContainerV1beta1::Cluster, decorator: Google::Apis::ContainerV1beta1::Cluster::Representation collection :missing_zones, as: 'missingZones' end end class ListNodePoolsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :node_pools, as: 'nodePools', class: Google::Apis::ContainerV1beta1::NodePool, decorator: Google::Apis::ContainerV1beta1::NodePool::Representation end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :missing_zones, as: 'missingZones' collection :operations, as: 'operations', class: Google::Apis::ContainerV1beta1::Operation, decorator: Google::Apis::ContainerV1beta1::Operation::Representation end end class MaintenancePolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :window, as: 'window', class: Google::Apis::ContainerV1beta1::MaintenanceWindow, decorator: Google::Apis::ContainerV1beta1::MaintenanceWindow::Representation end end class MaintenanceWindow # @private class Representation < Google::Apis::Core::JsonRepresentation property :daily_maintenance_window, as: 'dailyMaintenanceWindow', class: Google::Apis::ContainerV1beta1::DailyMaintenanceWindow, decorator: Google::Apis::ContainerV1beta1::DailyMaintenanceWindow::Representation end end class MasterAuth # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_certificate, as: 'clientCertificate' property :client_certificate_config, as: 'clientCertificateConfig', class: Google::Apis::ContainerV1beta1::ClientCertificateConfig, decorator: Google::Apis::ContainerV1beta1::ClientCertificateConfig::Representation property :client_key, as: 'clientKey' property :cluster_ca_certificate, as: 'clusterCaCertificate' property :password, as: 'password' property :username, as: 'username' end end class MasterAuthorizedNetworksConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :cidr_blocks, as: 'cidrBlocks', class: Google::Apis::ContainerV1beta1::CidrBlock, decorator: Google::Apis::ContainerV1beta1::CidrBlock::Representation property :enabled, as: 'enabled' end end class NetworkPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :enabled, as: 'enabled' property :provider, as: 'provider' end end class NetworkPolicyConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :disabled, as: 'disabled' end end class NodeConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accelerators, as: 'accelerators', class: Google::Apis::ContainerV1beta1::AcceleratorConfig, decorator: Google::Apis::ContainerV1beta1::AcceleratorConfig::Representation property :disk_size_gb, as: 'diskSizeGb' property :image_type, as: 'imageType' hash :labels, as: 'labels' property :local_ssd_count, as: 'localSsdCount' property :machine_type, as: 'machineType' hash :metadata, as: 'metadata' property :min_cpu_platform, as: 'minCpuPlatform' collection :oauth_scopes, as: 'oauthScopes' property :preemptible, as: 'preemptible' property :service_account, as: 'serviceAccount' collection :tags, as: 'tags' collection :taints, as: 'taints', class: Google::Apis::ContainerV1beta1::NodeTaint, decorator: Google::Apis::ContainerV1beta1::NodeTaint::Representation property :workload_metadata_config, as: 'workloadMetadataConfig', class: Google::Apis::ContainerV1beta1::WorkloadMetadataConfig, decorator: Google::Apis::ContainerV1beta1::WorkloadMetadataConfig::Representation end end class NodeManagement # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_repair, as: 'autoRepair' property :auto_upgrade, as: 'autoUpgrade' property :upgrade_options, as: 'upgradeOptions', class: Google::Apis::ContainerV1beta1::AutoUpgradeOptions, decorator: Google::Apis::ContainerV1beta1::AutoUpgradeOptions::Representation end end class NodePool # @private class Representation < Google::Apis::Core::JsonRepresentation property :autoscaling, as: 'autoscaling', class: Google::Apis::ContainerV1beta1::NodePoolAutoscaling, decorator: Google::Apis::ContainerV1beta1::NodePoolAutoscaling::Representation property :config, as: 'config', class: Google::Apis::ContainerV1beta1::NodeConfig, decorator: Google::Apis::ContainerV1beta1::NodeConfig::Representation property :initial_node_count, as: 'initialNodeCount' collection :instance_group_urls, as: 'instanceGroupUrls' property :management, as: 'management', class: Google::Apis::ContainerV1beta1::NodeManagement, decorator: Google::Apis::ContainerV1beta1::NodeManagement::Representation property :name, as: 'name' property :self_link, as: 'selfLink' property :status, as: 'status' property :status_message, as: 'statusMessage' property :version, as: 'version' end end class NodePoolAutoscaling # @private class Representation < Google::Apis::Core::JsonRepresentation property :enabled, as: 'enabled' property :max_node_count, as: 'maxNodeCount' property :min_node_count, as: 'minNodeCount' end end class NodeTaint # @private class Representation < Google::Apis::Core::JsonRepresentation property :effect, as: 'effect' property :key, as: 'key' property :value, as: 'value' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :detail, as: 'detail' property :end_time, as: 'endTime' property :location, as: 'location' property :name, as: 'name' property :operation_type, as: 'operationType' property :self_link, as: 'selfLink' property :start_time, as: 'startTime' property :status, as: 'status' property :status_message, as: 'statusMessage' property :target_link, as: 'targetLink' property :zone, as: 'zone' end end class PodSecurityPolicyConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :enabled, as: 'enabled' end end class RollbackNodePoolUpgradeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :name, as: 'name' property :node_pool_id, as: 'nodePoolId' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class ServerConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_cluster_version, as: 'defaultClusterVersion' property :default_image_type, as: 'defaultImageType' collection :valid_image_types, as: 'validImageTypes' collection :valid_master_versions, as: 'validMasterVersions' collection :valid_node_versions, as: 'validNodeVersions' end end class SetAddonsConfigRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :addons_config, as: 'addonsConfig', class: Google::Apis::ContainerV1beta1::AddonsConfig, decorator: Google::Apis::ContainerV1beta1::AddonsConfig::Representation property :cluster_id, as: 'clusterId' property :name, as: 'name' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class SetLabelsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :label_fingerprint, as: 'labelFingerprint' property :name, as: 'name' property :project_id, as: 'projectId' hash :resource_labels, as: 'resourceLabels' property :zone, as: 'zone' end end class SetLegacyAbacRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :enabled, as: 'enabled' property :name, as: 'name' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class SetLocationsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' collection :locations, as: 'locations' property :name, as: 'name' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class SetLoggingServiceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :logging_service, as: 'loggingService' property :name, as: 'name' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class SetMaintenancePolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :maintenance_policy, as: 'maintenancePolicy', class: Google::Apis::ContainerV1beta1::MaintenancePolicy, decorator: Google::Apis::ContainerV1beta1::MaintenancePolicy::Representation property :name, as: 'name' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class SetMasterAuthRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' property :cluster_id, as: 'clusterId' property :name, as: 'name' property :project_id, as: 'projectId' property :update, as: 'update', class: Google::Apis::ContainerV1beta1::MasterAuth, decorator: Google::Apis::ContainerV1beta1::MasterAuth::Representation property :zone, as: 'zone' end end class SetMonitoringServiceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :monitoring_service, as: 'monitoringService' property :name, as: 'name' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class SetNetworkPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :name, as: 'name' property :network_policy, as: 'networkPolicy', class: Google::Apis::ContainerV1beta1::NetworkPolicy, decorator: Google::Apis::ContainerV1beta1::NetworkPolicy::Representation property :project_id, as: 'projectId' property :zone, as: 'zone' end end class SetNodePoolAutoscalingRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :autoscaling, as: 'autoscaling', class: Google::Apis::ContainerV1beta1::NodePoolAutoscaling, decorator: Google::Apis::ContainerV1beta1::NodePoolAutoscaling::Representation property :cluster_id, as: 'clusterId' property :name, as: 'name' property :node_pool_id, as: 'nodePoolId' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class SetNodePoolManagementRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :management, as: 'management', class: Google::Apis::ContainerV1beta1::NodeManagement, decorator: Google::Apis::ContainerV1beta1::NodeManagement::Representation property :name, as: 'name' property :node_pool_id, as: 'nodePoolId' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class SetNodePoolSizeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :name, as: 'name' property :node_count, as: 'nodeCount' property :node_pool_id, as: 'nodePoolId' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class StartIpRotationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :name, as: 'name' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class UpdateClusterRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :name, as: 'name' property :project_id, as: 'projectId' property :update, as: 'update', class: Google::Apis::ContainerV1beta1::ClusterUpdate, decorator: Google::Apis::ContainerV1beta1::ClusterUpdate::Representation property :zone, as: 'zone' end end class UpdateMasterRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :master_version, as: 'masterVersion' property :name, as: 'name' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class UpdateNodePoolRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_id, as: 'clusterId' property :image_type, as: 'imageType' property :name, as: 'name' property :node_pool_id, as: 'nodePoolId' property :node_version, as: 'nodeVersion' property :project_id, as: 'projectId' property :zone, as: 'zone' end end class WorkloadMetadataConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :node_metadata, as: 'nodeMetadata' end end end end end google-api-client-0.19.8/generated/google/apis/container_v1beta1/classes.rb0000644000004100000410000034274413252673043026620 0ustar www-datawww-data# 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 ContainerV1beta1 # AcceleratorConfig represents a Hardware Accelerator request. class AcceleratorConfig include Google::Apis::Core::Hashable # The number of the accelerator cards exposed to an instance. # Corresponds to the JSON property `acceleratorCount` # @return [Fixnum] attr_accessor :accelerator_count # The accelerator type resource name. List of supported accelerators # [here](/compute/docs/gpus/#Introduction) # Corresponds to the JSON property `acceleratorType` # @return [String] attr_accessor :accelerator_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accelerator_count = args[:accelerator_count] if args.key?(:accelerator_count) @accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type) end end # Configuration for the addons that can be automatically spun up in the # cluster, enabling additional functionality. class AddonsConfig include Google::Apis::Core::Hashable # Configuration options for the horizontal pod autoscaling feature, which # increases or decreases the number of replica pods a replication controller # has based on the resource usage of the existing pods. # Corresponds to the JSON property `horizontalPodAutoscaling` # @return [Google::Apis::ContainerV1beta1::HorizontalPodAutoscaling] attr_accessor :horizontal_pod_autoscaling # Configuration options for the HTTP (L7) load balancing controller addon, # which makes it easy to set up HTTP load balancers for services in a cluster. # Corresponds to the JSON property `httpLoadBalancing` # @return [Google::Apis::ContainerV1beta1::HttpLoadBalancing] attr_accessor :http_load_balancing # Configuration for the Kubernetes Dashboard. # Corresponds to the JSON property `kubernetesDashboard` # @return [Google::Apis::ContainerV1beta1::KubernetesDashboard] attr_accessor :kubernetes_dashboard # Configuration for NetworkPolicy. This only tracks whether the addon # is enabled or not on the Master, it does not track whether network policy # is enabled for the nodes. # Corresponds to the JSON property `networkPolicyConfig` # @return [Google::Apis::ContainerV1beta1::NetworkPolicyConfig] attr_accessor :network_policy_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @horizontal_pod_autoscaling = args[:horizontal_pod_autoscaling] if args.key?(:horizontal_pod_autoscaling) @http_load_balancing = args[:http_load_balancing] if args.key?(:http_load_balancing) @kubernetes_dashboard = args[:kubernetes_dashboard] if args.key?(:kubernetes_dashboard) @network_policy_config = args[:network_policy_config] if args.key?(:network_policy_config) end end # AutoUpgradeOptions defines the set of options for the user to control how # the Auto Upgrades will proceed. class AutoUpgradeOptions include Google::Apis::Core::Hashable # [Output only] This field is set when upgrades are about to commence # with the approximate start time for the upgrades, in # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `autoUpgradeStartTime` # @return [String] attr_accessor :auto_upgrade_start_time # [Output only] This field is set when upgrades are about to commence # with the description of the upgrade. # 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) @auto_upgrade_start_time = args[:auto_upgrade_start_time] if args.key?(:auto_upgrade_start_time) @description = args[:description] if args.key?(:description) end end # CancelOperationRequest cancels a single operation. class CancelOperationRequest include Google::Apis::Core::Hashable # The name (project, location, operation id) of the operation to cancel. # Specified in the format 'projects/*/locations/*/operations/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The server-assigned `name` of the operation. # This field is deprecated, use name instead. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the operation resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @operation_id = args[:operation_id] if args.key?(:operation_id) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # CidrBlock contains an optional name and one CIDR block. class CidrBlock include Google::Apis::Core::Hashable # cidr_block must be specified in CIDR notation. # Corresponds to the JSON property `cidrBlock` # @return [String] attr_accessor :cidr_block # display_name is an optional field for users to identify CIDR blocks. # 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) @cidr_block = args[:cidr_block] if args.key?(:cidr_block) @display_name = args[:display_name] if args.key?(:display_name) end end # Configuration for client certificates on the cluster. class ClientCertificateConfig include Google::Apis::Core::Hashable # Issue a client certificate. # Corresponds to the JSON property `issueClientCertificate` # @return [Boolean] attr_accessor :issue_client_certificate alias_method :issue_client_certificate?, :issue_client_certificate def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @issue_client_certificate = args[:issue_client_certificate] if args.key?(:issue_client_certificate) end end # A Google Kubernetes Engine cluster. class Cluster include Google::Apis::Core::Hashable # Configuration for the addons that can be automatically spun up in the # cluster, enabling additional functionality. # Corresponds to the JSON property `addonsConfig` # @return [Google::Apis::ContainerV1beta1::AddonsConfig] attr_accessor :addons_config # The IP address range of the container pods in this cluster, in # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) # notation (e.g. `10.96.0.0/14`). Leave blank to have # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. # Corresponds to the JSON property `clusterIpv4Cidr` # @return [String] attr_accessor :cluster_ipv4_cidr # [Output only] The time the cluster was created, in # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # [Output only] The current software version of the master endpoint. # Corresponds to the JSON property `currentMasterVersion` # @return [String] attr_accessor :current_master_version # [Output only] The number of nodes currently in the cluster. # Corresponds to the JSON property `currentNodeCount` # @return [Fixnum] attr_accessor :current_node_count # [Output only] 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. # Corresponds to the JSON property `currentNodeVersion` # @return [String] attr_accessor :current_node_version # An optional description of this cluster. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Kubernetes alpha features are enabled on this cluster. This includes alpha # API groups (e.g. v1beta1) and features that may not be production ready in # the kubernetes version of the master and nodes. # The cluster has no SLA for uptime and master/node upgrades are disabled. # Alpha enabled clusters are automatically deleted thirty days after # creation. # Corresponds to the JSON property `enableKubernetesAlpha` # @return [Boolean] attr_accessor :enable_kubernetes_alpha alias_method :enable_kubernetes_alpha?, :enable_kubernetes_alpha # [Output only] The IP address of this cluster's master endpoint. # The endpoint can be accessed from the internet at # `https://username:password@endpoint/`. # See the `masterAuth` property of this resource for username and # password information. # Corresponds to the JSON property `endpoint` # @return [String] attr_accessor :endpoint # [Output only] The time the cluster will be automatically # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time # The initial Kubernetes version for this cluster. Valid versions are those # found in validMasterVersions returned by getServerConfig. The version can # be upgraded over time; such upgrades are reflected in # currentMasterVersion and currentNodeVersion. # Corresponds to the JSON property `initialClusterVersion` # @return [String] attr_accessor :initial_cluster_version # The number of nodes to create in this cluster. You must ensure that your # Compute Engine resource quota # is sufficient for this number of instances. You must also have available # firewall and routes quota. # For requests, this field should only be used in lieu of a # "node_pool" object, since this configuration (along with the # "node_config") will be used to create a "NodePool" object with an # auto-generated name. Do not use this and a node_pool at the same time. # Corresponds to the JSON property `initialNodeCount` # @return [Fixnum] attr_accessor :initial_node_count # Deprecated. Use node_pools.instance_group_urls. # Corresponds to the JSON property `instanceGroupUrls` # @return [Array] attr_accessor :instance_group_urls # Configuration for controlling how IPs are allocated in the cluster. # Corresponds to the JSON property `ipAllocationPolicy` # @return [Google::Apis::ContainerV1beta1::IpAllocationPolicy] attr_accessor :ip_allocation_policy # The fingerprint of the set of labels for this cluster. # Corresponds to the JSON property `labelFingerprint` # @return [String] attr_accessor :label_fingerprint # Configuration for the legacy Attribute Based Access Control authorization # mode. # Corresponds to the JSON property `legacyAbac` # @return [Google::Apis::ContainerV1beta1::LegacyAbac] 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. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The list of Google Compute Engine # [locations](/compute/docs/zones#available) in which the cluster's nodes # should be located. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # The logging service the cluster should use to write logs. # Currently available options: # * `logging.googleapis.com` - the Google Cloud Logging service. # * `none` - no logs will be exported from the cluster. # * if left as an empty string,`logging.googleapis.com` will be used. # Corresponds to the JSON property `loggingService` # @return [String] attr_accessor :logging_service # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Corresponds to the JSON property `maintenancePolicy` # @return [Google::Apis::ContainerV1beta1::MaintenancePolicy] attr_accessor :maintenance_policy # The authentication information for accessing the master endpoint. # Authentication can be done using HTTP basic auth or using client # certificates. # Corresponds to the JSON property `masterAuth` # @return [Google::Apis::ContainerV1beta1::MasterAuth] attr_accessor :master_auth # Configuration options for the master authorized networks feature. Enabled # master authorized networks will disallow all external traffic to access # Kubernetes master through HTTPS except traffic from the given CIDR blocks, # Google Compute Engine Public IPs and Google Prod IPs. # Corresponds to the JSON property `masterAuthorizedNetworksConfig` # @return [Google::Apis::ContainerV1beta1::MasterAuthorizedNetworksConfig] attr_accessor :master_authorized_networks_config # The monitoring service the cluster should use to write metrics. # Currently available options: # * `monitoring.googleapis.com` - the Google Cloud Monitoring service. # * `none` - no metrics will be exported from the cluster. # * if left as an empty string, `monitoring.googleapis.com` will be used. # Corresponds to the JSON property `monitoringService` # @return [String] attr_accessor :monitoring_service # The name of this cluster. The name must be unique within this project # and zone, and can be up to 40 characters with the following restrictions: # * Lowercase letters, numbers, and hyphens only. # * Must start with a letter. # * Must end with a number or a letter. # Corresponds to the JSON property `name` # @return [String] 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. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Configuration options for the NetworkPolicy feature. # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Corresponds to the JSON property `networkPolicy` # @return [Google::Apis::ContainerV1beta1::NetworkPolicy] attr_accessor :network_policy # Parameters that describe the nodes in a cluster. # Corresponds to the JSON property `nodeConfig` # @return [Google::Apis::ContainerV1beta1::NodeConfig] attr_accessor :node_config # [Output only] The size of the address space on each node for hosting # containers. This is provisioned from within the `container_ipv4_cidr` # range. # Corresponds to the JSON property `nodeIpv4CidrSize` # @return [Fixnum] attr_accessor :node_ipv4_cidr_size # The node pools associated with this cluster. # This field should not be set if "node_config" or "initial_node_count" are # specified. # Corresponds to the JSON property `nodePools` # @return [Array] attr_accessor :node_pools # Configuration for the PodSecurityPolicy feature. # Corresponds to the JSON property `podSecurityPolicyConfig` # @return [Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig] attr_accessor :pod_security_policy_config # The resource labels for the cluster to use to annotate any related GCE # resources. # Corresponds to the JSON property `resourceLabels` # @return [Hash] attr_accessor :resource_labels # [Output only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output only] The IP address range of the Kubernetes services in # this cluster, in # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) # notation (e.g. `1.2.3.4/29`). Service addresses are # typically put in the last `/16` from the container CIDR. # Corresponds to the JSON property `servicesIpv4Cidr` # @return [String] attr_accessor :services_ipv4_cidr # [Output only] The current status of this cluster. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output only] Additional information about the current status of this # cluster, if available. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # The name of the Google Compute Engine # [subnetwork](/compute/docs/subnetworks) to which the # cluster is connected. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork # [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. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @addons_config = args[:addons_config] if args.key?(:addons_config) @cluster_ipv4_cidr = args[:cluster_ipv4_cidr] if args.key?(:cluster_ipv4_cidr) @create_time = args[:create_time] if args.key?(:create_time) @current_master_version = args[:current_master_version] if args.key?(:current_master_version) @current_node_count = args[:current_node_count] if args.key?(:current_node_count) @current_node_version = args[:current_node_version] if args.key?(:current_node_version) @description = args[:description] if args.key?(:description) @enable_kubernetes_alpha = args[:enable_kubernetes_alpha] if args.key?(:enable_kubernetes_alpha) @endpoint = args[:endpoint] if args.key?(:endpoint) @expire_time = args[:expire_time] if args.key?(:expire_time) @initial_cluster_version = args[:initial_cluster_version] if args.key?(:initial_cluster_version) @initial_node_count = args[:initial_node_count] if args.key?(:initial_node_count) @instance_group_urls = args[:instance_group_urls] if args.key?(:instance_group_urls) @ip_allocation_policy = args[:ip_allocation_policy] if args.key?(:ip_allocation_policy) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @legacy_abac = args[:legacy_abac] if args.key?(:legacy_abac) @location = args[:location] if args.key?(:location) @locations = args[:locations] if args.key?(:locations) @logging_service = args[:logging_service] if args.key?(:logging_service) @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy) @master_auth = args[:master_auth] if args.key?(:master_auth) @master_authorized_networks_config = args[:master_authorized_networks_config] if args.key?(:master_authorized_networks_config) @monitoring_service = args[:monitoring_service] if args.key?(:monitoring_service) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @network_policy = args[:network_policy] if args.key?(:network_policy) @node_config = args[:node_config] if args.key?(:node_config) @node_ipv4_cidr_size = args[:node_ipv4_cidr_size] if args.key?(:node_ipv4_cidr_size) @node_pools = args[:node_pools] if args.key?(:node_pools) @pod_security_policy_config = args[:pod_security_policy_config] if args.key?(:pod_security_policy_config) @resource_labels = args[:resource_labels] if args.key?(:resource_labels) @self_link = args[:self_link] if args.key?(:self_link) @services_ipv4_cidr = args[:services_ipv4_cidr] if args.key?(:services_ipv4_cidr) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) @zone = args[:zone] if args.key?(:zone) end end # ClusterUpdate describes an update to the cluster. Exactly one update can # be applied to a cluster with each request, so at most one field can be # provided. class ClusterUpdate include Google::Apis::Core::Hashable # Configuration for the addons that can be automatically spun up in the # cluster, enabling additional functionality. # Corresponds to the JSON property `desiredAddonsConfig` # @return [Google::Apis::ContainerV1beta1::AddonsConfig] attr_accessor :desired_addons_config # The desired image type for the node pool. # NOTE: Set the "desired_node_pool" field as well. # Corresponds to the JSON property `desiredImageType` # @return [String] attr_accessor :desired_image_type # The desired list of Google Compute Engine # [locations](/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] attr_accessor :desired_locations # Configuration options for the master authorized networks feature. Enabled # master authorized networks will disallow all external traffic to access # Kubernetes master through HTTPS except traffic from the given CIDR blocks, # Google Compute Engine Public IPs and Google Prod IPs. # Corresponds to the JSON property `desiredMasterAuthorizedNetworksConfig` # @return [Google::Apis::ContainerV1beta1::MasterAuthorizedNetworksConfig] attr_accessor :desired_master_authorized_networks_config # The Kubernetes version to change the master to. The only valid value is the # latest supported version. Use "-" to have the server automatically select # the latest version. # Corresponds to the JSON property `desiredMasterVersion` # @return [String] attr_accessor :desired_master_version # The monitoring service the cluster should use to write metrics. # Currently available options: # * "monitoring.googleapis.com" - the Google Cloud Monitoring service # * "none" - no metrics will be exported from the cluster # Corresponds to the JSON property `desiredMonitoringService` # @return [String] attr_accessor :desired_monitoring_service # NodePoolAutoscaling contains information required by cluster autoscaler to # adjust the size of the node pool to the current cluster usage. # Corresponds to the JSON property `desiredNodePoolAutoscaling` # @return [Google::Apis::ContainerV1beta1::NodePoolAutoscaling] attr_accessor :desired_node_pool_autoscaling # The node pool to be upgraded. This field is mandatory if # "desired_node_version", "desired_image_family" or # "desired_node_pool_autoscaling" is specified and there is more than one # node pool on the cluster. # Corresponds to the JSON property `desiredNodePoolId` # @return [String] attr_accessor :desired_node_pool_id # The Kubernetes version to change the nodes to (typically an # upgrade). Use `-` to upgrade to the latest version supported by # the server. # Corresponds to the JSON property `desiredNodeVersion` # @return [String] attr_accessor :desired_node_version # Configuration for the PodSecurityPolicy feature. # Corresponds to the JSON property `desiredPodSecurityPolicyConfig` # @return [Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig] attr_accessor :desired_pod_security_policy_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @desired_addons_config = args[:desired_addons_config] if args.key?(:desired_addons_config) @desired_image_type = args[:desired_image_type] if args.key?(:desired_image_type) @desired_locations = args[:desired_locations] if args.key?(:desired_locations) @desired_master_authorized_networks_config = args[:desired_master_authorized_networks_config] if args.key?(:desired_master_authorized_networks_config) @desired_master_version = args[:desired_master_version] if args.key?(:desired_master_version) @desired_monitoring_service = args[:desired_monitoring_service] if args.key?(:desired_monitoring_service) @desired_node_pool_autoscaling = args[:desired_node_pool_autoscaling] if args.key?(:desired_node_pool_autoscaling) @desired_node_pool_id = args[:desired_node_pool_id] if args.key?(:desired_node_pool_id) @desired_node_version = args[:desired_node_version] if args.key?(:desired_node_version) @desired_pod_security_policy_config = args[:desired_pod_security_policy_config] if args.key?(:desired_pod_security_policy_config) end end # CompleteIPRotationRequest moves the cluster master back into single-IP mode. class CompleteIpRotationRequest include Google::Apis::Core::Hashable # The name of the cluster. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster id) of the cluster to complete IP # rotation. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # CreateClusterRequest creates a cluster. class CreateClusterRequest include Google::Apis::Core::Hashable # A Google Kubernetes Engine cluster. # Corresponds to the JSON property `cluster` # @return [Google::Apis::ContainerV1beta1::Cluster] attr_accessor :cluster # The parent (project and location) where the cluster will be created. # Specified in the format 'projects/*/locations/*'. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use parent instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use parent instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster = args[:cluster] if args.key?(:cluster) @parent = args[:parent] if args.key?(:parent) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # CreateNodePoolRequest creates a node pool for a cluster. class CreateNodePoolRequest include Google::Apis::Core::Hashable # The name of the cluster. # This field is deprecated, use parent instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # NodePool contains the name and configuration for a cluster's node pool. # Node pools are a set of nodes (i.e. VM's), with a common configuration and # specification, under the control of the cluster master. They may have a set # of Kubernetes labels applied to them, which may be used to reference them # during pod scheduling. They may also be resized up or down, to accommodate # the workload. # Corresponds to the JSON property `nodePool` # @return [Google::Apis::ContainerV1beta1::NodePool] attr_accessor :node_pool # The parent (project, location, cluster id) where the node pool will be created. # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use parent instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use parent instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @node_pool = args[:node_pool] if args.key?(:node_pool) @parent = args[:parent] if args.key?(:parent) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # Time window specified for daily maintenance operations. class DailyMaintenanceWindow include Google::Apis::Core::Hashable # [Output only] Duration of the time window, automatically chosen to be # smallest possible in the given scenario. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration # Time within the maintenance window to start the maintenance operations. # It must be in format "HH:MM”, where HH : [00-23] and MM : [00-59] GMT. # 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) @duration = args[:duration] if args.key?(:duration) @start_time = args[:start_time] if args.key?(:start_time) 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 # Configuration options for the horizontal pod autoscaling feature, which # increases or decreases the number of replica pods a replication controller # has based on the resource usage of the existing pods. class HorizontalPodAutoscaling include Google::Apis::Core::Hashable # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. # When enabled, it ensures that a Heapster pod is running in the cluster, # which is also used by the Cloud Monitoring service. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled alias_method :disabled?, :disabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disabled = args[:disabled] if args.key?(:disabled) end end # Configuration options for the HTTP (L7) load balancing controller addon, # which makes it easy to set up HTTP load balancers for services in a cluster. class HttpLoadBalancing include Google::Apis::Core::Hashable # Whether the HTTP Load Balancing controller is enabled in the cluster. # When enabled, it runs a small pod in the cluster that manages the load # balancers. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled alias_method :disabled?, :disabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disabled = args[:disabled] if args.key?(:disabled) end end # Configuration for controlling how IPs are allocated in the cluster. class IpAllocationPolicy include Google::Apis::Core::Hashable # If true, allow allocation of cluster CIDR ranges that overlap with certain # kinds of network routes. By default we do not allow cluster CIDR ranges to # intersect with any user declared routes. With allow_route_overlap == true, # we allow overlapping with CIDR ranges that are larger than the cluster CIDR # range. # If this field is set to true, then cluster and services CIDRs must be # fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: # 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and # `services_ipv4_cidr_block` must be fully-specified. # 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be # fully-specified. # Corresponds to the JSON property `allowRouteOverlap` # @return [Boolean] attr_accessor :allow_route_overlap alias_method :allow_route_overlap?, :allow_route_overlap # This field is deprecated, use cluster_ipv4_cidr_block. # Corresponds to the JSON property `clusterIpv4Cidr` # @return [String] attr_accessor :cluster_ipv4_cidr # The IP address range for the cluster pod IPs. If this field is set, then # `cluster.cluster_ipv4_cidr` must be left blank. # This field is only applicable when `use_ip_aliases` is true. # Set to blank to have a range chosen with the default size. # Set to /netmask (e.g. `/14`) to have a range chosen with a specific # netmask. # Set to a # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range # to use. # Corresponds to the JSON property `clusterIpv4CidrBlock` # @return [String] attr_accessor :cluster_ipv4_cidr_block # The name of the secondary range to be used for the cluster CIDR # block. The secondary range will be used for pod IP # addresses. This must be an existing secondary range associated # with the cluster subnetwork. # This field is only applicable with use_ip_aliases and # create_subnetwork is false. # Corresponds to the JSON property `clusterSecondaryRangeName` # @return [String] attr_accessor :cluster_secondary_range_name # Whether a new subnetwork will be created automatically for the cluster. # This field is only applicable when `use_ip_aliases` is true. # Corresponds to the JSON property `createSubnetwork` # @return [Boolean] attr_accessor :create_subnetwork alias_method :create_subnetwork?, :create_subnetwork # This field is deprecated, use node_ipv4_cidr_block. # Corresponds to the JSON property `nodeIpv4Cidr` # @return [String] attr_accessor :node_ipv4_cidr # The IP address range of the instance IPs in this cluster. # This is applicable only if `create_subnetwork` is true. # Set to blank to have a range chosen with the default size. # Set to /netmask (e.g. `/14`) to have a range chosen with a specific # netmask. # Set to a # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range # to use. # Corresponds to the JSON property `nodeIpv4CidrBlock` # @return [String] attr_accessor :node_ipv4_cidr_block # This field is deprecated, use services_ipv4_cidr_block. # Corresponds to the JSON property `servicesIpv4Cidr` # @return [String] attr_accessor :services_ipv4_cidr # The IP address range of the services IPs in this cluster. If blank, a range # will be automatically chosen with the default size. # This field is only applicable when `use_ip_aliases` is true. # Set to blank to have a range chosen with the default size. # Set to /netmask (e.g. `/14`) to have a range chosen with a specific # netmask. # Set to a # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range # to use. # Corresponds to the JSON property `servicesIpv4CidrBlock` # @return [String] attr_accessor :services_ipv4_cidr_block # The name of the secondary range to be used as for the services # CIDR block. The secondary range will be used for service # ClusterIPs. This must be an existing secondary range associated # with the cluster subnetwork. # This field is only applicable with use_ip_aliases and # create_subnetwork is false. # Corresponds to the JSON property `servicesSecondaryRangeName` # @return [String] attr_accessor :services_secondary_range_name # A custom subnetwork name to be used if `create_subnetwork` is true. If # this field is empty, then an automatic name will be chosen for the new # subnetwork. # Corresponds to the JSON property `subnetworkName` # @return [String] attr_accessor :subnetwork_name # Whether alias IPs will be used for pod IPs in the cluster. # Corresponds to the JSON property `useIpAliases` # @return [Boolean] attr_accessor :use_ip_aliases alias_method :use_ip_aliases?, :use_ip_aliases def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allow_route_overlap = args[:allow_route_overlap] if args.key?(:allow_route_overlap) @cluster_ipv4_cidr = args[:cluster_ipv4_cidr] if args.key?(:cluster_ipv4_cidr) @cluster_ipv4_cidr_block = args[:cluster_ipv4_cidr_block] if args.key?(:cluster_ipv4_cidr_block) @cluster_secondary_range_name = args[:cluster_secondary_range_name] if args.key?(:cluster_secondary_range_name) @create_subnetwork = args[:create_subnetwork] if args.key?(:create_subnetwork) @node_ipv4_cidr = args[:node_ipv4_cidr] if args.key?(:node_ipv4_cidr) @node_ipv4_cidr_block = args[:node_ipv4_cidr_block] if args.key?(:node_ipv4_cidr_block) @services_ipv4_cidr = args[:services_ipv4_cidr] if args.key?(:services_ipv4_cidr) @services_ipv4_cidr_block = args[:services_ipv4_cidr_block] if args.key?(:services_ipv4_cidr_block) @services_secondary_range_name = args[:services_secondary_range_name] if args.key?(:services_secondary_range_name) @subnetwork_name = args[:subnetwork_name] if args.key?(:subnetwork_name) @use_ip_aliases = args[:use_ip_aliases] if args.key?(:use_ip_aliases) end end # Configuration for the Kubernetes Dashboard. class KubernetesDashboard include Google::Apis::Core::Hashable # Whether the Kubernetes Dashboard is enabled for this cluster. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled alias_method :disabled?, :disabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disabled = args[:disabled] if args.key?(:disabled) end end # Configuration for the legacy Attribute Based Access Control authorization # mode. class LegacyAbac include Google::Apis::Core::Hashable # Whether the ABAC authorizer is enabled for this cluster. When enabled, # identities in the system, including service accounts, nodes, and # controllers, will have statically granted permissions beyond those # provided by the RBAC configuration or IAM. # 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 # ListClustersResponse is the result of ListClustersRequest. class ListClustersResponse include Google::Apis::Core::Hashable # A list of clusters in the project in the specified zone, or # across all ones. # Corresponds to the JSON property `clusters` # @return [Array] attr_accessor :clusters # If any zones are listed here, the list of clusters returned # may be missing those zones. # Corresponds to the JSON property `missingZones` # @return [Array] attr_accessor :missing_zones def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @clusters = args[:clusters] if args.key?(:clusters) @missing_zones = args[:missing_zones] if args.key?(:missing_zones) end end # ListNodePoolsResponse is the result of ListNodePoolsRequest. class ListNodePoolsResponse include Google::Apis::Core::Hashable # A list of node pools for a cluster. # Corresponds to the JSON property `nodePools` # @return [Array] attr_accessor :node_pools def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @node_pools = args[:node_pools] if args.key?(:node_pools) end end # ListOperationsResponse is the result of ListOperationsRequest. class ListOperationsResponse include Google::Apis::Core::Hashable # If any zones are listed here, the list of operations returned # may be missing the operations from those zones. # Corresponds to the JSON property `missingZones` # @return [Array] attr_accessor :missing_zones # A list of operations in the project in the specified zone. # 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) @missing_zones = args[:missing_zones] if args.key?(:missing_zones) @operations = args[:operations] if args.key?(:operations) end end # MaintenancePolicy defines the maintenance policy to be used for the cluster. class MaintenancePolicy include Google::Apis::Core::Hashable # MaintenanceWindow defines the maintenance window to be used for the cluster. # Corresponds to the JSON property `window` # @return [Google::Apis::ContainerV1beta1::MaintenanceWindow] attr_accessor :window def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @window = args[:window] if args.key?(:window) end end # MaintenanceWindow defines the maintenance window to be used for the cluster. class MaintenanceWindow include Google::Apis::Core::Hashable # Time window specified for daily maintenance operations. # Corresponds to the JSON property `dailyMaintenanceWindow` # @return [Google::Apis::ContainerV1beta1::DailyMaintenanceWindow] attr_accessor :daily_maintenance_window def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @daily_maintenance_window = args[:daily_maintenance_window] if args.key?(:daily_maintenance_window) end end # The authentication information for accessing the master endpoint. # Authentication can be done using HTTP basic auth or using client # certificates. class MasterAuth include Google::Apis::Core::Hashable # [Output only] Base64-encoded public certificate used by clients to # authenticate to the cluster endpoint. # Corresponds to the JSON property `clientCertificate` # @return [String] attr_accessor :client_certificate # Configuration for client certificates on the cluster. # Corresponds to the JSON property `clientCertificateConfig` # @return [Google::Apis::ContainerV1beta1::ClientCertificateConfig] attr_accessor :client_certificate_config # [Output only] Base64-encoded private key used by clients to authenticate # to the cluster endpoint. # Corresponds to the JSON property `clientKey` # @return [String] attr_accessor :client_key # [Output only] Base64-encoded public certificate that is the root of # trust for the cluster. # Corresponds to the JSON property `clusterCaCertificate` # @return [String] attr_accessor :cluster_ca_certificate # The password to use for HTTP basic authentication to the master endpoint. # Because the master endpoint is open to the Internet, you should create a # strong password. If a password is provided for cluster creation, username # must be non-empty. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # The username to use for HTTP basic authentication to the master endpoint. # For clusters v1.6.0 and later, you can disable basic authentication by # providing an empty username. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_certificate = args[:client_certificate] if args.key?(:client_certificate) @client_certificate_config = args[:client_certificate_config] if args.key?(:client_certificate_config) @client_key = args[:client_key] if args.key?(:client_key) @cluster_ca_certificate = args[:cluster_ca_certificate] if args.key?(:cluster_ca_certificate) @password = args[:password] if args.key?(:password) @username = args[:username] if args.key?(:username) end end # Configuration options for the master authorized networks feature. Enabled # master authorized networks will disallow all external traffic to access # Kubernetes master through HTTPS except traffic from the given CIDR blocks, # Google Compute Engine Public IPs and Google Prod IPs. class MasterAuthorizedNetworksConfig include Google::Apis::Core::Hashable # cidr_blocks define up to 10 external networks that could access # Kubernetes master through HTTPS. # Corresponds to the JSON property `cidrBlocks` # @return [Array] attr_accessor :cidr_blocks # Whether or not master authorized networks is enabled. # 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) @cidr_blocks = args[:cidr_blocks] if args.key?(:cidr_blocks) @enabled = args[:enabled] if args.key?(:enabled) end end # Configuration options for the NetworkPolicy feature. # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ class NetworkPolicy include Google::Apis::Core::Hashable # Whether network policy is enabled on the cluster. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # The selected network policy provider. # Corresponds to the JSON property `provider` # @return [String] attr_accessor :provider def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enabled = args[:enabled] if args.key?(:enabled) @provider = args[:provider] if args.key?(:provider) end end # Configuration for NetworkPolicy. This only tracks whether the addon # is enabled or not on the Master, it does not track whether network policy # is enabled for the nodes. class NetworkPolicyConfig include Google::Apis::Core::Hashable # Whether NetworkPolicy is enabled for this cluster. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled alias_method :disabled?, :disabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disabled = args[:disabled] if args.key?(:disabled) end end # Parameters that describe the nodes in a cluster. class NodeConfig include Google::Apis::Core::Hashable # A list of hardware accelerators to be attached to each node. # See https://cloud.google.com/compute/docs/gpus for more information about # support for GPUs. # Corresponds to the JSON property `accelerators` # @return [Array] attr_accessor :accelerators # Size of the disk attached to each node, specified in GB. # The smallest allowed disk size is 10GB. # If unspecified, the default disk size is 100GB. # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] attr_accessor :disk_size_gb # The image type to use for this node. Note that for a given image type, # the latest version of it will be used. # Corresponds to the JSON property `imageType` # @return [String] attr_accessor :image_type # The map of Kubernetes labels (key/value pairs) to be applied to each node. # These will added in addition to any default label(s) that # Kubernetes may apply to the node. # In case of conflict in label keys, the applied set may differ depending on # the Kubernetes version -- it's best to assume the behavior is undefined # and conflicts should be avoided. # For more information, including usage and the valid values, see: # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The number of local SSD disks to be attached to the node. # The limit for this value is dependant upon the maximum number of # disks available on a machine per zone. See: # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits # for more information. # Corresponds to the JSON property `localSsdCount` # @return [Fixnum] attr_accessor :local_ssd_count # The name of a Google Compute Engine [machine # type](/compute/docs/machine-types) (e.g. # `n1-standard-1`). # If unspecified, the default machine type is # `n1-standard-1`. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type # The metadata key/value pairs assigned to instances in the cluster. # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes # in length. These are reflected as part of a URL in the metadata server. # Additionally, to avoid ambiguity, keys must not conflict with any other # metadata keys for the project or be one of the reserved keys: # "cluster-name" # "cluster-uid" # "configure-sh" # "gci-update-strategy" # "gci-ensure-gke-docker" # "instance-template" # "kube-env" # "startup-script" # "user-data" # Values are free-form strings, and only have meaning as interpreted by # the image running in the instance. The only restriction placed on them is # that each value's size must be less than or equal to 32 KB. # The total size of all keys and values must be less than 512 KB. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # Minimum CPU platform to be used by this instance. The instance may be # scheduled on the specified or newer CPU platform. Applicable values are the # friendly names of CPU platforms, such as # minCpuPlatform: "Intel Haswell" or # minCpuPlatform: "Intel Sandy Bridge". For more # information, read [how to specify min CPU platform](https://cloud.google.com/ # compute/docs/instances/specify-min-cpu-platform) # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform # The set of Google API scopes to be made available on all of the # node VMs under the "default" service account. # The following scopes are recommended, but not required, and by default are # not included: # * `https://www.googleapis.com/auth/compute` is required for mounting # 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/)). # 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` # @return [Array] attr_accessor :oauth_scopes # Whether the nodes are created as preemptible VM instances. See: # https://cloud.google.com/compute/docs/instances/preemptible for more # inforamtion about preemptible VM instances. # Corresponds to the JSON property `preemptible` # @return [Boolean] attr_accessor :preemptible alias_method :preemptible?, :preemptible # The Google Cloud Platform Service Account to be used by the node VMs. If # no Service Account is specified, the "default" service account is used. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account # The list of instance tags applied to all nodes. Tags are used to identify # valid sources or targets for network firewalls and are specified by # the client during cluster or node pool creation. Each tag within the list # must comply with RFC1035. # Corresponds to the JSON property `tags` # @return [Array] attr_accessor :tags # List of kubernetes taints to be applied to each node. # For more information, including usage and the valid values, see: # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ # Corresponds to the JSON property `taints` # @return [Array] attr_accessor :taints # WorkloadMetadataConfig defines the metadata configuration to expose to # workloads on the node pool. # Corresponds to the JSON property `workloadMetadataConfig` # @return [Google::Apis::ContainerV1beta1::WorkloadMetadataConfig] attr_accessor :workload_metadata_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accelerators = args[:accelerators] if args.key?(:accelerators) @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) @image_type = args[:image_type] if args.key?(:image_type) @labels = args[:labels] if args.key?(:labels) @local_ssd_count = args[:local_ssd_count] if args.key?(:local_ssd_count) @machine_type = args[:machine_type] if args.key?(:machine_type) @metadata = args[:metadata] if args.key?(:metadata) @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @oauth_scopes = args[:oauth_scopes] if args.key?(:oauth_scopes) @preemptible = args[:preemptible] if args.key?(:preemptible) @service_account = args[:service_account] if args.key?(:service_account) @tags = args[:tags] if args.key?(:tags) @taints = args[:taints] if args.key?(:taints) @workload_metadata_config = args[:workload_metadata_config] if args.key?(:workload_metadata_config) end end # NodeManagement defines the set of node management services turned on for the # node pool. class NodeManagement include Google::Apis::Core::Hashable # Whether the nodes will be automatically repaired. # Corresponds to the JSON property `autoRepair` # @return [Boolean] attr_accessor :auto_repair alias_method :auto_repair?, :auto_repair # Whether the nodes will be automatically upgraded. # Corresponds to the JSON property `autoUpgrade` # @return [Boolean] attr_accessor :auto_upgrade alias_method :auto_upgrade?, :auto_upgrade # AutoUpgradeOptions defines the set of options for the user to control how # the Auto Upgrades will proceed. # Corresponds to the JSON property `upgradeOptions` # @return [Google::Apis::ContainerV1beta1::AutoUpgradeOptions] attr_accessor :upgrade_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_repair = args[:auto_repair] if args.key?(:auto_repair) @auto_upgrade = args[:auto_upgrade] if args.key?(:auto_upgrade) @upgrade_options = args[:upgrade_options] if args.key?(:upgrade_options) end end # NodePool contains the name and configuration for a cluster's node pool. # Node pools are a set of nodes (i.e. VM's), with a common configuration and # specification, under the control of the cluster master. They may have a set # of Kubernetes labels applied to them, which may be used to reference them # during pod scheduling. They may also be resized up or down, to accommodate # the workload. class NodePool include Google::Apis::Core::Hashable # NodePoolAutoscaling contains information required by cluster autoscaler to # adjust the size of the node pool to the current cluster usage. # Corresponds to the JSON property `autoscaling` # @return [Google::Apis::ContainerV1beta1::NodePoolAutoscaling] attr_accessor :autoscaling # Parameters that describe the nodes in a cluster. # Corresponds to the JSON property `config` # @return [Google::Apis::ContainerV1beta1::NodeConfig] attr_accessor :config # The initial node count for the pool. You must ensure that your # Compute Engine resource quota # is sufficient for this number of instances. You must also have available # firewall and routes quota. # Corresponds to the JSON property `initialNodeCount` # @return [Fixnum] attr_accessor :initial_node_count # [Output only] The resource URLs of the [managed instance # groups](/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 # NodeManagement defines the set of node management services turned on for the # node pool. # Corresponds to the JSON property `management` # @return [Google::Apis::ContainerV1beta1::NodeManagement] attr_accessor :management # The name of the node pool. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output only] The status of the nodes in this pool instance. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output only] Additional information about the current status of this # node pool instance, if available. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # The version of the Kubernetes of this node. # 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) @autoscaling = args[:autoscaling] if args.key?(:autoscaling) @config = args[:config] if args.key?(:config) @initial_node_count = args[:initial_node_count] if args.key?(:initial_node_count) @instance_group_urls = args[:instance_group_urls] if args.key?(:instance_group_urls) @management = args[:management] if args.key?(:management) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @version = args[:version] if args.key?(:version) end end # NodePoolAutoscaling contains information required by cluster autoscaler to # adjust the size of the node pool to the current cluster usage. class NodePoolAutoscaling include Google::Apis::Core::Hashable # Is autoscaling enabled for this node pool. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # Maximum number of nodes in the NodePool. Must be >= min_node_count. There # has to enough quota to scale up the cluster. # Corresponds to the JSON property `maxNodeCount` # @return [Fixnum] attr_accessor :max_node_count # Minimum number of nodes in the NodePool. Must be >= 1 and <= # max_node_count. # Corresponds to the JSON property `minNodeCount` # @return [Fixnum] attr_accessor :min_node_count def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enabled = args[:enabled] if args.key?(:enabled) @max_node_count = args[:max_node_count] if args.key?(:max_node_count) @min_node_count = args[:min_node_count] if args.key?(:min_node_count) end end # Kubernetes taint is comprised of three fields: key, value, and effect. Effect # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. # For more information, including usage and the valid values, see: # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ class NodeTaint include Google::Apis::Core::Hashable # Effect for taint. # Corresponds to the JSON property `effect` # @return [String] attr_accessor :effect # Key for taint. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # Value for taint. # 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) @effect = args[:effect] if args.key?(:effect) @key = args[:key] if args.key?(:key) @value = args[:value] if args.key?(:value) end end # This operation resource represents operations that may have happened or are # happening on the cluster. All fields are output only. class Operation include Google::Apis::Core::Hashable # Detailed operation progress, if available. # Corresponds to the JSON property `detail` # @return [String] attr_accessor :detail # [Output only] The time the operation completed, in # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `endTime` # @return [String] 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. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The server-assigned ID for the operation. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The operation type. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output only] The time the operation started, in # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # The current status of the operation. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # If an error has occurred, a textual description of the error. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # Server-defined URL for the target of the operation. # Corresponds to the JSON property `targetLink` # @return [String] 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. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @detail = args[:detail] if args.key?(:detail) @end_time = args[:end_time] if args.key?(:end_time) @location = args[:location] if args.key?(:location) @name = args[:name] if args.key?(:name) @operation_type = args[:operation_type] if args.key?(:operation_type) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @target_link = args[:target_link] if args.key?(:target_link) @zone = args[:zone] if args.key?(:zone) end end # Configuration for the PodSecurityPolicy feature. class PodSecurityPolicyConfig include Google::Apis::Core::Hashable # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods # must be valid under a PodSecurityPolicy to be created. # 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 # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed # NodePool upgrade. This will be an no-op if the last upgrade successfully # completed. class RollbackNodePoolUpgradeRequest include Google::Apis::Core::Hashable # The name of the cluster to rollback. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster, node pool id) of the node poll to # rollback upgrade. # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The name of the node pool to rollback. # This field is deprecated, use name instead. # Corresponds to the JSON property `nodePoolId` # @return [String] attr_accessor :node_pool_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @name = args[:name] if args.key?(:name) @node_pool_id = args[:node_pool_id] if args.key?(:node_pool_id) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # Kubernetes Engine service configuration. class ServerConfig include Google::Apis::Core::Hashable # Version of Kubernetes the service deploys by default. # Corresponds to the JSON property `defaultClusterVersion` # @return [String] attr_accessor :default_cluster_version # Default image type. # Corresponds to the JSON property `defaultImageType` # @return [String] attr_accessor :default_image_type # List of valid image types. # Corresponds to the JSON property `validImageTypes` # @return [Array] attr_accessor :valid_image_types # List of valid master versions. # Corresponds to the JSON property `validMasterVersions` # @return [Array] attr_accessor :valid_master_versions # List of valid node upgrade target versions. # Corresponds to the JSON property `validNodeVersions` # @return [Array] attr_accessor :valid_node_versions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_cluster_version = args[:default_cluster_version] if args.key?(:default_cluster_version) @default_image_type = args[:default_image_type] if args.key?(:default_image_type) @valid_image_types = args[:valid_image_types] if args.key?(:valid_image_types) @valid_master_versions = args[:valid_master_versions] if args.key?(:valid_master_versions) @valid_node_versions = args[:valid_node_versions] if args.key?(:valid_node_versions) end end # SetAddonsRequest sets the addons associated with the cluster. class SetAddonsConfigRequest include Google::Apis::Core::Hashable # Configuration for the addons that can be automatically spun up in the # cluster, enabling additional functionality. # Corresponds to the JSON property `addonsConfig` # @return [Google::Apis::ContainerV1beta1::AddonsConfig] attr_accessor :addons_config # The name of the cluster to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster) of the cluster to set addons. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @addons_config = args[:addons_config] if args.key?(:addons_config) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container # Engine cluster, which will in turn set them for Google Compute Engine # resources used by that cluster class SetLabelsRequest include Google::Apis::Core::Hashable # The name of the cluster. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The fingerprint of the previous set of labels for this resource, # used to detect conflicts. The fingerprint is initially generated by # Kubernetes Engine and changes after every request to modify or update # labels. You must always provide an up-to-date fingerprint hash when # updating or changing labels. Make a get() request to the # resource to get the latest fingerprint. # Corresponds to the JSON property `labelFingerprint` # @return [String] attr_accessor :label_fingerprint # The name (project, location, cluster id) of the cluster to set labels. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The labels to set for that cluster. # Corresponds to the JSON property `resourceLabels` # @return [Hash] attr_accessor :resource_labels # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @resource_labels = args[:resource_labels] if args.key?(:resource_labels) @zone = args[:zone] if args.key?(:zone) end end # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for # a cluster. class SetLegacyAbacRequest include Google::Apis::Core::Hashable # The name of the cluster to update. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # Whether ABAC authorization will be enabled in the cluster. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # The name (project, location, cluster id) of the cluster to set legacy abac. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @enabled = args[:enabled] if args.key?(:enabled) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # SetLocationsRequest sets the locations of the cluster. class SetLocationsRequest include Google::Apis::Core::Hashable # The name of the cluster to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The desired list of Google Compute Engine # [locations](/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/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @locations = args[:locations] if args.key?(:locations) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # SetLoggingServiceRequest sets the logging service of a cluster. class SetLoggingServiceRequest include Google::Apis::Core::Hashable # The name of the cluster to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The logging service the cluster should use to write metrics. # Currently available options: # * "logging.googleapis.com" - the Google Cloud Logging service # * "none" - no metrics will be exported from the cluster # Corresponds to the JSON property `loggingService` # @return [String] attr_accessor :logging_service # The name (project, location, cluster) of the cluster to set logging. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @logging_service = args[:logging_service] if args.key?(:logging_service) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # SetMaintenancePolicyRequest sets the maintenance policy for a cluster. class SetMaintenancePolicyRequest include Google::Apis::Core::Hashable # The name of the cluster to update. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Corresponds to the JSON property `maintenancePolicy` # @return [Google::Apis::ContainerV1beta1::MaintenancePolicy] attr_accessor :maintenance_policy # The name (project, location, cluster id) of the cluster to set maintenance # policy. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # SetMasterAuthRequest updates the admin password of a cluster. class SetMasterAuthRequest include Google::Apis::Core::Hashable # The exact form of action to be taken on the master auth. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # The name of the cluster to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster) of the cluster to set auth. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The authentication information for accessing the master endpoint. # Authentication can be done using HTTP basic auth or using client # certificates. # Corresponds to the JSON property `update` # @return [Google::Apis::ContainerV1beta1::MasterAuth] attr_accessor :update # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @update = args[:update] if args.key?(:update) @zone = args[:zone] if args.key?(:zone) end end # SetMonitoringServiceRequest sets the monitoring service of a cluster. class SetMonitoringServiceRequest include Google::Apis::Core::Hashable # The name of the cluster to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The monitoring service the cluster should use to write metrics. # Currently available options: # * "monitoring.googleapis.com" - the Google Cloud Monitoring service # * "none" - no metrics will be exported from the cluster # Corresponds to the JSON property `monitoringService` # @return [String] attr_accessor :monitoring_service # The name (project, location, cluster) of the cluster to set monitoring. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @monitoring_service = args[:monitoring_service] if args.key?(:monitoring_service) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # SetNetworkPolicyRequest enables/disables network policy for a cluster. class SetNetworkPolicyRequest include Google::Apis::Core::Hashable # The name of the cluster. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster id) of the cluster to set networking # policy. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Configuration options for the NetworkPolicy feature. # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Corresponds to the JSON property `networkPolicy` # @return [Google::Apis::ContainerV1beta1::NetworkPolicy] attr_accessor :network_policy # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @name = args[:name] if args.key?(:name) @network_policy = args[:network_policy] if args.key?(:network_policy) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. class SetNodePoolAutoscalingRequest include Google::Apis::Core::Hashable # NodePoolAutoscaling contains information required by cluster autoscaler to # adjust the size of the node pool to the current cluster usage. # Corresponds to the JSON property `autoscaling` # @return [Google::Apis::ContainerV1beta1::NodePoolAutoscaling] attr_accessor :autoscaling # The name of the cluster to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster, node pool) of the node pool to set # autoscaler settings. Specified in the format # 'projects/*/locations/*/clusters/*/nodePools/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The name of the node pool to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `nodePoolId` # @return [String] attr_accessor :node_pool_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @autoscaling = args[:autoscaling] if args.key?(:autoscaling) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @name = args[:name] if args.key?(:name) @node_pool_id = args[:node_pool_id] if args.key?(:node_pool_id) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # SetNodePoolManagementRequest sets the node management properties of a node # pool. class SetNodePoolManagementRequest include Google::Apis::Core::Hashable # The name of the cluster to update. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # NodeManagement defines the set of node management services turned on for the # node pool. # Corresponds to the JSON property `management` # @return [Google::Apis::ContainerV1beta1::NodeManagement] attr_accessor :management # The name (project, location, cluster, node pool id) of the node pool to set # management properties. Specified in the format # 'projects/*/locations/*/clusters/*/nodePools/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The name of the node pool to update. # This field is deprecated, use name instead. # Corresponds to the JSON property `nodePoolId` # @return [String] attr_accessor :node_pool_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @management = args[:management] if args.key?(:management) @name = args[:name] if args.key?(:name) @node_pool_id = args[:node_pool_id] if args.key?(:node_pool_id) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # SetNodePoolSizeRequest sets the size a node # pool. class SetNodePoolSizeRequest include Google::Apis::Core::Hashable # The name of the cluster to update. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster, node pool id) of the node pool to set # size. # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The desired node count for the pool. # Corresponds to the JSON property `nodeCount` # @return [Fixnum] attr_accessor :node_count # The name of the node pool to update. # This field is deprecated, use name instead. # Corresponds to the JSON property `nodePoolId` # @return [String] attr_accessor :node_pool_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @name = args[:name] if args.key?(:name) @node_count = args[:node_count] if args.key?(:node_count) @node_pool_id = args[:node_pool_id] if args.key?(:node_pool_id) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # StartIPRotationRequest creates a new IP for the cluster and then performs # a node upgrade on each node pool to point to the new IP. class StartIpRotationRequest include Google::Apis::Core::Hashable # The name of the cluster. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster id) of the cluster to start IP rotation. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # UpdateClusterRequest updates the settings of a cluster. class UpdateClusterRequest include Google::Apis::Core::Hashable # The name of the cluster to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster) of the cluster to update. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # ClusterUpdate describes an update to the cluster. Exactly one update can # be applied to a cluster with each request, so at most one field can be # provided. # Corresponds to the JSON property `update` # @return [Google::Apis::ContainerV1beta1::ClusterUpdate] attr_accessor :update # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @update = args[:update] if args.key?(:update) @zone = args[:zone] if args.key?(:zone) end end # UpdateMasterRequest updates the master of the cluster. class UpdateMasterRequest include Google::Apis::Core::Hashable # The name of the cluster to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The Kubernetes version to change the master to. The only valid value is the # latest supported version. Use "-" to have the server automatically select # the latest version. # Corresponds to the JSON property `masterVersion` # @return [String] attr_accessor :master_version # The name (project, location, cluster) of the cluster to update. # Specified in the format 'projects/*/locations/*/clusters/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @master_version = args[:master_version] if args.key?(:master_version) @name = args[:name] if args.key?(:name) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # SetNodePoolVersionRequest updates the version of a node pool. class UpdateNodePoolRequest include Google::Apis::Core::Hashable # The name of the cluster to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The desired image type for the node pool. # Corresponds to the JSON property `imageType` # @return [String] attr_accessor :image_type # The name (project, location, cluster, node pool) of the node pool to update. # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The name of the node pool to upgrade. # This field is deprecated, use name instead. # Corresponds to the JSON property `nodePoolId` # @return [String] attr_accessor :node_pool_id # The Kubernetes version to change the nodes to (typically an # upgrade). Use `-` to upgrade to the latest version supported by # the server. # Corresponds to the JSON property `nodeVersion` # @return [String] attr_accessor :node_version # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @image_type = args[:image_type] if args.key?(:image_type) @name = args[:name] if args.key?(:name) @node_pool_id = args[:node_pool_id] if args.key?(:node_pool_id) @node_version = args[:node_version] if args.key?(:node_version) @project_id = args[:project_id] if args.key?(:project_id) @zone = args[:zone] if args.key?(:zone) end end # WorkloadMetadataConfig defines the metadata configuration to expose to # workloads on the node pool. class WorkloadMetadataConfig include Google::Apis::Core::Hashable # NodeMetadata is the configuration for if and how to expose the node # metadata to the workload running on the node. # Corresponds to the JSON property `nodeMetadata` # @return [String] attr_accessor :node_metadata def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @node_metadata = args[:node_metadata] if args.key?(:node_metadata) end end end end end google-api-client-0.19.8/generated/google/apis/container_v1beta1/service.rb0000644000004100000410000047745113252673043026627 0ustar www-datawww-data# 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 ContainerV1beta1 # Google Kubernetes Engine API # # The Google Kubernetes Engine API is used for building and managing container # based applications, powered by the open source Kubernetes technology. # # @example # require 'google/apis/container_v1beta1' # # Container = Google::Apis::ContainerV1beta1 # Alias the module # service = Container::ContainerService.new # # @see https://cloud.google.com/container-engine/ class ContainerService < 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://container.googleapis.com/', '') @batch_path = 'batch' end # Returns configuration info about the Kubernetes Engine service. # @param [String] name # The name (project and location) of the server config to get # Specified in the format 'projects/*/locations/*'. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine [zone](/compute/docs/zones#available) # to return operations for. # This field is deprecated, use name instead. # @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::ContainerV1beta1::ServerConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::ServerConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_server_config(name, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}/serverConfig', options) command.response_representation = Google::Apis::ContainerV1beta1::ServerConfig::Representation command.response_class = Google::Apis::ContainerV1beta1::ServerConfig command.params['name'] = name unless name.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['zone'] = zone unless zone.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # 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/*'. # @param [Google::Apis::ContainerV1beta1::CompleteIpRotationRequest] complete_ip_rotation_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 complete_project_location_cluster_ip_rotation(name, complete_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:completeIpRotation', options) command.request_representation = Google::Apis::ContainerV1beta1::CompleteIpRotationRequest::Representation command.request_object = complete_ip_rotation_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # 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). # One firewall is added for the cluster. After cluster creation, # the cluster creates routes for each node to allow the containers # on that node to communicate with all other instances in the # cluster. # Finally, an entry is added to the project's global metadata indicating # which CIDR range is being used by the cluster. # @param [String] parent # The parent (project and location) where the cluster will be created. # 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. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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_location_cluster(parent, create_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/clusters', options) command.request_representation = Google::Apis::ContainerV1beta1::CreateClusterRequest::Representation command.request_object = create_cluster_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 the cluster, including the Kubernetes endpoint and all worker # nodes. # Firewalls and routes that were configured during cluster creation # are also deleted. # Other Google Compute Engine resources that might be in use by the cluster # (e.g. load balancer resources) will not be deleted if they weren't present # at the initial create time. # @param [String] name # The name (project, location, cluster) of the cluster to delete. # Specified in the format 'projects/*/locations/*/clusters/*'. # @param [String] cluster_id # The name of the cluster to delete. # This field is deprecated, use name instead. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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_project_location_cluster(name, cluster_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['name'] = name unless name.nil? command.query['clusterId'] = cluster_id unless cluster_id.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['zone'] = zone unless zone.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 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/*'. # @param [String] cluster_id # The name of the cluster to retrieve. # This field is deprecated, use name instead. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @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::ContainerV1beta1::Cluster] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::Cluster] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_cluster(name, cluster_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::ContainerV1beta1::Cluster::Representation command.response_class = Google::Apis::ContainerV1beta1::Cluster command.params['name'] = name unless name.nil? command.query['clusterId'] = cluster_id unless cluster_id.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['zone'] = zone unless zone.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 clusters owned by a project in either the specified zone or all # zones. # @param [String] parent # The parent (project and location) where the clusters will be listed. # Specified in the format 'projects/*/locations/*'. # Location "-" matches all zones and all regions. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use parent instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides, or "-" for all zones. # This field is deprecated, use parent instead. # @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::ContainerV1beta1::ListClustersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::ListClustersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_clusters(parent, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/clusters', options) command.response_representation = Google::Apis::ContainerV1beta1::ListClustersResponse::Representation command.response_class = Google::Apis::ContainerV1beta1::ListClustersResponse command.params['parent'] = parent unless parent.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['zone'] = zone unless zone.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 addons of a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to set addons. # 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. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_cluster_addons_config(name, set_addons_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setAddons', options) command.request_representation = Google::Apis::ContainerV1beta1::SetAddonsConfigRequest::Representation command.request_object = set_addons_config_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # 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/*'. # @param [Google::Apis::ContainerV1beta1::SetLegacyAbacRequest] set_legacy_abac_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_cluster_legacy_abac(name, set_legacy_abac_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setLegacyAbac', options) command.request_representation = Google::Apis::ContainerV1beta1::SetLegacyAbacRequest::Representation command.request_object = set_legacy_abac_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Sets the locations of a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to set locations. # 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. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_cluster_locations(name, set_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setLocations', options) command.request_representation = Google::Apis::ContainerV1beta1::SetLocationsRequest::Representation command.request_object = set_locations_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Sets the logging service of a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to set logging. # 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. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_cluster_logging_service(name, set_logging_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setLogging', options) command.request_representation = Google::Apis::ContainerV1beta1::SetLoggingServiceRequest::Representation command.request_object = set_logging_service_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Sets the maintenance policy for a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set maintenance # policy. # 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. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_location_cluster_maintenance_policy(name, set_maintenance_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setMaintenancePolicy', options) command.request_representation = Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest::Representation command.request_object = set_maintenance_policy_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Used to set master auth materials. Currently supports :- # Changing the admin password of a specific cluster. # This can be either via password generation or explicitly set. # Modify basic_auth.csv and reset the K8S API server. # @param [String] name # The name (project, location, cluster) of the cluster to set auth. # 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. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_location_cluster_master_auth(name, set_master_auth_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setMasterAuth', options) command.request_representation = Google::Apis::ContainerV1beta1::SetMasterAuthRequest::Representation command.request_object = set_master_auth_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Sets the monitoring service of a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to set monitoring. # 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. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_cluster_monitoring_service(name, set_monitoring_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setMonitoring', options) command.request_representation = Google::Apis::ContainerV1beta1::SetMonitoringServiceRequest::Representation command.request_object = set_monitoring_service_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Enables/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/*'. # @param [Google::Apis::ContainerV1beta1::SetNetworkPolicyRequest] set_network_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_location_cluster_network_policy(name, set_network_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setNetworkPolicy', options) command.request_representation = Google::Apis::ContainerV1beta1::SetNetworkPolicyRequest::Representation command.request_object = set_network_policy_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # 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/*'. # @param [Google::Apis::ContainerV1beta1::SetLabelsRequest] set_labels_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_location_cluster_resource_labels(name, set_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setResourceLabels', options) command.request_representation = Google::Apis::ContainerV1beta1::SetLabelsRequest::Representation command.request_object = set_labels_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Start 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/*'. # @param [Google::Apis::ContainerV1beta1::StartIpRotationRequest] start_ip_rotation_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 start_project_location_cluster_ip_rotation(name, start_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:startIpRotation', options) command.request_representation = Google::Apis::ContainerV1beta1::StartIpRotationRequest::Representation command.request_object = start_ip_rotation_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # 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/*'. # @param [Google::Apis::ContainerV1beta1::UpdateClusterRequest] update_cluster_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 update_project_location_cluster(name, update_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta1/{+name}', options) command.request_representation = Google::Apis::ContainerV1beta1::UpdateClusterRequest::Representation command.request_object = update_cluster_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Updates the master of a specific cluster. # @param [String] name # The name (project, location, cluster) of the cluster to update. # 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. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 update_cluster_master(name, update_master_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:updateMaster', options) command.request_representation = Google::Apis::ContainerV1beta1::UpdateMasterRequest::Representation command.request_object = update_master_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Creates a node pool for a cluster. # @param [String] parent # The parent (project, location, cluster id) where the node pool will be created. # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. # @param [Google::Apis::ContainerV1beta1::CreateNodePoolRequest] create_node_pool_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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_location_cluster_node_pool(parent, create_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/nodePools', options) command.request_representation = Google::Apis::ContainerV1beta1::CreateNodePoolRequest::Representation command.request_object = create_node_pool_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 node pool from a cluster. # @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/*'. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use name instead. # @param [String] node_pool_id # The name of the node pool to delete. # This field is deprecated, use name instead. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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_project_location_cluster_node_pool(name, cluster_id: nil, node_pool_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['name'] = name unless name.nil? command.query['clusterId'] = cluster_id unless cluster_id.nil? command.query['nodePoolId'] = node_pool_id unless node_pool_id.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['zone'] = zone unless zone.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 node pool requested. # @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/*'. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use name instead. # @param [String] node_pool_id # The name of the node pool. # This field is deprecated, use name instead. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @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::ContainerV1beta1::NodePool] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::NodePool] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_cluster_node_pool(name, cluster_id: nil, node_pool_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::ContainerV1beta1::NodePool::Representation command.response_class = Google::Apis::ContainerV1beta1::NodePool command.params['name'] = name unless name.nil? command.query['clusterId'] = cluster_id unless cluster_id.nil? command.query['nodePoolId'] = node_pool_id unless node_pool_id.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['zone'] = zone unless zone.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 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/*'. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use parent instead. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use parent instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use parent instead. # @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::ContainerV1beta1::ListNodePoolsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::ListNodePoolsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_cluster_node_pools(parent, cluster_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/nodePools', options) command.response_representation = Google::Apis::ContainerV1beta1::ListNodePoolsResponse::Representation command.response_class = Google::Apis::ContainerV1beta1::ListNodePoolsResponse command.params['parent'] = parent unless parent.nil? command.query['clusterId'] = cluster_id unless cluster_id.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['zone'] = zone unless zone.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Roll back the previously Aborted or Failed NodePool upgrade. # This will be an no-op if the last upgrade successfully completed. # @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/*'. # @param [Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest] rollback_node_pool_upgrade_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 rollback_project_location_cluster_node_pool(name, rollback_node_pool_upgrade_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:rollback', options) command.request_representation = Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest::Representation command.request_object = rollback_node_pool_upgrade_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Sets the autoscaling settings of a specific node pool. # @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/*'. # @param [Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest] set_node_pool_autoscaling_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_location_cluster_node_pool_autoscaling(name, set_node_pool_autoscaling_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setAutoscaling', options) command.request_representation = Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest::Representation command.request_object = set_node_pool_autoscaling_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Sets the NodeManagement options for a node pool. # @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/*'. # @param [Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest] set_node_pool_management_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_location_cluster_node_pool_management(name, set_node_pool_management_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setManagement', options) command.request_representation = Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest::Representation command.request_object = set_node_pool_management_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Sets the size of a specific node pool. # @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/*'. # @param [Google::Apis::ContainerV1beta1::SetNodePoolSizeRequest] set_node_pool_size_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_location_cluster_node_pool_size(name, set_node_pool_size_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:setSize', options) command.request_representation = Google::Apis::ContainerV1beta1::SetNodePoolSizeRequest::Representation command.request_object = set_node_pool_size_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # Updates the version and/or image type of a specific node pool. # @param [String] name # The name (project, location, cluster, node pool) of the node pool to update. # Specified in the format '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. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 update_project_location_cluster_node_pool(name, update_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta1/{+name}', options) command.request_representation = Google::Apis::ContainerV1beta1::UpdateNodePoolRequest::Representation command.request_object = update_node_pool_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::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 # 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/*'. # @param [Google::Apis::ContainerV1beta1::CancelOperationRequest] cancel_operation_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::ContainerV1beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 cancel_project_location_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options) command.request_representation = Google::Apis::ContainerV1beta1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::ContainerV1beta1::Empty::Representation command.response_class = Google::Apis::ContainerV1beta1::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 the specified operation. # @param [String] name # The name (project, location, operation id) of the operation to get. # Specified in the format 'projects/*/locations/*/operations/*'. # @param [String] operation_id # The server-assigned `name` of the operation. # This field is deprecated, use name instead. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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_location_operation(name, operation_id: nil, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['name'] = name unless name.nil? command.query['operationId'] = operation_id unless operation_id.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['zone'] = zone unless zone.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 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/*'. # Location "-" matches all zones and all regions. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use parent instead. # @param [String] zone # The name of the Google Compute Engine [zone](/compute/docs/zones#available) # to return operations for, or `-` for all zones. # This field is deprecated, use parent instead. # @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::ContainerV1beta1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operations(parent, project_id: nil, zone: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/operations', options) command.response_representation = Google::Apis::ContainerV1beta1::ListOperationsResponse::Representation command.response_class = Google::Apis::ContainerV1beta1::ListOperationsResponse command.params['parent'] = parent unless parent.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['zone'] = zone unless zone.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 configuration info about the Kubernetes Engine service. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine [zone](/compute/docs/zones#available) # to return operations for. # This field is deprecated, use name instead. # @param [String] name # The name (project and location) of the server config to get # Specified in the format 'projects/*/locations/*'. # @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::ContainerV1beta1::ServerConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::ServerConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zone_serverconfig(project_id, zone, name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/serverconfig', options) command.response_representation = Google::Apis::ContainerV1beta1::ServerConfig::Representation command.response_class = Google::Apis::ContainerV1beta1::ServerConfig command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.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 # Sets the addons of a specific cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to upgrade. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetAddonsConfigRequest] set_addons_config_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 addons_project_zone_cluster(project_id, zone, cluster_id, set_addons_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons', options) command.request_representation = Google::Apis::ContainerV1beta1::SetAddonsConfigRequest::Representation command.request_object = set_addons_config_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Completes master IP rotation. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::CompleteIpRotationRequest] complete_ip_rotation_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 complete_project_zone_cluster_ip_rotation(project_id, zone, cluster_id, complete_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation', options) command.request_representation = Google::Apis::ContainerV1beta1::CompleteIpRotationRequest::Representation command.request_object = complete_ip_rotation_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # 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). # One firewall is added for the cluster. After cluster creation, # the cluster creates routes for each node to allow the containers # on that node to communicate with all other instances in the # cluster. # Finally, an entry is added to the project's global metadata indicating # which CIDR range is being used by the cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use parent instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use parent instead. # @param [Google::Apis::ContainerV1beta1::CreateClusterRequest] create_cluster_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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_cluster(project_id, zone, create_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters', options) command.request_representation = Google::Apis::ContainerV1beta1::CreateClusterRequest::Representation command.request_object = create_cluster_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.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 cluster, including the Kubernetes endpoint and all worker # nodes. # Firewalls and routes that were configured during cluster creation # are also deleted. # Other Google Compute Engine resources that might be in use by the cluster # (e.g. load balancer resources) will not be deleted if they weren't present # at the initial create time. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to delete. # This field is deprecated, use name instead. # @param [String] name # The name (project, location, cluster) of the cluster to delete. # Specified in the format 'projects/*/locations/*/clusters/*'. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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_zone_cluster(project_id, zone, cluster_id, name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}', options) command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['clusterId'] = cluster_id unless cluster_id.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 # Gets the details of a specific cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to retrieve. # This field is deprecated, use name instead. # @param [String] name # The name (project, location, cluster) of the cluster to retrieve. # Specified in the format 'projects/*/locations/*/clusters/*'. # @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::ContainerV1beta1::Cluster] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::Cluster] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zone_cluster(project_id, zone, cluster_id, name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}', options) command.response_representation = Google::Apis::ContainerV1beta1::Cluster::Representation command.response_class = Google::Apis::ContainerV1beta1::Cluster command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['clusterId'] = cluster_id unless cluster_id.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 # Enables or disables the ABAC authorization mechanism on a cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to update. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetLegacyAbacRequest] set_legacy_abac_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 legacy_project_zone_cluster_abac(project_id, zone, cluster_id, set_legacy_abac_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac', options) command.request_representation = Google::Apis::ContainerV1beta1::SetLegacyAbacRequest::Representation command.request_object = set_legacy_abac_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Lists all clusters owned by a project in either the specified zone or all # zones. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use parent instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides, or "-" for all zones. # This field is deprecated, use parent instead. # @param [String] parent # The parent (project and location) where the clusters will be listed. # 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. # @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::ContainerV1beta1::ListClustersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::ListClustersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zone_clusters(project_id, zone, parent: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/clusters', options) command.response_representation = Google::Apis::ContainerV1beta1::ListClustersResponse::Representation command.response_class = Google::Apis::ContainerV1beta1::ListClustersResponse command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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 # Sets the locations of a specific cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to upgrade. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetLocationsRequest] set_locations_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 locations_project_zone_cluster(project_id, zone, cluster_id, set_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations', options) command.request_representation = Google::Apis::ContainerV1beta1::SetLocationsRequest::Representation command.request_object = set_locations_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Sets the logging service of a specific cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # @param [String] cluster_id # The name of the cluster to upgrade. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetLoggingServiceRequest] set_logging_service_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 logging_project_zone_cluster(project_id, zone, cluster_id, set_logging_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging', options) command.request_representation = Google::Apis::ContainerV1beta1::SetLoggingServiceRequest::Representation command.request_object = set_logging_service_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Updates the master of a specific cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to upgrade. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::UpdateMasterRequest] update_master_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 master_project_zone_cluster(project_id, zone, cluster_id, update_master_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master', options) command.request_representation = Google::Apis::ContainerV1beta1::UpdateMasterRequest::Representation command.request_object = update_master_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Sets the monitoring service of a specific cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to upgrade. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetMonitoringServiceRequest] set_monitoring_service_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 monitoring_project_zone_cluster(project_id, zone, cluster_id, set_monitoring_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring', options) command.request_representation = Google::Apis::ContainerV1beta1::SetMonitoringServiceRequest::Representation command.request_object = set_monitoring_service_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Sets labels on a cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetLabelsRequest] set_labels_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 resource_project_zone_cluster_labels(project_id, zone, cluster_id, set_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels', options) command.request_representation = Google::Apis::ContainerV1beta1::SetLabelsRequest::Representation command.request_object = set_labels_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Sets the maintenance policy for a cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # @param [String] cluster_id # The name of the cluster to update. # @param [Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest] set_maintenance_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_zone_cluster_maintenance_policy(project_id, zone, cluster_id, set_maintenance_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy', options) command.request_representation = Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest::Representation command.request_object = set_maintenance_policy_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Used to set master auth materials. Currently supports :- # Changing the admin password of a specific cluster. # This can be either via password generation or explicitly set. # Modify basic_auth.csv and reset the K8S API server. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to upgrade. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetMasterAuthRequest] set_master_auth_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_zone_cluster_master_auth(project_id, zone, cluster_id, set_master_auth_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth', options) command.request_representation = Google::Apis::ContainerV1beta1::SetMasterAuthRequest::Representation command.request_object = set_master_auth_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Enables/Disables Network Policy for a cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetNetworkPolicyRequest] set_network_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_zone_cluster_network_policy(project_id, zone, cluster_id, set_network_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy', options) command.request_representation = Google::Apis::ContainerV1beta1::SetNetworkPolicyRequest::Representation command.request_object = set_network_policy_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Start master IP rotation. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::StartIpRotationRequest] start_ip_rotation_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 start_project_zone_cluster_ip_rotation(project_id, zone, cluster_id, start_ip_rotation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation', options) command.request_representation = Google::Apis::ContainerV1beta1::StartIpRotationRequest::Representation command.request_object = start_ip_rotation_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Updates the settings of a specific cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to upgrade. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::UpdateClusterRequest] update_cluster_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 update_project_zone_cluster(project_id, zone, cluster_id, update_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}', options) command.request_representation = Google::Apis::ContainerV1beta1::UpdateClusterRequest::Representation command.request_object = update_cluster_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Sets the autoscaling settings of a specific node pool. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to upgrade. # This field is deprecated, use name instead. # @param [String] node_pool_id # The name of the node pool to upgrade. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest] set_node_pool_autoscaling_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 autoscaling_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, set_node_pool_autoscaling_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling', options) command.request_representation = Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest::Representation command.request_object = set_node_pool_autoscaling_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['clusterId'] = cluster_id unless cluster_id.nil? command.params['nodePoolId'] = node_pool_id unless node_pool_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 node pool for a cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use parent instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use parent instead. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use parent instead. # @param [Google::Apis::ContainerV1beta1::CreateNodePoolRequest] create_node_pool_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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_zone_cluster_node_pool(project_id, zone, cluster_id, create_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools', options) command.request_representation = Google::Apis::ContainerV1beta1::CreateNodePoolRequest::Representation command.request_object = create_node_pool_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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? execute_or_queue_command(command, &block) end # Deletes a node pool from a cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use name instead. # @param [String] node_pool_id # The name of the node pool to delete. # This field is deprecated, use name instead. # @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/*'. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}', options) command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['clusterId'] = cluster_id unless cluster_id.nil? command.params['nodePoolId'] = node_pool_id unless node_pool_id.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 # Retrieves the node pool requested. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use name instead. # @param [String] node_pool_id # The name of the node pool. # This field is deprecated, use name instead. # @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/*'. # @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::ContainerV1beta1::NodePool] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::NodePool] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}', options) command.response_representation = Google::Apis::ContainerV1beta1::NodePool::Representation command.response_class = Google::Apis::ContainerV1beta1::NodePool command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['clusterId'] = cluster_id unless cluster_id.nil? command.params['nodePoolId'] = node_pool_id unless node_pool_id.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 # Lists the node pools for a cluster. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://developers.google.com/console/help/new/#projectnumber). # This field is deprecated, use parent instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use parent instead. # @param [String] cluster_id # The name of the cluster. # This field is deprecated, use parent instead. # @param [String] parent # The parent (project, location, cluster id) where the node pools will be 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContainerV1beta1::ListNodePoolsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::ListNodePoolsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zone_cluster_node_pools(project_id, zone, cluster_id, parent: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools', options) command.response_representation = Google::Apis::ContainerV1beta1::ListNodePoolsResponse::Representation command.response_class = Google::Apis::ContainerV1beta1::ListNodePoolsResponse command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['clusterId'] = cluster_id unless cluster_id.nil? 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 # Roll back the previously Aborted or Failed NodePool upgrade. # This will be an no-op if the last upgrade successfully completed. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to rollback. # This field is deprecated, use name instead. # @param [String] node_pool_id # The name of the node pool to rollback. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest] rollback_node_pool_upgrade_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 rollback_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, rollback_node_pool_upgrade_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback', options) command.request_representation = Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest::Representation command.request_object = rollback_node_pool_upgrade_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['clusterId'] = cluster_id unless cluster_id.nil? command.params['nodePoolId'] = node_pool_id unless node_pool_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 # Sets the NodeManagement options for a node pool. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to update. # This field is deprecated, use name instead. # @param [String] node_pool_id # The name of the node pool to update. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest] set_node_pool_management_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_zone_cluster_node_pool_management(project_id, zone, cluster_id, node_pool_id, set_node_pool_management_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement', options) command.request_representation = Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest::Representation command.request_object = set_node_pool_management_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['clusterId'] = cluster_id unless cluster_id.nil? command.params['nodePoolId'] = node_pool_id unless node_pool_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 # Sets the size of a specific node pool. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to update. # This field is deprecated, use name instead. # @param [String] node_pool_id # The name of the node pool to update. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::SetNodePoolSizeRequest] set_node_pool_size_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 set_project_zone_cluster_node_pool_size(project_id, zone, cluster_id, node_pool_id, set_node_pool_size_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize', options) command.request_representation = Google::Apis::ContainerV1beta1::SetNodePoolSizeRequest::Representation command.request_object = set_node_pool_size_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['clusterId'] = cluster_id unless cluster_id.nil? command.params['nodePoolId'] = node_pool_id unless node_pool_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 the version and/or image type of a specific node pool. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] cluster_id # The name of the cluster to upgrade. # This field is deprecated, use name instead. # @param [String] node_pool_id # The name of the node pool to upgrade. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::UpdateNodePoolRequest] update_node_pool_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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 update_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, update_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update', options) command.request_representation = Google::Apis::ContainerV1beta1::UpdateNodePoolRequest::Representation command.request_object = update_node_pool_request_object command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['clusterId'] = cluster_id unless cluster_id.nil? command.params['nodePoolId'] = node_pool_id unless node_pool_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 # Cancels the specified operation. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the operation resides. # This field is deprecated, use name instead. # @param [String] operation_id # The server-assigned `name` of the operation. # This field is deprecated, use name instead. # @param [Google::Apis::ContainerV1beta1::CancelOperationRequest] cancel_operation_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::ContainerV1beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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 cancel_project_zone_operation(project_id, zone, operation_id, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel', options) command.request_representation = Google::Apis::ContainerV1beta1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::ContainerV1beta1::Empty::Representation command.response_class = Google::Apis::ContainerV1beta1::Empty command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['operationId'] = operation_id unless operation_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 the specified operation. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use name instead. # @param [String] zone # The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. # This field is deprecated, use name instead. # @param [String] operation_id # The server-assigned `name` of the operation. # This field is deprecated, use name instead. # @param [String] name # The name (project, location, operation id) of the operation to get. # Specified in the format 'projects/*/locations/*/operations/*'. # @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::ContainerV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::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_zone_operation(project_id, zone, operation_id, name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}', options) command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation command.response_class = Google::Apis::ContainerV1beta1::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? command.params['operationId'] = operation_id unless operation_id.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 # Lists all operations in a project in a specific zone or all zones. # @param [String] project_id # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # This field is deprecated, use parent instead. # @param [String] zone # The name of the Google Compute Engine [zone](/compute/docs/zones#available) # to return operations for, or `-` for all zones. # This field is deprecated, use parent instead. # @param [String] parent # The parent (project and location) where the operations will be listed. # 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. # @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::ContainerV1beta1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContainerV1beta1::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zone_operations(project_id, zone, parent: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/projects/{projectId}/zones/{zone}/operations', options) command.response_representation = Google::Apis::ContainerV1beta1::ListOperationsResponse::Representation command.response_class = Google::Apis::ContainerV1beta1::ListOperationsResponse command.params['projectId'] = project_id unless project_id.nil? command.params['zone'] = zone unless zone.nil? 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 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 google-api-client-0.19.8/generated/google/apis/adexchangebuyer2_v2beta1.rb0000644000004100000410000000245613252673043026413 0ustar www-datawww-data# 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/adexchangebuyer2_v2beta1/service.rb' require 'google/apis/adexchangebuyer2_v2beta1/classes.rb' require 'google/apis/adexchangebuyer2_v2beta1/representations.rb' module Google module Apis # Ad Exchange Buyer API II # # Accesses the latest features for managing Ad Exchange accounts, Real-Time # Bidding configurations and auction metrics, and Marketplace programmatic deals. # # @see https://developers.google.com/ad-exchange/buyer-rest/reference/rest/ module Adexchangebuyer2V2beta1 VERSION = 'V2beta1' REVISION = '20180215' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' end end end google-api-client-0.19.8/generated/google/apis/civicinfo_v2.rb0000644000004100000410000000212013252673043024213 0ustar www-datawww-data# 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/civicinfo_v2/service.rb' require 'google/apis/civicinfo_v2/classes.rb' require 'google/apis/civicinfo_v2/representations.rb' module Google module Apis # Google Civic Information API # # Provides polling places, early vote locations, contest data, election # officials, and government representatives for U.S. residential addresses. # # @see https://developers.google.com/civic-information module CivicinfoV2 VERSION = 'V2' REVISION = '20161102' end end end google-api-client-0.19.8/generated/google/apis/script_v1.rb0000644000004100000410000000441213252673044023554 0ustar www-datawww-data# 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/script_v1/service.rb' require 'google/apis/script_v1/classes.rb' require 'google/apis/script_v1/representations.rb' module Google module Apis # Google Apps Script API # # An API for managing and executing Google Apps Script projects. # # @see https://developers.google.com/apps-script/api/ module ScriptV1 VERSION = 'V1' REVISION = '20180118' # Read, send, delete, and manage your email AUTH_SCOPE = 'https://mail.google.com/' # Manage your calendars CALENDAR_FEEDS = 'https://www.google.com/calendar/feeds' # Manage your contacts M8_FEEDS = 'https://www.google.com/m8/feeds' # View and manage the provisioning of groups on your domain AUTH_ADMIN_DIRECTORY_GROUP = 'https://www.googleapis.com/auth/admin.directory.group' # View and manage the provisioning of users on your domain AUTH_ADMIN_DIRECTORY_USER = 'https://www.googleapis.com/auth/admin.directory.user' # View and manage the files in your Google Drive AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' # View and manage your forms in Google Drive AUTH_FORMS = 'https://www.googleapis.com/auth/forms' # View and manage forms that this application has been installed in AUTH_FORMS_CURRENTONLY = 'https://www.googleapis.com/auth/forms.currentonly' # View and manage your Google Groups AUTH_GROUPS = 'https://www.googleapis.com/auth/groups' # View and manage your spreadsheets in Google Drive AUTH_SPREADSHEETS = 'https://www.googleapis.com/auth/spreadsheets' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' end end end google-api-client-0.19.8/generated/google/apis/translate_v2/0000755000004100000410000000000013252673044023720 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/translate_v2/representations.rb0000644000004100000410000001434013252673044027474 0ustar www-datawww-data# 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 TranslateV2 class DetectLanguageRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDetectionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DetectionsResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetSupportedLanguagesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLanguagesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LanguagesResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TranslateTextRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTranslationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TranslationsResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DetectLanguageRequest # @private class Representation < Google::Apis::Core::JsonRepresentation self.representation_wrap = lambda { |args| :data if args[:unwrap] == Google::Apis::TranslateV2::DetectLanguageRequest } collection :q, as: 'q' end end class ListDetectionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation self.representation_wrap = lambda { |args| :data if args[:unwrap] == Google::Apis::TranslateV2::ListDetectionsResponse } collection :detections, as: 'detections', :class => Array do include Representable::JSON::Collection items class: Google::Apis::TranslateV2::DetectionsResource, decorator: Google::Apis::TranslateV2::DetectionsResource::Representation end end end class DetectionsResource # @private class Representation < Google::Apis::Core::JsonRepresentation self.representation_wrap = lambda { |args| :data if args[:unwrap] == Google::Apis::TranslateV2::DetectionsResource } property :confidence, as: 'confidence' property :is_reliable, as: 'isReliable' property :language, as: 'language' end end class GetSupportedLanguagesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation self.representation_wrap = lambda { |args| :data if args[:unwrap] == Google::Apis::TranslateV2::GetSupportedLanguagesRequest } property :target, as: 'target' end end class ListLanguagesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation self.representation_wrap = lambda { |args| :data if args[:unwrap] == Google::Apis::TranslateV2::ListLanguagesResponse } collection :languages, as: 'languages', class: Google::Apis::TranslateV2::LanguagesResource, decorator: Google::Apis::TranslateV2::LanguagesResource::Representation end end class LanguagesResource # @private class Representation < Google::Apis::Core::JsonRepresentation self.representation_wrap = lambda { |args| :data if args[:unwrap] == Google::Apis::TranslateV2::LanguagesResource } property :language, as: 'language' property :name, as: 'name' end end class TranslateTextRequest # @private class Representation < Google::Apis::Core::JsonRepresentation self.representation_wrap = lambda { |args| :data if args[:unwrap] == Google::Apis::TranslateV2::TranslateTextRequest } property :format, as: 'format' property :model, as: 'model' collection :q, as: 'q' property :source, as: 'source' property :target, as: 'target' end end class ListTranslationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation self.representation_wrap = lambda { |args| :data if args[:unwrap] == Google::Apis::TranslateV2::ListTranslationsResponse } collection :translations, as: 'translations', class: Google::Apis::TranslateV2::TranslationsResource, decorator: Google::Apis::TranslateV2::TranslationsResource::Representation end end class TranslationsResource # @private class Representation < Google::Apis::Core::JsonRepresentation self.representation_wrap = lambda { |args| :data if args[:unwrap] == Google::Apis::TranslateV2::TranslationsResource } property :detected_source_language, as: 'detectedSourceLanguage' property :model, as: 'model' property :translated_text, as: 'translatedText' end end end end end google-api-client-0.19.8/generated/google/apis/translate_v2/classes.rb0000644000004100000410000002256313252673044025712 0ustar www-datawww-data# 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 TranslateV2 # The request message for language detection. class DetectLanguageRequest include Google::Apis::Core::Hashable # The input text upon which to perform language detection. Repeat this # parameter to perform language detection on multiple text inputs. # Corresponds to the JSON property `q` # @return [Array] attr_accessor :q def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @q = args[:q] if args.key?(:q) end end # class ListDetectionsResponse include Google::Apis::Core::Hashable # A detections contains detection results of several text # Corresponds to the JSON property `detections` # @return [Array>] attr_accessor :detections def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @detections = args[:detections] if args.key?(:detections) end end # class DetectionsResource include Google::Apis::Core::Hashable # The confidence of the detection result of this language. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence # A boolean to indicate is the language detection result reliable. # Corresponds to the JSON property `isReliable` # @return [Boolean] attr_accessor :is_reliable alias_method :is_reliable?, :is_reliable # The language we detected. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @confidence = args[:confidence] if args.key?(:confidence) @is_reliable = args[:is_reliable] if args.key?(:is_reliable) @language = args[:language] if args.key?(:language) end end # The request message for discovering supported languages. class GetSupportedLanguagesRequest include Google::Apis::Core::Hashable # The language to use to return localized, human readable names of supported # languages. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @target = args[:target] if args.key?(:target) end end # class ListLanguagesResponse include Google::Apis::Core::Hashable # List of source/target languages supported by the translation API. If target # parameter is unspecified, the list is sorted by the ASCII code point order of # the language code. If target parameter is specified, the list is sorted by the # collation order of the language name in the target language. # 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) @languages = args[:languages] if args.key?(:languages) end end # class LanguagesResource include Google::Apis::Core::Hashable # Supported language code, generally consisting of its ISO 639-1 # identifier. (E.g. 'en', 'ja'). In certain cases, BCP-47 codes including # language + region identifiers are returned (e.g. 'zh-TW' and 'zh-CH') # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # Human readable name of the language localized to the target language. # 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) @language = args[:language] if args.key?(:language) @name = args[:name] if args.key?(:name) end end # The main translation request message for the Cloud Translation API. class TranslateTextRequest include Google::Apis::Core::Hashable # The format of the source text, in either HTML (default) or plain-text. A # value of "html" indicates HTML and a value of "text" indicates plain-text. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # The `model` type requested for this translation. Valid values are # listed in public documentation. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model # The input text to translate. Repeat this parameter to perform translation # operations on multiple text inputs. # Corresponds to the JSON property `q` # @return [Array] attr_accessor :q # The language of the source text, set to one of the language codes listed in # Language Support. If the source language is not specified, the API will # attempt to identify the source language automatically and return it within # the response. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source # The language to use for translation of the input text, set to one of the # language codes listed in Language Support. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @format = args[:format] if args.key?(:format) @model = args[:model] if args.key?(:model) @q = args[:q] if args.key?(:q) @source = args[:source] if args.key?(:source) @target = args[:target] if args.key?(:target) end end # The main language translation response message. class ListTranslationsResponse include Google::Apis::Core::Hashable # Translations contains list of translation results of given text # Corresponds to the JSON property `translations` # @return [Array] attr_accessor :translations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @translations = args[:translations] if args.key?(:translations) end end # class TranslationsResource include Google::Apis::Core::Hashable # The source language of the initial request, detected automatically, if # no source language was passed within the initial request. If the # source language was passed, auto-detection of the language will not # occur and this field will be empty. # Corresponds to the JSON property `detectedSourceLanguage` # @return [String] attr_accessor :detected_source_language # The `model` type used for this translation. Valid values are # listed in public documentation. Can be different from requested `model`. # Present only if specific model type was explicitly requested. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model # Text translated into the target language. # Corresponds to the JSON property `translatedText` # @return [String] attr_accessor :translated_text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @detected_source_language = args[:detected_source_language] if args.key?(:detected_source_language) @model = args[:model] if args.key?(:model) @translated_text = args[:translated_text] if args.key?(:translated_text) end end end end end google-api-client-0.19.8/generated/google/apis/translate_v2/service.rb0000644000004100000410000003246113252673044025713 0ustar www-datawww-data# 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 TranslateV2 # Google Cloud Translation API # # The Google Cloud Translation API lets websites and programs integrate with # Google Translate programmatically. # # @example # require 'google/apis/translate_v2' # # Translate = Google::Apis::TranslateV2 # Alias the module # service = Translate::TranslateService.new # # @see https://code.google.com/apis/language/translate/v2/getting_started.html class TranslateService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user def initialize super('https://translation.googleapis.com/', 'language/translate/') @batch_path = 'batch/translate' end # Detects the language of text within a request. # @param [Google::Apis::TranslateV2::DetectLanguageRequest] detect_language_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. # Overrides userIp if both are provided. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TranslateV2::ListDetectionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranslateV2::ListDetectionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def detect_detection_language(detect_language_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/detect', options) command.request_representation = Google::Apis::TranslateV2::DetectLanguageRequest::Representation command.request_object = detect_language_request_object command.response_representation = Google::Apis::TranslateV2::ListDetectionsResponse::Representation command.response_class = Google::Apis::TranslateV2::ListDetectionsResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Detects the language of text within a request. # @param [Array, String] q # The input text upon which to perform language detection. Repeat this # parameter to perform language detection on multiple text inputs. # @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. # Overrides userIp if both are provided. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TranslateV2::ListDetectionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranslateV2::ListDetectionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_detections(q, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/detect', options) command.response_representation = Google::Apis::TranslateV2::ListDetectionsResponse::Representation command.response_class = Google::Apis::TranslateV2::ListDetectionsResponse command.query['q'] = q unless q.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 supported languages for translation. # @param [String] model # The model type for which supported languages should be returned. # @param [String] target # The language to use to return localized, human readable names of supported # languages. # @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. # Overrides userIp if both are provided. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TranslateV2::ListLanguagesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranslateV2::ListLanguagesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_languages(model: nil, target: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/languages', options) command.response_representation = Google::Apis::TranslateV2::ListLanguagesResponse::Representation command.response_class = Google::Apis::TranslateV2::ListLanguagesResponse command.query['model'] = model unless model.nil? command.query['target'] = target unless target.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 input text, returning translated text. # @param [Array, String] q # The input text to translate. Repeat this parameter to perform translation # operations on multiple text inputs. # @param [String] target # The language to use for translation of the input text, set to one of the # language codes listed in Language Support. # @param [Array, String] cid # The customization id for translate # @param [String] format # The format of the source text, in either HTML (default) or plain-text. A # value of "html" indicates HTML and a value of "text" indicates plain-text. # @param [String] model # The `model` type requested for this translation. Valid values are # listed in public documentation. # @param [String] source # The language of the source text, set to one of the language codes listed in # Language Support. If the source language is not specified, the API will # attempt to identify the source language automatically and return it within # 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. # Overrides userIp if both are provided. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TranslateV2::ListTranslationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranslateV2::ListTranslationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_translations(q, target, cid: nil, format: nil, model: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2', options) command.response_representation = Google::Apis::TranslateV2::ListTranslationsResponse::Representation command.response_class = Google::Apis::TranslateV2::ListTranslationsResponse command.query['cid'] = cid unless cid.nil? command.query['format'] = format unless format.nil? command.query['model'] = model unless model.nil? command.query['q'] = q unless q.nil? command.query['source'] = source unless source.nil? command.query['target'] = target unless target.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 input text, returning translated text. # @param [Google::Apis::TranslateV2::TranslateTextRequest] translate_text_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. # Overrides userIp if both are provided. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TranslateV2::ListTranslationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranslateV2::ListTranslationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def translate_translation_text(translate_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2', options) command.request_representation = Google::Apis::TranslateV2::TranslateTextRequest::Representation command.request_object = translate_text_request_object command.response_representation = Google::Apis::TranslateV2::ListTranslationsResponse::Representation command.response_class = Google::Apis::TranslateV2::ListTranslationsResponse 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 google-api-client-0.19.8/generated/google/apis/dataproc_v1beta2/0000755000004100000410000000000013252673043024434 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/dataproc_v1beta2/representations.rb0000644000004100000410000010763113252673043030216 0ustar www-datawww-data# 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 DataprocV1beta2 class AcceleratorConfig 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 CancelJobRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Cluster class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClusterConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClusterMetrics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClusterOperation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClusterOperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClusterOperationStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClusterSelector class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClusterStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DiagnoseClusterRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DiagnoseClusterResults class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DiskConfig 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 GceClusterConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HadoopJob class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HiveJob class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstantiateWorkflowTemplateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Job class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class JobPlacement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class JobReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class JobScheduling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class JobStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LifecycleConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListClustersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListJobsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListWorkflowTemplatesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LoggingConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedCluster class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedGroupConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NodeInitializationAction 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 OrderedJob class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PigJob class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PySparkJob class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SoftwareConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SparkJob class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SparkSqlJob 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 SubmitJobRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WorkflowGraph class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WorkflowMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WorkflowNode class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WorkflowTemplate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WorkflowTemplatePlacement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class YarnApplication class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AcceleratorConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :accelerator_count, as: 'acceleratorCount' property :accelerator_type_uri, as: 'acceleratorTypeUri' end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation collection :members, as: 'members' property :role, as: 'role' end end class CancelJobRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Cluster # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_name, as: 'clusterName' property :cluster_uuid, as: 'clusterUuid' property :config, as: 'config', class: Google::Apis::DataprocV1beta2::ClusterConfig, decorator: Google::Apis::DataprocV1beta2::ClusterConfig::Representation hash :labels, as: 'labels' property :metrics, as: 'metrics', class: Google::Apis::DataprocV1beta2::ClusterMetrics, decorator: Google::Apis::DataprocV1beta2::ClusterMetrics::Representation property :project_id, as: 'projectId' property :status, as: 'status', class: Google::Apis::DataprocV1beta2::ClusterStatus, decorator: Google::Apis::DataprocV1beta2::ClusterStatus::Representation collection :status_history, as: 'statusHistory', class: Google::Apis::DataprocV1beta2::ClusterStatus, decorator: Google::Apis::DataprocV1beta2::ClusterStatus::Representation end end class ClusterConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :config_bucket, as: 'configBucket' property :gce_cluster_config, as: 'gceClusterConfig', class: Google::Apis::DataprocV1beta2::GceClusterConfig, decorator: Google::Apis::DataprocV1beta2::GceClusterConfig::Representation collection :initialization_actions, as: 'initializationActions', class: Google::Apis::DataprocV1beta2::NodeInitializationAction, decorator: Google::Apis::DataprocV1beta2::NodeInitializationAction::Representation property :lifecycle_config, as: 'lifecycleConfig', class: Google::Apis::DataprocV1beta2::LifecycleConfig, decorator: Google::Apis::DataprocV1beta2::LifecycleConfig::Representation property :master_config, as: 'masterConfig', class: Google::Apis::DataprocV1beta2::InstanceGroupConfig, decorator: Google::Apis::DataprocV1beta2::InstanceGroupConfig::Representation property :secondary_worker_config, as: 'secondaryWorkerConfig', class: Google::Apis::DataprocV1beta2::InstanceGroupConfig, decorator: Google::Apis::DataprocV1beta2::InstanceGroupConfig::Representation property :software_config, as: 'softwareConfig', class: Google::Apis::DataprocV1beta2::SoftwareConfig, decorator: Google::Apis::DataprocV1beta2::SoftwareConfig::Representation property :worker_config, as: 'workerConfig', class: Google::Apis::DataprocV1beta2::InstanceGroupConfig, decorator: Google::Apis::DataprocV1beta2::InstanceGroupConfig::Representation end end class ClusterMetrics # @private class Representation < Google::Apis::Core::JsonRepresentation hash :hdfs_metrics, as: 'hdfsMetrics' hash :yarn_metrics, as: 'yarnMetrics' end end class ClusterOperation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error' property :operation_id, as: 'operationId' end end class ClusterOperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_name, as: 'clusterName' property :cluster_uuid, as: 'clusterUuid' property :description, as: 'description' hash :labels, as: 'labels' property :operation_type, as: 'operationType' property :status, as: 'status', class: Google::Apis::DataprocV1beta2::ClusterOperationStatus, decorator: Google::Apis::DataprocV1beta2::ClusterOperationStatus::Representation collection :status_history, as: 'statusHistory', class: Google::Apis::DataprocV1beta2::ClusterOperationStatus, decorator: Google::Apis::DataprocV1beta2::ClusterOperationStatus::Representation collection :warnings, as: 'warnings' end end class ClusterOperationStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :details, as: 'details' property :inner_state, as: 'innerState' property :state, as: 'state' property :state_start_time, as: 'stateStartTime' end end class ClusterSelector # @private class Representation < Google::Apis::Core::JsonRepresentation hash :cluster_labels, as: 'clusterLabels' property :zone, as: 'zone' end end class ClusterStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :detail, as: 'detail' property :state, as: 'state' property :state_start_time, as: 'stateStartTime' property :substate, as: 'substate' end end class DiagnoseClusterRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class DiagnoseClusterResults # @private class Representation < Google::Apis::Core::JsonRepresentation property :output_uri, as: 'outputUri' end end class DiskConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :boot_disk_size_gb, as: 'bootDiskSizeGb' property :boot_disk_type, as: 'bootDiskType' property :num_local_ssds, as: 'numLocalSsds' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GceClusterConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :internal_ip_only, as: 'internalIpOnly' hash :metadata, as: 'metadata' property :network_uri, as: 'networkUri' property :service_account, as: 'serviceAccount' collection :service_account_scopes, as: 'serviceAccountScopes' property :subnetwork_uri, as: 'subnetworkUri' collection :tags, as: 'tags' property :zone_uri, as: 'zoneUri' end end class HadoopJob # @private class Representation < Google::Apis::Core::JsonRepresentation collection :archive_uris, as: 'archiveUris' collection :args, as: 'args' collection :file_uris, as: 'fileUris' collection :jar_file_uris, as: 'jarFileUris' property :logging_config, as: 'loggingConfig', class: Google::Apis::DataprocV1beta2::LoggingConfig, decorator: Google::Apis::DataprocV1beta2::LoggingConfig::Representation property :main_class, as: 'mainClass' property :main_jar_file_uri, as: 'mainJarFileUri' hash :properties, as: 'properties' end end class HiveJob # @private class Representation < Google::Apis::Core::JsonRepresentation property :continue_on_failure, as: 'continueOnFailure' collection :jar_file_uris, as: 'jarFileUris' hash :properties, as: 'properties' property :query_file_uri, as: 'queryFileUri' property :query_list, as: 'queryList', class: Google::Apis::DataprocV1beta2::QueryList, decorator: Google::Apis::DataprocV1beta2::QueryList::Representation hash :script_variables, as: 'scriptVariables' end end class InstanceGroupConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accelerators, as: 'accelerators', class: Google::Apis::DataprocV1beta2::AcceleratorConfig, decorator: Google::Apis::DataprocV1beta2::AcceleratorConfig::Representation property :disk_config, as: 'diskConfig', class: Google::Apis::DataprocV1beta2::DiskConfig, decorator: Google::Apis::DataprocV1beta2::DiskConfig::Representation property :image_uri, as: 'imageUri' collection :instance_names, as: 'instanceNames' property :is_preemptible, as: 'isPreemptible' property :machine_type_uri, as: 'machineTypeUri' property :managed_group_config, as: 'managedGroupConfig', class: Google::Apis::DataprocV1beta2::ManagedGroupConfig, decorator: Google::Apis::DataprocV1beta2::ManagedGroupConfig::Representation property :min_cpu_platform, as: 'minCpuPlatform' property :num_instances, as: 'numInstances' end end class InstantiateWorkflowTemplateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance_id, as: 'instanceId' property :version, as: 'version' end end class Job # @private class Representation < Google::Apis::Core::JsonRepresentation property :driver_control_files_uri, as: 'driverControlFilesUri' property :driver_output_resource_uri, as: 'driverOutputResourceUri' property :hadoop_job, as: 'hadoopJob', class: Google::Apis::DataprocV1beta2::HadoopJob, decorator: Google::Apis::DataprocV1beta2::HadoopJob::Representation property :hive_job, as: 'hiveJob', class: Google::Apis::DataprocV1beta2::HiveJob, decorator: Google::Apis::DataprocV1beta2::HiveJob::Representation hash :labels, as: 'labels' property :pig_job, as: 'pigJob', class: Google::Apis::DataprocV1beta2::PigJob, decorator: Google::Apis::DataprocV1beta2::PigJob::Representation property :placement, as: 'placement', class: Google::Apis::DataprocV1beta2::JobPlacement, decorator: Google::Apis::DataprocV1beta2::JobPlacement::Representation property :pyspark_job, as: 'pysparkJob', class: Google::Apis::DataprocV1beta2::PySparkJob, decorator: Google::Apis::DataprocV1beta2::PySparkJob::Representation property :reference, as: 'reference', class: Google::Apis::DataprocV1beta2::JobReference, decorator: Google::Apis::DataprocV1beta2::JobReference::Representation property :scheduling, as: 'scheduling', class: Google::Apis::DataprocV1beta2::JobScheduling, decorator: Google::Apis::DataprocV1beta2::JobScheduling::Representation property :spark_job, as: 'sparkJob', class: Google::Apis::DataprocV1beta2::SparkJob, decorator: Google::Apis::DataprocV1beta2::SparkJob::Representation property :spark_sql_job, as: 'sparkSqlJob', class: Google::Apis::DataprocV1beta2::SparkSqlJob, decorator: Google::Apis::DataprocV1beta2::SparkSqlJob::Representation property :status, as: 'status', class: Google::Apis::DataprocV1beta2::JobStatus, decorator: Google::Apis::DataprocV1beta2::JobStatus::Representation collection :status_history, as: 'statusHistory', class: Google::Apis::DataprocV1beta2::JobStatus, decorator: Google::Apis::DataprocV1beta2::JobStatus::Representation collection :yarn_applications, as: 'yarnApplications', class: Google::Apis::DataprocV1beta2::YarnApplication, decorator: Google::Apis::DataprocV1beta2::YarnApplication::Representation end end class JobPlacement # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_name, as: 'clusterName' property :cluster_uuid, as: 'clusterUuid' end end class JobReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :job_id, as: 'jobId' property :project_id, as: 'projectId' end end class JobScheduling # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_failures_per_hour, as: 'maxFailuresPerHour' end end class JobStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :details, as: 'details' property :state, as: 'state' property :state_start_time, as: 'stateStartTime' property :substate, as: 'substate' end end class LifecycleConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_delete_time, as: 'autoDeleteTime' property :auto_delete_ttl, as: 'autoDeleteTtl' property :idle_delete_ttl, as: 'idleDeleteTtl' end end class ListClustersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :clusters, as: 'clusters', class: Google::Apis::DataprocV1beta2::Cluster, decorator: Google::Apis::DataprocV1beta2::Cluster::Representation property :next_page_token, as: 'nextPageToken' end end class ListJobsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :jobs, as: 'jobs', class: Google::Apis::DataprocV1beta2::Job, decorator: Google::Apis::DataprocV1beta2::Job::Representation property :next_page_token, as: 'nextPageToken' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::DataprocV1beta2::Operation, decorator: Google::Apis::DataprocV1beta2::Operation::Representation end end class ListWorkflowTemplatesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :templates, as: 'templates', class: Google::Apis::DataprocV1beta2::WorkflowTemplate, decorator: Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation end end class LoggingConfig # @private class Representation < Google::Apis::Core::JsonRepresentation hash :driver_log_levels, as: 'driverLogLevels' end end class ManagedCluster # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_name, as: 'clusterName' property :config, as: 'config', class: Google::Apis::DataprocV1beta2::ClusterConfig, decorator: Google::Apis::DataprocV1beta2::ClusterConfig::Representation hash :labels, as: 'labels' end end class ManagedGroupConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance_group_manager_name, as: 'instanceGroupManagerName' property :instance_template_name, as: 'instanceTemplateName' end end class NodeInitializationAction # @private class Representation < Google::Apis::Core::JsonRepresentation property :executable_file, as: 'executableFile' property :execution_timeout, as: 'executionTimeout' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::DataprocV1beta2::Status, decorator: Google::Apis::DataprocV1beta2::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class OrderedJob # @private class Representation < Google::Apis::Core::JsonRepresentation property :hadoop_job, as: 'hadoopJob', class: Google::Apis::DataprocV1beta2::HadoopJob, decorator: Google::Apis::DataprocV1beta2::HadoopJob::Representation property :hive_job, as: 'hiveJob', class: Google::Apis::DataprocV1beta2::HiveJob, decorator: Google::Apis::DataprocV1beta2::HiveJob::Representation hash :labels, as: 'labels' property :pig_job, as: 'pigJob', class: Google::Apis::DataprocV1beta2::PigJob, decorator: Google::Apis::DataprocV1beta2::PigJob::Representation collection :prerequisite_step_ids, as: 'prerequisiteStepIds' property :pyspark_job, as: 'pysparkJob', class: Google::Apis::DataprocV1beta2::PySparkJob, decorator: Google::Apis::DataprocV1beta2::PySparkJob::Representation property :scheduling, as: 'scheduling', class: Google::Apis::DataprocV1beta2::JobScheduling, decorator: Google::Apis::DataprocV1beta2::JobScheduling::Representation property :spark_job, as: 'sparkJob', class: Google::Apis::DataprocV1beta2::SparkJob, decorator: Google::Apis::DataprocV1beta2::SparkJob::Representation property :spark_sql_job, as: 'sparkSqlJob', class: Google::Apis::DataprocV1beta2::SparkSqlJob, decorator: Google::Apis::DataprocV1beta2::SparkSqlJob::Representation property :step_id, as: 'stepId' end end class PigJob # @private class Representation < Google::Apis::Core::JsonRepresentation property :continue_on_failure, as: 'continueOnFailure' collection :jar_file_uris, as: 'jarFileUris' property :logging_config, as: 'loggingConfig', class: Google::Apis::DataprocV1beta2::LoggingConfig, decorator: Google::Apis::DataprocV1beta2::LoggingConfig::Representation hash :properties, as: 'properties' property :query_file_uri, as: 'queryFileUri' property :query_list, as: 'queryList', class: Google::Apis::DataprocV1beta2::QueryList, decorator: Google::Apis::DataprocV1beta2::QueryList::Representation hash :script_variables, as: 'scriptVariables' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :bindings, as: 'bindings', class: Google::Apis::DataprocV1beta2::Binding, decorator: Google::Apis::DataprocV1beta2::Binding::Representation property :etag, :base64 => true, as: 'etag' property :version, as: 'version' end end class PySparkJob # @private class Representation < Google::Apis::Core::JsonRepresentation collection :archive_uris, as: 'archiveUris' collection :args, as: 'args' collection :file_uris, as: 'fileUris' collection :jar_file_uris, as: 'jarFileUris' property :logging_config, as: 'loggingConfig', class: Google::Apis::DataprocV1beta2::LoggingConfig, decorator: Google::Apis::DataprocV1beta2::LoggingConfig::Representation property :main_python_file_uri, as: 'mainPythonFileUri' hash :properties, as: 'properties' collection :python_file_uris, as: 'pythonFileUris' end end class QueryList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :queries, as: 'queries' end end class SetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :policy, as: 'policy', class: Google::Apis::DataprocV1beta2::Policy, decorator: Google::Apis::DataprocV1beta2::Policy::Representation end end class SoftwareConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :image_version, as: 'imageVersion' hash :properties, as: 'properties' end end class SparkJob # @private class Representation < Google::Apis::Core::JsonRepresentation collection :archive_uris, as: 'archiveUris' collection :args, as: 'args' collection :file_uris, as: 'fileUris' collection :jar_file_uris, as: 'jarFileUris' property :logging_config, as: 'loggingConfig', class: Google::Apis::DataprocV1beta2::LoggingConfig, decorator: Google::Apis::DataprocV1beta2::LoggingConfig::Representation property :main_class, as: 'mainClass' property :main_jar_file_uri, as: 'mainJarFileUri' hash :properties, as: 'properties' end end class SparkSqlJob # @private class Representation < Google::Apis::Core::JsonRepresentation collection :jar_file_uris, as: 'jarFileUris' property :logging_config, as: 'loggingConfig', class: Google::Apis::DataprocV1beta2::LoggingConfig, decorator: Google::Apis::DataprocV1beta2::LoggingConfig::Representation hash :properties, as: 'properties' property :query_file_uri, as: 'queryFileUri' property :query_list, as: 'queryList', class: Google::Apis::DataprocV1beta2::QueryList, decorator: Google::Apis::DataprocV1beta2::QueryList::Representation hash :script_variables, as: 'scriptVariables' 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 SubmitJobRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :job, as: 'job', class: Google::Apis::DataprocV1beta2::Job, decorator: Google::Apis::DataprocV1beta2::Job::Representation end end class TestIamPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestIamPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class WorkflowGraph # @private class Representation < Google::Apis::Core::JsonRepresentation collection :nodes, as: 'nodes', class: Google::Apis::DataprocV1beta2::WorkflowNode, decorator: Google::Apis::DataprocV1beta2::WorkflowNode::Representation end end class WorkflowMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_name, as: 'clusterName' property :create_cluster, as: 'createCluster', class: Google::Apis::DataprocV1beta2::ClusterOperation, decorator: Google::Apis::DataprocV1beta2::ClusterOperation::Representation property :delete_cluster, as: 'deleteCluster', class: Google::Apis::DataprocV1beta2::ClusterOperation, decorator: Google::Apis::DataprocV1beta2::ClusterOperation::Representation property :graph, as: 'graph', class: Google::Apis::DataprocV1beta2::WorkflowGraph, decorator: Google::Apis::DataprocV1beta2::WorkflowGraph::Representation property :state, as: 'state' property :template, as: 'template' property :version, as: 'version' end end class WorkflowNode # @private class Representation < Google::Apis::Core::JsonRepresentation property :error, as: 'error' property :job_id, as: 'jobId' collection :prerequisite_step_ids, as: 'prerequisiteStepIds' property :state, as: 'state' property :step_id, as: 'stepId' end end class WorkflowTemplate # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :id, as: 'id' collection :jobs, as: 'jobs', class: Google::Apis::DataprocV1beta2::OrderedJob, decorator: Google::Apis::DataprocV1beta2::OrderedJob::Representation hash :labels, as: 'labels' property :name, as: 'name' property :placement, as: 'placement', class: Google::Apis::DataprocV1beta2::WorkflowTemplatePlacement, decorator: Google::Apis::DataprocV1beta2::WorkflowTemplatePlacement::Representation property :update_time, as: 'updateTime' property :version, as: 'version' end end class WorkflowTemplatePlacement # @private class Representation < Google::Apis::Core::JsonRepresentation property :cluster_selector, as: 'clusterSelector', class: Google::Apis::DataprocV1beta2::ClusterSelector, decorator: Google::Apis::DataprocV1beta2::ClusterSelector::Representation property :managed_cluster, as: 'managedCluster', class: Google::Apis::DataprocV1beta2::ManagedCluster, decorator: Google::Apis::DataprocV1beta2::ManagedCluster::Representation end end class YarnApplication # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :progress, as: 'progress' property :state, as: 'state' property :tracking_url, as: 'trackingUrl' end end end end end google-api-client-0.19.8/generated/google/apis/dataproc_v1beta2/classes.rb0000644000004100000410000031373513252673043026432 0ustar www-datawww-data# 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 DataprocV1beta2 # Specifies the type and number of accelerator cards attached to the instances # of an instance group (see GPUs on Compute Engine). class AcceleratorConfig include Google::Apis::Core::Hashable # The number of the accelerator cards of this type exposed to this instance. # Corresponds to the JSON property `acceleratorCount` # @return [Fixnum] attr_accessor :accelerator_count # Full URL, partial URI, or short name of the accelerator type resource to # expose to this instance. See Google Compute Engine AcceleratorTypes( /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-k80 # Corresponds to the JSON property `acceleratorTypeUri` # @return [String] attr_accessor :accelerator_type_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accelerator_count = args[:accelerator_count] if args.key?(:accelerator_count) @accelerator_type_uri = args[:accelerator_type_uri] if args.key?(:accelerator_type_uri) end end # Associates members with a role. class Binding include Google::Apis::Core::Hashable # 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@gmail.com or joe@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. # domain:`domain`: A Google Apps domain name 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. Required # 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) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end # A request to cancel a job. class CancelJobRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Describes the identifying information, config, and status of a cluster of # Google Compute Engine instances. class Cluster include Google::Apis::Core::Hashable # Required. The cluster name. Cluster names within a project must be unique. # Names of deleted clusters can be reused. # Corresponds to the JSON property `clusterName` # @return [String] attr_accessor :cluster_name # Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc # generates this value when it creates the cluster. # Corresponds to the JSON property `clusterUuid` # @return [String] attr_accessor :cluster_uuid # The cluster config. # Corresponds to the JSON property `config` # @return [Google::Apis::DataprocV1beta2::ClusterConfig] attr_accessor :config # Optional. The labels to associate with this cluster. Label keys must contain 1 # to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/ # rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 # characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt) # . No more than 32 labels can be associated with a cluster. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: # This report is available for testing purposes only. It may be changed before # final release. # Corresponds to the JSON property `metrics` # @return [Google::Apis::DataprocV1beta2::ClusterMetrics] attr_accessor :metrics # Required. The Google Cloud Platform project ID that the cluster belongs to. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The status of a cluster and its instances. # Corresponds to the JSON property `status` # @return [Google::Apis::DataprocV1beta2::ClusterStatus] attr_accessor :status # Output only. The previous cluster status. # Corresponds to the JSON property `statusHistory` # @return [Array] attr_accessor :status_history def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_name = args[:cluster_name] if args.key?(:cluster_name) @cluster_uuid = args[:cluster_uuid] if args.key?(:cluster_uuid) @config = args[:config] if args.key?(:config) @labels = args[:labels] if args.key?(:labels) @metrics = args[:metrics] if args.key?(:metrics) @project_id = args[:project_id] if args.key?(:project_id) @status = args[:status] if args.key?(:status) @status_history = args[:status_history] if args.key?(:status_history) end end # The cluster config. class ClusterConfig include Google::Apis::Core::Hashable # Optional. A Google Cloud Storage staging bucket used for sharing generated SSH # keys and config. If you do not specify a staging bucket, Cloud Dataproc will # determine an appropriate Cloud Storage location (US, ASIA, or EU) for your # cluster's staging bucket according to the Google Compute Engine zone where # your cluster is deployed, and then it will create and manage this project- # level, per-location bucket for you. # Corresponds to the JSON property `configBucket` # @return [String] attr_accessor :config_bucket # Common config settings for resources of Google Compute Engine cluster # instances, applicable to all instances in the cluster. # Corresponds to the JSON property `gceClusterConfig` # @return [Google::Apis::DataprocV1beta2::GceClusterConfig] attr_accessor :gce_cluster_config # Optional. Commands to execute on each node after config is completed. By # default, executables are run on master and all worker nodes. You can test a # node's role metadata to run an executable on a master or worker # node, as shown below using curl (you can also use wget): # ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1beta2/ # instance/attributes/dataproc-role) # if [[ "$`ROLE`" == 'Master' ]]; then # ... master specific actions ... # else # ... worker specific actions ... # fi # Corresponds to the JSON property `initializationActions` # @return [Array] attr_accessor :initialization_actions # Specifies the cluster auto delete related schedule configuration. # Corresponds to the JSON property `lifecycleConfig` # @return [Google::Apis::DataprocV1beta2::LifecycleConfig] attr_accessor :lifecycle_config # Optional. The config settings for Google Compute Engine resources in an # instance group, such as a master or worker group. # Corresponds to the JSON property `masterConfig` # @return [Google::Apis::DataprocV1beta2::InstanceGroupConfig] attr_accessor :master_config # Optional. The config settings for Google Compute Engine resources in an # instance group, such as a master or worker group. # Corresponds to the JSON property `secondaryWorkerConfig` # @return [Google::Apis::DataprocV1beta2::InstanceGroupConfig] attr_accessor :secondary_worker_config # Specifies the selection and config of software inside the cluster. # Corresponds to the JSON property `softwareConfig` # @return [Google::Apis::DataprocV1beta2::SoftwareConfig] attr_accessor :software_config # Optional. The config settings for Google Compute Engine resources in an # instance group, such as a master or worker group. # Corresponds to the JSON property `workerConfig` # @return [Google::Apis::DataprocV1beta2::InstanceGroupConfig] attr_accessor :worker_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @config_bucket = args[:config_bucket] if args.key?(:config_bucket) @gce_cluster_config = args[:gce_cluster_config] if args.key?(:gce_cluster_config) @initialization_actions = args[:initialization_actions] if args.key?(:initialization_actions) @lifecycle_config = args[:lifecycle_config] if args.key?(:lifecycle_config) @master_config = args[:master_config] if args.key?(:master_config) @secondary_worker_config = args[:secondary_worker_config] if args.key?(:secondary_worker_config) @software_config = args[:software_config] if args.key?(:software_config) @worker_config = args[:worker_config] if args.key?(:worker_config) end end # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: # This report is available for testing purposes only. It may be changed before # final release. class ClusterMetrics include Google::Apis::Core::Hashable # The HDFS metrics. # Corresponds to the JSON property `hdfsMetrics` # @return [Hash] attr_accessor :hdfs_metrics # The YARN metrics. # Corresponds to the JSON property `yarnMetrics` # @return [Hash] attr_accessor :yarn_metrics def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @hdfs_metrics = args[:hdfs_metrics] if args.key?(:hdfs_metrics) @yarn_metrics = args[:yarn_metrics] if args.key?(:yarn_metrics) end end # The cluster operation triggered by a workflow. class ClusterOperation include Google::Apis::Core::Hashable # Output only. Indicates the operation is done. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done # Output only. Error, if operation failed. # Corresponds to the JSON property `error` # @return [String] attr_accessor :error # Output only. The id of the cluster operation. # 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) @done = args[:done] if args.key?(:done) @error = args[:error] if args.key?(:error) @operation_id = args[:operation_id] if args.key?(:operation_id) end end # Metadata describing the operation. class ClusterOperationMetadata include Google::Apis::Core::Hashable # Output only. Name of the cluster for the operation. # Corresponds to the JSON property `clusterName` # @return [String] attr_accessor :cluster_name # Output only. Cluster UUID for the operation. # Corresponds to the JSON property `clusterUuid` # @return [String] attr_accessor :cluster_uuid # Output only. Short description of operation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Output only. Labels associated with the operation # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Output only. The operation type. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # The status of the operation. # Corresponds to the JSON property `status` # @return [Google::Apis::DataprocV1beta2::ClusterOperationStatus] attr_accessor :status # Output only. The previous operation status. # Corresponds to the JSON property `statusHistory` # @return [Array] attr_accessor :status_history # Output only. Errors encountered during operation execution. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_name = args[:cluster_name] if args.key?(:cluster_name) @cluster_uuid = args[:cluster_uuid] if args.key?(:cluster_uuid) @description = args[:description] if args.key?(:description) @labels = args[:labels] if args.key?(:labels) @operation_type = args[:operation_type] if args.key?(:operation_type) @status = args[:status] if args.key?(:status) @status_history = args[:status_history] if args.key?(:status_history) @warnings = args[:warnings] if args.key?(:warnings) end end # The status of the operation. class ClusterOperationStatus include Google::Apis::Core::Hashable # Output only. A message containing any operation metadata details. # Corresponds to the JSON property `details` # @return [String] attr_accessor :details # Output only. A message containing the detailed operation state. # Corresponds to the JSON property `innerState` # @return [String] attr_accessor :inner_state # Output only. A message containing the operation state. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. The time this state was entered. # Corresponds to the JSON property `stateStartTime` # @return [String] attr_accessor :state_start_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @details = args[:details] if args.key?(:details) @inner_state = args[:inner_state] if args.key?(:inner_state) @state = args[:state] if args.key?(:state) @state_start_time = args[:state_start_time] if args.key?(:state_start_time) end end # A selector that chooses target cluster for jobs based on metadata. class ClusterSelector include Google::Apis::Core::Hashable # Required. The cluster labels. Cluster must have all labels to match. # Corresponds to the JSON property `clusterLabels` # @return [Hash] attr_accessor :cluster_labels # Optional. The zone where workflow process executes. This parameter does not # affect the selection of the cluster.If unspecified, the zone of the first # cluster matching the selector is used. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_labels = args[:cluster_labels] if args.key?(:cluster_labels) @zone = args[:zone] if args.key?(:zone) end end # The status of a cluster and its instances. class ClusterStatus include Google::Apis::Core::Hashable # Output only. Optional details of cluster's state. # Corresponds to the JSON property `detail` # @return [String] attr_accessor :detail # Output only. The cluster's state. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. Time when this state was entered. # Corresponds to the JSON property `stateStartTime` # @return [String] attr_accessor :state_start_time # Output only. Additional state information that includes status reported by the # agent. # Corresponds to the JSON property `substate` # @return [String] attr_accessor :substate def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @detail = args[:detail] if args.key?(:detail) @state = args[:state] if args.key?(:state) @state_start_time = args[:state_start_time] if args.key?(:state_start_time) @substate = args[:substate] if args.key?(:substate) end end # A request to collect cluster diagnostic information. class DiagnoseClusterRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The location of diagnostic output. class DiagnoseClusterResults include Google::Apis::Core::Hashable # Output only. The Google Cloud Storage URI of the diagnostic output. The output # report is a plain text file with a summary of collected diagnostics. # Corresponds to the JSON property `outputUri` # @return [String] attr_accessor :output_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @output_uri = args[:output_uri] if args.key?(:output_uri) end end # Specifies the config of disk options for a group of VM instances. class DiskConfig include Google::Apis::Core::Hashable # Optional. Size in GB of the boot disk (default is 500GB). # Corresponds to the JSON property `bootDiskSizeGb` # @return [Fixnum] attr_accessor :boot_disk_size_gb # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd- # ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk # Hard Disk Drive). # Corresponds to the JSON property `bootDiskType` # @return [String] attr_accessor :boot_disk_type # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not # attached, the boot disk is used to store runtime logs and HDFS (https://hadoop. # apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are # attached, this runtime bulk data is spread across them, and the boot disk # contains only basic config and installed binaries. # Corresponds to the JSON property `numLocalSsds` # @return [Fixnum] attr_accessor :num_local_ssds def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @boot_disk_size_gb = args[:boot_disk_size_gb] if args.key?(:boot_disk_size_gb) @boot_disk_type = args[:boot_disk_type] if args.key?(:boot_disk_type) @num_local_ssds = args[:num_local_ssds] if args.key?(:num_local_ssds) 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 # Common config settings for resources of Google Compute Engine cluster # instances, applicable to all instances in the cluster. class GceClusterConfig include Google::Apis::Core::Hashable # Optional. If true, all instances in the cluster will only have internal IP # addresses. By default, clusters are not restricted to internal IP addresses, # and will have ephemeral external IP addresses assigned to each instance. This # internal_ip_only restriction can only be enabled for subnetwork enabled # networks, and all off-cluster dependencies must be configured to be accessible # without external IP addresses. # Corresponds to the JSON property `internalIpOnly` # @return [Boolean] attr_accessor :internal_ip_only alias_method :internal_ip_only?, :internal_ip_only # The Google Compute Engine metadata entries to add to all instances (see # Project and instance metadata (https://cloud.google.com/compute/docs/storing- # retrieving-metadata#project_and_instance_metadata)). # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # Optional. The Google 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: # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/ # default # projects/[project_id]/regions/global/default # default # Corresponds to the JSON property `networkUri` # @return [String] attr_accessor :network_uri # Optional. The service account of the instances. Defaults to the default Google # Compute Engine service account. Custom service accounts need permissions # equivalent to the folloing IAM roles: # roles/logging.logWriter # roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/ # service-accounts#custom_service_accounts for more information). Example: [ # account_id]@[project_id].iam.gserviceaccount.com # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account # Optional. The URIs of service account scopes to be included in Google Compute # Engine instances. The following base set of scopes is always included: # https://www.googleapis.com/auth/cloud.useraccounts.readonly # https://www.googleapis.com/auth/devstorage.read_write # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the # following defaults are also provided: # https://www.googleapis.com/auth/bigquery # https://www.googleapis.com/auth/bigtable.admin.table # https://www.googleapis.com/auth/bigtable.data # https://www.googleapis.com/auth/devstorage.full_control # Corresponds to the JSON property `serviceAccountScopes` # @return [Array] attr_accessor :service_account_scopes # Optional. The Google Compute Engine subnetwork to be used for machine # communications. Cannot be specified with network_uri.A full URL, partial URI, # or short name are valid. Examples: # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/ # sub0 # projects/[project_id]/regions/us-east1/sub0 # sub0 # Corresponds to the JSON property `subnetworkUri` # @return [String] attr_accessor :subnetwork_uri # The Google Compute Engine tags to add to all instances (see Tagging instances). # Corresponds to the JSON property `tags` # @return [Array] attr_accessor :tags # Optional. The zone where the Google Compute Engine cluster will be located. On # a create request, it is required in the "global" region. If omitted in a non- # global Cloud Dataproc region, the service will pick a zone in the # corresponding Compute Engine region. On a get request, zone will always be # present.A full URL, partial URI, or short name are valid. Examples: # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] # projects/[project_id]/zones/[zone] # us-central1-f # Corresponds to the JSON property `zoneUri` # @return [String] attr_accessor :zone_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @internal_ip_only = args[:internal_ip_only] if args.key?(:internal_ip_only) @metadata = args[:metadata] if args.key?(:metadata) @network_uri = args[:network_uri] if args.key?(:network_uri) @service_account = args[:service_account] if args.key?(:service_account) @service_account_scopes = args[:service_account_scopes] if args.key?(:service_account_scopes) @subnetwork_uri = args[:subnetwork_uri] if args.key?(:subnetwork_uri) @tags = args[:tags] if args.key?(:tags) @zone_uri = args[:zone_uri] if args.key?(:zone_uri) end end # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop. # apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/ # MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/ # docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). class HadoopJob include Google::Apis::Core::Hashable # Optional. HCFS URIs of archives to be extracted in the working directory of # Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or . # zip. # Corresponds to the JSON property `archiveUris` # @return [Array] attr_accessor :archive_uris # Optional. The arguments to pass to the driver. Do not include arguments, such # as -libjars or -Dfoo=bar, that can be set as job properties, since a collision # may occur that causes an incorrect job submission. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to # the working directory of Hadoop drivers and distributed tasks. Useful for # naively parallel tasks. # Corresponds to the JSON property `fileUris` # @return [Array] attr_accessor :file_uris # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and # tasks. # Corresponds to the JSON property `jarFileUris` # @return [Array] attr_accessor :jar_file_uris # The runtime logging config of the job. # Corresponds to the JSON property `loggingConfig` # @return [Google::Apis::DataprocV1beta2::LoggingConfig] attr_accessor :logging_config # The name of the driver's main class. The jar file containing the class must be # in the default CLASSPATH or specified in jar_file_uris. # Corresponds to the JSON property `mainClass` # @return [String] attr_accessor :main_class # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo- # bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test- # samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop- # mapreduce-examples.jar' # Corresponds to the JSON property `mainJarFileUri` # @return [String] attr_accessor :main_jar_file_uri # Optional. A mapping of property names to values, used to configure Hadoop. # Properties that conflict with values set by the Cloud Dataproc API may be # overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes # in user code. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @archive_uris = args[:archive_uris] if args.key?(:archive_uris) @args = args[:args] if args.key?(:args) @file_uris = args[:file_uris] if args.key?(:file_uris) @jar_file_uris = args[:jar_file_uris] if args.key?(:jar_file_uris) @logging_config = args[:logging_config] if args.key?(:logging_config) @main_class = args[:main_class] if args.key?(:main_class) @main_jar_file_uri = args[:main_jar_file_uri] if args.key?(:main_jar_file_uri) @properties = args[:properties] if args.key?(:properties) end end # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) # queries on YARN. class HiveJob include Google::Apis::Core::Hashable # Optional. Whether to continue executing queries if a query fails. The default # value is false. Setting to true can be useful when executing independent # parallel queries. # Corresponds to the JSON property `continueOnFailure` # @return [Boolean] attr_accessor :continue_on_failure alias_method :continue_on_failure?, :continue_on_failure # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server # and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. # Corresponds to the JSON property `jarFileUris` # @return [Array] attr_accessor :jar_file_uris # Optional. A mapping of property names and values, used to configure Hive. # Properties that conflict with values set by the Cloud Dataproc API may be # overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/ # hive/conf/hive-site.xml, and classes in user code. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties # The HCFS URI of the script that contains Hive queries. # Corresponds to the JSON property `queryFileUri` # @return [String] attr_accessor :query_file_uri # A list of queries to run on a cluster. # Corresponds to the JSON property `queryList` # @return [Google::Apis::DataprocV1beta2::QueryList] attr_accessor :query_list # Optional. Mapping of query variable names to values (equivalent to the Hive # command: SET name="value";). # Corresponds to the JSON property `scriptVariables` # @return [Hash] attr_accessor :script_variables def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @continue_on_failure = args[:continue_on_failure] if args.key?(:continue_on_failure) @jar_file_uris = args[:jar_file_uris] if args.key?(:jar_file_uris) @properties = args[:properties] if args.key?(:properties) @query_file_uri = args[:query_file_uri] if args.key?(:query_file_uri) @query_list = args[:query_list] if args.key?(:query_list) @script_variables = args[:script_variables] if args.key?(:script_variables) end end # Optional. The config settings for Google Compute Engine resources in an # instance group, such as a master or worker group. class InstanceGroupConfig include Google::Apis::Core::Hashable # Optional. The Google Compute Engine accelerator configuration for these # instances.Beta Feature: This feature is still under development. It may be # changed before final release. # Corresponds to the JSON property `accelerators` # @return [Array] attr_accessor :accelerators # Specifies the config of disk options for a group of VM instances. # Corresponds to the JSON property `diskConfig` # @return [Google::Apis::DataprocV1beta2::DiskConfig] attr_accessor :disk_config # Output only. The Google Compute Engine image resource used for cluster # instances. Inferred from SoftwareConfig.image_version. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri # Optional. The list of instance names. Cloud Dataproc derives the names from # cluster_name, num_instances, and the instance group if not set by user ( # recommended practice is to let Cloud Dataproc derive the name). # Corresponds to the JSON property `instanceNames` # @return [Array] attr_accessor :instance_names # Optional. Specifies that this instance group contains preemptible instances. # Corresponds to the JSON property `isPreemptible` # @return [Boolean] attr_accessor :is_preemptible alias_method :is_preemptible?, :is_preemptible # Optional. The Google Compute Engine machine type used for cluster instances.A # full URL, partial URI, or short name are valid. Examples: # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/ # machineTypes/n1-standard-2 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 # n1-standard-2 # Corresponds to the JSON property `machineTypeUri` # @return [String] attr_accessor :machine_type_uri # Specifies the resources used to actively manage an instance group. # Corresponds to the JSON property `managedGroupConfig` # @return [Google::Apis::DataprocV1beta2::ManagedGroupConfig] attr_accessor :managed_group_config # Optional. Specifies the minimum cpu platform for the Instance Group. See Cloud # Dataproc→Minimum CPU Platform. # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform # Optional. The number of VM instances in the instance group. For master # instance groups, must be set to 1. # Corresponds to the JSON property `numInstances` # @return [Fixnum] attr_accessor :num_instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accelerators = args[:accelerators] if args.key?(:accelerators) @disk_config = args[:disk_config] if args.key?(:disk_config) @image_uri = args[:image_uri] if args.key?(:image_uri) @instance_names = args[:instance_names] if args.key?(:instance_names) @is_preemptible = args[:is_preemptible] if args.key?(:is_preemptible) @machine_type_uri = args[:machine_type_uri] if args.key?(:machine_type_uri) @managed_group_config = args[:managed_group_config] if args.key?(:managed_group_config) @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @num_instances = args[:num_instances] if args.key?(:num_instances) end end # A request to instantiate a workflow template. class InstantiateWorkflowTemplateRequest include Google::Apis::Core::Hashable # Optional. A tag that prevents multiple concurrent workflow instances with the # same tag from running. This mitigates risk of concurrent instances started due # to retries.It is recommended to always set this value to a UUID (https://en. # wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only # letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The # maximum length is 40 characters. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id # Optional. The version of workflow template to instantiate. If specified, the # workflow will be instantiated only if the current version of the workflow # template has the supplied version.This option cannot be used to instantiate a # previous version of workflow template. # 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) @instance_id = args[:instance_id] if args.key?(:instance_id) @version = args[:version] if args.key?(:version) end end # A Cloud Dataproc job resource. class Job include Google::Apis::Core::Hashable # Output only. If present, the location of miscellaneous control files which may # be used as part of job setup and handling. If not present, control files may # be placed in the same location as driver_output_uri. # Corresponds to the JSON property `driverControlFilesUri` # @return [String] attr_accessor :driver_control_files_uri # Output only. A URI pointing to the location of the stdout of the job's driver # program. # Corresponds to the JSON property `driverOutputResourceUri` # @return [String] attr_accessor :driver_output_resource_uri # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop. # apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/ # MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/ # docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Corresponds to the JSON property `hadoopJob` # @return [Google::Apis::DataprocV1beta2::HadoopJob] attr_accessor :hadoop_job # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) # queries on YARN. # Corresponds to the JSON property `hiveJob` # @return [Google::Apis::DataprocV1beta2::HiveJob] attr_accessor :hive_job # Optional. The labels to associate with this job. Label keys must contain 1 to # 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035. # txt). Label values may be empty, but, if present, must contain 1 to 63 # characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt) # . No more than 32 labels can be associated with a job. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries # on YARN. # Corresponds to the JSON property `pigJob` # @return [Google::Apis::DataprocV1beta2::PigJob] attr_accessor :pig_job # Cloud Dataproc job config. # Corresponds to the JSON property `placement` # @return [Google::Apis::DataprocV1beta2::JobPlacement] attr_accessor :placement # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/ # 0.9.0/python-programming-guide.html) applications on YARN. # Corresponds to the JSON property `pysparkJob` # @return [Google::Apis::DataprocV1beta2::PySparkJob] attr_accessor :pyspark_job # Encapsulates the full scoping used to reference a job. # Corresponds to the JSON property `reference` # @return [Google::Apis::DataprocV1beta2::JobReference] attr_accessor :reference # Job scheduling options. # Corresponds to the JSON property `scheduling` # @return [Google::Apis::DataprocV1beta2::JobScheduling] attr_accessor :scheduling # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) # applications on YARN. # Corresponds to the JSON property `sparkJob` # @return [Google::Apis::DataprocV1beta2::SparkJob] attr_accessor :spark_job # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/ # ) queries. # Corresponds to the JSON property `sparkSqlJob` # @return [Google::Apis::DataprocV1beta2::SparkSqlJob] attr_accessor :spark_sql_job # Cloud Dataproc job status. # Corresponds to the JSON property `status` # @return [Google::Apis::DataprocV1beta2::JobStatus] attr_accessor :status # Output only. The previous job status. # Corresponds to the JSON property `statusHistory` # @return [Array] attr_accessor :status_history # Output only. The collection of YARN applications spun up by this job.Beta # Feature: This report is available for testing purposes only. It may be changed # before final release. # Corresponds to the JSON property `yarnApplications` # @return [Array] attr_accessor :yarn_applications def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @driver_control_files_uri = args[:driver_control_files_uri] if args.key?(:driver_control_files_uri) @driver_output_resource_uri = args[:driver_output_resource_uri] if args.key?(:driver_output_resource_uri) @hadoop_job = args[:hadoop_job] if args.key?(:hadoop_job) @hive_job = args[:hive_job] if args.key?(:hive_job) @labels = args[:labels] if args.key?(:labels) @pig_job = args[:pig_job] if args.key?(:pig_job) @placement = args[:placement] if args.key?(:placement) @pyspark_job = args[:pyspark_job] if args.key?(:pyspark_job) @reference = args[:reference] if args.key?(:reference) @scheduling = args[:scheduling] if args.key?(:scheduling) @spark_job = args[:spark_job] if args.key?(:spark_job) @spark_sql_job = args[:spark_sql_job] if args.key?(:spark_sql_job) @status = args[:status] if args.key?(:status) @status_history = args[:status_history] if args.key?(:status_history) @yarn_applications = args[:yarn_applications] if args.key?(:yarn_applications) end end # Cloud Dataproc job config. class JobPlacement include Google::Apis::Core::Hashable # Required. The name of the cluster where the job will be submitted. # Corresponds to the JSON property `clusterName` # @return [String] attr_accessor :cluster_name # Output only. A cluster UUID generated by the Cloud Dataproc service when the # job is submitted. # Corresponds to the JSON property `clusterUuid` # @return [String] attr_accessor :cluster_uuid def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_name = args[:cluster_name] if args.key?(:cluster_name) @cluster_uuid = args[:cluster_uuid] if args.key?(:cluster_uuid) end end # Encapsulates the full scoping used to reference a job. class JobReference include Google::Apis::Core::Hashable # Optional. The job ID, which must be unique within the project. The job ID is # generated by the server upon job submission or provided by the user as a means # to perform retries without creating duplicate jobs. The ID must contain only # letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The # maximum length is 100 characters. # Corresponds to the JSON property `jobId` # @return [String] attr_accessor :job_id # Required. The ID of the Google Cloud Platform project that the job belongs to. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @job_id = args[:job_id] if args.key?(:job_id) @project_id = args[:project_id] if args.key?(:project_id) end end # Job scheduling options. class JobScheduling include Google::Apis::Core::Hashable # Optional. Maximum number of times per hour a driver may be restarted as a # result of driver terminating with non-zero code before job is reported failed. # A job may be reported as thrashing if driver exits with non-zero code 4 times # within 10 minute window.Maximum value is 10. # Corresponds to the JSON property `maxFailuresPerHour` # @return [Fixnum] attr_accessor :max_failures_per_hour def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_failures_per_hour = args[:max_failures_per_hour] if args.key?(:max_failures_per_hour) end end # Cloud Dataproc job status. class JobStatus include Google::Apis::Core::Hashable # Output only. Optional job state details, such as an error description if the # state is ERROR. # Corresponds to the JSON property `details` # @return [String] attr_accessor :details # Output only. A state message specifying the overall job state. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. The time when this state was entered. # Corresponds to the JSON property `stateStartTime` # @return [String] attr_accessor :state_start_time # Output only. Additional state information, which includes status reported by # the agent. # Corresponds to the JSON property `substate` # @return [String] attr_accessor :substate def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @details = args[:details] if args.key?(:details) @state = args[:state] if args.key?(:state) @state_start_time = args[:state_start_time] if args.key?(:state_start_time) @substate = args[:substate] if args.key?(:substate) end end # Specifies the cluster auto delete related schedule configuration. class LifecycleConfig include Google::Apis::Core::Hashable # Optional. The time when cluster will be auto-deleted. # Corresponds to the JSON property `autoDeleteTime` # @return [String] attr_accessor :auto_delete_time # Optional. The life duration of cluster, the cluster will be auto-deleted at # the end of this duration. # Corresponds to the JSON property `autoDeleteTtl` # @return [String] attr_accessor :auto_delete_ttl # Optional. The longest duration that cluster would keep alive while staying # idle; passing this threshold will cause cluster to be auto-deleted. # Corresponds to the JSON property `idleDeleteTtl` # @return [String] attr_accessor :idle_delete_ttl def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_delete_time = args[:auto_delete_time] if args.key?(:auto_delete_time) @auto_delete_ttl = args[:auto_delete_ttl] if args.key?(:auto_delete_ttl) @idle_delete_ttl = args[:idle_delete_ttl] if args.key?(:idle_delete_ttl) end end # The list of all clusters in a project. class ListClustersResponse include Google::Apis::Core::Hashable # Output only. The clusters in the project. # Corresponds to the JSON property `clusters` # @return [Array] attr_accessor :clusters # Output only. This token is included in the response if there are more results # to fetch. To fetch additional results, provide this value as the page_token in # a subsequent ListClustersRequest. # 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) @clusters = args[:clusters] if args.key?(:clusters) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # A list of jobs in a project. class ListJobsResponse include Google::Apis::Core::Hashable # Output only. Jobs list. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs # Optional. This token is included in the response if there are more results to # fetch. To fetch additional results, provide this value as the page_token in a # subsequent ListJobsRequest. # 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) @jobs = args[:jobs] if args.key?(:jobs) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Operations.ListOperations. class ListOperationsResponse 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 # A response to a request to list workflow templates in a project. class ListWorkflowTemplatesResponse include Google::Apis::Core::Hashable # Output only. This token is included in the response if there are more results # to fetch. To fetch additional results, provide this value as the page_token in # a subsequent ListWorkflowTemplatesRequest. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. WorkflowTemplates list. # Corresponds to the JSON property `templates` # @return [Array] attr_accessor :templates 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) @templates = args[:templates] if args.key?(:templates) end end # The runtime logging config of the job. class LoggingConfig include Google::Apis::Core::Hashable # The per-package log levels for the driver. This may include "root" package # name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', ' # org.apache = DEBUG' # Corresponds to the JSON property `driverLogLevels` # @return [Hash] attr_accessor :driver_log_levels def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @driver_log_levels = args[:driver_log_levels] if args.key?(:driver_log_levels) end end # Cluster that is managed by the workflow. class ManagedCluster include Google::Apis::Core::Hashable # Required. The cluster name. Cluster names within a project must be unique. # Names from deleted clusters can be reused. # Corresponds to the JSON property `clusterName` # @return [String] attr_accessor :cluster_name # The cluster config. # Corresponds to the JSON property `config` # @return [Google::Apis::DataprocV1beta2::ClusterConfig] attr_accessor :config # Optional. The labels to associate with this cluster.Label keys must be between # 1 and 63 characters long, and must conform to the following PCRE regular # expression: \p`Ll`\p`Lo``0,62`Label values must be between 1 and 63 characters # long, and must conform to the following PCRE regular expression: \p`Ll`\p`Lo`\ # p`N`_-`0,63`No more than 64 labels can be associated with a given cluster. # 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) @cluster_name = args[:cluster_name] if args.key?(:cluster_name) @config = args[:config] if args.key?(:config) @labels = args[:labels] if args.key?(:labels) end end # Specifies the resources used to actively manage an instance group. class ManagedGroupConfig include Google::Apis::Core::Hashable # Output only. The name of the Instance Group Manager for this group. # Corresponds to the JSON property `instanceGroupManagerName` # @return [String] attr_accessor :instance_group_manager_name # Output only. The name of the Instance Template used for the Managed Instance # Group. # Corresponds to the JSON property `instanceTemplateName` # @return [String] attr_accessor :instance_template_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance_group_manager_name = args[:instance_group_manager_name] if args.key?(:instance_group_manager_name) @instance_template_name = args[:instance_template_name] if args.key?(:instance_template_name) end end # Specifies an executable to run on a fully configured node and a timeout period # for executable completion. class NodeInitializationAction include Google::Apis::Core::Hashable # Required. Google Cloud Storage URI of executable file. # Corresponds to the JSON property `executableFile` # @return [String] attr_accessor :executable_file # Optional. Amount of time executable has to complete. Default is 10 minutes. # Cluster creation fails with an explanatory error message (the name of the # executable that caused the error and the exceeded timeout period) if the # executable is not completed at end of the timeout period. # Corresponds to the JSON property `executionTimeout` # @return [String] attr_accessor :execution_timeout def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @executable_file = args[:executable_file] if args.key?(:executable_file) @execution_timeout = args[:execution_timeout] if args.key?(:execution_timeout) 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). The error model is designed to be: # Simple to use and understand for most users # Flexible enough to meet unexpected needsOverviewThe Status message contains # three pieces of data: error code, error message, and error details. The error # code should be an enum value of google.rpc.Code, but it may accept additional # error codes if needed. The error message should be a developer-facing English # message that helps developers understand and resolve the error. If a localized # user-facing error message is needed, put the localized message in the error # details or localize it in the client. The optional error details may contain # arbitrary information about the error. There is a predefined set of error # detail types in the package google.rpc that can be used for common error # conditions.Language mappingThe Status message is the logical representation of # the error model, but it is not necessarily the actual wire format. When the # Status message is exposed in different client libraries and different wire # protocols, it can be mapped differently. For example, it will likely be mapped # to some exceptions in Java, but more likely mapped to some error codes in C. # Other usesThe error model and the Status message can be used in a variety of # environments, either with or without APIs, to provide a consistent developer # experience across different environments.Example uses of this error model # include: # Partial errors. If a service needs to return partial errors to the client, it # may embed the Status in the normal response to indicate the partial errors. # Workflow errors. A typical workflow has multiple steps. Each step may have a # Status message for error reporting. # Batch operations. If a client uses batch request and batch response, the # Status message should be used directly inside batch response, one for each # error sub-response. # Asynchronous operations. If an API call embeds asynchronous operation results # in its response, the status of those operations should be represented directly # using the Status message. # Logging. If some API errors are stored in logs, the message Status could be # used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::DataprocV1beta2::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 # have the format of operations/some/unique/name. # 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 job executed by the workflow. class OrderedJob include Google::Apis::Core::Hashable # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop. # apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/ # MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/ # docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Corresponds to the JSON property `hadoopJob` # @return [Google::Apis::DataprocV1beta2::HadoopJob] attr_accessor :hadoop_job # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) # queries on YARN. # Corresponds to the JSON property `hiveJob` # @return [Google::Apis::DataprocV1beta2::HiveJob] attr_accessor :hive_job # Optional. The labels to associate with this job.Label keys must be between 1 # and 63 characters long, and must conform to the following regular expression: \ # p`Ll`\p`Lo``0,62`Label values must be between 1 and 63 characters long, and # must conform to the following regular expression: \p`Ll`\p`Lo`\p`N`_-`0,63`No # more than 64 labels can be associated with a given job. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries # on YARN. # Corresponds to the JSON property `pigJob` # @return [Google::Apis::DataprocV1beta2::PigJob] attr_accessor :pig_job # Optional. The optional list of prerequisite job step_ids. If not specified, # the job will start at the beginning of workflow. # Corresponds to the JSON property `prerequisiteStepIds` # @return [Array] attr_accessor :prerequisite_step_ids # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/ # 0.9.0/python-programming-guide.html) applications on YARN. # Corresponds to the JSON property `pysparkJob` # @return [Google::Apis::DataprocV1beta2::PySparkJob] attr_accessor :pyspark_job # Job scheduling options. # Corresponds to the JSON property `scheduling` # @return [Google::Apis::DataprocV1beta2::JobScheduling] attr_accessor :scheduling # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) # applications on YARN. # Corresponds to the JSON property `sparkJob` # @return [Google::Apis::DataprocV1beta2::SparkJob] attr_accessor :spark_job # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/ # ) queries. # Corresponds to the JSON property `sparkSqlJob` # @return [Google::Apis::DataprocV1beta2::SparkSqlJob] attr_accessor :spark_sql_job # Required. The step id. The id must be unique among all jobs within the # template.The step id is used as prefix for job id, as job workflow-step-id # label, and in prerequisite_step_ids field from other steps. # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @hadoop_job = args[:hadoop_job] if args.key?(:hadoop_job) @hive_job = args[:hive_job] if args.key?(:hive_job) @labels = args[:labels] if args.key?(:labels) @pig_job = args[:pig_job] if args.key?(:pig_job) @prerequisite_step_ids = args[:prerequisite_step_ids] if args.key?(:prerequisite_step_ids) @pyspark_job = args[:pyspark_job] if args.key?(:pyspark_job) @scheduling = args[:scheduling] if args.key?(:scheduling) @spark_job = args[:spark_job] if args.key?(:spark_job) @spark_sql_job = args[:spark_sql_job] if args.key?(:spark_sql_job) @step_id = args[:step_id] if args.key?(:step_id) end end # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries # on YARN. class PigJob include Google::Apis::Core::Hashable # Optional. Whether to continue executing queries if a query fails. The default # value is false. Setting to true can be useful when executing independent # parallel queries. # Corresponds to the JSON property `continueOnFailure` # @return [Boolean] attr_accessor :continue_on_failure alias_method :continue_on_failure?, :continue_on_failure # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and # Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. # Corresponds to the JSON property `jarFileUris` # @return [Array] attr_accessor :jar_file_uris # The runtime logging config of the job. # Corresponds to the JSON property `loggingConfig` # @return [Google::Apis::DataprocV1beta2::LoggingConfig] attr_accessor :logging_config # Optional. A mapping of property names to values, used to configure Pig. # Properties that conflict with values set by the Cloud Dataproc API may be # overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/ # pig/conf/pig.properties, and classes in user code. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties # The HCFS URI of the script that contains the Pig queries. # Corresponds to the JSON property `queryFileUri` # @return [String] attr_accessor :query_file_uri # A list of queries to run on a cluster. # Corresponds to the JSON property `queryList` # @return [Google::Apis::DataprocV1beta2::QueryList] attr_accessor :query_list # Optional. Mapping of query variable names to values (equivalent to the Pig # command: name=[value]). # Corresponds to the JSON property `scriptVariables` # @return [Hash] attr_accessor :script_variables def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @continue_on_failure = args[:continue_on_failure] if args.key?(:continue_on_failure) @jar_file_uris = args[:jar_file_uris] if args.key?(:jar_file_uris) @logging_config = args[:logging_config] if args.key?(:logging_config) @properties = args[:properties] if args.key?(:properties) @query_file_uri = args[:query_file_uri] if args.key?(:query_file_uri) @query_list = args[:query_list] if args.key?(:query_list) @script_variables = args[:script_variables] if args.key?(:script_variables) end end # Defines an Identity and Access Management (IAM) policy. It is used to specify # access control policies for Cloud Platform resources.A Policy consists of a # list of bindings. A Binding binds a list of members to a role, where the # members can be user accounts, Google groups, Google domains, and service # accounts. A role is a named list of permissions defined by IAM.Example # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the IAM developer's guide ( # https://cloud.google.com/iam/docs). class Policy include Google::Apis::Core::Hashable # Associates a list of members to a role. bindings with no members will result # in an error. # 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.If no etag is provided in the call to setIamPolicy, # then the existing policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # Deprecated. # 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) @bindings = args[:bindings] if args.key?(:bindings) @etag = args[:etag] if args.key?(:etag) @version = args[:version] if args.key?(:version) end end # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/ # 0.9.0/python-programming-guide.html) applications on YARN. class PySparkJob include Google::Apis::Core::Hashable # Optional. HCFS URIs of archives to be extracted in the working directory of . # jar, .tar, .tar.gz, .tgz, and .zip. # Corresponds to the JSON property `archiveUris` # @return [Array] attr_accessor :archive_uris # Optional. The arguments to pass to the driver. Do not include arguments, such # as --conf, that can be set as job properties, since a collision may occur that # causes an incorrect job submission. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args # Optional. HCFS URIs of files to be copied to the working directory of Python # drivers and distributed tasks. Useful for naively parallel tasks. # Corresponds to the JSON property `fileUris` # @return [Array] attr_accessor :file_uris # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver # and tasks. # Corresponds to the JSON property `jarFileUris` # @return [Array] attr_accessor :jar_file_uris # The runtime logging config of the job. # Corresponds to the JSON property `loggingConfig` # @return [Google::Apis::DataprocV1beta2::LoggingConfig] attr_accessor :logging_config # Required. The HCFS URI of the main Python file to use as the driver. Must be a # .py file. # Corresponds to the JSON property `mainPythonFileUri` # @return [String] attr_accessor :main_python_file_uri # Optional. A mapping of property names to values, used to configure PySpark. # Properties that conflict with values set by the Cloud Dataproc API may be # overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf # and classes in user code. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties # Optional. HCFS file URIs of Python files to pass to the PySpark framework. # Supported file types: .py, .egg, and .zip. # Corresponds to the JSON property `pythonFileUris` # @return [Array] attr_accessor :python_file_uris def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @archive_uris = args[:archive_uris] if args.key?(:archive_uris) @args = args[:args] if args.key?(:args) @file_uris = args[:file_uris] if args.key?(:file_uris) @jar_file_uris = args[:jar_file_uris] if args.key?(:jar_file_uris) @logging_config = args[:logging_config] if args.key?(:logging_config) @main_python_file_uri = args[:main_python_file_uri] if args.key?(:main_python_file_uri) @properties = args[:properties] if args.key?(:properties) @python_file_uris = args[:python_file_uris] if args.key?(:python_file_uris) end end # A list of queries to run on a cluster. class QueryList include Google::Apis::Core::Hashable # Required. The queries to execute. You do not need to terminate a query with a # semicolon. Multiple queries can be specified in one string by separating each # with a semicolon. Here is an example of an Cloud Dataproc API snippet that # uses a QueryList to specify a HiveJob: # "hiveJob": ` # "queryList": ` # "queries": [ # "query1", # "query2", # "query3;query4", # ] # ` # ` # 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 # Request message for SetIamPolicy method. class SetIamPolicyRequest include Google::Apis::Core::Hashable # Defines an Identity and Access Management (IAM) policy. It is used to specify # access control policies for Cloud Platform resources.A Policy consists of a # list of bindings. A Binding binds a list of members to a role, where the # members can be user accounts, Google groups, Google domains, and service # accounts. A role is a named list of permissions defined by IAM.Example # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the IAM developer's guide ( # https://cloud.google.com/iam/docs). # Corresponds to the JSON property `policy` # @return [Google::Apis::DataprocV1beta2::Policy] attr_accessor :policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @policy = args[:policy] if args.key?(:policy) end end # Specifies the selection and config of software inside the cluster. class SoftwareConfig include Google::Apis::Core::Hashable # Optional. The version of software inside the cluster. It must match the # regular expression [0-9]+\.[0-9]+. If unspecified, it defaults to the latest # version (see Cloud Dataproc Versioning). # Corresponds to the JSON property `imageVersion` # @return [String] attr_accessor :image_version # Optional. The properties to set on daemon config files.Property keys are # specified in prefix:property format, such as core:fs.defaultFS. The following # are supported prefixes and their mappings: # capacity-scheduler: capacity-scheduler.xml # core: core-site.xml # distcp: distcp-default.xml # hdfs: hdfs-site.xml # hive: hive-site.xml # mapred: mapred-site.xml # pig: pig.properties # spark: spark-defaults.conf # yarn: yarn-site.xmlFor more information, see Cluster properties. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @image_version = args[:image_version] if args.key?(:image_version) @properties = args[:properties] if args.key?(:properties) end end # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) # applications on YARN. class SparkJob include Google::Apis::Core::Hashable # Optional. HCFS URIs of archives to be extracted in the working directory of # Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and . # zip. # Corresponds to the JSON property `archiveUris` # @return [Array] attr_accessor :archive_uris # Optional. The arguments to pass to the driver. Do not include arguments, such # as --conf, that can be set as job properties, since a collision may occur that # causes an incorrect job submission. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args # Optional. HCFS URIs of files to be copied to the working directory of Spark # drivers and distributed tasks. Useful for naively parallel tasks. # Corresponds to the JSON property `fileUris` # @return [Array] attr_accessor :file_uris # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver # and tasks. # Corresponds to the JSON property `jarFileUris` # @return [Array] attr_accessor :jar_file_uris # The runtime logging config of the job. # Corresponds to the JSON property `loggingConfig` # @return [Google::Apis::DataprocV1beta2::LoggingConfig] attr_accessor :logging_config # The name of the driver's main class. The jar file that contains the class must # be in the default CLASSPATH or specified in jar_file_uris. # Corresponds to the JSON property `mainClass` # @return [String] attr_accessor :main_class # The HCFS URI of the jar file that contains the main class. # Corresponds to the JSON property `mainJarFileUri` # @return [String] attr_accessor :main_jar_file_uri # Optional. A mapping of property names to values, used to configure Spark. # Properties that conflict with values set by the Cloud Dataproc API may be # overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf # and classes in user code. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @archive_uris = args[:archive_uris] if args.key?(:archive_uris) @args = args[:args] if args.key?(:args) @file_uris = args[:file_uris] if args.key?(:file_uris) @jar_file_uris = args[:jar_file_uris] if args.key?(:jar_file_uris) @logging_config = args[:logging_config] if args.key?(:logging_config) @main_class = args[:main_class] if args.key?(:main_class) @main_jar_file_uri = args[:main_jar_file_uri] if args.key?(:main_jar_file_uri) @properties = args[:properties] if args.key?(:properties) end end # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/ # ) queries. class SparkSqlJob include Google::Apis::Core::Hashable # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. # Corresponds to the JSON property `jarFileUris` # @return [Array] attr_accessor :jar_file_uris # The runtime logging config of the job. # Corresponds to the JSON property `loggingConfig` # @return [Google::Apis::DataprocV1beta2::LoggingConfig] attr_accessor :logging_config # Optional. A mapping of property names to values, used to configure Spark SQL's # SparkConf. Properties that conflict with values set by the Cloud Dataproc API # may be overwritten. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties # The HCFS URI of the script that contains SQL queries. # Corresponds to the JSON property `queryFileUri` # @return [String] attr_accessor :query_file_uri # A list of queries to run on a cluster. # Corresponds to the JSON property `queryList` # @return [Google::Apis::DataprocV1beta2::QueryList] attr_accessor :query_list # Optional. Mapping of query variable names to values (equivalent to the Spark # SQL command: SET name="value";). # Corresponds to the JSON property `scriptVariables` # @return [Hash] attr_accessor :script_variables def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @jar_file_uris = args[:jar_file_uris] if args.key?(:jar_file_uris) @logging_config = args[:logging_config] if args.key?(:logging_config) @properties = args[:properties] if args.key?(:properties) @query_file_uri = args[:query_file_uri] if args.key?(:query_file_uri) @query_list = args[:query_list] if args.key?(:query_list) @script_variables = args[:script_variables] if args.key?(:script_variables) 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). The error model is designed to be: # Simple to use and understand for most users # Flexible enough to meet unexpected needsOverviewThe Status message contains # three pieces of data: error code, error message, and error details. The error # code should be an enum value of google.rpc.Code, but it may accept additional # error codes if needed. The error message should be a developer-facing English # message that helps developers understand and resolve the error. If a localized # user-facing error message is needed, put the localized message in the error # details or localize it in the client. The optional error details may contain # arbitrary information about the error. There is a predefined set of error # detail types in the package google.rpc that can be used for common error # conditions.Language mappingThe Status message is the logical representation of # the error model, but it is not necessarily the actual wire format. When the # Status message is exposed in different client libraries and different wire # protocols, it can be mapped differently. For example, it will likely be mapped # to some exceptions in Java, but more likely mapped to some error codes in C. # Other usesThe error model and the Status message can be used in a variety of # environments, either with or without APIs, to provide a consistent developer # experience across different environments.Example uses of this error model # include: # Partial errors. If a service needs to return partial errors to the client, it # may embed the Status in the normal response to indicate the partial errors. # Workflow errors. A typical workflow has multiple steps. Each step may have a # Status message for error reporting. # Batch operations. If a client uses batch request and batch response, the # Status message should be used directly inside batch response, one for each # error sub-response. # Asynchronous operations. If an API call embeds asynchronous operation results # in its response, the status of those operations should be represented directly # using the Status message. # Logging. If some API errors are stored in logs, the message Status could be # used directly after any stripping needed for security/privacy reasons. class Status 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 # A request to submit a job. class SubmitJobRequest include Google::Apis::Core::Hashable # A Cloud Dataproc job resource. # Corresponds to the JSON property `job` # @return [Google::Apis::DataprocV1beta2::Job] attr_accessor :job def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @job = args[:job] if args.key?(:job) end end # Request message for TestIamPermissions method. class TestIamPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the resource. Permissions with wildcards ( # such as '*' or 'storage.*') are not allowed. For more information see IAM # Overview (https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permissions = args[:permissions] if args.key?(:permissions) end end # Response message for TestIamPermissions method. class TestIamPermissionsResponse include Google::Apis::Core::Hashable # A subset of TestPermissionsRequest.permissions that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] 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 workflow graph. class WorkflowGraph include Google::Apis::Core::Hashable # Output only. The workflow nodes. # Corresponds to the JSON property `nodes` # @return [Array] attr_accessor :nodes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @nodes = args[:nodes] if args.key?(:nodes) end end # A Cloud Dataproc workflow template resource. class WorkflowMetadata include Google::Apis::Core::Hashable # Output only. The name of the managed cluster. # Corresponds to the JSON property `clusterName` # @return [String] attr_accessor :cluster_name # The cluster operation triggered by a workflow. # Corresponds to the JSON property `createCluster` # @return [Google::Apis::DataprocV1beta2::ClusterOperation] attr_accessor :create_cluster # The cluster operation triggered by a workflow. # Corresponds to the JSON property `deleteCluster` # @return [Google::Apis::DataprocV1beta2::ClusterOperation] attr_accessor :delete_cluster # The workflow graph. # Corresponds to the JSON property `graph` # @return [Google::Apis::DataprocV1beta2::WorkflowGraph] attr_accessor :graph # Output only. The workflow state. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. The "resource name" of the template. # Corresponds to the JSON property `template` # @return [String] attr_accessor :template # Output only. The version of template at the time of workflow instantiation. # 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) @cluster_name = args[:cluster_name] if args.key?(:cluster_name) @create_cluster = args[:create_cluster] if args.key?(:create_cluster) @delete_cluster = args[:delete_cluster] if args.key?(:delete_cluster) @graph = args[:graph] if args.key?(:graph) @state = args[:state] if args.key?(:state) @template = args[:template] if args.key?(:template) @version = args[:version] if args.key?(:version) end end # The workflow node. class WorkflowNode include Google::Apis::Core::Hashable # Output only. The error detail. # Corresponds to the JSON property `error` # @return [String] attr_accessor :error # Output only. The job id; populated after the node enters RUNNING state. # Corresponds to the JSON property `jobId` # @return [String] attr_accessor :job_id # Output only. Node's prerequisite nodes. # Corresponds to the JSON property `prerequisiteStepIds` # @return [Array] attr_accessor :prerequisite_step_ids # Output only. The node state. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. The name of the node. # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error = args[:error] if args.key?(:error) @job_id = args[:job_id] if args.key?(:job_id) @prerequisite_step_ids = args[:prerequisite_step_ids] if args.key?(:prerequisite_step_ids) @state = args[:state] if args.key?(:state) @step_id = args[:step_id] if args.key?(:step_id) end end # A Cloud Dataproc workflow template resource. class WorkflowTemplate include Google::Apis::Core::Hashable # Output only. The time template was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Required. The template id. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Required. The Directed Acyclic Graph of Jobs to submit. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs # Optional. The labels to associate with this template. These labels will be # propagated to all jobs and clusters created by the workflow instance.Label # keys must contain 1 to 63 characters, and must conform to RFC 1035 (https:// # www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must # contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/ # rfc/rfc1035.txt).No more than 32 labels can be associated with a template. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Output only. The "resource name" of the template, as described in https:// # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Specifies workflow execution target.Either managed_cluster or cluster_selector # is required. # Corresponds to the JSON property `placement` # @return [Google::Apis::DataprocV1beta2::WorkflowTemplatePlacement] attr_accessor :placement # Output only. The time template was last updated. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Optional. Used to perform a consistent read-modify-write.This field should be # left blank for a CreateWorkflowTemplate request. It is required for an # UpdateWorkflowTemplate request, and must match the current server version. A # typical update template flow would fetch the current template with a # GetWorkflowTemplate request, which will return the current template with the # version field filled in with the current server version. The user updates # other fields in the template, then returns it as part of the # UpdateWorkflowTemplate request. # 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) @create_time = args[:create_time] if args.key?(:create_time) @id = args[:id] if args.key?(:id) @jobs = args[:jobs] if args.key?(:jobs) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @placement = args[:placement] if args.key?(:placement) @update_time = args[:update_time] if args.key?(:update_time) @version = args[:version] if args.key?(:version) end end # Specifies workflow execution target.Either managed_cluster or cluster_selector # is required. class WorkflowTemplatePlacement include Google::Apis::Core::Hashable # A selector that chooses target cluster for jobs based on metadata. # Corresponds to the JSON property `clusterSelector` # @return [Google::Apis::DataprocV1beta2::ClusterSelector] attr_accessor :cluster_selector # Cluster that is managed by the workflow. # Corresponds to the JSON property `managedCluster` # @return [Google::Apis::DataprocV1beta2::ManagedCluster] attr_accessor :managed_cluster def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cluster_selector = args[:cluster_selector] if args.key?(:cluster_selector) @managed_cluster = args[:managed_cluster] if args.key?(:managed_cluster) end end # A YARN application created by a job. Application information is a subset of < # code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto. # Beta Feature: This report is available for testing purposes only. It may be # changed before final release. class YarnApplication include Google::Apis::Core::Hashable # Required. The application name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. The numerical progress of the application, from 1 to 100. # Corresponds to the JSON property `progress` # @return [Float] attr_accessor :progress # Required. The application state. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or # TimelineServer that provides application-specific information. The URL uses # the internal hostname, and requires a proxy server for resolution and, # possibly, access. # Corresponds to the JSON property `trackingUrl` # @return [String] attr_accessor :tracking_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @progress = args[:progress] if args.key?(:progress) @state = args[:state] if args.key?(:state) @tracking_url = args[:tracking_url] if args.key?(:tracking_url) end end end end end google-api-client-0.19.8/generated/google/apis/dataproc_v1beta2/service.rb0000644000004100000410000025674613252673043026445 0ustar www-datawww-data# 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 DataprocV1beta2 # Google Cloud Dataproc API # # Manages Hadoop-based clusters and jobs on Google Cloud Platform. # # @example # require 'google/apis/dataproc_v1beta2' # # Dataproc = Google::Apis::DataprocV1beta2 # Alias the module # service = Dataproc::DataprocService.new # # @see https://cloud.google.com/dataproc/ class DataprocService < 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://dataproc.googleapis.com/', '') @batch_path = 'batch' end # Creates new workflow template. # @param [String] parent # Required. The "resource name" of the region, as described in https://cloud. # google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region` # @param [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_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::DataprocV1beta2::WorkflowTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::WorkflowTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_workflow_template(parent, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+parent}/workflowTemplates', options) command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.request_object = workflow_template_object command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate 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 workflow template. It does not cancel in-progress workflows. # @param [String] name # Required. The "resource name" of the workflow template, as described in https:/ # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Fixnum] version # Optional. The version of workflow template to delete. If specified, will only # delete the template if the current server version matches specified version. # @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::DataprocV1beta2::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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_location_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation command.response_class = Google::Apis::DataprocV1beta2::Empty command.params['name'] = name unless name.nil? command.query['version'] = version unless 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 # Retrieves the latest workflow template.Can retrieve previously instantiated # template by specifying optional version parameter. # @param [String] name # Required. The "resource name" of the workflow template, as described in https:/ # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Fixnum] version # Optional. The version of workflow template to retrieve. Only previously # instatiated versions can be retrieved.If unspecified, retrieves the current # version. # @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::DataprocV1beta2::WorkflowTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::WorkflowTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate command.params['name'] = name unless name.nil? command.query['version'] = version unless 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 # Instantiates a template and begins execution.The returned Operation can be # used to track execution of workflow by polling operations.get. The Operation # will complete when entire workflow is finished.The running workflow can be # aborted via operations.cancel. This will cause any inflight jobs to be # cancelled and workflow-owned clusters to be deleted.The Operation.metadata # will be WorkflowMetadata.On successful completion, Operation.response will be # Empty. # @param [String] name # Required. The "resource name" of the workflow template, as described in https:/ # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Google::Apis::DataprocV1beta2::InstantiateWorkflowTemplateRequest] instantiate_workflow_template_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::DataprocV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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 instantiate_project_location_workflow_template(name, instantiate_workflow_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+name}:instantiate', options) command.request_representation = Google::Apis::DataprocV1beta2::InstantiateWorkflowTemplateRequest::Representation command.request_object = instantiate_workflow_template_request_object command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation command.response_class = Google::Apis::DataprocV1beta2::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 # Instantiates a template and begins execution.This method is equivalent to # executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, # DeleteWorkflowTemplate.The returned Operation can be used to track execution # of workflow by polling operations.get. The Operation will complete when entire # workflow is finished.The running workflow can be aborted via operations.cancel. # This will cause any inflight jobs to be cancelled and workflow-owned clusters # to be deleted.The Operation.metadata will be WorkflowMetadata.On successful # completion, Operation.response will be Empty. # @param [String] parent # Required. The "resource name" of the workflow template region, as described in # https://cloud.google.com/apis/design/resource_names of the form projects/` # project_id`/regions/`region` # @param [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_object # @param [String] instance_id # Optional. A tag that prevents multiple concurrent workflow instances with the # same tag from running. This mitigates risk of concurrent instances started due # to retries.It is recommended to always set this value to a UUID (https://en. # wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only # letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The # maximum length is 40 characters. # @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::DataprocV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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 instantiate_project_location_workflow_template_inline(parent, workflow_template_object = nil, instance_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+parent}/workflowTemplates:instantiateInline', options) command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.request_object = workflow_template_object command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation command.response_class = Google::Apis::DataprocV1beta2::Operation command.params['parent'] = parent unless parent.nil? command.query['instanceId'] = instance_id unless instance_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 workflows that match the specified filter in the request. # @param [String] parent # Required. The "resource name" of the region, as described in https://cloud. # google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region` # @param [Fixnum] page_size # Optional. The maximum number of results to return in each response. # @param [String] page_token # Optional. The page token, returned by a previous call, to request the next # page of results. # @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::DataprocV1beta2::ListWorkflowTemplatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_workflow_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+parent}/workflowTemplates', options) command.response_representation = Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse::Representation command.response_class = Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse 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 # Updates (replaces) workflow template. The updated template must contain # version that matches the current server version. # @param [String] name # Output only. The "resource name" of the template, as described in https:// # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_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::DataprocV1beta2::WorkflowTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::WorkflowTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_location_workflow_template(name, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta2/{+name}', options) command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.request_object = workflow_template_object command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate 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 cluster in a project. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [Google::Apis::DataprocV1beta2::Cluster] cluster_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::DataprocV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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_region_cluster(project_id, region, cluster_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/clusters', options) command.request_representation = Google::Apis::DataprocV1beta2::Cluster::Representation command.request_object = cluster_object command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation command.response_class = Google::Apis::DataprocV1beta2::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.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 cluster in a project. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [String] cluster_name # Required. The cluster name. # @param [String] cluster_uuid # Optional. Specifying the cluster_uuid means the RPC should fail (with error # NOT_FOUND) if cluster with specified UUID does not exist. # @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::DataprocV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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_project_region_cluster(project_id, region, cluster_name, cluster_uuid: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}', options) command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation command.response_class = Google::Apis::DataprocV1beta2::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.params['clusterName'] = cluster_name unless cluster_name.nil? command.query['clusterUuid'] = cluster_uuid unless cluster_uuid.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 cluster diagnostic information. After the operation completes, the # Operation.response field contains DiagnoseClusterOutputLocation. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [String] cluster_name # Required. The cluster name. # @param [Google::Apis::DataprocV1beta2::DiagnoseClusterRequest] diagnose_cluster_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::DataprocV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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 diagnose_cluster(project_id, region, cluster_name, diagnose_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose', options) command.request_representation = Google::Apis::DataprocV1beta2::DiagnoseClusterRequest::Representation command.request_object = diagnose_cluster_request_object command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation command.response_class = Google::Apis::DataprocV1beta2::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.params['clusterName'] = cluster_name unless cluster_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 resource representation for a cluster in a project. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [String] cluster_name # Required. The cluster 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::DataprocV1beta2::Cluster] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::Cluster] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_cluster(project_id, region, cluster_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}', options) command.response_representation = Google::Apis::DataprocV1beta2::Cluster::Representation command.response_class = Google::Apis::DataprocV1beta2::Cluster command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.params['clusterName'] = cluster_name unless cluster_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 access control policy for a resource. Returns an empty policy if the # resource exists and does not have a policy set. # @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 [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::DataprocV1beta2::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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_project_region_cluster_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options) command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation command.response_class = Google::Apis::DataprocV1beta2::Policy 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 # Lists all regions/`region`/clusters in a project. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [String] filter # Optional. A filter constraining the clusters to list. Filters are case- # sensitive and have the following syntax:field = value AND field = value ... # where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is # a label key. value can be * to match all values. status.state can be one of # the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or # UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE # contains the DELETING and ERROR states. clusterName is the name of the cluster # provided at creation time. Only the logical AND operator is supported; space- # separated items are treated as having an implicit AND operator.Example filter: # status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND # labels.starred = * # @param [Fixnum] page_size # Optional. The standard List page size. # @param [String] page_token # Optional. 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::DataprocV1beta2::ListClustersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::ListClustersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_clusters(project_id, region, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/projects/{projectId}/regions/{region}/clusters', options) command.response_representation = Google::Apis::DataprocV1beta2::ListClustersResponse::Representation command.response_class = Google::Apis::DataprocV1beta2::ListClustersResponse command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.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 cluster in a project. # @param [String] project_id # Required. The ID of the Google Cloud Platform project the cluster belongs to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [String] cluster_name # Required. The cluster name. # @param [Google::Apis::DataprocV1beta2::Cluster] cluster_object # @param [String] graceful_decommission_timeout # Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning # allows removing nodes from the cluster without interrupting jobs in progress. # Timeout specifies how long to wait for jobs in progress to finish before # forcefully removing nodes (and potentially interrupting jobs). Default timeout # is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. # Only supported on Dataproc image versions 1.2 and higher. # @param [String] update_mask # Required. Specifies the path, relative to Cluster, of the field # to update. For example, to change the number of workers in a cluster to 5, the # update_mask parameter would be specified as config. # worker_config.num_instances, and the PATCH request body would specify # the new value, as follows: # ` # "config":` # "workerConfig":` # "numInstances":"5" # ` # ` # ` # Similarly, to change the number of preemptible workers in a cluster to 5, the < # code>update_mask parameter would be config. # secondary_worker_config.num_instances, and the PATCH request body would # be set as follows: # ` # "config":` # "secondaryWorkerConfig":` # "numInstances":"5" # ` # ` # ` # Note: currently only some fields can be updated: |Mask| # Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize # primary worker group| |config.secondary_worker_config.num_instances|Resize # secondary worker group| |config.lifecycle_config.auto_delete_ttl|Reset MAX TTL # duration| |config.lifecycle_config.auto_delete_time|Update MAX TTL deletion # timestamp| |config.lifecycle_config.idle_delete_ttl|Update Idle TTL duration| # @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::DataprocV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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_region_cluster(project_id, region, cluster_name, cluster_object = nil, graceful_decommission_timeout: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}', options) command.request_representation = Google::Apis::DataprocV1beta2::Cluster::Representation command.request_object = cluster_object command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation command.response_class = Google::Apis::DataprocV1beta2::Operation command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.params['clusterName'] = cluster_name unless cluster_name.nil? command.query['gracefulDecommissionTimeout'] = graceful_decommission_timeout unless graceful_decommission_timeout.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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @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::DataprocV1beta2::SetIamPolicyRequest] 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::DataprocV1beta2::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options) command.request_representation = Google::Apis::DataprocV1beta2::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation command.response_class = Google::Apis::DataprocV1beta2::Policy 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 # 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.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. # @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::DataprocV1beta2::TestIamPermissionsRequest] 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::DataprocV1beta2::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options) command.request_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse 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 # Starts a job cancellation request. To access the job resource after # cancellation, call regions/`region`/jobs.list or regions/`region`/jobs.get. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the job belongs to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [String] job_id # Required. The job ID. # @param [Google::Apis::DataprocV1beta2::CancelJobRequest] cancel_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::DataprocV1beta2::Job] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::Job] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job(project_id, region, job_id, cancel_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel', options) command.request_representation = Google::Apis::DataprocV1beta2::CancelJobRequest::Representation command.request_object = cancel_job_request_object command.response_representation = Google::Apis::DataprocV1beta2::Job::Representation command.response_class = Google::Apis::DataprocV1beta2::Job command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.params['jobId'] = job_id unless job_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 the job from the project. If the job is active, the delete fails, and # the response returns FAILED_PRECONDITION. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the job belongs to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [String] job_id # Required. The job 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::DataprocV1beta2::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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_region_job(project_id, region, job_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}', options) command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation command.response_class = Google::Apis::DataprocV1beta2::Empty command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.params['jobId'] = job_id unless job_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 the resource representation for a job in a project. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the job belongs to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [String] job_id # Required. The job 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::DataprocV1beta2::Job] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::Job] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_job(project_id, region, job_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}', options) command.response_representation = Google::Apis::DataprocV1beta2::Job::Representation command.response_class = Google::Apis::DataprocV1beta2::Job command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.params['jobId'] = job_id unless job_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 regions/`region`/jobs in a project. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the job belongs to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [String] cluster_name # Optional. If set, the returned jobs list includes only jobs that were # submitted to the named cluster. # @param [String] filter # Optional. A filter constraining the jobs to list. Filters are case-sensitive # and have the following syntax:field = value AND field = value ...where field # is status.state or labels.[KEY], and [KEY] is a label key. value can be * to # match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the # logical AND operator is supported; space-separated items are treated as having # an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = # staging AND labels.starred = * # @param [String] job_state_matcher # Optional. Specifies enumerated categories of jobs to list. (default = match # ALL jobs).If filter is provided, jobStateMatcher will be ignored. # @param [Fixnum] page_size # Optional. The number of results to return in each response. # @param [String] page_token # Optional. The page token, returned by a previous call, to request the next # page of results. # @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::DataprocV1beta2::ListJobsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::ListJobsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_jobs(project_id, region, cluster_name: nil, filter: nil, job_state_matcher: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/projects/{projectId}/regions/{region}/jobs', options) command.response_representation = Google::Apis::DataprocV1beta2::ListJobsResponse::Representation command.response_class = Google::Apis::DataprocV1beta2::ListJobsResponse command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.query['clusterName'] = cluster_name unless cluster_name.nil? command.query['filter'] = filter unless filter.nil? command.query['jobStateMatcher'] = job_state_matcher unless job_state_matcher.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 job in a project. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the job belongs to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [String] job_id # Required. The job ID. # @param [Google::Apis::DataprocV1beta2::Job] job_object # @param [String] update_mask # Required. Specifies the path, relative to Job, of the field to # update. For example, to update the labels of a Job the update_mask # parameter would be specified as labels, and the PATCH request # body would specify the new value. Note: Currently, # labels is the only field that can 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::DataprocV1beta2::Job] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::Job] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_job(project_id, region, job_id, job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}', options) command.request_representation = Google::Apis::DataprocV1beta2::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::DataprocV1beta2::Job::Representation command.response_class = Google::Apis::DataprocV1beta2::Job command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.params['jobId'] = job_id unless job_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 # Submits a job to a cluster. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the job belongs to. # @param [String] region # Required. The Cloud Dataproc region in which to handle the request. # @param [Google::Apis::DataprocV1beta2::SubmitJobRequest] submit_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::DataprocV1beta2::Job] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::Job] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def submit_job(project_id, region, submit_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/jobs:submit', options) command.request_representation = Google::Apis::DataprocV1beta2::SubmitJobRequest::Representation command.request_object = submit_job_request_object command.response_representation = Google::Apis::DataprocV1beta2::Job::Representation command.response_class = Google::Apis::DataprocV1beta2::Job command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Starts asynchronous cancellation on a long-running operation. The server makes # a best effort to cancel the operation, but success is not guaranteed. If the # server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. # Clients can use Operations.GetOperation or other methods to check whether the # cancellation succeeded or whether the operation completed despite cancellation. # On successful cancellation, the operation is not deleted; instead, it becomes # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to Code.CANCELLED. # @param [String] name # The name of the operation resource to be cancelled. # @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::DataprocV1beta2::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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 cancel_project_region_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+name}:cancel', options) command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation command.response_class = Google::Apis::DataprocV1beta2::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 # Deletes a long-running operation. This method indicates that the client is no # longer interested in the operation result. It does not cancel the operation. # If the server doesn't support this method, it returns google.rpc.Code. # UNIMPLEMENTED. # @param [String] name # The name of the operation resource 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::DataprocV1beta2::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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_region_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation command.response_class = Google::Apis::DataprocV1beta2::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 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::DataprocV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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_region_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation command.response_class = Google::Apis::DataprocV1beta2::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 # 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::DataprocV1beta2::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::DataprocV1beta2::ListOperationsResponse::Representation command.response_class = Google::Apis::DataprocV1beta2::ListOperationsResponse 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 new workflow template. # @param [String] parent # Required. The "resource name" of the region, as described in https://cloud. # google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region` # @param [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_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::DataprocV1beta2::WorkflowTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::WorkflowTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_workflow_template(parent, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+parent}/workflowTemplates', options) command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.request_object = workflow_template_object command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate 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 workflow template. It does not cancel in-progress workflows. # @param [String] name # Required. The "resource name" of the workflow template, as described in https:/ # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Fixnum] version # Optional. The version of workflow template to delete. If specified, will only # delete the template if the current server version matches specified version. # @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::DataprocV1beta2::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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_region_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation command.response_class = Google::Apis::DataprocV1beta2::Empty command.params['name'] = name unless name.nil? command.query['version'] = version unless 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 # Retrieves the latest workflow template.Can retrieve previously instantiated # template by specifying optional version parameter. # @param [String] name # Required. The "resource name" of the workflow template, as described in https:/ # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Fixnum] version # Optional. The version of workflow template to retrieve. Only previously # instatiated versions can be retrieved.If unspecified, retrieves the current # version. # @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::DataprocV1beta2::WorkflowTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::WorkflowTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+name}', options) command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate command.params['name'] = name unless name.nil? command.query['version'] = version unless 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 # Instantiates a template and begins execution.The returned Operation can be # used to track execution of workflow by polling operations.get. The Operation # will complete when entire workflow is finished.The running workflow can be # aborted via operations.cancel. This will cause any inflight jobs to be # cancelled and workflow-owned clusters to be deleted.The Operation.metadata # will be WorkflowMetadata.On successful completion, Operation.response will be # Empty. # @param [String] name # Required. The "resource name" of the workflow template, as described in https:/ # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Google::Apis::DataprocV1beta2::InstantiateWorkflowTemplateRequest] instantiate_workflow_template_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::DataprocV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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 instantiate_project_region_workflow_template(name, instantiate_workflow_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+name}:instantiate', options) command.request_representation = Google::Apis::DataprocV1beta2::InstantiateWorkflowTemplateRequest::Representation command.request_object = instantiate_workflow_template_request_object command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation command.response_class = Google::Apis::DataprocV1beta2::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 # Instantiates a template and begins execution.This method is equivalent to # executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, # DeleteWorkflowTemplate.The returned Operation can be used to track execution # of workflow by polling operations.get. The Operation will complete when entire # workflow is finished.The running workflow can be aborted via operations.cancel. # This will cause any inflight jobs to be cancelled and workflow-owned clusters # to be deleted.The Operation.metadata will be WorkflowMetadata.On successful # completion, Operation.response will be Empty. # @param [String] parent # Required. The "resource name" of the workflow template region, as described in # https://cloud.google.com/apis/design/resource_names of the form projects/` # project_id`/regions/`region` # @param [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_object # @param [String] instance_id # Optional. A tag that prevents multiple concurrent workflow instances with the # same tag from running. This mitigates risk of concurrent instances started due # to retries.It is recommended to always set this value to a UUID (https://en. # wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only # letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The # maximum length is 40 characters. # @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::DataprocV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::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 instantiate_project_region_workflow_template_inline(parent, workflow_template_object = nil, instance_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+parent}/workflowTemplates:instantiateInline', options) command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.request_object = workflow_template_object command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation command.response_class = Google::Apis::DataprocV1beta2::Operation command.params['parent'] = parent unless parent.nil? command.query['instanceId'] = instance_id unless instance_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 workflows that match the specified filter in the request. # @param [String] parent # Required. The "resource name" of the region, as described in https://cloud. # google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region` # @param [Fixnum] page_size # Optional. The maximum number of results to return in each response. # @param [String] page_token # Optional. The page token, returned by a previous call, to request the next # page of results. # @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::DataprocV1beta2::ListWorkflowTemplatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_workflow_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+parent}/workflowTemplates', options) command.response_representation = Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse::Representation command.response_class = Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse 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 # Updates (replaces) workflow template. The updated template must contain # version that matches the current server version. # @param [String] name # Output only. The "resource name" of the template, as described in https:// # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_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::DataprocV1beta2::WorkflowTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DataprocV1beta2::WorkflowTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_region_workflow_template(name, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta2/{+name}', options) command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.request_object = workflow_template_object command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate 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 google-api-client-0.19.8/generated/google/apis/analytics_v3.rb0000644000004100000410000000347113252673043024244 0ustar www-datawww-data# 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/analytics_v3/service.rb' require 'google/apis/analytics_v3/classes.rb' require 'google/apis/analytics_v3/representations.rb' module Google module Apis # Google Analytics API # # Views and manages your Google Analytics data. # # @see https://developers.google.com/analytics/ module AnalyticsV3 VERSION = 'V3' REVISION = '20171211' # View and manage your Google Analytics data AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics' # Edit Google Analytics management entities AUTH_ANALYTICS_EDIT = 'https://www.googleapis.com/auth/analytics.edit' # Manage Google Analytics Account users by email address AUTH_ANALYTICS_MANAGE_USERS = 'https://www.googleapis.com/auth/analytics.manage.users' # View Google Analytics user permissions AUTH_ANALYTICS_MANAGE_USERS_READONLY = 'https://www.googleapis.com/auth/analytics.manage.users.readonly' # Create a new Google Analytics account along with its default property and view AUTH_ANALYTICS_PROVISION = 'https://www.googleapis.com/auth/analytics.provision' # View your Google Analytics data AUTH_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/analytics.readonly' end end end google-api-client-0.19.8/generated/google/apis/androidpublisher_v1/0000755000004100000410000000000013252673043025257 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/androidpublisher_v1/representations.rb0000644000004100000410000000265613252673043031042 0ustar www-datawww-data# 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 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 google-api-client-0.19.8/generated/google/apis/androidpublisher_v1/classes.rb0000644000004100000410000000475113252673043027250 0ustar www-datawww-data# 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 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 google-api-client-0.19.8/generated/google/apis/androidpublisher_v1/service.rb0000644000004100000410000001677313252673043027262 0ustar www-datawww-data# 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 AndroidpublisherV1 # Google Play Developer API # # Lets Android application developers access their Google Play accounts. # # @example # require 'google/apis/androidpublisher_v1' # # Androidpublisher = Google::Apis::AndroidpublisherV1 # Alias the module # service = Androidpublisher::AndroidPublisherService.new # # @see https://developers.google.com/android-publisher class AndroidPublisherService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'androidpublisher/v1/applications/') @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 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 end end google-api-client-0.19.8/generated/google/apis/adexchangeseller_v1_1.rb0000644000004100000410000000246613252673043025774 0ustar www-datawww-data# 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/adexchangeseller_v1_1/service.rb' require 'google/apis/adexchangeseller_v1_1/classes.rb' require 'google/apis/adexchangeseller_v1_1/representations.rb' module Google module Apis # Ad Exchange Seller API # # Accesses the inventory of Ad Exchange seller users and generates reports. # # @see https://developers.google.com/ad-exchange/seller-rest/ module AdexchangesellerV1_1 VERSION = 'V1_1' REVISION = '20160805' # View and manage your Ad Exchange data AUTH_ADEXCHANGE_SELLER = 'https://www.googleapis.com/auth/adexchange.seller' # View your Ad Exchange data AUTH_ADEXCHANGE_SELLER_READONLY = 'https://www.googleapis.com/auth/adexchange.seller.readonly' end end end google-api-client-0.19.8/generated/google/apis/storage_v1beta1.rb0000644000004100000410000000271013252673044024630 0ustar www-datawww-data# 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/storage_v1beta1/service.rb' require 'google/apis/storage_v1beta1/classes.rb' require 'google/apis/storage_v1beta1/representations.rb' module Google module Apis # Cloud Storage JSON API # # Lets you store and retrieve potentially-large, immutable data objects. # # @see https://developers.google.com/storage/docs/json_api/ module StorageV1beta1 VERSION = 'V1beta1' REVISION = '20171212' # Manage your data and permissions in Google Cloud Storage AUTH_DEVSTORAGE_FULL_CONTROL = 'https://www.googleapis.com/auth/devstorage.full_control' # View your data in Google Cloud Storage AUTH_DEVSTORAGE_READ_ONLY = 'https://www.googleapis.com/auth/devstorage.read_only' # Manage your data in Google Cloud Storage AUTH_DEVSTORAGE_READ_WRITE = 'https://www.googleapis.com/auth/devstorage.read_write' end end end google-api-client-0.19.8/generated/google/apis/pubsub_v1beta2.rb0000644000004100000410000000242313252673044024466 0ustar www-datawww-data# 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/pubsub_v1beta2/service.rb' require 'google/apis/pubsub_v1beta2/classes.rb' require 'google/apis/pubsub_v1beta2/representations.rb' module Google module Apis # Google Cloud Pub/Sub API # # Provides reliable, many-to-many, asynchronous messaging between applications. # # @see https://cloud.google.com/pubsub/docs module PubsubV1beta2 VERSION = 'V1beta2' REVISION = '20180103' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View and manage Pub/Sub topics and subscriptions AUTH_PUBSUB = 'https://www.googleapis.com/auth/pubsub' end end end google-api-client-0.19.8/generated/google/apis/cloudtasks_v2beta2/0000755000004100000410000000000013252673043025014 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/cloudtasks_v2beta2/representations.rb0000644000004100000410000004324613252673043030577 0ustar www-datawww-data# 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 CloudtasksV2beta2 class AcknowledgeTaskRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AppEngineHttpRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AppEngineHttpTarget class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AppEngineRouting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AttemptStatus 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 CancelLeaseRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateTaskRequest 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 GetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LeaseTasksRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LeaseTasksResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLocationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListQueuesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTasksResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Location class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PauseQueueRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PullMessage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PullTarget class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PurgeQueueRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Queue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RateLimits class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RenewLeaseRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResumeQueueRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RetryConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RunTaskRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetIamPolicyRequest 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 Task class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TaskStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AcknowledgeTaskRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :schedule_time, as: 'scheduleTime' end end class AppEngineHttpRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_engine_routing, as: 'appEngineRouting', class: Google::Apis::CloudtasksV2beta2::AppEngineRouting, decorator: Google::Apis::CloudtasksV2beta2::AppEngineRouting::Representation hash :headers, as: 'headers' property :http_method, as: 'httpMethod' property :payload, :base64 => true, as: 'payload' property :relative_url, as: 'relativeUrl' end end class AppEngineHttpTarget # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_engine_routing_override, as: 'appEngineRoutingOverride', class: Google::Apis::CloudtasksV2beta2::AppEngineRouting, decorator: Google::Apis::CloudtasksV2beta2::AppEngineRouting::Representation end end class AppEngineRouting # @private class Representation < Google::Apis::Core::JsonRepresentation property :host, as: 'host' property :instance, as: 'instance' property :service, as: 'service' property :version, as: 'version' end end class AttemptStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :dispatch_time, as: 'dispatchTime' property :response_status, as: 'responseStatus', class: Google::Apis::CloudtasksV2beta2::Status, decorator: Google::Apis::CloudtasksV2beta2::Status::Representation property :response_time, as: 'responseTime' property :schedule_time, as: 'scheduleTime' end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation collection :members, as: 'members' property :role, as: 'role' end end class CancelLeaseRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :response_view, as: 'responseView' property :schedule_time, as: 'scheduleTime' end end class CreateTaskRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :response_view, as: 'responseView' property :task, as: 'task', class: Google::Apis::CloudtasksV2beta2::Task, decorator: Google::Apis::CloudtasksV2beta2::Task::Representation end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class LeaseTasksRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :filter, as: 'filter' property :lease_duration, as: 'leaseDuration' property :max_tasks, as: 'maxTasks' property :response_view, as: 'responseView' end end class LeaseTasksResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :tasks, as: 'tasks', class: Google::Apis::CloudtasksV2beta2::Task, decorator: Google::Apis::CloudtasksV2beta2::Task::Representation end end class ListLocationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :locations, as: 'locations', class: Google::Apis::CloudtasksV2beta2::Location, decorator: Google::Apis::CloudtasksV2beta2::Location::Representation property :next_page_token, as: 'nextPageToken' end end class ListQueuesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :queues, as: 'queues', class: Google::Apis::CloudtasksV2beta2::Queue, decorator: Google::Apis::CloudtasksV2beta2::Queue::Representation end end class ListTasksResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :tasks, as: 'tasks', class: Google::Apis::CloudtasksV2beta2::Task, decorator: Google::Apis::CloudtasksV2beta2::Task::Representation end end class Location # @private class Representation < Google::Apis::Core::JsonRepresentation hash :labels, as: 'labels' property :location_id, as: 'locationId' hash :metadata, as: 'metadata' property :name, as: 'name' end end class PauseQueueRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :bindings, as: 'bindings', class: Google::Apis::CloudtasksV2beta2::Binding, decorator: Google::Apis::CloudtasksV2beta2::Binding::Representation property :etag, :base64 => true, as: 'etag' property :version, as: 'version' end end class PullMessage # @private class Representation < Google::Apis::Core::JsonRepresentation property :payload, :base64 => true, as: 'payload' property :tag, as: 'tag' end end class PullTarget # @private class Representation < Google::Apis::Core::JsonRepresentation end end class PurgeQueueRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Queue # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_engine_http_target, as: 'appEngineHttpTarget', class: Google::Apis::CloudtasksV2beta2::AppEngineHttpTarget, decorator: Google::Apis::CloudtasksV2beta2::AppEngineHttpTarget::Representation property :name, as: 'name' property :pull_target, as: 'pullTarget', class: Google::Apis::CloudtasksV2beta2::PullTarget, decorator: Google::Apis::CloudtasksV2beta2::PullTarget::Representation property :purge_time, as: 'purgeTime' property :rate_limits, as: 'rateLimits', class: Google::Apis::CloudtasksV2beta2::RateLimits, decorator: Google::Apis::CloudtasksV2beta2::RateLimits::Representation property :retry_config, as: 'retryConfig', class: Google::Apis::CloudtasksV2beta2::RetryConfig, decorator: Google::Apis::CloudtasksV2beta2::RetryConfig::Representation property :state, as: 'state' end end class RateLimits # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_burst_size, as: 'maxBurstSize' property :max_concurrent_tasks, as: 'maxConcurrentTasks' property :max_tasks_dispatched_per_second, as: 'maxTasksDispatchedPerSecond' end end class RenewLeaseRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :lease_duration, as: 'leaseDuration' property :response_view, as: 'responseView' property :schedule_time, as: 'scheduleTime' end end class ResumeQueueRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class RetryConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_attempts, as: 'maxAttempts' property :max_backoff, as: 'maxBackoff' property :max_doublings, as: 'maxDoublings' property :max_retry_duration, as: 'maxRetryDuration' property :min_backoff, as: 'minBackoff' property :unlimited_attempts, as: 'unlimitedAttempts' end end class RunTaskRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :response_view, as: 'responseView' end end class SetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :policy, as: 'policy', class: Google::Apis::CloudtasksV2beta2::Policy, decorator: Google::Apis::CloudtasksV2beta2::Policy::Representation 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 Task # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_engine_http_request, as: 'appEngineHttpRequest', class: Google::Apis::CloudtasksV2beta2::AppEngineHttpRequest, decorator: Google::Apis::CloudtasksV2beta2::AppEngineHttpRequest::Representation property :create_time, as: 'createTime' property :name, as: 'name' property :pull_message, as: 'pullMessage', class: Google::Apis::CloudtasksV2beta2::PullMessage, decorator: Google::Apis::CloudtasksV2beta2::PullMessage::Representation property :schedule_time, as: 'scheduleTime' property :status, as: 'status', class: Google::Apis::CloudtasksV2beta2::TaskStatus, decorator: Google::Apis::CloudtasksV2beta2::TaskStatus::Representation property :view, as: 'view' end end class TaskStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :attempt_dispatch_count, as: 'attemptDispatchCount' property :attempt_response_count, as: 'attemptResponseCount' property :first_attempt_status, as: 'firstAttemptStatus', class: Google::Apis::CloudtasksV2beta2::AttemptStatus, decorator: Google::Apis::CloudtasksV2beta2::AttemptStatus::Representation property :last_attempt_status, as: 'lastAttemptStatus', class: Google::Apis::CloudtasksV2beta2::AttemptStatus, decorator: Google::Apis::CloudtasksV2beta2::AttemptStatus::Representation end end class TestIamPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestIamPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end end end end google-api-client-0.19.8/generated/google/apis/cloudtasks_v2beta2/classes.rb0000644000004100000410000021310513252673043027000 0ustar www-datawww-data# 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 CloudtasksV2beta2 # Request message for acknowledging a task using # AcknowledgeTask. class AcknowledgeTaskRequest include Google::Apis::Core::Hashable # Required. # The task's current schedule time, available in the # schedule_time returned by # LeaseTasks response or # RenewLease response. This restriction is # to ensure that your worker currently holds the lease. # Corresponds to the JSON property `scheduleTime` # @return [String] attr_accessor :schedule_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @schedule_time = args[:schedule_time] if args.key?(:schedule_time) end end # App Engine HTTP request. # The message defines the HTTP request that is sent to an App Engine app when # the task is dispatched. # This proto can only be used for tasks in a queue which has # app_engine_http_target set. # Using AppEngineHttpRequest requires # [`appengine.applications.get`](/appengine/docs/admin-api/access-control) # Google IAM permission for the project # and the following scope: # `https://www.googleapis.com/auth/cloud-platform` # The task will be delivered to the App Engine app which belongs to the same # project as the queue. For more information, see # [How Requests are Routed](/appengine/docs/standard/python/how-requests-are- # routed) # and how routing is affected by # [dispatch files](/appengine/docs/python/config/dispatchref). # The AppEngineRouting used to construct the URL that the task is # delivered to can be set at the queue-level or task-level: # * If set, # app_engine_routing_override # is used for all tasks in the queue, no matter what the setting # is for the # task-level app_engine_routing. # The `url` that the task will be sent to is: # * `url =` host `+` # relative_url # The task attempt has succeeded if the app's request handler returns # an HTTP response code in the range [`200` - `299`]. `503` is # considered an App Engine system error instead of an application # error. Requests returning error `503` will be retried regardless of # retry configuration and not counted against retry counts. # Any other response code or a failure to receive a response before the # deadline is a failed attempt. class AppEngineHttpRequest include Google::Apis::Core::Hashable # App Engine Routing. # For more information about services, versions, and instances see # [An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine), # [Microservices Architecture on Google App Engine](/appengine/docs/python/ # microservices-on-app-engine), # [App Engine Standard request routing](/appengine/docs/standard/python/how- # requests-are-routed), # and [App Engine Flex request routing](/appengine/docs/flexible/python/how- # requests-are-routed). # Corresponds to the JSON property `appEngineRouting` # @return [Google::Apis::CloudtasksV2beta2::AppEngineRouting] attr_accessor :app_engine_routing # HTTP request headers. # This map contains the header field names and values. # Headers can be set when the # [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask). # Repeated headers are not supported but a header value can contain commas. # Cloud Tasks sets some headers to default values: # * `User-Agent`: By default, this header is # `"AppEngine-Google; (+http://code.google.com/appengine)"`. # This header can be modified, but Cloud Tasks will append # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the # modified `User-Agent`. # If the task has a payload, Cloud # Tasks sets the following headers: # * `Content-Type`: By default, the `Content-Type` header is set to # `"application/octet-stream"`. The default can be overridden by explicitly # setting `Content-Type` to a particular media type when the # [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask). # For example, `Content-Type` can be set to `"application/json"`. # * `Content-Length`: This is computed by Cloud Tasks. This value is # output only. It cannot be changed. # The headers below cannot be set or overridden: # * `Host` # * `X-Google-*` # * `X-AppEngine-*` # In addition, Cloud Tasks sets some headers when the task is dispatched, # such as headers containing information about the task; see # [request headers](/appengine/docs/python/taskqueue/push/creating-handlers# # reading_request_headers). # These headers are set only when the task is dispatched, so they are not # visible when the task is returned in a Cloud Tasks response. # Although there is no specific limit for the maximum number of headers or # the size, there is a limit on the maximum size of the Task. For more # information, see the CreateTask documentation. # Corresponds to the JSON property `headers` # @return [Hash] attr_accessor :headers # 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 handler](/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](/appengine/docs/python/tools/webapp/ # requesthandlerclass). # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method # Payload. # The payload will be sent as the HTTP message body. A message # body, and thus a payload, is allowed only if the HTTP method is # POST or PUT. It is an error to set a data payload on a task with # an incompatible HttpMethod. # Corresponds to the JSON property `payload` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :payload # The relative URL. # The relative URL must begin with "/" and must be a valid HTTP relative URL. # It can contain a path and query string arguments. # If the relative URL is empty, then the root path "/" will be used. # No spaces are allowed, and the maximum length allowed is 2083 characters. # Corresponds to the JSON property `relativeUrl` # @return [String] attr_accessor :relative_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @app_engine_routing = args[:app_engine_routing] if args.key?(:app_engine_routing) @headers = args[:headers] if args.key?(:headers) @http_method = args[:http_method] if args.key?(:http_method) @payload = args[:payload] if args.key?(:payload) @relative_url = args[:relative_url] if args.key?(:relative_url) end end # App Engine HTTP target. # The task will be delivered to the App Engine application hostname # specified by its AppEngineHttpTarget and AppEngineHttpRequest. # The documentation for AppEngineHttpRequest explains how the # task's host URL is constructed. # Using AppEngineHttpTarget requires # [`appengine.applications.get`](/appengine/docs/admin-api/access-control) # Google IAM permission for the project # and the following scope: # `https://www.googleapis.com/auth/cloud-platform` class AppEngineHttpTarget include Google::Apis::Core::Hashable # App Engine Routing. # For more information about services, versions, and instances see # [An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine), # [Microservices Architecture on Google App Engine](/appengine/docs/python/ # microservices-on-app-engine), # [App Engine Standard request routing](/appengine/docs/standard/python/how- # requests-are-routed), # and [App Engine Flex request routing](/appengine/docs/flexible/python/how- # requests-are-routed). # Corresponds to the JSON property `appEngineRoutingOverride` # @return [Google::Apis::CloudtasksV2beta2::AppEngineRouting] attr_accessor :app_engine_routing_override def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @app_engine_routing_override = args[:app_engine_routing_override] if args.key?(:app_engine_routing_override) end end # App Engine Routing. # For more information about services, versions, and instances see # [An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine), # [Microservices Architecture on Google App Engine](/appengine/docs/python/ # microservices-on-app-engine), # [App Engine Standard request routing](/appengine/docs/standard/python/how- # requests-are-routed), # and [App Engine Flex request routing](/appengine/docs/flexible/python/how- # requests-are-routed). class AppEngineRouting include Google::Apis::Core::Hashable # Output only. The host that the task is sent to. # For more information, see # [How Requests are Routed](/appengine/docs/standard/python/how-requests-are- # routed). # The host is constructed as: # * `host = [application_domain_name]`
# `| [service] + '.' + [application_domain_name]`
# `| [version] + '.' + [application_domain_name]`
# `| [version_dot_service]+ '.' + [application_domain_name]`
# `| [instance] + '.' + [application_domain_name]`
# `| [instance_dot_service] + '.' + [application_domain_name]`
# `| [instance_dot_version] + '.' + [application_domain_name]`
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` # * `application_domain_name` = The domain name of the app, for # example .appspot.com, which is associated with the # queue's project ID. Some tasks which were created using the App Engine # SDK use a custom domain name. # * `service =` service # * `version =` version # * `version_dot_service =` # version `+ '.' +` # service # * `instance =` instance # * `instance_dot_service =` # instance `+ '.' +` # service # * `instance_dot_version =` # instance `+ '.' +` # version # * `instance_dot_version_dot_service =` # instance `+ '.' +` # version `+ '.' +` # service # If service is empty, then the task will be sent # to the service which is the default service when the task is attempted. # If version is empty, then the task will be sent # to the version which is the default version when the task is attempted. # If instance is empty, then the task # will be sent to an instance which is available when the task is # attempted. # When service is "default", # version is "default", and # instance is empty, # host is shortened to just the # `application_domain_name`. # If service, # version, or # instance is invalid, then the task # will be sent to the default version of the default service when # the task is attempted. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # App instance. # By default, the task is sent to an instance which is available when # the task is attempted. # Requests can only be sent to a specific instance if # [manual scaling is used in App Engine Standard](/appengine/docs/python/an- # overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). # App Engine Flex does not support instances. For more information, see # [App Engine Standard request routing](/appengine/docs/standard/python/how- # requests-are-routed) # and [App Engine Flex request routing](/appengine/docs/flexible/python/how- # requests-are-routed). # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # App service. # By default, the task is sent to the service which is the default # service when the task is attempted ("default"). # For some queues or tasks which were created using the App Engine # Task Queue API, host is not parsable # into service, # version, and # instance. For example, some tasks # which were created using the App Engine SDK use a custom domain # name; custom domains are not parsed by Cloud Tasks. If # host is not parsable, then # service, # version, and # instance are the empty string. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service # App version. # By default, the task is sent to the version which is the default # version when the task is attempted ("default"). # For some queues or tasks which were created using the App Engine # Task Queue API, host is not parsable # into service, # version, and # instance. For example, some tasks # which were created using the App Engine SDK use a custom domain # name; custom domains are not parsed by Cloud Tasks. If # host is not parsable, then # service, # version, and # instance are the empty string. # 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) @host = args[:host] if args.key?(:host) @instance = args[:instance] if args.key?(:instance) @service = args[:service] if args.key?(:service) @version = args[:version] if args.key?(:version) end end # The status of a task attempt. class AttemptStatus include Google::Apis::Core::Hashable # Output only. The time that this attempt was dispatched. # `dispatch_time` will be truncated to the nearest microsecond. # Corresponds to the JSON property `dispatchTime` # @return [String] attr_accessor :dispatch_time # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `responseStatus` # @return [Google::Apis::CloudtasksV2beta2::Status] attr_accessor :response_status # Output only. The time that this attempt response was received. # `response_time` will be truncated to the nearest microsecond. # Corresponds to the JSON property `responseTime` # @return [String] attr_accessor :response_time # Output only. The time that this attempt was scheduled. # `schedule_time` will be truncated to the nearest microsecond. # Corresponds to the JSON property `scheduleTime` # @return [String] attr_accessor :schedule_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dispatch_time = args[:dispatch_time] if args.key?(:dispatch_time) @response_status = args[:response_status] if args.key?(:response_status) @response_time = args[:response_time] if args.key?(:response_time) @schedule_time = args[:schedule_time] if args.key?(:schedule_time) end end # Associates `members` with a `role`. class Binding include Google::Apis::Core::Hashable # 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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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`. # Required # 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) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end # Request message for canceling a lease using # CancelLease. class CancelLeaseRequest include Google::Apis::Core::Hashable # The response_view specifies which subset of the Task will be # returned. # By default response_view is BASIC; not all # information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # Authorization for FULL requires # `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the # Task resource. # Corresponds to the JSON property `responseView` # @return [String] attr_accessor :response_view # Required. # The task's current schedule time, available in the # schedule_time returned by # LeaseTasks response or # RenewLease response. This restriction is # to ensure that your worker currently holds the lease. # Corresponds to the JSON property `scheduleTime` # @return [String] attr_accessor :schedule_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @response_view = args[:response_view] if args.key?(:response_view) @schedule_time = args[:schedule_time] if args.key?(:schedule_time) end end # Request message for CreateTask. class CreateTaskRequest include Google::Apis::Core::Hashable # The response_view specifies which subset of the Task will be # returned. # By default response_view is BASIC; not all # information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # Authorization for FULL requires # `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the # Task resource. # Corresponds to the JSON property `responseView` # @return [String] attr_accessor :response_view # A unit of scheduled work. # Corresponds to the JSON property `task` # @return [Google::Apis::CloudtasksV2beta2::Task] attr_accessor :task def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @response_view = args[:response_view] if args.key?(:response_view) @task = args[:task] if args.key?(:task) 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 # Request message for `GetIamPolicy` method. class GetIamPolicyRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Request message for leasing tasks using LeaseTasks. class LeaseTasksRequest include Google::Apis::Core::Hashable # `filter` can be used to specify a subset of tasks to lease. # When `filter` is set to `tag=` then the # response will contain only tasks whose # tag is equal to ``. `` must be # less than 500 characters. # When `filter` is set to `tag_function=oldest_tag()`, only tasks which have # the same tag as the task with the oldest schedule_time will be returned. # Grammar Syntax: # * `filter = "tag=" tag | "tag_function=" function` # * `tag = string` # * `function = "oldest_tag()"` # The `oldest_tag()` function returns tasks which have the same tag as the # oldest task (ordered by schedule time). # SDK compatibility: Although the SDK allows tags to be either # string or # [bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/api/ # taskqueue/TaskOptions.html#tag-byte:A-), # only UTF-8 encoded tags can be used in Cloud Tasks. Tag which # aren't UTF-8 encoded can't be used in the # filter and the task's # tag will be displayed as empty in Cloud Tasks. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # After the worker has successfully finished the work associated # with the task, the worker must call via # AcknowledgeTask before the # schedule_time. Otherwise the task will be # returned to a later LeaseTasks call so # that another worker can retry it. # The maximum lease duration is 1 week. # `lease_duration` will be truncated to the nearest second. # Corresponds to the JSON property `leaseDuration` # @return [String] attr_accessor :lease_duration # The maximum number of tasks to lease. The maximum that can be # requested is 1000. # Corresponds to the JSON property `maxTasks` # @return [Fixnum] attr_accessor :max_tasks # The response_view specifies which subset of the Task will be # returned. # By default response_view is BASIC; not all # information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # Authorization for FULL requires # `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the # Task resource. # Corresponds to the JSON property `responseView` # @return [String] attr_accessor :response_view def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filter = args[:filter] if args.key?(:filter) @lease_duration = args[:lease_duration] if args.key?(:lease_duration) @max_tasks = args[:max_tasks] if args.key?(:max_tasks) @response_view = args[:response_view] if args.key?(:response_view) end end # Response message for leasing tasks using LeaseTasks. class LeaseTasksResponse include Google::Apis::Core::Hashable # The leased tasks. # Corresponds to the JSON property `tasks` # @return [Array] attr_accessor :tasks def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @tasks = args[:tasks] if args.key?(:tasks) end end # The response message for Locations.ListLocations. class ListLocationsResponse include Google::Apis::Core::Hashable # A list of locations that matches the specified filter in the request. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # The standard List next-page token. # 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) @locations = args[:locations] if args.key?(:locations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for ListQueues. class ListQueuesResponse include Google::Apis::Core::Hashable # A token to retrieve next page of results. # To return the next page of results, call # ListQueues with this value as the # page_token. # If the next_page_token is empty, there are no more results. # The page token is valid for only 2 hours. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of queues. # Corresponds to the JSON property `queues` # @return [Array] attr_accessor :queues 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) @queues = args[:queues] if args.key?(:queues) end end # Response message for listing tasks using ListTasks. class ListTasksResponse include Google::Apis::Core::Hashable # A token to retrieve next page of results. # To return the next page of results, call # ListTasks with this value as the # page_token. # If the next_page_token is empty, there are no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of tasks. # Corresponds to the JSON property `tasks` # @return [Array] attr_accessor :tasks 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) @tasks = args[:tasks] if args.key?(:tasks) end end # A resource that represents Google Cloud Platform location. class Location include Google::Apis::Core::Hashable # Cross-service attributes for the location. For example # `"cloud.googleapis.com/region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The canonical id for this location. For example: `"us-east1"`. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Service-specific metadata. For example the available capacity at the given # location. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # Resource name for the location, which may vary between implementations. # For example: `"projects/example-project/locations/us-east1"` # 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) @labels = args[:labels] if args.key?(:labels) @location_id = args[:location_id] if args.key?(:location_id) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) end end # Request message for PauseQueue. class PauseQueueRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). class Policy include Google::Apis::Core::Hashable # Associates a list of `members` to a `role`. # `bindings` with no members will result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # Deprecated. # 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) @bindings = args[:bindings] if args.key?(:bindings) @etag = args[:etag] if args.key?(:etag) @version = args[:version] if args.key?(:version) end end # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. # This proto can only be used for tasks in a queue which has # pull_target set. class PullMessage include Google::Apis::Core::Hashable # A data payload consumed by the worker to execute the task. # Corresponds to the JSON property `payload` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :payload # The task's tag. # Tags allow similar tasks to be processed in a batch. If you label # tasks with a tag, your worker can # lease tasks with the same tag using # filter. For example, if you want to # aggregate the events associated with a specific user once a day, # you could tag tasks with the user ID. # The task's tag can only be set when the # task is created. # The tag must be less than 500 characters. # SDK compatibility: Although the SDK allows tags to be either # string or [bytes](/appengine/docs/standard/java/javadoc/com/google/appengine/ # api/taskqueue/TaskOptions.html#tag-byte:A-), # only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 # encoded, the tag will be empty when the task is returned by Cloud Tasks. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @payload = args[:payload] if args.key?(:payload) @tag = args[:tag] if args.key?(:tag) end end # Pull target. class PullTarget include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Request message for PurgeQueue. class PurgeQueueRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # A queue is a container of related tasks. Queues are configured to manage # how those tasks are dispatched. Configurable properties include rate limits, # retry options, target types, and others. class Queue include Google::Apis::Core::Hashable # App Engine HTTP target. # The task will be delivered to the App Engine application hostname # specified by its AppEngineHttpTarget and AppEngineHttpRequest. # The documentation for AppEngineHttpRequest explains how the # task's host URL is constructed. # Using AppEngineHttpTarget requires # [`appengine.applications.get`](/appengine/docs/admin-api/access-control) # Google IAM permission for the project # and the following scope: # `https://www.googleapis.com/auth/cloud-platform` # Corresponds to the JSON property `appEngineHttpTarget` # @return [Google::Apis::CloudtasksV2beta2::AppEngineHttpTarget] attr_accessor :app_engine_http_target # The queue name. # The queue name must have the following format: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), # hyphens (-), colons (:), or periods (.). # For more information, see # [Identifying projects](/resource-manager/docs/creating-managing-projects# # identifying_projects) # * `LOCATION_ID` is the canonical ID for the queue's location. # The list of available locations can be obtained by calling # ListLocations. # For more information, see https://cloud.google.com/about/locations/. # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or # hyphens (-). The maximum length is 100 characters. # Caller-specified and required in CreateQueue, # after which it becomes output only. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Pull target. # Corresponds to the JSON property `pullTarget` # @return [Google::Apis::CloudtasksV2beta2::PullTarget] attr_accessor :pull_target # Output only. The last time this queue was purged. # All tasks that were created before this time # were purged. # A queue can be purged using PurgeQueue, the # [App Engine Task Queue SDK, or the Cloud Console](/appengine/docs/standard/ # python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue) # . # Purge time will be truncated to the nearest microsecond. Purge # time will be unset if the queue has never been purged. # Corresponds to the JSON property `purgeTime` # @return [String] attr_accessor :purge_time # Rate limits. # This message determines the maximum rate that tasks can be dispatched by a # queue, regardless of whether the dispatch is a first task attempt or a retry. # Corresponds to the JSON property `rateLimits` # @return [Google::Apis::CloudtasksV2beta2::RateLimits] attr_accessor :rate_limits # Retry config. # These settings determine how a failed task attempt is retried. # Corresponds to the JSON property `retryConfig` # @return [Google::Apis::CloudtasksV2beta2::RetryConfig] attr_accessor :retry_config # Output only. The state of the queue. # `state` can only be changed by called # PauseQueue, # ResumeQueue, or uploading # [queue.yaml/xml](/appengine/docs/python/config/queueref). # UpdateQueue cannot be used to change `state`. # 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) @app_engine_http_target = args[:app_engine_http_target] if args.key?(:app_engine_http_target) @name = args[:name] if args.key?(:name) @pull_target = args[:pull_target] if args.key?(:pull_target) @purge_time = args[:purge_time] if args.key?(:purge_time) @rate_limits = args[:rate_limits] if args.key?(:rate_limits) @retry_config = args[:retry_config] if args.key?(:retry_config) @state = args[:state] if args.key?(:state) end end # Rate limits. # This message determines the maximum rate that tasks can be dispatched by a # queue, regardless of whether the dispatch is a first task attempt or a retry. class RateLimits include Google::Apis::Core::Hashable # Output only. The max burst size. # Max burst size limits how fast tasks in queue are processed when # many tasks are in the queue and the rate is high. This field # allows the queue to have a high rate so processing starts shortly # after a task is enqueued, but still limits resource usage when # many tasks are enqueued in a short period of time. # The [token bucket](https://wikipedia.org/wiki/Token_Bucket) # algorithm is used to control the rate of task dispatches. Each # queue has a token bucket that holds tokens, up to the maximum # specified by `max_burst_size`. Each time a task is dispatched, a # token is removed from the bucket. Tasks will be dispatched until # the queue's bucket runs out of tokens. The bucket will be # continuously refilled with new tokens based on # max_tasks_dispatched_per_second. # Cloud Tasks will pick the value of `max_burst_size` based on the # value of # max_tasks_dispatched_per_second. # For App Engine queues that were created or updated using # `queue.yaml/xml`, `max_burst_size` is equal to # [bucket_size](/appengine/docs/standard/python/config/queueref#bucket_size). # Since `max_burst_size` is output only, if # UpdateQueue is called on a queue # created by `queue.yaml/xml`, `max_burst_size` will be reset based # on the value of # max_tasks_dispatched_per_second, # regardless of whether # max_tasks_dispatched_per_second # is updated. # Corresponds to the JSON property `maxBurstSize` # @return [Fixnum] attr_accessor :max_burst_size # The maximum number of concurrent tasks that Cloud Tasks allows # to be dispatched for this queue. After this threshold has been # reached, Cloud Tasks stops dispatching tasks until the number of # concurrent requests decreases. # If unspecified when the queue is created, Cloud Tasks will pick the # default. # The maximum allowed value is 5,000. -1 indicates no limit. # This field is output only for # [pull queues](google.cloud.tasks.v2beta2.PullTarget). # This field has the same meaning as # [max_concurrent_requests in queue.yaml/xml](/appengine/docs/standard/python/ # config/queueref#max_concurrent_requests). # Corresponds to the JSON property `maxConcurrentTasks` # @return [Fixnum] attr_accessor :max_concurrent_tasks # The maximum rate at which tasks are dispatched from this queue. # If unspecified when the queue is created, Cloud Tasks will pick the # default. # * For App Engine queues, the maximum allowed value is 500. # * This field is output only for [pull queues](google.cloud.tasks.v2beta2. # PullTarget). In # addition to the `max_tasks_dispatched_per_second` limit, a # maximum of 10 QPS of LeaseTasks # requests are allowed per pull queue. # This field has the same meaning as # [rate in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#rate). # Corresponds to the JSON property `maxTasksDispatchedPerSecond` # @return [Float] attr_accessor :max_tasks_dispatched_per_second def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_burst_size = args[:max_burst_size] if args.key?(:max_burst_size) @max_concurrent_tasks = args[:max_concurrent_tasks] if args.key?(:max_concurrent_tasks) @max_tasks_dispatched_per_second = args[:max_tasks_dispatched_per_second] if args.key?(:max_tasks_dispatched_per_second) end end # Request message for renewing a lease using # RenewLease. class RenewLeaseRequest include Google::Apis::Core::Hashable # Required. # The desired new lease duration, starting from now. # The maximum lease duration is 1 week. # `lease_duration` will be truncated to the nearest second. # Corresponds to the JSON property `leaseDuration` # @return [String] attr_accessor :lease_duration # The response_view specifies which subset of the Task will be # returned. # By default response_view is BASIC; not all # information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # Authorization for FULL requires # `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the # Task resource. # Corresponds to the JSON property `responseView` # @return [String] attr_accessor :response_view # Required. # The task's current schedule time, available in the # schedule_time returned by # LeaseTasks response or # RenewLease response. This restriction is # to ensure that your worker currently holds the lease. # Corresponds to the JSON property `scheduleTime` # @return [String] attr_accessor :schedule_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @lease_duration = args[:lease_duration] if args.key?(:lease_duration) @response_view = args[:response_view] if args.key?(:response_view) @schedule_time = args[:schedule_time] if args.key?(:schedule_time) end end # Request message for ResumeQueue. class ResumeQueueRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Retry config. # These settings determine how a failed task attempt is retried. class RetryConfig include Google::Apis::Core::Hashable # The maximum number of attempts for a task. # Cloud Tasks will attempt the task `max_attempts` times (that # is, if the first attempt fails, then there will be # `max_attempts - 1` retries). Must be > 0. # Corresponds to the JSON property `maxAttempts` # @return [Fixnum] attr_accessor :max_attempts # A task will be [scheduled](Task.schedule_time) for retry between # min_backoff and # max_backoff duration after it fails, # if the queue's RetryConfig specifies that the task should be # retried. # If unspecified when the queue is created, Cloud Tasks will pick the # default. # This field is output only for # [pull queues](google.cloud.tasks.v2beta2.PullTarget). # `max_backoff` will be truncated to the nearest second. # This field has the same meaning as # [max_backoff_seconds in queue.yaml/xml](/appengine/docs/standard/python/config/ # queueref#retry_parameters). # Corresponds to the JSON property `maxBackoff` # @return [String] attr_accessor :max_backoff # The time between retries will double `max_doublings` times. # A task's retry interval starts at # min_backoff, then doubles # `max_doublings` times, then increases linearly, and finally # retries retries at intervals of # max_backoff up to # max_attempts times. # For example, if min_backoff is 10s, # max_backoff is 300s, and # `max_doublings` is 3, then the a task will first be retried in # 10s. The retry interval will double three times, and then # increase linearly by 2^3 * 10s. Finally, the task will retry at # intervals of max_backoff until the # task has been attempted max_attempts # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, # 240s, 300s, 300s, .... # If unspecified when the queue is created, Cloud Tasks will pick the # default. # This field is output only for # [pull queues](google.cloud.tasks.v2beta2.PullTarget). # This field has the same meaning as # [max_doublings in queue.yaml/xml](/appengine/docs/standard/python/config/ # queueref#retry_parameters). # Corresponds to the JSON property `maxDoublings` # @return [Fixnum] attr_accessor :max_doublings # If positive, `max_retry_duration` specifies the time limit for # retrying a failed task, measured from when the task was first # attempted. Once `max_retry_duration` time has passed *and* the # task has been attempted max_attempts # times, no further attempts will be made and the task will be # deleted. # If zero, then the task age is unlimited. # If unspecified when the queue is created, Cloud Tasks will pick the # default. # This field is output only for # [pull queues](google.cloud.tasks.v2beta2.PullTarget). # `max_retry_duration` will be truncated to the nearest second. # This field has the same meaning as # [task_age_limit in queue.yaml/xml](/appengine/docs/standard/python/config/ # queueref#retry_parameters). # Corresponds to the JSON property `maxRetryDuration` # @return [String] attr_accessor :max_retry_duration # A task will be [scheduled](Task.schedule_time) for retry between # min_backoff and # max_backoff duration after it fails, # if the queue's RetryConfig specifies that the task should be # retried. # If unspecified when the queue is created, Cloud Tasks will pick the # default. # This field is output only for # [pull queues](google.cloud.tasks.v2beta2.PullTarget). # `min_backoff` will be truncated to the nearest second. # This field has the same meaning as # [min_backoff_seconds in queue.yaml/xml](/appengine/docs/standard/python/config/ # queueref#retry_parameters). # Corresponds to the JSON property `minBackoff` # @return [String] attr_accessor :min_backoff # If true, then the number of attempts is unlimited. # Corresponds to the JSON property `unlimitedAttempts` # @return [Boolean] attr_accessor :unlimited_attempts alias_method :unlimited_attempts?, :unlimited_attempts def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_attempts = args[:max_attempts] if args.key?(:max_attempts) @max_backoff = args[:max_backoff] if args.key?(:max_backoff) @max_doublings = args[:max_doublings] if args.key?(:max_doublings) @max_retry_duration = args[:max_retry_duration] if args.key?(:max_retry_duration) @min_backoff = args[:min_backoff] if args.key?(:min_backoff) @unlimited_attempts = args[:unlimited_attempts] if args.key?(:unlimited_attempts) end end # Request message for forcing a task to run now using # RunTask. class RunTaskRequest include Google::Apis::Core::Hashable # The response_view specifies which subset of the Task will be # returned. # By default response_view is BASIC; not all # information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # Authorization for FULL requires # `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the # Task resource. # Corresponds to the JSON property `responseView` # @return [String] attr_accessor :response_view def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @response_view = args[:response_view] if args.key?(:response_view) end end # Request message for `SetIamPolicy` method. class SetIamPolicyRequest include Google::Apis::Core::Hashable # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). # Corresponds to the JSON property `policy` # @return [Google::Apis::CloudtasksV2beta2::Policy] attr_accessor :policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @policy = args[:policy] if args.key?(:policy) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 # A unit of scheduled work. class Task include Google::Apis::Core::Hashable # App Engine HTTP request. # The message defines the HTTP request that is sent to an App Engine app when # the task is dispatched. # This proto can only be used for tasks in a queue which has # app_engine_http_target set. # Using AppEngineHttpRequest requires # [`appengine.applications.get`](/appengine/docs/admin-api/access-control) # Google IAM permission for the project # and the following scope: # `https://www.googleapis.com/auth/cloud-platform` # The task will be delivered to the App Engine app which belongs to the same # project as the queue. For more information, see # [How Requests are Routed](/appengine/docs/standard/python/how-requests-are- # routed) # and how routing is affected by # [dispatch files](/appengine/docs/python/config/dispatchref). # The AppEngineRouting used to construct the URL that the task is # delivered to can be set at the queue-level or task-level: # * If set, # app_engine_routing_override # is used for all tasks in the queue, no matter what the setting # is for the # task-level app_engine_routing. # The `url` that the task will be sent to is: # * `url =` host `+` # relative_url # The task attempt has succeeded if the app's request handler returns # an HTTP response code in the range [`200` - `299`]. `503` is # considered an App Engine system error instead of an application # error. Requests returning error `503` will be retried regardless of # retry configuration and not counted against retry counts. # Any other response code or a failure to receive a response before the # deadline is a failed attempt. # Corresponds to the JSON property `appEngineHttpRequest` # @return [Google::Apis::CloudtasksV2beta2::AppEngineHttpRequest] attr_accessor :app_engine_http_request # Output only. The time that the task was created. # `create_time` will be truncated to the nearest second. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The task name. # The task name must have the following format: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), # hyphens (-), colons (:), or periods (.). # For more information, see # [Identifying projects](/resource-manager/docs/creating-managing-projects# # identifying_projects) # * `LOCATION_ID` is the canonical ID for the task's location. # The list of available locations can be obtained by calling # ListLocations. # For more information, see https://cloud.google.com/about/locations/. # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or # hyphens (-). The maximum length is 100 characters. # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), # hyphens (-), or underscores (_). The maximum length is 500 characters. # Optionally caller-specified in CreateTask. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The pull message contains data that can be used by the caller of # LeaseTasks to process the task. # This proto can only be used for tasks in a queue which has # pull_target set. # Corresponds to the JSON property `pullMessage` # @return [Google::Apis::CloudtasksV2beta2::PullMessage] attr_accessor :pull_message # The time when the task is scheduled to be attempted. # For App Engine queues, this is when the task will be attempted or retried. # For pull queues, this is the time when the task is available to # be leased; if a task is currently leased, this is the time when # the current lease expires, that is, the time that the task was # leased plus the lease_duration. # `schedule_time` will be truncated to the nearest microsecond. # Corresponds to the JSON property `scheduleTime` # @return [String] attr_accessor :schedule_time # Status of the task. # Corresponds to the JSON property `status` # @return [Google::Apis::CloudtasksV2beta2::TaskStatus] attr_accessor :status # Output only. The view specifies which subset of the Task has # been returned. # Corresponds to the JSON property `view` # @return [String] attr_accessor :view def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @app_engine_http_request = args[:app_engine_http_request] if args.key?(:app_engine_http_request) @create_time = args[:create_time] if args.key?(:create_time) @name = args[:name] if args.key?(:name) @pull_message = args[:pull_message] if args.key?(:pull_message) @schedule_time = args[:schedule_time] if args.key?(:schedule_time) @status = args[:status] if args.key?(:status) @view = args[:view] if args.key?(:view) end end # Status of the task. class TaskStatus include Google::Apis::Core::Hashable # Output only. The number of attempts dispatched. # This count includes tasks which have been dispatched but haven't # received a response. # Corresponds to the JSON property `attemptDispatchCount` # @return [Fixnum] attr_accessor :attempt_dispatch_count # Output only. The number of attempts which have received a response. # This field is not calculated for # [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget). # Corresponds to the JSON property `attemptResponseCount` # @return [Fixnum] attr_accessor :attempt_response_count # The status of a task attempt. # Corresponds to the JSON property `firstAttemptStatus` # @return [Google::Apis::CloudtasksV2beta2::AttemptStatus] attr_accessor :first_attempt_status # The status of a task attempt. # Corresponds to the JSON property `lastAttemptStatus` # @return [Google::Apis::CloudtasksV2beta2::AttemptStatus] attr_accessor :last_attempt_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @attempt_dispatch_count = args[:attempt_dispatch_count] if args.key?(:attempt_dispatch_count) @attempt_response_count = args[:attempt_response_count] if args.key?(:attempt_response_count) @first_attempt_status = args[:first_attempt_status] if args.key?(:first_attempt_status) @last_attempt_status = args[:last_attempt_status] if args.key?(:last_attempt_status) end end # Request message for `TestIamPermissions` method. class TestIamPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the `resource`. Permissions with # wildcards (such as '*' or 'storage.*') are not allowed. For more # information see # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permissions = args[:permissions] if args.key?(:permissions) end end # Response message for `TestIamPermissions` method. class TestIamPermissionsResponse include Google::Apis::Core::Hashable # A subset of `TestPermissionsRequest.permissions` that the caller is # allowed. # Corresponds to the JSON property `permissions` # @return [Array] 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 end end end google-api-client-0.19.8/generated/google/apis/cloudtasks_v2beta2/service.rb0000644000004100000410000016770213252673043027016 0ustar www-datawww-data# 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 CloudtasksV2beta2 # Cloud Tasks API # # Manages the execution of large numbers of distributed requests. Cloud Tasks is # in Alpha. # # @example # require 'google/apis/cloudtasks_v2beta2' # # Cloudtasks = Google::Apis::CloudtasksV2beta2 # Alias the module # service = Cloudtasks::CloudTasksService.new # # @see https://cloud.google.com/cloud-tasks/ class CloudTasksService < 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://cloudtasks.googleapis.com/', '') @batch_path = 'batch' end # Get information about a location. # @param [String] name # Resource name for the location. # @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::CloudtasksV2beta2::Location] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Location] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::CloudtasksV2beta2::Location::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Location 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 information about the supported locations for this service. # @param [String] name # The resource that owns the locations collection, if applicable. # @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::CloudtasksV2beta2::ListLocationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::ListLocationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}/locations', options) command.response_representation = Google::Apis::CloudtasksV2beta2::ListLocationsResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta2::ListLocationsResponse 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 queue. # Queues created with this method allow tasks to live for a maximum of 31 # days. After a task is 31 days old, the task will be deleted regardless of # whether # it was dispatched or not. # WARNING: Using this method may have unintended side effects if you are # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. # Read # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) # before using this method. # @param [String] parent # Required. # The location name in which the queue will be created. # For example: `projects/PROJECT_ID/locations/LOCATION_ID` # The list of allowed locations can be obtained by calling Cloud # Tasks' implementation of # ListLocations. # @param [Google::Apis::CloudtasksV2beta2::Queue] queue_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::CloudtasksV2beta2::Queue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Queue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_queue(parent, queue_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/queues', options) command.request_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.request_object = queue_object command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue 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 queue. # This command will delete the queue even if it has tasks in it. # Note: If you delete a queue, a queue with the same name can't be created # for 7 days. # WARNING: Using this method may have unintended side effects if you are # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. # Read # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) # before using this method. # @param [String] name # Required. # The queue name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_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::CloudtasksV2beta2::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::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_location_queue(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation command.response_class = Google::Apis::CloudtasksV2beta2::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 queue. # @param [String] name # Required. # The resource name of the queue. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_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::CloudtasksV2beta2::Queue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Queue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_queue(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue 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 access control policy for a Queue. # Returns an empty policy if the resource exists and does not have a policy # set. # Authorization requires the following [Google IAM](/iam) permission on the # specified resource parent: # * `cloudtasks.queues.getIamPolicy` # @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 [Google::Apis::CloudtasksV2beta2::GetIamPolicyRequest] get_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::CloudtasksV2beta2::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::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_queue_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+resource}:getIamPolicy', options) command.request_representation = Google::Apis::CloudtasksV2beta2::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Policy::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Policy 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 # Lists queues. # Queues are returned in lexicographical order. # @param [String] parent # Required. # The location name. # For example: `projects/PROJECT_ID/locations/LOCATION_ID` # @param [String] filter # `filter` can be used to specify a subset of queues. Any Queue # field can be used as a filter and several operators as supported. # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as # described in # [Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters). # Sample filter "app_engine_http_target: *". # Note that using filters might cause fewer queues than the # requested_page size to be returned. # @param [Fixnum] page_size # Requested page size. # The maximum page size is 9800. If unspecified, the page size will # be the maximum. Fewer queues than requested might be returned, # even if more queues exist; use the # next_page_token in the # response to determine if more queues exist. # @param [String] page_token # A token identifying the page of results to return. # To request the first page results, page_token must be empty. To # request the next page of results, page_token must be the value of # next_page_token returned # from the previous call to ListQueues # method. It is an error to switch the value of the # filter while iterating through pages. # @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::CloudtasksV2beta2::ListQueuesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::ListQueuesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_queues(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+parent}/queues', options) command.response_representation = Google::Apis::CloudtasksV2beta2::ListQueuesResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta2::ListQueuesResponse 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 queue. # This method creates the queue if it does not exist and updates # the queue if it does exist. # Queues created with this method allow tasks to live for a maximum of 31 # days. After a task is 31 days old, the task will be deleted regardless of # whether # it was dispatched or not. # WARNING: Using this method may have unintended side effects if you are # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. # Read # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) # before using this method. # @param [String] name # The queue name. # The queue name must have the following format: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), # hyphens (-), colons (:), or periods (.). # For more information, see # [Identifying projects](/resource-manager/docs/creating-managing-projects# # identifying_projects) # * `LOCATION_ID` is the canonical ID for the queue's location. # The list of available locations can be obtained by calling # ListLocations. # For more information, see https://cloud.google.com/about/locations/. # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or # hyphens (-). The maximum length is 100 characters. # Caller-specified and required in CreateQueue, # after which it becomes output only. # @param [Google::Apis::CloudtasksV2beta2::Queue] queue_object # @param [String] update_mask # A mask used to specify which fields of the queue are being updated. # If empty, then all fields will 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::CloudtasksV2beta2::Queue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Queue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_queue(name, queue_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta2/{+name}', options) command.request_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.request_object = queue_object command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue 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 # Pauses the queue. # If a queue is paused then the system will stop dispatching tasks # until the queue is resumed via # ResumeQueue. Tasks can still be added # when the queue is paused. A queue is paused if its # state is PAUSED. # @param [String] name # Required. # The queue name. For example: # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` # @param [Google::Apis::CloudtasksV2beta2::PauseQueueRequest] pause_queue_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::CloudtasksV2beta2::Queue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Queue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def pause_queue(name, pause_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:pause', options) command.request_representation = Google::Apis::CloudtasksV2beta2::PauseQueueRequest::Representation command.request_object = pause_queue_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue 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 # Purges a queue by deleting all of its tasks. # All tasks created before this method is called are permanently deleted. # Purge operations can take up to one minute to take effect. Tasks # might be dispatched before the purge takes effect. A purge is irreversible. # @param [String] name # Required. # The queue name. For example: # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` # @param [Google::Apis::CloudtasksV2beta2::PurgeQueueRequest] purge_queue_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::CloudtasksV2beta2::Queue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Queue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def purge_queue(name, purge_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:purge', options) command.request_representation = Google::Apis::CloudtasksV2beta2::PurgeQueueRequest::Representation command.request_object = purge_queue_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue 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 # Resume a queue. # This method resumes a queue after it has been # PAUSED or # DISABLED. The state of a queue is stored # in the queue's state; after calling this method it # will be set to RUNNING. # WARNING: Resuming many high-QPS queues at the same time can # lead to target overloading. If you are resuming high-QPS # queues, follow the 500/50/5 pattern described in # [Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks- # scaling-risks-2017-06-05.pdf). # @param [String] name # Required. # The queue name. For example: # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` # @param [Google::Apis::CloudtasksV2beta2::ResumeQueueRequest] resume_queue_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::CloudtasksV2beta2::Queue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Queue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def resume_queue(name, resume_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:resume', options) command.request_representation = Google::Apis::CloudtasksV2beta2::ResumeQueueRequest::Representation command.request_object = resume_queue_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue 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 # Sets the access control policy for a Queue. Replaces any existing # policy. # Note: The Cloud Console does not check queue-level IAM permissions yet. # Project-level permissions are required to use the Cloud Console. # Authorization requires the following [Google IAM](/iam) permission on the # specified resource parent: # * `cloudtasks.queues.setIamPolicy` # @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::CloudtasksV2beta2::SetIamPolicyRequest] 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::CloudtasksV2beta2::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::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_queue_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+resource}:setIamPolicy', options) command.request_representation = Google::Apis::CloudtasksV2beta2::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Policy::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Policy 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 # Returns permissions that a caller has on a Queue. # If the resource does not exist, this will return an empty set of # 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. # @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::CloudtasksV2beta2::TestIamPermissionsRequest] 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::CloudtasksV2beta2::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_queue_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+resource}:testIamPermissions', options) command.request_representation = Google::Apis::CloudtasksV2beta2::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse 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 # Acknowledges a pull task. # The worker, that is, the entity that # leased this task must call this method # to indicate that the work associated with the task has finished. # The worker must acknowledge a task within the # lease_duration or the lease # will expire and the task will become available to be leased # again. After the task is acknowledged, it will not be returned # by a later LeaseTasks, # GetTask, or # ListTasks. # To acknowledge multiple tasks at the same time, use # [HTTP batching](/storage/docs/json_api/v1/how-tos/batch) # or the batching documentation for your client library, for example # https://developers.google.com/api-client-library/python/guide/batch. # @param [String] name # Required. # The task name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # @param [Google::Apis::CloudtasksV2beta2::AcknowledgeTaskRequest] acknowledge_task_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::CloudtasksV2beta2::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::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 acknowledge_task(name, acknowledge_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:acknowledge', options) command.request_representation = Google::Apis::CloudtasksV2beta2::AcknowledgeTaskRequest::Representation command.request_object = acknowledge_task_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation command.response_class = Google::Apis::CloudtasksV2beta2::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 # Cancel a pull task's lease. # The worker can use this method to cancel a task's lease by # setting its schedule_time to now. This will # make the task available to be leased to the next caller of # LeaseTasks. # @param [String] name # Required. # The task name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # @param [Google::Apis::CloudtasksV2beta2::CancelLeaseRequest] cancel_lease_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::CloudtasksV2beta2::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_task_lease(name, cancel_lease_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:cancelLease', options) command.request_representation = Google::Apis::CloudtasksV2beta2::CancelLeaseRequest::Representation command.request_object = cancel_lease_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Task 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 task and adds it to a queue. # To add multiple tasks at the same time, use # [HTTP batching](/storage/docs/json_api/v1/how-tos/batch) # or the batching documentation for your client library, for example # https://developers.google.com/api-client-library/python/guide/batch. # Tasks cannot be updated after creation; there is no UpdateTask command. # * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget), # the maximum task size is 100KB. # * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this # the maximum task size is 1MB. # @param [String] parent # Required. # The queue name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` # The queue must already exist. # @param [Google::Apis::CloudtasksV2beta2::CreateTaskRequest] create_task_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::CloudtasksV2beta2::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_task(parent, create_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/tasks', options) command.request_representation = Google::Apis::CloudtasksV2beta2::CreateTaskRequest::Representation command.request_object = create_task_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Task 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 task. # A task can be deleted if it is scheduled or dispatched. A task # cannot be deleted if it has completed successfully or permanently # failed. # @param [String] name # Required. # The task name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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::CloudtasksV2beta2::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::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_location_queue_task(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation command.response_class = Google::Apis::CloudtasksV2beta2::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 task. # @param [String] name # Required. # The task name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # @param [String] response_view # The response_view specifies which subset of the Task will be # returned. # By default response_view is BASIC; not all # information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # Authorization for FULL requires # `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the # Task 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::CloudtasksV2beta2::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_queue_task(name, response_view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Task command.params['name'] = name unless name.nil? command.query['responseView'] = response_view unless response_view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Leases tasks from a pull queue for # lease_duration. # This method is invoked by the worker to obtain a lease. The # worker must acknowledge the task via # AcknowledgeTask after they have # performed the work associated with the task. # The payload is intended to store data that # the worker needs to perform the work associated with the task. To # return the payloads in the response, set # response_view to # FULL. # A maximum of 10 qps of LeaseTasks # requests are allowed per # queue. RESOURCE_EXHAUSTED # is returned when this limit is # exceeded. RESOURCE_EXHAUSTED # is also returned when # max_tasks_dispatched_per_second # is exceeded. # @param [String] parent # Required. # The queue name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` # @param [Google::Apis::CloudtasksV2beta2::LeaseTasksRequest] lease_tasks_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::CloudtasksV2beta2::LeaseTasksResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::LeaseTasksResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def lease_tasks(parent, lease_tasks_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/tasks:lease', options) command.request_representation = Google::Apis::CloudtasksV2beta2::LeaseTasksRequest::Representation command.request_object = lease_tasks_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::LeaseTasksResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta2::LeaseTasksResponse 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 # Lists the tasks in a queue. # By default, only the BASIC view is retrieved # due to performance considerations; # response_view controls the # subset of information which is returned. # @param [String] parent # Required. # The queue name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` # @param [String] order_by # Sort order used for the query. The only fields supported for sorting # are `schedule_time` and `pull_message.tag`. All results will be # returned in approximately ascending order. The default ordering is by # `schedule_time`. # @param [Fixnum] page_size # Requested page size. Fewer tasks than requested might be returned. # The maximum page size is 1000. If unspecified, the page size will # be the maximum. Fewer tasks than requested might be returned, # even if more tasks exist; use # next_page_token in the # response to determine if more tasks exist. # @param [String] page_token # A token identifying the page of results to return. # To request the first page results, page_token must be empty. To # request the next page of results, page_token must be the value of # next_page_token returned # from the previous call to ListTasks # method. # The page token is valid for only 2 hours. # @param [String] response_view # The response_view specifies which subset of the Task will be # returned. # By default response_view is BASIC; not all # information is retrieved by default because some data, such as # payloads, might be desirable to return only when needed because # of its large size or because of the sensitivity of data that it # contains. # Authorization for FULL requires # `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the # Task 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::CloudtasksV2beta2::ListTasksResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::ListTasksResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_queue_tasks(parent, order_by: nil, page_size: nil, page_token: nil, response_view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+parent}/tasks', options) command.response_representation = Google::Apis::CloudtasksV2beta2::ListTasksResponse::Representation command.response_class = Google::Apis::CloudtasksV2beta2::ListTasksResponse command.params['parent'] = parent unless parent.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['responseView'] = response_view unless response_view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Renew the current lease of a pull task. # The worker can use this method to extend the lease by a new # duration, starting from now. The new task lease will be # returned in the task's schedule_time. # @param [String] name # Required. # The task name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # @param [Google::Apis::CloudtasksV2beta2::RenewLeaseRequest] renew_lease_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::CloudtasksV2beta2::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def renew_task_lease(name, renew_lease_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:renewLease', options) command.request_representation = Google::Apis::CloudtasksV2beta2::RenewLeaseRequest::Representation command.request_object = renew_lease_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Task 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 # Forces a task to run now. # This command is meant to be used for manual debugging. For # example, RunTask can be used to retry a failed # task after a fix has been made or to manually force a task to be # dispatched now. # When this method is called, Cloud Tasks will dispatch the task to its # target, even if the queue is PAUSED. # The dispatched task is returned. That is, the task that is returned # contains the status after the task is dispatched but # before the task is received by its target. # If Cloud Tasks receives a successful response from the task's # handler, then the task will be deleted; otherwise the task's # schedule_time will be reset to the time that # RunTask was called plus the retry delay specified # in the queue and task's RetryConfig. # RunTask returns # NOT_FOUND when it is called on a # task that has already succeeded or permanently # failed. FAILED_PRECONDITION # is returned when RunTask is called on task # that is dispatched or already running. # RunTask cannot be called on # pull tasks. # @param [String] name # Required. # The task name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # @param [Google::Apis::CloudtasksV2beta2::RunTaskRequest] run_task_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::CloudtasksV2beta2::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudtasksV2beta2::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def run_task(name, run_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:run', options) command.request_representation = Google::Apis::CloudtasksV2beta2::RunTaskRequest::Representation command.request_object = run_task_request_object command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Task 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 google-api-client-0.19.8/generated/google/apis/youtube_partner_v1/0000755000004100000410000000000013252673044025151 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/youtube_partner_v1/representations.rb0000644000004100000410000020365213252673044030733 0ustar www-datawww-data# 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 YoutubePartnerV1 class AdBreak class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdSlot class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AllowedAdvertisingOptions 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 AssetLabel class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AssetLabelListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AssetListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AssetMatchPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AssetRelationship class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AssetRelationshipListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AssetSearchResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AssetShare class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AssetShareListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AssetSnippet 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 CampaignData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CampaignList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CampaignSource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CampaignTargetLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Claim class Representation < Google::Apis::Core::JsonRepresentation; end class MatchInfo class Representation < Google::Apis::Core::JsonRepresentation; end class LongestMatch class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TotalMatch class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Origin class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ClaimEvent class Representation < Google::Apis::Core::JsonRepresentation; end class Source class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ClaimHistory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClaimListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClaimSearchResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClaimSnippet class Representation < Google::Apis::Core::JsonRepresentation; end class Origin class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ClaimedVideoDefaults class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Conditions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConflictingOwnership class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContentOwner class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContentOwnerAdvertisingOption class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContentOwnerListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CountriesRestriction class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CuepointSettings 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 ExcludedInterval class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IntervalCondition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveCuepoint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MatchSegment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Metadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetadataHistory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetadataHistoryListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Order class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Origination class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OwnershipConflicts class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OwnershipHistoryListResponse 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 PackageInsertResponse 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 Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PolicyList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PolicyRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PromotedContent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Publisher class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PublisherList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Rating class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Reference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReferenceConflict class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReferenceConflictListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReferenceConflictMatch class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReferenceListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Requirements class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RightsOwnership class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RightsOwnershipHistory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Segment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShowDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SpreadsheetTemplate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SpreadsheetTemplateListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StateCompleted class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StatusReport class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TerritoryCondition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TerritoryConflicts class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TerritoryOwners class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Uploader class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UploaderListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ValidateAsyncRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ValidateAsyncResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ValidateError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ValidateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ValidateResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ValidateStatusRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ValidateStatusResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoAdvertisingOption class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoAdvertisingOptionGetEnabledAdsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Whitelist class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WhitelistListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdBreak # @private class Representation < Google::Apis::Core::JsonRepresentation property :midroll_seconds, as: 'midrollSeconds' property :position, as: 'position' collection :slot, as: 'slot', class: Google::Apis::YoutubePartnerV1::AdSlot, decorator: Google::Apis::YoutubePartnerV1::AdSlot::Representation end end class AdSlot # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :type, as: 'type' end end class AllowedAdvertisingOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :ads_on_embeds, as: 'adsOnEmbeds' property :kind, as: 'kind' collection :lic_ad_formats, as: 'licAdFormats' collection :ugc_ad_formats, as: 'ugcAdFormats' end end class Asset # @private class Representation < Google::Apis::Core::JsonRepresentation collection :alias_id, as: 'aliasId' property :id, as: 'id' property :kind, as: 'kind' collection :label, as: 'label' property :match_policy, as: 'matchPolicy', class: Google::Apis::YoutubePartnerV1::AssetMatchPolicy, decorator: Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation property :match_policy_effective, as: 'matchPolicyEffective', class: Google::Apis::YoutubePartnerV1::AssetMatchPolicy, decorator: Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation property :match_policy_mine, as: 'matchPolicyMine', class: Google::Apis::YoutubePartnerV1::AssetMatchPolicy, decorator: Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation property :metadata, as: 'metadata', class: Google::Apis::YoutubePartnerV1::Metadata, decorator: Google::Apis::YoutubePartnerV1::Metadata::Representation property :metadata_effective, as: 'metadataEffective', class: Google::Apis::YoutubePartnerV1::Metadata, decorator: Google::Apis::YoutubePartnerV1::Metadata::Representation property :metadata_mine, as: 'metadataMine', class: Google::Apis::YoutubePartnerV1::Metadata, decorator: Google::Apis::YoutubePartnerV1::Metadata::Representation property :ownership, as: 'ownership', class: Google::Apis::YoutubePartnerV1::RightsOwnership, decorator: Google::Apis::YoutubePartnerV1::RightsOwnership::Representation property :ownership_conflicts, as: 'ownershipConflicts', class: Google::Apis::YoutubePartnerV1::OwnershipConflicts, decorator: Google::Apis::YoutubePartnerV1::OwnershipConflicts::Representation property :ownership_effective, as: 'ownershipEffective', class: Google::Apis::YoutubePartnerV1::RightsOwnership, decorator: Google::Apis::YoutubePartnerV1::RightsOwnership::Representation property :ownership_mine, as: 'ownershipMine', class: Google::Apis::YoutubePartnerV1::RightsOwnership, decorator: Google::Apis::YoutubePartnerV1::RightsOwnership::Representation property :status, as: 'status' property :time_created, as: 'timeCreated', type: DateTime property :type, as: 'type' end end class AssetLabel # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :label_name, as: 'labelName' end end class AssetLabelListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::AssetLabel, decorator: Google::Apis::YoutubePartnerV1::AssetLabel::Representation property :kind, as: 'kind' end end class AssetListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::Asset, decorator: Google::Apis::YoutubePartnerV1::Asset::Representation property :kind, as: 'kind' end end class AssetMatchPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :policy_id, as: 'policyId' collection :rules, as: 'rules', class: Google::Apis::YoutubePartnerV1::PolicyRule, decorator: Google::Apis::YoutubePartnerV1::PolicyRule::Representation end end class AssetRelationship # @private class Representation < Google::Apis::Core::JsonRepresentation property :child_asset_id, as: 'childAssetId' property :id, as: 'id' property :kind, as: 'kind' property :parent_asset_id, as: 'parentAssetId' end end class AssetRelationshipListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::AssetRelationship, decorator: Google::Apis::YoutubePartnerV1::AssetRelationship::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation end end class AssetSearchResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::AssetSnippet, decorator: Google::Apis::YoutubePartnerV1::AssetSnippet::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation end end class AssetShare # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :share_id, as: 'shareId' property :view_id, as: 'viewId' end end class AssetShareListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::AssetShare, decorator: Google::Apis::YoutubePartnerV1::AssetShare::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation end end class AssetSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :custom_id, as: 'customId' property :id, as: 'id' property :isrc, as: 'isrc' property :iswc, as: 'iswc' property :kind, as: 'kind' property :time_created, as: 'timeCreated', type: DateTime property :title, as: 'title' property :type, as: 'type' end end class Campaign # @private class Representation < Google::Apis::Core::JsonRepresentation property :campaign_data, as: 'campaignData', class: Google::Apis::YoutubePartnerV1::CampaignData, decorator: Google::Apis::YoutubePartnerV1::CampaignData::Representation property :id, as: 'id' property :kind, as: 'kind' property :status, as: 'status' property :time_created, as: 'timeCreated', type: DateTime property :time_last_modified, as: 'timeLastModified', type: DateTime end end class CampaignData # @private class Representation < Google::Apis::Core::JsonRepresentation property :campaign_source, as: 'campaignSource', class: Google::Apis::YoutubePartnerV1::CampaignSource, decorator: Google::Apis::YoutubePartnerV1::CampaignSource::Representation property :expire_time, as: 'expireTime', type: DateTime property :name, as: 'name' collection :promoted_content, as: 'promotedContent', class: Google::Apis::YoutubePartnerV1::PromotedContent, decorator: Google::Apis::YoutubePartnerV1::PromotedContent::Representation property :start_time, as: 'startTime', type: DateTime end end class CampaignList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::Campaign, decorator: Google::Apis::YoutubePartnerV1::Campaign::Representation property :kind, as: 'kind' end end class CampaignSource # @private class Representation < Google::Apis::Core::JsonRepresentation property :source_type, as: 'sourceType' collection :source_value, as: 'sourceValue' end end class CampaignTargetLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :target_id, as: 'targetId' property :target_type, as: 'targetType' end end class Claim # @private class Representation < Google::Apis::Core::JsonRepresentation property :applied_policy, as: 'appliedPolicy', class: Google::Apis::YoutubePartnerV1::Policy, decorator: Google::Apis::YoutubePartnerV1::Policy::Representation property :asset_id, as: 'assetId' property :block_outside_ownership, as: 'blockOutsideOwnership' property :content_type, as: 'contentType' property :id, as: 'id' property :is_partner_uploaded, as: 'isPartnerUploaded' property :kind, as: 'kind' property :match_info, as: 'matchInfo', class: Google::Apis::YoutubePartnerV1::Claim::MatchInfo, decorator: Google::Apis::YoutubePartnerV1::Claim::MatchInfo::Representation property :origin, as: 'origin', class: Google::Apis::YoutubePartnerV1::Claim::Origin, decorator: Google::Apis::YoutubePartnerV1::Claim::Origin::Representation property :policy, as: 'policy', class: Google::Apis::YoutubePartnerV1::Policy, decorator: Google::Apis::YoutubePartnerV1::Policy::Representation property :status, as: 'status' property :time_created, as: 'timeCreated', type: DateTime property :video_id, as: 'videoId' end class MatchInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :longest_match, as: 'longestMatch', class: Google::Apis::YoutubePartnerV1::Claim::MatchInfo::LongestMatch, decorator: Google::Apis::YoutubePartnerV1::Claim::MatchInfo::LongestMatch::Representation collection :match_segments, as: 'matchSegments', class: Google::Apis::YoutubePartnerV1::MatchSegment, decorator: Google::Apis::YoutubePartnerV1::MatchSegment::Representation property :reference_id, as: 'referenceId' property :total_match, as: 'totalMatch', class: Google::Apis::YoutubePartnerV1::Claim::MatchInfo::TotalMatch, decorator: Google::Apis::YoutubePartnerV1::Claim::MatchInfo::TotalMatch::Representation end class LongestMatch # @private class Representation < Google::Apis::Core::JsonRepresentation property :duration_secs, :numeric_string => true, as: 'durationSecs' property :reference_offset, :numeric_string => true, as: 'referenceOffset' property :user_video_offset, :numeric_string => true, as: 'userVideoOffset' end end class TotalMatch # @private class Representation < Google::Apis::Core::JsonRepresentation property :reference_duration_secs, :numeric_string => true, as: 'referenceDurationSecs' property :user_video_duration_secs, :numeric_string => true, as: 'userVideoDurationSecs' end end end class Origin # @private class Representation < Google::Apis::Core::JsonRepresentation property :source, as: 'source' end end end class ClaimEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :reason, as: 'reason' property :source, as: 'source', class: Google::Apis::YoutubePartnerV1::ClaimEvent::Source, decorator: Google::Apis::YoutubePartnerV1::ClaimEvent::Source::Representation property :time, as: 'time', type: DateTime property :type, as: 'type' property :type_details, as: 'typeDetails', class: Google::Apis::YoutubePartnerV1::ClaimEvent::TypeDetails, decorator: Google::Apis::YoutubePartnerV1::ClaimEvent::TypeDetails::Representation end class Source # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_owner_id, as: 'contentOwnerId' property :type, as: 'type' property :user_email, as: 'userEmail' end end class TypeDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :appeal_explanation, as: 'appealExplanation' property :dispute_notes, as: 'disputeNotes' property :dispute_reason, as: 'disputeReason' property :update_status, as: 'updateStatus' end end end class ClaimHistory # @private class Representation < Google::Apis::Core::JsonRepresentation collection :event, as: 'event', class: Google::Apis::YoutubePartnerV1::ClaimEvent, decorator: Google::Apis::YoutubePartnerV1::ClaimEvent::Representation property :id, as: 'id' property :kind, as: 'kind' property :uploader_channel_id, as: 'uploaderChannelId' end end class ClaimListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::Claim, decorator: Google::Apis::YoutubePartnerV1::Claim::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation property :previous_page_token, as: 'previousPageToken' end end class ClaimSearchResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::ClaimSnippet, decorator: Google::Apis::YoutubePartnerV1::ClaimSnippet::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation property :previous_page_token, as: 'previousPageToken' end end class ClaimSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :asset_id, as: 'assetId' property :content_type, as: 'contentType' property :id, as: 'id' property :is_partner_uploaded, as: 'isPartnerUploaded' property :kind, as: 'kind' property :origin, as: 'origin', class: Google::Apis::YoutubePartnerV1::ClaimSnippet::Origin, decorator: Google::Apis::YoutubePartnerV1::ClaimSnippet::Origin::Representation property :status, as: 'status' property :third_party_claim, as: 'thirdPartyClaim' property :time_created, as: 'timeCreated', type: DateTime property :time_status_last_modified, as: 'timeStatusLastModified', type: DateTime property :video_id, as: 'videoId' property :video_title, as: 'videoTitle' property :video_views, :numeric_string => true, as: 'videoViews' end class Origin # @private class Representation < Google::Apis::Core::JsonRepresentation property :source, as: 'source' end end end class ClaimedVideoDefaults # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_generated_breaks, as: 'autoGeneratedBreaks' property :channel_override, as: 'channelOverride' property :kind, as: 'kind' collection :new_video_defaults, as: 'newVideoDefaults' end end class Conditions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :content_match_type, as: 'contentMatchType' collection :match_duration, as: 'matchDuration', class: Google::Apis::YoutubePartnerV1::IntervalCondition, decorator: Google::Apis::YoutubePartnerV1::IntervalCondition::Representation collection :match_percent, as: 'matchPercent', class: Google::Apis::YoutubePartnerV1::IntervalCondition, decorator: Google::Apis::YoutubePartnerV1::IntervalCondition::Representation collection :reference_duration, as: 'referenceDuration', class: Google::Apis::YoutubePartnerV1::IntervalCondition, decorator: Google::Apis::YoutubePartnerV1::IntervalCondition::Representation collection :reference_percent, as: 'referencePercent', class: Google::Apis::YoutubePartnerV1::IntervalCondition, decorator: Google::Apis::YoutubePartnerV1::IntervalCondition::Representation property :required_territories, as: 'requiredTerritories', class: Google::Apis::YoutubePartnerV1::TerritoryCondition, decorator: Google::Apis::YoutubePartnerV1::TerritoryCondition::Representation end end class ConflictingOwnership # @private class Representation < Google::Apis::Core::JsonRepresentation property :owner, as: 'owner' property :ratio, as: 'ratio' end end class ContentOwner # @private class Representation < Google::Apis::Core::JsonRepresentation property :conflict_notification_email, as: 'conflictNotificationEmail' property :display_name, as: 'displayName' collection :dispute_notification_emails, as: 'disputeNotificationEmails' collection :fingerprint_report_notification_emails, as: 'fingerprintReportNotificationEmails' property :id, as: 'id' property :kind, as: 'kind' collection :primary_notification_emails, as: 'primaryNotificationEmails' end end class ContentOwnerAdvertisingOption # @private class Representation < Google::Apis::Core::JsonRepresentation property :allowed_options, as: 'allowedOptions', class: Google::Apis::YoutubePartnerV1::AllowedAdvertisingOptions, decorator: Google::Apis::YoutubePartnerV1::AllowedAdvertisingOptions::Representation property :claimed_video_options, as: 'claimedVideoOptions', class: Google::Apis::YoutubePartnerV1::ClaimedVideoDefaults, decorator: Google::Apis::YoutubePartnerV1::ClaimedVideoDefaults::Representation property :id, as: 'id' property :kind, as: 'kind' end end class ContentOwnerListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::ContentOwner, decorator: Google::Apis::YoutubePartnerV1::ContentOwner::Representation property :kind, as: 'kind' end end class CountriesRestriction # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ad_formats, as: 'adFormats' collection :territories, as: 'territories' end end class CuepointSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :cue_type, as: 'cueType' property :duration_secs, as: 'durationSecs' property :offset_time_ms, :numeric_string => true, as: 'offsetTimeMs' property :walltime, as: 'walltime', type: DateTime 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, as: 'end', class: Google::Apis::YoutubePartnerV1::Date, decorator: Google::Apis::YoutubePartnerV1::Date::Representation property :kind, as: 'kind' property :start, as: 'start', class: Google::Apis::YoutubePartnerV1::Date, decorator: Google::Apis::YoutubePartnerV1::Date::Representation end end class ExcludedInterval # @private class Representation < Google::Apis::Core::JsonRepresentation property :high, as: 'high' property :low, as: 'low' property :origin, as: 'origin' property :time_created, as: 'timeCreated', type: DateTime end end class IntervalCondition # @private class Representation < Google::Apis::Core::JsonRepresentation property :high, as: 'high' property :low, as: 'low' end end class LiveCuepoint # @private class Representation < Google::Apis::Core::JsonRepresentation property :broadcast_id, as: 'broadcastId' property :id, as: 'id' property :kind, as: 'kind' property :settings, as: 'settings', class: Google::Apis::YoutubePartnerV1::CuepointSettings, decorator: Google::Apis::YoutubePartnerV1::CuepointSettings::Representation end end class MatchSegment # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel, as: 'channel' property :reference_segment, as: 'reference_segment', class: Google::Apis::YoutubePartnerV1::Segment, decorator: Google::Apis::YoutubePartnerV1::Segment::Representation property :video_segment, as: 'video_segment', class: Google::Apis::YoutubePartnerV1::Segment, decorator: Google::Apis::YoutubePartnerV1::Segment::Representation end end class Metadata # @private class Representation < Google::Apis::Core::JsonRepresentation collection :actor, as: 'actor' property :album, as: 'album' collection :artist, as: 'artist' collection :broadcaster, as: 'broadcaster' property :category, as: 'category' property :content_type, as: 'contentType' property :copyright_date, as: 'copyrightDate', class: Google::Apis::YoutubePartnerV1::Date, decorator: Google::Apis::YoutubePartnerV1::Date::Representation property :custom_id, as: 'customId' property :description, as: 'description' collection :director, as: 'director' property :eidr, as: 'eidr' property :end_year, as: 'endYear' property :episode_number, as: 'episodeNumber' property :episodes_are_untitled, as: 'episodesAreUntitled' collection :genre, as: 'genre' property :grid, as: 'grid' property :hfa, as: 'hfa' property :info_url, as: 'infoUrl' property :isan, as: 'isan' property :isrc, as: 'isrc' property :iswc, as: 'iswc' collection :keyword, as: 'keyword' property :label, as: 'label' property :notes, as: 'notes' property :original_release_medium, as: 'originalReleaseMedium' collection :producer, as: 'producer' collection :ratings, as: 'ratings', class: Google::Apis::YoutubePartnerV1::Rating, decorator: Google::Apis::YoutubePartnerV1::Rating::Representation property :release_date, as: 'releaseDate', class: Google::Apis::YoutubePartnerV1::Date, decorator: Google::Apis::YoutubePartnerV1::Date::Representation property :season_number, as: 'seasonNumber' property :show_custom_id, as: 'showCustomId' property :show_title, as: 'showTitle' property :spoken_language, as: 'spokenLanguage' property :start_year, as: 'startYear' collection :subtitled_language, as: 'subtitledLanguage' property :title, as: 'title' property :tms_id, as: 'tmsId' property :total_episodes_expected, as: 'totalEpisodesExpected' property :upc, as: 'upc' collection :writer, as: 'writer' end end class MetadataHistory # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :metadata, as: 'metadata', class: Google::Apis::YoutubePartnerV1::Metadata, decorator: Google::Apis::YoutubePartnerV1::Metadata::Representation property :origination, as: 'origination', class: Google::Apis::YoutubePartnerV1::Origination, decorator: Google::Apis::YoutubePartnerV1::Origination::Representation property :time_provided, as: 'timeProvided', type: DateTime end end class MetadataHistoryListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::MetadataHistory, decorator: Google::Apis::YoutubePartnerV1::MetadataHistory::Representation property :kind, as: 'kind' end end class Order # @private class Representation < Google::Apis::Core::JsonRepresentation property :avail_group_id, as: 'availGroupId' property :channel_id, as: 'channelId' property :content_type, as: 'contentType' property :country, as: 'country' property :custom_id, as: 'customId' property :dvd_release_date, as: 'dvdReleaseDate', class: Google::Apis::YoutubePartnerV1::Date, decorator: Google::Apis::YoutubePartnerV1::Date::Representation property :est_dates, as: 'estDates', class: Google::Apis::YoutubePartnerV1::DateRange, decorator: Google::Apis::YoutubePartnerV1::DateRange::Representation collection :events, as: 'events', class: Google::Apis::YoutubePartnerV1::StateCompleted, decorator: Google::Apis::YoutubePartnerV1::StateCompleted::Representation property :id, as: 'id' property :kind, as: 'kind' property :movie, as: 'movie' property :original_release_date, as: 'originalReleaseDate', class: Google::Apis::YoutubePartnerV1::Date, decorator: Google::Apis::YoutubePartnerV1::Date::Representation property :priority, as: 'priority' property :production_house, as: 'productionHouse' property :purchase_order, as: 'purchaseOrder' property :requirements, as: 'requirements', class: Google::Apis::YoutubePartnerV1::Requirements, decorator: Google::Apis::YoutubePartnerV1::Requirements::Representation property :show, as: 'show', class: Google::Apis::YoutubePartnerV1::ShowDetails, decorator: Google::Apis::YoutubePartnerV1::ShowDetails::Representation property :status, as: 'status' property :video_id, as: 'videoId' property :vod_dates, as: 'vodDates', class: Google::Apis::YoutubePartnerV1::DateRange, decorator: Google::Apis::YoutubePartnerV1::DateRange::Representation end end class OrderListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::Order, decorator: Google::Apis::YoutubePartnerV1::Order::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation property :previous_page_token, as: 'previousPageToken' end end class Origination # @private class Representation < Google::Apis::Core::JsonRepresentation property :owner, as: 'owner' property :source, as: 'source' end end class OwnershipConflicts # @private class Representation < Google::Apis::Core::JsonRepresentation collection :general, as: 'general', class: Google::Apis::YoutubePartnerV1::TerritoryConflicts, decorator: Google::Apis::YoutubePartnerV1::TerritoryConflicts::Representation property :kind, as: 'kind' collection :mechanical, as: 'mechanical', class: Google::Apis::YoutubePartnerV1::TerritoryConflicts, decorator: Google::Apis::YoutubePartnerV1::TerritoryConflicts::Representation collection :performance, as: 'performance', class: Google::Apis::YoutubePartnerV1::TerritoryConflicts, decorator: Google::Apis::YoutubePartnerV1::TerritoryConflicts::Representation collection :synchronization, as: 'synchronization', class: Google::Apis::YoutubePartnerV1::TerritoryConflicts, decorator: Google::Apis::YoutubePartnerV1::TerritoryConflicts::Representation end end class OwnershipHistoryListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::RightsOwnershipHistory, decorator: Google::Apis::YoutubePartnerV1::RightsOwnershipHistory::Representation property :kind, as: 'kind' end end class Package # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' collection :custom_ids, as: 'customIds' property :id, as: 'id' property :kind, as: 'kind' property :locale, as: 'locale' property :name, as: 'name' property :status, as: 'status' collection :status_reports, as: 'statusReports', class: Google::Apis::YoutubePartnerV1::StatusReport, decorator: Google::Apis::YoutubePartnerV1::StatusReport::Representation property :time_created, as: 'timeCreated', type: DateTime property :type, as: 'type' property :uploader_name, as: 'uploaderName' end end class PackageInsertResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::YoutubePartnerV1::ValidateError, decorator: Google::Apis::YoutubePartnerV1::ValidateError::Representation property :kind, as: 'kind' property :resource, as: 'resource', class: Google::Apis::YoutubePartnerV1::Package, decorator: Google::Apis::YoutubePartnerV1::Package::Representation property :status, as: 'status' end end class PageInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :results_per_page, as: 'resultsPerPage' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' collection :rules, as: 'rules', class: Google::Apis::YoutubePartnerV1::PolicyRule, decorator: Google::Apis::YoutubePartnerV1::PolicyRule::Representation property :time_updated, as: 'timeUpdated', type: DateTime end end class PolicyList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::Policy, decorator: Google::Apis::YoutubePartnerV1::Policy::Representation property :kind, as: 'kind' end end class PolicyRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' property :conditions, as: 'conditions', class: Google::Apis::YoutubePartnerV1::Conditions, decorator: Google::Apis::YoutubePartnerV1::Conditions::Representation collection :subaction, as: 'subaction' end end class PromotedContent # @private class Representation < Google::Apis::Core::JsonRepresentation collection :link, as: 'link', class: Google::Apis::YoutubePartnerV1::CampaignTargetLink, decorator: Google::Apis::YoutubePartnerV1::CampaignTargetLink::Representation end end class Publisher # @private class Representation < Google::Apis::Core::JsonRepresentation property :cae_number, as: 'caeNumber' property :id, as: 'id' property :ipi_number, as: 'ipiNumber' property :kind, as: 'kind' property :name, as: 'name' end end class PublisherList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::Publisher, decorator: Google::Apis::YoutubePartnerV1::Publisher::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation end end class Rating # @private class Representation < Google::Apis::Core::JsonRepresentation property :rating, as: 'rating' property :rating_system, as: 'ratingSystem' end end class Reference # @private class Representation < Google::Apis::Core::JsonRepresentation property :asset_id, as: 'assetId' property :audioswap_enabled, as: 'audioswapEnabled' property :claim_id, as: 'claimId' property :content_type, as: 'contentType' property :duplicate_leader, as: 'duplicateLeader' collection :excluded_intervals, as: 'excludedIntervals', class: Google::Apis::YoutubePartnerV1::ExcludedInterval, decorator: Google::Apis::YoutubePartnerV1::ExcludedInterval::Representation property :fp_direct, as: 'fpDirect' property :hash_code, as: 'hashCode' property :id, as: 'id' property :ignore_fp_match, as: 'ignoreFpMatch' property :kind, as: 'kind' property :length, as: 'length' property :origination, as: 'origination', class: Google::Apis::YoutubePartnerV1::Origination, decorator: Google::Apis::YoutubePartnerV1::Origination::Representation property :status, as: 'status' property :status_reason, as: 'statusReason' property :urgent, as: 'urgent' property :video_id, as: 'videoId' end end class ReferenceConflict # @private class Representation < Google::Apis::Core::JsonRepresentation property :conflicting_reference_id, as: 'conflictingReferenceId' property :expiry_time, as: 'expiryTime', type: DateTime property :id, as: 'id' property :kind, as: 'kind' collection :matches, as: 'matches', class: Google::Apis::YoutubePartnerV1::ReferenceConflictMatch, decorator: Google::Apis::YoutubePartnerV1::ReferenceConflictMatch::Representation property :original_reference_id, as: 'originalReferenceId' property :status, as: 'status' end end class ReferenceConflictListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::ReferenceConflict, decorator: Google::Apis::YoutubePartnerV1::ReferenceConflict::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation end end class ReferenceConflictMatch # @private class Representation < Google::Apis::Core::JsonRepresentation property :conflicting_reference_offset_ms, :numeric_string => true, as: 'conflicting_reference_offset_ms' property :length_ms, :numeric_string => true, as: 'length_ms' property :original_reference_offset_ms, :numeric_string => true, as: 'original_reference_offset_ms' property :type, as: 'type' end end class ReferenceListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::Reference, decorator: Google::Apis::YoutubePartnerV1::Reference::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation end end class Requirements # @private class Representation < Google::Apis::Core::JsonRepresentation property :caption, as: 'caption' property :hd_transcode, as: 'hdTranscode' property :poster_art, as: 'posterArt' property :spotlight_art, as: 'spotlightArt' property :spotlight_review, as: 'spotlightReview' property :trailer, as: 'trailer' end end class RightsOwnership # @private class Representation < Google::Apis::Core::JsonRepresentation collection :general, as: 'general', class: Google::Apis::YoutubePartnerV1::TerritoryOwners, decorator: Google::Apis::YoutubePartnerV1::TerritoryOwners::Representation property :kind, as: 'kind' collection :mechanical, as: 'mechanical', class: Google::Apis::YoutubePartnerV1::TerritoryOwners, decorator: Google::Apis::YoutubePartnerV1::TerritoryOwners::Representation collection :performance, as: 'performance', class: Google::Apis::YoutubePartnerV1::TerritoryOwners, decorator: Google::Apis::YoutubePartnerV1::TerritoryOwners::Representation collection :synchronization, as: 'synchronization', class: Google::Apis::YoutubePartnerV1::TerritoryOwners, decorator: Google::Apis::YoutubePartnerV1::TerritoryOwners::Representation end end class RightsOwnershipHistory # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :origination, as: 'origination', class: Google::Apis::YoutubePartnerV1::Origination, decorator: Google::Apis::YoutubePartnerV1::Origination::Representation property :ownership, as: 'ownership', class: Google::Apis::YoutubePartnerV1::RightsOwnership, decorator: Google::Apis::YoutubePartnerV1::RightsOwnership::Representation property :time_provided, as: 'timeProvided', type: DateTime end end class Segment # @private class Representation < Google::Apis::Core::JsonRepresentation property :duration, :numeric_string => true, as: 'duration' property :kind, as: 'kind' property :start, :numeric_string => true, as: 'start' end end class ShowDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :episode_number, as: 'episodeNumber' property :episode_title, as: 'episodeTitle' property :season_number, as: 'seasonNumber' property :title, as: 'title' end end class SpreadsheetTemplate # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :status, as: 'status' property :template_content, as: 'templateContent' property :template_name, as: 'templateName' property :template_type, as: 'templateType' end end class SpreadsheetTemplateListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::SpreadsheetTemplate, decorator: Google::Apis::YoutubePartnerV1::SpreadsheetTemplate::Representation property :kind, as: 'kind' property :status, as: 'status' end end class StateCompleted # @private class Representation < Google::Apis::Core::JsonRepresentation property :state, as: 'state' property :time_completed, :numeric_string => true, as: 'timeCompleted' end end class StatusReport # @private class Representation < Google::Apis::Core::JsonRepresentation property :status_content, as: 'statusContent' property :status_file_name, as: 'statusFileName' end end class TerritoryCondition # @private class Representation < Google::Apis::Core::JsonRepresentation collection :territories, as: 'territories' property :type, as: 'type' end end class TerritoryConflicts # @private class Representation < Google::Apis::Core::JsonRepresentation collection :conflicting_ownership, as: 'conflictingOwnership', class: Google::Apis::YoutubePartnerV1::ConflictingOwnership, decorator: Google::Apis::YoutubePartnerV1::ConflictingOwnership::Representation property :territory, as: 'territory' end end class TerritoryOwners # @private class Representation < Google::Apis::Core::JsonRepresentation property :owner, as: 'owner' property :publisher, as: 'publisher' property :ratio, as: 'ratio' collection :territories, as: 'territories' property :type, as: 'type' end end class Uploader # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :uploader_name, as: 'uploaderName' end end class UploaderListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::Uploader, decorator: Google::Apis::YoutubePartnerV1::Uploader::Representation property :kind, as: 'kind' end end class ValidateAsyncRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :kind, as: 'kind' property :uploader_name, as: 'uploaderName' end end class ValidateAsyncResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :status, as: 'status' property :validation_id, as: 'validationId' end end class ValidateError # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_name, as: 'columnName' property :column_number, as: 'columnNumber' property :line_number, as: 'lineNumber' property :message, as: 'message' property :message_code, as: 'messageCode' property :severity, as: 'severity' end end class ValidateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :kind, as: 'kind' property :locale, as: 'locale' property :uploader_name, as: 'uploaderName' end end class ValidateResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::YoutubePartnerV1::ValidateError, decorator: Google::Apis::YoutubePartnerV1::ValidateError::Representation property :kind, as: 'kind' property :status, as: 'status' end end class ValidateStatusRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :locale, as: 'locale' property :validation_id, as: 'validationId' end end class ValidateStatusResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::YoutubePartnerV1::ValidateError, decorator: Google::Apis::YoutubePartnerV1::ValidateError::Representation property :is_metadata_only, as: 'isMetadataOnly' property :kind, as: 'kind' property :status, as: 'status' end end class VideoAdvertisingOption # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ad_breaks, as: 'adBreaks', class: Google::Apis::YoutubePartnerV1::AdBreak, decorator: Google::Apis::YoutubePartnerV1::AdBreak::Representation collection :ad_formats, as: 'adFormats' property :auto_generated_breaks, as: 'autoGeneratedBreaks' collection :break_position, as: 'breakPosition' property :id, as: 'id' property :kind, as: 'kind' property :tp_ad_server_video_id, as: 'tpAdServerVideoId' property :tp_targeting_url, as: 'tpTargetingUrl' property :tp_url_parameters, as: 'tpUrlParameters' end end class VideoAdvertisingOptionGetEnabledAdsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ad_breaks, as: 'adBreaks', class: Google::Apis::YoutubePartnerV1::AdBreak, decorator: Google::Apis::YoutubePartnerV1::AdBreak::Representation property :ads_on_embeds, as: 'adsOnEmbeds' collection :countries_restriction, as: 'countriesRestriction', class: Google::Apis::YoutubePartnerV1::CountriesRestriction, decorator: Google::Apis::YoutubePartnerV1::CountriesRestriction::Representation property :id, as: 'id' property :kind, as: 'kind' end end class Whitelist # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :title, as: 'title' end end class WhitelistListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::Whitelist, decorator: Google::Apis::YoutubePartnerV1::Whitelist::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation end end end end end google-api-client-0.19.8/generated/google/apis/youtube_partner_v1/classes.rb0000644000004100000410000050531413252673044027143 0ustar www-datawww-data# 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 YoutubePartnerV1 # class AdBreak include Google::Apis::Core::Hashable # The time of the ad break specified as the number of seconds after the start of # the video when the break occurs. # Corresponds to the JSON property `midrollSeconds` # @return [Fixnum] attr_accessor :midroll_seconds # The point at which the break occurs during the video playback. # Corresponds to the JSON property `position` # @return [String] attr_accessor :position # A list of ad slots that occur in an ad break. Ad slots let you specify the # number of ads that should run in each break. # Corresponds to the JSON property `slot` # @return [Array] attr_accessor :slot def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @midroll_seconds = args[:midroll_seconds] if args.key?(:midroll_seconds) @position = args[:position] if args.key?(:position) @slot = args[:slot] if args.key?(:slot) end end # class AdSlot include Google::Apis::Core::Hashable # A value that identifies the ad slot to the ad server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of ad that runs in the slot. The value may affect YouTube's fallback # behavior if the third-party platform does not return ads. # 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) @id = args[:id] if args.key?(:id) @type = args[:type] if args.key?(:type) end end # class AllowedAdvertisingOptions include Google::Apis::Core::Hashable # This setting indicates whether the partner can display ads when videos run in # an embedded player. # Corresponds to the JSON property `adsOnEmbeds` # @return [Boolean] attr_accessor :ads_on_embeds alias_method :ads_on_embeds?, :ads_on_embeds # This property identifies the resource type. Its value is youtubePartner# # allowedAdvertisingOptions. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A list of ad formats that the partner is allowed to use for its uploaded # videos. # Corresponds to the JSON property `licAdFormats` # @return [Array] attr_accessor :lic_ad_formats # A list of ad formats that the partner is allowed to use for claimed, user- # uploaded content. # Corresponds to the JSON property `ugcAdFormats` # @return [Array] attr_accessor :ugc_ad_formats def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ads_on_embeds = args[:ads_on_embeds] if args.key?(:ads_on_embeds) @kind = args[:kind] if args.key?(:kind) @lic_ad_formats = args[:lic_ad_formats] if args.key?(:lic_ad_formats) @ugc_ad_formats = args[:ugc_ad_formats] if args.key?(:ugc_ad_formats) end end # class Asset include Google::Apis::Core::Hashable # A list of asset IDs that can be used to refer to the asset. The list contains # values if the asset represents multiple constituent assets that have been # merged. In that case, any of the asset IDs originally assigned to the # constituent assets could be used to update the master, or synthesized, asset. # Corresponds to the JSON property `aliasId` # @return [Array] attr_accessor :alias_id # An ID that YouTube assigns and uses to uniquely identify the asset. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For asset resources, the value is youtubePartner# # asset. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A list of asset labels on the asset. # Corresponds to the JSON property `label` # @return [Array] attr_accessor :label # The matchPolicy object contains information about the asset's match policy, # which YouTube applies to user-uploaded videos that match the asset. # Corresponds to the JSON property `matchPolicy` # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] attr_accessor :match_policy # # Corresponds to the JSON property `matchPolicyEffective` # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] attr_accessor :match_policy_effective # # Corresponds to the JSON property `matchPolicyMine` # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] attr_accessor :match_policy_mine # The metadata object contains information that identifies and describes the # asset. This information could be used to search for the asset or to eliminate # duplication within YouTube's database. # Corresponds to the JSON property `metadata` # @return [Google::Apis::YoutubePartnerV1::Metadata] attr_accessor :metadata # # Corresponds to the JSON property `metadataEffective` # @return [Google::Apis::YoutubePartnerV1::Metadata] attr_accessor :metadata_effective # # Corresponds to the JSON property `metadataMine` # @return [Google::Apis::YoutubePartnerV1::Metadata] attr_accessor :metadata_mine # The ownership object identifies an asset's owners and provides additional # details about their ownership, such as the territories where they own the # asset. # Corresponds to the JSON property `ownership` # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] attr_accessor :ownership # The ownershipConflicts object contains information about the asset's ownership # conflicts. # Corresponds to the JSON property `ownershipConflicts` # @return [Google::Apis::YoutubePartnerV1::OwnershipConflicts] attr_accessor :ownership_conflicts # # Corresponds to the JSON property `ownershipEffective` # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] attr_accessor :ownership_effective # # Corresponds to the JSON property `ownershipMine` # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] attr_accessor :ownership_mine # The asset's status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The date and time the asset was created. The value is specified in RFC 3339 ( # YYYY-MM-DDThh:mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` # @return [DateTime] attr_accessor :time_created # The asset's type. This value determines the metadata fields that you can set # for the asset. In addition, certain API functions may only be supported for # specific types of assets. For example, composition assets may have more # complex ownership data than other types of assets. # 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_id = args[:alias_id] if args.key?(:alias_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @label = args[:label] if args.key?(:label) @match_policy = args[:match_policy] if args.key?(:match_policy) @match_policy_effective = args[:match_policy_effective] if args.key?(:match_policy_effective) @match_policy_mine = args[:match_policy_mine] if args.key?(:match_policy_mine) @metadata = args[:metadata] if args.key?(:metadata) @metadata_effective = args[:metadata_effective] if args.key?(:metadata_effective) @metadata_mine = args[:metadata_mine] if args.key?(:metadata_mine) @ownership = args[:ownership] if args.key?(:ownership) @ownership_conflicts = args[:ownership_conflicts] if args.key?(:ownership_conflicts) @ownership_effective = args[:ownership_effective] if args.key?(:ownership_effective) @ownership_mine = args[:ownership_mine] if args.key?(:ownership_mine) @status = args[:status] if args.key?(:status) @time_created = args[:time_created] if args.key?(:time_created) @type = args[:type] if args.key?(:type) end end # class AssetLabel include Google::Apis::Core::Hashable # The type of the API resource. For assetLabel resources, this value is # youtubePartner#assetLabel. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of the asset label. # Corresponds to the JSON property `labelName` # @return [String] attr_accessor :label_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @label_name = args[:label_name] if args.key?(:label_name) end end # class AssetLabelListResponse include Google::Apis::Core::Hashable # A list of assetLabel resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # assetLabelList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class AssetListResponse include Google::Apis::Core::Hashable # A list of asset resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # assetList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class AssetMatchPolicy include Google::Apis::Core::Hashable # The type of the API resource. Value: youtubePartner#assetMatchPolicy. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A value that uniquely identifies the Policy resource that YouTube applies to # user-uploaded videos that match the asset. # Corresponds to the JSON property `policyId` # @return [String] attr_accessor :policy_id # A list of rules that collectively define the policy that the content owner # wants to apply to user-uploaded videos that match the asset. Each rule # specifies the action that YouTube should take and may optionally specify the # conditions under which that action is enforced. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @policy_id = args[:policy_id] if args.key?(:policy_id) @rules = args[:rules] if args.key?(:rules) end end # class AssetRelationship include Google::Apis::Core::Hashable # The ID of the child (contained) asset. # Corresponds to the JSON property `childAssetId` # @return [String] attr_accessor :child_asset_id # A value that YouTube assigns and uses to uniquely identify the asset # relationship. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For this resource, the value is youtubePartner# # assetRelationship. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The ID of the parent (containing) asset. # Corresponds to the JSON property `parentAssetId` # @return [String] attr_accessor :parent_asset_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @child_asset_id = args[:child_asset_id] if args.key?(:child_asset_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @parent_asset_id = args[:parent_asset_id] if args.key?(:parent_asset_id) end end # class AssetRelationshipListResponse include Google::Apis::Core::Hashable # A list of assetRelationship resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # assetRelationshipList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @page_info = args[:page_info] if args.key?(:page_info) end end # class AssetSearchResponse include Google::Apis::Core::Hashable # A list of asset resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # assetSnippetList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @page_info = args[:page_info] if args.key?(:page_info) end end # class AssetShare include Google::Apis::Core::Hashable # The type of the API resource. For this resource, the value is youtubePartner# # assetShare. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A value that YouTube assigns and uses to uniquely identify the asset share. # Corresponds to the JSON property `shareId` # @return [String] attr_accessor :share_id # A value that YouTube assigns and uses to uniquely identify the asset view. # Corresponds to the JSON property `viewId` # @return [String] attr_accessor :view_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @share_id = args[:share_id] if args.key?(:share_id) @view_id = args[:view_id] if args.key?(:view_id) end end # class AssetShareListResponse include Google::Apis::Core::Hashable # An assetShare resource that matches the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # assetShareList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @page_info = args[:page_info] if args.key?(:page_info) end end # class AssetSnippet include Google::Apis::Core::Hashable # Custom ID assigned by the content owner to this asset. # Corresponds to the JSON property `customId` # @return [String] attr_accessor :custom_id # An ID that YouTube assigns and uses to uniquely identify the asset. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The ISRC (International Standard Recording Code) for this asset. # Corresponds to the JSON property `isrc` # @return [String] attr_accessor :isrc # The ISWC (International Standard Musical Work Code) for this asset. # Corresponds to the JSON property `iswc` # @return [String] attr_accessor :iswc # The type of the API resource. For this operation, the value is youtubePartner# # assetSnippet. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The date and time the asset was created. The value is specified in RFC 3339 ( # YYYY-MM-DDThh:mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` # @return [DateTime] attr_accessor :time_created # Title of this asset. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The asset's type. This value determines which metadata fields might be # included in the metadata object. # 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) @custom_id = args[:custom_id] if args.key?(:custom_id) @id = args[:id] if args.key?(:id) @isrc = args[:isrc] if args.key?(:isrc) @iswc = args[:iswc] if args.key?(:iswc) @kind = args[:kind] if args.key?(:kind) @time_created = args[:time_created] if args.key?(:time_created) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) end end # class Campaign include Google::Apis::Core::Hashable # The campaignData object contains details like the campaign's start and end # dates, target and source. # Corresponds to the JSON property `campaignData` # @return [Google::Apis::YoutubePartnerV1::CampaignData] attr_accessor :campaign_data # The unique ID that YouTube uses to identify the campaign. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For campaign resources, this value is # youtubePartner#campaign. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The status of the campaign. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The time the campaign was created. # Corresponds to the JSON property `timeCreated` # @return [DateTime] attr_accessor :time_created # The time the campaign was last modified. # Corresponds to the JSON property `timeLastModified` # @return [DateTime] attr_accessor :time_last_modified def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @campaign_data = args[:campaign_data] if args.key?(:campaign_data) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) @time_created = args[:time_created] if args.key?(:time_created) @time_last_modified = args[:time_last_modified] if args.key?(:time_last_modified) end end # class CampaignData include Google::Apis::Core::Hashable # The campaignSource object contains information about the assets for which the # campaign will generate links. # Corresponds to the JSON property `campaignSource` # @return [Google::Apis::YoutubePartnerV1::CampaignSource] attr_accessor :campaign_source # The time at which the campaign should expire. Do not specify a value if the # campaign has no expiration time. # Corresponds to the JSON property `expireTime` # @return [DateTime] attr_accessor :expire_time # The user-given name of the campaign. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A list of videos or channels that will be linked to from claimed videos that # are included in the campaign. # Corresponds to the JSON property `promotedContent` # @return [Array] attr_accessor :promoted_content # The time at which the campaign should start. Do not specify a value if the # campaign should start immediately. # Corresponds to the JSON property `startTime` # @return [DateTime] attr_accessor :start_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @campaign_source = args[:campaign_source] if args.key?(:campaign_source) @expire_time = args[:expire_time] if args.key?(:expire_time) @name = args[:name] if args.key?(:name) @promoted_content = args[:promoted_content] if args.key?(:promoted_content) @start_time = args[:start_time] if args.key?(:start_time) end end # class CampaignList include Google::Apis::Core::Hashable # A list of campaigns. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # campaignList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class CampaignSource include Google::Apis::Core::Hashable # The type of the campaign source. # Corresponds to the JSON property `sourceType` # @return [String] attr_accessor :source_type # A list of values of the campaign source. # Corresponds to the JSON property `sourceValue` # @return [Array] attr_accessor :source_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @source_type = args[:source_type] if args.key?(:source_type) @source_value = args[:source_value] if args.key?(:source_value) end end # class CampaignTargetLink include Google::Apis::Core::Hashable # The channel ID or video ID of the link target. # Corresponds to the JSON property `targetId` # @return [String] attr_accessor :target_id # Indicates whether the link target is a channel or video. # Corresponds to the JSON property `targetType` # @return [String] attr_accessor :target_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @target_id = args[:target_id] if args.key?(:target_id) @target_type = args[:target_type] if args.key?(:target_type) end end # class Claim include Google::Apis::Core::Hashable # The applied policy for the viewing owner on the claim. This might not be the # same as the final claim policy on the video as it does not consider other # partners' policy of the same claim. # Corresponds to the JSON property `appliedPolicy` # @return [Google::Apis::YoutubePartnerV1::Policy] attr_accessor :applied_policy # The unique YouTube asset ID that identifies the asset associated with the # claim. # Corresponds to the JSON property `assetId` # @return [String] attr_accessor :asset_id # Indicates whether or not the claimed video should be blocked anywhere it is # not explicitly owned. # Corresponds to the JSON property `blockOutsideOwnership` # @return [Boolean] attr_accessor :block_outside_ownership alias_method :block_outside_ownership?, :block_outside_ownership # This value indicates whether the claim covers the audio, video, or audiovisual # portion of the claimed content. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # The ID that YouTube assigns and uses to uniquely identify the claim. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Indicates whether or not the claim is a partner uploaded claim. # Corresponds to the JSON property `isPartnerUploaded` # @return [Boolean] attr_accessor :is_partner_uploaded alias_method :is_partner_uploaded?, :is_partner_uploaded # The type of the API resource. For claim resources, this value is # youtubePartner#claim. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # If this claim was auto-generated based on a provided reference, this section # will provide details of the match that generated the claim. # Corresponds to the JSON property `matchInfo` # @return [Google::Apis::YoutubePartnerV1::Claim::MatchInfo] attr_accessor :match_info # # Corresponds to the JSON property `origin` # @return [Google::Apis::YoutubePartnerV1::Claim::Origin] attr_accessor :origin # The policy provided by the viewing owner on the claim. # Corresponds to the JSON property `policy` # @return [Google::Apis::YoutubePartnerV1::Policy] attr_accessor :policy # The claim's status. When updating a claim, you can update its status from # active to inactive to effectively release the claim, but the API does not # support other updates to a claim's status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The time the claim was created. # Corresponds to the JSON property `timeCreated` # @return [DateTime] attr_accessor :time_created # The unique YouTube video ID that identifies the video associated with the # claim. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @applied_policy = args[:applied_policy] if args.key?(:applied_policy) @asset_id = args[:asset_id] if args.key?(:asset_id) @block_outside_ownership = args[:block_outside_ownership] if args.key?(:block_outside_ownership) @content_type = args[:content_type] if args.key?(:content_type) @id = args[:id] if args.key?(:id) @is_partner_uploaded = args[:is_partner_uploaded] if args.key?(:is_partner_uploaded) @kind = args[:kind] if args.key?(:kind) @match_info = args[:match_info] if args.key?(:match_info) @origin = args[:origin] if args.key?(:origin) @policy = args[:policy] if args.key?(:policy) @status = args[:status] if args.key?(:status) @time_created = args[:time_created] if args.key?(:time_created) @video_id = args[:video_id] if args.key?(:video_id) end # If this claim was auto-generated based on a provided reference, this section # will provide details of the match that generated the claim. class MatchInfo include Google::Apis::Core::Hashable # Details of the longest match between the reference and the user video. # Corresponds to the JSON property `longestMatch` # @return [Google::Apis::YoutubePartnerV1::Claim::MatchInfo::LongestMatch] attr_accessor :longest_match # Details about each match segment. Each item in the list contains information # about one match segment associated with the claim. It is possible to have # multiple match segments. For example, if the audio and video content of an # uploaded video match that of a reference video, there would be two match # segments. One segment would describe the audio match and the other would # describe the video match. # Corresponds to the JSON property `matchSegments` # @return [Array] attr_accessor :match_segments # The reference ID that generated this match. # Corresponds to the JSON property `referenceId` # @return [String] attr_accessor :reference_id # Details of the total amount of reference and user video content which matched # each other. Note these two values may differ if either the reference or the # user video contains a loop. # Corresponds to the JSON property `totalMatch` # @return [Google::Apis::YoutubePartnerV1::Claim::MatchInfo::TotalMatch] attr_accessor :total_match def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @longest_match = args[:longest_match] if args.key?(:longest_match) @match_segments = args[:match_segments] if args.key?(:match_segments) @reference_id = args[:reference_id] if args.key?(:reference_id) @total_match = args[:total_match] if args.key?(:total_match) end # Details of the longest match between the reference and the user video. class LongestMatch include Google::Apis::Core::Hashable # The duration of the longest match between the reference and the user video. # Corresponds to the JSON property `durationSecs` # @return [Fixnum] attr_accessor :duration_secs # The offset in seconds into the reference at which the longest match began. # Corresponds to the JSON property `referenceOffset` # @return [Fixnum] attr_accessor :reference_offset # The offset in seconds into the user video at which the longest match began. # Corresponds to the JSON property `userVideoOffset` # @return [Fixnum] attr_accessor :user_video_offset def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @duration_secs = args[:duration_secs] if args.key?(:duration_secs) @reference_offset = args[:reference_offset] if args.key?(:reference_offset) @user_video_offset = args[:user_video_offset] if args.key?(:user_video_offset) end end # Details of the total amount of reference and user video content which matched # each other. Note these two values may differ if either the reference or the # user video contains a loop. class TotalMatch include Google::Apis::Core::Hashable # The total amount of content in the reference which matched the user video in # seconds. # Corresponds to the JSON property `referenceDurationSecs` # @return [Fixnum] attr_accessor :reference_duration_secs # The total amount of content in the user video which matched the reference in # seconds. # Corresponds to the JSON property `userVideoDurationSecs` # @return [Fixnum] attr_accessor :user_video_duration_secs def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @reference_duration_secs = args[:reference_duration_secs] if args.key?(:reference_duration_secs) @user_video_duration_secs = args[:user_video_duration_secs] if args.key?(:user_video_duration_secs) end end end # class Origin include Google::Apis::Core::Hashable # # 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) @source = args[:source] if args.key?(:source) end end end # class ClaimEvent include Google::Apis::Core::Hashable # The type of the API resource. For claimEvent resources, this value is # youtubePartner#claimEvent. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Reason of the event. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # Data related to source of the event. # Corresponds to the JSON property `source` # @return [Google::Apis::YoutubePartnerV1::ClaimEvent::Source] attr_accessor :source # The time when the event occurred. # Corresponds to the JSON property `time` # @return [DateTime] attr_accessor :time # Type of the event. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Details of event's type. # Corresponds to the JSON property `typeDetails` # @return [Google::Apis::YoutubePartnerV1::ClaimEvent::TypeDetails] attr_accessor :type_details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @reason = args[:reason] if args.key?(:reason) @source = args[:source] if args.key?(:source) @time = args[:time] if args.key?(:time) @type = args[:type] if args.key?(:type) @type_details = args[:type_details] if args.key?(:type_details) end # Data related to source of the event. class Source include Google::Apis::Core::Hashable # Id of content owner that initiated the event. # Corresponds to the JSON property `contentOwnerId` # @return [String] attr_accessor :content_owner_id # Type of the event source. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Email of user who initiated the event. # Corresponds to the JSON property `userEmail` # @return [String] attr_accessor :user_email def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_owner_id = args[:content_owner_id] if args.key?(:content_owner_id) @type = args[:type] if args.key?(:type) @user_email = args[:user_email] if args.key?(:user_email) end end # Details of event's type. class TypeDetails include Google::Apis::Core::Hashable # Appeal explanations for dispute_appeal event. # Corresponds to the JSON property `appealExplanation` # @return [String] attr_accessor :appeal_explanation # Dispute notes for dispute_create events. # Corresponds to the JSON property `disputeNotes` # @return [String] attr_accessor :dispute_notes # Dispute reason for dispute_create and dispute_appeal events. # Corresponds to the JSON property `disputeReason` # @return [String] attr_accessor :dispute_reason # Status that was a result of update for claim_update event. # Corresponds to the JSON property `updateStatus` # @return [String] attr_accessor :update_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @appeal_explanation = args[:appeal_explanation] if args.key?(:appeal_explanation) @dispute_notes = args[:dispute_notes] if args.key?(:dispute_notes) @dispute_reason = args[:dispute_reason] if args.key?(:dispute_reason) @update_status = args[:update_status] if args.key?(:update_status) end end end # class ClaimHistory include Google::Apis::Core::Hashable # A list of claim history events. # Corresponds to the JSON property `event` # @return [Array] attr_accessor :event # The ID that YouTube assigns and uses to uniquely identify the claim. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For claimHistory resources, this value is # youtubePartner#claimHistory. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The external channel id of claimed video's uploader. # Corresponds to the JSON property `uploaderChannelId` # @return [String] attr_accessor :uploader_channel_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @event = args[:event] if args.key?(:event) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @uploader_channel_id = args[:uploader_channel_id] if args.key?(:uploader_channel_id) end end # class ClaimListResponse include Google::Apis::Core::Hashable # A list of claims that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # claimList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `previousPageToken` # @return [String] attr_accessor :previous_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @page_info = args[:page_info] if args.key?(:page_info) @previous_page_token = args[:previous_page_token] if args.key?(:previous_page_token) end end # class ClaimSearchResponse include Google::Apis::Core::Hashable # A list of claims that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # claimSnippetList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `previousPageToken` # @return [String] attr_accessor :previous_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @page_info = args[:page_info] if args.key?(:page_info) @previous_page_token = args[:previous_page_token] if args.key?(:previous_page_token) end end # class ClaimSnippet include Google::Apis::Core::Hashable # The unique YouTube asset ID that identifies the asset associated with the # claim. # Corresponds to the JSON property `assetId` # @return [String] attr_accessor :asset_id # This value indicates whether the claim covers the audio, video, or audiovisual # portion of the claimed content. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # The ID that YouTube assigns and uses to uniquely identify the claim. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Indicates whether or not the claim is a partner uploaded claim. # Corresponds to the JSON property `isPartnerUploaded` # @return [Boolean] attr_accessor :is_partner_uploaded alias_method :is_partner_uploaded?, :is_partner_uploaded # The type of the API resource. For this operation, the value is youtubePartner# # claimSnippet. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # # Corresponds to the JSON property `origin` # @return [Google::Apis::YoutubePartnerV1::ClaimSnippet::Origin] attr_accessor :origin # The claim's status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Indicates that this is a third party claim. # Corresponds to the JSON property `thirdPartyClaim` # @return [Boolean] attr_accessor :third_party_claim alias_method :third_party_claim?, :third_party_claim # The time the claim was created. # Corresponds to the JSON property `timeCreated` # @return [DateTime] attr_accessor :time_created # The time the claim status and/or status detail was last modified. # Corresponds to the JSON property `timeStatusLastModified` # @return [DateTime] attr_accessor :time_status_last_modified # The unique YouTube video ID that identifies the video associated with the # claim. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id # The title of the claimed video. # Corresponds to the JSON property `videoTitle` # @return [String] attr_accessor :video_title # Number of views for the claimed video. # Corresponds to the JSON property `videoViews` # @return [Fixnum] attr_accessor :video_views def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @asset_id = args[:asset_id] if args.key?(:asset_id) @content_type = args[:content_type] if args.key?(:content_type) @id = args[:id] if args.key?(:id) @is_partner_uploaded = args[:is_partner_uploaded] if args.key?(:is_partner_uploaded) @kind = args[:kind] if args.key?(:kind) @origin = args[:origin] if args.key?(:origin) @status = args[:status] if args.key?(:status) @third_party_claim = args[:third_party_claim] if args.key?(:third_party_claim) @time_created = args[:time_created] if args.key?(:time_created) @time_status_last_modified = args[:time_status_last_modified] if args.key?(:time_status_last_modified) @video_id = args[:video_id] if args.key?(:video_id) @video_title = args[:video_title] if args.key?(:video_title) @video_views = args[:video_views] if args.key?(:video_views) end # class Origin include Google::Apis::Core::Hashable # # 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) @source = args[:source] if args.key?(:source) end end end # class ClaimedVideoDefaults include Google::Apis::Core::Hashable # Set this property to true to enable automatically generated breaks for a newly # claimed video longer than 10 minutes. The first partner that claims the video # sets its default advertising options to that video. claimedVideoOptions. # auto_generated_breaks_default # Corresponds to the JSON property `autoGeneratedBreaks` # @return [Boolean] attr_accessor :auto_generated_breaks alias_method :auto_generated_breaks?, :auto_generated_breaks # Set this property to true to indicate that the channel's claimedVideoOptions # can override the content owner's claimedVideoOptions. # Corresponds to the JSON property `channelOverride` # @return [Boolean] attr_accessor :channel_override alias_method :channel_override?, :channel_override # Identifies this resource as default options for newly claimed video. Value: " # youtubePartner#claimedVideoDefaults". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A list of ad formats that could be used as the default settings for a newly # claimed video. The first partner that claims the video sets its default # advertising options to that video. # Corresponds to the JSON property `newVideoDefaults` # @return [Array] attr_accessor :new_video_defaults def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_generated_breaks = args[:auto_generated_breaks] if args.key?(:auto_generated_breaks) @channel_override = args[:channel_override] if args.key?(:channel_override) @kind = args[:kind] if args.key?(:kind) @new_video_defaults = args[:new_video_defaults] if args.key?(:new_video_defaults) end end # class Conditions include Google::Apis::Core::Hashable # This match condition specifies whether the user- or partner-uploaded content # needs to match the audio, video or audiovisual content of a reference file for # the rule to apply. # Corresponds to the JSON property `contentMatchType` # @return [Array] attr_accessor :content_match_type # This match condition specifies an amount of time that the user- or partner- # uploaded content needs to match a reference file for the rule to apply. # Corresponds to the JSON property `matchDuration` # @return [Array] attr_accessor :match_duration # This match condition specifies a percentage of the user- or partner-uploaded # content that needs to match a reference file for the rule to apply. # Corresponds to the JSON property `matchPercent` # @return [Array] attr_accessor :match_percent # This match condition indicates that the reference must be a certain duration # for the rule to apply. # Corresponds to the JSON property `referenceDuration` # @return [Array] attr_accessor :reference_duration # This match condition indicates that the specified percentage of a reference # file must match the user- or partner-uploaded content for the rule to apply. # Corresponds to the JSON property `referencePercent` # @return [Array] attr_accessor :reference_percent # This watch condition specifies where users are (or or not) allowed to watch ( # or listen to) an asset. YouTube determines whether the condition is satisfied # based on the user's location. # Corresponds to the JSON property `requiredTerritories` # @return [Google::Apis::YoutubePartnerV1::TerritoryCondition] attr_accessor :required_territories def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_match_type = args[:content_match_type] if args.key?(:content_match_type) @match_duration = args[:match_duration] if args.key?(:match_duration) @match_percent = args[:match_percent] if args.key?(:match_percent) @reference_duration = args[:reference_duration] if args.key?(:reference_duration) @reference_percent = args[:reference_percent] if args.key?(:reference_percent) @required_territories = args[:required_territories] if args.key?(:required_territories) end end # class ConflictingOwnership include Google::Apis::Core::Hashable # The ID of the conflicting asset's owner. # Corresponds to the JSON property `owner` # @return [String] attr_accessor :owner # The percentage of the asset that the owner controls or administers. # Corresponds to the JSON property `ratio` # @return [Float] attr_accessor :ratio def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @owner = args[:owner] if args.key?(:owner) @ratio = args[:ratio] if args.key?(:ratio) end end # class ContentOwner include Google::Apis::Core::Hashable # The email address visible to other partners for use in managing asset # ownership conflicts. # Corresponds to the JSON property `conflictNotificationEmail` # @return [String] attr_accessor :conflict_notification_email # The content owner's display name. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The email address(es) to which YouTube sends claim dispute notifications and # possible claim notifications. # Corresponds to the JSON property `disputeNotificationEmails` # @return [Array] attr_accessor :dispute_notification_emails # The email address(es) to which YouTube sends fingerprint reports. # Corresponds to the JSON property `fingerprintReportNotificationEmails` # @return [Array] attr_accessor :fingerprint_report_notification_emails # A unique ID that YouTube uses to identify the content owner. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For content owner resources, the value is # youtubePartner#contentOwner. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The email address(es) to which YouTube sends CMS account details and report # notifications. # Corresponds to the JSON property `primaryNotificationEmails` # @return [Array] attr_accessor :primary_notification_emails def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @conflict_notification_email = args[:conflict_notification_email] if args.key?(:conflict_notification_email) @display_name = args[:display_name] if args.key?(:display_name) @dispute_notification_emails = args[:dispute_notification_emails] if args.key?(:dispute_notification_emails) @fingerprint_report_notification_emails = args[:fingerprint_report_notification_emails] if args.key?(:fingerprint_report_notification_emails) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @primary_notification_emails = args[:primary_notification_emails] if args.key?(:primary_notification_emails) end end # class ContentOwnerAdvertisingOption include Google::Apis::Core::Hashable # This object identifies the ad formats that the content owner is allowed to use. # Corresponds to the JSON property `allowedOptions` # @return [Google::Apis::YoutubePartnerV1::AllowedAdvertisingOptions] attr_accessor :allowed_options # This object identifies the advertising options used by default for the content # owner's newly claimed videos. # Corresponds to the JSON property `claimedVideoOptions` # @return [Google::Apis::YoutubePartnerV1::ClaimedVideoDefaults] attr_accessor :claimed_video_options # The value that YouTube uses to uniquely identify the content owner. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For this resource, the value is youtubePartner# # contentOwnerAdvertisingOption. # 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) @allowed_options = args[:allowed_options] if args.key?(:allowed_options) @claimed_video_options = args[:claimed_video_options] if args.key?(:claimed_video_options) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) end end # class ContentOwnerListResponse include Google::Apis::Core::Hashable # A list of content owners that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # contentOwnerList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class CountriesRestriction include Google::Apis::Core::Hashable # A list of ad formats that can be used in the specified countries. # Corresponds to the JSON property `adFormats` # @return [Array] attr_accessor :ad_formats # A list of ISO 3166-1 alpha-2 country codes that identify the countries where # ads are enabled. # Corresponds to the JSON property `territories` # @return [Array] attr_accessor :territories def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_formats = args[:ad_formats] if args.key?(:ad_formats) @territories = args[:territories] if args.key?(:territories) end end # class CuepointSettings include Google::Apis::Core::Hashable # The cuepoint's type. See the Getting started guide for an explanation of the # different types of cuepoints. Also see the Life of a broadcast document for # best practices about inserting cuepoints during your broadcast. # Corresponds to the JSON property `cueType` # @return [String] attr_accessor :cue_type # The cuepoint's duration, in seconds. This value must be specified if the # cueType is ad and is ignored otherwise. # Corresponds to the JSON property `durationSecs` # @return [Fixnum] attr_accessor :duration_secs # This value specifies a point in time in the video when viewers should see an # ad or in-stream slate. The property value identifies a time offset, in # milliseconds, from the beginning of the monitor stream. Though measured in # milliseconds, the value is actually an approximation, and YouTube will insert # the cuepoint as closely as possible to that time. You should not specify a # value for this parameter if your broadcast does not have a monitor stream. # This property's default value is 0, which indicates that the cuepoint should # be inserted as soon as possible. If your broadcast stream is not delayed, then # 0 is also the only valid value. However, if your broadcast stream is delayed, # then the property value can specify the time when the cuepoint should be # inserted. See the Getting started guide for more details. # Note: If your broadcast had a testing phase, the offset is measured from the # time that the testing phase began. # Corresponds to the JSON property `offsetTimeMs` # @return [Fixnum] attr_accessor :offset_time_ms # This value specifies the wall clock time at which the cuepoint should be # inserted. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. # Corresponds to the JSON property `walltime` # @return [DateTime] attr_accessor :walltime def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cue_type = args[:cue_type] if args.key?(:cue_type) @duration_secs = args[:duration_secs] if args.key?(:duration_secs) @offset_time_ms = args[:offset_time_ms] if args.key?(:offset_time_ms) @walltime = args[:walltime] if args.key?(:walltime) end end # class Date include Google::Apis::Core::Hashable # The date's day. The value should be an integer between 1 and 31. Note that # some day-month combinations are not valid. # Corresponds to the JSON property `day` # @return [Fixnum] attr_accessor :day # The date's month. The value should be an integer between 1 and 12. # Corresponds to the JSON property `month` # @return [Fixnum] attr_accessor :month # The date's year in the Gregorian Calendar. Assumed to be A.D. # 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 # class DateRange include Google::Apis::Core::Hashable # The end date (inclusive) for the date range. This value is required for video- # on-demand (VOD) orders and optional for electronic sell-through (EST) orders. # Corresponds to the JSON property `end` # @return [Google::Apis::YoutubePartnerV1::Date] attr_accessor :end # Identifies this resource as order date range. Value: "youtubePartner#dateRange" # . # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The start date for the date range. This value is required for all date ranges. # Corresponds to the JSON property `start` # @return [Google::Apis::YoutubePartnerV1::Date] attr_accessor :start def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end = args[:end] if args.key?(:end) @kind = args[:kind] if args.key?(:kind) @start = args[:start] if args.key?(:start) end end # class ExcludedInterval include Google::Apis::Core::Hashable # The end (inclusive) time in seconds of the time window. The value can be any # value greater than low. If high is greater than the length of the reference, # the interval between low and the end of the reference will be excluded. Every # interval must specify a value for this field. # Corresponds to the JSON property `high` # @return [Float] attr_accessor :high # The start (inclusive) time in seconds of the time window. The value can be any # value between 0 and high. Every interval must specify a value for this field. # Corresponds to the JSON property `low` # @return [Float] attr_accessor :low # The source of the request to exclude the interval from Content ID matching. # Corresponds to the JSON property `origin` # @return [String] attr_accessor :origin # The date and time that the exclusion was created. The value is specified in # RFC 3339 (YYYY-MM-DDThh:mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` # @return [DateTime] attr_accessor :time_created def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @high = args[:high] if args.key?(:high) @low = args[:low] if args.key?(:low) @origin = args[:origin] if args.key?(:origin) @time_created = args[:time_created] if args.key?(:time_created) end end # class IntervalCondition include Google::Apis::Core::Hashable # The maximum (inclusive) allowed value for the condition to be satisfied. The # default value is ∞. # Corresponds to the JSON property `high` # @return [Float] attr_accessor :high # The minimum (inclusive) allowed value for the condition to be satisfied. The # default value is -∞. # Corresponds to the JSON property `low` # @return [Float] attr_accessor :low def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @high = args[:high] if args.key?(:high) @low = args[:low] if args.key?(:low) end end # class LiveCuepoint include Google::Apis::Core::Hashable # The ID that YouTube assigns to uniquely identify the broadcast into which the # cuepoint is being inserted. # Corresponds to the JSON property `broadcastId` # @return [String] attr_accessor :broadcast_id # A value that YouTube assigns to uniquely identify the cuepoint. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For liveCuepoint resources, the value is # youtubePartner#liveCuepoint. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The settings object defines the cuepoint's settings. # Corresponds to the JSON property `settings` # @return [Google::Apis::YoutubePartnerV1::CuepointSettings] attr_accessor :settings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @broadcast_id = args[:broadcast_id] if args.key?(:broadcast_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @settings = args[:settings] if args.key?(:settings) end end # class MatchSegment include Google::Apis::Core::Hashable # Identifies the manner in which the claimed video matches the reference video. # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel # The reference_segment object contains information about the matched portion of # the reference content. # Corresponds to the JSON property `reference_segment` # @return [Google::Apis::YoutubePartnerV1::Segment] attr_accessor :reference_segment # The video_segment object contains information about the matched portion of the # claimed video. # Corresponds to the JSON property `video_segment` # @return [Google::Apis::YoutubePartnerV1::Segment] attr_accessor :video_segment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel = args[:channel] if args.key?(:channel) @reference_segment = args[:reference_segment] if args.key?(:reference_segment) @video_segment = args[:video_segment] if args.key?(:video_segment) end end # class Metadata include Google::Apis::Core::Hashable # A list that identifies actors associated with the asset. You can specify up to # 50 actors for an asset. # Corresponds to the JSON property `actor` # @return [Array] attr_accessor :actor # The album on which a sound recording asset is included. This field is only # valid for sound recording assets and has a maximum length of 255 bytes. # Corresponds to the JSON property `album` # @return [String] attr_accessor :album # The artist associated with a music video or sound recording asset. This field # is only valid for music video and sound recording assets. It is required for # sound recordings included in the AudioSwap program. # Corresponds to the JSON property `artist` # @return [Array] attr_accessor :artist # Identifies the network or channel that originally broadcast a show or a season # of a show. This field should only be included for an asset if the broadcaster # associated with the asset is different from the partner uploading the asset to # YouTube. Note that a show may have multiple broadcasters; for example, a show # may switch networks between seasons. # Corresponds to the JSON property `broadcaster` # @return [Array] attr_accessor :broadcaster # Category of this asset. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category # The type of video content that the asset represents. This field is only valid # for movie and episode assets, and is required for the following types of those # assets: # - Episode assets that are linked to a show # - Movie assets that appear in YouTube's Movies category # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # The date copyright for this asset was established. * # Corresponds to the JSON property `copyrightDate` # @return [Google::Apis::YoutubePartnerV1::Date] attr_accessor :copyright_date # A unique value that you, the metadata provider, use to identify an asset. The # value could be a unique ID that you created for the asset or a standard # identifier, such as an ISRC. The value has a maximum length of 64 bytes and # may contain alphanumeric characters, hyphens (-), underscores (_), periods (.), # "at" symbols (@), or forward slashes (/). # Corresponds to the JSON property `customId` # @return [String] attr_accessor :custom_id # A description of the asset. The description may be displayed on YouTube or in # CMS. This field has a maximum length of 5,000 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # A list that identifies directors associated with the asset. You can specify up # to 50 directors for an asset. # Corresponds to the JSON property `director` # @return [Array] attr_accessor :director # The Entertainment Identifier Registry (EIDR) assigned to an asset. This value # is only used for episode and movie assets and is optional in both cases. The # value contains a standard prefix for EIDR registry, followed by a forward # slash, a 20-character hexadecimal string, and an alphanumeric (0-9A-Z) check # character. # Corresponds to the JSON property `eidr` # @return [String] attr_accessor :eidr # The last year that a television show aired. This value is only used for show # assets, for which it is optional. Do not specify a value if new show episodes # are still being created. # Corresponds to the JSON property `endYear` # @return [Fixnum] attr_accessor :end_year # The episode number associated with an episode asset. This field is required # for and only used for episode assets that are linked to show assets. It has a # maximum length of 5 bytes. # Corresponds to the JSON property `episodeNumber` # @return [String] attr_accessor :episode_number # This value indicates that the episodes associated with a particular show asset # or a particular season asset are untitled. An untitled show (or season) has # episodes which are identified by their episode number or date. If this field # is set to true, then YouTube will optimize the title displayed for associated # episodes. # Corresponds to the JSON property `episodesAreUntitled` # @return [Boolean] attr_accessor :episodes_are_untitled alias_method :episodes_are_untitled?, :episodes_are_untitled # This field specifies a genre that can be used to categorize an asset. Assets # may be categorized in more than one genre, and YouTube uses different sets of # genres to categorize different types of assets. For example, Soaps might be a # valid genre for a show but not for a movie or sound recording. # - Show assets # - Movie assets that appear in YouTube's Movies category # - Sound recordings included in the AudioSwap program # Corresponds to the JSON property `genre` # @return [Array] attr_accessor :genre # The GRID (Global Release Identifier) of a music video or sound recording. This # field's value must contain exactly 18 alphanumeric characters. # Corresponds to the JSON property `grid` # @return [String] attr_accessor :grid # The six-character Harry Fox Agency (HFA) song code issued to uniquely identify # a composition. This value is only valid for composition assets. # Corresponds to the JSON property `hfa` # @return [String] attr_accessor :hfa # An official URL associated with the asset. This field has a maximum length of # 1536 bytes. Please do not submit a 1537-byte URL. Your efforts would be futile. # Corresponds to the JSON property `infoUrl` # @return [String] attr_accessor :info_url # The ISAN (International Standard Audiovisual Number) for the asset. This value # is only used for episode and movie assets and is optional in both cases. The # value contains 26 characters, which includes the 24 hexadecimal characters of # the ISAN as well as two check characters, in the following format: # - The first 16 characters in the tag value contain hexadecimal characters # specifying the 'root' and 'episode' components of the ISAN. # - The seventeenth character is a check character (a letter from A-Z). # - Characters 18 to 25 are the remaining eight characters of the ISAN, which # specify the 'version' component of the ISAN. # - The twenty-sixth character is another check character (A-Z). # Corresponds to the JSON property `isan` # @return [String] attr_accessor :isan # The ISRC (International Standard Recording Code) of a music video or sound # recording asset. This field's value must contain exactly 12 alphanumeric # characters. # Corresponds to the JSON property `isrc` # @return [String] attr_accessor :isrc # The ISWC (International Standard Musical Work Code) for a composition asset. # The field's value must contain exactly 11 characters in the format of a letter # (T) followed by 10 digits. # Corresponds to the JSON property `iswc` # @return [String] attr_accessor :iswc # A list of up to 100 keywords associated with a show asset. This field is # required for and also only used for show assets. # Corresponds to the JSON property `keyword` # @return [Array] attr_accessor :keyword # The record label that released a sound recording asset. This field is only # valid for sound recording assets and has a maximum length of 255 bytes. # Corresponds to the JSON property `label` # @return [String] attr_accessor :label # Additional information that does not map directly to one of the other metadata # fields. This field has a maximum length of 255 bytes. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # The method by which people first had the opportunity to see a video asset. # This value is only used for episode and movie assets. It is required for the # assets listed below and otherwise optional: # - Episode assets that are linked to a show # - Movie assets that appear in YouTube's Movies category # Corresponds to the JSON property `originalReleaseMedium` # @return [String] attr_accessor :original_release_medium # A list that identifies producers of the asset. You can specify up to 50 # producers for an asset. # Corresponds to the JSON property `producer` # @return [Array] attr_accessor :producer # A list of ratings that an asset received. The rating must be valid under the # specified rating system. # Corresponds to the JSON property `ratings` # @return [Array] attr_accessor :ratings # The date that an asset was publicly released. For season assets, this value # specifies the first date that the season aired. Dates prior to the year 1902 # are not supported. This value is valid for episode, season, movie, music video, # and sound recording assets. It is required for the assets listed below and # otherwise optional: # - Episode assets that are linked to a show # - Movie assets that appear in YouTube's Movies category # Corresponds to the JSON property `releaseDate` # @return [Google::Apis::YoutubePartnerV1::Date] attr_accessor :release_date # The season number that identifies a season asset, or the season number that is # associated with an episode asset. This field has a maximum length of 5 bytes. # Corresponds to the JSON property `seasonNumber` # @return [String] attr_accessor :season_number # The customId of the show asset that a season or episode asset is associated # with. It is required for season and episode assets that appear in the Shows # category on YouTube, and it is not valid for other types of assets. This field # has a maximum length of 64 bytes and may contain alphanumeric characters, # hyphens (-), underscores (_), periods (.), "at" symbols (@), or forward # slashes (/). # Corresponds to the JSON property `showCustomId` # @return [String] attr_accessor :show_custom_id # The name of the show that an episode asset is associated with. Note: This tag # is only used for and valid for episodes that are not associated with show # assets and enables those assets to still display a show title in the asset # metadata section of CMS. This field has a maximum length of 120 bytes. # Corresponds to the JSON property `showTitle` # @return [String] attr_accessor :show_title # The video's primary spoken language. The value can be any ISO 639-1 two-letter # language code. This value is only used for episode and movie assets and is not # valid for other types of assets. # Corresponds to the JSON property `spokenLanguage` # @return [String] attr_accessor :spoken_language # The first year that a television show aired. This value is required for and # also only used for show assets. # Corresponds to the JSON property `startYear` # @return [Fixnum] attr_accessor :start_year # A list of languages for which the video has either a separate caption track or # burnt-in captions that are part of the video. Each value in the list should be # an ISO 639-1 two-letter language code. This value is only used for episode and # movie assets and is not valid for other types of assets. # Corresponds to the JSON property `subtitledLanguage` # @return [Array] attr_accessor :subtitled_language # The asset's title or name. The value has a maximum length of 255 bytes. This # value is required for the assets listed below and optional for all other # assets: # - Show assets # - Episode assets that are linked to a show # - Movie assets that appear in YouTube's Movies category # - Sound recordings included in the AudioSwap program # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # TMS (Tribune Media Systems) ID for the asset. # Corresponds to the JSON property `tmsId` # @return [String] attr_accessor :tms_id # Specifies the total number of full-length episodes in the season. This value # is used only for season assets. # Corresponds to the JSON property `totalEpisodesExpected` # @return [Fixnum] attr_accessor :total_episodes_expected # The UPC (Universal Product Code) associated with the asset. # Corresponds to the JSON property `upc` # @return [String] attr_accessor :upc # A list that identifies writers associated with the asset. You can specify up # to 50 writers for an asset. # Corresponds to the JSON property `writer` # @return [Array] attr_accessor :writer def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @actor = args[:actor] if args.key?(:actor) @album = args[:album] if args.key?(:album) @artist = args[:artist] if args.key?(:artist) @broadcaster = args[:broadcaster] if args.key?(:broadcaster) @category = args[:category] if args.key?(:category) @content_type = args[:content_type] if args.key?(:content_type) @copyright_date = args[:copyright_date] if args.key?(:copyright_date) @custom_id = args[:custom_id] if args.key?(:custom_id) @description = args[:description] if args.key?(:description) @director = args[:director] if args.key?(:director) @eidr = args[:eidr] if args.key?(:eidr) @end_year = args[:end_year] if args.key?(:end_year) @episode_number = args[:episode_number] if args.key?(:episode_number) @episodes_are_untitled = args[:episodes_are_untitled] if args.key?(:episodes_are_untitled) @genre = args[:genre] if args.key?(:genre) @grid = args[:grid] if args.key?(:grid) @hfa = args[:hfa] if args.key?(:hfa) @info_url = args[:info_url] if args.key?(:info_url) @isan = args[:isan] if args.key?(:isan) @isrc = args[:isrc] if args.key?(:isrc) @iswc = args[:iswc] if args.key?(:iswc) @keyword = args[:keyword] if args.key?(:keyword) @label = args[:label] if args.key?(:label) @notes = args[:notes] if args.key?(:notes) @original_release_medium = args[:original_release_medium] if args.key?(:original_release_medium) @producer = args[:producer] if args.key?(:producer) @ratings = args[:ratings] if args.key?(:ratings) @release_date = args[:release_date] if args.key?(:release_date) @season_number = args[:season_number] if args.key?(:season_number) @show_custom_id = args[:show_custom_id] if args.key?(:show_custom_id) @show_title = args[:show_title] if args.key?(:show_title) @spoken_language = args[:spoken_language] if args.key?(:spoken_language) @start_year = args[:start_year] if args.key?(:start_year) @subtitled_language = args[:subtitled_language] if args.key?(:subtitled_language) @title = args[:title] if args.key?(:title) @tms_id = args[:tms_id] if args.key?(:tms_id) @total_episodes_expected = args[:total_episodes_expected] if args.key?(:total_episodes_expected) @upc = args[:upc] if args.key?(:upc) @writer = args[:writer] if args.key?(:writer) end end # class MetadataHistory include Google::Apis::Core::Hashable # The type of the API resource. For metadata history resources, the value is # youtubePartner#metadataHistory. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The metadata object contains the metadata provided by the specified source ( # origination) at the specified time (timeProvided). # Corresponds to the JSON property `metadata` # @return [Google::Apis::YoutubePartnerV1::Metadata] attr_accessor :metadata # The origination object contains information that describes the metadata source. # Corresponds to the JSON property `origination` # @return [Google::Apis::YoutubePartnerV1::Origination] attr_accessor :origination # The time the metadata was provided. # Corresponds to the JSON property `timeProvided` # @return [DateTime] attr_accessor :time_provided def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @metadata = args[:metadata] if args.key?(:metadata) @origination = args[:origination] if args.key?(:origination) @time_provided = args[:time_provided] if args.key?(:time_provided) end end # class MetadataHistoryListResponse include Google::Apis::Core::Hashable # A list of metadata history (youtubePartner#metadataHistory) resources that # match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # metadataHistoryList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class Order include Google::Apis::Core::Hashable # Links an order to the avails associated with it. # Corresponds to the JSON property `availGroupId` # @return [String] attr_accessor :avail_group_id # Channel ID - identifies the channel this order and video are associated with # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # Type of content possible values are # - MOVIE # - SHOW # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # Two letter country code for the order only countries where YouTube does # transactional business are allowed. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # Secondary id to be used to identify content in other systems like partner # database # Corresponds to the JSON property `customId` # @return [String] attr_accessor :custom_id # Date when this content was first made available on DVD # Corresponds to the JSON property `dvdReleaseDate` # @return [Google::Apis::YoutubePartnerV1::Date] attr_accessor :dvd_release_date # Range of time content is to be available for rental. # Corresponds to the JSON property `estDates` # @return [Google::Apis::YoutubePartnerV1::DateRange] attr_accessor :est_dates # History log of events for this order # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events # Order Id unique identifier for an order. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies this resource as order. Value: "youtubePartner#order". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Title if the order is type movie. # Corresponds to the JSON property `movie` # @return [String] attr_accessor :movie # Date when this content was first made available to the public # Corresponds to the JSON property `originalReleaseDate` # @return [Google::Apis::YoutubePartnerV1::Date] attr_accessor :original_release_date # The priority for the order in the QC review queue once the content is ready # for QC. # Corresponds to the JSON property `priority` # @return [String] attr_accessor :priority # Post production house that is to process this order # Corresponds to the JSON property `productionHouse` # @return [String] attr_accessor :production_house # Youtube purchase order reference for the post production house. # Corresponds to the JSON property `purchaseOrder` # @return [String] attr_accessor :purchase_order # Minumim set of requirements for this order to be complete such as is a trailer # required. # Corresponds to the JSON property `requirements` # @return [Google::Apis::YoutubePartnerV1::Requirements] attr_accessor :requirements # Details of a show, show name, season number, episode etc. # Corresponds to the JSON property `show` # @return [Google::Apis::YoutubePartnerV1::ShowDetails] attr_accessor :show # The order's status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Video ID the video that this order is associated with if any. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id # Range of time content is to be available for purchase. # Corresponds to the JSON property `vodDates` # @return [Google::Apis::YoutubePartnerV1::DateRange] attr_accessor :vod_dates def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @avail_group_id = args[:avail_group_id] if args.key?(:avail_group_id) @channel_id = args[:channel_id] if args.key?(:channel_id) @content_type = args[:content_type] if args.key?(:content_type) @country = args[:country] if args.key?(:country) @custom_id = args[:custom_id] if args.key?(:custom_id) @dvd_release_date = args[:dvd_release_date] if args.key?(:dvd_release_date) @est_dates = args[:est_dates] if args.key?(:est_dates) @events = args[:events] if args.key?(:events) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @movie = args[:movie] if args.key?(:movie) @original_release_date = args[:original_release_date] if args.key?(:original_release_date) @priority = args[:priority] if args.key?(:priority) @production_house = args[:production_house] if args.key?(:production_house) @purchase_order = args[:purchase_order] if args.key?(:purchase_order) @requirements = args[:requirements] if args.key?(:requirements) @show = args[:show] if args.key?(:show) @status = args[:status] if args.key?(:status) @video_id = args[:video_id] if args.key?(:video_id) @vod_dates = args[:vod_dates] if args.key?(:vod_dates) end end # class OrderListResponse include Google::Apis::Core::Hashable # A list of orders that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # orderList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `previousPageToken` # @return [String] attr_accessor :previous_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @page_info = args[:page_info] if args.key?(:page_info) @previous_page_token = args[:previous_page_token] if args.key?(:previous_page_token) end end # class Origination include Google::Apis::Core::Hashable # The content owner who provided the metadata or ownership information. # Corresponds to the JSON property `owner` # @return [String] attr_accessor :owner # The mechanism by which the piece of metadata, ownership or relationship # information was provided. # 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) @owner = args[:owner] if args.key?(:owner) @source = args[:source] if args.key?(:source) end end # class OwnershipConflicts include Google::Apis::Core::Hashable # A list that identifies ownership conflicts of an asset and the territories # where conflicting ownership is inserted. # Corresponds to the JSON property `general` # @return [Array] attr_accessor :general # The type of the API resource. For ownershipConflicts resources, the value is # youtubePartner#ownershipConflicts. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A list that identifies ownership conflicts of the mechanical rights for a # composition asset and the territories where conflicting ownership is inserted. # Corresponds to the JSON property `mechanical` # @return [Array] attr_accessor :mechanical # A list that identifies ownership conflicts of the performance rights for a # composition asset and the territories where conflicting ownership is inserted. # Corresponds to the JSON property `performance` # @return [Array] attr_accessor :performance # A list that identifies ownership conflicts of the synchronization rights for a # composition asset and the territories where conflicting ownership is inserted. # Corresponds to the JSON property `synchronization` # @return [Array] attr_accessor :synchronization def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @general = args[:general] if args.key?(:general) @kind = args[:kind] if args.key?(:kind) @mechanical = args[:mechanical] if args.key?(:mechanical) @performance = args[:performance] if args.key?(:performance) @synchronization = args[:synchronization] if args.key?(:synchronization) end end # class OwnershipHistoryListResponse include Google::Apis::Core::Hashable # A list of ownership history (youtubePartner#ownershipHistory) resources that # match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # ownershipHistoryList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class Package include Google::Apis::Core::Hashable # The package's metadata file contents. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The list of customer IDs. # Corresponds to the JSON property `customIds` # @return [Array] attr_accessor :custom_ids # An ID that YouTube assigns and uses to uniquely identify the package. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For package resources, this value is # youtubePartner#package. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The desired locale of the error messages as defined in BCP 47 (http://tools. # ietf.org/html/bcp47). For example, "en-US" or "de". If not specified we will # return the error messages in English ("en"). # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # The package name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The package status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The package status reports. # Corresponds to the JSON property `statusReports` # @return [Array] attr_accessor :status_reports # The package creation time. The value is specified in RFC 3339 (YYYY-MM-DDThh: # mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` # @return [DateTime] attr_accessor :time_created # The package type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The uploader name. # Corresponds to the JSON property `uploaderName` # @return [String] attr_accessor :uploader_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content = args[:content] if args.key?(:content) @custom_ids = args[:custom_ids] if args.key?(:custom_ids) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @locale = args[:locale] if args.key?(:locale) @name = args[:name] if args.key?(:name) @status = args[:status] if args.key?(:status) @status_reports = args[:status_reports] if args.key?(:status_reports) @time_created = args[:time_created] if args.key?(:time_created) @type = args[:type] if args.key?(:type) @uploader_name = args[:uploader_name] if args.key?(:uploader_name) end end # class PackageInsertResponse include Google::Apis::Core::Hashable # The list of errors and/or warnings. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # The type of the API response. For this operation, the value is youtubePartner# # packageInsert. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The package resource. # Corresponds to the JSON property `resource` # @return [Google::Apis::YoutubePartnerV1::Package] attr_accessor :resource # The package insert status. Indicates whether the insert operation completed # successfully or identifies the general cause of failure. For most cases where # the insert operation failed, the errors are described in the API response's # errors object. However, if the operation failed because the package contained # non-metadata files, the errors object is not included in the response. # 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) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) @resource = args[:resource] if args.key?(:resource) @status = args[:status] if args.key?(:status) end end # class PageInfo include Google::Apis::Core::Hashable # The number of results included in the API response. # Corresponds to the JSON property `resultsPerPage` # @return [Fixnum] attr_accessor :results_per_page # The index of the first item in the API response. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # The total number of results in the result set. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @results_per_page = args[:results_per_page] if args.key?(:results_per_page) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) end end # class Policy include Google::Apis::Core::Hashable # The policy's description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # A value that YouTube assigns and uses to uniquely identify the policy. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies this as a policy. Value: "youtubePartner#policy" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The policy's name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A list of rules that specify the action that YouTube should take and may # optionally specify the conditions under which that action is enforced. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules # The time the policy was updated. # Corresponds to the JSON property `timeUpdated` # @return [DateTime] attr_accessor :time_updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @rules = args[:rules] if args.key?(:rules) @time_updated = args[:time_updated] if args.key?(:time_updated) end end # class PolicyList include Google::Apis::Core::Hashable # A list of saved policies. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # policyList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class PolicyRule include Google::Apis::Core::Hashable # The policy that YouTube should enforce if the rule's conditions are all valid # for an asset or for an attempt to view that asset on YouTube. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # A set of conditions that must be met for the rule's action (and subactions) to # be enforced. For a rule to be valid, all of its conditions must be met. # Corresponds to the JSON property `conditions` # @return [Google::Apis::YoutubePartnerV1::Conditions] attr_accessor :conditions # A list of additional actions that YouTube should take if the conditions in the # rule are met. # Corresponds to the JSON property `subaction` # @return [Array] attr_accessor :subaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) @conditions = args[:conditions] if args.key?(:conditions) @subaction = args[:subaction] if args.key?(:subaction) end end # class PromotedContent include Google::Apis::Core::Hashable # A list of link targets that will be used to generate the annotation link that # appears on videos included in the campaign. If more than one link is # specified, the link that is displayed to viewers will be randomly selected # from the list. # Corresponds to the JSON property `link` # @return [Array] attr_accessor :link def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @link = args[:link] if args.key?(:link) end end # class Publisher include Google::Apis::Core::Hashable # The publisher's unique CAE (Compositeur, Auteur and Editeur) number. # Corresponds to the JSON property `caeNumber` # @return [String] attr_accessor :cae_number # A value that YouTube assigns and uses to uniquely identify the publisher. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The publisher's unique IPI (Interested Parties Information) code. # Corresponds to the JSON property `ipiNumber` # @return [String] attr_accessor :ipi_number # The type of the API resource. For this resource, the value is youtubePartner# # publisher. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The publisher's name. # 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) @cae_number = args[:cae_number] if args.key?(:cae_number) @id = args[:id] if args.key?(:id) @ipi_number = args[:ipi_number] if args.key?(:ipi_number) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # class PublisherList include Google::Apis::Core::Hashable # A list of publishers that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # publisherList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @page_info = args[:page_info] if args.key?(:page_info) end end # class Rating include Google::Apis::Core::Hashable # The rating that the asset received. # Corresponds to the JSON property `rating` # @return [String] attr_accessor :rating # The rating system associated with the rating. # Corresponds to the JSON property `ratingSystem` # @return [String] attr_accessor :rating_system def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @rating = args[:rating] if args.key?(:rating) @rating_system = args[:rating_system] if args.key?(:rating_system) end end # class Reference include Google::Apis::Core::Hashable # The ID that uniquely identifies the asset that the reference is associated # with. # Corresponds to the JSON property `assetId` # @return [String] attr_accessor :asset_id # Set this field's value to true to indicate that the reference content should # be included in YouTube's AudioSwap program. # Corresponds to the JSON property `audioswapEnabled` # @return [Boolean] attr_accessor :audioswap_enabled alias_method :audioswap_enabled?, :audioswap_enabled # This field is present if the reference was created by associating an asset # with an existing YouTube video that was uploaded to a YouTube channel linked # to your CMS account. In that case, this field contains the ID of the claim # representing the resulting association between the asset and the video. # Corresponds to the JSON property `claimId` # @return [String] attr_accessor :claim_id # The type of content that the reference represents. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # The ID that uniquely identifies the reference that this reference duplicates. # This field is only present if the reference's status is inactive with reason # REASON_DUPLICATE_FOR_OWNERS. # Corresponds to the JSON property `duplicateLeader` # @return [String] attr_accessor :duplicate_leader # The list of time intervals from this reference that will be ignored during the # match process. # Corresponds to the JSON property `excludedIntervals` # @return [Array] attr_accessor :excluded_intervals # When uploading a reference, set this value to true to indicate that the # reference is a pre-generated fingerprint. # Corresponds to the JSON property `fpDirect` # @return [Boolean] attr_accessor :fp_direct alias_method :fp_direct?, :fp_direct # The MD5 hashcode of the reference content. # Corresponds to the JSON property `hashCode` # @return [String] attr_accessor :hash_code # A value that YouTube assigns and uses to uniquely identify a reference. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Set this value to true to indicate that the reference should not be used to # generate claims. This field is only used on AudioSwap references. # Corresponds to the JSON property `ignoreFpMatch` # @return [Boolean] attr_accessor :ignore_fp_match alias_method :ignore_fp_match?, :ignore_fp_match # The type of the API resource. For reference resources, the value is # youtubePartner#reference. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The length of the reference in seconds. # Corresponds to the JSON property `length` # @return [Float] attr_accessor :length # The origination object contains information that describes the reference # source. # Corresponds to the JSON property `origination` # @return [Google::Apis::YoutubePartnerV1::Origination] attr_accessor :origination # The reference's status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # An explanation of how a reference entered its current state. This value is # only present if the reference's status is either inactive or deleted. # Corresponds to the JSON property `statusReason` # @return [String] attr_accessor :status_reason # Set this value to true to indicate that YouTube should prioritize Content ID # processing for a video file. YouTube processes urgent video files before other # files that are not marked as urgent. This setting is primarily used for videos # of live events or other videos that require time-sensitive processing. The # sooner YouTube completes Content ID processing for a video, the sooner YouTube # can match user-uploaded videos to that video. # Note that marking all of your files as urgent could delay processing for those # files. # Corresponds to the JSON property `urgent` # @return [Boolean] attr_accessor :urgent alias_method :urgent?, :urgent # This field is present if the reference was created by associating an asset # with an existing YouTube video that was uploaded to a YouTube channel linked # to your CMS account. In that case, this field contains the ID of the source # video. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @asset_id = args[:asset_id] if args.key?(:asset_id) @audioswap_enabled = args[:audioswap_enabled] if args.key?(:audioswap_enabled) @claim_id = args[:claim_id] if args.key?(:claim_id) @content_type = args[:content_type] if args.key?(:content_type) @duplicate_leader = args[:duplicate_leader] if args.key?(:duplicate_leader) @excluded_intervals = args[:excluded_intervals] if args.key?(:excluded_intervals) @fp_direct = args[:fp_direct] if args.key?(:fp_direct) @hash_code = args[:hash_code] if args.key?(:hash_code) @id = args[:id] if args.key?(:id) @ignore_fp_match = args[:ignore_fp_match] if args.key?(:ignore_fp_match) @kind = args[:kind] if args.key?(:kind) @length = args[:length] if args.key?(:length) @origination = args[:origination] if args.key?(:origination) @status = args[:status] if args.key?(:status) @status_reason = args[:status_reason] if args.key?(:status_reason) @urgent = args[:urgent] if args.key?(:urgent) @video_id = args[:video_id] if args.key?(:video_id) end end # class ReferenceConflict include Google::Apis::Core::Hashable # An id of a conflicting reference. # Corresponds to the JSON property `conflictingReferenceId` # @return [String] attr_accessor :conflicting_reference_id # Conflict review expiry time. # Corresponds to the JSON property `expiryTime` # @return [DateTime] attr_accessor :expiry_time # A value that YouTube assigns and uses to uniquely identify a reference # conflict. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For referenceConflict resources, the value is # youtubePartner#referenceConflict. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The list of matches between conflicting and original references at the time of # conflict creation. # Corresponds to the JSON property `matches` # @return [Array] attr_accessor :matches # An id of an original reference. # Corresponds to the JSON property `originalReferenceId` # @return [String] attr_accessor :original_reference_id # The referenceConflict's status. # 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) @conflicting_reference_id = args[:conflicting_reference_id] if args.key?(:conflicting_reference_id) @expiry_time = args[:expiry_time] if args.key?(:expiry_time) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @matches = args[:matches] if args.key?(:matches) @original_reference_id = args[:original_reference_id] if args.key?(:original_reference_id) @status = args[:status] if args.key?(:status) end end # class ReferenceConflictListResponse include Google::Apis::Core::Hashable # A list of reference conflicts that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # referenceConflictList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @page_info = args[:page_info] if args.key?(:page_info) end end # class ReferenceConflictMatch include Google::Apis::Core::Hashable # Conflicting reference offset in milliseconds. # Corresponds to the JSON property `conflicting_reference_offset_ms` # @return [Fixnum] attr_accessor :conflicting_reference_offset_ms # Match length in milliseconds. # Corresponds to the JSON property `length_ms` # @return [Fixnum] attr_accessor :length_ms # Original reference offset in milliseconds. # Corresponds to the JSON property `original_reference_offset_ms` # @return [Fixnum] attr_accessor :original_reference_offset_ms # The referenceConflictMatch's 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) @conflicting_reference_offset_ms = args[:conflicting_reference_offset_ms] if args.key?(:conflicting_reference_offset_ms) @length_ms = args[:length_ms] if args.key?(:length_ms) @original_reference_offset_ms = args[:original_reference_offset_ms] if args.key?(:original_reference_offset_ms) @type = args[:type] if args.key?(:type) end end # class ReferenceListResponse include Google::Apis::Core::Hashable # A list of references that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # referenceList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @page_info = args[:page_info] if args.key?(:page_info) end end # class Requirements include Google::Apis::Core::Hashable # This value indicates whether the order requires closed captions. # Corresponds to the JSON property `caption` # @return [Boolean] attr_accessor :caption alias_method :caption?, :caption # This value indicates whether the order requires HD-quality video. # Corresponds to the JSON property `hdTranscode` # @return [Boolean] attr_accessor :hd_transcode alias_method :hd_transcode?, :hd_transcode # This value indicates whether the order requires poster artwork. # Corresponds to the JSON property `posterArt` # @return [Boolean] attr_accessor :poster_art alias_method :poster_art?, :poster_art # This value indicates whether the order requires spotlight artwork. # Corresponds to the JSON property `spotlightArt` # @return [Boolean] attr_accessor :spotlight_art alias_method :spotlight_art?, :spotlight_art # This value indicates whether the spotlight artwork for the order needs to be # reviewed. # Corresponds to the JSON property `spotlightReview` # @return [Boolean] attr_accessor :spotlight_review alias_method :spotlight_review?, :spotlight_review # This value indicates whether the order requires a trailer. # Corresponds to the JSON property `trailer` # @return [Boolean] attr_accessor :trailer alias_method :trailer?, :trailer def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @caption = args[:caption] if args.key?(:caption) @hd_transcode = args[:hd_transcode] if args.key?(:hd_transcode) @poster_art = args[:poster_art] if args.key?(:poster_art) @spotlight_art = args[:spotlight_art] if args.key?(:spotlight_art) @spotlight_review = args[:spotlight_review] if args.key?(:spotlight_review) @trailer = args[:trailer] if args.key?(:trailer) end end # class RightsOwnership include Google::Apis::Core::Hashable # A list that identifies the owners of an asset and the territories where each # owner has ownership. General asset ownership is used for all types of assets # and is the only type of ownership data that can be provided for assets that # are not compositions. # Note: You cannot specify general ownership rights and also specify either # mechanical, performance, or synchronization rights. # Corresponds to the JSON property `general` # @return [Array] attr_accessor :general # The type of the API resource. For rightsOwnership resources, the value is # youtubePartner#rightsOwnership. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A list that identifies owners of the mechanical rights for a composition asset. # Corresponds to the JSON property `mechanical` # @return [Array] attr_accessor :mechanical # A list that identifies owners of the performance rights for a composition # asset. # Corresponds to the JSON property `performance` # @return [Array] attr_accessor :performance # A list that identifies owners of the synchronization rights for a composition # asset. # Corresponds to the JSON property `synchronization` # @return [Array] attr_accessor :synchronization def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @general = args[:general] if args.key?(:general) @kind = args[:kind] if args.key?(:kind) @mechanical = args[:mechanical] if args.key?(:mechanical) @performance = args[:performance] if args.key?(:performance) @synchronization = args[:synchronization] if args.key?(:synchronization) end end # class RightsOwnershipHistory include Google::Apis::Core::Hashable # The type of the API resource. For ownership history resources, the value is # youtubePartner#rightsOwnershipHistory. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The origination object contains information that describes the metadata source. # Corresponds to the JSON property `origination` # @return [Google::Apis::YoutubePartnerV1::Origination] attr_accessor :origination # The ownership object contains the ownership data provided by the specified # source (origination) at the specified time (timeProvided). # Corresponds to the JSON property `ownership` # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] attr_accessor :ownership # The time that the ownership data was provided. # Corresponds to the JSON property `timeProvided` # @return [DateTime] attr_accessor :time_provided def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @origination = args[:origination] if args.key?(:origination) @ownership = args[:ownership] if args.key?(:ownership) @time_provided = args[:time_provided] if args.key?(:time_provided) end end # class Segment include Google::Apis::Core::Hashable # The duration of the segment in milliseconds. # Corresponds to the JSON property `duration` # @return [Fixnum] attr_accessor :duration # The type of the API resource. For segment resources, the value is # youtubePartner#segment. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The start time of the segment, measured in milliseconds from the beginning. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @duration = args[:duration] if args.key?(:duration) @kind = args[:kind] if args.key?(:kind) @start = args[:start] if args.key?(:start) end end # class ShowDetails include Google::Apis::Core::Hashable # The episode number associated with the episode. # Corresponds to the JSON property `episodeNumber` # @return [String] attr_accessor :episode_number # The episode's title. # Corresponds to the JSON property `episodeTitle` # @return [String] attr_accessor :episode_title # The season number associated with the episode. # Corresponds to the JSON property `seasonNumber` # @return [String] attr_accessor :season_number # The show's title # 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) @episode_number = args[:episode_number] if args.key?(:episode_number) @episode_title = args[:episode_title] if args.key?(:episode_title) @season_number = args[:season_number] if args.key?(:season_number) @title = args[:title] if args.key?(:title) end end # class SpreadsheetTemplate include Google::Apis::Core::Hashable # The type of the API resource. For spreadsheet template resources, the value is # youtubePartner#spreadsheetTemplate. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The template status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The template content. # Corresponds to the JSON property `templateContent` # @return [String] attr_accessor :template_content # The template name. # Corresponds to the JSON property `templateName` # @return [String] attr_accessor :template_name # The template type. # Corresponds to the JSON property `templateType` # @return [String] attr_accessor :template_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) @template_content = args[:template_content] if args.key?(:template_content) @template_name = args[:template_name] if args.key?(:template_name) @template_type = args[:template_type] if args.key?(:template_type) end end # class SpreadsheetTemplateListResponse include Google::Apis::Core::Hashable # A list of spreadsheet templates (youtubePartner#spreadsheetTemplate) resources # that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # spreadsheetTemplateList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The status of the API response. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) end end # class StateCompleted include Google::Apis::Core::Hashable # The state that the order entered. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # The time that the state transition occurred. # Corresponds to the JSON property `timeCompleted` # @return [Fixnum] attr_accessor :time_completed def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @state = args[:state] if args.key?(:state) @time_completed = args[:time_completed] if args.key?(:time_completed) end end # class StatusReport include Google::Apis::Core::Hashable # The content of the report message. Used only in Hybrid. # Corresponds to the JSON property `statusContent` # @return [String] attr_accessor :status_content # Status file name. Used only in Hybrid. # Corresponds to the JSON property `statusFileName` # @return [String] attr_accessor :status_file_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @status_content = args[:status_content] if args.key?(:status_content) @status_file_name = args[:status_file_name] if args.key?(:status_file_name) end end # class TerritoryCondition include Google::Apis::Core::Hashable # A list of territories. Each territory is an ISO 3166 two-letter country code.. # Corresponds to the JSON property `territories` # @return [Array] attr_accessor :territories # This field indicates whether the associated policy rule is or is not valid in # the specified territories. # 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) @territories = args[:territories] if args.key?(:territories) @type = args[:type] if args.key?(:type) end end # class TerritoryConflicts include Google::Apis::Core::Hashable # A list of conflicting ownerships. # Corresponds to the JSON property `conflictingOwnership` # @return [Array] attr_accessor :conflicting_ownership # A territories where the ownership conflict is present. Territory is an ISO # 3166 two-letter country code.. # Corresponds to the JSON property `territory` # @return [String] attr_accessor :territory def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @conflicting_ownership = args[:conflicting_ownership] if args.key?(:conflicting_ownership) @territory = args[:territory] if args.key?(:territory) end end # class TerritoryOwners include Google::Apis::Core::Hashable # The name of the asset's owner or rights administrator. # Corresponds to the JSON property `owner` # @return [String] attr_accessor :owner # The name of the asset's publisher. This field is only used for composition # assets, and it is used when the asset owner is not known to have a formal # relationship established with YouTube. # Corresponds to the JSON property `publisher` # @return [String] attr_accessor :publisher # The percentage of the asset that the owner controls or administers. For # composition assets, the value can be any value between 0 and 100 inclusive. # For all other assets, the only valid values are 100, which indicates that the # owner completely owns the asset in the specified territories, and 0, which # indicates that you are removing ownership of the asset in the specified # territories. # Corresponds to the JSON property `ratio` # @return [Float] attr_accessor :ratio # A list of territories where the owner owns (or does not own) the asset. Each # territory is an ISO 3166 two-letter country code.. # Corresponds to the JSON property `territories` # @return [Array] attr_accessor :territories # This field indicates whether the ownership data applies or does not apply in # the specified territories. # 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) @owner = args[:owner] if args.key?(:owner) @publisher = args[:publisher] if args.key?(:publisher) @ratio = args[:ratio] if args.key?(:ratio) @territories = args[:territories] if args.key?(:territories) @type = args[:type] if args.key?(:type) end end # class Uploader include Google::Apis::Core::Hashable # The type of the API resource. For uploader resources, the value is # youtubePartner#uploader. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The uploader name. # Corresponds to the JSON property `uploaderName` # @return [String] attr_accessor :uploader_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @uploader_name = args[:uploader_name] if args.key?(:uploader_name) end end # class UploaderListResponse include Google::Apis::Core::Hashable # A list of uploader (youtubePartner#uploader) resources that match the request # criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # uploaderList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class ValidateAsyncRequest include Google::Apis::Core::Hashable # The metadata file contents. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The type of the API resource. For this operation, the value is youtubePartner# # validateAsyncRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The uploader name. # Corresponds to the JSON property `uploaderName` # @return [String] attr_accessor :uploader_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content = args[:content] if args.key?(:content) @kind = args[:kind] if args.key?(:kind) @uploader_name = args[:uploader_name] if args.key?(:uploader_name) end end # class ValidateAsyncResponse include Google::Apis::Core::Hashable # The type of the API resource. For this operation, the value is youtubePartner# # validateAsyncResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The validation status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The validation ID. # Corresponds to the JSON property `validationId` # @return [String] attr_accessor :validation_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) @validation_id = args[:validation_id] if args.key?(:validation_id) end end # class ValidateError include Google::Apis::Core::Hashable # The column name where the error occurred. # Corresponds to the JSON property `columnName` # @return [String] attr_accessor :column_name # The column number where the error occurred (1-based). # Corresponds to the JSON property `columnNumber` # @return [Fixnum] attr_accessor :column_number # The line number where the error occurred (1-based). # Corresponds to the JSON property `lineNumber` # @return [Fixnum] attr_accessor :line_number # The error message. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message # The code for the error message (if one exists). # Corresponds to the JSON property `messageCode` # @return [Fixnum] attr_accessor :message_code # The error severity. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_name = args[:column_name] if args.key?(:column_name) @column_number = args[:column_number] if args.key?(:column_number) @line_number = args[:line_number] if args.key?(:line_number) @message = args[:message] if args.key?(:message) @message_code = args[:message_code] if args.key?(:message_code) @severity = args[:severity] if args.key?(:severity) end end # class ValidateRequest include Google::Apis::Core::Hashable # The metadata file contents. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The type of the API resource. For this operation, the value is youtubePartner# # validateRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The desired locale of the error messages as defined in BCP 47 (http://tools. # ietf.org/html/bcp47). For example, "en-US" or "de". If not specified we will # return the error messages in English ("en"). # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # The uploader name. # Corresponds to the JSON property `uploaderName` # @return [String] attr_accessor :uploader_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content = args[:content] if args.key?(:content) @kind = args[:kind] if args.key?(:kind) @locale = args[:locale] if args.key?(:locale) @uploader_name = args[:uploader_name] if args.key?(:uploader_name) end end # class ValidateResponse include Google::Apis::Core::Hashable # The list of errors and/or warnings. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # The type of the API resource. For this operation, the value is youtubePartner# # validateResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The validation status. # 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) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) end end # class ValidateStatusRequest include Google::Apis::Core::Hashable # The type of the API resource. For this operation, the value is youtubePartner# # validateStatusRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The desired locale of the error messages as defined in BCP 47 (http://tools. # ietf.org/html/bcp47). For example, "en-US" or "de". If not specified we will # return the error messages in English ("en"). # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # The validation ID. # Corresponds to the JSON property `validationId` # @return [String] attr_accessor :validation_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @locale = args[:locale] if args.key?(:locale) @validation_id = args[:validation_id] if args.key?(:validation_id) end end # class ValidateStatusResponse include Google::Apis::Core::Hashable # The list of errors and/or warnings. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # If this is a metadata-only package. # Corresponds to the JSON property `isMetadataOnly` # @return [Boolean] attr_accessor :is_metadata_only alias_method :is_metadata_only?, :is_metadata_only # The type of the API resource. For this operation, the value is youtubePartner# # validateStatusResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The validation status. # 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) @errors = args[:errors] if args.key?(:errors) @is_metadata_only = args[:is_metadata_only] if args.key?(:is_metadata_only) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) end end # class VideoAdvertisingOption include Google::Apis::Core::Hashable # A list of times when YouTube can show an in-stream advertisement during # playback of the video. # Corresponds to the JSON property `adBreaks` # @return [Array] attr_accessor :ad_breaks # A list of ad formats that the video is allowed to show. # Corresponds to the JSON property `adFormats` # @return [Array] attr_accessor :ad_formats # Enables this video for automatically generated midroll breaks. # Corresponds to the JSON property `autoGeneratedBreaks` # @return [Boolean] attr_accessor :auto_generated_breaks alias_method :auto_generated_breaks?, :auto_generated_breaks # The point at which the break occurs during the video playback. # Corresponds to the JSON property `breakPosition` # @return [Array] attr_accessor :break_position # The ID that YouTube uses to uniquely identify the video associated with the # advertising settings. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For this resource, the value is youtubePartner# # videoAdvertisingOption. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A value that uniquely identifies the video to the third-party ad server. # Corresponds to the JSON property `tpAdServerVideoId` # @return [String] attr_accessor :tp_ad_server_video_id # The base URL for a third-party ad server from which YouTube can retrieve in- # stream ads for the video. # Corresponds to the JSON property `tpTargetingUrl` # @return [String] attr_accessor :tp_targeting_url # A parameter string to append to the end of the request to the third-party ad # server. # Corresponds to the JSON property `tpUrlParameters` # @return [String] attr_accessor :tp_url_parameters def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_breaks = args[:ad_breaks] if args.key?(:ad_breaks) @ad_formats = args[:ad_formats] if args.key?(:ad_formats) @auto_generated_breaks = args[:auto_generated_breaks] if args.key?(:auto_generated_breaks) @break_position = args[:break_position] if args.key?(:break_position) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @tp_ad_server_video_id = args[:tp_ad_server_video_id] if args.key?(:tp_ad_server_video_id) @tp_targeting_url = args[:tp_targeting_url] if args.key?(:tp_targeting_url) @tp_url_parameters = args[:tp_url_parameters] if args.key?(:tp_url_parameters) end end # class VideoAdvertisingOptionGetEnabledAdsResponse include Google::Apis::Core::Hashable # A list of ad breaks that occur in a claimed YouTube video. # Corresponds to the JSON property `adBreaks` # @return [Array] attr_accessor :ad_breaks # This field indicates whether YouTube can show ads when the video is played in # an embedded player. # Corresponds to the JSON property `adsOnEmbeds` # @return [Boolean] attr_accessor :ads_on_embeds alias_method :ads_on_embeds?, :ads_on_embeds # A list that identifies the countries where ads can run and the types of ads # allowed in those countries. # Corresponds to the JSON property `countriesRestriction` # @return [Array] attr_accessor :countries_restriction # The ID that YouTube uses to uniquely identify the claimed video. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For this resource, the value is youtubePartner# # videoAdvertisingOptionGetEnabledAds. # 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) @ad_breaks = args[:ad_breaks] if args.key?(:ad_breaks) @ads_on_embeds = args[:ads_on_embeds] if args.key?(:ads_on_embeds) @countries_restriction = args[:countries_restriction] if args.key?(:countries_restriction) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) end end # class Whitelist include Google::Apis::Core::Hashable # The YouTube channel ID that uniquely identifies the whitelisted channel. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the API resource. For whitelist resources, this value is # youtubePartner#whitelist. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Title of the whitelisted YouTube channel. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @title = args[:title] if args.key?(:title) end end # class WhitelistListResponse include Google::Apis::Core::Hashable # A list of whitelist resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of the API response. For this operation, the value is youtubePartner# # whitelistList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @page_info = args[:page_info] if args.key?(:page_info) end end end end end google-api-client-0.19.8/generated/google/apis/youtube_partner_v1/service.rb0000644000004100000410000070035013252673044027143 0ustar www-datawww-data# 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 YoutubePartnerV1 # Youtube Content ID API # # API for YouTube partners. To use this API YouTube CMS account is required. # # @example # require 'google/apis/youtube_partner_v1' # # YoutubePartner = Google::Apis::YoutubePartnerV1 # Alias the module # service = YoutubePartner::YouTubePartnerService.new # # @see https://developers.google.com/youtube/partner/ class YouTubePartnerService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'youtube/partner/v1/') @batch_path = 'batch/youtubePartner/v1' end # Insert an asset label for an owner. # @param [Google::Apis::YoutubePartnerV1::AssetLabel] asset_label_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetLabel] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::AssetLabel] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset_label(asset_label_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'assetLabels', options) command.request_representation = Google::Apis::YoutubePartnerV1::AssetLabel::Representation command.request_object = asset_label_object command.response_representation = Google::Apis::YoutubePartnerV1::AssetLabel::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetLabel command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 all asset labels for an owner. # @param [String] label_prefix # The labelPrefix parameter identifies the prefix of asset labels to retrieve. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] q # The q parameter specifies the query string to use to filter search results. # YouTube searches for the query string in the labelName field of asset labels. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetLabelListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::AssetLabelListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset_labels(label_prefix: nil, on_behalf_of_content_owner: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'assetLabels', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetLabelListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetLabelListResponse command.query['labelPrefix'] = label_prefix unless label_prefix.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['q'] = q unless q.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 the match policy assigned to the specified asset by the content # owner associated with the authenticated user. This information is only # accessible to an owner of the asset. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset for which # you are retrieving the match policy. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset_match_policy(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'assets/{assetId}/matchPolicy', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetMatchPolicy command.params['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 asset's match policy. If an asset has multiple owners, each owner # may set its own match policy for the asset. YouTube then computes the match # policy that is actually applied for the asset based on the territories where # each owner owns the asset. This method supports patch semantics. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset for which # you are retrieving the match policy. # @param [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] asset_match_policy_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'assets/{assetId}/matchPolicy', options) command.request_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation command.request_object = asset_match_policy_object command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetMatchPolicy command.params['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 asset's match policy. If an asset has multiple owners, each owner # may set its own match policy for the asset. YouTube then computes the match # policy that is actually applied for the asset based on the territories where # each owner owns the asset. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset for which # you are retrieving the match policy. # @param [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] asset_match_policy_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'assets/{assetId}/matchPolicy', options) command.request_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation command.request_object = asset_match_policy_object command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetMatchPolicy command.params['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 a relationship between two assets. # @param [String] asset_relationship_id # The assetRelationshipId parameter specifies a value that uniquely identifies # the relationship you are deleting. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_asset_relationship(asset_relationship_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'assetRelationships/{assetRelationshipId}', options) command.params['assetRelationshipId'] = asset_relationship_id unless asset_relationship_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 relationship that links two assets. # @param [Google::Apis::YoutubePartnerV1::AssetRelationship] asset_relationship_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetRelationship] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::AssetRelationship] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset_relationship(asset_relationship_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'assetRelationships', options) command.request_representation = Google::Apis::YoutubePartnerV1::AssetRelationship::Representation command.request_object = asset_relationship_object command.response_representation = Google::Apis::YoutubePartnerV1::AssetRelationship::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetRelationship command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 relationships for a given asset. The list contains # relationships where the specified asset is either the parent (embedding) or # child (embedded) asset in the relationship. # @param [String] asset_id # The assetId parameter specifies the asset ID of the asset for which you are # retrieving relationships. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] page_token # The pageToken parameter specifies a token that identifies a particular page of # results to return. Set this parameter to the value of the nextPageToken value # from the previous API response to retrieve the next page of search results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset_relationships(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'assetRelationships', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse command.query['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Searches for assets based on asset metadata. The method can retrieve all # assets or only assets owned by the content owner. This method mimics the # functionality of the advanced search feature on the Assets page in CMS. # @param [DateTime] created_after # The createdAfter parameter restricts the set of returned assets to ones # originally created on or after the specified datetime. For example: 2015-01- # 29T23:00:00Z # @param [DateTime] created_before # The createdBefore parameter restricts the set of returned assets to ones # originally created on or before the specified datetime. For example: 2015-01- # 29T23:00:00Z # @param [Boolean] has_conflicts # The hasConflicts parameter enables you to only retrieve assets that have # ownership conflicts. The only valid value is true. Setting the parameter value # to false does not affect the results. # @param [Boolean] include_any_providedlabel # If includeAnyProvidedlabel parameter is set to true, will search for assets # that contain any of the provided labels; else will search for assets that # contain all the provided labels. # @param [String] isrcs # A comma-separated list of up to 50 ISRCs. If you specify a value for this # parameter, the API server ignores any values set for the following parameters: # q, includeAnyProvidedLabel, hasConflicts, labels, metadataSearchFields, sort, # and type. # @param [String] labels # The labels parameter specifies the assets with certain asset labels that you # want to retrieve. The parameter value is a comma-separated list of asset # labels. # @param [String] metadata_search_fields # The metadataSearchField parameter specifies which metadata fields to search by. # It is a comma-separated list of metadata field and value pairs connected by # colon(:). For example: customId:my_custom_id,artist:Dandexx # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] ownership_restriction # The ownershipRestriction parameter specifies the ownership filtering option # for the search. By default the search is performed in the assets owned by # currently authenticated user only. # @param [String] page_token # The pageToken parameter specifies a token that identifies a particular page of # results to return. Set this parameter to the value of the nextPageToken value # from the previous API response to retrieve the next page of search results. # @param [String] q # YouTube searches within the id, type, and customId fields for all assets as # well as in numerous other metadata fields – such as actor, album, director, # isrc, and tmsId – that vary for different types of assets (movies, music # videos, etc.). # @param [String] sort # The sort parameter specifies how the search results should be sorted. Note # that results are always sorted in descending order. # @param [String] type # The type parameter specifies the types of assets that you want to retrieve. # The parameter value is a comma-separated list of asset types. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetSearchResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::AssetSearchResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset_searches(created_after: nil, created_before: nil, has_conflicts: nil, include_any_providedlabel: nil, isrcs: nil, labels: nil, metadata_search_fields: nil, on_behalf_of_content_owner: nil, ownership_restriction: nil, page_token: nil, q: nil, sort: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'assetSearch', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetSearchResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetSearchResponse command.query['createdAfter'] = created_after unless created_after.nil? command.query['createdBefore'] = created_before unless created_before.nil? command.query['hasConflicts'] = has_conflicts unless has_conflicts.nil? command.query['includeAnyProvidedlabel'] = include_any_providedlabel unless include_any_providedlabel.nil? command.query['isrcs'] = isrcs unless isrcs.nil? command.query['labels'] = labels unless labels.nil? command.query['metadataSearchFields'] = metadata_search_fields unless metadata_search_fields.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['ownershipRestriction'] = ownership_restriction unless ownership_restriction.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['q'] = q unless q.nil? command.query['sort'] = sort unless sort.nil? command.query['type'] = type unless 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 # This method either retrieves a list of asset shares the partner owns and that # map to a specified asset view ID or it retrieves a list of asset views # associated with a specified asset share ID owned by the partner. # @param [String] asset_id # The assetId parameter specifies the asset ID for which you are retrieving data. # The parameter can be an asset view ID or an asset share ID. # - If the value is an asset view ID, the API response identifies any asset # share ids mapped to the asset view. # - If the value is an asset share ID, the API response identifies any asset # view ids that maps to that asset share. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] page_token # The pageToken parameter specifies a token that identifies a particular page of # results to return. Set this parameter to the value of the nextPageToken value # from the previous API response to retrieve the next page of search results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetShareListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::AssetShareListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset_shares(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'assetShares', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetShareListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetShareListResponse command.query['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Retrieves the metadata for the specified asset. Note that if the request # identifies an asset that has been merged with another asset, meaning that # YouTube identified the requested asset as a duplicate, then the request # retrieves the merged, or synthesized, asset. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset being # retrieved. # @param [String] fetch_match_policy # The fetchMatchPolicy parameter specifies the version of the asset's match # policy that should be returned in the API response. # @param [String] fetch_metadata # The fetchMetadata parameter specifies the version of the asset's metadata that # should be returned in the API response. In some cases, YouTube receives # metadata for an asset from multiple sources, such as when different partners # own the asset in different territories. # @param [String] fetch_ownership # The fetchOwnership parameter specifies the version of the asset's ownership # data that should be returned in the API response. As with asset metadata, # YouTube can receive asset ownership data from multiple sources. # @param [Boolean] fetch_ownership_conflicts # The fetchOwnershipConflicts parameter allows you to retrieve information about # ownership conflicts. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Asset] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Asset] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset(asset_id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'assets/{assetId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.response_class = Google::Apis::YoutubePartnerV1::Asset command.params['assetId'] = asset_id unless asset_id.nil? command.query['fetchMatchPolicy'] = fetch_match_policy unless fetch_match_policy.nil? command.query['fetchMetadata'] = fetch_metadata unless fetch_metadata.nil? command.query['fetchOwnership'] = fetch_ownership unless fetch_ownership.nil? command.query['fetchOwnershipConflicts'] = fetch_ownership_conflicts unless fetch_ownership_conflicts.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Inserts an asset with the specified metadata. After inserting an asset, you # can set its ownership data and match policy. # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Asset] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Asset] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset(asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'assets', options) command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.request_object = asset_object command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.response_class = Google::Apis::YoutubePartnerV1::Asset command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 assets based on asset metadata. The method can retrieve # all assets or only assets owned by the content owner. # Note that in cases where duplicate assets have been merged, the API response # only contains the synthesized asset. (It does not contain the constituent # assets that were merged into the synthesized asset.) # @param [String] id # The id parameter specifies a comma-separated list of YouTube Asset IDs that # identify the assets you want to retrieve. As noted in the method description, # if you try to retrieve an asset that YouTube identified as a duplicate and # merged with another asset, the API response only returns the synthesized asset. # In that case, the aliasId property in the asset resource specifies a list of # other asset IDs that can be used to identify that asset. # Also note that the API response does not contain duplicates. As such, if your # request identifies three asset IDs, and all of those have been merged into a # single asset, then the API response identifies one matching asset. # @param [String] fetch_match_policy # The fetchMatchPolicy parameter specifies the version of the asset's match # policy that should be returned in the API response. # @param [String] fetch_metadata # The fetchMetadata parameter specifies the version of the asset's metadata that # should be returned in the API response. In some cases, YouTube receives # metadata for an asset from multiple sources, such as when different partners # own the asset in different territories. # @param [String] fetch_ownership # The fetchOwnership parameter specifies the version of the asset's ownership # data that should be returned in the API response. As with asset metadata, # YouTube can receive asset ownership data from multiple sources. # @param [Boolean] fetch_ownership_conflicts # The fetchOwnershipConflicts parameter allows you to retrieve information about # ownership conflicts. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::AssetListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::AssetListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_assets(id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'assets', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetListResponse command.query['fetchMatchPolicy'] = fetch_match_policy unless fetch_match_policy.nil? command.query['fetchMetadata'] = fetch_metadata unless fetch_metadata.nil? command.query['fetchOwnership'] = fetch_ownership unless fetch_ownership.nil? command.query['fetchOwnershipConflicts'] = fetch_ownership_conflicts unless fetch_ownership_conflicts.nil? command.query['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 metadata for the specified asset. This method supports patch # semantics. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset being # updated. # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Asset] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Asset] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'assets/{assetId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.request_object = asset_object command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.response_class = Google::Apis::YoutubePartnerV1::Asset command.params['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 metadata for the specified asset. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset being # updated. # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Asset] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Asset] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'assets/{assetId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.request_object = asset_object command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.response_class = Google::Apis::YoutubePartnerV1::Asset command.params['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 a specified campaign for an owner. # @param [String] campaign_id # The campaignId parameter specifies the YouTube campaign ID of the campaign # being deleted. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'campaigns/{campaignId}', options) command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 particular campaign for an owner. # @param [String] campaign_id # The campaignId parameter specifies the YouTube campaign ID of the campaign # being retrieved. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::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_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'campaigns/{campaignId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.response_class = Google::Apis::YoutubePartnerV1::Campaign command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Insert a new campaign for an owner using the specified campaign data. # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::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 insert_campaign(campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'campaigns', options) command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.response_class = Google::Apis::YoutubePartnerV1::Campaign command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 campaigns for an owner. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] page_token # The pageToken parameter specifies a token that identifies a particular page of # results to return. For example, set this parameter to the value of the # nextPageToken value from the previous API response to retrieve the next page # of search results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::CampaignList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::CampaignList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_campaigns(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'campaigns', options) command.response_representation = Google::Apis::YoutubePartnerV1::CampaignList::Representation command.response_class = Google::Apis::YoutubePartnerV1::CampaignList command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Update the data for a specific campaign. This method supports patch semantics. # @param [String] campaign_id # The campaignId parameter specifies the YouTube campaign ID of the campaign # being retrieved. # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::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_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'campaigns/{campaignId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.response_class = Google::Apis::YoutubePartnerV1::Campaign command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Update the data for a specific campaign. # @param [String] campaign_id # The campaignId parameter specifies the YouTube campaign ID of the campaign # being retrieved. # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::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 update_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'campaigns/{campaignId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.response_class = Google::Apis::YoutubePartnerV1::Campaign command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 the claim history for a specified claim. # @param [String] claim_id # The claimId parameter specifies the YouTube claim ID of the claim for which # you are retrieving the claim history. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ClaimHistory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ClaimHistory] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_claim_history(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'claimHistory/{claimId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::ClaimHistory::Representation command.response_class = Google::Apis::YoutubePartnerV1::ClaimHistory command.params['claimId'] = claim_id unless claim_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 claims that match the search criteria. You can search for # claims that are associated with a specific asset or video or that match a # specified query string. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset for which # you are retrieving claims. # @param [String] content_type # The contentType parameter specifies the content type of claims that you want # to retrieve. # @param [DateTime] created_after # The createdAfter parameter allows you to restrict the set of returned claims # to ones created on or after the specified date (inclusive). # @param [DateTime] created_before # The createdBefore parameter allows you to restrict the set of returned claims # to ones created before the specified date (exclusive). # @param [String] inactive_reasons # The inactiveReasons parameter allows you to specify what kind of inactive # claims you want to find based on the reasons why the claims became inactive. # @param [Boolean] include_third_party_claims # Used along with the videoId parameter this parameter determines whether or not # to include third party claims in the search results. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] origin # The origin parameter specifies the origins you want to find claims for. It is # a comma-separated list of origin values. # @param [String] page_token # The pageToken parameter specifies a token that identifies a particular page of # results to return. For example, set this parameter to the value of the # nextPageToken value from the previous API response to retrieve the next page # of search results. # @param [Boolean] partner_uploaded # The partnerUploaded parameter specifies whether you want to filter your search # results to only partner uploaded or non partner uploaded claims. # @param [String] q # The q parameter specifies the query string to use to filter search results. # YouTube searches for the query string in the following claim fields: # video_title, video_keywords, user_name, isrc, iswc, grid, custom_id, and in # the content owner's email address. # @param [String] reference_id # The referenceId parameter specifies the YouTube reference ID of the reference # for which you are retrieving claims. # @param [String] sort # The sort parameter specifies the method that will be used to order resources # in the API response. The default value is date. However, if the status # parameter value is either appealed, disputed, pending, potential, or # routedForReview, then results will be sorted by the time that the claim review # period expires. # @param [String] status # The status parameter restricts your results to only claims in the specified # status. # @param [DateTime] status_modified_after # The statusModifiedAfter parameter allows you to restrict the result set to # only include claims that have had their status modified on or after the # specified date (inclusive). The date specified must be on or after June 30, # 2016 (2016-06-30). The parameter value's format is YYYY-MM-DD. # @param [DateTime] status_modified_before # The statusModifiedBefore parameter allows you to restrict the result set to # only include claims that have had their status modified before the specified # date (exclusive). The date specified must be on or after July 1, 2016 (2016-07- # 01). The parameter value's format is YYYY-MM-DD. # @param [String] video_id # The videoId parameter specifies comma-separated list of YouTube video IDs for # which you are retrieving claims. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ClaimSearchResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ClaimSearchResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_claim_searches(asset_id: nil, content_type: nil, created_after: nil, created_before: nil, inactive_reasons: nil, include_third_party_claims: nil, on_behalf_of_content_owner: nil, origin: nil, page_token: nil, partner_uploaded: nil, q: nil, reference_id: nil, sort: nil, status: nil, status_modified_after: nil, status_modified_before: nil, video_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'claimSearch', options) command.response_representation = Google::Apis::YoutubePartnerV1::ClaimSearchResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ClaimSearchResponse command.query['assetId'] = asset_id unless asset_id.nil? command.query['contentType'] = content_type unless content_type.nil? command.query['createdAfter'] = created_after unless created_after.nil? command.query['createdBefore'] = created_before unless created_before.nil? command.query['inactiveReasons'] = inactive_reasons unless inactive_reasons.nil? command.query['includeThirdPartyClaims'] = include_third_party_claims unless include_third_party_claims.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['origin'] = origin unless origin.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['partnerUploaded'] = partner_uploaded unless partner_uploaded.nil? command.query['q'] = q unless q.nil? command.query['referenceId'] = reference_id unless reference_id.nil? command.query['sort'] = sort unless sort.nil? command.query['status'] = status unless status.nil? command.query['statusModifiedAfter'] = status_modified_after unless status_modified_after.nil? command.query['statusModifiedBefore'] = status_modified_before unless status_modified_before.nil? command.query['videoId'] = video_id unless video_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 specific claim by ID. # @param [String] claim_id # The claimId parameter specifies the claim ID of the claim being retrieved. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Claim] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Claim] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_claim(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'claims/{claimId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.response_class = Google::Apis::YoutubePartnerV1::Claim command.params['claimId'] = claim_id unless claim_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 claim. The video being claimed must have been uploaded to a channel # associated with the same content owner as the API user sending the request. # You can set the claim's policy in any of the following ways: # - Use the claim resource's policy property to identify a saved policy by its # unique ID. # - Use the claim resource's policy property to specify a custom set of rules. # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object # @param [Boolean] is_manual_claim # restricted # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Claim] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Claim] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_claim(claim_object = nil, is_manual_claim: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'claims', options) command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.request_object = claim_object command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.response_class = Google::Apis::YoutubePartnerV1::Claim command.query['isManualClaim'] = is_manual_claim unless is_manual_claim.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 claims administered by the content owner associated with # the currently authenticated user. Results are sorted in descending order of # creation time. # @param [String] asset_id # Use the claimSearch.list method's assetId parameter to search for claim # snippets by asset ID. You can then retrieve the claim resources for those # claims by using this method's id parameter to specify a comma-separated list # of claim IDs. # @param [String] id # The id parameter specifies a list of comma-separated YouTube claim IDs to # retrieve. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] page_token # The pageToken parameter specifies a token that identifies a particular page of # results to return. For example, set this parameter to the value of the # nextPageToken value from the previous API response to retrieve the next page # of search results. # @param [String] q # Use the claimSearch.list method's q parameter to search for claim snippets # that match a particular query string. You can then retrieve the claim # resources for those claims by using this method's id parameter to specify a # comma-separated list of claim IDs. # @param [String] video_id # Use the claimSearch.list method's videoId parameter to search for claim # snippets by video ID. You can then retrieve the claim resources for those # claims by using this method's id parameter to specify a comma-separated list # of claim IDs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ClaimListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ClaimListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_claims(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, q: nil, video_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'claims', options) command.response_representation = Google::Apis::YoutubePartnerV1::ClaimListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ClaimListResponse command.query['assetId'] = asset_id unless asset_id.nil? command.query['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['q'] = q unless q.nil? command.query['videoId'] = video_id unless video_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 an existing claim by either changing its policy or its status. You can # update a claim's status from active to inactive to effectively release the # claim. This method supports patch semantics. # @param [String] claim_id # The claimId parameter specifies the claim ID of the claim being updated. # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Claim] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Claim] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'claims/{claimId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.request_object = claim_object command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.response_class = Google::Apis::YoutubePartnerV1::Claim command.params['claimId'] = claim_id unless claim_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 claim by either changing its policy or its status. You can # update a claim's status from active to inactive to effectively release the # claim. # @param [String] claim_id # The claimId parameter specifies the claim ID of the claim being updated. # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Claim] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Claim] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'claims/{claimId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.request_object = claim_object command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.response_class = Google::Apis::YoutubePartnerV1::Claim command.params['claimId'] = claim_id unless claim_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 advertising options for the content owner associated with the # authenticated user. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_owner_advertising_option(on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'contentOwnerAdvertisingOptions', options) command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 advertising options for the content owner associated with the # authenticated API user. This method supports patch semantics. # @param [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] content_owner_advertising_option_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_owner_advertising_option(content_owner_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'contentOwnerAdvertisingOptions', options) command.request_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation command.request_object = content_owner_advertising_option_object command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 advertising options for the content owner associated with the # authenticated API user. # @param [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] content_owner_advertising_option_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_owner_advertising_option(content_owner_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'contentOwnerAdvertisingOptions', options) command.request_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation command.request_object = content_owner_advertising_option_object command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 information about the specified content owner. # @param [String] content_owner_id # The contentOwnerId parameter specifies a value that uniquely identifies the # content owner. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ContentOwner] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ContentOwner] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_owner(content_owner_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'contentOwners/{contentOwnerId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwner::Representation command.response_class = Google::Apis::YoutubePartnerV1::ContentOwner command.params['contentOwnerId'] = content_owner_id unless content_owner_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 content owners that match the request criteria. # @param [Boolean] fetch_mine # The fetchMine parameter restricts the result set to content owners associated # with the currently authenticated API user. # @param [String] id # The id parameter specifies a comma-separated list of YouTube content owner IDs # to retrieve. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ContentOwnerListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ContentOwnerListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_owners(fetch_mine: nil, id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'contentOwners', options) command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerListResponse command.query['fetchMine'] = fetch_mine unless fetch_mine.nil? command.query['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Inserts a cuepoint into a live broadcast. # @param [String] channel_id # The channelId parameter identifies the channel that owns the broadcast into # which the cuepoint is being inserted. # @param [Google::Apis::YoutubePartnerV1::LiveCuepoint] live_cuepoint_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. You can obtain the content owner ID # that will serve as the parameter value by calling the YouTube Content ID API's # contentOwners.list method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::LiveCuepoint] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::LiveCuepoint] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_live_cuepoint(channel_id, live_cuepoint_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'liveCuepoints', options) command.request_representation = Google::Apis::YoutubePartnerV1::LiveCuepoint::Representation command.request_object = live_cuepoint_object command.response_representation = Google::Apis::YoutubePartnerV1::LiveCuepoint::Representation command.response_class = Google::Apis::YoutubePartnerV1::LiveCuepoint command.query['channelId'] = channel_id unless channel_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 all metadata provided for an asset, regardless of which # content owner provided the data. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset for which # you are retrieving a metadata history. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metadata_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'metadataHistory', options) command.response_representation = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse command.query['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 order, which moves orders to inactive state and removes any # associated video. # @param [String] order_id # Id of the order to delete. # @param [String] on_behalf_of_content_owner # ContentOwnerId that super admin acts in behalf 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_order(order_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'orders/{orderId}', options) command.params['orderId'] = order_id unless order_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Retrieve the details of an existing order. # @param [String] order_id # The id of the order. # @param [String] on_behalf_of_content_owner # ContentOnwerId that super admin acts in behalf 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Order] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Order] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order(order_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'orders/{orderId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation command.response_class = Google::Apis::YoutubePartnerV1::Order command.params['orderId'] = order_id unless order_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 basic order entry in the YouTube premium asset order management # system. You must supply at least a country and channel in the new order. # @param [Google::Apis::YoutubePartnerV1::Order] order_object # @param [String] on_behalf_of_content_owner # ContentOnwerId that super admin acts in behalf 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Order] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Order] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order(order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'orders', options) command.request_representation = Google::Apis::YoutubePartnerV1::Order::Representation command.request_object = order_object command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation command.response_class = Google::Apis::YoutubePartnerV1::Order command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Return a list of orders, filtered by the parameters below, may return more # than a single page of results. # @param [String] channel_id # Filter results to only a specific channel ( use encrypted ID). # @param [String] content_type # Filter the results by type, possible values are SHOW or MOVIE. # @param [String] country # Filter results by country, two letter ISO country codes are used. # @param [String] custom_id # Filter result by orders that have this custom ID. # @param [String] on_behalf_of_content_owner # ContentOnwerId that super admin acts in behalf of. # @param [String] page_token # The continuation token is an optional value that is only used to page through # large result sets. # - To retrieve the next page of results for a request, set this parameter to # the value of the nextPageToken value from the previous response. # - To get the previous page of results, set this parameter to the value of the # previousPageToken value from the previous response. # @param [String] priority # Filter results by priority. P0, P1, P2, P3 and P4 are the acceptable options. # @param [String] production_house # Filter results by a particular production house. Specified by the name of the # production house. # @param [String] q # Filter results to only orders that contain this string in the title. # @param [String] status # Filter results to have this status, available options are STATUS_AVAILED, # STATUS_ORDERED, STATUS_RECEIVED, STATUS_READY_FOR_QC, STATUS_MOC_FIX, # STATUS_PARTNER_FIX, STATUS_YOUTUBE_FIX, STATUS_QC_APPROVED, STATUS_INACTIVE, # STATUS_INGESTION_COMPLETE, STATUS_REORDERED # @param [String] video_id # Filter results to orders that are associated with this YouTube external video # 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::OrderListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::OrderListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_orders(channel_id: nil, content_type: nil, country: nil, custom_id: nil, on_behalf_of_content_owner: nil, page_token: nil, priority: nil, production_house: nil, q: nil, status: nil, video_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'orders', options) command.response_representation = Google::Apis::YoutubePartnerV1::OrderListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::OrderListResponse command.query['channelId'] = channel_id unless channel_id.nil? command.query['contentType'] = content_type unless content_type.nil? command.query['country'] = country unless country.nil? command.query['customId'] = custom_id unless custom_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['priority'] = priority unless priority.nil? command.query['productionHouse'] = production_house unless production_house.nil? command.query['q'] = q unless q.nil? command.query['status'] = status unless status.nil? command.query['videoId'] = video_id unless video_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 # Update the values in an existing order. This method supports patch semantics. # @param [String] order_id # The id of the order. # @param [Google::Apis::YoutubePartnerV1::Order] order_object # @param [String] on_behalf_of_content_owner # ContentOwnerId that super admin acts in behalf 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Order] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Order] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order(order_id, order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'orders/{orderId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Order::Representation command.request_object = order_object command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation command.response_class = Google::Apis::YoutubePartnerV1::Order command.params['orderId'] = order_id unless order_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Update the values in an existing order. # @param [String] order_id # The id of the order. # @param [Google::Apis::YoutubePartnerV1::Order] order_object # @param [String] on_behalf_of_content_owner # ContentOwnerId that super admin acts in behalf 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Order] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Order] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order(order_id, order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'orders/{orderId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Order::Representation command.request_object = order_object command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation command.response_class = Google::Apis::YoutubePartnerV1::Order command.params['orderId'] = order_id unless order_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 the ownership data provided for the specified asset by the content # owner associated with the authenticated user. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID for which you are # retrieving ownership data. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::RightsOwnership] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ownership(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'assets/{assetId}/ownership', options) command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation command.response_class = Google::Apis::YoutubePartnerV1::RightsOwnership command.params['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Provides new ownership information for the specified asset. Note that YouTube # may receive ownership information from multiple sources. For example, if an # asset has multiple owners, each owner might send ownership data for the asset. # YouTube algorithmically combines the ownership data received from all of those # sources to generate the asset's canonical ownership data, which should provide # the most comprehensive and accurate representation of the asset's ownership. # This method supports patch semantics. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset being # updated. # @param [Google::Apis::YoutubePartnerV1::RightsOwnership] rights_ownership_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::RightsOwnership] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'assets/{assetId}/ownership', options) command.request_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation command.request_object = rights_ownership_object command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation command.response_class = Google::Apis::YoutubePartnerV1::RightsOwnership command.params['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Provides new ownership information for the specified asset. Note that YouTube # may receive ownership information from multiple sources. For example, if an # asset has multiple owners, each owner might send ownership data for the asset. # YouTube algorithmically combines the ownership data received from all of those # sources to generate the asset's canonical ownership data, which should provide # the most comprehensive and accurate representation of the asset's ownership. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset being # updated. # @param [Google::Apis::YoutubePartnerV1::RightsOwnership] rights_ownership_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::RightsOwnership] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'assets/{assetId}/ownership', options) command.request_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation command.request_object = rights_ownership_object command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation command.response_class = Google::Apis::YoutubePartnerV1::RightsOwnership command.params['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 the ownership data for an asset, regardless of which # content owner provided the data. The list only includes the most recent # ownership data for each content owner. However, if the content owner has # submitted ownership data through multiple data sources (API, content feeds, # etc.), the list will contain the most recent data for each content owner and # data source. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset for which # you are retrieving an ownership data history. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ownership_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'ownershipHistory', options) command.response_representation = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse command.query['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 information for the specified package. # @param [String] package_id # The packageId parameter specifies the Content Delivery package ID of the # package being retrieved. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Package] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Package] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_package(package_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'package/{packageId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Package::Representation command.response_class = Google::Apis::YoutubePartnerV1::Package command.params['packageId'] = package_id unless package_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Inserts a metadata-only package. # @param [Google::Apis::YoutubePartnerV1::Package] package_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::PackageInsertResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::PackageInsertResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_package(package_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'package', options) command.request_representation = Google::Apis::YoutubePartnerV1::Package::Representation command.request_object = package_object command.response_representation = Google::Apis::YoutubePartnerV1::PackageInsertResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::PackageInsertResponse command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 the specified saved policy. # @param [String] policy_id # The policyId parameter specifies a value that uniquely identifies the policy # being retrieved. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::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_policy(policy_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'policies/{policyId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.response_class = Google::Apis::YoutubePartnerV1::Policy command.params['policyId'] = policy_id unless policy_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 saved policy. # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::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 insert_policy(policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'policies', options) command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.response_class = Google::Apis::YoutubePartnerV1::Policy command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 the content owner's saved policies. # @param [String] id # The id parameter specifies a comma-separated list of saved policy IDs to # retrieve. Only policies belonging to the currently authenticated content owner # will be available. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] sort # The sort parameter specifies how the search results should be sorted. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::PolicyList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::PolicyList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_policies(id: nil, on_behalf_of_content_owner: nil, sort: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'policies', options) command.response_representation = Google::Apis::YoutubePartnerV1::PolicyList::Representation command.response_class = Google::Apis::YoutubePartnerV1::PolicyList command.query['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['sort'] = sort unless sort.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 specified saved policy. This method supports patch semantics. # @param [String] policy_id # The policyId parameter specifies a value that uniquely identifies the policy # being updated. # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::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 patch_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'policies/{policyId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.response_class = Google::Apis::YoutubePartnerV1::Policy command.params['policyId'] = policy_id unless policy_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 specified saved policy. # @param [String] policy_id # The policyId parameter specifies a value that uniquely identifies the policy # being updated. # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::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 update_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'policies/{policyId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.response_class = Google::Apis::YoutubePartnerV1::Policy command.params['policyId'] = policy_id unless policy_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 information about the specified publisher. # @param [String] publisher_id # The publisherId parameter specifies a publisher ID that uniquely identifies # the publisher being retrieved. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Publisher] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Publisher] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_publisher(publisher_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'publishers/{publisherId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Publisher::Representation command.response_class = Google::Apis::YoutubePartnerV1::Publisher command.params['publisherId'] = publisher_id unless publisher_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 publishers that match the request criteria. This method is # analogous to a publisher search function. # @param [String] cae_number # The caeNumber parameter specifies the CAE number of the publisher that you # want to retrieve. # @param [String] id # The id parameter specifies a comma-separated list of YouTube publisher IDs to # retrieve. # @param [String] ipi_number # The ipiNumber parameter specifies the IPI number of the publisher that you # want to retrieve. # @param [Fixnum] max_results # The maxResults parameter specifies the maximum number of results to return per # page. # @param [String] name_prefix # The namePrefix parameter indicates that the API should only return publishers # whose name starts with this prefix. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] page_token # The pageToken parameter specifies a token that identifies a particular page of # results to return. Set this parameter to the value of the nextPageToken value # from the previous API response to retrieve the next page of search results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::PublisherList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::PublisherList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_publishers(cae_number: nil, id: nil, ipi_number: nil, max_results: nil, name_prefix: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'publishers', options) command.response_representation = Google::Apis::YoutubePartnerV1::PublisherList::Representation command.response_class = Google::Apis::YoutubePartnerV1::PublisherList command.query['caeNumber'] = cae_number unless cae_number.nil? command.query['id'] = id unless id.nil? command.query['ipiNumber'] = ipi_number unless ipi_number.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['namePrefix'] = name_prefix unless name_prefix.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Retrieves information about the specified reference conflict. # @param [String] reference_conflict_id # The referenceConflictId parameter specifies the YouTube reference conflict ID # of the reference conflict being retrieved. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ReferenceConflict] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ReferenceConflict] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reference_conflict(reference_conflict_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'referenceConflicts/{referenceConflictId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceConflict::Representation command.response_class = Google::Apis::YoutubePartnerV1::ReferenceConflict command.params['referenceConflictId'] = reference_conflict_id unless reference_conflict_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 unresolved reference conflicts. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] page_token # The pageToken parameter specifies a token that identifies a particular page of # results to return. Set this parameter to the value of the nextPageToken value # from the previous API response to retrieve the next page of search results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reference_conflicts(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'referenceConflicts', options) command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Retrieves information about the specified reference. # @param [String] reference_id # The referenceId parameter specifies the YouTube reference ID of the reference # being retrieved. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Reference] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Reference] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reference(reference_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'references/{referenceId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation command.response_class = Google::Apis::YoutubePartnerV1::Reference command.params['referenceId'] = reference_id unless reference_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 reference in one of the following ways: # - If your request is uploading a reference file, YouTube creates the reference # from the provided content. You can provide either a video/audio file or a pre- # generated fingerprint. If you are providing a pre-generated fingerprint, set # the reference resource's fpDirect property to true in the request body. In # this flow, you can use either the multipart or resumable upload flows to # provide the reference content. # - If you want to create a reference using a claimed video as the reference # content, use the claimId parameter to identify the claim. # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object # @param [String] claim_id # The claimId parameter specifies the YouTube claim ID of an existing claim from # which a reference should be created. (The claimed video is used as the # reference content.) # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::YoutubePartnerV1::Reference] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Reference] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reference(reference_object = nil, claim_id: nil, on_behalf_of_content_owner: 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, 'references', options) else command = make_upload_command(:post, 'references', options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation command.request_object = reference_object command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation command.response_class = Google::Apis::YoutubePartnerV1::Reference command.query['claimId'] = claim_id unless claim_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 references by ID or the list of references for the # specified asset. # @param [String] asset_id # The assetId parameter specifies the YouTube asset ID of the asset for which # you are retrieving references. # @param [String] id # The id parameter specifies a comma-separated list of YouTube reference IDs to # retrieve. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] page_token # The pageToken parameter specifies a token that identifies a particular page of # results to return. Set this parameter to the value of the nextPageToken value # from the previous API response to retrieve the next page of search results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ReferenceListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ReferenceListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_references(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'references', options) command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ReferenceListResponse command.query['assetId'] = asset_id unless asset_id.nil? command.query['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 a reference. This method supports patch semantics. # @param [String] reference_id # The referenceId parameter specifies the YouTube reference ID of the reference # being updated. # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [Boolean] release_claims # The releaseClaims parameter indicates that you want to release all match # claims associated with this reference. This parameter only works when the # claim's status is being updated to 'inactive' - you can then set the parameter' # s value to true to release all match claims produced by this reference. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Reference] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Reference] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'references/{referenceId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation command.request_object = reference_object command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation command.response_class = Google::Apis::YoutubePartnerV1::Reference command.params['referenceId'] = reference_id unless reference_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['releaseClaims'] = release_claims unless release_claims.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 a reference. # @param [String] reference_id # The referenceId parameter specifies the YouTube reference ID of the reference # being updated. # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [Boolean] release_claims # The releaseClaims parameter indicates that you want to release all match # claims associated with this reference. This parameter only works when the # claim's status is being updated to 'inactive' - you can then set the parameter' # s value to true to release all match claims produced by this reference. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Reference] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Reference] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'references/{referenceId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation command.request_object = reference_object command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation command.response_class = Google::Apis::YoutubePartnerV1::Reference command.params['referenceId'] = reference_id unless reference_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['releaseClaims'] = release_claims unless release_claims.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 spreadsheet templates for a content owner. # @param [String] locale # The locale parameter identifies the desired language for templates in the API # response. The value is a string that contains a BCP-47 language code. The # default value is en. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_spreadsheet_templates(locale: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'spreadsheetTemplate', options) command.response_representation = Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse command.query['locale'] = locale unless locale.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 uploaders for a content owner. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::UploaderListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::UploaderListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_uploaders(on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'uploader', options) command.response_representation = Google::Apis::YoutubePartnerV1::UploaderListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::UploaderListResponse command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Validate a metadata file. # @param [Google::Apis::YoutubePartnerV1::ValidateRequest] validate_request_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ValidateResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ValidateResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_validator(validate_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'validator', options) command.request_representation = Google::Apis::YoutubePartnerV1::ValidateRequest::Representation command.request_object = validate_request_object command.response_representation = Google::Apis::YoutubePartnerV1::ValidateResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ValidateResponse command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Validate a metadata file asynchronously. # @param [Google::Apis::YoutubePartnerV1::ValidateAsyncRequest] validate_async_request_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ValidateAsyncResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ValidateAsyncResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_validator_async(validate_async_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'validatorAsync', options) command.request_representation = Google::Apis::YoutubePartnerV1::ValidateAsyncRequest::Representation command.request_object = validate_async_request_object command.response_representation = Google::Apis::YoutubePartnerV1::ValidateAsyncResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ValidateAsyncResponse command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Get the asynchronous validation status. # @param [Google::Apis::YoutubePartnerV1::ValidateStatusRequest] validate_status_request_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::ValidateStatusResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::ValidateStatusResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_validator_async_status(validate_status_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'validatorAsyncStatus', options) command.request_representation = Google::Apis::YoutubePartnerV1::ValidateStatusRequest::Representation command.request_object = validate_status_request_object command.response_representation = Google::Apis::YoutubePartnerV1::ValidateStatusResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ValidateStatusResponse command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 advertising settings for the specified video. # @param [String] video_id # The videoId parameter specifies the YouTube video ID of the video for which # you are retrieving advertising settings. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_video_advertising_option(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'videoAdvertisingOptions/{videoId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption command.params['videoId'] = video_id unless video_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 details about the types of allowed ads for a specified partner- or # user-uploaded video. # @param [String] video_id # The videoId parameter specifies the YouTube video ID of the video for which # you are retrieving advertising options. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_video_advertising_option_enabled_ads(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'videoAdvertisingOptions/{videoId}/getEnabledAds', options) command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse command.params['videoId'] = video_id unless video_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 advertising settings for the specified video. This method supports # patch semantics. # @param [String] video_id # The videoId parameter specifies the YouTube video ID of the video for which # you are updating advertising settings. # @param [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] video_advertising_option_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'videoAdvertisingOptions/{videoId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation command.request_object = video_advertising_option_object command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption command.params['videoId'] = video_id unless video_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 advertising settings for the specified video. # @param [String] video_id # The videoId parameter specifies the YouTube video ID of the video for which # you are updating advertising settings. # @param [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] video_advertising_option_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'videoAdvertisingOptions/{videoId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation command.request_object = video_advertising_option_object command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption command.params['videoId'] = video_id unless video_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Removes a whitelisted channel for a content owner. # @param [String] id # The id parameter specifies the YouTube channel ID of the channel being removed # from whitelist. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'whitelists/{id}', options) command.params['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 specific whitelisted channel by ID. # @param [String] id # The id parameter specifies the YouTube channel ID of the whitelisted channel # being retrieved. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Whitelist] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Whitelist] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'whitelists/{id}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation command.response_class = Google::Apis::YoutubePartnerV1::Whitelist command.params['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Whitelist a YouTube channel for your content owner. Whitelisted channels are # channels that are not owned or managed by you, but you would like to whitelist # so that no claims from your assets are placed on videos uploaded to these # channels. # @param [Google::Apis::YoutubePartnerV1::Whitelist] whitelist_object # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::Whitelist] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::Whitelist] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_whitelist(whitelist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'whitelists', options) command.request_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation command.request_object = whitelist_object command.response_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation command.response_class = Google::Apis::YoutubePartnerV1::Whitelist command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 whitelisted channels for a content owner. # @param [String] id # The id parameter specifies a comma-separated list of YouTube channel IDs that # identify the whitelisted channels you want to retrieve. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the # user is acting on behalf of. This parameter supports users whose accounts are # associated with multiple content owners. # @param [String] page_token # The pageToken parameter specifies a token that identifies a particular page of # results to return. Set this parameter to the value of the nextPageToken value # from the previous API response to retrieve the next page of results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubePartnerV1::WhitelistListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubePartnerV1::WhitelistListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_whitelists(id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'whitelists', options) command.response_representation = Google::Apis::YoutubePartnerV1::WhitelistListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::WhitelistListResponse command.query['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 protected 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 end end google-api-client-0.19.8/generated/google/apis/iam_v1.rb0000644000004100000410000000237213252673043023020 0ustar www-datawww-data# 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/iam_v1/service.rb' require 'google/apis/iam_v1/classes.rb' require 'google/apis/iam_v1/representations.rb' module Google module Apis # Google Identity and Access Management (IAM) API # # Manages identity and access control for Google Cloud Platform resources, # including the creation of service accounts, which you can use to authenticate # to Google and make API calls. # # @see https://cloud.google.com/iam/ module IamV1 VERSION = 'V1' REVISION = '20180202' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end google-api-client-0.19.8/generated/google/apis/cloudbilling_v1.rb0000644000004100000410000000225713252673043024723 0ustar www-datawww-data# 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/cloudbilling_v1/service.rb' require 'google/apis/cloudbilling_v1/classes.rb' require 'google/apis/cloudbilling_v1/representations.rb' module Google module Apis # Google Cloud Billing API # # Allows developers to manage billing for their Google Cloud Platform projects # programmatically. # # @see https://cloud.google.com/billing/ module CloudbillingV1 VERSION = 'V1' REVISION = '20180116' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end google-api-client-0.19.8/generated/google/apis/genomics_v1alpha2.rb0000644000004100000410000000256013252673043025145 0ustar www-datawww-data# 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/genomics_v1alpha2/service.rb' require 'google/apis/genomics_v1alpha2/classes.rb' require 'google/apis/genomics_v1alpha2/representations.rb' module Google module Apis # Genomics API # # Upload, process, query, and search Genomics data in the cloud. # # @see https://cloud.google.com/genomics module GenomicsV1alpha2 VERSION = 'V1alpha2' REVISION = '20180208' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View and manage your Google Compute Engine resources AUTH_COMPUTE = 'https://www.googleapis.com/auth/compute' # View and manage Genomics data AUTH_GENOMICS = 'https://www.googleapis.com/auth/genomics' end end end google-api-client-0.19.8/generated/google/apis/reseller_v1.rb0000644000004100000410000000233413252673044024066 0ustar www-datawww-data# 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/reseller_v1/service.rb' require 'google/apis/reseller_v1/classes.rb' require 'google/apis/reseller_v1/representations.rb' module Google module Apis # Enterprise Apps Reseller API # # Creates and manages your customers and their subscriptions. # # @see https://developers.google.com/google-apps/reseller/ module ResellerV1 VERSION = 'V1' REVISION = '20170228' # Manage users on your domain AUTH_APPS_ORDER = 'https://www.googleapis.com/auth/apps.order' # Manage users on your domain AUTH_APPS_ORDER_READONLY = 'https://www.googleapis.com/auth/apps.order.readonly' end end end google-api-client-0.19.8/generated/google/apis/storage_v1/0000755000004100000410000000000013252673044023366 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/storage_v1/representations.rb0000644000004100000410000006102413252673044027143 0ustar www-datawww-data# 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 StorageV1 class Bucket class Representation < Google::Apis::Core::JsonRepresentation; end class Billing class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CorsConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Encryption class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Lifecycle class Representation < Google::Apis::Core::JsonRepresentation; end class Rule class Representation < Google::Apis::Core::JsonRepresentation; end class Action class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Condition 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 Logging class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Owner class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RetentionPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Versioning class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Website class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class BucketAccessControl class Representation < Google::Apis::Core::JsonRepresentation; end class ProjectTeam class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class BucketAccessControls class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Buckets 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 ComposeRequest class Representation < Google::Apis::Core::JsonRepresentation; end class SourceObject class Representation < Google::Apis::Core::JsonRepresentation; end class ObjectPreconditions 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 Notification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Notifications class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Object class Representation < Google::Apis::Core::JsonRepresentation; end class CustomerEncryption class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Owner class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ObjectAccessControl class Representation < Google::Apis::Core::JsonRepresentation; end class ProjectTeam class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ObjectAccessControls class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Objects class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end class Binding class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class RewriteResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Bucket # @private class Representation < Google::Apis::Core::JsonRepresentation collection :acl, as: 'acl', class: Google::Apis::StorageV1::BucketAccessControl, decorator: Google::Apis::StorageV1::BucketAccessControl::Representation property :billing, as: 'billing', class: Google::Apis::StorageV1::Bucket::Billing, decorator: Google::Apis::StorageV1::Bucket::Billing::Representation collection :cors_configurations, as: 'cors', class: Google::Apis::StorageV1::Bucket::CorsConfiguration, decorator: Google::Apis::StorageV1::Bucket::CorsConfiguration::Representation property :default_event_based_hold, as: 'defaultEventBasedHold' collection :default_object_acl, as: 'defaultObjectAcl', class: Google::Apis::StorageV1::ObjectAccessControl, decorator: Google::Apis::StorageV1::ObjectAccessControl::Representation property :encryption, as: 'encryption', class: Google::Apis::StorageV1::Bucket::Encryption, decorator: Google::Apis::StorageV1::Bucket::Encryption::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' hash :labels, as: 'labels' property :lifecycle, as: 'lifecycle', class: Google::Apis::StorageV1::Bucket::Lifecycle, decorator: Google::Apis::StorageV1::Bucket::Lifecycle::Representation property :location, as: 'location' property :logging, as: 'logging', class: Google::Apis::StorageV1::Bucket::Logging, decorator: Google::Apis::StorageV1::Bucket::Logging::Representation property :metageneration, :numeric_string => true, as: 'metageneration' property :name, as: 'name' property :owner, as: 'owner', class: Google::Apis::StorageV1::Bucket::Owner, decorator: Google::Apis::StorageV1::Bucket::Owner::Representation property :project_number, :numeric_string => true, as: 'projectNumber' property :retention_policy, as: 'retentionPolicy', class: Google::Apis::StorageV1::Bucket::RetentionPolicy, decorator: Google::Apis::StorageV1::Bucket::RetentionPolicy::Representation property :self_link, as: 'selfLink' property :storage_class, as: 'storageClass' property :time_created, as: 'timeCreated', type: DateTime property :updated, as: 'updated', type: DateTime property :versioning, as: 'versioning', class: Google::Apis::StorageV1::Bucket::Versioning, decorator: Google::Apis::StorageV1::Bucket::Versioning::Representation property :website, as: 'website', class: Google::Apis::StorageV1::Bucket::Website, decorator: Google::Apis::StorageV1::Bucket::Website::Representation end class Billing # @private class Representation < Google::Apis::Core::JsonRepresentation property :requester_pays, as: 'requesterPays' end end class CorsConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_age_seconds, as: 'maxAgeSeconds' collection :http_method, as: 'method' collection :origin, as: 'origin' collection :response_header, as: 'responseHeader' end end class Encryption # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_kms_key_name, as: 'defaultKmsKeyName' end end class Lifecycle # @private class Representation < Google::Apis::Core::JsonRepresentation collection :rule, as: 'rule', class: Google::Apis::StorageV1::Bucket::Lifecycle::Rule, decorator: Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Representation end class Rule # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action', class: Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Action, decorator: Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Action::Representation property :condition, as: 'condition', class: Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Condition, decorator: Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Condition::Representation end class Action # @private class Representation < Google::Apis::Core::JsonRepresentation property :storage_class, as: 'storageClass' property :type, as: 'type' end end class Condition # @private class Representation < Google::Apis::Core::JsonRepresentation property :age, as: 'age' property :created_before, as: 'createdBefore', type: Date property :is_live, as: 'isLive' collection :matches_storage_class, as: 'matchesStorageClass' property :num_newer_versions, as: 'numNewerVersions' end end end end class Logging # @private class Representation < Google::Apis::Core::JsonRepresentation property :log_bucket, as: 'logBucket' property :log_object_prefix, as: 'logObjectPrefix' end end class Owner # @private class Representation < Google::Apis::Core::JsonRepresentation property :entity, as: 'entity' property :entity_id, as: 'entityId' end end class RetentionPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :effective_time, as: 'effectiveTime', type: DateTime property :is_locked, as: 'isLocked' property :retention_period, :numeric_string => true, as: 'retentionPeriod' end end class Versioning # @private class Representation < Google::Apis::Core::JsonRepresentation property :enabled, as: 'enabled' end end class Website # @private class Representation < Google::Apis::Core::JsonRepresentation property :main_page_suffix, as: 'mainPageSuffix' property :not_found_page, as: 'notFoundPage' end end end class BucketAccessControl # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket, as: 'bucket' property :domain, as: 'domain' property :email, as: 'email' property :entity, as: 'entity' property :entity_id, as: 'entityId' property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :project_team, as: 'projectTeam', class: Google::Apis::StorageV1::BucketAccessControl::ProjectTeam, decorator: Google::Apis::StorageV1::BucketAccessControl::ProjectTeam::Representation property :role, as: 'role' property :self_link, as: 'selfLink' end class ProjectTeam # @private class Representation < Google::Apis::Core::JsonRepresentation property :project_number, as: 'projectNumber' property :team, as: 'team' end end end class BucketAccessControls # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::StorageV1::BucketAccessControl, decorator: Google::Apis::StorageV1::BucketAccessControl::Representation property :kind, as: 'kind' end end class Buckets # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::StorageV1::Bucket, decorator: Google::Apis::StorageV1::Bucket::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Channel # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address' property :expiration, :numeric_string => true, as: 'expiration' property :id, as: 'id' property :kind, as: 'kind' hash :params, as: 'params' property :payload, as: 'payload' property :resource_id, as: 'resourceId' property :resource_uri, as: 'resourceUri' property :token, as: 'token' property :type, as: 'type' end end class ComposeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination, as: 'destination', class: Google::Apis::StorageV1::Object, decorator: Google::Apis::StorageV1::Object::Representation property :kind, as: 'kind' collection :source_objects, as: 'sourceObjects', class: Google::Apis::StorageV1::ComposeRequest::SourceObject, decorator: Google::Apis::StorageV1::ComposeRequest::SourceObject::Representation end class SourceObject # @private class Representation < Google::Apis::Core::JsonRepresentation property :generation, :numeric_string => true, as: 'generation' property :name, as: 'name' property :object_preconditions, as: 'objectPreconditions', class: Google::Apis::StorageV1::ComposeRequest::SourceObject::ObjectPreconditions, decorator: Google::Apis::StorageV1::ComposeRequest::SourceObject::ObjectPreconditions::Representation end class ObjectPreconditions # @private class Representation < Google::Apis::Core::JsonRepresentation property :if_generation_match, :numeric_string => true, as: 'ifGenerationMatch' end end end end class Notification # @private class Representation < Google::Apis::Core::JsonRepresentation hash :custom_attributes, as: 'custom_attributes' property :etag, as: 'etag' collection :event_types, as: 'event_types' property :id, as: 'id' property :kind, as: 'kind' property :object_name_prefix, as: 'object_name_prefix' property :payload_format, as: 'payload_format' property :self_link, as: 'selfLink' property :topic, as: 'topic' end end class Notifications # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::StorageV1::Notification, decorator: Google::Apis::StorageV1::Notification::Representation property :kind, as: 'kind' end end class Object # @private class Representation < Google::Apis::Core::JsonRepresentation collection :acl, as: 'acl', class: Google::Apis::StorageV1::ObjectAccessControl, decorator: Google::Apis::StorageV1::ObjectAccessControl::Representation property :bucket, as: 'bucket' property :cache_control, as: 'cacheControl' property :component_count, as: 'componentCount' property :content_disposition, as: 'contentDisposition' property :content_encoding, as: 'contentEncoding' property :content_language, as: 'contentLanguage' property :content_type, as: 'contentType' property :crc32c, as: 'crc32c' property :customer_encryption, as: 'customerEncryption', class: Google::Apis::StorageV1::Object::CustomerEncryption, decorator: Google::Apis::StorageV1::Object::CustomerEncryption::Representation property :etag, as: 'etag' property :event_based_hold, as: 'eventBasedHold' property :generation, :numeric_string => true, as: 'generation' property :id, as: 'id' property :kind, as: 'kind' property :kms_key_name, as: 'kmsKeyName' property :md5_hash, as: 'md5Hash' property :media_link, as: 'mediaLink' hash :metadata, as: 'metadata' property :metageneration, :numeric_string => true, as: 'metageneration' property :name, as: 'name' property :owner, as: 'owner', class: Google::Apis::StorageV1::Object::Owner, decorator: Google::Apis::StorageV1::Object::Owner::Representation property :retention_expiration_time, as: 'retentionExpirationTime', type: DateTime property :self_link, as: 'selfLink' property :size, :numeric_string => true, as: 'size' property :storage_class, as: 'storageClass' property :temporary_hold, as: 'temporaryHold' property :time_created, as: 'timeCreated', type: DateTime property :time_deleted, as: 'timeDeleted', type: DateTime property :time_storage_class_updated, as: 'timeStorageClassUpdated', type: DateTime property :updated, as: 'updated', type: DateTime end class CustomerEncryption # @private class Representation < Google::Apis::Core::JsonRepresentation property :encryption_algorithm, as: 'encryptionAlgorithm' property :key_sha256, as: 'keySha256' end end class Owner # @private class Representation < Google::Apis::Core::JsonRepresentation property :entity, as: 'entity' property :entity_id, as: 'entityId' end end end class ObjectAccessControl # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket, as: 'bucket' property :domain, as: 'domain' property :email, as: 'email' property :entity, as: 'entity' property :entity_id, as: 'entityId' property :etag, as: 'etag' property :generation, :numeric_string => true, as: 'generation' property :id, as: 'id' property :kind, as: 'kind' property :object, as: 'object' property :project_team, as: 'projectTeam', class: Google::Apis::StorageV1::ObjectAccessControl::ProjectTeam, decorator: Google::Apis::StorageV1::ObjectAccessControl::ProjectTeam::Representation property :role, as: 'role' property :self_link, as: 'selfLink' end class ProjectTeam # @private class Representation < Google::Apis::Core::JsonRepresentation property :project_number, as: 'projectNumber' property :team, as: 'team' end end end class ObjectAccessControls # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::StorageV1::ObjectAccessControl, decorator: Google::Apis::StorageV1::ObjectAccessControl::Representation property :kind, as: 'kind' end end class Objects # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::StorageV1::Object, decorator: Google::Apis::StorageV1::Object::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :prefixes, as: 'prefixes' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :bindings, as: 'bindings', class: Google::Apis::StorageV1::Policy::Binding, decorator: Google::Apis::StorageV1::Policy::Binding::Representation property :etag, :base64 => true, as: 'etag' property :kind, as: 'kind' property :resource_id, as: 'resourceId' end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation property :condition, as: 'condition' collection :members, as: 'members' property :role, as: 'role' end end end class RewriteResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :kind, as: 'kind' property :object_size, :numeric_string => true, as: 'objectSize' property :resource, as: 'resource', class: Google::Apis::StorageV1::Object, decorator: Google::Apis::StorageV1::Object::Representation property :rewrite_token, as: 'rewriteToken' property :total_bytes_rewritten, :numeric_string => true, as: 'totalBytesRewritten' end end class ServiceAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :email_address, as: 'email_address' property :kind, as: 'kind' end end class TestIamPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :permissions, as: 'permissions' end end end end end google-api-client-0.19.8/generated/google/apis/storage_v1/classes.rb0000644000004100000410000021255413252673044025361 0ustar www-datawww-data# 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 StorageV1 # A bucket. class Bucket include Google::Apis::Core::Hashable # Access controls on the bucket. # Corresponds to the JSON property `acl` # @return [Array] attr_accessor :acl # The bucket's billing configuration. # Corresponds to the JSON property `billing` # @return [Google::Apis::StorageV1::Bucket::Billing] attr_accessor :billing # The bucket's Cross-Origin Resource Sharing (CORS) configuration. # Corresponds to the JSON property `cors` # @return [Array] attr_accessor :cors_configurations # Defines the default value for Event-Based hold on newly created objects in # this bucket. Event-Based hold is a way to retain objects indefinitely until an # event occurs, signified by the hold's release. After being released, such # objects will be subject to bucket-level retention (if any). One sample use # case of this flag is for banks to hold loan documents for at least 3 years # after loan is paid in full. Here bucket-level retention is 3 years and the # event is loan being paid in full. In this example these objects will be held # intact for any number of years until the event has occurred (hold is released) # and then 3 more years after that. Objects under Event-Based hold cannot be # deleted, overwritten or archived until the hold is removed. # Corresponds to the JSON property `defaultEventBasedHold` # @return [Boolean] attr_accessor :default_event_based_hold alias_method :default_event_based_hold?, :default_event_based_hold # Default access controls to apply to new objects when no ACL is provided. # Corresponds to the JSON property `defaultObjectAcl` # @return [Array] attr_accessor :default_object_acl # Encryption configuration used by default for newly inserted objects, when no # encryption config is specified. # Corresponds to the JSON property `encryption` # @return [Google::Apis::StorageV1::Bucket::Encryption] attr_accessor :encryption # HTTP 1.1 Entity tag for the bucket. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of the bucket. For buckets, the id and name properties are the same. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of item this is. For buckets, this is always storage#bucket. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # User-provided labels, in key/value pairs. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The bucket's lifecycle configuration. See lifecycle management for more # information. # Corresponds to the JSON property `lifecycle` # @return [Google::Apis::StorageV1::Bucket::Lifecycle] attr_accessor :lifecycle # The location of the bucket. Object data for objects in the bucket resides in # physical storage within this region. Defaults to US. See the developer's guide # for the authoritative list. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The bucket's logging configuration, which defines the destination bucket and # optional name prefix for the current bucket's logs. # Corresponds to the JSON property `logging` # @return [Google::Apis::StorageV1::Bucket::Logging] attr_accessor :logging # The metadata generation of this bucket. # Corresponds to the JSON property `metageneration` # @return [Fixnum] attr_accessor :metageneration # The name of the bucket. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The owner of the bucket. This is always the project team's owner group. # Corresponds to the JSON property `owner` # @return [Google::Apis::StorageV1::Bucket::Owner] attr_accessor :owner # The project number of the project the bucket belongs to. # Corresponds to the JSON property `projectNumber` # @return [Fixnum] attr_accessor :project_number # Defines the retention policy for a bucket. The Retention policy enforces a # minimum retention time for all objects contained in the bucket, based on their # creation time. Any attempt to overwrite or delete objects younger than the # retention period will result in a PERMISSION_DENIED error. An unlocked # retention policy can be modified or removed from the bucket via the # UpdateBucketMetadata RPC. A locked retention policy cannot be removed or # shortened in duration for the lifetime of the bucket. Attempting to remove or # decrease period of a locked retention policy will result in a # PERMISSION_DENIED error. # Corresponds to the JSON property `retentionPolicy` # @return [Google::Apis::StorageV1::Bucket::RetentionPolicy] attr_accessor :retention_policy # The URI of this bucket. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The bucket's default storage class, used whenever no storageClass is specified # for a newly-created object. This defines how objects in the bucket are stored # and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, # REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If # this value is not specified when the bucket is created, it will default to # STANDARD. For more information, see storage classes. # Corresponds to the JSON property `storageClass` # @return [String] attr_accessor :storage_class # The creation time of the bucket in RFC 3339 format. # Corresponds to the JSON property `timeCreated` # @return [DateTime] attr_accessor :time_created # The modification time of the bucket in RFC 3339 format. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # The bucket's versioning configuration. # Corresponds to the JSON property `versioning` # @return [Google::Apis::StorageV1::Bucket::Versioning] attr_accessor :versioning # The bucket's website configuration, controlling how the service behaves when # accessing bucket contents as a web site. See the Static Website Examples for # more information. # Corresponds to the JSON property `website` # @return [Google::Apis::StorageV1::Bucket::Website] attr_accessor :website def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @acl = args[:acl] if args.key?(:acl) @billing = args[:billing] if args.key?(:billing) @cors_configurations = args[:cors_configurations] if args.key?(:cors_configurations) @default_event_based_hold = args[:default_event_based_hold] if args.key?(:default_event_based_hold) @default_object_acl = args[:default_object_acl] if args.key?(:default_object_acl) @encryption = args[:encryption] if args.key?(:encryption) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @labels = args[:labels] if args.key?(:labels) @lifecycle = args[:lifecycle] if args.key?(:lifecycle) @location = args[:location] if args.key?(:location) @logging = args[:logging] if args.key?(:logging) @metageneration = args[:metageneration] if args.key?(:metageneration) @name = args[:name] if args.key?(:name) @owner = args[:owner] if args.key?(:owner) @project_number = args[:project_number] if args.key?(:project_number) @retention_policy = args[:retention_policy] if args.key?(:retention_policy) @self_link = args[:self_link] if args.key?(:self_link) @storage_class = args[:storage_class] if args.key?(:storage_class) @time_created = args[:time_created] if args.key?(:time_created) @updated = args[:updated] if args.key?(:updated) @versioning = args[:versioning] if args.key?(:versioning) @website = args[:website] if args.key?(:website) end # The bucket's billing configuration. class Billing include Google::Apis::Core::Hashable # When set to true, Requester Pays is enabled for this bucket. # Corresponds to the JSON property `requesterPays` # @return [Boolean] attr_accessor :requester_pays alias_method :requester_pays?, :requester_pays def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @requester_pays = args[:requester_pays] if args.key?(:requester_pays) end end # class CorsConfiguration include Google::Apis::Core::Hashable # The value, in seconds, to return in the Access-Control-Max-Age header used in # preflight responses. # Corresponds to the JSON property `maxAgeSeconds` # @return [Fixnum] attr_accessor :max_age_seconds # The list of HTTP methods on which to include CORS response headers, (GET, # OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means " # any method". # Corresponds to the JSON property `method` # @return [Array] attr_accessor :http_method # The list of Origins eligible to receive CORS response headers. Note: "*" is # permitted in the list of origins, and means "any Origin". # Corresponds to the JSON property `origin` # @return [Array] attr_accessor :origin # The list of HTTP headers other than the simple response headers to give # permission for the user-agent to share across domains. # Corresponds to the JSON property `responseHeader` # @return [Array] attr_accessor :response_header def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_age_seconds = args[:max_age_seconds] if args.key?(:max_age_seconds) @http_method = args[:http_method] if args.key?(:http_method) @origin = args[:origin] if args.key?(:origin) @response_header = args[:response_header] if args.key?(:response_header) end end # Encryption configuration used by default for newly inserted objects, when no # encryption config is specified. class Encryption include Google::Apis::Core::Hashable # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, # if no encryption method is specified. Limited availability; usable only by # enabled projects. # Corresponds to the JSON property `defaultKmsKeyName` # @return [String] attr_accessor :default_kms_key_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_kms_key_name = args[:default_kms_key_name] if args.key?(:default_kms_key_name) end end # The bucket's lifecycle configuration. See lifecycle management for more # information. class Lifecycle include Google::Apis::Core::Hashable # A lifecycle management rule, which is made of an action to take and the # condition(s) under which the action will be taken. # Corresponds to the JSON property `rule` # @return [Array] attr_accessor :rule def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @rule = args[:rule] if args.key?(:rule) end # class Rule include Google::Apis::Core::Hashable # The action to take. # Corresponds to the JSON property `action` # @return [Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Action] attr_accessor :action # The condition(s) under which the action will be taken. # Corresponds to the JSON property `condition` # @return [Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Condition] attr_accessor :condition def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) @condition = args[:condition] if args.key?(:condition) end # The action to take. class Action include Google::Apis::Core::Hashable # Target storage class. Required iff the type of the action is SetStorageClass. # Corresponds to the JSON property `storageClass` # @return [String] attr_accessor :storage_class # Type of the action. Currently, only Delete and SetStorageClass are supported. # 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) @storage_class = args[:storage_class] if args.key?(:storage_class) @type = args[:type] if args.key?(:type) end end # The condition(s) under which the action will be taken. class Condition include Google::Apis::Core::Hashable # Age of an object (in days). This condition is satisfied when an object reaches # the specified age. # Corresponds to the JSON property `age` # @return [Fixnum] attr_accessor :age # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). # This condition is satisfied when an object is created before midnight of the # specified date in UTC. # Corresponds to the JSON property `createdBefore` # @return [Date] attr_accessor :created_before # 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` # @return [Boolean] attr_accessor :is_live alias_method :is_live?, :is_live # Objects having any of the storage classes specified by this condition will be # matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, # and DURABLE_REDUCED_AVAILABILITY. # Corresponds to the JSON property `matchesStorageClass` # @return [Array] attr_accessor :matches_storage_class # Relevant only for versioned objects. If the value is N, this condition is # satisfied when there are at least N versions (including the live version) # newer than this version of the object. # Corresponds to the JSON property `numNewerVersions` # @return [Fixnum] attr_accessor :num_newer_versions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @age = args[:age] if args.key?(:age) @created_before = args[:created_before] if args.key?(:created_before) @is_live = args[:is_live] if args.key?(:is_live) @matches_storage_class = args[:matches_storage_class] if args.key?(:matches_storage_class) @num_newer_versions = args[:num_newer_versions] if args.key?(:num_newer_versions) end end end end # The bucket's logging configuration, which defines the destination bucket and # optional name prefix for the current bucket's logs. class Logging include Google::Apis::Core::Hashable # The destination bucket where the current bucket's logs should be placed. # Corresponds to the JSON property `logBucket` # @return [String] attr_accessor :log_bucket # A prefix for log object names. # Corresponds to the JSON property `logObjectPrefix` # @return [String] attr_accessor :log_object_prefix def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @log_bucket = args[:log_bucket] if args.key?(:log_bucket) @log_object_prefix = args[:log_object_prefix] if args.key?(:log_object_prefix) end end # The owner of the bucket. This is always the project team's owner group. class Owner include Google::Apis::Core::Hashable # The entity, in the form project-owner-projectId. # Corresponds to the JSON property `entity` # @return [String] attr_accessor :entity # The ID for the entity. # Corresponds to the JSON property `entityId` # @return [String] attr_accessor :entity_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity = args[:entity] if args.key?(:entity) @entity_id = args[:entity_id] if args.key?(:entity_id) end end # Defines the retention policy for a bucket. The Retention policy enforces a # minimum retention time for all objects contained in the bucket, based on their # creation time. Any attempt to overwrite or delete objects younger than the # retention period will result in a PERMISSION_DENIED error. An unlocked # retention policy can be modified or removed from the bucket via the # UpdateBucketMetadata RPC. A locked retention policy cannot be removed or # shortened in duration for the lifetime of the bucket. Attempting to remove or # decrease period of a locked retention policy will result in a # PERMISSION_DENIED error. class RetentionPolicy include Google::Apis::Core::Hashable # The time from which policy was enforced and effective. RFC 3339 format. # Corresponds to the JSON property `effectiveTime` # @return [DateTime] attr_accessor :effective_time # Once locked, an object retention policy cannot be modified. # Corresponds to the JSON property `isLocked` # @return [Boolean] attr_accessor :is_locked alias_method :is_locked?, :is_locked # Specifies the duration that objects need to be retained. Retention duration # must be greater than zero and less than 100 years. Note that enforcement of # retention periods less than a day is not guaranteed. Such periods should only # be used for testing purposes. # Corresponds to the JSON property `retentionPeriod` # @return [Fixnum] attr_accessor :retention_period def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @effective_time = args[:effective_time] if args.key?(:effective_time) @is_locked = args[:is_locked] if args.key?(:is_locked) @retention_period = args[:retention_period] if args.key?(:retention_period) end end # The bucket's versioning configuration. class Versioning include Google::Apis::Core::Hashable # While set to true, versioning is fully enabled for this bucket. # 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 # The bucket's website configuration, controlling how the service behaves when # accessing bucket contents as a web site. See the Static Website Examples for # more information. class Website include Google::Apis::Core::Hashable # If the requested object path is missing, the service will ensure the path has # a trailing '/', append this suffix, and attempt to retrieve the resulting # object. This allows the creation of index.html objects to represent directory # pages. # Corresponds to the JSON property `mainPageSuffix` # @return [String] attr_accessor :main_page_suffix # If the requested object path is missing, and any mainPageSuffix object is # missing, if applicable, the service will return the named object from this # bucket as the content for a 404 Not Found result. # Corresponds to the JSON property `notFoundPage` # @return [String] attr_accessor :not_found_page def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @main_page_suffix = args[:main_page_suffix] if args.key?(:main_page_suffix) @not_found_page = args[:not_found_page] if args.key?(:not_found_page) end end end # An access-control entry. class BucketAccessControl include Google::Apis::Core::Hashable # The name of the bucket. # Corresponds to the JSON property `bucket` # @return [String] attr_accessor :bucket # The domain associated with the entity, if any. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # The email address associated with the entity, if any. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The entity holding the permission, in one of the following forms: # - user-userId # - user-email # - group-groupId # - group-email # - domain-domain # - project-team-projectId # - allUsers # - allAuthenticatedUsers Examples: # - The user liz@example.com would be user-liz@example.com. # - The group example@googlegroups.com would be group-example@googlegroups.com. # - To refer to all members of the Google Apps for Business domain example.com, # the entity would be domain-example.com. # Corresponds to the JSON property `entity` # @return [String] attr_accessor :entity # The ID for the entity, if any. # Corresponds to the JSON property `entityId` # @return [String] attr_accessor :entity_id # HTTP 1.1 Entity tag for the access-control entry. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of the access-control entry. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of item this is. For bucket access control entries, this is always # storage#bucketAccessControl. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The project team associated with the entity, if any. # Corresponds to the JSON property `projectTeam` # @return [Google::Apis::StorageV1::BucketAccessControl::ProjectTeam] attr_accessor :project_team # The access permission for the entity. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role # The link to this access-control entry. # 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) @bucket = args[:bucket] if args.key?(:bucket) @domain = args[:domain] if args.key?(:domain) @email = args[:email] if args.key?(:email) @entity = args[:entity] if args.key?(:entity) @entity_id = args[:entity_id] if args.key?(:entity_id) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @project_team = args[:project_team] if args.key?(:project_team) @role = args[:role] if args.key?(:role) @self_link = args[:self_link] if args.key?(:self_link) end # The project team associated with the entity, if any. class ProjectTeam include Google::Apis::Core::Hashable # The project number. # Corresponds to the JSON property `projectNumber` # @return [String] attr_accessor :project_number # The team. # Corresponds to the JSON property `team` # @return [String] attr_accessor :team def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @project_number = args[:project_number] if args.key?(:project_number) @team = args[:team] if args.key?(:team) end end end # An access-control list. class BucketAccessControls include Google::Apis::Core::Hashable # The list of items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of item this is. For lists of bucket access control entries, this is # always storage#bucketAccessControls. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # A list of buckets. class Buckets include Google::Apis::Core::Hashable # The list of items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of item this is. For lists of buckets, this is always storage#buckets. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, used to page through large result sets. Provide this # value in a subsequent request to return 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) @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) end end # An notification channel used to watch for resource changes. class Channel include Google::Apis::Core::Hashable # The address where notifications are delivered for this channel. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Date and time of notification channel expiration, expressed as a Unix # timestamp, in milliseconds. Optional. # Corresponds to the JSON property `expiration` # @return [Fixnum] attr_accessor :expiration # A UUID or similar unique string that identifies this channel. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies this as a notification channel used to watch for changes to a # resource. Value: the fixed string "api#channel". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Additional parameters controlling delivery channel behavior. Optional. # Corresponds to the JSON property `params` # @return [Hash] attr_accessor :params # A Boolean value to indicate whether payload is wanted. Optional. # Corresponds to the JSON property `payload` # @return [Boolean] attr_accessor :payload alias_method :payload?, :payload # An opaque ID that identifies the resource being watched on this channel. # Stable across different API versions. # Corresponds to the JSON property `resourceId` # @return [String] attr_accessor :resource_id # A version-specific identifier for the watched resource. # Corresponds to the JSON property `resourceUri` # @return [String] attr_accessor :resource_uri # An arbitrary string delivered to the target address with each notification # delivered over this channel. Optional. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token # The type of delivery mechanism used for this channel. # 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) @address = args[:address] if args.key?(:address) @expiration = args[:expiration] if args.key?(:expiration) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @params = args[:params] if args.key?(:params) @payload = args[:payload] if args.key?(:payload) @resource_id = args[:resource_id] if args.key?(:resource_id) @resource_uri = args[:resource_uri] if args.key?(:resource_uri) @token = args[:token] if args.key?(:token) @type = args[:type] if args.key?(:type) end end # A Compose request. class ComposeRequest include Google::Apis::Core::Hashable # An object. # Corresponds to the JSON property `destination` # @return [Google::Apis::StorageV1::Object] attr_accessor :destination # The kind of item this is. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The list of source objects that will be concatenated into a single object. # Corresponds to the JSON property `sourceObjects` # @return [Array] attr_accessor :source_objects def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @destination = args[:destination] if args.key?(:destination) @kind = args[:kind] if args.key?(:kind) @source_objects = args[:source_objects] if args.key?(:source_objects) end # class SourceObject include Google::Apis::Core::Hashable # The generation of this object to use as the source. # Corresponds to the JSON property `generation` # @return [Fixnum] attr_accessor :generation # The source object's name. The source object's bucket is implicitly the # destination bucket. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Conditions that must be met for this operation to execute. # Corresponds to the JSON property `objectPreconditions` # @return [Google::Apis::StorageV1::ComposeRequest::SourceObject::ObjectPreconditions] attr_accessor :object_preconditions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @generation = args[:generation] if args.key?(:generation) @name = args[:name] if args.key?(:name) @object_preconditions = args[:object_preconditions] if args.key?(:object_preconditions) end # Conditions that must be met for this operation to execute. class ObjectPreconditions include Google::Apis::Core::Hashable # Only perform the composition if the generation of the source object that would # be used matches this value. If this value and a generation are both specified, # they must be the same value or the call will fail. # Corresponds to the JSON property `ifGenerationMatch` # @return [Fixnum] attr_accessor :if_generation_match def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @if_generation_match = args[:if_generation_match] if args.key?(:if_generation_match) end end end end # A subscription to receive Google PubSub notifications. class Notification include Google::Apis::Core::Hashable # An optional list of additional attributes to attach to each Cloud PubSub # message published for this notification subscription. # Corresponds to the JSON property `custom_attributes` # @return [Hash] attr_accessor :custom_attributes # HTTP 1.1 Entity tag for this subscription notification. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # If present, only send notifications about listed event types. If empty, sent # notifications for all event types. # Corresponds to the JSON property `event_types` # @return [Array] attr_accessor :event_types # The ID of the notification. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of item this is. For notifications, this is always storage# # notification. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # If present, only apply this notification configuration to object names that # begin with this prefix. # Corresponds to the JSON property `object_name_prefix` # @return [String] attr_accessor :object_name_prefix # The desired content of the Payload. # Corresponds to the JSON property `payload_format` # @return [String] attr_accessor :payload_format # The canonical URL of this notification. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The Cloud PubSub topic to which this subscription publishes. Formatted as: '// # pubsub.googleapis.com/projects/`project-identifier`/topics/`my-topic`' # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes) @etag = args[:etag] if args.key?(:etag) @event_types = args[:event_types] if args.key?(:event_types) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @object_name_prefix = args[:object_name_prefix] if args.key?(:object_name_prefix) @payload_format = args[:payload_format] if args.key?(:payload_format) @self_link = args[:self_link] if args.key?(:self_link) @topic = args[:topic] if args.key?(:topic) end end # A list of notification subscriptions. class Notifications include Google::Apis::Core::Hashable # The list of items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of item this is. For lists of notifications, this is always storage# # notifications. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # An object. class Object include Google::Apis::Core::Hashable # Access controls on the object. # Corresponds to the JSON property `acl` # @return [Array] attr_accessor :acl # The name of the bucket containing this object. # Corresponds to the JSON property `bucket` # @return [String] attr_accessor :bucket # Cache-Control directive for the object data. If omitted, and the object is # accessible to all anonymous users, the default will be public, max-age=3600. # Corresponds to the JSON property `cacheControl` # @return [String] attr_accessor :cache_control # Number of underlying components that make up this object. Components are # accumulated by compose operations. # Corresponds to the JSON property `componentCount` # @return [Fixnum] attr_accessor :component_count # Content-Disposition of the object data. # Corresponds to the JSON property `contentDisposition` # @return [String] attr_accessor :content_disposition # Content-Encoding of the object data. # Corresponds to the JSON property `contentEncoding` # @return [String] attr_accessor :content_encoding # Content-Language of the object data. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language # Content-Type of the object data. If an object is stored without a Content-Type, # it is served as application/octet-stream. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in # big-endian byte order. For more information about using the CRC32c checksum, # see Hashes and ETags: Best Practices. # Corresponds to the JSON property `crc32c` # @return [String] attr_accessor :crc32c # Metadata of customer-supplied encryption key, if the object is encrypted by # such a key. # Corresponds to the JSON property `customerEncryption` # @return [Google::Apis::StorageV1::Object::CustomerEncryption] attr_accessor :customer_encryption # HTTP 1.1 Entity tag for the object. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Defines the Event-Based hold for an object. Event-Based hold is a way to # retain objects indefinitely until an event occurs, signified by the hold's # release. After being released, such objects will be subject to bucket-level # retention (if any). One sample use case of this flag is for banks to hold loan # documents for at least 3 years after loan is paid in full. Here bucket-level # retention is 3 years and the event is loan being paid in full. In this example # these objects will be held intact for any number of years until the event has # occurred (hold is released) and then 3 more years after that. # Corresponds to the JSON property `eventBasedHold` # @return [Boolean] attr_accessor :event_based_hold alias_method :event_based_hold?, :event_based_hold # The content generation of this object. Used for object versioning. # Corresponds to the JSON property `generation` # @return [Fixnum] attr_accessor :generation # The ID of the object, including the bucket name, object name, and generation # number. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of item this is. For objects, this is always storage#object. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Cloud KMS Key used to encrypt this object, if the object is encrypted by such # a key. Limited availability; usable only by enabled projects. # Corresponds to the JSON property `kmsKeyName` # @return [String] attr_accessor :kms_key_name # MD5 hash of the data; encoded using base64. For more information about using # the MD5 hash, see Hashes and ETags: Best Practices. # Corresponds to the JSON property `md5Hash` # @return [String] attr_accessor :md5_hash # Media download link. # Corresponds to the JSON property `mediaLink` # @return [String] attr_accessor :media_link # User-provided metadata, in key/value pairs. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The version of the metadata for this object at this generation. Used for # preconditions and for detecting changes in metadata. A metageneration number # is only meaningful in the context of a particular generation of a particular # object. # Corresponds to the JSON property `metageneration` # @return [Fixnum] attr_accessor :metageneration # The name of the object. Required if not specified by URL parameter. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The owner of the object. This will always be the uploader of the object. # Corresponds to the JSON property `owner` # @return [Google::Apis::StorageV1::Object::Owner] attr_accessor :owner # Specifies the earliest time that the object's retention period expires. This # value is server-determined and is in RFC 3339 format. Note 1: This field is # not provided for objects with an active Event-Based hold, since retention # expiration is unknown until the hold is removed. Note 2: This value can be # provided even when TemporaryHold is set (so that the user can reason about # policy without having to first unset the TemporaryHold). # Corresponds to the JSON property `retentionExpirationTime` # @return [DateTime] attr_accessor :retention_expiration_time # The link to this object. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Content-Length of the data in bytes. # Corresponds to the JSON property `size` # @return [Fixnum] attr_accessor :size # Storage class of the object. # Corresponds to the JSON property `storageClass` # @return [String] attr_accessor :storage_class # Defines the temporary hold for an object. This flag is used to enforce a # temporary hold on an object. While it is set to true, the object is protected # against deletion and overwrites. A common use case of this flag is regulatory # investigations where objects need to be retained while the investigation is # ongoing. # Corresponds to the JSON property `temporaryHold` # @return [Boolean] attr_accessor :temporary_hold alias_method :temporary_hold?, :temporary_hold # The creation time of the object in RFC 3339 format. # Corresponds to the JSON property `timeCreated` # @return [DateTime] attr_accessor :time_created # The deletion time of the object in RFC 3339 format. Will be returned if and # only if this version of the object has been deleted. # Corresponds to the JSON property `timeDeleted` # @return [DateTime] attr_accessor :time_deleted # The time at which the object's storage class was last changed. When the object # is initially created, it will be set to timeCreated. # Corresponds to the JSON property `timeStorageClassUpdated` # @return [DateTime] attr_accessor :time_storage_class_updated # The modification time of the object metadata in RFC 3339 format. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @acl = args[:acl] if args.key?(:acl) @bucket = args[:bucket] if args.key?(:bucket) @cache_control = args[:cache_control] if args.key?(:cache_control) @component_count = args[:component_count] if args.key?(:component_count) @content_disposition = args[:content_disposition] if args.key?(:content_disposition) @content_encoding = args[:content_encoding] if args.key?(:content_encoding) @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) @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) @generation = args[:generation] if args.key?(:generation) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name) @md5_hash = args[:md5_hash] if args.key?(:md5_hash) @media_link = args[:media_link] if args.key?(:media_link) @metadata = args[:metadata] if args.key?(:metadata) @metageneration = args[:metageneration] if args.key?(:metageneration) @name = args[:name] if args.key?(:name) @owner = args[:owner] if args.key?(:owner) @retention_expiration_time = args[:retention_expiration_time] if args.key?(:retention_expiration_time) @self_link = args[:self_link] if args.key?(:self_link) @size = args[:size] if args.key?(:size) @storage_class = args[:storage_class] if args.key?(:storage_class) @temporary_hold = args[:temporary_hold] if args.key?(:temporary_hold) @time_created = args[:time_created] if args.key?(:time_created) @time_deleted = args[:time_deleted] if args.key?(:time_deleted) @time_storage_class_updated = args[:time_storage_class_updated] if args.key?(:time_storage_class_updated) @updated = args[:updated] if args.key?(:updated) end # Metadata of customer-supplied encryption key, if the object is encrypted by # such a key. class CustomerEncryption include Google::Apis::Core::Hashable # The encryption algorithm. # Corresponds to the JSON property `encryptionAlgorithm` # @return [String] attr_accessor :encryption_algorithm # SHA256 hash value of the encryption key. # Corresponds to the JSON property `keySha256` # @return [String] attr_accessor :key_sha256 def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @encryption_algorithm = args[:encryption_algorithm] if args.key?(:encryption_algorithm) @key_sha256 = args[:key_sha256] if args.key?(:key_sha256) end end # The owner of the object. This will always be the uploader of the object. class Owner include Google::Apis::Core::Hashable # The entity, in the form user-userId. # Corresponds to the JSON property `entity` # @return [String] attr_accessor :entity # The ID for the entity. # Corresponds to the JSON property `entityId` # @return [String] attr_accessor :entity_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity = args[:entity] if args.key?(:entity) @entity_id = args[:entity_id] if args.key?(:entity_id) end end end # An access-control entry. class ObjectAccessControl include Google::Apis::Core::Hashable # The name of the bucket. # Corresponds to the JSON property `bucket` # @return [String] attr_accessor :bucket # The domain associated with the entity, if any. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # The email address associated with the entity, if any. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The entity holding the permission, in one of the following forms: # - user-userId # - user-email # - group-groupId # - group-email # - domain-domain # - project-team-projectId # - allUsers # - allAuthenticatedUsers Examples: # - The user liz@example.com would be user-liz@example.com. # - The group example@googlegroups.com would be group-example@googlegroups.com. # - To refer to all members of the Google Apps for Business domain example.com, # the entity would be domain-example.com. # Corresponds to the JSON property `entity` # @return [String] attr_accessor :entity # The ID for the entity, if any. # Corresponds to the JSON property `entityId` # @return [String] attr_accessor :entity_id # HTTP 1.1 Entity tag for the access-control entry. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The content generation of the object, if applied to an object. # Corresponds to the JSON property `generation` # @return [Fixnum] attr_accessor :generation # The ID of the access-control entry. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of item this is. For object access control entries, this is always # storage#objectAccessControl. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the object, if applied to an object. # Corresponds to the JSON property `object` # @return [String] attr_accessor :object # The project team associated with the entity, if any. # Corresponds to the JSON property `projectTeam` # @return [Google::Apis::StorageV1::ObjectAccessControl::ProjectTeam] attr_accessor :project_team # The access permission for the entity. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role # The link to this access-control entry. # 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) @bucket = args[:bucket] if args.key?(:bucket) @domain = args[:domain] if args.key?(:domain) @email = args[:email] if args.key?(:email) @entity = args[:entity] if args.key?(:entity) @entity_id = args[:entity_id] if args.key?(:entity_id) @etag = args[:etag] if args.key?(:etag) @generation = args[:generation] if args.key?(:generation) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @object = args[:object] if args.key?(:object) @project_team = args[:project_team] if args.key?(:project_team) @role = args[:role] if args.key?(:role) @self_link = args[:self_link] if args.key?(:self_link) end # The project team associated with the entity, if any. class ProjectTeam include Google::Apis::Core::Hashable # The project number. # Corresponds to the JSON property `projectNumber` # @return [String] attr_accessor :project_number # The team. # Corresponds to the JSON property `team` # @return [String] attr_accessor :team def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @project_number = args[:project_number] if args.key?(:project_number) @team = args[:team] if args.key?(:team) end end end # An access-control list. class ObjectAccessControls include Google::Apis::Core::Hashable # The list of items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of item this is. For lists of object access control entries, this is # always storage#objectAccessControls. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # A list of objects. class Objects include Google::Apis::Core::Hashable # The list of items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of item this is. For lists of objects, this is always storage#objects. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, used to page through large result sets. Provide this # value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of prefixes of objects matching-but-not-listed up to and including # the requested delimiter. # Corresponds to the JSON property `prefixes` # @return [Array] attr_accessor :prefixes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @prefixes = args[:prefixes] if args.key?(:prefixes) end end # A bucket/object IAM policy. class Policy include Google::Apis::Core::Hashable # An association between a role, which comes with a set of permissions, and # members who may assume that role. # Corresponds to the JSON property `bindings` # @return [Array] attr_accessor :bindings # HTTP 1.1 Entity tag for the policy. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # The kind of item this is. For policies, this is always storage#policy. This # field is ignored on input. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The ID of the resource to which this policy belongs. Will be of the form # projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/ # object for objects. A specific generation may be specified by appending # # generationNumber to the end of the object name, e.g. projects/_/buckets/my- # bucket/objects/data.txt#17. The current generation can be denoted with #0. # This field is ignored on input. # Corresponds to the JSON property `resourceId` # @return [String] attr_accessor :resource_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bindings = args[:bindings] if args.key?(:bindings) @etag = args[:etag] if args.key?(:etag) @kind = args[:kind] if args.key?(:kind) @resource_id = args[:resource_id] if args.key?(:resource_id) end # class Binding include Google::Apis::Core::Hashable # # Corresponds to the JSON property `condition` # @return [Object] attr_accessor :condition # A collection of identifiers for members who may assume the provided role. # Recognized identifiers are as follows: # - allUsers — A special identifier that represents anyone 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 account. For # example, user:alice@gmail.com or user:joe@example.com. # - serviceAccount:emailid — An email address that represents a service account. # For example, serviceAccount:my-other-app@appspot.gserviceaccount.com . # - group:emailid — An email address that represents a Google group. For example, # group:admins@example.com. # - domain:domain — A Google Apps domain name that represents all the users of # that domain. For example, domain:google.com or domain:example.com. # - projectOwner:projectid — Owners of the given project. For example, # projectOwner:my-example-project # - projectEditor:projectid — Editors of the given project. For example, # projectEditor:my-example-project # - projectViewer:projectid — Viewers of the given project. For example, # projectViewer:my-example-project # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members # The role to which members belong. Two types of roles are supported: new IAM # roles, which grant permissions that do not map directly to those provided by # ACLs, and legacy IAM roles, which do map directly to ACL permissions. All # roles are of the format roles/storage.specificRole. # The new IAM roles are: # - roles/storage.admin — Full control of Google Cloud Storage resources. # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage # objects. # - roles/storage.objectCreator — Access to create objects in Google Cloud # Storage. # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. # The legacy IAM roles are: # - roles/storage.legacyObjectReader — Read-only access to objects without # listing. Equivalent to an ACL entry on an object with the READER role. # - roles/storage.legacyObjectOwner — Read/write access to existing objects # without listing. Equivalent to an ACL entry on an object with the OWNER role. # - roles/storage.legacyBucketReader — Read access to buckets with object # listing. Equivalent to an ACL entry on a bucket with the READER role. # - roles/storage.legacyBucketWriter — Read access to buckets with object # listing/creation/deletion. Equivalent to an ACL entry on a bucket with the # WRITER role. # - roles/storage.legacyBucketOwner — Read and write access to existing buckets # with object listing/creation/deletion. Equivalent to an ACL entry on a bucket # with the OWNER 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) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end end # A rewrite response. class RewriteResponse include Google::Apis::Core::Hashable # true if the copy is finished; otherwise, false if the copy is in progress. # This property is always present in the response. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done # The kind of item this is. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The total size of the object being copied in bytes. This property is always # present in the response. # Corresponds to the JSON property `objectSize` # @return [Fixnum] attr_accessor :object_size # An object. # Corresponds to the JSON property `resource` # @return [Google::Apis::StorageV1::Object] attr_accessor :resource # A token to use in subsequent requests to continue copying data. This token is # present in the response only when there is more data to copy. # Corresponds to the JSON property `rewriteToken` # @return [String] attr_accessor :rewrite_token # The total bytes written so far, which can be used to provide a waiting user # with a progress indicator. This property is always present in the response. # Corresponds to the JSON property `totalBytesRewritten` # @return [Fixnum] attr_accessor :total_bytes_rewritten def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @done = args[:done] if args.key?(:done) @kind = args[:kind] if args.key?(:kind) @object_size = args[:object_size] if args.key?(:object_size) @resource = args[:resource] if args.key?(:resource) @rewrite_token = args[:rewrite_token] if args.key?(:rewrite_token) @total_bytes_rewritten = args[:total_bytes_rewritten] if args.key?(:total_bytes_rewritten) end end # A subscription to receive Google PubSub notifications. class ServiceAccount include Google::Apis::Core::Hashable # The ID of the notification. # Corresponds to the JSON property `email_address` # @return [String] attr_accessor :email_address # The kind of item this is. For notifications, this is always storage# # notification. # 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) @email_address = args[:email_address] if args.key?(:email_address) @kind = args[:kind] if args.key?(:kind) end end # A storage.(buckets|objects).testIamPermissions response. class TestIamPermissionsResponse include Google::Apis::Core::Hashable # The kind of item this is. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The permissions held by the caller. Permissions are always of the format # storage.resource.capability, where resource is one of buckets or objects. The # supported permissions are as follows: # - storage.buckets.delete — Delete bucket. # - storage.buckets.get — Read bucket metadata. # - storage.buckets.getIamPolicy — Read bucket IAM policy. # - storage.buckets.create — Create bucket. # - storage.buckets.list — List buckets. # - storage.buckets.setIamPolicy — Update bucket IAM policy. # - storage.buckets.update — Update bucket metadata. # - storage.objects.delete — Delete object. # - storage.objects.get — Read object data and metadata. # - storage.objects.getIamPolicy — Read object IAM policy. # - storage.objects.create — Create object. # - storage.objects.list — List objects. # - storage.objects.setIamPolicy — Update object IAM policy. # - storage.objects.update — Update object metadata. # 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) @kind = args[:kind] if args.key?(:kind) @permissions = args[:permissions] if args.key?(:permissions) end end end end end google-api-client-0.19.8/generated/google/apis/storage_v1/service.rb0000644000004100000410000047371313252673044025372 0ustar www-datawww-data# 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 StorageV1 # Cloud Storage JSON API # # Stores and retrieves potentially large, immutable data objects. # # @example # require 'google/apis/storage_v1' # # Storage = Google::Apis::StorageV1 # Alias the module # service = Storage::StorageService.new # # @see https://developers.google.com/storage/docs/json_api/ class StorageService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'storage/v1/') @batch_path = 'batch/storage/v1' end # Permanently deletes the ACL entry for the specified entity on the specified # bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_bucket_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}/acl/{entity}', options) command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.nil? command.query['userProject'] = user_project unless user_project.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 ACL entry for the specified entity on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::BucketAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::BucketAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/acl/{entity}', options) command.response_representation = Google::Apis::StorageV1::BucketAccessControl::Representation command.response_class = Google::Apis::StorageV1::BucketAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.nil? command.query['userProject'] = user_project unless user_project.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 ACL entry on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [Google::Apis::StorageV1::BucketAccessControl] bucket_access_control_object # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::BucketAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::BucketAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_access_control(bucket, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{bucket}/acl', options) command.request_representation = Google::Apis::StorageV1::BucketAccessControl::Representation command.request_object = bucket_access_control_object command.response_representation = Google::Apis::StorageV1::BucketAccessControl::Representation command.response_class = Google::Apis::StorageV1::BucketAccessControl command.params['bucket'] = bucket unless bucket.nil? command.query['userProject'] = user_project unless user_project.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 ACL entries on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::BucketAccessControls] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::BucketAccessControls] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_access_controls(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/acl', options) command.response_representation = Google::Apis::StorageV1::BucketAccessControls::Representation command.response_class = Google::Apis::StorageV1::BucketAccessControls command.params['bucket'] = bucket unless bucket.nil? command.query['userProject'] = user_project unless user_project.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 ACL entry on the specified bucket. This method supports patch # semantics. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1::BucketAccessControl] bucket_access_control_object # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::BucketAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::BucketAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'b/{bucket}/acl/{entity}', options) command.request_representation = Google::Apis::StorageV1::BucketAccessControl::Representation command.request_object = bucket_access_control_object command.response_representation = Google::Apis::StorageV1::BucketAccessControl::Representation command.response_class = Google::Apis::StorageV1::BucketAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.nil? command.query['userProject'] = user_project unless user_project.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 ACL entry on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1::BucketAccessControl] bucket_access_control_object # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::BucketAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::BucketAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}/acl/{entity}', options) command.request_representation = Google::Apis::StorageV1::BucketAccessControl::Representation command.request_object = bucket_access_control_object command.response_representation = Google::Apis::StorageV1::BucketAccessControl::Representation command.response_class = Google::Apis::StorageV1::BucketAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.nil? command.query['userProject'] = user_project unless user_project.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 # Permanently deletes an empty bucket. # @param [String] bucket # Name of a bucket. # @param [Fixnum] if_metageneration_match # If set, only deletes the bucket if its metageneration matches this value. # @param [Fixnum] if_metageneration_not_match # If set, only deletes the bucket if its metageneration does not match this # value. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_bucket(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}', options) command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['userProject'] = user_project unless user_project.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 metadata for the specified bucket. # @param [String] bucket # Name of a bucket. # @param [Fixnum] if_metageneration_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration does not match the given value. # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Bucket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Bucket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}', options) command.response_representation = Google::Apis::StorageV1::Bucket::Representation command.response_class = Google::Apis::StorageV1::Bucket command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.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 an IAM policy for the specified bucket. # @param [String] bucket # Name of a bucket. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::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_bucket_iam_policy(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/iam', options) command.response_representation = Google::Apis::StorageV1::Policy::Representation command.response_class = Google::Apis::StorageV1::Policy command.params['bucket'] = bucket unless bucket.nil? command.query['userProject'] = user_project unless user_project.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 bucket. # @param [String] project # A valid API project identifier. # @param [Google::Apis::StorageV1::Bucket] bucket_object # @param [String] predefined_acl # Apply a predefined set of access controls to this bucket. # @param [String] predefined_default_object_acl # Apply a predefined set of default object access controls to this bucket. # @param [String] projection # Set of properties to return. Defaults to noAcl, unless the bucket resource # specifies acl or defaultObjectAcl properties, when it defaults to full. # @param [String] user_project # The project to be billed for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Bucket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Bucket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket(project, bucket_object = nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b', options) command.request_representation = Google::Apis::StorageV1::Bucket::Representation command.request_object = bucket_object command.response_representation = Google::Apis::StorageV1::Bucket::Representation command.response_class = Google::Apis::StorageV1::Bucket command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil? command.query['predefinedDefaultObjectAcl'] = predefined_default_object_acl unless predefined_default_object_acl.nil? command.query['project'] = project unless project.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.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 buckets for a given project. # @param [String] project # A valid API project identifier. # @param [Fixnum] max_results # Maximum number of buckets to return in a single response. The service will use # this parameter or 1,000 items, whichever is smaller. # @param [String] page_token # A previously-returned page token representing part of the larger set of # results to view. # @param [String] prefix # Filter results to buckets whose names begin with this prefix. # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [String] user_project # The project to be billed for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Buckets] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Buckets] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_buckets(project, max_results: nil, page_token: nil, prefix: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b', options) command.response_representation = Google::Apis::StorageV1::Buckets::Representation command.response_class = Google::Apis::StorageV1::Buckets command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['prefix'] = prefix unless prefix.nil? command.query['project'] = project unless project.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.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 # Locks retention policy on a bucket. # @param [String] bucket # Name of a bucket. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether bucket's current metageneration # matches the given value. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Bucket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Bucket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def lock_bucket_retention_policy(bucket, if_metageneration_match, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{bucket}/lockRetentionPolicy', options) command.response_representation = Google::Apis::StorageV1::Bucket::Representation command.response_class = Google::Apis::StorageV1::Bucket command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['userProject'] = user_project unless user_project.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 a bucket. Changes to the bucket will be readable immediately after # writing, but configuration changes may take time to propagate. This method # supports patch semantics. # @param [String] bucket # Name of a bucket. # @param [Google::Apis::StorageV1::Bucket] bucket_object # @param [Fixnum] if_metageneration_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration does not match the given value. # @param [String] predefined_acl # Apply a predefined set of access controls to this bucket. # @param [String] predefined_default_object_acl # Apply a predefined set of default object access controls to this bucket. # @param [String] projection # Set of properties to return. Defaults to full. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Bucket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Bucket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket(bucket, bucket_object = nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'b/{bucket}', options) command.request_representation = Google::Apis::StorageV1::Bucket::Representation command.request_object = bucket_object command.response_representation = Google::Apis::StorageV1::Bucket::Representation command.response_class = Google::Apis::StorageV1::Bucket command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil? command.query['predefinedDefaultObjectAcl'] = predefined_default_object_acl unless predefined_default_object_acl.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.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 IAM policy for the specified bucket. # @param [String] bucket # Name of a bucket. # @param [Google::Apis::StorageV1::Policy] policy_object # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::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_bucket_iam_policy(bucket, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}/iam', options) command.request_representation = Google::Apis::StorageV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::StorageV1::Policy::Representation command.response_class = Google::Apis::StorageV1::Policy command.params['bucket'] = bucket unless bucket.nil? command.query['userProject'] = user_project unless user_project.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 # Tests a set of permissions on the given bucket to see which, if any, are held # by the caller. # @param [String] bucket # Name of a bucket. # @param [Array, String] permissions # Permissions to test. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_iam_permissions(bucket, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/iam/testPermissions', options) command.response_representation = Google::Apis::StorageV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::StorageV1::TestIamPermissionsResponse command.params['bucket'] = bucket unless bucket.nil? command.query['permissions'] = permissions unless permissions.nil? command.query['userProject'] = user_project unless user_project.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 a bucket. Changes to the bucket will be readable immediately after # writing, but configuration changes may take time to propagate. # @param [String] bucket # Name of a bucket. # @param [Google::Apis::StorageV1::Bucket] bucket_object # @param [Fixnum] if_metageneration_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration does not match the given value. # @param [String] predefined_acl # Apply a predefined set of access controls to this bucket. # @param [String] predefined_default_object_acl # Apply a predefined set of default object access controls to this bucket. # @param [String] projection # Set of properties to return. Defaults to full. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Bucket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Bucket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket(bucket, bucket_object = nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}', options) command.request_representation = Google::Apis::StorageV1::Bucket::Representation command.request_object = bucket_object command.response_representation = Google::Apis::StorageV1::Bucket::Representation command.response_class = Google::Apis::StorageV1::Bucket command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil? command.query['predefinedDefaultObjectAcl'] = predefined_default_object_acl unless predefined_default_object_acl.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.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 # Stop watching resources through this channel # @param [Google::Apis::StorageV1::Channel] channel_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'channels/stop', options) command.request_representation = Google::Apis::StorageV1::Channel::Representation command.request_object = channel_object 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 # Permanently deletes the default object ACL entry for the specified entity on # the specified bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}/defaultObjectAcl/{entity}', options) command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.nil? command.query['userProject'] = user_project unless user_project.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 default object ACL entry for the specified entity on the specified # bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/defaultObjectAcl/{entity}', options) command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.nil? command.query['userProject'] = user_project unless user_project.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 default object ACL entry on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [Google::Apis::StorageV1::ObjectAccessControl] object_access_control_object # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_default_object_access_control(bucket, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{bucket}/defaultObjectAcl', options) command.request_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.query['userProject'] = user_project unless user_project.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 default object ACL entries on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [Fixnum] if_metageneration_match # If present, only return default ACL listing if the bucket's current # metageneration matches this value. # @param [Fixnum] if_metageneration_not_match # If present, only return default ACL listing if the bucket's current # metageneration does not match the given value. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ObjectAccessControls] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ObjectAccessControls] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_default_object_access_controls(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/defaultObjectAcl', options) command.response_representation = Google::Apis::StorageV1::ObjectAccessControls::Representation command.response_class = Google::Apis::StorageV1::ObjectAccessControls command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['userProject'] = user_project unless user_project.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 a default object ACL entry on the specified bucket. This method # supports patch semantics. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1::ObjectAccessControl] object_access_control_object # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'b/{bucket}/defaultObjectAcl/{entity}', options) command.request_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.nil? command.query['userProject'] = user_project unless user_project.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 a default object ACL entry on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1::ObjectAccessControl] object_access_control_object # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}/defaultObjectAcl/{entity}', options) command.request_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.nil? command.query['userProject'] = user_project unless user_project.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 # Permanently deletes a notification subscription. # @param [String] bucket # The parent bucket of the notification. # @param [String] notification # ID of the notification to delete. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}/notificationConfigs/{notification}', options) command.params['bucket'] = bucket unless bucket.nil? command.params['notification'] = notification unless notification.nil? command.query['userProject'] = user_project unless user_project.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 # View a notification configuration. # @param [String] bucket # The parent bucket of the notification. # @param [String] notification # Notification ID # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Notification] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Notification] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/notificationConfigs/{notification}', options) command.response_representation = Google::Apis::StorageV1::Notification::Representation command.response_class = Google::Apis::StorageV1::Notification command.params['bucket'] = bucket unless bucket.nil? command.params['notification'] = notification unless notification.nil? command.query['userProject'] = user_project unless user_project.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 notification subscription for a given bucket. # @param [String] bucket # The parent bucket of the notification. # @param [Google::Apis::StorageV1::Notification] notification_object # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Notification] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Notification] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_notification(bucket, notification_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{bucket}/notificationConfigs', options) command.request_representation = Google::Apis::StorageV1::Notification::Representation command.request_object = notification_object command.response_representation = Google::Apis::StorageV1::Notification::Representation command.response_class = Google::Apis::StorageV1::Notification command.params['bucket'] = bucket unless bucket.nil? command.query['userProject'] = user_project unless user_project.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 notification subscriptions for a given bucket. # @param [String] bucket # Name of a Google Cloud Storage bucket. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Notifications] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Notifications] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_notifications(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/notificationConfigs', options) command.response_representation = Google::Apis::StorageV1::Notifications::Representation command.response_class = Google::Apis::StorageV1::Notifications command.params['bucket'] = bucket unless bucket.nil? command.query['userProject'] = user_project unless user_project.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 # Permanently deletes the ACL entry for the specified entity on the specified # object. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_object_access_control(bucket, object, entity, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}/o/{object}/acl/{entity}', options) command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.params['entity'] = entity unless entity.nil? command.query['generation'] = generation unless generation.nil? command.query['userProject'] = user_project unless user_project.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 ACL entry for the specified entity on the specified object. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_access_control(bucket, object, entity, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/o/{object}/acl/{entity}', options) command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.params['entity'] = entity unless entity.nil? command.query['generation'] = generation unless generation.nil? command.query['userProject'] = user_project unless user_project.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 ACL entry on the specified object. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [Google::Apis::StorageV1::ObjectAccessControl] object_access_control_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_access_control(bucket, object, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{bucket}/o/{object}/acl', options) command.request_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['userProject'] = user_project unless user_project.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 ACL entries on the specified object. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ObjectAccessControls] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ObjectAccessControls] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_access_controls(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/o/{object}/acl', options) command.response_representation = Google::Apis::StorageV1::ObjectAccessControls::Representation command.response_class = Google::Apis::StorageV1::ObjectAccessControls command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['userProject'] = user_project unless user_project.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 ACL entry on the specified object. This method supports patch # semantics. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1::ObjectAccessControl] object_access_control_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'b/{bucket}/o/{object}/acl/{entity}', options) command.request_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.params['entity'] = entity unless entity.nil? command.query['generation'] = generation unless generation.nil? command.query['userProject'] = user_project unless user_project.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 ACL entry on the specified object. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1::ObjectAccessControl] object_access_control_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}/o/{object}/acl/{entity}', options) command.request_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.params['entity'] = entity unless entity.nil? command.query['generation'] = generation unless generation.nil? command.query['userProject'] = user_project unless user_project.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 # Concatenates a list of existing objects into a new object in the same bucket. # @param [String] destination_bucket # Name of the bucket in which to store the new object. # @param [String] destination_object # Name of the new object. For information about how to URL encode object names # to be path safe, see Encoding URI Path Parts. # @param [Google::Apis::StorageV1::ComposeRequest] compose_request_object # @param [String] destination_predefined_acl # Apply a predefined set of access controls to the destination object. # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. Setting to 0 makes the operation succeed only if # there are no live versions of the object. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [String] kms_key_name # Resource name of the Cloud KMS key, of the form projects/my-project/locations/ # global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the # object. Overrides the object metadata's kms_key_name value, if any. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def compose_object(destination_bucket, destination_object, compose_request_object = nil, destination_predefined_acl: nil, if_generation_match: nil, if_metageneration_match: nil, kms_key_name: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{destinationBucket}/o/{destinationObject}/compose', options) command.request_representation = Google::Apis::StorageV1::ComposeRequest::Representation command.request_object = compose_request_object command.response_representation = Google::Apis::StorageV1::Object::Representation command.response_class = Google::Apis::StorageV1::Object command.params['destinationBucket'] = destination_bucket unless destination_bucket.nil? command.params['destinationObject'] = destination_object unless destination_object.nil? command.query['destinationPredefinedAcl'] = destination_predefined_acl unless destination_predefined_acl.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['kmsKeyName'] = kms_key_name unless kms_key_name.nil? command.query['userProject'] = user_project unless user_project.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 # Copies a source object to a destination object. Optionally overrides metadata. # @param [String] source_bucket # Name of the bucket in which to find the source object. # @param [String] source_object # Name of the source object. For information about how to URL encode object # names to be path safe, see Encoding URI Path Parts. # @param [String] destination_bucket # Name of the bucket in which to store the new object. Overrides the provided # object metadata's bucket value, if any.For information about how to URL encode # object names to be path safe, see Encoding URI Path Parts. # @param [String] destination_object # Name of the new object. Required when the object metadata is not otherwise # provided. Overrides the object metadata's name value, if any. # @param [Google::Apis::StorageV1::Object] object_object # @param [String] destination_predefined_acl # Apply a predefined set of access controls to the destination object. # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the destination object's current # generation matches the given value. Setting to 0 makes the operation succeed # only if there are no live versions of the object. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the destination object's current # generation does not match the given value. If no live object exists, the # precondition fails. Setting to 0 makes the operation succeed only if there is # a live version of the object. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the destination object's current # metageneration matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the destination object's current # metageneration does not match the given value. # @param [Fixnum] if_source_generation_match # Makes the operation conditional on whether the source object's current # generation matches the given value. # @param [Fixnum] if_source_generation_not_match # Makes the operation conditional on whether the source object's current # generation does not match the given value. # @param [Fixnum] if_source_metageneration_match # Makes the operation conditional on whether the source object's current # metageneration matches the given value. # @param [Fixnum] if_source_metageneration_not_match # Makes the operation conditional on whether the source object's current # metageneration does not match the given value. # @param [String] projection # Set of properties to return. Defaults to noAcl, unless the object resource # specifies the acl property, when it defaults to full. # @param [Fixnum] source_generation # If present, selects a specific revision of the source object (as opposed to # the latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def copy_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, destination_predefined_acl: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, projection: nil, source_generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}', options) command.request_representation = Google::Apis::StorageV1::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1::Object::Representation command.response_class = Google::Apis::StorageV1::Object command.params['sourceBucket'] = source_bucket unless source_bucket.nil? command.params['sourceObject'] = source_object unless source_object.nil? command.params['destinationBucket'] = destination_bucket unless destination_bucket.nil? command.params['destinationObject'] = destination_object unless destination_object.nil? command.query['destinationPredefinedAcl'] = destination_predefined_acl unless destination_predefined_acl.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['ifSourceGenerationMatch'] = if_source_generation_match unless if_source_generation_match.nil? command.query['ifSourceGenerationNotMatch'] = if_source_generation_not_match unless if_source_generation_not_match.nil? command.query['ifSourceMetagenerationMatch'] = if_source_metageneration_match unless if_source_metageneration_match.nil? command.query['ifSourceMetagenerationNotMatch'] = if_source_metageneration_not_match unless if_source_metageneration_not_match.nil? command.query['projection'] = projection unless projection.nil? command.query['sourceGeneration'] = source_generation unless source_generation.nil? command.query['userProject'] = user_project unless user_project.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 object and its metadata. Deletions are permanent if versioning is # not enabled for the bucket, or if the generation parameter is used. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [Fixnum] generation # If present, permanently deletes a specific revision of this object (as opposed # to the latest version, the default). # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. Setting to 0 makes the operation succeed only if # there are no live versions of the object. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's current generation # does not match the given value. If no live object exists, the precondition # fails. Setting to 0 makes the operation succeed only if there is a live # version of the object. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the object's current metageneration # does not match the given value. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}/o/{object}', options) command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['userProject'] = user_project unless user_project.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 object or its metadata. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. Setting to 0 makes the operation succeed only if # there are no live versions of the object. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's current generation # does not match the given value. If no live object exists, the precondition # fails. Setting to 0 makes the operation succeed only if there is a live # version of the object. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the object's current metageneration # does not match the given value. # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'b/{bucket}/o/{object}', options) else command = make_download_command(:get, 'b/{bucket}/o/{object}', options) command.download_dest = download_dest end command.response_representation = Google::Apis::StorageV1::Object::Representation command.response_class = Google::Apis::StorageV1::Object command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.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 an IAM policy for the specified object. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::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_object_iam_policy(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/o/{object}/iam', options) command.response_representation = Google::Apis::StorageV1::Policy::Representation command.response_class = Google::Apis::StorageV1::Policy command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['userProject'] = user_project unless user_project.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 # Stores a new object and metadata. # @param [String] bucket # Name of the bucket in which to store the new object. Overrides the provided # object metadata's bucket value, if any. # @param [Google::Apis::StorageV1::Object] object_object # @param [String] content_encoding # If set, sets the contentEncoding property of the final object to this value. # Setting this parameter is equivalent to setting the contentEncoding metadata # property. This can be useful when uploading an object with uploadType=media to # indicate the encoding of the content being uploaded. # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. Setting to 0 makes the operation succeed only if # there are no live versions of the object. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's current generation # does not match the given value. If no live object exists, the precondition # fails. Setting to 0 makes the operation succeed only if there is a live # version of the object. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the object's current metageneration # does not match the given value. # @param [String] kms_key_name # Resource name of the Cloud KMS key, of the form projects/my-project/locations/ # global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the # object. Overrides the object metadata's kms_key_name value, if any. Limited # availability; usable only by enabled projects. # @param [String] name # Name of the object. Required when the object metadata is not otherwise # provided. Overrides the object metadata's name value, if any. For information # about how to URL encode object names to be path safe, see Encoding URI Path # Parts. # @param [String] predefined_acl # Apply a predefined set of access controls to this object. # @param [String] projection # Set of properties to return. Defaults to noAcl, unless the object resource # specifies the acl property, when it defaults to full. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::StorageV1::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object(bucket, object_object = nil, content_encoding: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, kms_key_name: nil, name: nil, predefined_acl: nil, projection: nil, user_project: 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, 'b/{bucket}/o', options) else command = make_upload_command(:post, 'b/{bucket}/o', options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::StorageV1::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1::Object::Representation command.response_class = Google::Apis::StorageV1::Object command.params['bucket'] = bucket unless bucket.nil? command.query['contentEncoding'] = content_encoding unless content_encoding.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['kmsKeyName'] = kms_key_name unless kms_key_name.nil? command.query['name'] = name unless name.nil? command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.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 objects matching the criteria. # @param [String] bucket # Name of the bucket in which to look for objects. # @param [String] delimiter # Returns results in a directory-like mode. items will contain only objects # whose names, aside from the prefix, do not contain delimiter. Objects whose # names, aside from the prefix, contain delimiter will have their name, # truncated after the delimiter, returned in prefixes. Duplicate prefixes are # omitted. # @param [Fixnum] max_results # Maximum number of items plus prefixes to return in a single page of responses. # As duplicate prefixes are omitted, fewer total results may be returned than # requested. The service will use this parameter or 1,000 items, whichever is # smaller. # @param [String] page_token # A previously-returned page token representing part of the larger set of # results to view. # @param [String] prefix # Filter results to objects whose names begin with this prefix. # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @param [Boolean] versions # If true, lists all versions of an object as distinct results. The default is # false. For more information, see Object Versioning. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Objects] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Objects] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_objects(bucket, delimiter: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, user_project: nil, versions: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/o', options) command.response_representation = Google::Apis::StorageV1::Objects::Representation command.response_class = Google::Apis::StorageV1::Objects command.params['bucket'] = bucket unless bucket.nil? command.query['delimiter'] = delimiter unless delimiter.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['prefix'] = prefix unless prefix.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.nil? command.query['versions'] = versions unless versions.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 # Patches an object's metadata. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [Google::Apis::StorageV1::Object] object_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. Setting to 0 makes the operation succeed only if # there are no live versions of the object. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's current generation # does not match the given value. If no live object exists, the precondition # fails. Setting to 0 makes the operation succeed only if there is a live # version of the object. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the object's current metageneration # does not match the given value. # @param [String] predefined_acl # Apply a predefined set of access controls to this object. # @param [String] projection # Set of properties to return. Defaults to full. # @param [String] user_project # The project to be billed for this request, for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'b/{bucket}/o/{object}', options) command.request_representation = Google::Apis::StorageV1::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1::Object::Representation command.response_class = Google::Apis::StorageV1::Object command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.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 # Rewrites a source object to a destination object. Optionally overrides # metadata. # @param [String] source_bucket # Name of the bucket in which to find the source object. # @param [String] source_object # Name of the source object. For information about how to URL encode object # names to be path safe, see Encoding URI Path Parts. # @param [String] destination_bucket # Name of the bucket in which to store the new object. Overrides the provided # object metadata's bucket value, if any. # @param [String] destination_object # Name of the new object. Required when the object metadata is not otherwise # provided. Overrides the object metadata's name value, if any. For information # about how to URL encode object names to be path safe, see Encoding URI Path # Parts. # @param [Google::Apis::StorageV1::Object] object_object # @param [String] destination_kms_key_name # Resource name of the Cloud KMS key, of the form projects/my-project/locations/ # global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the # object. Overrides the object metadata's kms_key_name value, if any. # @param [String] destination_predefined_acl # Apply a predefined set of access controls to the destination object. # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. Setting to 0 makes the operation succeed only if # there are no live versions of the object. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's current generation # does not match the given value. If no live object exists, the precondition # fails. Setting to 0 makes the operation succeed only if there is a live # version of the object. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the destination object's current # metageneration matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the destination object's current # metageneration does not match the given value. # @param [Fixnum] if_source_generation_match # Makes the operation conditional on whether the source object's current # generation matches the given value. # @param [Fixnum] if_source_generation_not_match # Makes the operation conditional on whether the source object's current # generation does not match the given value. # @param [Fixnum] if_source_metageneration_match # Makes the operation conditional on whether the source object's current # metageneration matches the given value. # @param [Fixnum] if_source_metageneration_not_match # Makes the operation conditional on whether the source object's current # metageneration does not match the given value. # @param [Fixnum] max_bytes_rewritten_per_call # The maximum number of bytes that will be rewritten per rewrite request. Most # callers shouldn't need to specify this parameter - it is primarily in place to # support testing. If specified the value must be an integral multiple of 1 MiB ( # 1048576). Also, this only applies to requests where the source and destination # span locations and/or storage classes. Finally, this value must not change # across rewrite calls else you'll get an error that the rewriteToken is invalid. # @param [String] projection # Set of properties to return. Defaults to noAcl, unless the object resource # specifies the acl property, when it defaults to full. # @param [String] rewrite_token # Include this field (from the previous rewrite response) on each rewrite # request after the first one, until the rewrite response 'done' flag is true. # Calls that provide a rewriteToken can omit all other request fields, but if # included those fields must match the values provided in the first rewrite # request. # @param [Fixnum] source_generation # If present, selects a specific revision of the source object (as opposed to # the latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::RewriteResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::RewriteResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def rewrite_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, destination_kms_key_name: nil, destination_predefined_acl: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, max_bytes_rewritten_per_call: nil, projection: nil, rewrite_token: nil, source_generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}', options) command.request_representation = Google::Apis::StorageV1::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1::RewriteResponse::Representation command.response_class = Google::Apis::StorageV1::RewriteResponse command.params['sourceBucket'] = source_bucket unless source_bucket.nil? command.params['sourceObject'] = source_object unless source_object.nil? command.params['destinationBucket'] = destination_bucket unless destination_bucket.nil? command.params['destinationObject'] = destination_object unless destination_object.nil? command.query['destinationKmsKeyName'] = destination_kms_key_name unless destination_kms_key_name.nil? command.query['destinationPredefinedAcl'] = destination_predefined_acl unless destination_predefined_acl.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['ifSourceGenerationMatch'] = if_source_generation_match unless if_source_generation_match.nil? command.query['ifSourceGenerationNotMatch'] = if_source_generation_not_match unless if_source_generation_not_match.nil? command.query['ifSourceMetagenerationMatch'] = if_source_metageneration_match unless if_source_metageneration_match.nil? command.query['ifSourceMetagenerationNotMatch'] = if_source_metageneration_not_match unless if_source_metageneration_not_match.nil? command.query['maxBytesRewrittenPerCall'] = max_bytes_rewritten_per_call unless max_bytes_rewritten_per_call.nil? command.query['projection'] = projection unless projection.nil? command.query['rewriteToken'] = rewrite_token unless rewrite_token.nil? command.query['sourceGeneration'] = source_generation unless source_generation.nil? command.query['userProject'] = user_project unless user_project.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 IAM policy for the specified object. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [Google::Apis::StorageV1::Policy] policy_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::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_object_iam_policy(bucket, object, policy_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}/o/{object}/iam', options) command.request_representation = Google::Apis::StorageV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::StorageV1::Policy::Representation command.response_class = Google::Apis::StorageV1::Policy command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['userProject'] = user_project unless user_project.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 # Tests a set of permissions on the given object to see which, if any, are held # by the caller. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [Array, String] permissions # Permissions to test. # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_iam_permissions(bucket, object, permissions, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/o/{object}/iam/testPermissions', options) command.response_representation = Google::Apis::StorageV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::StorageV1::TestIamPermissionsResponse command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['permissions'] = permissions unless permissions.nil? command.query['userProject'] = user_project unless user_project.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 object's metadata. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. For information about how to URL encode object names to be # path safe, see Encoding URI Path Parts. # @param [Google::Apis::StorageV1::Object] object_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. Setting to 0 makes the operation succeed only if # there are no live versions of the object. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's current generation # does not match the given value. If no live object exists, the precondition # fails. Setting to 0 makes the operation succeed only if there is a live # version of the object. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the object's current metageneration # does not match the given value. # @param [String] predefined_acl # Apply a predefined set of access controls to this object. # @param [String] projection # Set of properties to return. Defaults to full. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}/o/{object}', options) command.request_representation = Google::Apis::StorageV1::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1::Object::Representation command.response_class = Google::Apis::StorageV1::Object command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.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 # Watch for changes on all objects in a bucket. # @param [String] bucket # Name of the bucket in which to look for objects. # @param [Google::Apis::StorageV1::Channel] channel_object # @param [String] delimiter # Returns results in a directory-like mode. items will contain only objects # whose names, aside from the prefix, do not contain delimiter. Objects whose # names, aside from the prefix, contain delimiter will have their name, # truncated after the delimiter, returned in prefixes. Duplicate prefixes are # omitted. # @param [Fixnum] max_results # Maximum number of items plus prefixes to return in a single page of responses. # As duplicate prefixes are omitted, fewer total results may be returned than # requested. The service will use this parameter or 1,000 items, whichever is # smaller. # @param [String] page_token # A previously-returned page token representing part of the larger set of # results to view. # @param [String] prefix # Filter results to objects whose names begin with this prefix. # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [String] user_project # The project to be billed for this request. Required for Requester Pays buckets. # @param [Boolean] versions # If true, lists all versions of an object as distinct results. The default is # false. For more information, see Object Versioning. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::Channel] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::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 watch_all_objects(bucket, channel_object = nil, delimiter: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, user_project: nil, versions: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{bucket}/o/watch', options) command.request_representation = Google::Apis::StorageV1::Channel::Representation command.request_object = channel_object command.response_representation = Google::Apis::StorageV1::Channel::Representation command.response_class = Google::Apis::StorageV1::Channel command.params['bucket'] = bucket unless bucket.nil? command.query['delimiter'] = delimiter unless delimiter.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['prefix'] = prefix unless prefix.nil? command.query['projection'] = projection unless projection.nil? command.query['userProject'] = user_project unless user_project.nil? command.query['versions'] = versions unless versions.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 # Get the email address of this project's Google Cloud Storage service account. # @param [String] project_id # Project ID # @param [String] user_project # The project to be billed for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1::ServiceAccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1::ServiceAccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_service_account(project_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'projects/{projectId}/serviceAccount', options) command.response_representation = Google::Apis::StorageV1::ServiceAccount::Representation command.response_class = Google::Apis::StorageV1::ServiceAccount command.params['projectId'] = project_id unless project_id.nil? command.query['userProject'] = user_project unless user_project.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 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 end end google-api-client-0.19.8/generated/google/apis/appengine_v1.rb0000644000004100000410000000276213252673043024223 0ustar www-datawww-data# 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/appengine_v1/service.rb' require 'google/apis/appengine_v1/classes.rb' require 'google/apis/appengine_v1/representations.rb' module Google module Apis # Google App Engine Admin API # # The App Engine Admin API enables developers to provision and manage their App # Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1 VERSION = 'V1' REVISION = '20180209' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' end end end google-api-client-0.19.8/generated/google/apis/groupssettings_v1/0000755000004100000410000000000013252673043025021 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/groupssettings_v1/representations.rb0000644000004100000410000000601313252673043030573 0ustar www-datawww-data# 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 GroupssettingsV1 class Groups class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Groups # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_external_members, as: 'allowExternalMembers' property :allow_google_communication, as: 'allowGoogleCommunication' property :allow_web_posting, as: 'allowWebPosting' property :archive_only, as: 'archiveOnly' property :custom_footer_text, as: 'customFooterText' property :custom_reply_to, as: 'customReplyTo' property :default_message_deny_notification_text, as: 'defaultMessageDenyNotificationText' property :description, as: 'description' property :email, as: 'email' property :include_custom_footer, as: 'includeCustomFooter' property :include_in_global_address_list, as: 'includeInGlobalAddressList' property :is_archived, as: 'isArchived' property :kind, as: 'kind' property :max_message_bytes, as: 'maxMessageBytes' property :members_can_post_as_the_group, as: 'membersCanPostAsTheGroup' property :message_display_font, as: 'messageDisplayFont' property :message_moderation_level, as: 'messageModerationLevel' property :name, as: 'name' property :primary_language, as: 'primaryLanguage' property :reply_to, as: 'replyTo' property :send_message_deny_notification, as: 'sendMessageDenyNotification' property :show_in_group_directory, as: 'showInGroupDirectory' property :spam_moderation_level, as: 'spamModerationLevel' property :who_can_add, as: 'whoCanAdd' property :who_can_contact_owner, as: 'whoCanContactOwner' property :who_can_invite, as: 'whoCanInvite' property :who_can_join, as: 'whoCanJoin' property :who_can_leave_group, as: 'whoCanLeaveGroup' property :who_can_post_message, as: 'whoCanPostMessage' property :who_can_view_group, as: 'whoCanViewGroup' property :who_can_view_membership, as: 'whoCanViewMembership' end end end end end google-api-client-0.19.8/generated/google/apis/groupssettings_v1/classes.rb0000644000004100000410000002531713252673043027013 0ustar www-datawww-data# 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 GroupssettingsV1 # JSON template for Group resource class Groups include Google::Apis::Core::Hashable # Are external members allowed to join the group. # Corresponds to the JSON property `allowExternalMembers` # @return [String] attr_accessor :allow_external_members # Is google allowed to contact admins. # Corresponds to the JSON property `allowGoogleCommunication` # @return [String] attr_accessor :allow_google_communication # If posting from web is allowed. # Corresponds to the JSON property `allowWebPosting` # @return [String] attr_accessor :allow_web_posting # If the group is archive only # Corresponds to the JSON property `archiveOnly` # @return [String] attr_accessor :archive_only # Custom footer text. # Corresponds to the JSON property `customFooterText` # @return [String] attr_accessor :custom_footer_text # Default email to which reply to any message should go. # Corresponds to the JSON property `customReplyTo` # @return [String] attr_accessor :custom_reply_to # Default message deny notification message # Corresponds to the JSON property `defaultMessageDenyNotificationText` # @return [String] attr_accessor :default_message_deny_notification_text # Description of the group # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Email id of the group # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # Whether to include custom footer. # Corresponds to the JSON property `includeCustomFooter` # @return [String] attr_accessor :include_custom_footer # If this groups should be included in global address list or not. # Corresponds to the JSON property `includeInGlobalAddressList` # @return [String] attr_accessor :include_in_global_address_list # If the contents of the group are archived. # Corresponds to the JSON property `isArchived` # @return [String] attr_accessor :is_archived # The type of the resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Maximum message size allowed. # Corresponds to the JSON property `maxMessageBytes` # @return [Fixnum] attr_accessor :max_message_bytes # Can members post using the group email address. # Corresponds to the JSON property `membersCanPostAsTheGroup` # @return [String] attr_accessor :members_can_post_as_the_group # Default message display font. Possible values are: DEFAULT_FONT # FIXED_WIDTH_FONT # Corresponds to the JSON property `messageDisplayFont` # @return [String] attr_accessor :message_display_font # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES # MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE # Corresponds to the JSON property `messageModerationLevel` # @return [String] attr_accessor :message_moderation_level # Name of the Group # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Primary language for the group. # Corresponds to the JSON property `primaryLanguage` # @return [String] attr_accessor :primary_language # Whome should the default reply to a message go to. Possible values are: # REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE # REPLY_TO_MANAGERS # Corresponds to the JSON property `replyTo` # @return [String] attr_accessor :reply_to # Should the member be notified if his message is denied by owner. # Corresponds to the JSON property `sendMessageDenyNotification` # @return [String] attr_accessor :send_message_deny_notification # Is the group listed in groups directory # Corresponds to the JSON property `showInGroupDirectory` # @return [String] attr_accessor :show_in_group_directory # Moderation level for messages detected as spam. Possible values are: ALLOW # MODERATE SILENTLY_MODERATE REJECT # Corresponds to the JSON property `spamModerationLevel` # @return [String] attr_accessor :spam_moderation_level # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD # ALL_MEMBERS_CAN_ADD NONE_CAN_ADD # Corresponds to the JSON property `whoCanAdd` # @return [String] attr_accessor :who_can_add # Permission to contact owner of the group via web UI. Possible values are: # ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT # ALL_MANAGERS_CAN_CONTACT # Corresponds to the JSON property `whoCanContactOwner` # @return [String] attr_accessor :who_can_contact_owner # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE # ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE # Corresponds to the JSON property `whoCanInvite` # @return [String] attr_accessor :who_can_invite # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN # ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN # Corresponds to the JSON property `whoCanJoin` # @return [String] attr_accessor :who_can_join # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE # ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE # Corresponds to the JSON property `whoCanLeaveGroup` # @return [String] attr_accessor :who_can_leave_group # Permissions to post messages to the group. Possible values are: NONE_CAN_POST # ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_OWNERS_CAN_POST # ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST # Corresponds to the JSON property `whoCanPostMessage` # @return [String] attr_accessor :who_can_post_message # Permissions to view group. Possible values are: ANYONE_CAN_VIEW # ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW # Corresponds to the JSON property `whoCanViewGroup` # @return [String] attr_accessor :who_can_view_group # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW # ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW # Corresponds to the JSON property `whoCanViewMembership` # @return [String] attr_accessor :who_can_view_membership def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allow_external_members = args[:allow_external_members] if args.key?(:allow_external_members) @allow_google_communication = args[:allow_google_communication] if args.key?(:allow_google_communication) @allow_web_posting = args[:allow_web_posting] if args.key?(:allow_web_posting) @archive_only = args[:archive_only] if args.key?(:archive_only) @custom_footer_text = args[:custom_footer_text] if args.key?(:custom_footer_text) @custom_reply_to = args[:custom_reply_to] if args.key?(:custom_reply_to) @default_message_deny_notification_text = args[:default_message_deny_notification_text] if args.key?(:default_message_deny_notification_text) @description = args[:description] if args.key?(:description) @email = args[:email] if args.key?(:email) @include_custom_footer = args[:include_custom_footer] if args.key?(:include_custom_footer) @include_in_global_address_list = args[:include_in_global_address_list] if args.key?(:include_in_global_address_list) @is_archived = args[:is_archived] if args.key?(:is_archived) @kind = args[:kind] if args.key?(:kind) @max_message_bytes = args[:max_message_bytes] if args.key?(:max_message_bytes) @members_can_post_as_the_group = args[:members_can_post_as_the_group] if args.key?(:members_can_post_as_the_group) @message_display_font = args[:message_display_font] if args.key?(:message_display_font) @message_moderation_level = args[:message_moderation_level] if args.key?(:message_moderation_level) @name = args[:name] if args.key?(:name) @primary_language = args[:primary_language] if args.key?(:primary_language) @reply_to = args[:reply_to] if args.key?(:reply_to) @send_message_deny_notification = args[:send_message_deny_notification] if args.key?(:send_message_deny_notification) @show_in_group_directory = args[:show_in_group_directory] if args.key?(:show_in_group_directory) @spam_moderation_level = args[:spam_moderation_level] if args.key?(:spam_moderation_level) @who_can_add = args[:who_can_add] if args.key?(:who_can_add) @who_can_contact_owner = args[:who_can_contact_owner] if args.key?(:who_can_contact_owner) @who_can_invite = args[:who_can_invite] if args.key?(:who_can_invite) @who_can_join = args[:who_can_join] if args.key?(:who_can_join) @who_can_leave_group = args[:who_can_leave_group] if args.key?(:who_can_leave_group) @who_can_post_message = args[:who_can_post_message] if args.key?(:who_can_post_message) @who_can_view_group = args[:who_can_view_group] if args.key?(:who_can_view_group) @who_can_view_membership = args[:who_can_view_membership] if args.key?(:who_can_view_membership) end end end end end google-api-client-0.19.8/generated/google/apis/groupssettings_v1/service.rb0000644000004100000410000002206413252673043027012 0ustar www-datawww-data# 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 GroupssettingsV1 # Groups Settings API # # Lets you manage permission levels and related settings of a group. # # @example # require 'google/apis/groupssettings_v1' # # Groupssettings = Google::Apis::GroupssettingsV1 # Alias the module # service = Groupssettings::GroupssettingsService.new # # @see https://developers.google.com/google-apps/groups-settings/get_started class GroupssettingsService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'groups/v1/groups/') @batch_path = 'batch/groupssettings/v1' end # Gets one resource by id. # @param [String] group_unique_id # The resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GroupssettingsV1::Groups] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GroupssettingsV1::Groups] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(group_unique_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{groupUniqueId}', options) command.query['alt'] = 'json' command.response_representation = Google::Apis::GroupssettingsV1::Groups::Representation command.response_class = Google::Apis::GroupssettingsV1::Groups command.params['groupUniqueId'] = group_unique_id unless group_unique_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 an existing resource. This method supports patch semantics. # @param [String] group_unique_id # The resource ID # @param [Google::Apis::GroupssettingsV1::Groups] groups_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GroupssettingsV1::Groups] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GroupssettingsV1::Groups] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(group_unique_id, groups_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{groupUniqueId}', options) command.request_representation = Google::Apis::GroupssettingsV1::Groups::Representation command.request_object = groups_object command.query['alt'] = 'json' command.response_representation = Google::Apis::GroupssettingsV1::Groups::Representation command.response_class = Google::Apis::GroupssettingsV1::Groups command.params['groupUniqueId'] = group_unique_id unless group_unique_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 an existing resource. # @param [String] group_unique_id # The resource ID # @param [Google::Apis::GroupssettingsV1::Groups] groups_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GroupssettingsV1::Groups] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GroupssettingsV1::Groups] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(group_unique_id, groups_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{groupUniqueId}', options) command.request_representation = Google::Apis::GroupssettingsV1::Groups::Representation command.request_object = groups_object command.query['alt'] = 'json' command.response_representation = Google::Apis::GroupssettingsV1::Groups::Representation command.response_class = Google::Apis::GroupssettingsV1::Groups command.params['groupUniqueId'] = group_unique_id unless group_unique_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 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 end end google-api-client-0.19.8/generated/google/apis/site_verification_v1/0000755000004100000410000000000013252673044025430 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/site_verification_v1/representations.rb0000644000004100000410000000760613252673044031213 0ustar www-datawww-data# 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 SiteVerificationV1 class GetWebResourceTokenRequest class Representation < Google::Apis::Core::JsonRepresentation; end class Site class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class GetWebResourceTokenResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListWebResourceResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SiteVerificationWebResourceResource class Representation < Google::Apis::Core::JsonRepresentation; end class Site class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class GetWebResourceTokenRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :site, as: 'site', class: Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest::Site, decorator: Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest::Site::Representation property :verification_method, as: 'verificationMethod' end class Site # @private class Representation < Google::Apis::Core::JsonRepresentation property :identifier, as: 'identifier' property :type, as: 'type' end end end class GetWebResourceTokenResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :verification_method, as: 'method' property :token, as: 'token' end end class ListWebResourceResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource, decorator: Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation end end class SiteVerificationWebResourceResource # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :owners, as: 'owners' property :site, as: 'site', class: Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Site, decorator: Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Site::Representation end class Site # @private class Representation < Google::Apis::Core::JsonRepresentation property :identifier, as: 'identifier' property :type, as: 'type' end end end end end end google-api-client-0.19.8/generated/google/apis/site_verification_v1/classes.rb0000644000004100000410000001477013252673044027423 0ustar www-datawww-data# 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 SiteVerificationV1 # class GetWebResourceTokenRequest include Google::Apis::Core::Hashable # The site for which a verification token will be generated. # Corresponds to the JSON property `site` # @return [Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest::Site] attr_accessor :site # The verification method that will be used to verify this site. For sites, ' # FILE' or 'META' methods may be used. For domains, only 'DNS' may be used. # Corresponds to the JSON property `verificationMethod` # @return [String] attr_accessor :verification_method def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @site = args[:site] if args.key?(:site) @verification_method = args[:verification_method] if args.key?(:verification_method) end # The site for which a verification token will be generated. class Site include Google::Apis::Core::Hashable # The site identifier. If the type is set to SITE, the identifier is a URL. If # the type is set to INET_DOMAIN, the site identifier is a domain name. # Corresponds to the JSON property `identifier` # @return [String] attr_accessor :identifier # The type of resource to be verified. Can be SITE or INET_DOMAIN (domain 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) @identifier = args[:identifier] if args.key?(:identifier) @type = args[:type] if args.key?(:type) end end end # class GetWebResourceTokenResponse include Google::Apis::Core::Hashable # The verification method to use in conjunction with this token. For FILE, the # token should be placed in the top-level directory of the site, stored inside a # file of the same name. For META, the token should be placed in the HEAD tag of # the default page that is loaded for the site. For DNS, the token should be # placed in a TXT record of the domain. # Corresponds to the JSON property `method` # @return [String] attr_accessor :verification_method # The verification token. The token must be placed appropriately in order for # verification to succeed. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @verification_method = args[:verification_method] if args.key?(:verification_method) @token = args[:token] if args.key?(:token) end end # class ListWebResourceResponse include Google::Apis::Core::Hashable # The list of sites that are owned by the authenticated user. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) end end # class SiteVerificationWebResourceResource include Google::Apis::Core::Hashable # The string used to identify this site. This value should be used in the "id" # portion of the REST URL for the Get, Update, and Delete operations. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The email addresses of all verified owners. # Corresponds to the JSON property `owners` # @return [Array] attr_accessor :owners # The address and type of a site that is verified or will be verified. # Corresponds to the JSON property `site` # @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Site] attr_accessor :site def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @owners = args[:owners] if args.key?(:owners) @site = args[:site] if args.key?(:site) end # The address and type of a site that is verified or will be verified. class Site include Google::Apis::Core::Hashable # The site identifier. If the type is set to SITE, the identifier is a URL. If # the type is set to INET_DOMAIN, the site identifier is a domain name. # Corresponds to the JSON property `identifier` # @return [String] attr_accessor :identifier # The site type. Can be SITE or INET_DOMAIN (domain 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) @identifier = args[:identifier] if args.key?(:identifier) @type = args[:type] if args.key?(:type) end end end end end end google-api-client-0.19.8/generated/google/apis/site_verification_v1/service.rb0000644000004100000410000004441113252673044027421 0ustar www-datawww-data# 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 SiteVerificationV1 # Google Site Verification API # # Verifies ownership of websites or domains with Google. # # @example # require 'google/apis/site_verification_v1' # # SiteVerification = Google::Apis::SiteVerificationV1 # Alias the module # service = SiteVerification::SiteVerificationService.new # # @see https://developers.google.com/site-verification/ class SiteVerificationService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'siteVerification/v1/') @batch_path = 'batch/siteVerification/v1' end # Relinquish ownership of a website or domain. # @param [String] id # The id of a verified site or domain. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_web_resource(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'webResource/{id}', options) command.params['id'] = id unless 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 # Get the most current data for a website or domain. # @param [String] id # The id of a verified site or domain. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resource(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'webResource/{id}', options) command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.params['id'] = id unless 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 # Get a verification token for placing on a website or domain. # @param [Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest] get_web_resource_token_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resource_token(get_web_resource_token_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'token', options) command.request_representation = Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest::Representation command.request_object = get_web_resource_token_request_object command.response_representation = Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse::Representation command.response_class = Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse 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 # Attempt verification of a website or domain. # @param [String] verification_method # The method to use for verifying a site or domain. # @param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resource(verification_method, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'webResource', options) command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.request_object = site_verification_web_resource_resource_object command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.query['verificationMethod'] = verification_method unless verification_method.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 # Get the list of your verified websites and domains. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SiteVerificationV1::ListWebResourceResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::ListWebResourceResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resources(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'webResource', options) command.response_representation = Google::Apis::SiteVerificationV1::ListWebResourceResponse::Representation command.response_class = Google::Apis::SiteVerificationV1::ListWebResourceResponse 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 # Modify the list of owners for your website or domain. This method supports # patch semantics. # @param [String] id # The id of a verified site or domain. # @param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resource(id, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'webResource/{id}', options) command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.request_object = site_verification_web_resource_resource_object command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.params['id'] = id unless 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 # Modify the list of owners for your website or domain. # @param [String] id # The id of a verified site or domain. # @param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resource(id, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'webResource/{id}', options) command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.request_object = site_verification_web_resource_resource_object command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.params['id'] = id unless 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 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 end end google-api-client-0.19.8/generated/google/apis/tagmanager_v1/0000755000004100000410000000000013252673044024030 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/tagmanager_v1/representations.rb0000644000004100000410000006427613252673044027621 0ustar www-datawww-data# 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 TagmanagerV1 class Account class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountAccess class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Condition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Container class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContainerAccess class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContainerVersion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContainerVersionHeader class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateContainerVersionRequestVersionOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateContainerVersionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Environment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Folder class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FolderEntities class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAccountUsersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAccountsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListContainerVersionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListContainersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListEnvironmentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListFoldersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTagsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTriggersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListVariablesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Macro class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Parameter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PublishContainerVersionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Rule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetupTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Tag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TeardownTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Trigger class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserAccess class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Variable class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Account # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :fingerprint, as: 'fingerprint' property :name, as: 'name' property :share_data, as: 'shareData' end end class AccountAccess # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permission, as: 'permission' end end class Condition # @private class Representation < Google::Apis::Core::JsonRepresentation collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :type, as: 'type' end end class Container # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :container_id, as: 'containerId' collection :domain_name, as: 'domainName' collection :enabled_built_in_variable, as: 'enabledBuiltInVariable' property :fingerprint, as: 'fingerprint' property :name, as: 'name' property :notes, as: 'notes' property :public_id, as: 'publicId' property :time_zone_country_id, as: 'timeZoneCountryId' property :time_zone_id, as: 'timeZoneId' collection :usage_context, as: 'usageContext' end end class ContainerAccess # @private class Representation < Google::Apis::Core::JsonRepresentation property :container_id, as: 'containerId' collection :permission, as: 'permission' end end class ContainerVersion # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :container, as: 'container', class: Google::Apis::TagmanagerV1::Container, decorator: Google::Apis::TagmanagerV1::Container::Representation property :container_id, as: 'containerId' property :container_version_id, as: 'containerVersionId' property :deleted, as: 'deleted' property :fingerprint, as: 'fingerprint' collection :folder, as: 'folder', class: Google::Apis::TagmanagerV1::Folder, decorator: Google::Apis::TagmanagerV1::Folder::Representation collection :macro, as: 'macro', class: Google::Apis::TagmanagerV1::Macro, decorator: Google::Apis::TagmanagerV1::Macro::Representation property :name, as: 'name' property :notes, as: 'notes' collection :rule, as: 'rule', class: Google::Apis::TagmanagerV1::Rule, decorator: Google::Apis::TagmanagerV1::Rule::Representation collection :tag, as: 'tag', class: Google::Apis::TagmanagerV1::Tag, decorator: Google::Apis::TagmanagerV1::Tag::Representation collection :trigger, as: 'trigger', class: Google::Apis::TagmanagerV1::Trigger, decorator: Google::Apis::TagmanagerV1::Trigger::Representation collection :variable, as: 'variable', class: Google::Apis::TagmanagerV1::Variable, decorator: Google::Apis::TagmanagerV1::Variable::Representation end end class ContainerVersionHeader # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :container_id, as: 'containerId' property :container_version_id, as: 'containerVersionId' property :deleted, as: 'deleted' property :name, as: 'name' property :num_macros, as: 'numMacros' property :num_rules, as: 'numRules' property :num_tags, as: 'numTags' property :num_triggers, as: 'numTriggers' property :num_variables, as: 'numVariables' end end class CreateContainerVersionRequestVersionOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :notes, as: 'notes' property :quick_preview, as: 'quickPreview' end end class CreateContainerVersionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :compiler_error, as: 'compilerError' property :container_version, as: 'containerVersion', class: Google::Apis::TagmanagerV1::ContainerVersion, decorator: Google::Apis::TagmanagerV1::ContainerVersion::Representation end end class Environment # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :authorization_code, as: 'authorizationCode' property :authorization_timestamp_ms, :numeric_string => true, as: 'authorizationTimestampMs' property :container_id, as: 'containerId' property :container_version_id, as: 'containerVersionId' property :description, as: 'description' property :enable_debug, as: 'enableDebug' property :environment_id, as: 'environmentId' property :fingerprint, as: 'fingerprint' property :name, as: 'name' property :type, as: 'type' property :url, as: 'url' end end class Folder # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :container_id, as: 'containerId' property :fingerprint, as: 'fingerprint' property :folder_id, as: 'folderId' property :name, as: 'name' end end class FolderEntities # @private class Representation < Google::Apis::Core::JsonRepresentation collection :tag, as: 'tag', class: Google::Apis::TagmanagerV1::Tag, decorator: Google::Apis::TagmanagerV1::Tag::Representation collection :trigger, as: 'trigger', class: Google::Apis::TagmanagerV1::Trigger, decorator: Google::Apis::TagmanagerV1::Trigger::Representation collection :variable, as: 'variable', class: Google::Apis::TagmanagerV1::Variable, decorator: Google::Apis::TagmanagerV1::Variable::Representation end end class ListAccountUsersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :user_access, as: 'userAccess', class: Google::Apis::TagmanagerV1::UserAccess, decorator: Google::Apis::TagmanagerV1::UserAccess::Representation end end class ListAccountsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accounts, as: 'accounts', class: Google::Apis::TagmanagerV1::Account, decorator: Google::Apis::TagmanagerV1::Account::Representation end end class ListContainerVersionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :container_version, as: 'containerVersion', class: Google::Apis::TagmanagerV1::ContainerVersion, decorator: Google::Apis::TagmanagerV1::ContainerVersion::Representation collection :container_version_header, as: 'containerVersionHeader', class: Google::Apis::TagmanagerV1::ContainerVersionHeader, decorator: Google::Apis::TagmanagerV1::ContainerVersionHeader::Representation end end class ListContainersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :containers, as: 'containers', class: Google::Apis::TagmanagerV1::Container, decorator: Google::Apis::TagmanagerV1::Container::Representation end end class ListEnvironmentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :environments, as: 'environments', class: Google::Apis::TagmanagerV1::Environment, decorator: Google::Apis::TagmanagerV1::Environment::Representation end end class ListFoldersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :folders, as: 'folders', class: Google::Apis::TagmanagerV1::Folder, decorator: Google::Apis::TagmanagerV1::Folder::Representation end end class ListTagsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :tags, as: 'tags', class: Google::Apis::TagmanagerV1::Tag, decorator: Google::Apis::TagmanagerV1::Tag::Representation end end class ListTriggersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :triggers, as: 'triggers', class: Google::Apis::TagmanagerV1::Trigger, decorator: Google::Apis::TagmanagerV1::Trigger::Representation end end class ListVariablesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :variables, as: 'variables', class: Google::Apis::TagmanagerV1::Variable, decorator: Google::Apis::TagmanagerV1::Variable::Representation end end class Macro # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :container_id, as: 'containerId' collection :disabling_rule_id, as: 'disablingRuleId' collection :enabling_rule_id, as: 'enablingRuleId' property :fingerprint, as: 'fingerprint' property :macro_id, as: 'macroId' property :name, as: 'name' property :notes, as: 'notes' collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :parent_folder_id, as: 'parentFolderId' property :schedule_end_ms, :numeric_string => true, as: 'scheduleEndMs' property :schedule_start_ms, :numeric_string => true, as: 'scheduleStartMs' property :type, as: 'type' end end class Parameter # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' collection :list, as: 'list', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation collection :map, as: 'map', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :type, as: 'type' property :value, as: 'value' end end class PublishContainerVersionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :compiler_error, as: 'compilerError' property :container_version, as: 'containerVersion', class: Google::Apis::TagmanagerV1::ContainerVersion, decorator: Google::Apis::TagmanagerV1::ContainerVersion::Representation end end class Rule # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' collection :condition, as: 'condition', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation property :container_id, as: 'containerId' property :fingerprint, as: 'fingerprint' property :name, as: 'name' property :notes, as: 'notes' property :rule_id, as: 'ruleId' end end class SetupTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :stop_on_setup_failure, as: 'stopOnSetupFailure' property :tag_name, as: 'tagName' end end class Tag # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' collection :blocking_rule_id, as: 'blockingRuleId' collection :blocking_trigger_id, as: 'blockingTriggerId' property :container_id, as: 'containerId' property :fingerprint, as: 'fingerprint' collection :firing_rule_id, as: 'firingRuleId' collection :firing_trigger_id, as: 'firingTriggerId' property :live_only, as: 'liveOnly' property :name, as: 'name' property :notes, as: 'notes' collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :parent_folder_id, as: 'parentFolderId' property :paused, as: 'paused' property :priority, as: 'priority', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :schedule_end_ms, :numeric_string => true, as: 'scheduleEndMs' property :schedule_start_ms, :numeric_string => true, as: 'scheduleStartMs' collection :setup_tag, as: 'setupTag', class: Google::Apis::TagmanagerV1::SetupTag, decorator: Google::Apis::TagmanagerV1::SetupTag::Representation property :tag_firing_option, as: 'tagFiringOption' property :tag_id, as: 'tagId' collection :teardown_tag, as: 'teardownTag', class: Google::Apis::TagmanagerV1::TeardownTag, decorator: Google::Apis::TagmanagerV1::TeardownTag::Representation property :type, as: 'type' end end class TeardownTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :stop_teardown_on_failure, as: 'stopTeardownOnFailure' property :tag_name, as: 'tagName' end end class Trigger # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' collection :auto_event_filter, as: 'autoEventFilter', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation property :check_validation, as: 'checkValidation', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :container_id, as: 'containerId' property :continuous_time_min_milliseconds, as: 'continuousTimeMinMilliseconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation collection :custom_event_filter, as: 'customEventFilter', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation property :event_name, as: 'eventName', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation collection :filter, as: 'filter', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation property :fingerprint, as: 'fingerprint' property :horizontal_scroll_percentage_list, as: 'horizontalScrollPercentageList', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :interval, as: 'interval', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :interval_seconds, as: 'intervalSeconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :limit, as: 'limit', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :max_timer_length_seconds, as: 'maxTimerLengthSeconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :name, as: 'name' collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :parent_folder_id, as: 'parentFolderId' property :selector, as: 'selector', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :total_time_min_milliseconds, as: 'totalTimeMinMilliseconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :trigger_id, as: 'triggerId' property :type, as: 'type' property :unique_trigger_id, as: 'uniqueTriggerId', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :vertical_scroll_percentage_list, as: 'verticalScrollPercentageList', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :visibility_selector, as: 'visibilitySelector', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :visible_percentage_max, as: 'visiblePercentageMax', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :visible_percentage_min, as: 'visiblePercentageMin', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :wait_for_tags, as: 'waitForTags', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :wait_for_tags_timeout, as: 'waitForTagsTimeout', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation end end class UserAccess # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_access, as: 'accountAccess', class: Google::Apis::TagmanagerV1::AccountAccess, decorator: Google::Apis::TagmanagerV1::AccountAccess::Representation property :account_id, as: 'accountId' collection :container_access, as: 'containerAccess', class: Google::Apis::TagmanagerV1::ContainerAccess, decorator: Google::Apis::TagmanagerV1::ContainerAccess::Representation property :email_address, as: 'emailAddress' property :permission_id, as: 'permissionId' end end class Variable # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :container_id, as: 'containerId' collection :disabling_trigger_id, as: 'disablingTriggerId' collection :enabling_trigger_id, as: 'enablingTriggerId' property :fingerprint, as: 'fingerprint' property :name, as: 'name' property :notes, as: 'notes' collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :parent_folder_id, as: 'parentFolderId' property :schedule_end_ms, :numeric_string => true, as: 'scheduleEndMs' property :schedule_start_ms, :numeric_string => true, as: 'scheduleStartMs' property :type, as: 'type' property :variable_id, as: 'variableId' end end end end end google-api-client-0.19.8/generated/google/apis/tagmanager_v1/classes.rb0000644000004100000410000016710713252673044026026 0ustar www-datawww-data# 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 TagmanagerV1 # Represents a Google Tag Manager Account. class Account include Google::Apis::Core::Hashable # The Account ID uniquely identifies the GTM Account. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # The fingerprint of the GTM Account as computed at storage time. This value is # recomputed whenever the account is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # Account display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether the account shares data anonymously with Google and others. # Corresponds to the JSON property `shareData` # @return [Boolean] attr_accessor :share_data alias_method :share_data?, :share_data def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @name = args[:name] if args.key?(:name) @share_data = args[:share_data] if args.key?(:share_data) end end # Defines the Google Tag Manager Account access permissions. class AccountAccess include Google::Apis::Core::Hashable # List of Account permissions. Valid account permissions are read and manage. # Corresponds to the JSON property `permission` # @return [Array] attr_accessor :permission def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permission = args[:permission] if args.key?(:permission) end end # Represents a predicate. class Condition include Google::Apis::Core::Hashable # A list of named parameters (key/value), depending on the condition's type. # Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying # the left and right operands, respectively. # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named # ignore_case that is set to true. If not specified or set to any other value, # the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean # parameter that is set to true. # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter # The type of operator for this condition. # 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) @parameter = args[:parameter] if args.key?(:parameter) @type = args[:type] if args.key?(:type) end end # Represents a Google Tag Manager Container. class Container include Google::Apis::Core::Hashable # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # The Container ID uniquely identifies the GTM Container. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # Optional list of domain names associated with the Container. # Corresponds to the JSON property `domainName` # @return [Array] attr_accessor :domain_name # List of enabled built-in variables. Valid values include: pageUrl, # pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, # clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, # formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, # oldHistoryFragment, newHistoryState, oldHistoryState, historySource, # containerVersion, debugMode, randomNumber, containerId. # Corresponds to the JSON property `enabledBuiltInVariable` # @return [Array] attr_accessor :enabled_built_in_variable # The fingerprint of the GTM Container as computed at storage time. This value # is recomputed whenever the account is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # Container display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Container Notes. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # Container Public ID. # Corresponds to the JSON property `publicId` # @return [String] attr_accessor :public_id # Container Country ID. # Corresponds to the JSON property `timeZoneCountryId` # @return [String] attr_accessor :time_zone_country_id # Container Time Zone ID. # Corresponds to the JSON property `timeZoneId` # @return [String] attr_accessor :time_zone_id # List of Usage Contexts for the Container. Valid values include: web, android, # ios. # Corresponds to the JSON property `usageContext` # @return [Array] attr_accessor :usage_context def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @container_id = args[:container_id] if args.key?(:container_id) @domain_name = args[:domain_name] if args.key?(:domain_name) @enabled_built_in_variable = args[:enabled_built_in_variable] if args.key?(:enabled_built_in_variable) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @public_id = args[:public_id] if args.key?(:public_id) @time_zone_country_id = args[:time_zone_country_id] if args.key?(:time_zone_country_id) @time_zone_id = args[:time_zone_id] if args.key?(:time_zone_id) @usage_context = args[:usage_context] if args.key?(:usage_context) end end # Defines the Google Tag Manager Container access permissions. class ContainerAccess include Google::Apis::Core::Hashable # GTM Container ID. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # List of Container permissions. Valid container permissions are: read, edit, # delete, publish. # Corresponds to the JSON property `permission` # @return [Array] attr_accessor :permission def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @container_id = args[:container_id] if args.key?(:container_id) @permission = args[:permission] if args.key?(:permission) end end # Represents a Google Tag Manager Container Version. class ContainerVersion include Google::Apis::Core::Hashable # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Represents a Google Tag Manager Container. # Corresponds to the JSON property `container` # @return [Google::Apis::TagmanagerV1::Container] attr_accessor :container # GTM Container ID. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # The Container Version ID uniquely identifies the GTM Container Version. # Corresponds to the JSON property `containerVersionId` # @return [String] attr_accessor :container_version_id # A value of true indicates this container version has been deleted. # Corresponds to the JSON property `deleted` # @return [Boolean] attr_accessor :deleted alias_method :deleted?, :deleted # The fingerprint of the GTM Container Version as computed at storage time. This # value is recomputed whenever the container version is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # The folders in the container that this version was taken from. # Corresponds to the JSON property `folder` # @return [Array] attr_accessor :folder # The macros in the container that this version was taken from. # Corresponds to the JSON property `macro` # @return [Array] attr_accessor :macro # Container version display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # User notes on how to apply this container version in the container. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # The rules in the container that this version was taken from. # Corresponds to the JSON property `rule` # @return [Array] attr_accessor :rule # The tags in the container that this version was taken from. # Corresponds to the JSON property `tag` # @return [Array] attr_accessor :tag # The triggers in the container that this version was taken from. # Corresponds to the JSON property `trigger` # @return [Array] attr_accessor :trigger # The variables in the container that this version was taken from. # Corresponds to the JSON property `variable` # @return [Array] attr_accessor :variable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @container = args[:container] if args.key?(:container) @container_id = args[:container_id] if args.key?(:container_id) @container_version_id = args[:container_version_id] if args.key?(:container_version_id) @deleted = args[:deleted] if args.key?(:deleted) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @folder = args[:folder] if args.key?(:folder) @macro = args[:macro] if args.key?(:macro) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @rule = args[:rule] if args.key?(:rule) @tag = args[:tag] if args.key?(:tag) @trigger = args[:trigger] if args.key?(:trigger) @variable = args[:variable] if args.key?(:variable) end end # Represents a Google Tag Manager Container Version Header. class ContainerVersionHeader include Google::Apis::Core::Hashable # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # GTM Container ID. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # The Container Version ID uniquely identifies the GTM Container Version. # Corresponds to the JSON property `containerVersionId` # @return [String] attr_accessor :container_version_id # A value of true indicates this container version has been deleted. # Corresponds to the JSON property `deleted` # @return [Boolean] attr_accessor :deleted alias_method :deleted?, :deleted # Container version display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Number of macros in the container version. # Corresponds to the JSON property `numMacros` # @return [String] attr_accessor :num_macros # Number of rules in the container version. # Corresponds to the JSON property `numRules` # @return [String] attr_accessor :num_rules # Number of tags in the container version. # Corresponds to the JSON property `numTags` # @return [String] attr_accessor :num_tags # Number of triggers in the container version. # Corresponds to the JSON property `numTriggers` # @return [String] attr_accessor :num_triggers # Number of variables in the container version. # Corresponds to the JSON property `numVariables` # @return [String] attr_accessor :num_variables def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @container_id = args[:container_id] if args.key?(:container_id) @container_version_id = args[:container_version_id] if args.key?(:container_version_id) @deleted = args[:deleted] if args.key?(:deleted) @name = args[:name] if args.key?(:name) @num_macros = args[:num_macros] if args.key?(:num_macros) @num_rules = args[:num_rules] if args.key?(:num_rules) @num_tags = args[:num_tags] if args.key?(:num_tags) @num_triggers = args[:num_triggers] if args.key?(:num_triggers) @num_variables = args[:num_variables] if args.key?(:num_variables) end end # Options for new container versions. class CreateContainerVersionRequestVersionOptions include Google::Apis::Core::Hashable # The name of the container version to be created. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The notes of the container version to be created. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # The creation of this version may be for quick preview and shouldn't be saved. # Corresponds to the JSON property `quickPreview` # @return [Boolean] attr_accessor :quick_preview alias_method :quick_preview?, :quick_preview def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @quick_preview = args[:quick_preview] if args.key?(:quick_preview) end end # Create container versions response. class CreateContainerVersionResponse include Google::Apis::Core::Hashable # Compiler errors or not. # Corresponds to the JSON property `compilerError` # @return [Boolean] attr_accessor :compiler_error alias_method :compiler_error?, :compiler_error # Represents a Google Tag Manager Container Version. # Corresponds to the JSON property `containerVersion` # @return [Google::Apis::TagmanagerV1::ContainerVersion] attr_accessor :container_version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @compiler_error = args[:compiler_error] if args.key?(:compiler_error) @container_version = args[:container_version] if args.key?(:container_version) end end # Represents a Google Tag Manager Environment. Note that a user can create, # delete and update environments of type USER, but can only update the # enable_debug and url fields of environments of other types. class Environment include Google::Apis::Core::Hashable # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # The environment authorization code. # Corresponds to the JSON property `authorizationCode` # @return [String] attr_accessor :authorization_code # The last update time-stamp for the authorization code. # Corresponds to the JSON property `authorizationTimestampMs` # @return [Fixnum] attr_accessor :authorization_timestamp_ms # GTM Container ID. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # # Corresponds to the JSON property `containerVersionId` # @return [String] attr_accessor :container_version_id # The environment description. Can be set or changed only on USER type # environments. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Whether or not to enable debug by default on for the environment. # Corresponds to the JSON property `enableDebug` # @return [Boolean] attr_accessor :enable_debug alias_method :enable_debug?, :enable_debug # GTM Environment ID uniquely identifies the GTM Environment. # Corresponds to the JSON property `environmentId` # @return [String] attr_accessor :environment_id # The fingerprint of the GTM environment as computed at storage time. This value # is recomputed whenever the environment is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # The environment display name. Can be set or changed only on USER type # environments. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The type of this environment. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Default preview page url for the environment. # 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) @account_id = args[:account_id] if args.key?(:account_id) @authorization_code = args[:authorization_code] if args.key?(:authorization_code) @authorization_timestamp_ms = args[:authorization_timestamp_ms] if args.key?(:authorization_timestamp_ms) @container_id = args[:container_id] if args.key?(:container_id) @container_version_id = args[:container_version_id] if args.key?(:container_version_id) @description = args[:description] if args.key?(:description) @enable_debug = args[:enable_debug] if args.key?(:enable_debug) @environment_id = args[:environment_id] if args.key?(:environment_id) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) end end # Represents a Google Tag Manager Folder. class Folder include Google::Apis::Core::Hashable # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # GTM Container ID. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # The fingerprint of the GTM Folder as computed at storage time. This value is # recomputed whenever the folder is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # The Folder ID uniquely identifies the GTM Folder. # Corresponds to the JSON property `folderId` # @return [String] attr_accessor :folder_id # Folder display name. # 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) @account_id = args[:account_id] if args.key?(:account_id) @container_id = args[:container_id] if args.key?(:container_id) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @folder_id = args[:folder_id] if args.key?(:folder_id) @name = args[:name] if args.key?(:name) end end # Represents a Google Tag Manager Folder's contents. class FolderEntities include Google::Apis::Core::Hashable # The list of tags inside the folder. # Corresponds to the JSON property `tag` # @return [Array] attr_accessor :tag # The list of triggers inside the folder. # Corresponds to the JSON property `trigger` # @return [Array] attr_accessor :trigger # The list of variables inside the folder. # Corresponds to the JSON property `variable` # @return [Array] attr_accessor :variable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @tag = args[:tag] if args.key?(:tag) @trigger = args[:trigger] if args.key?(:trigger) @variable = args[:variable] if args.key?(:variable) end end # List AccountUsers Response. class ListAccountUsersResponse include Google::Apis::Core::Hashable # All GTM AccountUsers of a GTM Account. # Corresponds to the JSON property `userAccess` # @return [Array] attr_accessor :user_access def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @user_access = args[:user_access] if args.key?(:user_access) end end # List Accounts Response. class ListAccountsResponse include Google::Apis::Core::Hashable # List of GTM Accounts that a user has access to. # Corresponds to the JSON property `accounts` # @return [Array] attr_accessor :accounts def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accounts = args[:accounts] if args.key?(:accounts) end end # List container versions response. class ListContainerVersionsResponse include Google::Apis::Core::Hashable # All versions of a GTM Container. # Corresponds to the JSON property `containerVersion` # @return [Array] attr_accessor :container_version # All container version headers of a GTM Container. # Corresponds to the JSON property `containerVersionHeader` # @return [Array] attr_accessor :container_version_header def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @container_version = args[:container_version] if args.key?(:container_version) @container_version_header = args[:container_version_header] if args.key?(:container_version_header) end end # List Containers Response. class ListContainersResponse include Google::Apis::Core::Hashable # All Containers of a GTM Account. # Corresponds to the JSON property `containers` # @return [Array] attr_accessor :containers def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @containers = args[:containers] if args.key?(:containers) end end # List Environments Response. class ListEnvironmentsResponse include Google::Apis::Core::Hashable # All Environments of a GTM Container. # Corresponds to the JSON property `environments` # @return [Array] attr_accessor :environments def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @environments = args[:environments] if args.key?(:environments) end end # List Folders Response. class ListFoldersResponse include Google::Apis::Core::Hashable # All GTM Folders of a GTM Container. # Corresponds to the JSON property `folders` # @return [Array] attr_accessor :folders def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @folders = args[:folders] if args.key?(:folders) end end # List Tags Response. class ListTagsResponse include Google::Apis::Core::Hashable # All GTM Tags of a GTM Container. # Corresponds to the JSON property `tags` # @return [Array] attr_accessor :tags def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @tags = args[:tags] if args.key?(:tags) end end # List triggers response. class ListTriggersResponse include Google::Apis::Core::Hashable # All GTM Triggers of a GTM Container. # Corresponds to the JSON property `triggers` # @return [Array] attr_accessor :triggers def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @triggers = args[:triggers] if args.key?(:triggers) end end # List Variables Response. class ListVariablesResponse include Google::Apis::Core::Hashable # All GTM Variables of a GTM Container. # 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) @variables = args[:variables] if args.key?(:variables) end end # Represents a Google Tag Manager Macro. class Macro include Google::Apis::Core::Hashable # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # GTM Container ID. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # For mobile containers only: A list of rule IDs for disabling conditional # macros; the macro is enabled if one of the enabling rules is true while all # the disabling rules are false. Treated as an unordered set. # Corresponds to the JSON property `disablingRuleId` # @return [Array] attr_accessor :disabling_rule_id # For mobile containers only: A list of rule IDs for enabling conditional macros; # the macro is enabled if one of the enabling rules is true while all the # disabling rules are false. Treated as an unordered set. # Corresponds to the JSON property `enablingRuleId` # @return [Array] attr_accessor :enabling_rule_id # The fingerprint of the GTM Macro as computed at storage time. This value is # recomputed whenever the macro is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # The Macro ID uniquely identifies the GTM Macro. # Corresponds to the JSON property `macroId` # @return [String] attr_accessor :macro_id # Macro display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # User notes on how to apply this macro in the container. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # The macro's parameters. # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter # Parent folder id. # Corresponds to the JSON property `parentFolderId` # @return [String] attr_accessor :parent_folder_id # The end timestamp in milliseconds to schedule a macro. # Corresponds to the JSON property `scheduleEndMs` # @return [Fixnum] attr_accessor :schedule_end_ms # The start timestamp in milliseconds to schedule a macro. # Corresponds to the JSON property `scheduleStartMs` # @return [Fixnum] attr_accessor :schedule_start_ms # GTM Macro 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) @account_id = args[:account_id] if args.key?(:account_id) @container_id = args[:container_id] if args.key?(:container_id) @disabling_rule_id = args[:disabling_rule_id] if args.key?(:disabling_rule_id) @enabling_rule_id = args[:enabling_rule_id] if args.key?(:enabling_rule_id) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @macro_id = args[:macro_id] if args.key?(:macro_id) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @parameter = args[:parameter] if args.key?(:parameter) @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms) @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms) @type = args[:type] if args.key?(:type) end end # Represents a Google Tag Manager Parameter. class Parameter include Google::Apis::Core::Hashable # The named key that uniquely identifies a parameter. Required for top-level # parameters, as well as map values. Ignored for list values. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # This list parameter's parameters (keys will be ignored). # Corresponds to the JSON property `list` # @return [Array] attr_accessor :list # This map parameter's parameters (must have keys; keys must be unique). # Corresponds to the JSON property `map` # @return [Array] attr_accessor :map # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified # - template: The value represents any text; this can include variable # references (even variable references that might return non-string types) # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # A parameter's value (may contain variable references such as "``myVariable``") # as appropriate to the specified type. # 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) @list = args[:list] if args.key?(:list) @map = args[:map] if args.key?(:map) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end # Publish container version response. class PublishContainerVersionResponse include Google::Apis::Core::Hashable # Compiler errors or not. # Corresponds to the JSON property `compilerError` # @return [Boolean] attr_accessor :compiler_error alias_method :compiler_error?, :compiler_error # Represents a Google Tag Manager Container Version. # Corresponds to the JSON property `containerVersion` # @return [Google::Apis::TagmanagerV1::ContainerVersion] attr_accessor :container_version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @compiler_error = args[:compiler_error] if args.key?(:compiler_error) @container_version = args[:container_version] if args.key?(:container_version) end end # Represents a Google Tag Manager Rule. class Rule include Google::Apis::Core::Hashable # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # The list of conditions that make up this rule (implicit AND between them). # Corresponds to the JSON property `condition` # @return [Array] attr_accessor :condition # GTM Container ID. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # The fingerprint of the GTM Rule as computed at storage time. This value is # recomputed whenever the rule is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # Rule display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # User notes on how to apply this rule in the container. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # The Rule ID uniquely identifies the GTM Rule. # Corresponds to the JSON property `ruleId` # @return [String] attr_accessor :rule_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @condition = args[:condition] if args.key?(:condition) @container_id = args[:container_id] if args.key?(:container_id) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @rule_id = args[:rule_id] if args.key?(:rule_id) end end # class SetupTag include Google::Apis::Core::Hashable # If true, fire the main tag if and only if the setup tag fires successfully. If # false, fire the main tag regardless of setup tag firing status. # Corresponds to the JSON property `stopOnSetupFailure` # @return [Boolean] attr_accessor :stop_on_setup_failure alias_method :stop_on_setup_failure?, :stop_on_setup_failure # The name of the setup tag. # Corresponds to the JSON property `tagName` # @return [String] attr_accessor :tag_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @stop_on_setup_failure = args[:stop_on_setup_failure] if args.key?(:stop_on_setup_failure) @tag_name = args[:tag_name] if args.key?(:tag_name) end end # Represents a Google Tag Manager Tag. class Tag include Google::Apis::Core::Hashable # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will # not fire. # Corresponds to the JSON property `blockingRuleId` # @return [Array] attr_accessor :blocking_rule_id # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag # will not fire. # Corresponds to the JSON property `blockingTriggerId` # @return [Array] attr_accessor :blocking_trigger_id # GTM Container ID. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # The fingerprint of the GTM Tag as computed at storage time. This value is # recomputed whenever the tag is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # Firing rule IDs. A tag will fire when any of the listed rules are true and all # of its blockingRuleIds (if any specified) are false. # Corresponds to the JSON property `firingRuleId` # @return [Array] attr_accessor :firing_rule_id # Firing trigger IDs. A tag will fire when any of the listed triggers are true # and all of its blockingTriggerIds (if any specified) are false. # Corresponds to the JSON property `firingTriggerId` # @return [Array] attr_accessor :firing_trigger_id # If set to true, this tag will only fire in the live environment (e.g. not in # preview or debug mode). # Corresponds to the JSON property `liveOnly` # @return [Boolean] attr_accessor :live_only alias_method :live_only?, :live_only # Tag display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # User notes on how to apply this tag in the container. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # The tag's parameters. # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter # Parent folder id. # Corresponds to the JSON property `parentFolderId` # @return [String] attr_accessor :parent_folder_id # True if the tag is paused. # Corresponds to the JSON property `paused` # @return [Boolean] attr_accessor :paused alias_method :paused?, :paused # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `priority` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :priority # The end timestamp in milliseconds to schedule a tag. # Corresponds to the JSON property `scheduleEndMs` # @return [Fixnum] attr_accessor :schedule_end_ms # The start timestamp in milliseconds to schedule a tag. # Corresponds to the JSON property `scheduleStartMs` # @return [Fixnum] attr_accessor :schedule_start_ms # The list of setup tags. Currently we only allow one. # Corresponds to the JSON property `setupTag` # @return [Array] attr_accessor :setup_tag # Option to fire this tag. # Corresponds to the JSON property `tagFiringOption` # @return [String] attr_accessor :tag_firing_option # The Tag ID uniquely identifies the GTM Tag. # Corresponds to the JSON property `tagId` # @return [String] attr_accessor :tag_id # The list of teardown tags. Currently we only allow one. # Corresponds to the JSON property `teardownTag` # @return [Array] attr_accessor :teardown_tag # GTM Tag 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) @account_id = args[:account_id] if args.key?(:account_id) @blocking_rule_id = args[:blocking_rule_id] if args.key?(:blocking_rule_id) @blocking_trigger_id = args[:blocking_trigger_id] if args.key?(:blocking_trigger_id) @container_id = args[:container_id] if args.key?(:container_id) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @firing_rule_id = args[:firing_rule_id] if args.key?(:firing_rule_id) @firing_trigger_id = args[:firing_trigger_id] if args.key?(:firing_trigger_id) @live_only = args[:live_only] if args.key?(:live_only) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @parameter = args[:parameter] if args.key?(:parameter) @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) @paused = args[:paused] if args.key?(:paused) @priority = args[:priority] if args.key?(:priority) @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms) @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms) @setup_tag = args[:setup_tag] if args.key?(:setup_tag) @tag_firing_option = args[:tag_firing_option] if args.key?(:tag_firing_option) @tag_id = args[:tag_id] if args.key?(:tag_id) @teardown_tag = args[:teardown_tag] if args.key?(:teardown_tag) @type = args[:type] if args.key?(:type) end end # class TeardownTag include Google::Apis::Core::Hashable # If true, fire the teardown tag if and only if the main tag fires successfully. # If false, fire the teardown tag regardless of main tag firing status. # Corresponds to the JSON property `stopTeardownOnFailure` # @return [Boolean] attr_accessor :stop_teardown_on_failure alias_method :stop_teardown_on_failure?, :stop_teardown_on_failure # The name of the teardown tag. # Corresponds to the JSON property `tagName` # @return [String] attr_accessor :tag_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @stop_teardown_on_failure = args[:stop_teardown_on_failure] if args.key?(:stop_teardown_on_failure) @tag_name = args[:tag_name] if args.key?(:tag_name) end end # Represents a Google Tag Manager Trigger class Trigger include Google::Apis::Core::Hashable # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # Used in the case of auto event tracking. # Corresponds to the JSON property `autoEventFilter` # @return [Array] attr_accessor :auto_event_filter # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `checkValidation` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :check_validation # GTM Container ID. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `continuousTimeMinMilliseconds` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :continuous_time_min_milliseconds # Used in the case of custom event, which is fired iff all Conditions are true. # Corresponds to the JSON property `customEventFilter` # @return [Array] attr_accessor :custom_event_filter # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `eventName` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :event_name # The trigger will only fire iff all Conditions are true. # Corresponds to the JSON property `filter` # @return [Array] attr_accessor :filter # The fingerprint of the GTM Trigger as computed at storage time. This value is # recomputed whenever the trigger is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `horizontalScrollPercentageList` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :horizontal_scroll_percentage_list # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `interval` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :interval # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `intervalSeconds` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :interval_seconds # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `limit` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :limit # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `maxTimerLengthSeconds` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :max_timer_length_seconds # Trigger display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Additional parameters. # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter # Parent folder id. # Corresponds to the JSON property `parentFolderId` # @return [String] attr_accessor :parent_folder_id # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `selector` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :selector # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `totalTimeMinMilliseconds` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :total_time_min_milliseconds # The Trigger ID uniquely identifies the GTM Trigger. # Corresponds to the JSON property `triggerId` # @return [String] attr_accessor :trigger_id # Defines the data layer event that causes this trigger. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `uniqueTriggerId` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :unique_trigger_id # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `verticalScrollPercentageList` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :vertical_scroll_percentage_list # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `visibilitySelector` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :visibility_selector # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `visiblePercentageMax` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :visible_percentage_max # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `visiblePercentageMin` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :visible_percentage_min # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `waitForTags` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :wait_for_tags # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `waitForTagsTimeout` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :wait_for_tags_timeout def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @auto_event_filter = args[:auto_event_filter] if args.key?(:auto_event_filter) @check_validation = args[:check_validation] if args.key?(:check_validation) @container_id = args[:container_id] if args.key?(:container_id) @continuous_time_min_milliseconds = args[:continuous_time_min_milliseconds] if args.key?(:continuous_time_min_milliseconds) @custom_event_filter = args[:custom_event_filter] if args.key?(:custom_event_filter) @event_name = args[:event_name] if args.key?(:event_name) @filter = args[:filter] if args.key?(:filter) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @horizontal_scroll_percentage_list = args[:horizontal_scroll_percentage_list] if args.key?(:horizontal_scroll_percentage_list) @interval = args[:interval] if args.key?(:interval) @interval_seconds = args[:interval_seconds] if args.key?(:interval_seconds) @limit = args[:limit] if args.key?(:limit) @max_timer_length_seconds = args[:max_timer_length_seconds] if args.key?(:max_timer_length_seconds) @name = args[:name] if args.key?(:name) @parameter = args[:parameter] if args.key?(:parameter) @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) @selector = args[:selector] if args.key?(:selector) @total_time_min_milliseconds = args[:total_time_min_milliseconds] if args.key?(:total_time_min_milliseconds) @trigger_id = args[:trigger_id] if args.key?(:trigger_id) @type = args[:type] if args.key?(:type) @unique_trigger_id = args[:unique_trigger_id] if args.key?(:unique_trigger_id) @vertical_scroll_percentage_list = args[:vertical_scroll_percentage_list] if args.key?(:vertical_scroll_percentage_list) @visibility_selector = args[:visibility_selector] if args.key?(:visibility_selector) @visible_percentage_max = args[:visible_percentage_max] if args.key?(:visible_percentage_max) @visible_percentage_min = args[:visible_percentage_min] if args.key?(:visible_percentage_min) @wait_for_tags = args[:wait_for_tags] if args.key?(:wait_for_tags) @wait_for_tags_timeout = args[:wait_for_tags_timeout] if args.key?(:wait_for_tags_timeout) end end # Represents a user's permissions to an account and its container. class UserAccess include Google::Apis::Core::Hashable # Defines the Google Tag Manager Account access permissions. # Corresponds to the JSON property `accountAccess` # @return [Google::Apis::TagmanagerV1::AccountAccess] attr_accessor :account_access # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # GTM Container access permissions. # Corresponds to the JSON property `containerAccess` # @return [Array] attr_accessor :container_access # User's email address. # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address # Account Permission ID. # Corresponds to the JSON property `permissionId` # @return [String] attr_accessor :permission_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_access = args[:account_access] if args.key?(:account_access) @account_id = args[:account_id] if args.key?(:account_id) @container_access = args[:container_access] if args.key?(:container_access) @email_address = args[:email_address] if args.key?(:email_address) @permission_id = args[:permission_id] if args.key?(:permission_id) end end # Represents a Google Tag Manager Variable. class Variable include Google::Apis::Core::Hashable # GTM Account ID. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # GTM Container ID. # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id # For mobile containers only: A list of trigger IDs for disabling conditional # variables; the variable is enabled if one of the enabling trigger is true # while all the disabling trigger are false. Treated as an unordered set. # Corresponds to the JSON property `disablingTriggerId` # @return [Array] attr_accessor :disabling_trigger_id # For mobile containers only: A list of trigger IDs for enabling conditional # variables; the variable is enabled if one of the enabling triggers is true # while all the disabling triggers are false. Treated as an unordered set. # Corresponds to the JSON property `enablingTriggerId` # @return [Array] attr_accessor :enabling_trigger_id # The fingerprint of the GTM Variable as computed at storage time. This value is # recomputed whenever the variable is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # Variable display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # User notes on how to apply this variable in the container. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # The variable's parameters. # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter # Parent folder id. # Corresponds to the JSON property `parentFolderId` # @return [String] attr_accessor :parent_folder_id # The end timestamp in milliseconds to schedule a variable. # Corresponds to the JSON property `scheduleEndMs` # @return [Fixnum] attr_accessor :schedule_end_ms # The start timestamp in milliseconds to schedule a variable. # Corresponds to the JSON property `scheduleStartMs` # @return [Fixnum] attr_accessor :schedule_start_ms # GTM Variable Type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The Variable ID uniquely identifies the GTM Variable. # Corresponds to the JSON property `variableId` # @return [String] attr_accessor :variable_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @container_id = args[:container_id] if args.key?(:container_id) @disabling_trigger_id = args[:disabling_trigger_id] if args.key?(:disabling_trigger_id) @enabling_trigger_id = args[:enabling_trigger_id] if args.key?(:enabling_trigger_id) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @parameter = args[:parameter] if args.key?(:parameter) @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms) @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms) @type = args[:type] if args.key?(:type) @variable_id = args[:variable_id] if args.key?(:variable_id) end end end end end google-api-client-0.19.8/generated/google/apis/tagmanager_v1/service.rb0000644000004100000410000036645413252673044026037 0ustar www-datawww-data# 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 TagmanagerV1 # Tag Manager API # # Accesses Tag Manager accounts and containers. # # @example # require 'google/apis/tagmanager_v1' # # Tagmanager = Google::Apis::TagmanagerV1 # Alias the module # service = Tagmanager::TagManagerService.new # # @see https://developers.google.com/tag-manager/api/v1/ class TagManagerService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'tagmanager/v1/') @batch_path = 'batch/tagmanager/v1' end # Gets a GTM Account. # @param [String] account_id # The GTM Account 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}', options) command.response_representation = Google::Apis::TagmanagerV1::Account::Representation command.response_class = Google::Apis::TagmanagerV1::Account command.params['accountId'] = account_id unless account_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 all GTM Accounts that a user has access to. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ListAccountsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ListAccountsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_accounts(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts', options) command.response_representation = Google::Apis::TagmanagerV1::ListAccountsResponse::Representation command.response_class = Google::Apis::TagmanagerV1::ListAccountsResponse 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 a GTM Account. # @param [String] account_id # The GTM Account ID. # @param [Google::Apis::TagmanagerV1::Account] account_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the account in # storage. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(account_id, account_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}', options) command.request_representation = Google::Apis::TagmanagerV1::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::TagmanagerV1::Account::Representation command.response_class = Google::Apis::TagmanagerV1::Account command.params['accountId'] = account_id unless account_id.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 Container. # @param [String] account_id # The GTM Account ID. # @param [Google::Apis::TagmanagerV1::Container] container_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Container] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Container] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_container(account_id, container_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/containers', options) command.request_representation = Google::Apis::TagmanagerV1::Container::Representation command.request_object = container_object command.response_representation = Google::Apis::TagmanagerV1::Container::Representation command.response_class = Google::Apis::TagmanagerV1::Container command.params['accountId'] = account_id unless account_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 a Container. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_container(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 Container. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Container] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Container] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_container(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}', options) command.response_representation = Google::Apis::TagmanagerV1::Container::Representation command.response_class = Google::Apis::TagmanagerV1::Container command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 all Containers that belongs to a GTM Account. # @param [String] account_id # The GTM Account 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ListContainersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ListContainersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_containers(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers', options) command.response_representation = Google::Apis::TagmanagerV1::ListContainersResponse::Representation command.response_class = Google::Apis::TagmanagerV1::ListContainersResponse command.params['accountId'] = account_id unless account_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 a Container. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [Google::Apis::TagmanagerV1::Container] container_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the container in # storage. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Container] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Container] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_container(account_id, container_id, container_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}', options) command.request_representation = Google::Apis::TagmanagerV1::Container::Representation command.request_object = container_object command.response_representation = Google::Apis::TagmanagerV1::Container::Representation command.response_class = Google::Apis::TagmanagerV1::Container command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 GTM Environment. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [Google::Apis::TagmanagerV1::Environment] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Environment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Environment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_environment(account_id, container_id, environment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/environments', options) command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation command.request_object = environment_object command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation command.response_class = Google::Apis::TagmanagerV1::Environment command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a GTM Environment. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] environment_id # The GTM Environment 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_account_container_environment(account_id, container_id, environment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? 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 # Gets a GTM Environment. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] environment_id # The GTM Environment 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Environment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Environment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_environment(account_id, container_id, environment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options) command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation command.response_class = Google::Apis::TagmanagerV1::Environment command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? 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 all GTM Environments of a GTM Container. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ListEnvironmentsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ListEnvironmentsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_environments(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/environments', options) command.response_representation = Google::Apis::TagmanagerV1::ListEnvironmentsResponse::Representation command.response_class = Google::Apis::TagmanagerV1::ListEnvironmentsResponse command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a GTM Environment. This method supports patch semantics. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] environment_id # The GTM Environment ID. # @param [Google::Apis::TagmanagerV1::Environment] environment_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the environment # in storage. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Environment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Environment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_environment(account_id, container_id, environment_id, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options) command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation command.request_object = environment_object command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation command.response_class = Google::Apis::TagmanagerV1::Environment command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['environmentId'] = environment_id unless environment_id.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 a GTM Environment. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] environment_id # The GTM Environment ID. # @param [Google::Apis::TagmanagerV1::Environment] environment_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the environment # in storage. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Environment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Environment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_environment(account_id, container_id, environment_id, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options) command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation command.request_object = environment_object command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation command.response_class = Google::Apis::TagmanagerV1::Environment command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['environmentId'] = environment_id unless environment_id.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 GTM Folder. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [Google::Apis::TagmanagerV1::Folder] folder_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Folder] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Folder] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_folder(account_id, container_id, folder_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/folders', options) command.request_representation = Google::Apis::TagmanagerV1::Folder::Representation command.request_object = folder_object command.response_representation = Google::Apis::TagmanagerV1::Folder::Representation command.response_class = Google::Apis::TagmanagerV1::Folder command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a GTM Folder. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] folder_id # The GTM Folder 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_account_container_folder(account_id, container_id, folder_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/folders/{folderId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['folderId'] = folder_id unless folder_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 GTM Folder. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] folder_id # The GTM Folder 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Folder] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Folder] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_folder(account_id, container_id, folder_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/folders/{folderId}', options) command.response_representation = Google::Apis::TagmanagerV1::Folder::Representation command.response_class = Google::Apis::TagmanagerV1::Folder command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['folderId'] = folder_id unless folder_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 all GTM Folders of a Container. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ListFoldersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ListFoldersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_folders(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/folders', options) command.response_representation = Google::Apis::TagmanagerV1::ListFoldersResponse::Representation command.response_class = Google::Apis::TagmanagerV1::ListFoldersResponse command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a GTM Folder. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] folder_id # The GTM Folder ID. # @param [Google::Apis::TagmanagerV1::Folder] folder_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the folder in # storage. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Folder] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Folder] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_folder(account_id, container_id, folder_id, folder_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/folders/{folderId}', options) command.request_representation = Google::Apis::TagmanagerV1::Folder::Representation command.request_object = folder_object command.response_representation = Google::Apis::TagmanagerV1::Folder::Representation command.response_class = Google::Apis::TagmanagerV1::Folder command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['folderId'] = folder_id unless folder_id.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 entities in a GTM Folder. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] folder_id # The GTM Folder 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::FolderEntities] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::FolderEntities] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_folder_entities(account_id, container_id, folder_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/folders/{folderId}/entities', options) command.response_representation = Google::Apis::TagmanagerV1::FolderEntities::Representation command.response_class = Google::Apis::TagmanagerV1::FolderEntities command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['folderId'] = folder_id unless folder_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 # Moves entities to a GTM Folder. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] folder_id # The GTM Folder ID. # @param [Google::Apis::TagmanagerV1::Folder] folder_object # @param [Array, String] tag_id # The tags to be moved to the folder. # @param [Array, String] trigger_id # The triggers to be moved to the folder. # @param [Array, String] variable_id # The variables to be moved to the folder. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_account_container_move_folder(account_id, container_id, folder_id, folder_object = nil, tag_id: nil, trigger_id: nil, variable_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/move_folders/{folderId}', options) command.request_representation = Google::Apis::TagmanagerV1::Folder::Representation command.request_object = folder_object command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['folderId'] = folder_id unless folder_id.nil? command.query['tagId'] = tag_id unless tag_id.nil? command.query['triggerId'] = trigger_id unless trigger_id.nil? command.query['variableId'] = variable_id unless variable_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 # Re-generates the authorization code for a GTM Environment. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] environment_id # The GTM Environment ID. # @param [Google::Apis::TagmanagerV1::Environment] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Environment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Environment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_container_reauthorize_environment(account_id, container_id, environment_id, environment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/reauthorize_environments/{environmentId}', options) command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation command.request_object = environment_object command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation command.response_class = Google::Apis::TagmanagerV1::Environment command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? 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 # Creates a GTM Tag. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [Google::Apis::TagmanagerV1::Tag] tag_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Tag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Tag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tag(account_id, container_id, tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/tags', options) command.request_representation = Google::Apis::TagmanagerV1::Tag::Representation command.request_object = tag_object command.response_representation = Google::Apis::TagmanagerV1::Tag::Representation command.response_class = Google::Apis::TagmanagerV1::Tag command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a GTM Tag. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] tag_id # The GTM Tag 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_tag(account_id, container_id, tag_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/tags/{tagId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['tagId'] = tag_id unless tag_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 GTM Tag. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] tag_id # The GTM Tag 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Tag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Tag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tag(account_id, container_id, tag_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/tags/{tagId}', options) command.response_representation = Google::Apis::TagmanagerV1::Tag::Representation command.response_class = Google::Apis::TagmanagerV1::Tag command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['tagId'] = tag_id unless tag_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 all GTM Tags of a Container. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ListTagsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ListTagsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tags(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/tags', options) command.response_representation = Google::Apis::TagmanagerV1::ListTagsResponse::Representation command.response_class = Google::Apis::TagmanagerV1::ListTagsResponse command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a GTM Tag. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] tag_id # The GTM Tag ID. # @param [Google::Apis::TagmanagerV1::Tag] tag_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the tag in # storage. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Tag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Tag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tag(account_id, container_id, tag_id, tag_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/tags/{tagId}', options) command.request_representation = Google::Apis::TagmanagerV1::Tag::Representation command.request_object = tag_object command.response_representation = Google::Apis::TagmanagerV1::Tag::Representation command.response_class = Google::Apis::TagmanagerV1::Tag command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['tagId'] = tag_id unless tag_id.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 GTM Trigger. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [Google::Apis::TagmanagerV1::Trigger] trigger_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Trigger] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Trigger] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_trigger(account_id, container_id, trigger_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/triggers', options) command.request_representation = Google::Apis::TagmanagerV1::Trigger::Representation command.request_object = trigger_object command.response_representation = Google::Apis::TagmanagerV1::Trigger::Representation command.response_class = Google::Apis::TagmanagerV1::Trigger command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a GTM Trigger. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] trigger_id # The GTM Trigger 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_trigger(account_id, container_id, trigger_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/triggers/{triggerId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['triggerId'] = trigger_id unless trigger_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 GTM Trigger. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] trigger_id # The GTM Trigger 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Trigger] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Trigger] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_trigger(account_id, container_id, trigger_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/triggers/{triggerId}', options) command.response_representation = Google::Apis::TagmanagerV1::Trigger::Representation command.response_class = Google::Apis::TagmanagerV1::Trigger command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['triggerId'] = trigger_id unless trigger_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 all GTM Triggers of a Container. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ListTriggersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ListTriggersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_triggers(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/triggers', options) command.response_representation = Google::Apis::TagmanagerV1::ListTriggersResponse::Representation command.response_class = Google::Apis::TagmanagerV1::ListTriggersResponse command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a GTM Trigger. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] trigger_id # The GTM Trigger ID. # @param [Google::Apis::TagmanagerV1::Trigger] trigger_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the trigger in # storage. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Trigger] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Trigger] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_trigger(account_id, container_id, trigger_id, trigger_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/triggers/{triggerId}', options) command.request_representation = Google::Apis::TagmanagerV1::Trigger::Representation command.request_object = trigger_object command.response_representation = Google::Apis::TagmanagerV1::Trigger::Representation command.response_class = Google::Apis::TagmanagerV1::Trigger command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['triggerId'] = trigger_id unless trigger_id.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 GTM Variable. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [Google::Apis::TagmanagerV1::Variable] variable_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Variable] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Variable] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_variable(account_id, container_id, variable_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/variables', options) command.request_representation = Google::Apis::TagmanagerV1::Variable::Representation command.request_object = variable_object command.response_representation = Google::Apis::TagmanagerV1::Variable::Representation command.response_class = Google::Apis::TagmanagerV1::Variable command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a GTM Variable. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] variable_id # The GTM Variable 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_variable(account_id, container_id, variable_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/variables/{variableId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['variableId'] = variable_id unless variable_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 GTM Variable. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] variable_id # The GTM Variable 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Variable] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Variable] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_variable(account_id, container_id, variable_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/variables/{variableId}', options) command.response_representation = Google::Apis::TagmanagerV1::Variable::Representation command.response_class = Google::Apis::TagmanagerV1::Variable command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['variableId'] = variable_id unless variable_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 all GTM Variables of a Container. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ListVariablesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ListVariablesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_variables(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/variables', options) command.response_representation = Google::Apis::TagmanagerV1::ListVariablesResponse::Representation command.response_class = Google::Apis::TagmanagerV1::ListVariablesResponse command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a GTM Variable. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] variable_id # The GTM Variable ID. # @param [Google::Apis::TagmanagerV1::Variable] variable_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the variable in # storage. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::Variable] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::Variable] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_variable(account_id, container_id, variable_id, variable_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/variables/{variableId}', options) command.request_representation = Google::Apis::TagmanagerV1::Variable::Representation command.request_object = variable_object command.response_representation = Google::Apis::TagmanagerV1::Variable::Representation command.response_class = Google::Apis::TagmanagerV1::Variable command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['variableId'] = variable_id unless variable_id.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 Container Version. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [Google::Apis::TagmanagerV1::CreateContainerVersionRequestVersionOptions] create_container_version_request_version_options_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::CreateContainerVersionResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::CreateContainerVersionResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_version(account_id, container_id, create_container_version_request_version_options_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/versions', options) command.request_representation = Google::Apis::TagmanagerV1::CreateContainerVersionRequestVersionOptions::Representation command.request_object = create_container_version_request_version_options_object command.response_representation = Google::Apis::TagmanagerV1::CreateContainerVersionResponse::Representation command.response_class = Google::Apis::TagmanagerV1::CreateContainerVersionResponse command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_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 a Container Version. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] container_version_id # The GTM Container Version 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['containerVersionId'] = container_version_id unless container_version_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 Container Version. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] container_version_id # The GTM Container Version ID. Specify published to retrieve the currently # published version. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ContainerVersion] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ContainerVersion] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}', options) command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation command.response_class = Google::Apis::TagmanagerV1::ContainerVersion command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['containerVersionId'] = container_version_id unless container_version_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 all Container Versions of a GTM Container. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [Boolean] headers # Retrieve headers only when true. # @param [Boolean] include_deleted # Also retrieve deleted (archived) versions when true. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ListContainerVersionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ListContainerVersionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_versions(account_id, container_id, headers: nil, include_deleted: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/versions', options) command.response_representation = Google::Apis::TagmanagerV1::ListContainerVersionsResponse::Representation command.response_class = Google::Apis::TagmanagerV1::ListContainerVersionsResponse command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.query['headers'] = headers unless headers.nil? command.query['includeDeleted'] = include_deleted unless include_deleted.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 # Publishes a Container Version. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] container_version_id # The GTM Container Version ID. # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the container # version in storage. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::PublishContainerVersionResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::PublishContainerVersionResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_version(account_id, container_id, container_version_id, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/publish', options) command.response_representation = Google::Apis::TagmanagerV1::PublishContainerVersionResponse::Representation command.response_class = Google::Apis::TagmanagerV1::PublishContainerVersionResponse command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['containerVersionId'] = container_version_id unless container_version_id.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 # Restores a Container Version. This will overwrite the container's current # configuration (including its variables, triggers and tags). The operation will # not have any effect on the version that is being served (i.e. the published # version). # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] container_version_id # The GTM Container Version 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ContainerVersion] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ContainerVersion] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def restore_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/restore', options) command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation command.response_class = Google::Apis::TagmanagerV1::ContainerVersion command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['containerVersionId'] = container_version_id unless container_version_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 # Undeletes a Container Version. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] container_version_id # The GTM Container Version 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ContainerVersion] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ContainerVersion] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def undelete_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/undelete', options) command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation command.response_class = Google::Apis::TagmanagerV1::ContainerVersion command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['containerVersionId'] = container_version_id unless container_version_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 a Container Version. # @param [String] account_id # The GTM Account ID. # @param [String] container_id # The GTM Container ID. # @param [String] container_version_id # The GTM Container Version ID. # @param [Google::Apis::TagmanagerV1::ContainerVersion] container_version_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the container # version in storage. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ContainerVersion] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ContainerVersion] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_version(account_id, container_id, container_version_id, container_version_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}', options) command.request_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation command.request_object = container_version_object command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation command.response_class = Google::Apis::TagmanagerV1::ContainerVersion command.params['accountId'] = account_id unless account_id.nil? command.params['containerId'] = container_id unless container_id.nil? command.params['containerVersionId'] = container_version_id unless container_version_id.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 user's Account & Container Permissions. # @param [String] account_id # The GTM Account ID. # @param [Google::Apis::TagmanagerV1::UserAccess] user_access_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::UserAccess] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::UserAccess] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_permission(account_id, user_access_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{accountId}/permissions', options) command.request_representation = Google::Apis::TagmanagerV1::UserAccess::Representation command.request_object = user_access_object command.response_representation = Google::Apis::TagmanagerV1::UserAccess::Representation command.response_class = Google::Apis::TagmanagerV1::UserAccess command.params['accountId'] = account_id unless account_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 # Removes a user from the account, revoking access to it and all of its # containers. # @param [String] account_id # The GTM Account ID. # @param [String] permission_id # The GTM User 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_permission(account_id, permission_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'accounts/{accountId}/permissions/{permissionId}', options) command.params['accountId'] = account_id unless account_id.nil? command.params['permissionId'] = permission_id unless permission_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 user's Account & Container Permissions. # @param [String] account_id # The GTM Account ID. # @param [String] permission_id # The GTM User 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::UserAccess] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::UserAccess] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_permission(account_id, permission_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/permissions/{permissionId}', options) command.response_representation = Google::Apis::TagmanagerV1::UserAccess::Representation command.response_class = Google::Apis::TagmanagerV1::UserAccess command.params['accountId'] = account_id unless account_id.nil? command.params['permissionId'] = permission_id unless permission_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 # List all users that have access to the account along with Account and # Container Permissions granted to each of them. # @param [String] account_id # The GTM Account ID. @required tagmanager.accounts.permissions.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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::ListAccountUsersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::ListAccountUsersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_permissions(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/{accountId}/permissions', options) command.response_representation = Google::Apis::TagmanagerV1::ListAccountUsersResponse::Representation command.response_class = Google::Apis::TagmanagerV1::ListAccountUsersResponse command.params['accountId'] = account_id unless account_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 a user's Account & Container Permissions. # @param [String] account_id # The GTM Account ID. # @param [String] permission_id # The GTM User ID. # @param [Google::Apis::TagmanagerV1::UserAccess] user_access_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TagmanagerV1::UserAccess] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TagmanagerV1::UserAccess] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_permission(account_id, permission_id, user_access_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'accounts/{accountId}/permissions/{permissionId}', options) command.request_representation = Google::Apis::TagmanagerV1::UserAccess::Representation command.request_object = user_access_object command.response_representation = Google::Apis::TagmanagerV1::UserAccess::Representation command.response_class = Google::Apis::TagmanagerV1::UserAccess command.params['accountId'] = account_id unless account_id.nil? command.params['permissionId'] = permission_id unless permission_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 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 end end google-api-client-0.19.8/generated/google/apis/proximitybeacon_v1beta1/0000755000004100000410000000000013252673044026053 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/proximitybeacon_v1beta1/representations.rb0000644000004100000410000003151113252673044031626 0ustar www-datawww-data# 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 ProximitybeaconV1beta1 class AdvertisedId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AttachmentInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Beacon class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BeaconAttachment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BeaconInfo 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 DeleteAttachmentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Diagnostics 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 EphemeralIdRegistration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EphemeralIdRegistrationParams class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetInfoForObservedBeaconsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetInfoForObservedBeaconsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IndoorLevel class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LatLng class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListBeaconAttachmentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListBeaconsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDiagnosticsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListNamespacesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Namespace class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Observation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdvertisedId # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :base64 => true, as: 'id' property :type, as: 'type' end end class AttachmentInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, :base64 => true, as: 'data' property :max_distance_meters, as: 'maxDistanceMeters' property :namespaced_type, as: 'namespacedType' end end class Beacon # @private class Representation < Google::Apis::Core::JsonRepresentation property :advertised_id, as: 'advertisedId', class: Google::Apis::ProximitybeaconV1beta1::AdvertisedId, decorator: Google::Apis::ProximitybeaconV1beta1::AdvertisedId::Representation property :beacon_name, as: 'beaconName' property :description, as: 'description' property :ephemeral_id_registration, as: 'ephemeralIdRegistration', class: Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistration, decorator: Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistration::Representation property :expected_stability, as: 'expectedStability' property :indoor_level, as: 'indoorLevel', class: Google::Apis::ProximitybeaconV1beta1::IndoorLevel, decorator: Google::Apis::ProximitybeaconV1beta1::IndoorLevel::Representation property :lat_lng, as: 'latLng', class: Google::Apis::ProximitybeaconV1beta1::LatLng, decorator: Google::Apis::ProximitybeaconV1beta1::LatLng::Representation property :place_id, as: 'placeId' hash :properties, as: 'properties' property :provisioning_key, :base64 => true, as: 'provisioningKey' property :status, as: 'status' end end class BeaconAttachment # @private class Representation < Google::Apis::Core::JsonRepresentation property :attachment_name, as: 'attachmentName' property :creation_time_ms, as: 'creationTimeMs' property :data, :base64 => true, as: 'data' property :max_distance_meters, as: 'maxDistanceMeters' property :namespaced_type, as: 'namespacedType' end end class BeaconInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :advertised_id, as: 'advertisedId', class: Google::Apis::ProximitybeaconV1beta1::AdvertisedId, decorator: Google::Apis::ProximitybeaconV1beta1::AdvertisedId::Representation collection :attachments, as: 'attachments', class: Google::Apis::ProximitybeaconV1beta1::AttachmentInfo, decorator: Google::Apis::ProximitybeaconV1beta1::AttachmentInfo::Representation property :beacon_name, as: 'beaconName' 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 DeleteAttachmentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :num_deleted, as: 'numDeleted' end end class Diagnostics # @private class Representation < Google::Apis::Core::JsonRepresentation collection :alerts, as: 'alerts' property :beacon_name, as: 'beaconName' property :estimated_low_battery_date, as: 'estimatedLowBatteryDate', class: Google::Apis::ProximitybeaconV1beta1::Date, decorator: Google::Apis::ProximitybeaconV1beta1::Date::Representation end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class EphemeralIdRegistration # @private class Representation < Google::Apis::Core::JsonRepresentation property :beacon_ecdh_public_key, :base64 => true, as: 'beaconEcdhPublicKey' property :beacon_identity_key, :base64 => true, as: 'beaconIdentityKey' property :initial_clock_value, :numeric_string => true, as: 'initialClockValue' property :initial_eid, :base64 => true, as: 'initialEid' property :rotation_period_exponent, as: 'rotationPeriodExponent' property :service_ecdh_public_key, :base64 => true, as: 'serviceEcdhPublicKey' end end class EphemeralIdRegistrationParams # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_rotation_period_exponent, as: 'maxRotationPeriodExponent' property :min_rotation_period_exponent, as: 'minRotationPeriodExponent' property :service_ecdh_public_key, :base64 => true, as: 'serviceEcdhPublicKey' end end class GetInfoForObservedBeaconsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :namespaced_types, as: 'namespacedTypes' collection :observations, as: 'observations', class: Google::Apis::ProximitybeaconV1beta1::Observation, decorator: Google::Apis::ProximitybeaconV1beta1::Observation::Representation end end class GetInfoForObservedBeaconsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :beacons, as: 'beacons', class: Google::Apis::ProximitybeaconV1beta1::BeaconInfo, decorator: Google::Apis::ProximitybeaconV1beta1::BeaconInfo::Representation end end class IndoorLevel # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class LatLng # @private class Representation < Google::Apis::Core::JsonRepresentation property :latitude, as: 'latitude' property :longitude, as: 'longitude' end end class ListBeaconAttachmentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :attachments, as: 'attachments', class: Google::Apis::ProximitybeaconV1beta1::BeaconAttachment, decorator: Google::Apis::ProximitybeaconV1beta1::BeaconAttachment::Representation end end class ListBeaconsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :beacons, as: 'beacons', class: Google::Apis::ProximitybeaconV1beta1::Beacon, decorator: Google::Apis::ProximitybeaconV1beta1::Beacon::Representation property :next_page_token, as: 'nextPageToken' property :total_count, :numeric_string => true, as: 'totalCount' end end class ListDiagnosticsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :diagnostics, as: 'diagnostics', class: Google::Apis::ProximitybeaconV1beta1::Diagnostics, decorator: Google::Apis::ProximitybeaconV1beta1::Diagnostics::Representation property :next_page_token, as: 'nextPageToken' end end class ListNamespacesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :namespaces, as: 'namespaces', class: Google::Apis::ProximitybeaconV1beta1::Namespace, decorator: Google::Apis::ProximitybeaconV1beta1::Namespace::Representation end end class Namespace # @private class Representation < Google::Apis::Core::JsonRepresentation property :namespace_name, as: 'namespaceName' property :serving_visibility, as: 'servingVisibility' end end class Observation # @private class Representation < Google::Apis::Core::JsonRepresentation property :advertised_id, as: 'advertisedId', class: Google::Apis::ProximitybeaconV1beta1::AdvertisedId, decorator: Google::Apis::ProximitybeaconV1beta1::AdvertisedId::Representation property :telemetry, :base64 => true, as: 'telemetry' property :timestamp_ms, as: 'timestampMs' end end end end end google-api-client-0.19.8/generated/google/apis/proximitybeacon_v1beta1/classes.rb0000644000004100000410000011023413252673044030036 0ustar www-datawww-data# 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 ProximitybeaconV1beta1 # Defines a unique identifier of a beacon as broadcast by the device. class AdvertisedId include Google::Apis::Core::Hashable # The actual beacon identifier, as broadcast by the beacon hardware. Must be # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP # requests, and will be so encoded (with padding) in responses. The base64 # encoding should be of the binary byte-stream and not any textual (such as # hex) representation thereof. # Required. # Corresponds to the JSON property `id` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :id # Specifies the identifier type. # Required. # 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) @id = args[:id] if args.key?(:id) @type = args[:type] if args.key?(:type) end end # A subset of attachment information served via the # `beaconinfo.getforobserved` method, used when your users encounter your # beacons. class AttachmentInfo include Google::Apis::Core::Hashable # An opaque data container for client-provided data. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data # The distance away from the beacon at which this attachment should be # delivered to a mobile app. # Setting this to a value greater than zero indicates that the app should # behave as if the beacon is "seen" when the mobile device is less than this # distance away from the beacon. # Different attachments on the same beacon can have different max distances. # Note that even though this value is expressed with fractional meter # precision, real-world behavior is likley to be much less precise than one # meter, due to the nature of current Bluetooth radio technology. # Optional. When not set or zero, the attachment should be delivered at the # beacon's outer limit of detection. # Corresponds to the JSON property `maxDistanceMeters` # @return [Float] attr_accessor :max_distance_meters # Specifies what kind of attachment this is. Tells a client how to # interpret the `data` field. Format is namespace/type, for # example scrupulous-wombat-12345/welcome-message # Corresponds to the JSON property `namespacedType` # @return [String] attr_accessor :namespaced_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data = args[:data] if args.key?(:data) @max_distance_meters = args[:max_distance_meters] if args.key?(:max_distance_meters) @namespaced_type = args[:namespaced_type] if args.key?(:namespaced_type) end end # Details of a beacon device. class Beacon include Google::Apis::Core::Hashable # Defines a unique identifier of a beacon as broadcast by the device. # Corresponds to the JSON property `advertisedId` # @return [Google::Apis::ProximitybeaconV1beta1::AdvertisedId] attr_accessor :advertised_id # Resource name of this beacon. A beacon name has the format # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by # the beacon and N is a code for the beacon's type. Possible values are # `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. # This field must be left empty when registering. After reading a beacon, # clients can use the name for future operations. # Corresponds to the JSON property `beaconName` # @return [String] attr_accessor :beacon_name # Free text used to identify and describe the beacon. Maximum length 140 # characters. # Optional. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Write-only registration parameters for beacons using Eddystone-EID format. # Two ways of securely registering an Eddystone-EID beacon with the service # are supported: # 1. Perform an ECDH key exchange via this API, including a previous call # to `GET /v1beta1/eidparams`. In this case the fields # `beacon_ecdh_public_key` and `service_ecdh_public_key` should be # populated and `beacon_identity_key` should not be populated. This # method ensures that only the two parties in the ECDH key exchange can # compute the identity key, which becomes a secret between them. # 2. Derive or obtain the beacon's identity key via other secure means # (perhaps an ECDH key exchange between the beacon and a mobile device # or any other secure method), and then submit the resulting identity key # to the service. In this case `beacon_identity_key` field should be # populated, and neither of `beacon_ecdh_public_key` nor # `service_ecdh_public_key` fields should be. The security of this method # depends on how securely the parties involved (in particular the # bluetooth client) handle the identity key, and obviously on how # securely the identity key was generated. # See [the Eddystone specification](https://github.com/google/eddystone/tree/ # master/eddystone-eid) at GitHub. # Corresponds to the JSON property `ephemeralIdRegistration` # @return [Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistration] attr_accessor :ephemeral_id_registration # Expected location stability. This is set when the beacon is registered or # updated, not automatically detected in any way. # Optional. # Corresponds to the JSON property `expectedStability` # @return [String] attr_accessor :expected_stability # Indoor level, a human-readable string as returned by Google Maps APIs, # useful to indicate which floor of a building a beacon is located on. # Corresponds to the JSON property `indoorLevel` # @return [Google::Apis::ProximitybeaconV1beta1::IndoorLevel] attr_accessor :indoor_level # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::ProximitybeaconV1beta1::LatLng] attr_accessor :lat_lng # The [Google Places API](/places/place-id) Place ID of the place where # the beacon is deployed. This is given when the beacon is registered or # updated, not automatically detected in any way. # Optional. # Corresponds to the JSON property `placeId` # @return [String] attr_accessor :place_id # Properties of the beacon device, for example battery type or firmware # version. # Optional. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties # Some beacons may require a user to provide an authorization key before # changing any of its configuration (e.g. broadcast frames, transmit power). # This field provides a place to store and control access to that key. # This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` # from users with write access to the given beacon. That is to say: If the # user is authorized to write the beacon's confidential data in the service, # the service considers them authorized to configure the beacon. Note # that this key grants nothing on the service, only on the beacon itself. # Corresponds to the JSON property `provisioningKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :provisioning_key # Current status of the beacon. # Required. # 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) @advertised_id = args[:advertised_id] if args.key?(:advertised_id) @beacon_name = args[:beacon_name] if args.key?(:beacon_name) @description = args[:description] if args.key?(:description) @ephemeral_id_registration = args[:ephemeral_id_registration] if args.key?(:ephemeral_id_registration) @expected_stability = args[:expected_stability] if args.key?(:expected_stability) @indoor_level = args[:indoor_level] if args.key?(:indoor_level) @lat_lng = args[:lat_lng] if args.key?(:lat_lng) @place_id = args[:place_id] if args.key?(:place_id) @properties = args[:properties] if args.key?(:properties) @provisioning_key = args[:provisioning_key] if args.key?(:provisioning_key) @status = args[:status] if args.key?(:status) end end # Project-specific data associated with a beacon. class BeaconAttachment include Google::Apis::Core::Hashable # Resource name of this attachment. Attachment names have the format: # beacons/beacon_id/attachments/attachment_id. # Leave this empty on creation. # Corresponds to the JSON property `attachmentName` # @return [String] attr_accessor :attachment_name # The UTC time when this attachment was created, in milliseconds since the # UNIX epoch. # Corresponds to the JSON property `creationTimeMs` # @return [String] attr_accessor :creation_time_ms # An opaque data container for client-provided data. Must be # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP # requests, and will be so encoded (with padding) in responses. # Required. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data # The distance away from the beacon at which this attachment should be # delivered to a mobile app. # Setting this to a value greater than zero indicates that the app should # behave as if the beacon is "seen" when the mobile device is less than this # distance away from the beacon. # Different attachments on the same beacon can have different max distances. # Note that even though this value is expressed with fractional meter # precision, real-world behavior is likley to be much less precise than one # meter, due to the nature of current Bluetooth radio technology. # Optional. When not set or zero, the attachment should be delivered at the # beacon's outer limit of detection. # Negative values are invalid and return an error. # Corresponds to the JSON property `maxDistanceMeters` # @return [Float] attr_accessor :max_distance_meters # Specifies what kind of attachment this is. Tells a client how to # interpret the `data` field. Format is namespace/type. Namespace # provides type separation between clients. Type describes the type of # `data`, for use by the client when parsing the `data` field. # Required. # Corresponds to the JSON property `namespacedType` # @return [String] attr_accessor :namespaced_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @attachment_name = args[:attachment_name] if args.key?(:attachment_name) @creation_time_ms = args[:creation_time_ms] if args.key?(:creation_time_ms) @data = args[:data] if args.key?(:data) @max_distance_meters = args[:max_distance_meters] if args.key?(:max_distance_meters) @namespaced_type = args[:namespaced_type] if args.key?(:namespaced_type) end end # A subset of beacon information served via the `beaconinfo.getforobserved` # method, which you call when users of your app encounter your beacons. class BeaconInfo include Google::Apis::Core::Hashable # Defines a unique identifier of a beacon as broadcast by the device. # Corresponds to the JSON property `advertisedId` # @return [Google::Apis::ProximitybeaconV1beta1::AdvertisedId] attr_accessor :advertised_id # Attachments matching the type(s) requested. # May be empty if no attachment types were requested. # Corresponds to the JSON property `attachments` # @return [Array] attr_accessor :attachments # The name under which the beacon is registered. # Corresponds to the JSON property `beaconName` # @return [String] attr_accessor :beacon_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @advertised_id = args[:advertised_id] if args.key?(:advertised_id) @attachments = args[:attachments] if args.key?(:attachments) @beacon_name = args[:beacon_name] if args.key?(:beacon_name) end end # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary 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/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. # 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 # Response for a request to delete attachments. class DeleteAttachmentsResponse include Google::Apis::Core::Hashable # The number of attachments that were deleted. # Corresponds to the JSON property `numDeleted` # @return [Fixnum] attr_accessor :num_deleted def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @num_deleted = args[:num_deleted] if args.key?(:num_deleted) end end # Diagnostics for a single beacon. class Diagnostics include Google::Apis::Core::Hashable # An unordered list of Alerts that the beacon has. # Corresponds to the JSON property `alerts` # @return [Array] attr_accessor :alerts # Resource name of the beacon. For Eddystone-EID beacons, this may # be the beacon's current EID, or the beacon's "stable" Eddystone-UID. # Corresponds to the JSON property `beaconName` # @return [String] attr_accessor :beacon_name # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary date. Related types are google.type.TimeOfDay # and `google.protobuf.Timestamp`. # Corresponds to the JSON property `estimatedLowBatteryDate` # @return [Google::Apis::ProximitybeaconV1beta1::Date] attr_accessor :estimated_low_battery_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alerts = args[:alerts] if args.key?(:alerts) @beacon_name = args[:beacon_name] if args.key?(:beacon_name) @estimated_low_battery_date = args[:estimated_low_battery_date] if args.key?(:estimated_low_battery_date) 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 # Write-only registration parameters for beacons using Eddystone-EID format. # Two ways of securely registering an Eddystone-EID beacon with the service # are supported: # 1. Perform an ECDH key exchange via this API, including a previous call # to `GET /v1beta1/eidparams`. In this case the fields # `beacon_ecdh_public_key` and `service_ecdh_public_key` should be # populated and `beacon_identity_key` should not be populated. This # method ensures that only the two parties in the ECDH key exchange can # compute the identity key, which becomes a secret between them. # 2. Derive or obtain the beacon's identity key via other secure means # (perhaps an ECDH key exchange between the beacon and a mobile device # or any other secure method), and then submit the resulting identity key # to the service. In this case `beacon_identity_key` field should be # populated, and neither of `beacon_ecdh_public_key` nor # `service_ecdh_public_key` fields should be. The security of this method # depends on how securely the parties involved (in particular the # bluetooth client) handle the identity key, and obviously on how # securely the identity key was generated. # See [the Eddystone specification](https://github.com/google/eddystone/tree/ # master/eddystone-eid) at GitHub. class EphemeralIdRegistration include Google::Apis::Core::Hashable # The beacon's public key used for the Elliptic curve Diffie-Hellman # key exchange. When this field is populated, `service_ecdh_public_key` # must also be populated, and `beacon_identity_key` must not be. # Corresponds to the JSON property `beaconEcdhPublicKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :beacon_ecdh_public_key # The private key of the beacon. If this field is populated, # `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be # populated. # Corresponds to the JSON property `beaconIdentityKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :beacon_identity_key # The initial clock value of the beacon. The beacon's clock must have # begun counting at this value immediately prior to transmitting this # value to the resolving service. Significant delay in transmitting this # value to the service risks registration or resolution failures. If a # value is not provided, the default is zero. # Corresponds to the JSON property `initialClockValue` # @return [Fixnum] attr_accessor :initial_clock_value # An initial ephemeral ID calculated using the clock value submitted as # `initial_clock_value`, and the secret key generated by the # Diffie-Hellman key exchange using `service_ecdh_public_key` and # `service_ecdh_public_key`. This initial EID value will be used by the # service to confirm that the key exchange process was successful. # Corresponds to the JSON property `initialEid` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :initial_eid # Indicates the nominal period between each rotation of the beacon's # ephemeral ID. "Nominal" because the beacon should randomize the # actual interval. See [the spec at github](https://github.com/google/eddystone/ # tree/master/eddystone-eid) # for details. This value corresponds to a power-of-two scaler on the # beacon's clock: when the scaler value is K, the beacon will begin # broadcasting a new ephemeral ID on average every 2^K seconds. # Corresponds to the JSON property `rotationPeriodExponent` # @return [Fixnum] attr_accessor :rotation_period_exponent # The service's public key used for the Elliptic curve Diffie-Hellman # key exchange. When this field is populated, `beacon_ecdh_public_key` # must also be populated, and `beacon_identity_key` must not be. # Corresponds to the JSON property `serviceEcdhPublicKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :service_ecdh_public_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @beacon_ecdh_public_key = args[:beacon_ecdh_public_key] if args.key?(:beacon_ecdh_public_key) @beacon_identity_key = args[:beacon_identity_key] if args.key?(:beacon_identity_key) @initial_clock_value = args[:initial_clock_value] if args.key?(:initial_clock_value) @initial_eid = args[:initial_eid] if args.key?(:initial_eid) @rotation_period_exponent = args[:rotation_period_exponent] if args.key?(:rotation_period_exponent) @service_ecdh_public_key = args[:service_ecdh_public_key] if args.key?(:service_ecdh_public_key) end end # Information a client needs to provision and register beacons that # broadcast Eddystone-EID format beacon IDs, using Elliptic curve # Diffie-Hellman key exchange. See # [the Eddystone specification](https://github.com/google/eddystone/tree/master/ # eddystone-eid) at GitHub. class EphemeralIdRegistrationParams include Google::Apis::Core::Hashable # Indicates the maximum rotation period supported by the service. # See EddystoneEidRegistration.rotation_period_exponent # Corresponds to the JSON property `maxRotationPeriodExponent` # @return [Fixnum] attr_accessor :max_rotation_period_exponent # Indicates the minimum rotation period supported by the service. # See EddystoneEidRegistration.rotation_period_exponent # Corresponds to the JSON property `minRotationPeriodExponent` # @return [Fixnum] attr_accessor :min_rotation_period_exponent # The beacon service's public key for use by a beacon to derive its # Identity Key using Elliptic Curve Diffie-Hellman key exchange. # Corresponds to the JSON property `serviceEcdhPublicKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :service_ecdh_public_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_rotation_period_exponent = args[:max_rotation_period_exponent] if args.key?(:max_rotation_period_exponent) @min_rotation_period_exponent = args[:min_rotation_period_exponent] if args.key?(:min_rotation_period_exponent) @service_ecdh_public_key = args[:service_ecdh_public_key] if args.key?(:service_ecdh_public_key) end end # Request for beacon and attachment information about beacons that # a mobile client has encountered "in the wild". class GetInfoForObservedBeaconsRequest include Google::Apis::Core::Hashable # Specifies what kind of attachments to include in the response. # When given, the response will include only attachments of the given types. # When empty, no attachments will be returned. Must be in the format # namespace/type. Accepts `*` to specify all types in # all namespaces owned by the client. # Optional. # Corresponds to the JSON property `namespacedTypes` # @return [Array] attr_accessor :namespaced_types # The beacons that the client has encountered. # At least one must be given. # Corresponds to the JSON property `observations` # @return [Array] attr_accessor :observations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @namespaced_types = args[:namespaced_types] if args.key?(:namespaced_types) @observations = args[:observations] if args.key?(:observations) end end # Information about the requested beacons, optionally including attachment # data. class GetInfoForObservedBeaconsResponse include Google::Apis::Core::Hashable # Public information about beacons. # May be empty if the request matched no beacons. # Corresponds to the JSON property `beacons` # @return [Array] attr_accessor :beacons def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @beacons = args[:beacons] if args.key?(:beacons) end end # Indoor level, a human-readable string as returned by Google Maps APIs, # useful to indicate which floor of a building a beacon is located on. class IndoorLevel include Google::Apis::Core::Hashable # The name of this level. # 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 # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. class LatLng include Google::Apis::Core::Hashable # The latitude in degrees. It must be in the range [-90.0, +90.0]. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude # The longitude in degrees. It must be in the range [-180.0, +180.0]. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @latitude = args[:latitude] if args.key?(:latitude) @longitude = args[:longitude] if args.key?(:longitude) end end # Response to `ListBeaconAttachments` that contains the requested attachments. class ListBeaconAttachmentsResponse include Google::Apis::Core::Hashable # The attachments that corresponded to the request params. # Corresponds to the JSON property `attachments` # @return [Array] attr_accessor :attachments def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @attachments = args[:attachments] if args.key?(:attachments) end end # Response that contains list beacon results and pagination help. class ListBeaconsResponse include Google::Apis::Core::Hashable # The beacons that matched the search criteria. # Corresponds to the JSON property `beacons` # @return [Array] attr_accessor :beacons # An opaque pagination token that the client may provide in their next # request to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Estimate of the total number of beacons matched by the query. Higher # values may be less accurate. # Corresponds to the JSON property `totalCount` # @return [Fixnum] attr_accessor :total_count def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @beacons = args[:beacons] if args.key?(:beacons) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @total_count = args[:total_count] if args.key?(:total_count) end end # Response that contains the requested diagnostics. class ListDiagnosticsResponse include Google::Apis::Core::Hashable # The diagnostics matching the given request. # Corresponds to the JSON property `diagnostics` # @return [Array] attr_accessor :diagnostics # Token that can be used for pagination. Returned only if the # request matches more beacons than can be returned in this response. # 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) @diagnostics = args[:diagnostics] if args.key?(:diagnostics) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response to ListNamespacesRequest that contains all the project's namespaces. class ListNamespacesResponse include Google::Apis::Core::Hashable # The attachments that corresponded to the request params. # Corresponds to the JSON property `namespaces` # @return [Array] attr_accessor :namespaces def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @namespaces = args[:namespaces] if args.key?(:namespaces) end end # An attachment namespace defines read and write access for all the attachments # created under it. Each namespace is globally unique, and owned by one # project which is the only project that can create attachments under it. class Namespace include Google::Apis::Core::Hashable # Resource name of this namespace. Namespaces names have the format: # namespaces/namespace. # Corresponds to the JSON property `namespaceName` # @return [String] attr_accessor :namespace_name # Specifies what clients may receive attachments under this namespace # via `beaconinfo.getforobserved`. # Corresponds to the JSON property `servingVisibility` # @return [String] attr_accessor :serving_visibility def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @namespace_name = args[:namespace_name] if args.key?(:namespace_name) @serving_visibility = args[:serving_visibility] if args.key?(:serving_visibility) end end # Represents one beacon observed once. class Observation include Google::Apis::Core::Hashable # Defines a unique identifier of a beacon as broadcast by the device. # Corresponds to the JSON property `advertisedId` # @return [Google::Apis::ProximitybeaconV1beta1::AdvertisedId] attr_accessor :advertised_id # The array of telemetry bytes received from the beacon. The server is # responsible for parsing it. This field may frequently be empty, as # with a beacon that transmits telemetry only occasionally. # Corresponds to the JSON property `telemetry` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :telemetry # Time when the beacon was observed. # Corresponds to the JSON property `timestampMs` # @return [String] attr_accessor :timestamp_ms def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @advertised_id = args[:advertised_id] if args.key?(:advertised_id) @telemetry = args[:telemetry] if args.key?(:telemetry) @timestamp_ms = args[:timestamp_ms] if args.key?(:timestamp_ms) end end end end end google-api-client-0.19.8/generated/google/apis/proximitybeacon_v1beta1/service.rb0000644000004100000410000016210713252673044030047 0ustar www-datawww-data# 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 ProximitybeaconV1beta1 # Google Proximity Beacon API # # Registers, manages, indexes, and searches beacons. # # @example # require 'google/apis/proximitybeacon_v1beta1' # # Proximitybeacon = Google::Apis::ProximitybeaconV1beta1 # Alias the module # service = Proximitybeacon::ProximitybeaconService.new # # @see https://developers.google.com/beacons/proximity/ class ProximitybeaconService < 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://proximitybeacon.googleapis.com/', '') @batch_path = 'batch' end # Given one or more beacon observations, returns any beacon information # and attachments accessible to your application. Authorize by using the # [API key](https://developers.google.com/beacons/proximity/get-started# # request_a_browser_api_key) # for the application. # @param [Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsRequest] get_info_for_observed_beacons_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::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def getforobserved_beaconinfo(get_info_for_observed_beacons_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/beaconinfo:getforobserved', options) command.request_representation = Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsRequest::Representation command.request_object = get_info_for_observed_beacons_request_object command.response_representation = Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Activates a beacon. A beacon that is active will return information # and attachment data when queried via `beaconinfo.getforobserved`. # Calling this method on an already active beacon will do nothing (but # will return a successful response code). # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **Is owner** or **Can edit** permissions in the # Google Developers Console project. # @param [String] beacon_name # Beacon that should be activated. A beacon name has the format # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by # the beacon and N is a code for the beacon's type. Possible values are # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` # for AltBeacon. For Eddystone-EID beacons, you may use either the # current EID or the beacon's "stable" UID. # Required. # @param [String] project_id # The project id of the beacon to activate. If the project id is not # specified then the project making the request is used. The project id # must match the project that owns the beacon. # 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::ProximitybeaconV1beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::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 activate_beacon(beacon_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+beaconName}:activate', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty command.params['beaconName'] = beacon_name unless beacon_name.nil? command.query['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 # Deactivates a beacon. Once deactivated, the API will not return # information nor attachment data for the beacon when queried via # `beaconinfo.getforobserved`. Calling this method on an already inactive # beacon will do nothing (but will return a successful response code). # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **Is owner** or **Can edit** permissions in the # Google Developers Console project. # @param [String] beacon_name # Beacon that should be deactivated. A beacon name has the format # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by # the beacon and N is a code for the beacon's type. Possible values are # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` # for AltBeacon. For Eddystone-EID beacons, you may use either the # current EID or the beacon's "stable" UID. # Required. # @param [String] project_id # The project id of the beacon to deactivate. If the project id is not # specified then the project making the request is used. The project id must # match the project that owns the beacon. # 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::ProximitybeaconV1beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::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 deactivate_beacon(beacon_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+beaconName}:deactivate', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty command.params['beaconName'] = beacon_name unless beacon_name.nil? command.query['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 # Decommissions the specified beacon in the service. This beacon will no # longer be returned from `beaconinfo.getforobserved`. This operation is # permanent -- you will not be able to re-register a beacon with this ID # again. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **Is owner** or **Can edit** permissions in the # Google Developers Console project. # @param [String] beacon_name # Beacon that should be decommissioned. A beacon name has the format # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by # the beacon and N is a code for the beacon's type. Possible values are # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` # for AltBeacon. For Eddystone-EID beacons, you may use either the # current EID of the beacon's "stable" UID. # Required. # @param [String] project_id # The project id of the beacon to decommission. If the project id is not # specified then the project making the request is used. The project id # must match the project that owns the beacon. # 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::ProximitybeaconV1beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::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 decommission_beacon(beacon_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+beaconName}:decommission', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty command.params['beaconName'] = beacon_name unless beacon_name.nil? command.query['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 # Deletes the specified beacon including all diagnostics data for the beacon # as well as any attachments on the beacon (including those belonging to # other projects). This operation cannot be undone. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **Is owner** or **Can edit** permissions in the # Google Developers Console project. # @param [String] beacon_name # Beacon that should be deleted. A beacon name has the format # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by # the beacon and N is a code for the beacon's type. Possible values are # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` # for AltBeacon. For Eddystone-EID beacons, you may use either the # current EID or the beacon's "stable" UID. # Required. # @param [String] project_id # The project id of the beacon to delete. If not provided, the project # that is making the request is used. # 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::ProximitybeaconV1beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::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_beacon(beacon_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+beaconName}', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty command.params['beaconName'] = beacon_name unless beacon_name.nil? command.query['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 # Returns detailed information about the specified beacon. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **viewer**, **Is owner** or **Can edit** # permissions in the Google Developers Console project. # Requests may supply an Eddystone-EID beacon name in the form: # `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID # broadcast by the beacon. The returned `Beacon` object will contain the # beacon's stable Eddystone-UID. Clients not authorized to resolve the # beacon's ephemeral Eddystone-EID broadcast will receive an error. # @param [String] beacon_name # Resource name of this beacon. A beacon name has the format # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by # the beacon and N is a code for the beacon's type. Possible values are # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` # for AltBeacon. For Eddystone-EID beacons, you may use either the # current EID or the beacon's "stable" UID. # Required. # @param [String] project_id # The project id of the beacon to request. If the project id is not specified # then the project making the request is used. The project id must match the # project that owns the beacon. # 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::ProximitybeaconV1beta1::Beacon] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::Beacon] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_beacon(beacon_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+beaconName}', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::Beacon command.params['beaconName'] = beacon_name unless beacon_name.nil? command.query['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 # Searches the beacon registry for beacons that match the given search # criteria. Only those beacons that the client has permission to list # will be returned. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **viewer**, **Is owner** or **Can edit** # permissions in the Google Developers Console project. # @param [Fixnum] page_size # The maximum number of records to return for this request, up to a # server-defined upper limit. # @param [String] page_token # A pagination token obtained from a previous request to list beacons. # @param [String] project_id # The project id to list beacons under. If not present then the project # credential that made the request is used as the project. # Optional. # @param [String] q # Filter query string that supports the following field filters: # * **description:`""`** # For example: **description:"Room 3"** # Returns beacons whose description matches tokens in the string "Room 3" # (not necessarily that exact string). # The string must be double-quoted. # * **status:``** # For example: **status:active** # Returns beacons whose status matches the given value. Values must be # one of the Beacon.Status enum values (case insensitive). Accepts # multiple filters which will be combined with OR logic. # * **stability:``** # For example: **stability:mobile** # Returns beacons whose expected stability matches the given value. # Values must be one of the Beacon.Stability enum values (case # insensitive). Accepts multiple filters which will be combined with # OR logic. # * **place\_id:`""`** # For example: **place\_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw="** # Returns beacons explicitly registered at the given place, expressed as # a Place ID obtained from [Google Places API](/places/place-id). Does not # match places inside the given place. Does not consider the beacon's # actual location (which may be different from its registered place). # Accepts multiple filters that will be combined with OR logic. The place # ID must be double-quoted. # * **registration\_time`[<|>|<=|>=]`** # For example: **registration\_time>=1433116800** # Returns beacons whose registration time matches the given filter. # Supports the operators: <, >, <=, and >=. Timestamp must be expressed as # an integer number of seconds since midnight January 1, 1970 UTC. Accepts # at most two filters that will be combined with AND logic, to support # "between" semantics. If more than two are supplied, the latter ones are # ignored. # * **lat:` lng: radius:`** # For example: **lat:51.1232343 lng:-1.093852 radius:1000** # Returns beacons whose registered location is within the given circle. # When any of these fields are given, all are required. Latitude and # longitude must be decimal degrees between -90.0 and 90.0 and between # -180.0 and 180.0 respectively. Radius must be an integer number of # meters between 10 and 1,000,000 (1000 km). # * **property:`"="`** # For example: **property:"battery-type=CR2032"** # Returns beacons which have a property of the given name and value. # Supports multiple filters which will be combined with OR logic. # The entire name=value string must be double-quoted as one string. # * **attachment\_type:`""`** # For example: **attachment_type:"my-namespace/my-type"** # Returns beacons having at least one attachment of the given namespaced # type. Supports "any within this namespace" via the partial wildcard # syntax: "my-namespace/*". Supports multiple filters which will be # combined with OR logic. The string must be double-quoted. # * **indoor\_level:`""`** # For example: **indoor\_level:"1"** # Returns beacons which are located on the given indoor level. Accepts # multiple filters that will be combined with OR logic. # Multiple filters on the same field are combined with OR logic (except # registration_time which is combined with AND logic). # Multiple filters on different fields are combined with AND logic. # Filters should be separated by spaces. # As with any HTTP query string parameter, the whole filter expression must # be URL-encoded. # Example REST request: # `GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000` # @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::ProximitybeaconV1beta1::ListBeaconsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::ListBeaconsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_beacons(page_size: nil, page_token: nil, project_id: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/beacons', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListBeaconsResponse::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::ListBeaconsResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['q'] = q unless q.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Registers a previously unregistered beacon given its `advertisedId`. # These IDs are unique within the system. An ID can be registered only once. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **Is owner** or **Can edit** permissions in the # Google Developers Console project. # @param [Google::Apis::ProximitybeaconV1beta1::Beacon] beacon_object # @param [String] project_id # The project id of the project the beacon will be registered to. If # the project id is not specified then the project making the request # is used. # 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::ProximitybeaconV1beta1::Beacon] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::Beacon] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def register_beacon(beacon_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/beacons:register', options) command.request_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation command.request_object = beacon_object command.response_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::Beacon command.query['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 # Updates the information about the specified beacon. **Any field that you do # not populate in the submitted beacon will be permanently erased**, so you # should follow the "read, modify, write" pattern to avoid inadvertently # destroying data. # Changes to the beacon status via this method will be silently ignored. # To update beacon status, use the separate methods on this API for # activation, deactivation, and decommissioning. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **Is owner** or **Can edit** permissions in the # Google Developers Console project. # @param [String] beacon_name # Resource name of this beacon. A beacon name has the format # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by # the beacon and N is a code for the beacon's type. Possible values are # `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. # This field must be left empty when registering. After reading a beacon, # clients can use the name for future operations. # @param [Google::Apis::ProximitybeaconV1beta1::Beacon] beacon_object # @param [String] project_id # The project id of the beacon to update. If the project id is not # specified then the project making the request is used. The project id # must match the project that owns the beacon. # 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::ProximitybeaconV1beta1::Beacon] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::Beacon] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_beacon(beacon_name, beacon_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta1/{+beaconName}', options) command.request_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation command.request_object = beacon_object command.response_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::Beacon command.params['beaconName'] = beacon_name unless beacon_name.nil? command.query['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 # Deletes multiple attachments on a given beacon. This operation is # permanent and cannot be undone. # You can optionally specify `namespacedType` to choose which attachments # should be deleted. If you do not specify `namespacedType`, all your # attachments on the given beacon will be deleted. You also may explicitly # specify `*/*` to delete all. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **Is owner** or **Can edit** permissions in the # Google Developers Console project. # @param [String] beacon_name # The beacon whose attachments should be deleted. A beacon name has the # format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast # by the beacon and N is a code for the beacon's type. Possible values are # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` # for AltBeacon. For Eddystone-EID beacons, you may use either the # current EID or the beacon's "stable" UID. # Required. # @param [String] namespaced_type # Specifies the namespace and type of attachments to delete in # `namespace/type` format. Accepts `*/*` to specify # "all types in all namespaces". # Optional. # @param [String] project_id # The project id to delete beacon attachments under. This field can be # used when "*" is specified to mean all attachment namespaces. Projects # may have multiple attachments with multiple namespaces. If "*" is # specified and the projectId string is empty, then the project # making the request is used. # 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::ProximitybeaconV1beta1::DeleteAttachmentsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::DeleteAttachmentsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_beacon_attachment_delete(beacon_name, namespaced_type: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+beaconName}/attachments:batchDelete', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::DeleteAttachmentsResponse::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::DeleteAttachmentsResponse command.params['beaconName'] = beacon_name unless beacon_name.nil? command.query['namespacedType'] = namespaced_type unless namespaced_type.nil? command.query['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 # Associates the given data with the specified beacon. Attachment data must # contain two parts: #
    #
  • A namespaced type.
    • #
  • The actual attachment data itself.
    • #
# The namespaced type consists of two parts, the namespace and the type. # The namespace must be one of the values returned by the `namespaces` # endpoint, while the type can be a string of any characters except for the # forward slash (`/`) up to 100 characters in length. # Attachment data can be up to 1024 bytes long. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **Is owner** or **Can edit** permissions in the # Google Developers Console project. # @param [String] beacon_name # Beacon on which the attachment should be created. A beacon name has the # format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast # by the beacon and N is a code for the beacon's type. Possible values are # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` # for AltBeacon. For Eddystone-EID beacons, you may use either the # current EID or the beacon's "stable" UID. # Required. # @param [Google::Apis::ProximitybeaconV1beta1::BeaconAttachment] beacon_attachment_object # @param [String] project_id # The project id of the project the attachment will belong to. If # the project id is not specified then the project making the request # is used. # 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::ProximitybeaconV1beta1::BeaconAttachment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::BeaconAttachment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_beacon_attachment(beacon_name, beacon_attachment_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+beaconName}/attachments', options) command.request_representation = Google::Apis::ProximitybeaconV1beta1::BeaconAttachment::Representation command.request_object = beacon_attachment_object command.response_representation = Google::Apis::ProximitybeaconV1beta1::BeaconAttachment::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::BeaconAttachment command.params['beaconName'] = beacon_name unless beacon_name.nil? command.query['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 # Deletes the specified attachment for the given beacon. Each attachment has # a unique attachment name (`attachmentName`) which is returned when you # fetch the attachment data via this API. You specify this with the delete # request to control which attachment is removed. This operation cannot be # undone. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **Is owner** or **Can edit** permissions in the # Google Developers Console project. # @param [String] attachment_name # The attachment name (`attachmentName`) of # the attachment to remove. For example: # `beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For # Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the # beacon's current EID, or its "stable" Eddystone-UID. # Required. # @param [String] project_id # The project id of the attachment to delete. If not provided, the project # that is making the request is used. # 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::ProximitybeaconV1beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::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_beacon_attachment(attachment_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+attachmentName}', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty command.params['attachmentName'] = attachment_name unless attachment_name.nil? command.query['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 # Returns the attachments for the specified beacon that match the specified # namespaced-type pattern. # To control which namespaced types are returned, you add the # `namespacedType` query parameter to the request. You must either use # `*/*`, to return all attachments, or the namespace must be one of # the ones returned from the `namespaces` endpoint. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **viewer**, **Is owner** or **Can edit** # permissions in the Google Developers Console project. # @param [String] beacon_name # Beacon whose attachments should be fetched. A beacon name has the # format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast # by the beacon and N is a code for the beacon's type. Possible values are # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` # for AltBeacon. For Eddystone-EID beacons, you may use either the # current EID or the beacon's "stable" UID. # Required. # @param [String] namespaced_type # Specifies the namespace and type of attachment to include in response in # namespace/type format. Accepts `*/*` to specify # "all types in all namespaces". # @param [String] project_id # The project id to list beacon attachments under. This field can be # used when "*" is specified to mean all attachment namespaces. Projects # may have multiple attachments with multiple namespaces. If "*" is # specified and the projectId string is empty, then the project # making the request is used. # 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::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_beacon_attachments(beacon_name, namespaced_type: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+beaconName}/attachments', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse command.params['beaconName'] = beacon_name unless beacon_name.nil? command.query['namespacedType'] = namespaced_type unless namespaced_type.nil? command.query['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 # List the diagnostics for a single beacon. You can also list diagnostics for # all the beacons owned by your Google Developers Console project by using # the beacon name `beacons/-`. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **viewer**, **Is owner** or **Can edit** # permissions in the Google Developers Console project. # @param [String] beacon_name # Beacon that the diagnostics are for. # @param [String] alert_filter # Requests only beacons that have the given alert. For example, to find # beacons that have low batteries use `alert_filter=LOW_BATTERY`. # @param [Fixnum] page_size # Specifies the maximum number of results to return. Defaults to # 10. Maximum 1000. Optional. # @param [String] page_token # Requests results that occur after the `page_token`, obtained from the # response to a previous request. Optional. # @param [String] project_id # Requests only diagnostic records for the given project id. If not set, # then the project making the request will be used for looking up # diagnostic records. 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::ProximitybeaconV1beta1::ListDiagnosticsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::ListDiagnosticsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_beacon_diagnostics(beacon_name, alert_filter: nil, page_size: nil, page_token: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+beaconName}/diagnostics', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListDiagnosticsResponse::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::ListDiagnosticsResponse command.params['beaconName'] = beacon_name unless beacon_name.nil? command.query['alertFilter'] = alert_filter unless alert_filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['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 # Lists all attachment namespaces owned by your Google Developers Console # project. Attachment data associated with a beacon must include a # namespaced type, and the namespace must be owned by your project. # Authenticate using an [OAuth access token](https://developers.google.com/ # identity/protocols/OAuth2) # from a signed-in user with **viewer**, **Is owner** or **Can edit** # permissions in the Google Developers Console project. # @param [String] project_id # The project id to list namespaces under. # 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::ProximitybeaconV1beta1::ListNamespacesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::ListNamespacesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_namespaces(project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/namespaces', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListNamespacesResponse::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::ListNamespacesResponse command.query['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 # Updates the information about the specified namespace. Only the namespace # visibility can be updated. # @param [String] namespace_name # Resource name of this namespace. Namespaces names have the format: # namespaces/namespace. # @param [Google::Apis::ProximitybeaconV1beta1::Namespace] namespace_object # @param [String] project_id # The project id of the namespace to update. If the project id is not # specified then the project making the request is used. The project id # must match the project that owns the beacon. # 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::ProximitybeaconV1beta1::Namespace] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::Namespace] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_namespace(namespace_name, namespace_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta1/{+namespaceName}', options) command.request_representation = Google::Apis::ProximitybeaconV1beta1::Namespace::Representation command.request_object = namespace_object command.response_representation = Google::Apis::ProximitybeaconV1beta1::Namespace::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::Namespace command.params['namespaceName'] = namespace_name unless namespace_name.nil? command.query['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 # Gets the Proximity Beacon API's current public key and associated # parameters used to initiate the Diffie-Hellman key exchange required to # register a beacon that broadcasts the Eddystone-EID format. This key # changes periodically; clients may cache it and re-use the same public key # to provision and register multiple beacons. However, clients should be # prepared to refresh this key when they encounter an error registering an # Eddystone-EID beacon. # @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::ProximitybeaconV1beta1::EphemeralIdRegistrationParams] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistrationParams] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_eidparams(fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/eidparams', options) command.response_representation = Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistrationParams::Representation command.response_class = Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistrationParams 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 google-api-client-0.19.8/generated/google/apis/storage_v1beta2/0000755000004100000410000000000013252673044024304 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/storage_v1beta2/representations.rb0000644000004100000410000003774713252673044030100 0ustar www-datawww-data# 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 StorageV1beta2 class Bucket class Representation < Google::Apis::Core::JsonRepresentation; end class Cor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Lifecycle class Representation < Google::Apis::Core::JsonRepresentation; end class Rule class Representation < Google::Apis::Core::JsonRepresentation; end class Action class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Condition 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 Logging class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Owner class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Versioning class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Website class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class BucketAccessControl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BucketAccessControls class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Buckets 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 ComposeRequest class Representation < Google::Apis::Core::JsonRepresentation; end class SourceObject class Representation < Google::Apis::Core::JsonRepresentation; end class ObjectPreconditions 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 Object class Representation < Google::Apis::Core::JsonRepresentation; end class Owner class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ObjectAccessControl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ObjectAccessControls class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Objects class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Bucket # @private class Representation < Google::Apis::Core::JsonRepresentation collection :acl, as: 'acl', class: Google::Apis::StorageV1beta2::BucketAccessControl, decorator: Google::Apis::StorageV1beta2::BucketAccessControl::Representation collection :cors, as: 'cors', class: Google::Apis::StorageV1beta2::Bucket::Cor, decorator: Google::Apis::StorageV1beta2::Bucket::Cor::Representation collection :default_object_acl, as: 'defaultObjectAcl', class: Google::Apis::StorageV1beta2::ObjectAccessControl, decorator: Google::Apis::StorageV1beta2::ObjectAccessControl::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :lifecycle, as: 'lifecycle', class: Google::Apis::StorageV1beta2::Bucket::Lifecycle, decorator: Google::Apis::StorageV1beta2::Bucket::Lifecycle::Representation property :location, as: 'location' property :logging, as: 'logging', class: Google::Apis::StorageV1beta2::Bucket::Logging, decorator: Google::Apis::StorageV1beta2::Bucket::Logging::Representation property :metageneration, :numeric_string => true, as: 'metageneration' property :name, as: 'name' property :owner, as: 'owner', class: Google::Apis::StorageV1beta2::Bucket::Owner, decorator: Google::Apis::StorageV1beta2::Bucket::Owner::Representation property :self_link, as: 'selfLink' property :storage_class, as: 'storageClass' property :time_created, as: 'timeCreated', type: DateTime property :versioning, as: 'versioning', class: Google::Apis::StorageV1beta2::Bucket::Versioning, decorator: Google::Apis::StorageV1beta2::Bucket::Versioning::Representation property :website, as: 'website', class: Google::Apis::StorageV1beta2::Bucket::Website, decorator: Google::Apis::StorageV1beta2::Bucket::Website::Representation end class Cor # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_age_seconds, as: 'maxAgeSeconds' collection :method_prop, as: 'method' collection :origin, as: 'origin' collection :response_header, as: 'responseHeader' end end class Lifecycle # @private class Representation < Google::Apis::Core::JsonRepresentation collection :rule, as: 'rule', class: Google::Apis::StorageV1beta2::Bucket::Lifecycle::Rule, decorator: Google::Apis::StorageV1beta2::Bucket::Lifecycle::Rule::Representation end class Rule # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action', class: Google::Apis::StorageV1beta2::Bucket::Lifecycle::Rule::Action, decorator: Google::Apis::StorageV1beta2::Bucket::Lifecycle::Rule::Action::Representation property :condition, as: 'condition', class: Google::Apis::StorageV1beta2::Bucket::Lifecycle::Rule::Condition, decorator: Google::Apis::StorageV1beta2::Bucket::Lifecycle::Rule::Condition::Representation end class Action # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' end end class Condition # @private class Representation < Google::Apis::Core::JsonRepresentation property :age, as: 'age' property :created_before, as: 'createdBefore', type: Date property :is_live, as: 'isLive' property :num_newer_versions, as: 'numNewerVersions' end end end end class Logging # @private class Representation < Google::Apis::Core::JsonRepresentation property :log_bucket, as: 'logBucket' property :log_object_prefix, as: 'logObjectPrefix' end end class Owner # @private class Representation < Google::Apis::Core::JsonRepresentation property :entity, as: 'entity' property :entity_id, as: 'entityId' end end class Versioning # @private class Representation < Google::Apis::Core::JsonRepresentation property :enabled, as: 'enabled' end end class Website # @private class Representation < Google::Apis::Core::JsonRepresentation property :main_page_suffix, as: 'mainPageSuffix' property :not_found_page, as: 'notFoundPage' end end end class BucketAccessControl # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket, as: 'bucket' property :domain, as: 'domain' property :email, as: 'email' property :entity, as: 'entity' property :entity_id, as: 'entityId' property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :role, as: 'role' property :self_link, as: 'selfLink' end end class BucketAccessControls # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::StorageV1beta2::BucketAccessControl, decorator: Google::Apis::StorageV1beta2::BucketAccessControl::Representation property :kind, as: 'kind' end end class Buckets # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::StorageV1beta2::Bucket, decorator: Google::Apis::StorageV1beta2::Bucket::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Channel # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address' property :expiration, :numeric_string => true, as: 'expiration' property :id, as: 'id' property :kind, as: 'kind' hash :params, as: 'params' property :payload, as: 'payload' property :resource_id, as: 'resourceId' property :resource_uri, as: 'resourceUri' property :token, as: 'token' property :type, as: 'type' end end class ComposeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination, as: 'destination', class: Google::Apis::StorageV1beta2::Object, decorator: Google::Apis::StorageV1beta2::Object::Representation property :kind, as: 'kind' collection :source_objects, as: 'sourceObjects', class: Google::Apis::StorageV1beta2::ComposeRequest::SourceObject, decorator: Google::Apis::StorageV1beta2::ComposeRequest::SourceObject::Representation end class SourceObject # @private class Representation < Google::Apis::Core::JsonRepresentation property :generation, :numeric_string => true, as: 'generation' property :name, as: 'name' property :object_preconditions, as: 'objectPreconditions', class: Google::Apis::StorageV1beta2::ComposeRequest::SourceObject::ObjectPreconditions, decorator: Google::Apis::StorageV1beta2::ComposeRequest::SourceObject::ObjectPreconditions::Representation end class ObjectPreconditions # @private class Representation < Google::Apis::Core::JsonRepresentation property :if_generation_match, :numeric_string => true, as: 'ifGenerationMatch' end end end end class Object # @private class Representation < Google::Apis::Core::JsonRepresentation collection :acl, as: 'acl', class: Google::Apis::StorageV1beta2::ObjectAccessControl, decorator: Google::Apis::StorageV1beta2::ObjectAccessControl::Representation property :bucket, as: 'bucket' property :cache_control, as: 'cacheControl' property :component_count, as: 'componentCount' property :content_disposition, as: 'contentDisposition' property :content_encoding, as: 'contentEncoding' property :content_language, as: 'contentLanguage' property :content_type, as: 'contentType' property :crc32c, as: 'crc32c' property :etag, as: 'etag' property :generation, :numeric_string => true, as: 'generation' property :id, as: 'id' property :kind, as: 'kind' property :md5_hash, as: 'md5Hash' property :media_link, as: 'mediaLink' hash :metadata, as: 'metadata' property :metageneration, :numeric_string => true, as: 'metageneration' property :name, as: 'name' property :owner, as: 'owner', class: Google::Apis::StorageV1beta2::Object::Owner, decorator: Google::Apis::StorageV1beta2::Object::Owner::Representation property :self_link, as: 'selfLink' property :size, :numeric_string => true, as: 'size' property :storage_class, as: 'storageClass' property :time_deleted, as: 'timeDeleted', type: DateTime property :updated, as: 'updated', type: DateTime end class Owner # @private class Representation < Google::Apis::Core::JsonRepresentation property :entity, as: 'entity' property :entity_id, as: 'entityId' end end end class ObjectAccessControl # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket, as: 'bucket' property :domain, as: 'domain' property :email, as: 'email' property :entity, as: 'entity' property :entity_id, as: 'entityId' property :etag, as: 'etag' property :generation, :numeric_string => true, as: 'generation' property :id, as: 'id' property :kind, as: 'kind' property :object, as: 'object' property :role, as: 'role' property :self_link, as: 'selfLink' end end class ObjectAccessControls # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items' property :kind, as: 'kind' end end class Objects # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::StorageV1beta2::Object, decorator: Google::Apis::StorageV1beta2::Object::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :prefixes, as: 'prefixes' end end end end end google-api-client-0.19.8/generated/google/apis/storage_v1beta2/classes.rb0000644000004100000410000011617713252673044026303 0ustar www-datawww-data# 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 StorageV1beta2 # A bucket. class Bucket include Google::Apis::Core::Hashable # Access controls on the bucket. # Corresponds to the JSON property `acl` # @return [Array] attr_accessor :acl # The bucket's Cross-Origin Resource Sharing (CORS) configuration. # Corresponds to the JSON property `cors` # @return [Array] attr_accessor :cors # Default access controls to apply to new objects when no ACL is provided. # Corresponds to the JSON property `defaultObjectAcl` # @return [Array] attr_accessor :default_object_acl # HTTP 1.1 Entity tag for the bucket. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of the bucket. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of item this is. For buckets, this is always storage#bucket. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The bucket's lifecycle configuration. See object lifecycle management for more # information. # Corresponds to the JSON property `lifecycle` # @return [Google::Apis::StorageV1beta2::Bucket::Lifecycle] attr_accessor :lifecycle # The location of the bucket. Object data for objects in the bucket resides in # physical storage within this region. Typical values are US and EU. Defaults to # US. See the developer's guide for the authoritative list. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The bucket's logging configuration, which defines the destination bucket and # optional name prefix for the current bucket's logs. # Corresponds to the JSON property `logging` # @return [Google::Apis::StorageV1beta2::Bucket::Logging] attr_accessor :logging # The metadata generation of this bucket. # Corresponds to the JSON property `metageneration` # @return [Fixnum] attr_accessor :metageneration # The name of the bucket. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The owner of the bucket. This is always the project team's owner group. # Corresponds to the JSON property `owner` # @return [Google::Apis::StorageV1beta2::Bucket::Owner] attr_accessor :owner # The URI of this bucket. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The bucket's storage class. This defines how objects in the bucket are stored # and determines the SLA and the cost of storage. Typical values are STANDARD # and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's # guide for the authoritative list. # Corresponds to the JSON property `storageClass` # @return [String] attr_accessor :storage_class # Creation time of the bucket in RFC 3339 format. # Corresponds to the JSON property `timeCreated` # @return [DateTime] attr_accessor :time_created # The bucket's versioning configuration. # Corresponds to the JSON property `versioning` # @return [Google::Apis::StorageV1beta2::Bucket::Versioning] attr_accessor :versioning # The bucket's website configuration. # Corresponds to the JSON property `website` # @return [Google::Apis::StorageV1beta2::Bucket::Website] attr_accessor :website def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @acl = args[:acl] if args.key?(:acl) @cors = args[:cors] if args.key?(:cors) @default_object_acl = args[:default_object_acl] if args.key?(:default_object_acl) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @lifecycle = args[:lifecycle] if args.key?(:lifecycle) @location = args[:location] if args.key?(:location) @logging = args[:logging] if args.key?(:logging) @metageneration = args[:metageneration] if args.key?(:metageneration) @name = args[:name] if args.key?(:name) @owner = args[:owner] if args.key?(:owner) @self_link = args[:self_link] if args.key?(:self_link) @storage_class = args[:storage_class] if args.key?(:storage_class) @time_created = args[:time_created] if args.key?(:time_created) @versioning = args[:versioning] if args.key?(:versioning) @website = args[:website] if args.key?(:website) end # class Cor include Google::Apis::Core::Hashable # The value, in seconds, to return in the Access-Control-Max-Age header used in # preflight responses. # Corresponds to the JSON property `maxAgeSeconds` # @return [Fixnum] attr_accessor :max_age_seconds # The list of HTTP methods on which to include CORS response headers: GET, # OPTIONS, POST, etc. Note, "*" is permitted in the list of methods, and means " # any method". # Corresponds to the JSON property `method` # @return [Array] attr_accessor :method_prop # The list of Origins eligible to receive CORS response headers. Note: "*" is # permitted in the list of origins, and means "any Origin". # Corresponds to the JSON property `origin` # @return [Array] attr_accessor :origin # The list of HTTP headers other than the simple response headers to give # permission for the user-agent to share across domains. # Corresponds to the JSON property `responseHeader` # @return [Array] attr_accessor :response_header def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_age_seconds = args[:max_age_seconds] if args.key?(:max_age_seconds) @method_prop = args[:method_prop] if args.key?(:method_prop) @origin = args[:origin] if args.key?(:origin) @response_header = args[:response_header] if args.key?(:response_header) end end # The bucket's lifecycle configuration. See object lifecycle management for more # information. class Lifecycle include Google::Apis::Core::Hashable # A lifecycle management rule, which is made of an action to take and the # condition(s) under which the action will be taken. # Corresponds to the JSON property `rule` # @return [Array] attr_accessor :rule def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @rule = args[:rule] if args.key?(:rule) end # class Rule include Google::Apis::Core::Hashable # The action to take. # Corresponds to the JSON property `action` # @return [Google::Apis::StorageV1beta2::Bucket::Lifecycle::Rule::Action] attr_accessor :action # The condition(s) under which the action will be taken. # Corresponds to the JSON property `condition` # @return [Google::Apis::StorageV1beta2::Bucket::Lifecycle::Rule::Condition] attr_accessor :condition def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) @condition = args[:condition] if args.key?(:condition) end # The action to take. class Action include Google::Apis::Core::Hashable # Type of the action. Currently only Delete is supported. # 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) @type = args[:type] if args.key?(:type) end end # The condition(s) under which the action will be taken. class Condition include Google::Apis::Core::Hashable # Age of an object (in days). This condition is satisfied when an object reaches # the specified age. # Corresponds to the JSON property `age` # @return [Fixnum] attr_accessor :age # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This # condition is satisfied when an object is created before midnight of the # specified date in UTC. # Corresponds to the JSON property `createdBefore` # @return [Date] attr_accessor :created_before # 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` # @return [Boolean] attr_accessor :is_live alias_method :is_live?, :is_live # Relevant only for versioned objects. If the value is N, this condition is # satisfied when there are at least N versions (including the live version) # newer than this version of the object. # Corresponds to the JSON property `numNewerVersions` # @return [Fixnum] attr_accessor :num_newer_versions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @age = args[:age] if args.key?(:age) @created_before = args[:created_before] if args.key?(:created_before) @is_live = args[:is_live] if args.key?(:is_live) @num_newer_versions = args[:num_newer_versions] if args.key?(:num_newer_versions) end end end end # The bucket's logging configuration, which defines the destination bucket and # optional name prefix for the current bucket's logs. class Logging include Google::Apis::Core::Hashable # The destination bucket where the current bucket's logs should be placed. # Corresponds to the JSON property `logBucket` # @return [String] attr_accessor :log_bucket # A prefix for log object names. # Corresponds to the JSON property `logObjectPrefix` # @return [String] attr_accessor :log_object_prefix def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @log_bucket = args[:log_bucket] if args.key?(:log_bucket) @log_object_prefix = args[:log_object_prefix] if args.key?(:log_object_prefix) end end # The owner of the bucket. This is always the project team's owner group. class Owner include Google::Apis::Core::Hashable # The entity, in the form group-groupId. # Corresponds to the JSON property `entity` # @return [String] attr_accessor :entity # The ID for the entity. # Corresponds to the JSON property `entityId` # @return [String] attr_accessor :entity_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity = args[:entity] if args.key?(:entity) @entity_id = args[:entity_id] if args.key?(:entity_id) end end # The bucket's versioning configuration. class Versioning include Google::Apis::Core::Hashable # While set to true, versioning is fully enabled for this bucket. # 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 # The bucket's website configuration. class Website include Google::Apis::Core::Hashable # Behaves as the bucket's directory index where missing objects are treated as # potential directories. # Corresponds to the JSON property `mainPageSuffix` # @return [String] attr_accessor :main_page_suffix # The custom object to return when a requested resource is not found. # Corresponds to the JSON property `notFoundPage` # @return [String] attr_accessor :not_found_page def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @main_page_suffix = args[:main_page_suffix] if args.key?(:main_page_suffix) @not_found_page = args[:not_found_page] if args.key?(:not_found_page) end end end # An access-control entry. class BucketAccessControl include Google::Apis::Core::Hashable # The name of the bucket. # Corresponds to the JSON property `bucket` # @return [String] attr_accessor :bucket # The domain associated with the entity, if any. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # The email address associated with the entity, if any. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The entity holding the permission, in one of the following forms: # - user-userId # - user-email # - group-groupId # - group-email # - domain-domain # - allUsers # - allAuthenticatedUsers Examples: # - The user liz@example.com would be user-liz@example.com. # - The group example@googlegroups.com would be group-example@googlegroups.com. # - To refer to all members of the Google Apps for Business domain example.com, # the entity would be domain-example.com. # Corresponds to the JSON property `entity` # @return [String] attr_accessor :entity # The ID for the entity, if any. # Corresponds to the JSON property `entityId` # @return [String] attr_accessor :entity_id # HTTP 1.1 Entity tag for the access-control entry. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of the access-control entry. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of item this is. For bucket access control entries, this is always # storage#bucketAccessControl. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The access permission for the entity. Can be READER, WRITER, or OWNER. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role # The link to this access-control entry. # 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) @bucket = args[:bucket] if args.key?(:bucket) @domain = args[:domain] if args.key?(:domain) @email = args[:email] if args.key?(:email) @entity = args[:entity] if args.key?(:entity) @entity_id = args[:entity_id] if args.key?(:entity_id) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @role = args[:role] if args.key?(:role) @self_link = args[:self_link] if args.key?(:self_link) end end # An access-control list. class BucketAccessControls include Google::Apis::Core::Hashable # The list of items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of item this is. For lists of bucket access control entries, this is # always storage#bucketAccessControls. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # A list of buckets. class Buckets include Google::Apis::Core::Hashable # The list of items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of item this is. For lists of buckets, this is always storage#buckets. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, used to page through large result sets. Provide this # value in a subsequent request to return 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) @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) end end # An notification channel used to watch for resource changes. class Channel include Google::Apis::Core::Hashable # The address where notifications are delivered for this channel. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Date and time of notification channel expiration, expressed as a Unix # timestamp, in milliseconds. Optional. # Corresponds to the JSON property `expiration` # @return [Fixnum] attr_accessor :expiration # A UUID or similar unique string that identifies this channel. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies this as a notification channel used to watch for changes to a # resource. Value: the fixed string "api#channel". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Additional parameters controlling delivery channel behavior. Optional. # Corresponds to the JSON property `params` # @return [Hash] attr_accessor :params # A Boolean value to indicate whether payload is wanted. Optional. # Corresponds to the JSON property `payload` # @return [Boolean] attr_accessor :payload alias_method :payload?, :payload # An opaque ID that identifies the resource being watched on this channel. # Stable across different API versions. # Corresponds to the JSON property `resourceId` # @return [String] attr_accessor :resource_id # A version-specific identifier for the watched resource. # Corresponds to the JSON property `resourceUri` # @return [String] attr_accessor :resource_uri # An arbitrary string delivered to the target address with each notification # delivered over this channel. Optional. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token # The type of delivery mechanism used for this channel. # 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) @address = args[:address] if args.key?(:address) @expiration = args[:expiration] if args.key?(:expiration) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @params = args[:params] if args.key?(:params) @payload = args[:payload] if args.key?(:payload) @resource_id = args[:resource_id] if args.key?(:resource_id) @resource_uri = args[:resource_uri] if args.key?(:resource_uri) @token = args[:token] if args.key?(:token) @type = args[:type] if args.key?(:type) end end # A Compose request. class ComposeRequest include Google::Apis::Core::Hashable # An object. # Corresponds to the JSON property `destination` # @return [Google::Apis::StorageV1beta2::Object] attr_accessor :destination # The kind of item this is. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The list of source objects that will be concatenated into a single object. # Corresponds to the JSON property `sourceObjects` # @return [Array] attr_accessor :source_objects def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @destination = args[:destination] if args.key?(:destination) @kind = args[:kind] if args.key?(:kind) @source_objects = args[:source_objects] if args.key?(:source_objects) end # class SourceObject include Google::Apis::Core::Hashable # The generation of this object to use as the source. # Corresponds to the JSON property `generation` # @return [Fixnum] attr_accessor :generation # The source object's name. The source object's bucket is implicitly the # destination bucket. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Conditions that must be met for this operation to execute. # Corresponds to the JSON property `objectPreconditions` # @return [Google::Apis::StorageV1beta2::ComposeRequest::SourceObject::ObjectPreconditions] attr_accessor :object_preconditions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @generation = args[:generation] if args.key?(:generation) @name = args[:name] if args.key?(:name) @object_preconditions = args[:object_preconditions] if args.key?(:object_preconditions) end # Conditions that must be met for this operation to execute. class ObjectPreconditions include Google::Apis::Core::Hashable # Only perform the composition if the generation of the source object that would # be used matches this value. If this value and a generation are both specified, # they must be the same value or the call will fail. # Corresponds to the JSON property `ifGenerationMatch` # @return [Fixnum] attr_accessor :if_generation_match def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @if_generation_match = args[:if_generation_match] if args.key?(:if_generation_match) end end end end # An object. class Object include Google::Apis::Core::Hashable # Access controls on the object. # Corresponds to the JSON property `acl` # @return [Array] attr_accessor :acl # The bucket containing this object. # Corresponds to the JSON property `bucket` # @return [String] attr_accessor :bucket # Cache-Control directive for the object data. # Corresponds to the JSON property `cacheControl` # @return [String] attr_accessor :cache_control # Number of underlying components that make up this object. Components are # accumulated by compose operations and are limited to a count of 32. # Corresponds to the JSON property `componentCount` # @return [Fixnum] attr_accessor :component_count # Content-Disposition of the object data. # Corresponds to the JSON property `contentDisposition` # @return [String] attr_accessor :content_disposition # Content-Encoding of the object data. # Corresponds to the JSON property `contentEncoding` # @return [String] attr_accessor :content_encoding # Content-Language of the object data. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language # Content-Type of the object data. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. # Corresponds to the JSON property `crc32c` # @return [String] attr_accessor :crc32c # HTTP 1.1 Entity tag for the object. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The content generation of this object. Used for object versioning. # Corresponds to the JSON property `generation` # @return [Fixnum] attr_accessor :generation # The ID of the object. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of item this is. For objects, this is always storage#object. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # MD5 hash of the data; encoded using base64. # Corresponds to the JSON property `md5Hash` # @return [String] attr_accessor :md5_hash # Media download link. # Corresponds to the JSON property `mediaLink` # @return [String] attr_accessor :media_link # User-provided metadata, in key/value pairs. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The generation of the metadata for this object at this generation. Used for # metadata versioning. Has no meaning outside of the context of this generation. # Corresponds to the JSON property `metageneration` # @return [Fixnum] attr_accessor :metageneration # The name of this object. Required if not specified by URL parameter. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The owner of the object. This will always be the uploader of the object. # Corresponds to the JSON property `owner` # @return [Google::Apis::StorageV1beta2::Object::Owner] attr_accessor :owner # The link to this object. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Content-Length of the data in bytes. # Corresponds to the JSON property `size` # @return [Fixnum] attr_accessor :size # Storage class of the object. # Corresponds to the JSON property `storageClass` # @return [String] attr_accessor :storage_class # Deletion time of the object in RFC 3339 format. Will be returned if and only # if this version of the object has been deleted. # Corresponds to the JSON property `timeDeleted` # @return [DateTime] attr_accessor :time_deleted # Modification time of the object metadata in RFC 3339 format. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @acl = args[:acl] if args.key?(:acl) @bucket = args[:bucket] if args.key?(:bucket) @cache_control = args[:cache_control] if args.key?(:cache_control) @component_count = args[:component_count] if args.key?(:component_count) @content_disposition = args[:content_disposition] if args.key?(:content_disposition) @content_encoding = args[:content_encoding] if args.key?(:content_encoding) @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) @etag = args[:etag] if args.key?(:etag) @generation = args[:generation] if args.key?(:generation) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @md5_hash = args[:md5_hash] if args.key?(:md5_hash) @media_link = args[:media_link] if args.key?(:media_link) @metadata = args[:metadata] if args.key?(:metadata) @metageneration = args[:metageneration] if args.key?(:metageneration) @name = args[:name] if args.key?(:name) @owner = args[:owner] if args.key?(:owner) @self_link = args[:self_link] if args.key?(:self_link) @size = args[:size] if args.key?(:size) @storage_class = args[:storage_class] if args.key?(:storage_class) @time_deleted = args[:time_deleted] if args.key?(:time_deleted) @updated = args[:updated] if args.key?(:updated) end # The owner of the object. This will always be the uploader of the object. class Owner include Google::Apis::Core::Hashable # The entity, in the form user-userId. # Corresponds to the JSON property `entity` # @return [String] attr_accessor :entity # The ID for the entity. # Corresponds to the JSON property `entityId` # @return [String] attr_accessor :entity_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity = args[:entity] if args.key?(:entity) @entity_id = args[:entity_id] if args.key?(:entity_id) end end end # An access-control entry. class ObjectAccessControl include Google::Apis::Core::Hashable # The name of the bucket. # Corresponds to the JSON property `bucket` # @return [String] attr_accessor :bucket # The domain associated with the entity, if any. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # The email address associated with the entity, if any. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The entity holding the permission, in one of the following forms: # - user-userId # - user-email # - group-groupId # - group-email # - domain-domain # - allUsers # - allAuthenticatedUsers Examples: # - The user liz@example.com would be user-liz@example.com. # - The group example@googlegroups.com would be group-example@googlegroups.com. # - To refer to all members of the Google Apps for Business domain example.com, # the entity would be domain-example.com. # Corresponds to the JSON property `entity` # @return [String] attr_accessor :entity # The ID for the entity, if any. # Corresponds to the JSON property `entityId` # @return [String] attr_accessor :entity_id # HTTP 1.1 Entity tag for the access-control entry. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The content generation of the object. # Corresponds to the JSON property `generation` # @return [Fixnum] attr_accessor :generation # The ID of the access-control entry. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of item this is. For object access control entries, this is always # storage#objectAccessControl. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the object. # Corresponds to the JSON property `object` # @return [String] attr_accessor :object # The access permission for the entity. Can be READER or OWNER. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role # The link to this access-control entry. # 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) @bucket = args[:bucket] if args.key?(:bucket) @domain = args[:domain] if args.key?(:domain) @email = args[:email] if args.key?(:email) @entity = args[:entity] if args.key?(:entity) @entity_id = args[:entity_id] if args.key?(:entity_id) @etag = args[:etag] if args.key?(:etag) @generation = args[:generation] if args.key?(:generation) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @object = args[:object] if args.key?(:object) @role = args[:role] if args.key?(:role) @self_link = args[:self_link] if args.key?(:self_link) end end # An access-control list. class ObjectAccessControls include Google::Apis::Core::Hashable # The list of items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of item this is. For lists of object access control entries, this is # always storage#objectAccessControls. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # A list of objects. class Objects include Google::Apis::Core::Hashable # The list of items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of item this is. For lists of objects, this is always storage#objects. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, used to page through large result sets. Provide this # value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of prefixes of objects matching-but-not-listed up to and including # the requested delimiter. # Corresponds to the JSON property `prefixes` # @return [Array] attr_accessor :prefixes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @prefixes = args[:prefixes] if args.key?(:prefixes) end end end end end google-api-client-0.19.8/generated/google/apis/storage_v1beta2/service.rb0000644000004100000410000032231213252673044026274 0ustar www-datawww-data# 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 StorageV1beta2 # Cloud Storage JSON API # # Lets you store and retrieve potentially-large, immutable data objects. # # @example # require 'google/apis/storage_v1beta2' # # Storage = Google::Apis::StorageV1beta2 # Alias the module # service = Storage::StorageService.new # # @see https://developers.google.com/storage/docs/json_api/ class StorageService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'storage/v1beta2/') @batch_path = 'batch/storage/v1beta2' end # Permanently deletes the ACL entry for the specified entity on the specified # bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_bucket_access_control(bucket, entity, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}/acl/{entity}', options) command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.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 ACL entry for the specified entity on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::BucketAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::BucketAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_access_control(bucket, entity, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/acl/{entity}', options) command.response_representation = Google::Apis::StorageV1beta2::BucketAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::BucketAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.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 ACL entry on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [Google::Apis::StorageV1beta2::BucketAccessControl] bucket_access_control_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::BucketAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::BucketAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_access_control(bucket, bucket_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{bucket}/acl', options) command.request_representation = Google::Apis::StorageV1beta2::BucketAccessControl::Representation command.request_object = bucket_access_control_object command.response_representation = Google::Apis::StorageV1beta2::BucketAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::BucketAccessControl command.params['bucket'] = bucket unless bucket.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 ACL entries on the specified bucket. # @param [String] bucket # Name of a bucket. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::BucketAccessControls] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::BucketAccessControls] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_access_controls(bucket, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/acl', options) command.response_representation = Google::Apis::StorageV1beta2::BucketAccessControls::Representation command.response_class = Google::Apis::StorageV1beta2::BucketAccessControls command.params['bucket'] = bucket unless bucket.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 ACL entry on the specified bucket. This method supports patch # semantics. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1beta2::BucketAccessControl] bucket_access_control_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::BucketAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::BucketAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_access_control(bucket, entity, bucket_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'b/{bucket}/acl/{entity}', options) command.request_representation = Google::Apis::StorageV1beta2::BucketAccessControl::Representation command.request_object = bucket_access_control_object command.response_representation = Google::Apis::StorageV1beta2::BucketAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::BucketAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.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 ACL entry on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1beta2::BucketAccessControl] bucket_access_control_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::BucketAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::BucketAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket_access_control(bucket, entity, bucket_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}/acl/{entity}', options) command.request_representation = Google::Apis::StorageV1beta2::BucketAccessControl::Representation command.request_object = bucket_access_control_object command.response_representation = Google::Apis::StorageV1beta2::BucketAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::BucketAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.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 # Permanently deletes an empty bucket. # @param [String] bucket # Name of a bucket. # @param [Fixnum] if_metageneration_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration does not match the given 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_bucket(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}', options) command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.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 metadata for the specified bucket. # @param [String] bucket # Name of a bucket. # @param [Fixnum] if_metageneration_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration does not match the given value. # @param [String] projection # Set of properties to return. Defaults to noAcl. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Bucket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Bucket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}', options) command.response_representation = Google::Apis::StorageV1beta2::Bucket::Representation command.response_class = Google::Apis::StorageV1beta2::Bucket command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['projection'] = projection unless projection.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 bucket. # @param [String] project # A valid API project identifier. # @param [Google::Apis::StorageV1beta2::Bucket] bucket_object # @param [String] projection # Set of properties to return. Defaults to noAcl, unless the bucket resource # specifies acl or defaultObjectAcl properties, when it defaults to full. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Bucket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Bucket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket(project, bucket_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b', options) command.request_representation = Google::Apis::StorageV1beta2::Bucket::Representation command.request_object = bucket_object command.response_representation = Google::Apis::StorageV1beta2::Bucket::Representation command.response_class = Google::Apis::StorageV1beta2::Bucket command.query['project'] = project unless project.nil? command.query['projection'] = projection unless projection.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 buckets for a given project. # @param [String] project # A valid API project identifier. # @param [Fixnum] max_results # Maximum number of buckets to return. # @param [String] page_token # A previously-returned page token representing part of the larger set of # results to view. # @param [String] projection # Set of properties to return. Defaults to noAcl. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Buckets] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Buckets] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_buckets(project, max_results: nil, page_token: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b', options) command.response_representation = Google::Apis::StorageV1beta2::Buckets::Representation command.response_class = Google::Apis::StorageV1beta2::Buckets command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['project'] = project unless project.nil? command.query['projection'] = projection unless projection.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 a bucket. This method supports patch semantics. # @param [String] bucket # Name of a bucket. # @param [Google::Apis::StorageV1beta2::Bucket] bucket_object # @param [Fixnum] if_metageneration_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration does not match the given value. # @param [String] projection # Set of properties to return. Defaults to full. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Bucket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Bucket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket(bucket, bucket_object = nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'b/{bucket}', options) command.request_representation = Google::Apis::StorageV1beta2::Bucket::Representation command.request_object = bucket_object command.response_representation = Google::Apis::StorageV1beta2::Bucket::Representation command.response_class = Google::Apis::StorageV1beta2::Bucket command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['projection'] = projection unless projection.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 a bucket. # @param [String] bucket # Name of a bucket. # @param [Google::Apis::StorageV1beta2::Bucket] bucket_object # @param [Fixnum] if_metageneration_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the return of the bucket metadata conditional on whether the bucket's # current metageneration does not match the given value. # @param [String] projection # Set of properties to return. Defaults to full. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Bucket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Bucket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bucket(bucket, bucket_object = nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}', options) command.request_representation = Google::Apis::StorageV1beta2::Bucket::Representation command.request_object = bucket_object command.response_representation = Google::Apis::StorageV1beta2::Bucket::Representation command.response_class = Google::Apis::StorageV1beta2::Bucket command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['projection'] = projection unless projection.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 # Stop watching resources through this channel # @param [Google::Apis::StorageV1beta2::Channel] channel_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'channels/stop', options) command.request_representation = Google::Apis::StorageV1beta2::Channel::Representation command.request_object = channel_object 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 # Permanently deletes the default object ACL entry for the specified entity on # the specified bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_default_object_access_control(bucket, entity, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}/defaultObjectAcl/{entity}', options) command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.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 default object ACL entry for the specified entity on the specified # bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_default_object_access_control(bucket, entity, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/defaultObjectAcl/{entity}', options) command.response_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.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 default object ACL entry on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [Google::Apis::StorageV1beta2::ObjectAccessControl] object_access_control_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_default_object_access_control(bucket, object_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{bucket}/defaultObjectAcl', options) command.request_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::ObjectAccessControl command.params['bucket'] = bucket unless bucket.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 default object ACL entries on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [Fixnum] if_metageneration_match # If present, only return default ACL listing if the bucket's current # metageneration matches this value. # @param [Fixnum] if_metageneration_not_match # If present, only return default ACL listing if the bucket's current # metageneration does not match the given 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::ObjectAccessControls] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::ObjectAccessControls] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_default_object_access_controls(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/defaultObjectAcl', options) command.response_representation = Google::Apis::StorageV1beta2::ObjectAccessControls::Representation command.response_class = Google::Apis::StorageV1beta2::ObjectAccessControls command.params['bucket'] = bucket unless bucket.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.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 a default object ACL entry on the specified bucket. This method # supports patch semantics. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1beta2::ObjectAccessControl] object_access_control_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_default_object_access_control(bucket, entity, object_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'b/{bucket}/defaultObjectAcl/{entity}', options) command.request_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.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 a default object ACL entry on the specified bucket. # @param [String] bucket # Name of a bucket. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1beta2::ObjectAccessControl] object_access_control_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_default_object_access_control(bucket, entity, object_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}/defaultObjectAcl/{entity}', options) command.request_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['entity'] = entity unless entity.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 # Permanently deletes the ACL entry for the specified entity on the specified # object. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_object_access_control(bucket, object, entity, generation: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}/o/{object}/acl/{entity}', options) command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.params['entity'] = entity unless entity.nil? command.query['generation'] = generation unless generation.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 ACL entry for the specified entity on the specified object. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_access_control(bucket, object, entity, generation: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/o/{object}/acl/{entity}', options) command.response_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.params['entity'] = entity unless entity.nil? command.query['generation'] = generation unless generation.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 ACL entry on the specified object. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. # @param [Google::Apis::StorageV1beta2::ObjectAccessControl] object_access_control_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_access_control(bucket, object, object_access_control_object = nil, generation: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{bucket}/o/{object}/acl', options) command.request_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.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 ACL entries on the specified object. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::ObjectAccessControls] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::ObjectAccessControls] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_access_controls(bucket, object, generation: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/o/{object}/acl', options) command.response_representation = Google::Apis::StorageV1beta2::ObjectAccessControls::Representation command.response_class = Google::Apis::StorageV1beta2::ObjectAccessControls command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.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 ACL entry on the specified object. This method supports patch # semantics. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1beta2::ObjectAccessControl] object_access_control_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'b/{bucket}/o/{object}/acl/{entity}', options) command.request_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.params['entity'] = entity unless entity.nil? command.query['generation'] = generation unless generation.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 ACL entry on the specified object. # @param [String] bucket # Name of a bucket. # @param [String] object # Name of the object. # @param [String] entity # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1beta2::ObjectAccessControl] object_access_control_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::ObjectAccessControl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::ObjectAccessControl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'b/{bucket}/o/{object}/acl/{entity}', options) command.request_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.request_object = object_access_control_object command.response_representation = Google::Apis::StorageV1beta2::ObjectAccessControl::Representation command.response_class = Google::Apis::StorageV1beta2::ObjectAccessControl command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.params['entity'] = entity unless entity.nil? command.query['generation'] = generation unless generation.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 # Concatenates a list of existing objects into a new object in the same bucket. # @param [String] destination_bucket # Name of the bucket in which to store the new object. # @param [String] destination_object # Name of the new object. # @param [Google::Apis::StorageV1beta2::ComposeRequest] compose_request_object # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def compose_object(destination_bucket, destination_object, compose_request_object = nil, if_generation_match: nil, if_metageneration_match: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:post, 'b/{destinationBucket}/o/{destinationObject}/compose', options) else command = make_download_command(:post, 'b/{destinationBucket}/o/{destinationObject}/compose', options) command.download_dest = download_dest end command.request_representation = Google::Apis::StorageV1beta2::ComposeRequest::Representation command.request_object = compose_request_object command.response_representation = Google::Apis::StorageV1beta2::Object::Representation command.response_class = Google::Apis::StorageV1beta2::Object command.params['destinationBucket'] = destination_bucket unless destination_bucket.nil? command.params['destinationObject'] = destination_object unless destination_object.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.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 # Copies an object to a destination in the same location. Optionally overrides # metadata. # @param [String] source_bucket # Name of the bucket in which to find the source object. # @param [String] source_object # Name of the source object. # @param [String] destination_bucket # Name of the bucket in which to store the new object. Overrides the provided # object metadata's bucket value, if any. # @param [String] destination_object # Name of the new object. Required when the object metadata is not otherwise # provided. Overrides the object metadata's name value, if any. # @param [Google::Apis::StorageV1beta2::Object] object_object # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the destination object's current # generation matches the given value. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the destination object's current # generation does not match the given value. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the destination object's current # metageneration matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the destination object's current # metageneration does not match the given value. # @param [Fixnum] if_source_generation_match # Makes the operation conditional on whether the source object's generation # matches the given value. # @param [Fixnum] if_source_generation_not_match # Makes the operation conditional on whether the source object's generation does # not match the given value. # @param [Fixnum] if_source_metageneration_match # Makes the operation conditional on whether the source object's current # metageneration matches the given value. # @param [Fixnum] if_source_metageneration_not_match # Makes the operation conditional on whether the source object's current # metageneration does not match the given value. # @param [String] projection # Set of properties to return. Defaults to noAcl, unless the object resource # specifies the acl property, when it defaults to full. # @param [Fixnum] source_generation # If present, selects a specific revision of the source object (as opposed to # the latest version, the default). # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def copy_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, projection: nil, source_generation: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:post, 'b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}', options) else command = make_download_command(:post, 'b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}', options) command.download_dest = download_dest end command.request_representation = Google::Apis::StorageV1beta2::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1beta2::Object::Representation command.response_class = Google::Apis::StorageV1beta2::Object command.params['sourceBucket'] = source_bucket unless source_bucket.nil? command.params['sourceObject'] = source_object unless source_object.nil? command.params['destinationBucket'] = destination_bucket unless destination_bucket.nil? command.params['destinationObject'] = destination_object unless destination_object.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['ifSourceGenerationMatch'] = if_source_generation_match unless if_source_generation_match.nil? command.query['ifSourceGenerationNotMatch'] = if_source_generation_not_match unless if_source_generation_not_match.nil? command.query['ifSourceMetagenerationMatch'] = if_source_metageneration_match unless if_source_metageneration_match.nil? command.query['ifSourceMetagenerationNotMatch'] = if_source_metageneration_not_match unless if_source_metageneration_not_match.nil? command.query['projection'] = projection unless projection.nil? command.query['sourceGeneration'] = source_generation unless source_generation.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 data blobs and associated metadata. Deletions are permanent if # versioning is not enabled for the bucket, or if the generation parameter is # used. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. # @param [Fixnum] generation # If present, permanently deletes a specific revision of this object (as opposed # to the latest version, the default). # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's current generation # does not match the given value. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the object's current metageneration # does not match the given 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'b/{bucket}/o/{object}', options) command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.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 objects or their associated metadata. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's generation matches the # given value. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's generation does not # match the given value. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the object's current metageneration # does not match the given value. # @param [String] projection # Set of properties to return. Defaults to noAcl. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'b/{bucket}/o/{object}', options) else command = make_download_command(:get, 'b/{bucket}/o/{object}', options) command.download_dest = download_dest end command.response_representation = Google::Apis::StorageV1beta2::Object::Representation command.response_class = Google::Apis::StorageV1beta2::Object command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['projection'] = projection unless projection.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 # Stores new data blobs and associated metadata. # @param [String] bucket # Name of the bucket in which to store the new object. Overrides the provided # object metadata's bucket value, if any. # @param [Google::Apis::StorageV1beta2::Object] object_object # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's current generation # does not match the given value. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the object's current metageneration # does not match the given value. # @param [String] name # Name of the object. Required when the object metadata is not otherwise # provided. Overrides the object metadata's name value, if any. # @param [String] projection # Set of properties to return. Defaults to noAcl, unless the object resource # specifies the acl property, when it defaults to full. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::StorageV1beta2::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object(bucket, object_object = nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, name: nil, projection: 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, 'b/{bucket}/o', options) else command = make_upload_command(:post, 'b/{bucket}/o', options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::StorageV1beta2::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1beta2::Object::Representation command.response_class = Google::Apis::StorageV1beta2::Object command.params['bucket'] = bucket unless bucket.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['name'] = name unless name.nil? command.query['projection'] = projection unless projection.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 objects matching the criteria. # @param [String] bucket # Name of the bucket in which to look for objects. # @param [String] delimiter # Returns results in a directory-like mode. items will contain only objects # whose names, aside from the prefix, do not contain delimiter. Objects whose # names, aside from the prefix, contain delimiter will have their name, # truncated after the delimiter, returned in prefixes. Duplicate prefixes are # omitted. # @param [Fixnum] max_results # Maximum number of items plus prefixes to return. As duplicate prefixes are # omitted, fewer total results may be returned than requested. # @param [String] page_token # A previously-returned page token representing part of the larger set of # results to view. # @param [String] prefix # Filter results to objects whose names begin with this prefix. # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [Boolean] versions # If true, lists all versions of a file as distinct results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Objects] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Objects] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_objects(bucket, delimiter: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, versions: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'b/{bucket}/o', options) command.response_representation = Google::Apis::StorageV1beta2::Objects::Representation command.response_class = Google::Apis::StorageV1beta2::Objects command.params['bucket'] = bucket unless bucket.nil? command.query['delimiter'] = delimiter unless delimiter.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['prefix'] = prefix unless prefix.nil? command.query['projection'] = projection unless projection.nil? command.query['versions'] = versions unless versions.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 a data blob's associated metadata. This method supports patch # semantics. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. # @param [Google::Apis::StorageV1beta2::Object] object_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's current generation # does not match the given value. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the object's current metageneration # does not match the given value. # @param [String] projection # Set of properties to return. Defaults to full. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'b/{bucket}/o/{object}', options) command.request_representation = Google::Apis::StorageV1beta2::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1beta2::Object::Representation command.response_class = Google::Apis::StorageV1beta2::Object command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['projection'] = projection unless projection.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 a data blob's associated metadata. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object # Name of the object. # @param [Google::Apis::StorageV1beta2::Object] object_object # @param [Fixnum] generation # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [Fixnum] if_generation_match # Makes the operation conditional on whether the object's current generation # matches the given value. # @param [Fixnum] if_generation_not_match # Makes the operation conditional on whether the object's current generation # does not match the given value. # @param [Fixnum] if_metageneration_match # Makes the operation conditional on whether the object's current metageneration # matches the given value. # @param [Fixnum] if_metageneration_not_match # Makes the operation conditional on whether the object's current metageneration # does not match the given value. # @param [String] projection # Set of properties to return. Defaults to full. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Object] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::Object] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:put, 'b/{bucket}/o/{object}', options) else command = make_download_command(:put, 'b/{bucket}/o/{object}', options) command.download_dest = download_dest end command.request_representation = Google::Apis::StorageV1beta2::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1beta2::Object::Representation command.response_class = Google::Apis::StorageV1beta2::Object command.params['bucket'] = bucket unless bucket.nil? command.params['object'] = object unless object.nil? command.query['generation'] = generation unless generation.nil? command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil? command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil? command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil? command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil? command.query['projection'] = projection unless projection.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 # Watch for changes on all objects in a bucket. # @param [String] bucket # Name of the bucket in which to look for objects. # @param [Google::Apis::StorageV1beta2::Channel] channel_object # @param [String] delimiter # Returns results in a directory-like mode. items will contain only objects # whose names, aside from the prefix, do not contain delimiter. Objects whose # names, aside from the prefix, contain delimiter will have their name, # truncated after the delimiter, returned in prefixes. Duplicate prefixes are # omitted. # @param [Fixnum] max_results # Maximum number of items plus prefixes to return. As duplicate prefixes are # omitted, fewer total results may be returned than requested. # @param [String] page_token # A previously-returned page token representing part of the larger set of # results to view. # @param [String] prefix # Filter results to objects whose names begin with this prefix. # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [Boolean] versions # If true, lists all versions of a file as distinct results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::StorageV1beta2::Channel] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::StorageV1beta2::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 watch_object_all(bucket, channel_object = nil, delimiter: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, versions: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'b/{bucket}/o/watch', options) command.request_representation = Google::Apis::StorageV1beta2::Channel::Representation command.request_object = channel_object command.response_representation = Google::Apis::StorageV1beta2::Channel::Representation command.response_class = Google::Apis::StorageV1beta2::Channel command.params['bucket'] = bucket unless bucket.nil? command.query['delimiter'] = delimiter unless delimiter.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['prefix'] = prefix unless prefix.nil? command.query['projection'] = projection unless projection.nil? command.query['versions'] = versions unless versions.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 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 end end google-api-client-0.19.8/generated/google/apis/servicecontrol_v1.rb0000644000004100000410000000254113252673044025312 0ustar www-datawww-data# 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/servicecontrol_v1/service.rb' require 'google/apis/servicecontrol_v1/classes.rb' require 'google/apis/servicecontrol_v1/representations.rb' module Google module Apis # Google Service Control API # # Google Service Control provides control plane functionality to managed # services, such as logging, monitoring, and status checks. # # @see https://cloud.google.com/service-control/ module ServicecontrolV1 VERSION = 'V1' REVISION = '20171229' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # Manage your Google Service Control data AUTH_SERVICECONTROL = 'https://www.googleapis.com/auth/servicecontrol' end end end google-api-client-0.19.8/generated/google/apis/cloudiot_v1/0000755000004100000410000000000013252673043023543 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/cloudiot_v1/representations.rb0000644000004100000410000004004113252673043027314 0ustar www-datawww-data# 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 CloudiotV1 class AuditConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditLogConfig 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 Device class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeviceConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeviceCredential class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeviceRegistry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeviceState 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 EventNotificationConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDeviceConfigVersionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDeviceRegistriesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDeviceStatesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDevicesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ModifyCloudToDeviceConfigRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MqttConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PublicKeyCertificate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PublicKeyCredential class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegistryCredential class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StateNotificationConfig 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 TestIamPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class X509CertificateDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::CloudiotV1::AuditLogConfig, decorator: Google::Apis::CloudiotV1::AuditLogConfig::Representation property :service, as: 'service' end end class AuditLogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exempted_members, as: 'exemptedMembers' property :log_type, as: 'logType' end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation collection :members, as: 'members' property :role, as: 'role' end end class Device # @private class Representation < Google::Apis::Core::JsonRepresentation property :blocked, as: 'blocked' property :config, as: 'config', class: Google::Apis::CloudiotV1::DeviceConfig, decorator: Google::Apis::CloudiotV1::DeviceConfig::Representation collection :credentials, as: 'credentials', class: Google::Apis::CloudiotV1::DeviceCredential, decorator: Google::Apis::CloudiotV1::DeviceCredential::Representation property :id, as: 'id' property :last_config_ack_time, as: 'lastConfigAckTime' property :last_config_send_time, as: 'lastConfigSendTime' property :last_error_status, as: 'lastErrorStatus', class: Google::Apis::CloudiotV1::Status, decorator: Google::Apis::CloudiotV1::Status::Representation property :last_error_time, as: 'lastErrorTime' property :last_event_time, as: 'lastEventTime' property :last_heartbeat_time, as: 'lastHeartbeatTime' property :last_state_time, as: 'lastStateTime' hash :metadata, as: 'metadata' property :name, as: 'name' property :num_id, :numeric_string => true, as: 'numId' property :state, as: 'state', class: Google::Apis::CloudiotV1::DeviceState, decorator: Google::Apis::CloudiotV1::DeviceState::Representation end end class DeviceConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :binary_data, :base64 => true, as: 'binaryData' property :cloud_update_time, as: 'cloudUpdateTime' property :device_ack_time, as: 'deviceAckTime' property :version, :numeric_string => true, as: 'version' end end class DeviceCredential # @private class Representation < Google::Apis::Core::JsonRepresentation property :expiration_time, as: 'expirationTime' property :public_key, as: 'publicKey', class: Google::Apis::CloudiotV1::PublicKeyCredential, decorator: Google::Apis::CloudiotV1::PublicKeyCredential::Representation end end class DeviceRegistry # @private class Representation < Google::Apis::Core::JsonRepresentation collection :credentials, as: 'credentials', class: Google::Apis::CloudiotV1::RegistryCredential, decorator: Google::Apis::CloudiotV1::RegistryCredential::Representation collection :event_notification_configs, as: 'eventNotificationConfigs', class: Google::Apis::CloudiotV1::EventNotificationConfig, decorator: Google::Apis::CloudiotV1::EventNotificationConfig::Representation property :http_config, as: 'httpConfig', class: Google::Apis::CloudiotV1::HttpConfig, decorator: Google::Apis::CloudiotV1::HttpConfig::Representation property :id, as: 'id' property :mqtt_config, as: 'mqttConfig', class: Google::Apis::CloudiotV1::MqttConfig, decorator: Google::Apis::CloudiotV1::MqttConfig::Representation property :name, as: 'name' property :state_notification_config, as: 'stateNotificationConfig', class: Google::Apis::CloudiotV1::StateNotificationConfig, decorator: Google::Apis::CloudiotV1::StateNotificationConfig::Representation end end class DeviceState # @private class Representation < Google::Apis::Core::JsonRepresentation property :binary_data, :base64 => true, as: 'binaryData' property :update_time, as: 'updateTime' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class EventNotificationConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :pubsub_topic_name, as: 'pubsubTopicName' property :subfolder_matches, as: 'subfolderMatches' end end class GetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class HttpConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :http_enabled_state, as: 'httpEnabledState' end end class ListDeviceConfigVersionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :device_configs, as: 'deviceConfigs', class: Google::Apis::CloudiotV1::DeviceConfig, decorator: Google::Apis::CloudiotV1::DeviceConfig::Representation end end class ListDeviceRegistriesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :device_registries, as: 'deviceRegistries', class: Google::Apis::CloudiotV1::DeviceRegistry, decorator: Google::Apis::CloudiotV1::DeviceRegistry::Representation property :next_page_token, as: 'nextPageToken' end end class ListDeviceStatesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :device_states, as: 'deviceStates', class: Google::Apis::CloudiotV1::DeviceState, decorator: Google::Apis::CloudiotV1::DeviceState::Representation end end class ListDevicesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :devices, as: 'devices', class: Google::Apis::CloudiotV1::Device, decorator: Google::Apis::CloudiotV1::Device::Representation property :next_page_token, as: 'nextPageToken' end end class ModifyCloudToDeviceConfigRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :binary_data, :base64 => true, as: 'binaryData' property :version_to_update, :numeric_string => true, as: 'versionToUpdate' end end class MqttConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :mqtt_enabled_state, as: 'mqttEnabledState' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_configs, as: 'auditConfigs', class: Google::Apis::CloudiotV1::AuditConfig, decorator: Google::Apis::CloudiotV1::AuditConfig::Representation collection :bindings, as: 'bindings', class: Google::Apis::CloudiotV1::Binding, decorator: Google::Apis::CloudiotV1::Binding::Representation property :etag, :base64 => true, as: 'etag' property :version, as: 'version' end end class PublicKeyCertificate # @private class Representation < Google::Apis::Core::JsonRepresentation property :certificate, as: 'certificate' property :format, as: 'format' property :x509_details, as: 'x509Details', class: Google::Apis::CloudiotV1::X509CertificateDetails, decorator: Google::Apis::CloudiotV1::X509CertificateDetails::Representation end end class PublicKeyCredential # @private class Representation < Google::Apis::Core::JsonRepresentation property :format, as: 'format' property :key, as: 'key' end end class RegistryCredential # @private class Representation < Google::Apis::Core::JsonRepresentation property :public_key_certificate, as: 'publicKeyCertificate', class: Google::Apis::CloudiotV1::PublicKeyCertificate, decorator: Google::Apis::CloudiotV1::PublicKeyCertificate::Representation end end class SetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :policy, as: 'policy', class: Google::Apis::CloudiotV1::Policy, decorator: Google::Apis::CloudiotV1::Policy::Representation property :update_mask, as: 'updateMask' end end class StateNotificationConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :pubsub_topic_name, as: 'pubsubTopicName' 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 TestIamPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestIamPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class X509CertificateDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :expiry_time, as: 'expiryTime' property :issuer, as: 'issuer' property :public_key_type, as: 'publicKeyType' property :signature_algorithm, as: 'signatureAlgorithm' property :start_time, as: 'startTime' property :subject, as: 'subject' end end end end end google-api-client-0.19.8/generated/google/apis/cloudiot_v1/classes.rb0000644000004100000410000013376313252673043025542 0ustar www-datawww-data# 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 CloudiotV1 # 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:foo@gmail.com" # ] # `, # ` # "log_type": "DATA_WRITE", # `, # ` # "log_type": "ADMIN_READ", # ` # ] # `, # ` # "service": "fooservice.googleapis.com" # "audit_log_configs": [ # ` # "log_type": "DATA_READ", # `, # ` # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:bar@gmail.com" # ] # ` # ] # ` # ] # ` # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and # bar@gmail.com from DATA_WRITE logging. class AuditConfig include Google::Apis::Core::Hashable # The configuration for logging of each type of permission. # Next ID: 4 # 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:foo@gmail.com" # ] # `, # ` # "log_type": "DATA_WRITE", # ` # ] # ` # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # foo@gmail.com from DATA_READ logging. class AuditLogConfig include Google::Apis::Core::Hashable # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. # Corresponds to the JSON property `exemptedMembers` # @return [Array] 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 Binding include Google::Apis::Core::Hashable # 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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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`. # Required # 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) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end # The device resource. class Device include Google::Apis::Core::Hashable # If a device is blocked, connections or requests from this device will fail. # Can be used to temporarily prevent the device from connecting if, for # example, the sensor is generating bad data and needs maintenance. # Corresponds to the JSON property `blocked` # @return [Boolean] attr_accessor :blocked alias_method :blocked?, :blocked # The device configuration. Eventually delivered to devices. # Corresponds to the JSON property `config` # @return [Google::Apis::CloudiotV1::DeviceConfig] attr_accessor :config # The credentials used to authenticate this device. To allow credential # rotation without interruption, multiple device credentials can be bound to # this device. No more than 3 credentials can be bound to a single device at # a time. When new credentials are added to a device, they are verified # against the registry credentials. For details, see the description of the # `DeviceRegistry.credentials` field. # Corresponds to the JSON property `credentials` # @return [Array] attr_accessor :credentials # The user-defined device identifier. The device ID must be unique # within a device registry. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # [Output only] The last time a cloud-to-device config version acknowledgment # was received from the device. This field is only for configurations # sent through MQTT. # Corresponds to the JSON property `lastConfigAckTime` # @return [String] attr_accessor :last_config_ack_time # [Output only] The last time a cloud-to-device config version was sent to # the device. # Corresponds to the JSON property `lastConfigSendTime` # @return [String] attr_accessor :last_config_send_time # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `lastErrorStatus` # @return [Google::Apis::CloudiotV1::Status] attr_accessor :last_error_status # [Output only] The time the most recent error occurred, such as a failure to # publish to Cloud Pub/Sub. This field is the timestamp of # 'last_error_status'. # Corresponds to the JSON property `lastErrorTime` # @return [String] attr_accessor :last_error_time # [Output only] The last time a telemetry event was received. Timestamps are # periodically collected and written to storage; they may be stale by a few # minutes. # Corresponds to the JSON property `lastEventTime` # @return [String] attr_accessor :last_event_time # [Output only] The last time an MQTT `PINGREQ` was received. This field # applies only to devices connecting through MQTT. MQTT clients usually only # send `PINGREQ` messages if the connection is idle, and no other messages # have been sent. Timestamps are periodically collected and written to # storage; they may be stale by a few minutes. # Corresponds to the JSON property `lastHeartbeatTime` # @return [String] attr_accessor :last_heartbeat_time # [Output only] The last time a state event was received. Timestamps are # periodically collected and written to storage; they may be stale by a few # minutes. # Corresponds to the JSON property `lastStateTime` # @return [String] attr_accessor :last_state_time # The metadata key-value pairs assigned to the device. This metadata is not # interpreted or indexed by Cloud IoT Core. It can be used to add contextual # information for the device. # Keys must conform to the regular expression [a-zA-Z0-9-_]+ and be less than # 128 bytes in length. # Values are free-form strings. Each value must be less than or equal to 32 # KB in size. # The total size of all keys and values must be less than 256 KB, and the # maximum number of key-value pairs is 500. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The resource path name. For example, # `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or # `projects/p1/locations/us-central1/registries/registry0/devices/`num_id``. # When `name` is populated as a response from the service, it always ends # in the device numeric ID. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output only] A server-defined unique numeric ID for the device. This is a # more compact way to identify devices, and it is globally unique. # Corresponds to the JSON property `numId` # @return [Fixnum] attr_accessor :num_id # The device state, as reported by the device. # Corresponds to the JSON property `state` # @return [Google::Apis::CloudiotV1::DeviceState] attr_accessor :state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @blocked = args[:blocked] if args.key?(:blocked) @config = args[:config] if args.key?(:config) @credentials = args[:credentials] if args.key?(:credentials) @id = args[:id] if args.key?(:id) @last_config_ack_time = args[:last_config_ack_time] if args.key?(:last_config_ack_time) @last_config_send_time = args[:last_config_send_time] if args.key?(:last_config_send_time) @last_error_status = args[:last_error_status] if args.key?(:last_error_status) @last_error_time = args[:last_error_time] if args.key?(:last_error_time) @last_event_time = args[:last_event_time] if args.key?(:last_event_time) @last_heartbeat_time = args[:last_heartbeat_time] if args.key?(:last_heartbeat_time) @last_state_time = args[:last_state_time] if args.key?(:last_state_time) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @num_id = args[:num_id] if args.key?(:num_id) @state = args[:state] if args.key?(:state) end end # The device configuration. Eventually delivered to devices. class DeviceConfig include Google::Apis::Core::Hashable # The device configuration data. # Corresponds to the JSON property `binaryData` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :binary_data # [Output only] The time at which this configuration version was updated in # Cloud IoT Core. This timestamp is set by the server. # Corresponds to the JSON property `cloudUpdateTime` # @return [String] attr_accessor :cloud_update_time # [Output only] The time at which Cloud IoT Core received the # acknowledgment from the device, indicating that the device has received # this configuration version. If this field is not present, the device has # not yet acknowledged that it received this version. Note that when # the config was sent to the device, many config versions may have been # available in Cloud IoT Core while the device was disconnected, and on # connection, only the latest version is sent to the device. Some # versions may never be sent to the device, and therefore are never # acknowledged. This timestamp is set by Cloud IoT Core. # Corresponds to the JSON property `deviceAckTime` # @return [String] attr_accessor :device_ack_time # [Output only] The version of this update. The version number is assigned by # the server, and is always greater than 0 after device creation. The # version must be 0 on the `CreateDevice` request if a `config` is # specified; the response of `CreateDevice` will always have a value of 1. # 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) @binary_data = args[:binary_data] if args.key?(:binary_data) @cloud_update_time = args[:cloud_update_time] if args.key?(:cloud_update_time) @device_ack_time = args[:device_ack_time] if args.key?(:device_ack_time) @version = args[:version] if args.key?(:version) end end # A server-stored device credential used for authentication. class DeviceCredential include Google::Apis::Core::Hashable # [Optional] The time at which this credential becomes invalid. This # credential will be ignored for new client authentication requests after # this timestamp; however, it will not be automatically deleted. # Corresponds to the JSON property `expirationTime` # @return [String] attr_accessor :expiration_time # A public key format and data. # Corresponds to the JSON property `publicKey` # @return [Google::Apis::CloudiotV1::PublicKeyCredential] attr_accessor :public_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expiration_time = args[:expiration_time] if args.key?(:expiration_time) @public_key = args[:public_key] if args.key?(:public_key) end end # A container for a group of devices. class DeviceRegistry include Google::Apis::Core::Hashable # The credentials used to verify the device credentials. No more than 10 # credentials can be bound to a single registry at a time. The verification # process occurs at the time of device creation or update. If this field is # empty, no verification is performed. Otherwise, the credentials of a newly # created device or added credentials of an updated device should be signed # with one of these registry credentials. # Note, however, that existing devices will never be affected by # modifications to this list of credentials: after a device has been # successfully created in a registry, it should be able to connect even if # its registry credentials are revoked, deleted, or modified. # Corresponds to the JSON property `credentials` # @return [Array] attr_accessor :credentials # The configuration for notification of telemetry events received from the # device. All telemetry events that were successfully published by the # device and acknowledged by Cloud IoT Core are guaranteed to be # delivered to Cloud Pub/Sub. Only the first configuration is used. If you # try to publish a device telemetry event using MQTT without specifying a # Cloud Pub/Sub topic for the device's registry, the connection closes # automatically. If you try to do so using an HTTP connection, an error # is returned. # Corresponds to the JSON property `eventNotificationConfigs` # @return [Array] attr_accessor :event_notification_configs # The configuration of the HTTP bridge for a device registry. # Corresponds to the JSON property `httpConfig` # @return [Google::Apis::CloudiotV1::HttpConfig] attr_accessor :http_config # The identifier of this device registry. For example, `myRegistry`. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The configuration of MQTT for a device registry. # Corresponds to the JSON property `mqttConfig` # @return [Google::Apis::CloudiotV1::MqttConfig] attr_accessor :mqtt_config # The resource path name. For example, # `projects/example-project/locations/us-central1/registries/my-registry`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The configuration for notification of new states received from the device. # Corresponds to the JSON property `stateNotificationConfig` # @return [Google::Apis::CloudiotV1::StateNotificationConfig] attr_accessor :state_notification_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @credentials = args[:credentials] if args.key?(:credentials) @event_notification_configs = args[:event_notification_configs] if args.key?(:event_notification_configs) @http_config = args[:http_config] if args.key?(:http_config) @id = args[:id] if args.key?(:id) @mqtt_config = args[:mqtt_config] if args.key?(:mqtt_config) @name = args[:name] if args.key?(:name) @state_notification_config = args[:state_notification_config] if args.key?(:state_notification_config) end end # The device state, as reported by the device. class DeviceState include Google::Apis::Core::Hashable # The device state data. # Corresponds to the JSON property `binaryData` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :binary_data # [Output only] The time at which this state version was updated in Cloud # IoT Core. # 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) @binary_data = args[:binary_data] if args.key?(:binary_data) @update_time = args[:update_time] if args.key?(:update_time) 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 # The configuration to forward telemetry events. class EventNotificationConfig include Google::Apis::Core::Hashable # A Cloud Pub/Sub topic name. For example, # `projects/myProject/topics/deviceEvents`. # Corresponds to the JSON property `pubsubTopicName` # @return [String] attr_accessor :pubsub_topic_name # # Corresponds to the JSON property `subfolderMatches` # @return [String] attr_accessor :subfolder_matches def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @pubsub_topic_name = args[:pubsub_topic_name] if args.key?(:pubsub_topic_name) @subfolder_matches = args[:subfolder_matches] if args.key?(:subfolder_matches) end end # Request message for `GetIamPolicy` method. class GetIamPolicyRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The configuration of the HTTP bridge for a device registry. class HttpConfig include Google::Apis::Core::Hashable # If enabled, allows devices to use DeviceService via the HTTP protocol. # Otherwise, any requests to DeviceService will fail for this registry. # Corresponds to the JSON property `httpEnabledState` # @return [String] attr_accessor :http_enabled_state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @http_enabled_state = args[:http_enabled_state] if args.key?(:http_enabled_state) end end # Response for `ListDeviceConfigVersions`. class ListDeviceConfigVersionsResponse include Google::Apis::Core::Hashable # The device configuration for the last few versions. Versions are listed # in decreasing order, starting from the most recent one. # Corresponds to the JSON property `deviceConfigs` # @return [Array] attr_accessor :device_configs def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @device_configs = args[:device_configs] if args.key?(:device_configs) end end # Response for `ListDeviceRegistries`. class ListDeviceRegistriesResponse include Google::Apis::Core::Hashable # The registries that matched the query. # Corresponds to the JSON property `deviceRegistries` # @return [Array] attr_accessor :device_registries # If not empty, indicates that there may be more registries that match the # request; this value should be passed in a new # `ListDeviceRegistriesRequest`. # 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) @device_registries = args[:device_registries] if args.key?(:device_registries) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response for `ListDeviceStates`. class ListDeviceStatesResponse include Google::Apis::Core::Hashable # The last few device states. States are listed in descending order of server # update time, starting from the most recent one. # Corresponds to the JSON property `deviceStates` # @return [Array] attr_accessor :device_states def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @device_states = args[:device_states] if args.key?(:device_states) end end # Response for `ListDevices`. class ListDevicesResponse include Google::Apis::Core::Hashable # The devices that match the request. # Corresponds to the JSON property `devices` # @return [Array] attr_accessor :devices # If not empty, indicates that there may be more devices that match the # request; this value should be passed in a new `ListDevicesRequest`. # 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) @devices = args[:devices] if args.key?(:devices) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Request for `ModifyCloudToDeviceConfig`. class ModifyCloudToDeviceConfigRequest include Google::Apis::Core::Hashable # The configuration data for the device. # Corresponds to the JSON property `binaryData` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :binary_data # The version number to update. If this value is zero, it will not check the # version number of the server and will always update the current version; # otherwise, this update will fail if the version number found on the server # does not match this version number. This is used to support multiple # simultaneous updates without losing data. # Corresponds to the JSON property `versionToUpdate` # @return [Fixnum] attr_accessor :version_to_update def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @binary_data = args[:binary_data] if args.key?(:binary_data) @version_to_update = args[:version_to_update] if args.key?(:version_to_update) end end # The configuration of MQTT for a device registry. class MqttConfig include Google::Apis::Core::Hashable # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT # connections to this registry will fail. # Corresponds to the JSON property `mqttEnabledState` # @return [String] attr_accessor :mqtt_enabled_state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @mqtt_enabled_state = args[:mqtt_enabled_state] if args.key?(:mqtt_enabled_state) end end # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). class Policy include Google::Apis::Core::Hashable # Specifies cloud audit logging configuration for this policy. # Corresponds to the JSON property `auditConfigs` # @return [Array] attr_accessor :audit_configs # Associates a list of `members` to a `role`. # `bindings` with no members will result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # Deprecated. # 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 # A public key certificate format and data. class PublicKeyCertificate include Google::Apis::Core::Hashable # The certificate data. # Corresponds to the JSON property `certificate` # @return [String] attr_accessor :certificate # The certificate format. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # Details of an X.509 certificate. For informational purposes only. # Corresponds to the JSON property `x509Details` # @return [Google::Apis::CloudiotV1::X509CertificateDetails] attr_accessor :x509_details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @certificate = args[:certificate] if args.key?(:certificate) @format = args[:format] if args.key?(:format) @x509_details = args[:x509_details] if args.key?(:x509_details) end end # A public key format and data. class PublicKeyCredential include Google::Apis::Core::Hashable # The format of the key. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # The key data. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @format = args[:format] if args.key?(:format) @key = args[:key] if args.key?(:key) end end # A server-stored registry credential used to validate device credentials. class RegistryCredential include Google::Apis::Core::Hashable # A public key certificate format and data. # Corresponds to the JSON property `publicKeyCertificate` # @return [Google::Apis::CloudiotV1::PublicKeyCertificate] attr_accessor :public_key_certificate def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @public_key_certificate = args[:public_key_certificate] if args.key?(:public_key_certificate) end end # Request message for `SetIamPolicy` method. class SetIamPolicyRequest include Google::Apis::Core::Hashable # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). # Corresponds to the JSON property `policy` # @return [Google::Apis::CloudiotV1::Policy] attr_accessor :policy # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: # paths: "bindings, etag" # This field is only used by Cloud IAM. # 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 # The configuration for notification of new states received from the device. class StateNotificationConfig include Google::Apis::Core::Hashable # A Cloud Pub/Sub topic name. For example, # `projects/myProject/topics/deviceEvents`. # Corresponds to the JSON property `pubsubTopicName` # @return [String] attr_accessor :pubsub_topic_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @pubsub_topic_name = args[:pubsub_topic_name] if args.key?(:pubsub_topic_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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 # Request message for `TestIamPermissions` method. class TestIamPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the `resource`. Permissions with # wildcards (such as '*' or 'storage.*') are not allowed. For more # information see # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permissions = args[:permissions] if args.key?(:permissions) end end # Response message for `TestIamPermissions` method. class TestIamPermissionsResponse include Google::Apis::Core::Hashable # A subset of `TestPermissionsRequest.permissions` that the caller is # allowed. # Corresponds to the JSON property `permissions` # @return [Array] 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 # Details of an X.509 certificate. For informational purposes only. class X509CertificateDetails include Google::Apis::Core::Hashable # The time the certificate becomes invalid. # Corresponds to the JSON property `expiryTime` # @return [String] attr_accessor :expiry_time # The entity that signed the certificate. # Corresponds to the JSON property `issuer` # @return [String] attr_accessor :issuer # The type of public key in the certificate. # Corresponds to the JSON property `publicKeyType` # @return [String] attr_accessor :public_key_type # The algorithm used to sign the certificate. # Corresponds to the JSON property `signatureAlgorithm` # @return [String] attr_accessor :signature_algorithm # The time the certificate becomes valid. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # The entity the certificate and public key belong to. # Corresponds to the JSON property `subject` # @return [String] attr_accessor :subject def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expiry_time = args[:expiry_time] if args.key?(:expiry_time) @issuer = args[:issuer] if args.key?(:issuer) @public_key_type = args[:public_key_type] if args.key?(:public_key_type) @signature_algorithm = args[:signature_algorithm] if args.key?(:signature_algorithm) @start_time = args[:start_time] if args.key?(:start_time) @subject = args[:subject] if args.key?(:subject) end end end end end google-api-client-0.19.8/generated/google/apis/cloudiot_v1/service.rb0000644000004100000410000011667513252673043025550 0ustar www-datawww-data# 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 CloudiotV1 # Google Cloud IoT API # # Registers and manages IoT (Internet of Things) devices that connect to the # Google Cloud Platform. # # @example # require 'google/apis/cloudiot_v1' # # Cloudiot = Google::Apis::CloudiotV1 # Alias the module # service = Cloudiot::CloudIotService.new # # @see https://cloud.google.com/iot class CloudIotService < 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://cloudiot.googleapis.com/', '') @batch_path = 'batch' end # Creates a device registry that contains devices. # @param [String] parent # The project and cloud region where this device registry must be created. # For example, `projects/example-project/locations/us-central1`. # @param [Google::Apis::CloudiotV1::DeviceRegistry] device_registry_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::CloudiotV1::DeviceRegistry] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::DeviceRegistry] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_registry(parent, device_registry_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/registries', options) command.request_representation = Google::Apis::CloudiotV1::DeviceRegistry::Representation command.request_object = device_registry_object command.response_representation = Google::Apis::CloudiotV1::DeviceRegistry::Representation command.response_class = Google::Apis::CloudiotV1::DeviceRegistry 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 device registry configuration. # @param [String] name # The name of the device registry. For example, # `projects/example-project/locations/us-central1/registries/my-registry`. # @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::CloudiotV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::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_location_registry(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudiotV1::Empty::Representation command.response_class = Google::Apis::CloudiotV1::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 device registry configuration. # @param [String] name # The name of the device registry. For example, # `projects/example-project/locations/us-central1/registries/my-registry`. # @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::CloudiotV1::DeviceRegistry] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::DeviceRegistry] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_registry(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudiotV1::DeviceRegistry::Representation command.response_class = Google::Apis::CloudiotV1::DeviceRegistry 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 access control policy for a resource. # Returns an empty policy if the resource exists and does not have a policy # set. # @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 [Google::Apis::CloudiotV1::GetIamPolicyRequest] get_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::CloudiotV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::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_registry_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options) command.request_representation = Google::Apis::CloudiotV1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::CloudiotV1::Policy::Representation command.response_class = Google::Apis::CloudiotV1::Policy 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 # Lists device registries. # @param [String] parent # The project and cloud region path. For example, # `projects/example-project/locations/us-central1`. # @param [Fixnum] page_size # The maximum number of registries to return in the response. If this value # is zero, the service will select a default size. A call may return fewer # objects than requested, but if there is a non-empty `page_token`, it # indicates that more entries are available. # @param [String] page_token # The value returned by the last `ListDeviceRegistriesResponse`; indicates # that this is a continuation of a prior `ListDeviceRegistries` call, and # that the system should return the next page of data. # @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::CloudiotV1::ListDeviceRegistriesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::ListDeviceRegistriesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_registries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/registries', options) command.response_representation = Google::Apis::CloudiotV1::ListDeviceRegistriesResponse::Representation command.response_class = Google::Apis::CloudiotV1::ListDeviceRegistriesResponse 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 # Updates a device registry configuration. # @param [String] name # The resource path name. For example, # `projects/example-project/locations/us-central1/registries/my-registry`. # @param [Google::Apis::CloudiotV1::DeviceRegistry] device_registry_object # @param [String] update_mask # Only updates the `device_registry` fields indicated by this mask. # The field mask must not be empty, and it must not contain fields that # are immutable or only set by the server. # Mutable top-level fields: `event_notification_config`, `http_config`, # `mqtt_config`, and `state_notification_config`. # @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::CloudiotV1::DeviceRegistry] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::DeviceRegistry] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_registry(name, device_registry_object = 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::CloudiotV1::DeviceRegistry::Representation command.request_object = device_registry_object command.response_representation = Google::Apis::CloudiotV1::DeviceRegistry::Representation command.response_class = Google::Apis::CloudiotV1::DeviceRegistry 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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @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::CloudiotV1::SetIamPolicyRequest] 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::CloudiotV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::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_registry_iam_policy(resource, 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::CloudiotV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::CloudiotV1::Policy::Representation command.response_class = Google::Apis::CloudiotV1::Policy 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 # 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. # @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::CloudiotV1::TestIamPermissionsRequest] 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::CloudiotV1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_registry_iam_permissions(resource, 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::CloudiotV1::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::CloudiotV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::CloudiotV1::TestIamPermissionsResponse 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 device in a device registry. # @param [String] parent # The name of the device registry where this device should be created. # For example, # `projects/example-project/locations/us-central1/registries/my-registry`. # @param [Google::Apis::CloudiotV1::Device] device_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::CloudiotV1::Device] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::Device] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_registry_device(parent, device_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/devices', options) command.request_representation = Google::Apis::CloudiotV1::Device::Representation command.request_object = device_object command.response_representation = Google::Apis::CloudiotV1::Device::Representation command.response_class = Google::Apis::CloudiotV1::Device 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 device. # @param [String] name # The name of the device. For example, # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or # `projects/p0/locations/us-central1/registries/registry0/devices/`num_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::CloudiotV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::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_location_registry_device(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudiotV1::Empty::Representation command.response_class = Google::Apis::CloudiotV1::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 details about a device. # @param [String] name # The name of the device. For example, # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or # `projects/p0/locations/us-central1/registries/registry0/devices/`num_id``. # @param [String] field_mask # The fields of the `Device` resource to be returned in the response. If the # field mask is unset or empty, all fields are 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::CloudiotV1::Device] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::Device] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_registry_device(name, field_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudiotV1::Device::Representation command.response_class = Google::Apis::CloudiotV1::Device command.params['name'] = name unless name.nil? command.query['fieldMask'] = field_mask unless field_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 # List devices in a device registry. # @param [String] parent # The device registry path. Required. For example, # `projects/my-project/locations/us-central1/registries/my-registry`. # @param [Array, String] device_ids # A list of device string identifiers. If empty, it will ignore this field. # For example, `['device0', 'device12']`. This field cannot hold more than # 10,000 entries. # @param [Array, Fixnum] device_num_ids # A list of device numerical ids. If empty, it will ignore this field. This # field cannot hold more than 10,000 entries. # @param [String] field_mask # The fields of the `Device` resource to be returned in the response. The # fields `id`, and `num_id` are always returned by default, along with any # other fields specified. # @param [Fixnum] page_size # The maximum number of devices to return in the response. If this value # is zero, the service will select a default size. A call may return fewer # objects than requested, but if there is a non-empty `page_token`, it # indicates that more entries are available. # @param [String] page_token # The value returned by the last `ListDevicesResponse`; indicates # that this is a continuation of a prior `ListDevices` call, and # that the system should return the next page of data. # @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::CloudiotV1::ListDevicesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::ListDevicesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_registry_devices(parent, device_ids: nil, device_num_ids: nil, field_mask: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/devices', options) command.response_representation = Google::Apis::CloudiotV1::ListDevicesResponse::Representation command.response_class = Google::Apis::CloudiotV1::ListDevicesResponse command.params['parent'] = parent unless parent.nil? command.query['deviceIds'] = device_ids unless device_ids.nil? command.query['deviceNumIds'] = device_num_ids unless device_num_ids.nil? command.query['fieldMask'] = field_mask unless field_mask.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 # Modifies the configuration for the device, which is eventually sent from # the Cloud IoT Core servers. Returns the modified configuration version and # its metadata. # @param [String] name # The name of the device. For example, # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or # `projects/p0/locations/us-central1/registries/registry0/devices/`num_id``. # @param [Google::Apis::CloudiotV1::ModifyCloudToDeviceConfigRequest] modify_cloud_to_device_config_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::CloudiotV1::DeviceConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::DeviceConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def modify_cloud_to_device_config(name, modify_cloud_to_device_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:modifyCloudToDeviceConfig', options) command.request_representation = Google::Apis::CloudiotV1::ModifyCloudToDeviceConfigRequest::Representation command.request_object = modify_cloud_to_device_config_request_object command.response_representation = Google::Apis::CloudiotV1::DeviceConfig::Representation command.response_class = Google::Apis::CloudiotV1::DeviceConfig 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 a device. # @param [String] name # The resource path name. For example, # `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or # `projects/p1/locations/us-central1/registries/registry0/devices/`num_id``. # When `name` is populated as a response from the service, it always ends # in the device numeric ID. # @param [Google::Apis::CloudiotV1::Device] device_object # @param [String] update_mask # Only updates the `device` fields indicated by this mask. # The field mask must not be empty, and it must not contain fields that # are immutable or only set by the server. # Mutable top-level fields: `credentials`, `enabled_state`, and `metadata` # @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::CloudiotV1::Device] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::Device] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_registry_device(name, device_object = 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::CloudiotV1::Device::Representation command.request_object = device_object command.response_representation = Google::Apis::CloudiotV1::Device::Representation command.response_class = Google::Apis::CloudiotV1::Device 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 # Lists the last few versions of the device configuration in descending # order (i.e.: newest first). # @param [String] name # The name of the device. For example, # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or # `projects/p0/locations/us-central1/registries/registry0/devices/`num_id``. # @param [Fixnum] num_versions # The number of versions to list. Versions are listed in decreasing order of # the version number. The maximum number of versions retained is 10. If this # value is zero, it will return all the versions available. # @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::CloudiotV1::ListDeviceConfigVersionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::ListDeviceConfigVersionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_registry_device_config_versions(name, num_versions: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/configVersions', options) command.response_representation = Google::Apis::CloudiotV1::ListDeviceConfigVersionsResponse::Representation command.response_class = Google::Apis::CloudiotV1::ListDeviceConfigVersionsResponse command.params['name'] = name unless name.nil? command.query['numVersions'] = num_versions unless num_versions.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 last few versions of the device state in descending order (i.e.: # newest first). # @param [String] name # The name of the device. For example, # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or # `projects/p0/locations/us-central1/registries/registry0/devices/`num_id``. # @param [Fixnum] num_states # The number of states to list. States are listed in descending order of # update time. The maximum number of states retained is 10. If this # value is zero, it will return all the states available. # @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::CloudiotV1::ListDeviceStatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudiotV1::ListDeviceStatesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_registry_device_states(name, num_states: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/states', options) command.response_representation = Google::Apis::CloudiotV1::ListDeviceStatesResponse::Representation command.response_class = Google::Apis::CloudiotV1::ListDeviceStatesResponse command.params['name'] = name unless name.nil? command.query['numStates'] = num_states unless num_states.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 google-api-client-0.19.8/generated/google/apis/webmasters_v3/0000755000004100000410000000000013252673044024100 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/webmasters_v3/representations.rb0000644000004100000410000002403513252673044027656 0ustar www-datawww-data# 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 WebmastersV3 class ApiDataRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApiDimensionFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApiDimensionFilterGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchAnalyticsQueryRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchAnalyticsQueryResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListSitemapsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListSitesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlCrawlErrorCount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlCrawlErrorCountsPerType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QueryUrlCrawlErrorsCountsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlCrawlErrorsSample class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListUrlCrawlErrorsSamplesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlSampleDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WmxSite class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WmxSitemap class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WmxSitemapContent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApiDataRow # @private class Representation < Google::Apis::Core::JsonRepresentation property :clicks, as: 'clicks' property :ctr, as: 'ctr' property :impressions, as: 'impressions' collection :keys, as: 'keys' property :position, as: 'position' end end class ApiDimensionFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension, as: 'dimension' property :expression, as: 'expression' property :operator, as: 'operator' end end class ApiDimensionFilterGroup # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filters, as: 'filters', class: Google::Apis::WebmastersV3::ApiDimensionFilter, decorator: Google::Apis::WebmastersV3::ApiDimensionFilter::Representation property :group_type, as: 'groupType' end end class SearchAnalyticsQueryRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :aggregation_type, as: 'aggregationType' collection :dimension_filter_groups, as: 'dimensionFilterGroups', class: Google::Apis::WebmastersV3::ApiDimensionFilterGroup, decorator: Google::Apis::WebmastersV3::ApiDimensionFilterGroup::Representation collection :dimensions, as: 'dimensions' property :end_date, as: 'endDate' property :row_limit, as: 'rowLimit' property :search_type, as: 'searchType' property :start_date, as: 'startDate' property :start_row, as: 'startRow' end end class SearchAnalyticsQueryResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :response_aggregation_type, as: 'responseAggregationType' collection :rows, as: 'rows', class: Google::Apis::WebmastersV3::ApiDataRow, decorator: Google::Apis::WebmastersV3::ApiDataRow::Representation end end class ListSitemapsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :sitemap, as: 'sitemap', class: Google::Apis::WebmastersV3::WmxSitemap, decorator: Google::Apis::WebmastersV3::WmxSitemap::Representation end end class ListSitesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :site_entry, as: 'siteEntry', class: Google::Apis::WebmastersV3::WmxSite, decorator: Google::Apis::WebmastersV3::WmxSite::Representation end end class UrlCrawlErrorCount # @private class Representation < Google::Apis::Core::JsonRepresentation property :count, :numeric_string => true, as: 'count' property :timestamp, as: 'timestamp', type: DateTime end end class UrlCrawlErrorCountsPerType # @private class Representation < Google::Apis::Core::JsonRepresentation property :category, as: 'category' collection :entries, as: 'entries', class: Google::Apis::WebmastersV3::UrlCrawlErrorCount, decorator: Google::Apis::WebmastersV3::UrlCrawlErrorCount::Representation property :platform, as: 'platform' end end class QueryUrlCrawlErrorsCountsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :count_per_types, as: 'countPerTypes', class: Google::Apis::WebmastersV3::UrlCrawlErrorCountsPerType, decorator: Google::Apis::WebmastersV3::UrlCrawlErrorCountsPerType::Representation end end class UrlCrawlErrorsSample # @private class Representation < Google::Apis::Core::JsonRepresentation property :first_detected, as: 'first_detected', type: DateTime property :last_crawled, as: 'last_crawled', type: DateTime property :page_url, as: 'pageUrl' property :response_code, as: 'responseCode' property :url_details, as: 'urlDetails', class: Google::Apis::WebmastersV3::UrlSampleDetails, decorator: Google::Apis::WebmastersV3::UrlSampleDetails::Representation end end class ListUrlCrawlErrorsSamplesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :url_crawl_error_sample, as: 'urlCrawlErrorSample', class: Google::Apis::WebmastersV3::UrlCrawlErrorsSample, decorator: Google::Apis::WebmastersV3::UrlCrawlErrorsSample::Representation end end class UrlSampleDetails # @private class Representation < Google::Apis::Core::JsonRepresentation collection :containing_sitemaps, as: 'containingSitemaps' collection :linked_from_urls, as: 'linkedFromUrls' end end class WmxSite # @private class Representation < Google::Apis::Core::JsonRepresentation property :permission_level, as: 'permissionLevel' property :site_url, as: 'siteUrl' end end class WmxSitemap # @private class Representation < Google::Apis::Core::JsonRepresentation collection :contents, as: 'contents', class: Google::Apis::WebmastersV3::WmxSitemapContent, decorator: Google::Apis::WebmastersV3::WmxSitemapContent::Representation property :errors, :numeric_string => true, as: 'errors' property :is_pending, as: 'isPending' property :is_sitemaps_index, as: 'isSitemapsIndex' property :last_downloaded, as: 'lastDownloaded', type: DateTime property :last_submitted, as: 'lastSubmitted', type: DateTime property :path, as: 'path' property :type, as: 'type' property :warnings, :numeric_string => true, as: 'warnings' end end class WmxSitemapContent # @private class Representation < Google::Apis::Core::JsonRepresentation property :indexed, :numeric_string => true, as: 'indexed' property :submitted, :numeric_string => true, as: 'submitted' property :type, as: 'type' end end end end end google-api-client-0.19.8/generated/google/apis/webmasters_v3/classes.rb0000644000004100000410000005074713252673044026077 0ustar www-datawww-data# 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 WebmastersV3 # class ApiDataRow include Google::Apis::Core::Hashable # # Corresponds to the JSON property `clicks` # @return [Float] attr_accessor :clicks # # Corresponds to the JSON property `ctr` # @return [Float] attr_accessor :ctr # # Corresponds to the JSON property `impressions` # @return [Float] attr_accessor :impressions # # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys # # Corresponds to the JSON property `position` # @return [Float] attr_accessor :position def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @clicks = args[:clicks] if args.key?(:clicks) @ctr = args[:ctr] if args.key?(:ctr) @impressions = args[:impressions] if args.key?(:impressions) @keys = args[:keys] if args.key?(:keys) @position = args[:position] if args.key?(:position) end end # class ApiDimensionFilter include Google::Apis::Core::Hashable # # Corresponds to the JSON property `dimension` # @return [String] attr_accessor :dimension # # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression # # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimension = args[:dimension] if args.key?(:dimension) @expression = args[:expression] if args.key?(:expression) @operator = args[:operator] if args.key?(:operator) end end # class ApiDimensionFilterGroup include Google::Apis::Core::Hashable # # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters # # Corresponds to the JSON property `groupType` # @return [String] attr_accessor :group_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filters = args[:filters] if args.key?(:filters) @group_type = args[:group_type] if args.key?(:group_type) end end # class SearchAnalyticsQueryRequest include Google::Apis::Core::Hashable # [Optional; Default is "auto"] How data is aggregated. If aggregated by # property, all data for the same property is aggregated; if aggregated by page, # all data is aggregated by canonical URI. If you filter or group by page, # choose AUTO; otherwise you can aggregate either by property or by page, # depending on how you want your data calculated; see the help documentation to # learn how data is calculated differently by site versus by page. # Note: If you group or filter by page, you cannot aggregate by property. # If you specify any value other than AUTO, the aggregation type in the result # will match the requested type, or if you request an invalid type, you will get # an error. The API will never change your aggregation type if the requested # type is invalid. # Corresponds to the JSON property `aggregationType` # @return [String] attr_accessor :aggregation_type # [Optional] Zero or more filters to apply to the dimension grouping values; for # example, 'query contains "buy"' to see only data where the query string # contains the substring "buy" (not case-sensitive). You can filter by a # dimension without grouping by it. # Corresponds to the JSON property `dimensionFilterGroups` # @return [Array] attr_accessor :dimension_filter_groups # [Optional] Zero or more dimensions to group results by. Dimensions are the # group-by values in the Search Analytics page. Dimensions are combined to # create a unique row key for each row. Results are grouped in the order that # you supply these dimensions. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # [Required] End date of the requested date range, in YYYY-MM-DD format, in PST ( # UTC - 8:00). Must be greater than or equal to the start date. This value is # included in the range. # Corresponds to the JSON property `endDate` # @return [String] attr_accessor :end_date # [Optional; Default is 1000] The maximum number of rows to return. Must be a # number from 1 to 5,000 (inclusive). # Corresponds to the JSON property `rowLimit` # @return [Fixnum] attr_accessor :row_limit # [Optional; Default is "web"] The search type to filter for. # Corresponds to the JSON property `searchType` # @return [String] attr_accessor :search_type # [Required] Start date of the requested date range, in YYYY-MM-DD format, in # PST time (UTC - 8:00). Must be less than or equal to the end date. This value # is included in the range. # Corresponds to the JSON property `startDate` # @return [String] attr_accessor :start_date # [Optional; Default is 0] Zero-based index of the first row in the response. # Must be a non-negative number. # Corresponds to the JSON property `startRow` # @return [Fixnum] attr_accessor :start_row def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aggregation_type = args[:aggregation_type] if args.key?(:aggregation_type) @dimension_filter_groups = args[:dimension_filter_groups] if args.key?(:dimension_filter_groups) @dimensions = args[:dimensions] if args.key?(:dimensions) @end_date = args[:end_date] if args.key?(:end_date) @row_limit = args[:row_limit] if args.key?(:row_limit) @search_type = args[:search_type] if args.key?(:search_type) @start_date = args[:start_date] if args.key?(:start_date) @start_row = args[:start_row] if args.key?(:start_row) end end # A list of rows, one per result, grouped by key. Metrics in each row are # aggregated for all data grouped by that key either by page or property, as # specified by the aggregation type parameter. class SearchAnalyticsQueryResponse include Google::Apis::Core::Hashable # How the results were aggregated. # Corresponds to the JSON property `responseAggregationType` # @return [String] attr_accessor :response_aggregation_type # A list of rows grouped by the key values in the order given in the query. # Corresponds to the JSON property `rows` # @return [Array] attr_accessor :rows def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @response_aggregation_type = args[:response_aggregation_type] if args.key?(:response_aggregation_type) @rows = args[:rows] if args.key?(:rows) end end # List of sitemaps. class ListSitemapsResponse include Google::Apis::Core::Hashable # Contains detailed information about a specific URL submitted as a sitemap. # Corresponds to the JSON property `sitemap` # @return [Array] attr_accessor :sitemap def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @sitemap = args[:sitemap] if args.key?(:sitemap) end end # List of sites with access level information. class ListSitesResponse include Google::Apis::Core::Hashable # Contains permission level information about a Search Console site. For more # information, see Permissions in Search Console. # Corresponds to the JSON property `siteEntry` # @return [Array] attr_accessor :site_entry def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @site_entry = args[:site_entry] if args.key?(:site_entry) end end # An entry in a URL crawl errors time series. class UrlCrawlErrorCount include Google::Apis::Core::Hashable # The error count at the given timestamp. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # The date and time when the crawl attempt took place, in RFC 3339 format. # Corresponds to the JSON property `timestamp` # @return [DateTime] attr_accessor :timestamp def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @count = args[:count] if args.key?(:count) @timestamp = args[:timestamp] if args.key?(:timestamp) end end # Number of errors per day for a specific error type (defined by platform and # category). class UrlCrawlErrorCountsPerType include Google::Apis::Core::Hashable # The crawl error type. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category # The error count entries time series. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # The general type of Googlebot that made the request (see list of Googlebot # user-agents for the user-agents used). # Corresponds to the JSON property `platform` # @return [String] attr_accessor :platform def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @category = args[:category] if args.key?(:category) @entries = args[:entries] if args.key?(:entries) @platform = args[:platform] if args.key?(:platform) end end # A time series of the number of URL crawl errors per error category and # platform. class QueryUrlCrawlErrorsCountsResponse include Google::Apis::Core::Hashable # The time series of the number of URL crawl errors per error category and # platform. # Corresponds to the JSON property `countPerTypes` # @return [Array] attr_accessor :count_per_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @count_per_types = args[:count_per_types] if args.key?(:count_per_types) end end # Contains information about specific crawl errors. class UrlCrawlErrorsSample include Google::Apis::Core::Hashable # The time the error was first detected, in RFC 3339 format. # Corresponds to the JSON property `first_detected` # @return [DateTime] attr_accessor :first_detected # The time when the URL was last crawled, in RFC 3339 format. # Corresponds to the JSON property `last_crawled` # @return [DateTime] attr_accessor :last_crawled # The URL of an error, relative to the site. # Corresponds to the JSON property `pageUrl` # @return [String] attr_accessor :page_url # The HTTP response code, if any. # Corresponds to the JSON property `responseCode` # @return [Fixnum] attr_accessor :response_code # Additional details about the URL, set only when calling get(). # Corresponds to the JSON property `urlDetails` # @return [Google::Apis::WebmastersV3::UrlSampleDetails] attr_accessor :url_details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @first_detected = args[:first_detected] if args.key?(:first_detected) @last_crawled = args[:last_crawled] if args.key?(:last_crawled) @page_url = args[:page_url] if args.key?(:page_url) @response_code = args[:response_code] if args.key?(:response_code) @url_details = args[:url_details] if args.key?(:url_details) end end # List of crawl error samples. class ListUrlCrawlErrorsSamplesResponse include Google::Apis::Core::Hashable # Information about the sample URL and its crawl error. # Corresponds to the JSON property `urlCrawlErrorSample` # @return [Array] attr_accessor :url_crawl_error_sample def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @url_crawl_error_sample = args[:url_crawl_error_sample] if args.key?(:url_crawl_error_sample) end end # Additional details about the URL, set only when calling get(). class UrlSampleDetails include Google::Apis::Core::Hashable # List of sitemaps pointing at this URL. # Corresponds to the JSON property `containingSitemaps` # @return [Array] attr_accessor :containing_sitemaps # A sample set of URLs linking to this URL. # Corresponds to the JSON property `linkedFromUrls` # @return [Array] attr_accessor :linked_from_urls def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @containing_sitemaps = args[:containing_sitemaps] if args.key?(:containing_sitemaps) @linked_from_urls = args[:linked_from_urls] if args.key?(:linked_from_urls) end end # Contains permission level information about a Search Console site. For more # information, see Permissions in Search Console. class WmxSite include Google::Apis::Core::Hashable # The user's permission level for the site. # Corresponds to the JSON property `permissionLevel` # @return [String] attr_accessor :permission_level # The URL of the site. # Corresponds to the JSON property `siteUrl` # @return [String] attr_accessor :site_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permission_level = args[:permission_level] if args.key?(:permission_level) @site_url = args[:site_url] if args.key?(:site_url) end end # Contains detailed information about a specific URL submitted as a sitemap. class WmxSitemap include Google::Apis::Core::Hashable # The various content types in the sitemap. # Corresponds to the JSON property `contents` # @return [Array] attr_accessor :contents # Number of errors in the sitemap. These are issues with the sitemap itself that # need to be fixed before it can be processed correctly. # Corresponds to the JSON property `errors` # @return [Fixnum] attr_accessor :errors # If true, the sitemap has not been processed. # Corresponds to the JSON property `isPending` # @return [Boolean] attr_accessor :is_pending alias_method :is_pending?, :is_pending # If true, the sitemap is a collection of sitemaps. # Corresponds to the JSON property `isSitemapsIndex` # @return [Boolean] attr_accessor :is_sitemaps_index alias_method :is_sitemaps_index?, :is_sitemaps_index # Date & time in which this sitemap was last downloaded. Date format is in RFC # 3339 format (yyyy-mm-dd). # Corresponds to the JSON property `lastDownloaded` # @return [DateTime] attr_accessor :last_downloaded # Date & time in which this sitemap was submitted. Date format is in RFC 3339 # format (yyyy-mm-dd). # Corresponds to the JSON property `lastSubmitted` # @return [DateTime] attr_accessor :last_submitted # The url of the sitemap. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # The type of the sitemap. For example: rssFeed. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Number of warnings for the sitemap. These are generally non-critical issues # with URLs in the sitemaps. # Corresponds to the JSON property `warnings` # @return [Fixnum] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contents = args[:contents] if args.key?(:contents) @errors = args[:errors] if args.key?(:errors) @is_pending = args[:is_pending] if args.key?(:is_pending) @is_sitemaps_index = args[:is_sitemaps_index] if args.key?(:is_sitemaps_index) @last_downloaded = args[:last_downloaded] if args.key?(:last_downloaded) @last_submitted = args[:last_submitted] if args.key?(:last_submitted) @path = args[:path] if args.key?(:path) @type = args[:type] if args.key?(:type) @warnings = args[:warnings] if args.key?(:warnings) end end # Information about the various content types in the sitemap. class WmxSitemapContent include Google::Apis::Core::Hashable # The number of URLs from the sitemap that were indexed (of the content type). # Corresponds to the JSON property `indexed` # @return [Fixnum] attr_accessor :indexed # The number of URLs in the sitemap (of the content type). # Corresponds to the JSON property `submitted` # @return [Fixnum] attr_accessor :submitted # The specific type of content in this sitemap. For example: web. # 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) @indexed = args[:indexed] if args.key?(:indexed) @submitted = args[:submitted] if args.key?(:submitted) @type = args[:type] if args.key?(:type) end end end end end google-api-client-0.19.8/generated/google/apis/webmasters_v3/service.rb0000644000004100000410000010204213252673044026064 0ustar www-datawww-data# 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 WebmastersV3 # Search Console API # # View Google Search Console data for your verified sites. # # @example # require 'google/apis/webmasters_v3' # # Webmasters = Google::Apis::WebmastersV3 # Alias the module # service = Webmasters::WebmastersService.new # # @see https://developers.google.com/webmaster-tools/ class WebmastersService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'webmasters/v3/') @batch_path = 'batch/webmasters/v3' end # Query your data with filters and parameters that you define. Returns zero or # more rows grouped by the row keys that you define. You must define a date # range of one or more days. # When date is one of the group by values, any days without data are omitted # from the result list. If you need to know which days have data, issue a broad # date range query grouped by date for any metric, and see which day rows are # returned. # @param [String] site_url # The site's URL, including protocol. For example: http://www.example.com/ # @param [Google::Apis::WebmastersV3::SearchAnalyticsQueryRequest] search_analytics_query_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_search_analytics(site_url, search_analytics_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'sites/{siteUrl}/searchAnalytics/query', options) command.request_representation = Google::Apis::WebmastersV3::SearchAnalyticsQueryRequest::Representation command.request_object = search_analytics_query_request_object command.response_representation = Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse::Representation command.response_class = Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse command.params['siteUrl'] = site_url unless site_url.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 a sitemap from this site. # @param [String] site_url # The site's URL, including protocol. For example: http://www.example.com/ # @param [String] feedpath # The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'sites/{siteUrl}/sitemaps/{feedpath}', options) command.params['siteUrl'] = site_url unless site_url.nil? command.params['feedpath'] = feedpath unless feedpath.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 information about a specific sitemap. # @param [String] site_url # The site's URL, including protocol. For example: http://www.example.com/ # @param [String] feedpath # The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::WebmastersV3::WmxSitemap] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::WebmastersV3::WmxSitemap] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}/sitemaps/{feedpath}', options) command.response_representation = Google::Apis::WebmastersV3::WmxSitemap::Representation command.response_class = Google::Apis::WebmastersV3::WmxSitemap command.params['siteUrl'] = site_url unless site_url.nil? command.params['feedpath'] = feedpath unless feedpath.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 sitemaps-entries submitted for this site, or included in the sitemap # index file (if sitemapIndex is specified in the request). # @param [String] site_url # The site's URL, including protocol. For example: http://www.example.com/ # @param [String] sitemap_index # A URL of a site's sitemap index. For example: http://www.example.com/ # sitemapindex.xml # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::WebmastersV3::ListSitemapsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::WebmastersV3::ListSitemapsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_sitemaps(site_url, sitemap_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}/sitemaps', options) command.response_representation = Google::Apis::WebmastersV3::ListSitemapsResponse::Representation command.response_class = Google::Apis::WebmastersV3::ListSitemapsResponse command.params['siteUrl'] = site_url unless site_url.nil? command.query['sitemapIndex'] = sitemap_index unless sitemap_index.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 # Submits a sitemap for a site. # @param [String] site_url # The site's URL, including protocol. For example: http://www.example.com/ # @param [String] feedpath # The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 submit_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'sites/{siteUrl}/sitemaps/{feedpath}', options) command.params['siteUrl'] = site_url unless site_url.nil? command.params['feedpath'] = feedpath unless feedpath.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 # Adds a site to the set of the user's sites in Search Console. # @param [String] site_url # The URL of the site to add. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 add_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'sites/{siteUrl}', options) command.params['siteUrl'] = site_url unless site_url.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 # Removes a site from the set of the user's Search Console sites. # @param [String] site_url # The URI of the property as defined in Search Console. Examples: http://www. # example.com/ or android-app://com.example/ Note: for property-sets, use the # URI that starts with sc-set: which is used in Search Console URLs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'sites/{siteUrl}', options) command.params['siteUrl'] = site_url unless site_url.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 information about specific site. # @param [String] site_url # The URI of the property as defined in Search Console. Examples: http://www. # example.com/ or android-app://com.example/ Note: for property-sets, use the # URI that starts with sc-set: which is used in Search Console URLs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::WebmastersV3::WmxSite] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::WebmastersV3::WmxSite] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}', options) command.response_representation = Google::Apis::WebmastersV3::WmxSite::Representation command.response_class = Google::Apis::WebmastersV3::WmxSite command.params['siteUrl'] = site_url unless site_url.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 user's Search Console sites. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::WebmastersV3::ListSitesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::WebmastersV3::ListSitesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_sites(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites', options) command.response_representation = Google::Apis::WebmastersV3::ListSitesResponse::Representation command.response_class = Google::Apis::WebmastersV3::ListSitesResponse 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 time series of the number of URL crawl errors per error category # and platform. # @param [String] site_url # The site's URL, including protocol. For example: http://www.example.com/ # @param [String] category # The crawl error category. For example: serverError. If not specified, returns # results for all categories. # @param [Boolean] latest_counts_only # If true, returns only the latest crawl error counts. # @param [String] platform # The user agent type (platform) that made the request. For example: web. If not # specified, returns results for all platforms. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::WebmastersV3::QueryUrlCrawlErrorsCountsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::WebmastersV3::QueryUrlCrawlErrorsCountsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_errors_count(site_url, category: nil, latest_counts_only: nil, platform: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}/urlCrawlErrorsCounts/query', options) command.response_representation = Google::Apis::WebmastersV3::QueryUrlCrawlErrorsCountsResponse::Representation command.response_class = Google::Apis::WebmastersV3::QueryUrlCrawlErrorsCountsResponse command.params['siteUrl'] = site_url unless site_url.nil? command.query['category'] = category unless category.nil? command.query['latestCountsOnly'] = latest_counts_only unless latest_counts_only.nil? command.query['platform'] = platform unless platform.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 details about crawl errors for a site's sample URL. # @param [String] site_url # The site's URL, including protocol. For example: http://www.example.com/ # @param [String] url # The relative path (without the site) of the sample URL. It must be one of the # URLs returned by list(). For example, for the URL https://www.example.com/ # pagename on the site https://www.example.com/, the url value is pagename # @param [String] category # The crawl error category. For example: authPermissions # @param [String] platform # The user agent type (platform) that made the request. For example: web # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::WebmastersV3::UrlCrawlErrorsSample] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::WebmastersV3::UrlCrawlErrorsSample] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_errors_sample(site_url, url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}/urlCrawlErrorsSamples/{url}', options) command.response_representation = Google::Apis::WebmastersV3::UrlCrawlErrorsSample::Representation command.response_class = Google::Apis::WebmastersV3::UrlCrawlErrorsSample command.params['siteUrl'] = site_url unless site_url.nil? command.params['url'] = url unless url.nil? command.query['category'] = category unless category.nil? command.query['platform'] = platform unless platform.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 a site's sample URLs for the specified crawl error category and platform. # @param [String] site_url # The site's URL, including protocol. For example: http://www.example.com/ # @param [String] category # The crawl error category. For example: authPermissions # @param [String] platform # The user agent type (platform) that made the request. For example: web # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::WebmastersV3::ListUrlCrawlErrorsSamplesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::WebmastersV3::ListUrlCrawlErrorsSamplesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_errors_samples(site_url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}/urlCrawlErrorsSamples', options) command.response_representation = Google::Apis::WebmastersV3::ListUrlCrawlErrorsSamplesResponse::Representation command.response_class = Google::Apis::WebmastersV3::ListUrlCrawlErrorsSamplesResponse command.params['siteUrl'] = site_url unless site_url.nil? command.query['category'] = category unless category.nil? command.query['platform'] = platform unless platform.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 # Marks the provided site's sample URL as fixed, and removes it from the samples # list. # @param [String] site_url # The site's URL, including protocol. For example: http://www.example.com/ # @param [String] url # The relative path (without the site) of the sample URL. It must be one of the # URLs returned by list(). For example, for the URL https://www.example.com/ # pagename on the site https://www.example.com/, the url value is pagename # @param [String] category # The crawl error category. For example: authPermissions # @param [String] platform # The user agent type (platform) that made the request. For example: web # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 mark_as_fixed(site_url, url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'sites/{siteUrl}/urlCrawlErrorsSamples/{url}', options) command.params['siteUrl'] = site_url unless site_url.nil? command.params['url'] = url unless url.nil? command.query['category'] = category unless category.nil? command.query['platform'] = platform unless platform.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 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 end end google-api-client-0.19.8/generated/google/apis/deploymentmanager_alpha/0000755000004100000410000000000013252673043026173 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/deploymentmanager_alpha/representations.rb0000644000004100000410000013176713252673043031764 0ustar www-datawww-data# 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 DeploymentmanagerAlpha class AsyncOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditLogConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthorizationLoggingOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BasicAuth 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 CollectionOverride class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompositeType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompositeTypeLabelEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompositeTypesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Condition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConfigFile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConfigurableService class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Credential class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Deployment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentLabelEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentOutputsEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentUpdate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentUpdateLabelEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentsCancelPreviewRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeploymentsStopRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Diagnostic 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 ImportFile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InputMapping class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfigCloudAuditOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfigCounterOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfigDataAccessOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Manifest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManifestsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MethodMap class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Operation class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport 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 OperationsListResponse 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 Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PollingOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Resource 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 ResourceAccessControl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceUpdate class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport 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 ResourcesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Rule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TemplateContents class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Type class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeInfoSchemaInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeLabelEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeProvider class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeProviderLabelEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeProvidersListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypeProvidersListTypesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TypesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ValidationOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AsyncOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :method_match, as: 'methodMatch' property :polling_options, as: 'pollingOptions', class: Google::Apis::DeploymentmanagerAlpha::PollingOptions, decorator: Google::Apis::DeploymentmanagerAlpha::PollingOptions::Representation end end class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::DeploymentmanagerAlpha::AuditLogConfig, decorator: Google::Apis::DeploymentmanagerAlpha::AuditLogConfig::Representation collection :exempted_members, as: 'exemptedMembers' property :service, as: 'service' end end class AuditLogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exempted_members, as: 'exemptedMembers' property :log_type, as: 'logType' end end class AuthorizationLoggingOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :permission_type, as: 'permissionType' end end class BasicAuth # @private class Representation < Google::Apis::Core::JsonRepresentation property :password, as: 'password' property :user, as: 'user' end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation property :condition, as: 'condition', class: Google::Apis::DeploymentmanagerAlpha::Expr, decorator: Google::Apis::DeploymentmanagerAlpha::Expr::Representation collection :members, as: 'members' property :role, as: 'role' end end class CollectionOverride # @private class Representation < Google::Apis::Core::JsonRepresentation property :collection, as: 'collection' property :method_map, as: 'methodMap', class: Google::Apis::DeploymentmanagerAlpha::MethodMap, decorator: Google::Apis::DeploymentmanagerAlpha::MethodMap::Representation property :options, as: 'options', class: Google::Apis::DeploymentmanagerAlpha::Options, decorator: Google::Apis::DeploymentmanagerAlpha::Options::Representation end end class CompositeType # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerAlpha::CompositeTypeLabelEntry, decorator: Google::Apis::DeploymentmanagerAlpha::CompositeTypeLabelEntry::Representation property :name, as: 'name' property :operation, as: 'operation', class: Google::Apis::DeploymentmanagerAlpha::Operation, decorator: Google::Apis::DeploymentmanagerAlpha::Operation::Representation property :self_link, as: 'selfLink' property :status, as: 'status' property :template_contents, as: 'templateContents', class: Google::Apis::DeploymentmanagerAlpha::TemplateContents, decorator: Google::Apis::DeploymentmanagerAlpha::TemplateContents::Representation end end class CompositeTypeLabelEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class CompositeTypesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :composite_types, as: 'compositeTypes', class: Google::Apis::DeploymentmanagerAlpha::CompositeType, decorator: Google::Apis::DeploymentmanagerAlpha::CompositeType::Representation property :next_page_token, as: 'nextPageToken' end end class Condition # @private class Representation < Google::Apis::Core::JsonRepresentation property :iam, as: 'iam' property :op, as: 'op' property :svc, as: 'svc' property :sys, as: 'sys' property :value, as: 'value' collection :values, as: 'values' end end class ConfigFile # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' end end class ConfigurableService # @private class Representation < Google::Apis::Core::JsonRepresentation collection :collection_overrides, as: 'collectionOverrides', class: Google::Apis::DeploymentmanagerAlpha::CollectionOverride, decorator: Google::Apis::DeploymentmanagerAlpha::CollectionOverride::Representation property :credential, as: 'credential', class: Google::Apis::DeploymentmanagerAlpha::Credential, decorator: Google::Apis::DeploymentmanagerAlpha::Credential::Representation property :descriptor_url, as: 'descriptorUrl' property :options, as: 'options', class: Google::Apis::DeploymentmanagerAlpha::Options, decorator: Google::Apis::DeploymentmanagerAlpha::Options::Representation end end class Credential # @private class Representation < Google::Apis::Core::JsonRepresentation property :basic_auth, as: 'basicAuth', class: Google::Apis::DeploymentmanagerAlpha::BasicAuth, decorator: Google::Apis::DeploymentmanagerAlpha::BasicAuth::Representation property :service_account, as: 'serviceAccount', class: Google::Apis::DeploymentmanagerAlpha::ServiceAccount, decorator: Google::Apis::DeploymentmanagerAlpha::ServiceAccount::Representation property :use_project_default, as: 'useProjectDefault' end end class Deployment # @private class Representation < Google::Apis::Core::JsonRepresentation property :credential, as: 'credential', class: Google::Apis::DeploymentmanagerAlpha::Credential, decorator: Google::Apis::DeploymentmanagerAlpha::Credential::Representation property :description, as: 'description' property :fingerprint, :base64 => true, as: 'fingerprint' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerAlpha::DeploymentLabelEntry, decorator: Google::Apis::DeploymentmanagerAlpha::DeploymentLabelEntry::Representation property :manifest, as: 'manifest' property :name, as: 'name' property :operation, as: 'operation', class: Google::Apis::DeploymentmanagerAlpha::Operation, decorator: Google::Apis::DeploymentmanagerAlpha::Operation::Representation collection :outputs, as: 'outputs', class: Google::Apis::DeploymentmanagerAlpha::DeploymentOutputsEntry, decorator: Google::Apis::DeploymentmanagerAlpha::DeploymentOutputsEntry::Representation property :self_link, as: 'selfLink' property :target, as: 'target', class: Google::Apis::DeploymentmanagerAlpha::TargetConfiguration, decorator: Google::Apis::DeploymentmanagerAlpha::TargetConfiguration::Representation property :update, as: 'update', class: Google::Apis::DeploymentmanagerAlpha::DeploymentUpdate, decorator: Google::Apis::DeploymentmanagerAlpha::DeploymentUpdate::Representation end end class DeploymentLabelEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class DeploymentOutputsEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class DeploymentUpdate # @private class Representation < Google::Apis::Core::JsonRepresentation property :credential, as: 'credential', class: Google::Apis::DeploymentmanagerAlpha::Credential, decorator: Google::Apis::DeploymentmanagerAlpha::Credential::Representation property :description, as: 'description' collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerAlpha::DeploymentUpdateLabelEntry, decorator: Google::Apis::DeploymentmanagerAlpha::DeploymentUpdateLabelEntry::Representation property :manifest, as: 'manifest' end end class DeploymentUpdateLabelEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class DeploymentsCancelPreviewRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' end end class DeploymentsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :deployments, as: 'deployments', class: Google::Apis::DeploymentmanagerAlpha::Deployment, decorator: Google::Apis::DeploymentmanagerAlpha::Deployment::Representation property :next_page_token, as: 'nextPageToken' end end class DeploymentsStopRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' end end class Diagnostic # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field' property :level, as: 'level' 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 ImportFile # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :name, as: 'name' end end class InputMapping # @private class Representation < Google::Apis::Core::JsonRepresentation property :field_name, as: 'fieldName' property :location, as: 'location' property :method_match, as: 'methodMatch' property :value, as: 'value' end end class LogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :cloud_audit, as: 'cloudAudit', class: Google::Apis::DeploymentmanagerAlpha::LogConfigCloudAuditOptions, decorator: Google::Apis::DeploymentmanagerAlpha::LogConfigCloudAuditOptions::Representation property :counter, as: 'counter', class: Google::Apis::DeploymentmanagerAlpha::LogConfigCounterOptions, decorator: Google::Apis::DeploymentmanagerAlpha::LogConfigCounterOptions::Representation property :data_access, as: 'dataAccess', class: Google::Apis::DeploymentmanagerAlpha::LogConfigDataAccessOptions, decorator: Google::Apis::DeploymentmanagerAlpha::LogConfigDataAccessOptions::Representation end end class LogConfigCloudAuditOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :authorization_logging_options, as: 'authorizationLoggingOptions', class: Google::Apis::DeploymentmanagerAlpha::AuthorizationLoggingOptions, decorator: Google::Apis::DeploymentmanagerAlpha::AuthorizationLoggingOptions::Representation property :log_name, as: 'logName' end end class LogConfigCounterOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field' property :metric, as: 'metric' end end class LogConfigDataAccessOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :log_mode, as: 'logMode' end end class Manifest # @private class Representation < Google::Apis::Core::JsonRepresentation property :config, as: 'config', class: Google::Apis::DeploymentmanagerAlpha::ConfigFile, decorator: Google::Apis::DeploymentmanagerAlpha::ConfigFile::Representation property :expanded_config, as: 'expandedConfig' property :id, :numeric_string => true, as: 'id' collection :imports, as: 'imports', class: Google::Apis::DeploymentmanagerAlpha::ImportFile, decorator: Google::Apis::DeploymentmanagerAlpha::ImportFile::Representation property :insert_time, as: 'insertTime' property :layout, as: 'layout' property :name, as: 'name' property :self_link, as: 'selfLink' end end class ManifestsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :manifests, as: 'manifests', class: Google::Apis::DeploymentmanagerAlpha::Manifest, decorator: Google::Apis::DeploymentmanagerAlpha::Manifest::Representation property :next_page_token, as: 'nextPageToken' end end class MethodMap # @private class Representation < Google::Apis::Core::JsonRepresentation property :create, as: 'create' property :delete, as: 'delete' property :get, as: 'get' property :set_iam_policy, as: 'setIamPolicy' property :update, as: 'update' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_operation_id, as: 'clientOperationId' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :end_time, as: 'endTime' property :error, as: 'error', class: Google::Apis::DeploymentmanagerAlpha::Operation::Error, decorator: Google::Apis::DeploymentmanagerAlpha::Operation::Error::Representation property :http_error_message, as: 'httpErrorMessage' property :http_error_status_code, as: 'httpErrorStatusCode' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' property :kind, as: 'kind' property :name, as: 'name' property :operation_type, as: 'operationType' property :progress, as: 'progress' property :region, as: 'region' property :self_link, as: 'selfLink' property :start_time, as: 'startTime' property :status, as: 'status' property :status_message, as: 'statusMessage' property :target_id, :numeric_string => true, as: 'targetId' property :target_link, as: 'targetLink' property :user, as: 'user' collection :warnings, as: 'warnings', class: Google::Apis::DeploymentmanagerAlpha::Operation::Warning, decorator: Google::Apis::DeploymentmanagerAlpha::Operation::Warning::Representation property :zone, as: 'zone' end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::DeploymentmanagerAlpha::Operation::Error::Error, decorator: Google::Apis::DeploymentmanagerAlpha::Operation::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::DeploymentmanagerAlpha::Operation::Warning::Datum, decorator: Google::Apis::DeploymentmanagerAlpha::Operation::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 OperationsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::DeploymentmanagerAlpha::Operation, decorator: Google::Apis::DeploymentmanagerAlpha::Operation::Representation end end class Options # @private class Representation < Google::Apis::Core::JsonRepresentation collection :async_options, as: 'asyncOptions', class: Google::Apis::DeploymentmanagerAlpha::AsyncOptions, decorator: Google::Apis::DeploymentmanagerAlpha::AsyncOptions::Representation collection :input_mappings, as: 'inputMappings', class: Google::Apis::DeploymentmanagerAlpha::InputMapping, decorator: Google::Apis::DeploymentmanagerAlpha::InputMapping::Representation property :name_property, as: 'nameProperty' property :validation_options, as: 'validationOptions', class: Google::Apis::DeploymentmanagerAlpha::ValidationOptions, decorator: Google::Apis::DeploymentmanagerAlpha::ValidationOptions::Representation end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_configs, as: 'auditConfigs', class: Google::Apis::DeploymentmanagerAlpha::AuditConfig, decorator: Google::Apis::DeploymentmanagerAlpha::AuditConfig::Representation collection :bindings, as: 'bindings', class: Google::Apis::DeploymentmanagerAlpha::Binding, decorator: Google::Apis::DeploymentmanagerAlpha::Binding::Representation property :etag, :base64 => true, as: 'etag' property :iam_owned, as: 'iamOwned' collection :rules, as: 'rules', class: Google::Apis::DeploymentmanagerAlpha::Rule, decorator: Google::Apis::DeploymentmanagerAlpha::Rule::Representation property :version, as: 'version' end end class PollingOptions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :diagnostics, as: 'diagnostics', class: Google::Apis::DeploymentmanagerAlpha::Diagnostic, decorator: Google::Apis::DeploymentmanagerAlpha::Diagnostic::Representation property :fail_condition, as: 'failCondition' property :finish_condition, as: 'finishCondition' property :polling_link, as: 'pollingLink' property :target_link, as: 'targetLink' end end class Resource # @private class Representation < Google::Apis::Core::JsonRepresentation property :access_control, as: 'accessControl', class: Google::Apis::DeploymentmanagerAlpha::ResourceAccessControl, decorator: Google::Apis::DeploymentmanagerAlpha::ResourceAccessControl::Representation property :final_properties, as: 'finalProperties' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' property :last_used_credential, as: 'lastUsedCredential', class: Google::Apis::DeploymentmanagerAlpha::Credential, decorator: Google::Apis::DeploymentmanagerAlpha::Credential::Representation property :manifest, as: 'manifest' property :name, as: 'name' property :properties, as: 'properties' collection :runtime_policies, as: 'runtimePolicies' property :type, as: 'type' property :update, as: 'update', class: Google::Apis::DeploymentmanagerAlpha::ResourceUpdate, decorator: Google::Apis::DeploymentmanagerAlpha::ResourceUpdate::Representation property :update_time, as: 'updateTime' property :url, as: 'url' collection :warnings, as: 'warnings', class: Google::Apis::DeploymentmanagerAlpha::Resource::Warning, decorator: Google::Apis::DeploymentmanagerAlpha::Resource::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::DeploymentmanagerAlpha::Resource::Warning::Datum, decorator: Google::Apis::DeploymentmanagerAlpha::Resource::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 ResourceAccessControl # @private class Representation < Google::Apis::Core::JsonRepresentation property :gcp_iam_policy, as: 'gcpIamPolicy' end end class ResourceUpdate # @private class Representation < Google::Apis::Core::JsonRepresentation property :access_control, as: 'accessControl', class: Google::Apis::DeploymentmanagerAlpha::ResourceAccessControl, decorator: Google::Apis::DeploymentmanagerAlpha::ResourceAccessControl::Representation property :credential, as: 'credential', class: Google::Apis::DeploymentmanagerAlpha::Credential, decorator: Google::Apis::DeploymentmanagerAlpha::Credential::Representation property :error, as: 'error', class: Google::Apis::DeploymentmanagerAlpha::ResourceUpdate::Error, decorator: Google::Apis::DeploymentmanagerAlpha::ResourceUpdate::Error::Representation property :final_properties, as: 'finalProperties' property :intent, as: 'intent' property :manifest, as: 'manifest' property :properties, as: 'properties' collection :runtime_policies, as: 'runtimePolicies' property :state, as: 'state' collection :warnings, as: 'warnings', class: Google::Apis::DeploymentmanagerAlpha::ResourceUpdate::Warning, decorator: Google::Apis::DeploymentmanagerAlpha::ResourceUpdate::Warning::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::DeploymentmanagerAlpha::ResourceUpdate::Error::Error, decorator: Google::Apis::DeploymentmanagerAlpha::ResourceUpdate::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::DeploymentmanagerAlpha::ResourceUpdate::Warning::Datum, decorator: Google::Apis::DeploymentmanagerAlpha::ResourceUpdate::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 ResourcesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :resources, as: 'resources', class: Google::Apis::DeploymentmanagerAlpha::Resource, decorator: Google::Apis::DeploymentmanagerAlpha::Resource::Representation end end class Rule # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' collection :conditions, as: 'conditions', class: Google::Apis::DeploymentmanagerAlpha::Condition, decorator: Google::Apis::DeploymentmanagerAlpha::Condition::Representation property :description, as: 'description' collection :ins, as: 'ins' collection :log_configs, as: 'logConfigs', class: Google::Apis::DeploymentmanagerAlpha::LogConfig, decorator: Google::Apis::DeploymentmanagerAlpha::LogConfig::Representation collection :not_ins, as: 'notIns' collection :permissions, as: 'permissions' end end class ServiceAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' end end class TargetConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :config, as: 'config', class: Google::Apis::DeploymentmanagerAlpha::ConfigFile, decorator: Google::Apis::DeploymentmanagerAlpha::ConfigFile::Representation collection :imports, as: 'imports', class: Google::Apis::DeploymentmanagerAlpha::ImportFile, decorator: Google::Apis::DeploymentmanagerAlpha::ImportFile::Representation end end class TemplateContents # @private class Representation < Google::Apis::Core::JsonRepresentation collection :imports, as: 'imports', class: Google::Apis::DeploymentmanagerAlpha::ImportFile, decorator: Google::Apis::DeploymentmanagerAlpha::ImportFile::Representation property :interpreter, as: 'interpreter' property :main_template, as: 'mainTemplate' property :schema, as: 'schema' property :template, as: 'template' end end class TestPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class Type # @private class Representation < Google::Apis::Core::JsonRepresentation property :configurable_service, as: 'configurableService', class: Google::Apis::DeploymentmanagerAlpha::ConfigurableService, decorator: Google::Apis::DeploymentmanagerAlpha::ConfigurableService::Representation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerAlpha::TypeLabelEntry, decorator: Google::Apis::DeploymentmanagerAlpha::TypeLabelEntry::Representation property :name, as: 'name' property :operation, as: 'operation', class: Google::Apis::DeploymentmanagerAlpha::Operation, decorator: Google::Apis::DeploymentmanagerAlpha::Operation::Representation property :self_link, as: 'selfLink' end end class TypeInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :documentation_link, as: 'documentationLink' property :kind, as: 'kind' property :name, as: 'name' property :schema, as: 'schema', class: Google::Apis::DeploymentmanagerAlpha::TypeInfoSchemaInfo, decorator: Google::Apis::DeploymentmanagerAlpha::TypeInfoSchemaInfo::Representation property :self_link, as: 'selfLink' property :title, as: 'title' end end class TypeInfoSchemaInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :input, as: 'input' property :output, as: 'output' end end class TypeLabelEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class TypeProvider # @private class Representation < Google::Apis::Core::JsonRepresentation collection :collection_overrides, as: 'collectionOverrides', class: Google::Apis::DeploymentmanagerAlpha::CollectionOverride, decorator: Google::Apis::DeploymentmanagerAlpha::CollectionOverride::Representation property :credential, as: 'credential', class: Google::Apis::DeploymentmanagerAlpha::Credential, decorator: Google::Apis::DeploymentmanagerAlpha::Credential::Representation property :description, as: 'description' property :descriptor_url, as: 'descriptorUrl' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerAlpha::TypeProviderLabelEntry, decorator: Google::Apis::DeploymentmanagerAlpha::TypeProviderLabelEntry::Representation property :name, as: 'name' property :operation, as: 'operation', class: Google::Apis::DeploymentmanagerAlpha::Operation, decorator: Google::Apis::DeploymentmanagerAlpha::Operation::Representation property :options, as: 'options', class: Google::Apis::DeploymentmanagerAlpha::Options, decorator: Google::Apis::DeploymentmanagerAlpha::Options::Representation property :self_link, as: 'selfLink' end end class TypeProviderLabelEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class TypeProvidersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :type_providers, as: 'typeProviders', class: Google::Apis::DeploymentmanagerAlpha::TypeProvider, decorator: Google::Apis::DeploymentmanagerAlpha::TypeProvider::Representation end end class TypeProvidersListTypesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :types, as: 'types', class: Google::Apis::DeploymentmanagerAlpha::TypeInfo, decorator: Google::Apis::DeploymentmanagerAlpha::TypeInfo::Representation end end class TypesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :types, as: 'types', class: Google::Apis::DeploymentmanagerAlpha::Type, decorator: Google::Apis::DeploymentmanagerAlpha::Type::Representation end end class ValidationOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :schema_validation, as: 'schemaValidation' property :undeclared_properties, as: 'undeclaredProperties' end end end end end google-api-client-0.19.8/generated/google/apis/deploymentmanager_alpha/classes.rb0000644000004100000410000032272513252673043030170 0ustar www-datawww-data# 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 DeploymentmanagerAlpha # Async options that determine when a resource should finish. class AsyncOptions include Google::Apis::Core::Hashable # Method regex where this policy will apply. # Corresponds to the JSON property `methodMatch` # @return [String] attr_accessor :method_match # # Corresponds to the JSON property `pollingOptions` # @return [Google::Apis::DeploymentmanagerAlpha::PollingOptions] attr_accessor :polling_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @method_match = args[:method_match] if args.key?(:method_match) @polling_options = args[:polling_options] if args.key?(:polling_options) 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:foo@gmail.com" ] `, ` " # log_type": "DATA_WRITE", `, ` "log_type": "ADMIN_READ", ` ] `, ` "service": " # fooservice.googleapis.com" "audit_log_configs": [ ` "log_type": "DATA_READ", `, # ` "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] ` ] ` # ] ` # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail. # com from DATA_WRITE logging. class AuditConfig include Google::Apis::Core::Hashable # The configuration for logging of each type of permission. # Corresponds to the JSON property `auditLogConfigs` # @return [Array] attr_accessor :audit_log_configs # # Corresponds to the JSON property `exemptedMembers` # @return [Array] attr_accessor :exempted_members # 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) @exempted_members = args[:exempted_members] if args.key?(:exempted_members) @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:foo@gmail.com" ] `, ` "log_type": "DATA_WRITE", ` ] ` # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail. # com from DATA_READ logging. class AuditLogConfig include Google::Apis::Core::Hashable # Specifies the identities that do not cause logging for this type of permission. # Follows the same format of [Binding.members][]. # Corresponds to the JSON property `exemptedMembers` # @return [Array] 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 # Authorization-related information used by Cloud Audit Logging. class AuthorizationLoggingOptions include Google::Apis::Core::Hashable # The type of the permission that was checked. # Corresponds to the JSON property `permissionType` # @return [String] attr_accessor :permission_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permission_type = args[:permission_type] if args.key?(:permission_type) end end # Basic Auth used as a credential. class BasicAuth include Google::Apis::Core::Hashable # # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # # Corresponds to the JSON property `user` # @return [String] attr_accessor :user def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @password = args[:password] if args.key?(:password) @user = args[:user] if args.key?(:user) end end # Associates `members` with a `role`. class Binding include Google::Apis::Core::Hashable # Represents an expression text. Example: # title: "User account presence" description: "Determines whether the request # has a user account" expression: "size(request.user) > 0" # Corresponds to the JSON property `condition` # @return [Google::Apis::DeploymentmanagerAlpha::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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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 # CollectionOverride allows resource handling overrides for specific resources # within a BaseType class CollectionOverride include Google::Apis::Core::Hashable # The collection that identifies this resource within its service. # Corresponds to the JSON property `collection` # @return [String] attr_accessor :collection # Deployment Manager will call these methods during the events of creation/ # deletion/update/get/setIamPolicy # Corresponds to the JSON property `methodMap` # @return [Google::Apis::DeploymentmanagerAlpha::MethodMap] attr_accessor :method_map # Options allows customized resource handling by Deployment Manager. # Corresponds to the JSON property `options` # @return [Google::Apis::DeploymentmanagerAlpha::Options] attr_accessor :options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @collection = args[:collection] if args.key?(:collection) @method_map = args[:method_map] if args.key?(:method_map) @options = args[:options] if args.key?(:options) end end # Holds the composite type. class CompositeType include Google::Apis::Core::Hashable # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. Timestamp when the composite type was created, in RFC3339 text # format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Map of labels; provided by the client when the resource is created or updated. # Specifically: Label keys must be between 1 and 63 characters long and must # conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label # values must be between 0 and 63 characters long and must conform to the # regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Name of the composite type, must follow the expression: [a-z]([-a-z0-9_.]`0,61` # [a-z0-9])?. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) # Corresponds to the JSON property `operation` # @return [Google::Apis::DeploymentmanagerAlpha::Operation] attr_accessor :operation # Output only. Self link for the type provider. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Files that make up the template contents of a template type. # Corresponds to the JSON property `templateContents` # @return [Google::Apis::DeploymentmanagerAlpha::TemplateContents] attr_accessor :template_contents def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @operation = args[:operation] if args.key?(:operation) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) @template_contents = args[:template_contents] if args.key?(:template_contents) end end # class CompositeTypeLabelEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # A response that returns all Composite Types supported by Deployment Manager class CompositeTypesListResponse include Google::Apis::Core::Hashable # Output only. A list of resource composite types supported by Deployment # Manager. # Corresponds to the JSON property `compositeTypes` # @return [Array] attr_accessor :composite_types # A token used to continue a truncated list request. # 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) @composite_types = args[:composite_types] if args.key?(:composite_types) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # A condition to be met. class Condition include Google::Apis::Core::Hashable # Trusted attributes supplied by the IAM system. # Corresponds to the JSON property `iam` # @return [String] attr_accessor :iam # An operator to apply the subject with. # Corresponds to the JSON property `op` # @return [String] attr_accessor :op # Trusted attributes discharged by the service. # Corresponds to the JSON property `svc` # @return [String] attr_accessor :svc # Trusted attributes supplied by any service that owns resources and uses the # IAM system for access control. # Corresponds to the JSON property `sys` # @return [String] attr_accessor :sys # DEPRECATED. Use 'values' instead. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value # The objects of the condition. This is mutually exclusive with 'value'. # 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) @iam = args[:iam] if args.key?(:iam) @op = args[:op] if args.key?(:op) @svc = args[:svc] if args.key?(:svc) @sys = args[:sys] if args.key?(:sys) @value = args[:value] if args.key?(:value) @values = args[:values] if args.key?(:values) end end # class ConfigFile include Google::Apis::Core::Hashable # The contents of the file. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content = args[:content] if args.key?(:content) end end # BaseType that describes a service-backed Type. class ConfigurableService include Google::Apis::Core::Hashable # Allows resource handling overrides for specific collections # Corresponds to the JSON property `collectionOverrides` # @return [Array] attr_accessor :collection_overrides # The credential used by Deployment Manager and TypeProvider. Only one of the # options is permitted. # Corresponds to the JSON property `credential` # @return [Google::Apis::DeploymentmanagerAlpha::Credential] attr_accessor :credential # Descriptor Url for the this type. # Corresponds to the JSON property `descriptorUrl` # @return [String] attr_accessor :descriptor_url # Options allows customized resource handling by Deployment Manager. # Corresponds to the JSON property `options` # @return [Google::Apis::DeploymentmanagerAlpha::Options] attr_accessor :options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @collection_overrides = args[:collection_overrides] if args.key?(:collection_overrides) @credential = args[:credential] if args.key?(:credential) @descriptor_url = args[:descriptor_url] if args.key?(:descriptor_url) @options = args[:options] if args.key?(:options) end end # The credential used by Deployment Manager and TypeProvider. Only one of the # options is permitted. class Credential include Google::Apis::Core::Hashable # Basic Auth used as a credential. # Corresponds to the JSON property `basicAuth` # @return [Google::Apis::DeploymentmanagerAlpha::BasicAuth] attr_accessor :basic_auth # Service Account used as a credential. # Corresponds to the JSON property `serviceAccount` # @return [Google::Apis::DeploymentmanagerAlpha::ServiceAccount] attr_accessor :service_account # Specify to use the project default credential, only supported by Deployment. # Corresponds to the JSON property `useProjectDefault` # @return [Boolean] attr_accessor :use_project_default alias_method :use_project_default?, :use_project_default def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @basic_auth = args[:basic_auth] if args.key?(:basic_auth) @service_account = args[:service_account] if args.key?(:service_account) @use_project_default = args[:use_project_default] if args.key?(:use_project_default) end end # class Deployment include Google::Apis::Core::Hashable # The credential used by Deployment Manager and TypeProvider. Only one of the # options is permitted. # Corresponds to the JSON property `credential` # @return [Google::Apis::DeploymentmanagerAlpha::Credential] attr_accessor :credential # An optional user-provided description of the deployment. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Provides a fingerprint to use in requests to modify a deployment, such as # update(), stop(), and cancelPreview() requests. A fingerprint is a randomly # generated value that must be provided with update(), stop(), and cancelPreview( # ) requests to perform optimistic locking. This ensures optimistic concurrency # so that only one request happens at a time. # The fingerprint is initially generated by Deployment Manager and changes after # every request to modify data. To get the latest fingerprint value, perform a # get() request to a deployment. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. Timestamp when the deployment was created, in RFC3339 text format # . # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Map of labels; provided by the client when the resource is created or updated. # Specifically: Label keys must be between 1 and 63 characters long and must # conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label # values must be between 0 and 63 characters long and must conform to the # regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Output only. URL of the manifest representing the last manifest that was # successfully deployed. # Corresponds to the JSON property `manifest` # @return [String] attr_accessor :manifest # 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 Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) # Corresponds to the JSON property `operation` # @return [Google::Apis::DeploymentmanagerAlpha::Operation] attr_accessor :operation # Output only. Map of outputs from the last manifest that deployed successfully. # Corresponds to the JSON property `outputs` # @return [Array] attr_accessor :outputs # Output only. Self link for the deployment. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # # Corresponds to the JSON property `target` # @return [Google::Apis::DeploymentmanagerAlpha::TargetConfiguration] attr_accessor :target # # Corresponds to the JSON property `update` # @return [Google::Apis::DeploymentmanagerAlpha::DeploymentUpdate] attr_accessor :update def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @credential = args[:credential] if args.key?(:credential) @description = args[:description] if args.key?(:description) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @labels = args[:labels] if args.key?(:labels) @manifest = args[:manifest] if args.key?(:manifest) @name = args[:name] if args.key?(:name) @operation = args[:operation] if args.key?(:operation) @outputs = args[:outputs] if args.key?(:outputs) @self_link = args[:self_link] if args.key?(:self_link) @target = args[:target] if args.key?(:target) @update = args[:update] if args.key?(:update) end end # class DeploymentLabelEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # class DeploymentOutputsEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # class DeploymentUpdate include Google::Apis::Core::Hashable # The credential used by Deployment Manager and TypeProvider. Only one of the # options is permitted. # Corresponds to the JSON property `credential` # @return [Google::Apis::DeploymentmanagerAlpha::Credential] attr_accessor :credential # Output only. An optional user-provided description of the deployment after the # current update has been applied. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Output only. Map of labels; provided by the client when the resource is # created or updated. Specifically: Label keys must be between 1 and 63 # characters long and must conform to the following regular expression: [a-z]([- # a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and # must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Output only. URL of the manifest representing the update configuration of this # deployment. # Corresponds to the JSON property `manifest` # @return [String] attr_accessor :manifest def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @credential = args[:credential] if args.key?(:credential) @description = args[:description] if args.key?(:description) @labels = args[:labels] if args.key?(:labels) @manifest = args[:manifest] if args.key?(:manifest) end end # class DeploymentUpdateLabelEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # class DeploymentsCancelPreviewRequest include Google::Apis::Core::Hashable # Specifies a fingerprint for cancelPreview() requests. A fingerprint is a # randomly generated value that must be provided in cancelPreview() requests to # perform optimistic locking. This ensures optimistic concurrency so that the # deployment does not have conflicting requests (e.g. if someone attempts to # make a new update request while another user attempts to cancel a preview, # this would prevent one of the requests). # The fingerprint is initially generated by Deployment Manager and changes after # every request to modify a deployment. To get the latest fingerprint value, # perform a get() request on the deployment. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) end end # A response containing a partial list of deployments and a page token used to # build the next request if the request has been truncated. class DeploymentsListResponse include Google::Apis::Core::Hashable # Output only. The deployments contained in this response. # Corresponds to the JSON property `deployments` # @return [Array] attr_accessor :deployments # Output only. A token used to continue a truncated list request. # 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) @deployments = args[:deployments] if args.key?(:deployments) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # class DeploymentsStopRequest include Google::Apis::Core::Hashable # Specifies a fingerprint for stop() requests. A fingerprint is a randomly # generated value that must be provided in stop() requests to perform optimistic # locking. This ensures optimistic concurrency so that the deployment does not # have conflicting requests (e.g. if someone attempts to make a new update # request while another user attempts to stop an ongoing update request, this # would prevent a collision). # The fingerprint is initially generated by Deployment Manager and changes after # every request to modify a deployment. To get the latest fingerprint value, # perform a get() request on the deployment. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) end end # class Diagnostic include Google::Apis::Core::Hashable # JsonPath expression on the resource that if non empty, indicates that this # field needs to be extracted as a diagnostic. # Corresponds to the JSON property `field` # @return [String] attr_accessor :field # Level to record this diagnostic. # Corresponds to the JSON property `level` # @return [String] attr_accessor :level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) @level = args[:level] if args.key?(:level) end end # Represents an expression text. Example: # title: "User account presence" description: "Determines whether the request # has a user account" expression: "size(request.user) > 0" class Expr include Google::Apis::Core::Hashable # An 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. # The application context of the containing message determines which well-known # feature set of CEL is supported. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression # An 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 # An 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 # class ImportFile include Google::Apis::Core::Hashable # The contents of the file. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The name of the file. # 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) @content = args[:content] if args.key?(:content) @name = args[:name] if args.key?(:name) end end # InputMapping creates a 'virtual' property that will be injected into the # properties before sending the request to the underlying API. class InputMapping include Google::Apis::Core::Hashable # The name of the field that is going to be injected. # Corresponds to the JSON property `fieldName` # @return [String] attr_accessor :field_name # The location where this mapping applies. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # Regex to evaluate on method to decide if input applies. # Corresponds to the JSON property `methodMatch` # @return [String] attr_accessor :method_match # A jsonPath expression to select an element. # 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) @field_name = args[:field_name] if args.key?(:field_name) @location = args[:location] if args.key?(:location) @method_match = args[:method_match] if args.key?(:method_match) @value = args[:value] if args.key?(:value) end end # Specifies what kind of log the caller must write class LogConfig include Google::Apis::Core::Hashable # Write a Cloud Audit log # Corresponds to the JSON property `cloudAudit` # @return [Google::Apis::DeploymentmanagerAlpha::LogConfigCloudAuditOptions] attr_accessor :cloud_audit # Increment a streamz counter with the specified metric and field names. # Metric names should start with a '/', generally be lowercase-only, and end in " # _count". Field names should not contain an initial slash. The actual exported # metric names will have "/iam/policy" prepended. # Field names correspond to IAM request parameters and field values are their # respective values. # At present the only supported field names are - "iam_principal", corresponding # to IAMContext.principal; - "" (empty string), resulting in one aggretated # counter with no field. # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/backend_debug_access_count `iam_principal=[value # of IAMContext.principal]` # At this time we do not support: * multiple field names (though this may be # supported in the future) * decrementing the counter * incrementing it by # anything other than 1 # Corresponds to the JSON property `counter` # @return [Google::Apis::DeploymentmanagerAlpha::LogConfigCounterOptions] attr_accessor :counter # Write a Data Access (Gin) log # Corresponds to the JSON property `dataAccess` # @return [Google::Apis::DeploymentmanagerAlpha::LogConfigDataAccessOptions] attr_accessor :data_access def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cloud_audit = args[:cloud_audit] if args.key?(:cloud_audit) @counter = args[:counter] if args.key?(:counter) @data_access = args[:data_access] if args.key?(:data_access) end end # Write a Cloud Audit log class LogConfigCloudAuditOptions include Google::Apis::Core::Hashable # Authorization-related information used by Cloud Audit Logging. # Corresponds to the JSON property `authorizationLoggingOptions` # @return [Google::Apis::DeploymentmanagerAlpha::AuthorizationLoggingOptions] attr_accessor :authorization_logging_options # The log_name to populate in the Cloud Audit Record. # Corresponds to the JSON property `logName` # @return [String] attr_accessor :log_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @authorization_logging_options = args[:authorization_logging_options] if args.key?(:authorization_logging_options) @log_name = args[:log_name] if args.key?(:log_name) end end # Increment a streamz counter with the specified metric and field names. # Metric names should start with a '/', generally be lowercase-only, and end in " # _count". Field names should not contain an initial slash. The actual exported # metric names will have "/iam/policy" prepended. # Field names correspond to IAM request parameters and field values are their # respective values. # At present the only supported field names are - "iam_principal", corresponding # to IAMContext.principal; - "" (empty string), resulting in one aggretated # counter with no field. # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/backend_debug_access_count `iam_principal=[value # of IAMContext.principal]` # At this time we do not support: * multiple field names (though this may be # supported in the future) * decrementing the counter * incrementing it by # anything other than 1 class LogConfigCounterOptions include Google::Apis::Core::Hashable # The field value to attribute. # Corresponds to the JSON property `field` # @return [String] attr_accessor :field # The metric to update. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) @metric = args[:metric] if args.key?(:metric) end end # Write a Data Access (Gin) log class LogConfigDataAccessOptions include Google::Apis::Core::Hashable # Whether Gin logging should happen in a fail-closed manner at the caller. This # is relevant only in the LocalIAM implementation, for now. # Corresponds to the JSON property `logMode` # @return [String] attr_accessor :log_mode def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @log_mode = args[:log_mode] if args.key?(:log_mode) end end # class Manifest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `config` # @return [Google::Apis::DeploymentmanagerAlpha::ConfigFile] attr_accessor :config # Output only. The fully-expanded configuration file, including any templates # and references. # Corresponds to the JSON property `expandedConfig` # @return [String] attr_accessor :expanded_config # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. The imported files for this manifest. # Corresponds to the JSON property `imports` # @return [Array] attr_accessor :imports # Output only. Timestamp when the manifest was created, in RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Output only. The YAML layout for this manifest. # Corresponds to the JSON property `layout` # @return [String] attr_accessor :layout # Output only. # The name of the manifest. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. Self link for the manifest. # 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) @config = args[:config] if args.key?(:config) @expanded_config = args[:expanded_config] if args.key?(:expanded_config) @id = args[:id] if args.key?(:id) @imports = args[:imports] if args.key?(:imports) @insert_time = args[:insert_time] if args.key?(:insert_time) @layout = args[:layout] if args.key?(:layout) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) end end # A response containing a partial list of manifests and a page token used to # build the next request if the request has been truncated. class ManifestsListResponse include Google::Apis::Core::Hashable # Output only. Manifests contained in this list response. # Corresponds to the JSON property `manifests` # @return [Array] attr_accessor :manifests # Output only. A token used to continue a truncated list request. # 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) @manifests = args[:manifests] if args.key?(:manifests) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Deployment Manager will call these methods during the events of creation/ # deletion/update/get/setIamPolicy class MethodMap include Google::Apis::Core::Hashable # The action identifier for the create method to be used for this collection # Corresponds to the JSON property `create` # @return [String] attr_accessor :create # The action identifier for the delete method to be used for this collection # Corresponds to the JSON property `delete` # @return [String] attr_accessor :delete # The action identifier for the get method to be used for this collection # Corresponds to the JSON property `get` # @return [String] attr_accessor :get # The action identifier for the setIamPolicy method to be used for this # collection # Corresponds to the JSON property `setIamPolicy` # @return [String] attr_accessor :set_iam_policy # The action identifier for the update method to be used for this collection # Corresponds to the JSON property `update` # @return [String] attr_accessor :update def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create = args[:create] if args.key?(:create) @delete = args[:delete] if args.key?(:delete) @get = args[:get] if args.key?(:get) @set_iam_policy = args[:set_iam_policy] if args.key?(:set_iam_policy) @update = args[:update] if args.key?(:update) end end # An Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) class Operation include Google::Apis::Core::Hashable # [Output Only] Reserved for future use. # Corresponds to the JSON property `clientOperationId` # @return [String] attr_accessor :client_operation_id # [Deprecated] This field is deprecated. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] A textual description of the operation, which is set when the # operation is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The time that this operation was completed. This value is in # RFC3339 text format. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # [Output Only] If errors are generated during processing of the operation, this # field will be populated. # Corresponds to the JSON property `error` # @return [Google::Apis::DeploymentmanagerAlpha::Operation::Error] attr_accessor :error # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as NOT FOUND. # Corresponds to the JSON property `httpErrorMessage` # @return [String] attr_accessor :http_error_message # [Output Only] If the operation fails, this field contains the HTTP error # status code that was returned. For example, a 404 means the resource was not # found. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] attr_accessor :http_error_status_code # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The time that this operation was requested. This value is in # RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # [Output Only] Type of the resource. Always compute#operation for Operation # resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] The type of operation, such as insert, update, or delete, and so # on. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # [Output Only] An optional progress indicator that ranges from 0 to 100. There # is no requirement that this be linear or support any granularity of operations. # This should not be used to guess when the operation will be complete. This # number should monotonically increase as the operation progresses. # Corresponds to the JSON property `progress` # @return [Fixnum] attr_accessor :progress # [Output Only] The URL of the region where the operation resides. Only # available when performing regional operations. 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 # [Output Only] The time that this operation was started by the server. This # value is in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # [Output Only] The status of the operation, which can be one of the following: # PENDING, RUNNING, or DONE. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional textual description of the current status of the # operation. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # [Output Only] The unique target ID, which identifies a specific incarnation of # the target resource. # Corresponds to the JSON property `targetId` # @return [Fixnum] attr_accessor :target_id # [Output Only] The URL of the resource that the operation modifies. For # operations related to creating a snapshot, this points to the persistent disk # that the snapshot was created from. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link # [Output Only] User who requested the operation, for example: user@example.com. # Corresponds to the JSON property `user` # @return [String] attr_accessor :user # [Output Only] If warning messages are generated during processing of the # operation, this field will be populated. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings # [Output Only] The URL of the zone where the operation resides. Only available # when performing per-zone operations. 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 `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @end_time = args[:end_time] if args.key?(:end_time) @error = args[:error] if args.key?(:error) @http_error_message = args[:http_error_message] if args.key?(:http_error_message) @http_error_status_code = args[:http_error_status_code] if args.key?(:http_error_status_code) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @operation_type = args[:operation_type] if args.key?(:operation_type) @progress = args[:progress] if args.key?(:progress) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @target_id = args[:target_id] if args.key?(:target_id) @target_link = args[:target_link] if args.key?(:target_link) @user = args[:user] if args.key?(:user) @warnings = args[:warnings] if args.key?(:warnings) @zone = args[:zone] if args.key?(:zone) end # [Output Only] If errors are generated during processing of the operation, this # field will be populated. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end # 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 response containing a partial list of operations and a page token used to # build the next request if the request has been truncated. class OperationsListResponse include Google::Apis::Core::Hashable # Output only. A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. Operations contained in this list response. # 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 # Options allows customized resource handling by Deployment Manager. class Options include Google::Apis::Core::Hashable # Options regarding how to thread async requests. # Corresponds to the JSON property `asyncOptions` # @return [Array] attr_accessor :async_options # The mappings that apply for requests. # Corresponds to the JSON property `inputMappings` # @return [Array] attr_accessor :input_mappings # The json path to the field in the resource JSON body into which the resource # name should be mapped. Leaving this empty indicates that there should be no # mapping performed. # Corresponds to the JSON property `nameProperty` # @return [String] attr_accessor :name_property # Options for how to validate and process properties on a resource. # Corresponds to the JSON property `validationOptions` # @return [Google::Apis::DeploymentmanagerAlpha::ValidationOptions] attr_accessor :validation_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @async_options = args[:async_options] if args.key?(:async_options) @input_mappings = args[:input_mappings] if args.key?(:input_mappings) @name_property = args[:name_property] if args.key?(:name_property) @validation_options = args[:validation_options] if args.key?(:validation_options) end end # Defines an Identity and Access Management (IAM) policy. It is used to specify # access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of ` # members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` "bindings": [ ` "role": "roles/owner", "members": [ "user:mike@example.com", # "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@ # appspot.gserviceaccount.com", ] `, ` "role": "roles/viewer", "members": ["user: # sean@example.com"] ` ] ` # For a description of IAM and its features, see the [IAM developer's guide]( # https://cloud.google.com/iam/docs). class Policy include Google::Apis::Core::Hashable # Specifies cloud audit logging configuration for this policy. # Corresponds to the JSON property `auditConfigs` # @return [Array] attr_accessor :audit_configs # Associates a list of `members` to a `role`. `bindings` with no members will # result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # # Corresponds to the JSON property `iamOwned` # @return [Boolean] attr_accessor :iam_owned alias_method :iam_owned?, :iam_owned # If more than one rule is specified, the rules are applied in the following # manner: - All matching LOG rules are always applied. - If any DENY/ # DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if # one or more matching rule requires logging. - Otherwise, if any ALLOW/ # ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if # one or more matching rule requires logging. - Otherwise, if no rule applies, # permission is denied. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules # Deprecated. # 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) @iam_owned = args[:iam_owned] if args.key?(:iam_owned) @rules = args[:rules] if args.key?(:rules) @version = args[:version] if args.key?(:version) end end # class PollingOptions include Google::Apis::Core::Hashable # An array of diagnostics to be collected by Deployment Manager, these # diagnostics will be displayed to the user. # Corresponds to the JSON property `diagnostics` # @return [Array] attr_accessor :diagnostics # JsonPath expression that determines if the request failed. # Corresponds to the JSON property `failCondition` # @return [String] attr_accessor :fail_condition # JsonPath expression that determines if the request is completed. # Corresponds to the JSON property `finishCondition` # @return [String] attr_accessor :finish_condition # JsonPath expression that evaluates to string, it indicates where to poll. # Corresponds to the JSON property `pollingLink` # @return [String] attr_accessor :polling_link # JsonPath expression, after polling is completed, indicates where to fetch the # resource. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @diagnostics = args[:diagnostics] if args.key?(:diagnostics) @fail_condition = args[:fail_condition] if args.key?(:fail_condition) @finish_condition = args[:finish_condition] if args.key?(:finish_condition) @polling_link = args[:polling_link] if args.key?(:polling_link) @target_link = args[:target_link] if args.key?(:target_link) end end # class Resource include Google::Apis::Core::Hashable # The access controls set on the resource. # Corresponds to the JSON property `accessControl` # @return [Google::Apis::DeploymentmanagerAlpha::ResourceAccessControl] attr_accessor :access_control # Output only. The evaluated properties of the resource with references expanded. # Returned as serialized YAML. # Corresponds to the JSON property `finalProperties` # @return [String] attr_accessor :final_properties # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. Timestamp when the resource was created or acquired, in RFC3339 # text format . # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # The credential used by Deployment Manager and TypeProvider. Only one of the # options is permitted. # Corresponds to the JSON property `lastUsedCredential` # @return [Google::Apis::DeploymentmanagerAlpha::Credential] attr_accessor :last_used_credential # Output only. URL of the manifest representing the current configuration of # this resource. # Corresponds to the JSON property `manifest` # @return [String] attr_accessor :manifest # Output only. The name of the resource as it appears in the YAML config. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The current properties of the resource before any references have # been filled in. Returned as serialized YAML. # Corresponds to the JSON property `properties` # @return [String] attr_accessor :properties # Output only. In case this is an action, it will show the runtimePolicies on # which this action will run in the deployment # Corresponds to the JSON property `runtimePolicies` # @return [Array] attr_accessor :runtime_policies # Output only. The type of the resource, for example compute.v1.instance, or # cloudfunctions.v1beta1.function. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # # Corresponds to the JSON property `update` # @return [Google::Apis::DeploymentmanagerAlpha::ResourceUpdate] attr_accessor :update # Output only. Timestamp when the resource was updated, in RFC3339 text format . # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Output only. The URL of the actual resource. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Output only. If warning messages are generated during processing of this # resource, this field will be populated. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @access_control = args[:access_control] if args.key?(:access_control) @final_properties = args[:final_properties] if args.key?(:final_properties) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @last_used_credential = args[:last_used_credential] if args.key?(:last_used_credential) @manifest = args[:manifest] if args.key?(:manifest) @name = args[:name] if args.key?(:name) @properties = args[:properties] if args.key?(:properties) @runtime_policies = args[:runtime_policies] if args.key?(:runtime_policies) @type = args[:type] if args.key?(:type) @update = args[:update] if args.key?(:update) @update_time = args[:update_time] if args.key?(:update_time) @url = args[:url] if args.key?(:url) @warnings = args[:warnings] if args.key?(:warnings) end # 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 # The access controls set on the resource. class ResourceAccessControl include Google::Apis::Core::Hashable # The GCP IAM Policy to set on the resource. # Corresponds to the JSON property `gcpIamPolicy` # @return [String] attr_accessor :gcp_iam_policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @gcp_iam_policy = args[:gcp_iam_policy] if args.key?(:gcp_iam_policy) end end # class ResourceUpdate include Google::Apis::Core::Hashable # The access controls set on the resource. # Corresponds to the JSON property `accessControl` # @return [Google::Apis::DeploymentmanagerAlpha::ResourceAccessControl] attr_accessor :access_control # The credential used by Deployment Manager and TypeProvider. Only one of the # options is permitted. # Corresponds to the JSON property `credential` # @return [Google::Apis::DeploymentmanagerAlpha::Credential] attr_accessor :credential # Output only. If errors are generated during update of the resource, this field # will be populated. # Corresponds to the JSON property `error` # @return [Google::Apis::DeploymentmanagerAlpha::ResourceUpdate::Error] attr_accessor :error # Output only. The expanded properties of the resource with reference values # expanded. Returned as serialized YAML. # Corresponds to the JSON property `finalProperties` # @return [String] attr_accessor :final_properties # Output only. The intent of the resource: PREVIEW, UPDATE, or CANCEL. # Corresponds to the JSON property `intent` # @return [String] attr_accessor :intent # Output only. URL of the manifest representing the update configuration of this # resource. # Corresponds to the JSON property `manifest` # @return [String] attr_accessor :manifest # Output only. The set of updated properties for this resource, before # references are expanded. Returned as serialized YAML. # Corresponds to the JSON property `properties` # @return [String] attr_accessor :properties # Output only. In case this is an action, it will show the runtimePolicies that # this action will have after updating the deployment. # Corresponds to the JSON property `runtimePolicies` # @return [Array] attr_accessor :runtime_policies # Output only. The state of the resource. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. If warning messages are generated during processing of this # resource, this field will be populated. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @access_control = args[:access_control] if args.key?(:access_control) @credential = args[:credential] if args.key?(:credential) @error = args[:error] if args.key?(:error) @final_properties = args[:final_properties] if args.key?(:final_properties) @intent = args[:intent] if args.key?(:intent) @manifest = args[:manifest] if args.key?(:manifest) @properties = args[:properties] if args.key?(:properties) @runtime_policies = args[:runtime_policies] if args.key?(:runtime_policies) @state = args[:state] if args.key?(:state) @warnings = args[:warnings] if args.key?(:warnings) end # Output only. If errors are generated during update of the resource, this field # will be populated. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end # 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 response containing a partial list of resources and a page token used to # build the next request if the request has been truncated. class ResourcesListResponse include Google::Apis::Core::Hashable # A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Resources contained in this list response. # 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) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @resources = args[:resources] if args.key?(:resources) end end # A rule to be applied in a Policy. class Rule include Google::Apis::Core::Hashable # Required # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Additional restrictions that must be met. All conditions must pass for the # rule to match. # Corresponds to the JSON property `conditions` # @return [Array] attr_accessor :conditions # Human-readable description of the rule. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/ # AUTHORITY_SELECTOR is in at least one of these entries. # Corresponds to the JSON property `ins` # @return [Array] attr_accessor :ins # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries # that match the LOG action. # Corresponds to the JSON property `logConfigs` # @return [Array] attr_accessor :log_configs # If one or more 'not_in' clauses are specified, the rule matches if the # PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. # Corresponds to the JSON property `notIns` # @return [Array] attr_accessor :not_ins # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value # of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets. # *') matches all verbs. # 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) @action = args[:action] if args.key?(:action) @conditions = args[:conditions] if args.key?(:conditions) @description = args[:description] if args.key?(:description) @ins = args[:ins] if args.key?(:ins) @log_configs = args[:log_configs] if args.key?(:log_configs) @not_ins = args[:not_ins] if args.key?(:not_ins) @permissions = args[:permissions] if args.key?(:permissions) end end # Service Account used as a credential. class ServiceAccount include Google::Apis::Core::Hashable # The IAM service account email address like test@myproject.iam.gserviceaccount. # com # Corresponds to the JSON property `email` # @return [String] attr_accessor :email def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) end end # class TargetConfiguration include Google::Apis::Core::Hashable # # Corresponds to the JSON property `config` # @return [Google::Apis::DeploymentmanagerAlpha::ConfigFile] attr_accessor :config # Specifies any files to import for this configuration. This can be used to # import templates or other files. For example, you might import a text file in # order to use the file in a template. # Corresponds to the JSON property `imports` # @return [Array] attr_accessor :imports def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @config = args[:config] if args.key?(:config) @imports = args[:imports] if args.key?(:imports) end end # Files that make up the template contents of a template type. class TemplateContents include Google::Apis::Core::Hashable # Import files referenced by the main template. # Corresponds to the JSON property `imports` # @return [Array] attr_accessor :imports # Which interpreter (python or jinja) should be used during expansion. # Corresponds to the JSON property `interpreter` # @return [String] attr_accessor :interpreter # The filename of the mainTemplate # Corresponds to the JSON property `mainTemplate` # @return [String] attr_accessor :main_template # The contents of the template schema. # Corresponds to the JSON property `schema` # @return [String] attr_accessor :schema # The contents of the main template file. # Corresponds to the JSON property `template` # @return [String] attr_accessor :template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @imports = args[:imports] if args.key?(:imports) @interpreter = args[:interpreter] if args.key?(:interpreter) @main_template = args[:main_template] if args.key?(:main_template) @schema = args[:schema] if args.key?(:schema) @template = args[:template] if args.key?(:template) end end # class TestPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the 'resource'. Permissions with wildcards # (such as '*' or 'storage.*') are not 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 # class TestPermissionsResponse 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 # A resource type supported by Deployment Manager. class Type include Google::Apis::Core::Hashable # BaseType that describes a service-backed Type. # Corresponds to the JSON property `configurableService` # @return [Google::Apis::DeploymentmanagerAlpha::ConfigurableService] attr_accessor :configurable_service # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. Timestamp when the type was created, in RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Map of labels; provided by the client when the resource is created or updated. # Specifically: Label keys must be between 1 and 63 characters long and must # conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label # values must be between 0 and 63 characters long and must conform to the # regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Name of the type. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) # Corresponds to the JSON property `operation` # @return [Google::Apis::DeploymentmanagerAlpha::Operation] attr_accessor :operation # Output only. Self link for the type. # 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) @configurable_service = args[:configurable_service] if args.key?(:configurable_service) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @operation = args[:operation] if args.key?(:operation) @self_link = args[:self_link] if args.key?(:self_link) end end # Contains detailed information about a composite type, base type, or base type # with specific collection. class TypeInfo include Google::Apis::Core::Hashable # The description of the type. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field # will be empty. # Corresponds to the JSON property `documentationLink` # @return [String] attr_accessor :documentation_link # Output only. Type of the output. Always deploymentManager#TypeInfo for # TypeInfo. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The base type or composite type name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # # Corresponds to the JSON property `schema` # @return [Google::Apis::DeploymentmanagerAlpha::TypeInfoSchemaInfo] attr_accessor :schema # Output only. Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The title on the API descriptor URL provided. # 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) @documentation_link = args[:documentation_link] if args.key?(:documentation_link) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @schema = args[:schema] if args.key?(:schema) @self_link = args[:self_link] if args.key?(:self_link) @title = args[:title] if args.key?(:title) end end # class TypeInfoSchemaInfo include Google::Apis::Core::Hashable # The properties that this composite type or base type collection accept as # input, represented as a json blob, format is: JSON Schema Draft V4 # Corresponds to the JSON property `input` # @return [String] attr_accessor :input # The properties that this composite type or base type collection exposes as # output, these properties can be used for references, represented as json blob, # format is: JSON Schema Draft V4 # Corresponds to the JSON property `output` # @return [String] attr_accessor :output def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @input = args[:input] if args.key?(:input) @output = args[:output] if args.key?(:output) end end # class TypeLabelEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # A type provider that describes a service-backed Type. class TypeProvider include Google::Apis::Core::Hashable # Allows resource handling overrides for specific collections # Corresponds to the JSON property `collectionOverrides` # @return [Array] attr_accessor :collection_overrides # The credential used by Deployment Manager and TypeProvider. Only one of the # options is permitted. # Corresponds to the JSON property `credential` # @return [Google::Apis::DeploymentmanagerAlpha::Credential] attr_accessor :credential # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Descriptor Url for the this type provider. # Corresponds to the JSON property `descriptorUrl` # @return [String] attr_accessor :descriptor_url # Output only. Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Output only. Timestamp when the type provider was created, in RFC3339 text # format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # Map of labels; provided by the client when the resource is created or updated. # Specifically: Label keys must be between 1 and 63 characters long and must # conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label # values must be between 0 and 63 characters long and must conform to the # regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Name of the type provider. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) # Corresponds to the JSON property `operation` # @return [Google::Apis::DeploymentmanagerAlpha::Operation] attr_accessor :operation # Options allows customized resource handling by Deployment Manager. # Corresponds to the JSON property `options` # @return [Google::Apis::DeploymentmanagerAlpha::Options] attr_accessor :options # Output only. Self link for the type provider. # 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) @collection_overrides = args[:collection_overrides] if args.key?(:collection_overrides) @credential = args[:credential] if args.key?(:credential) @description = args[:description] if args.key?(:description) @descriptor_url = args[:descriptor_url] if args.key?(:descriptor_url) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @operation = args[:operation] if args.key?(:operation) @options = args[:options] if args.key?(:options) @self_link = args[:self_link] if args.key?(:self_link) end end # class TypeProviderLabelEntry include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 # A response that returns all Type Providers supported by Deployment Manager class TypeProvidersListResponse include Google::Apis::Core::Hashable # A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. A list of resource type providers supported by Deployment Manager. # Corresponds to the JSON property `typeProviders` # @return [Array] attr_accessor :type_providers 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) @type_providers = args[:type_providers] if args.key?(:type_providers) end end # class TypeProvidersListTypesResponse include Google::Apis::Core::Hashable # A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. A list of resource type info. # Corresponds to the JSON property `types` # @return [Array] attr_accessor :types 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) @types = args[:types] if args.key?(:types) end end # A response that returns all Types supported by Deployment Manager class TypesListResponse include Google::Apis::Core::Hashable # A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. A list of resource types supported by Deployment Manager. # Corresponds to the JSON property `types` # @return [Array] attr_accessor :types 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) @types = args[:types] if args.key?(:types) end end # Options for how to validate and process properties on a resource. class ValidationOptions include Google::Apis::Core::Hashable # Customize how deployment manager will validate the resource against schema # errors. # Corresponds to the JSON property `schemaValidation` # @return [String] attr_accessor :schema_validation # Specify what to do with extra properties when executing a request. # Corresponds to the JSON property `undeclaredProperties` # @return [String] attr_accessor :undeclared_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @schema_validation = args[:schema_validation] if args.key?(:schema_validation) @undeclared_properties = args[:undeclared_properties] if args.key?(:undeclared_properties) end end end end end google-api-client-0.19.8/generated/google/apis/deploymentmanager_alpha/service.rb0000644000004100000410000035460513252673043030175 0ustar www-datawww-data# 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 DeploymentmanagerAlpha # Google Cloud Deployment Manager Alpha API # # The Deployment Manager API allows users to declaratively configure, deploy and # run complex solutions on the Google Cloud Platform. # # @example # require 'google/apis/deploymentmanager_alpha' # # Deploymentmanager = Google::Apis::DeploymentmanagerAlpha # Alias the module # service = Deploymentmanager::DeploymentManagerAlphaService.new # # @see https://cloud.google.com/deployment-manager/ class DeploymentManagerAlphaService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'deploymentmanager/alpha/projects/') @batch_path = 'batch/deploymentmanager/alpha' end # Deletes a composite type. # @param [String] project # The project ID for this request. # @param [String] composite_type # The name of the type for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_composite_type(project, composite_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/compositeTypes/{compositeType}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['compositeType'] = composite_type unless composite_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 # Gets information about a specific composite type. # @param [String] project # The project ID for this request. # @param [String] composite_type # The name of the composite type for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::CompositeType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::CompositeType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_composite_type(project, composite_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/compositeTypes/{compositeType}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::CompositeType::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::CompositeType command.params['project'] = project unless project.nil? command.params['compositeType'] = composite_type unless composite_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 # Creates a composite type. # @param [String] project # The project ID for this request. # @param [Google::Apis::DeploymentmanagerAlpha::CompositeType] composite_type_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_composite_type(project, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/compositeTypes', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::CompositeType::Representation command.request_object = composite_type_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.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 composite types for Deployment Manager. # @param [String] project # The project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::CompositeTypesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::CompositeTypesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_composite_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/compositeTypes', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::CompositeTypesListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::CompositeTypesListResponse command.params['project'] = project unless project.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['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 a composite type. This method supports patch semantics. # @param [String] project # The project ID for this request. # @param [String] composite_type # The name of the composite type for this request. # @param [Google::Apis::DeploymentmanagerAlpha::CompositeType] composite_type_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_composite_type(project, composite_type, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/compositeTypes/{compositeType}', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::CompositeType::Representation command.request_object = composite_type_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['compositeType'] = composite_type unless composite_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 a composite type. # @param [String] project # The project ID for this request. # @param [String] composite_type # The name of the composite type for this request. # @param [Google::Apis::DeploymentmanagerAlpha::CompositeType] composite_type_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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 update_composite_type(project, composite_type, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/compositeTypes/{compositeType}', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::CompositeType::Representation command.request_object = composite_type_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['compositeType'] = composite_type unless composite_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 # Cancels and removes the preview currently associated with the deployment. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [Google::Apis::DeploymentmanagerAlpha::DeploymentsCancelPreviewRequest] deployments_cancel_preview_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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 cancel_deployment_preview(project, deployment, deployments_cancel_preview_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments/{deployment}/cancelPreview', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::DeploymentsCancelPreviewRequest::Representation command.request_object = deployments_cancel_preview_request_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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 a deployment and all of the resources in the deployment. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [String] delete_policy # Sets the policy to use for deleting resources. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_deployment(project, deployment, delete_policy: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/deployments/{deployment}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['deletePolicy'] = delete_policy unless delete_policy.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 information about a specific deployment. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Deployment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::Deployment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deployment(project, deployment, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::Deployment::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Deployment command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_deployment_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{resource}/getIamPolicy', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::Policy::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Policy command.params['project'] = project unless project.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 # Creates a deployment and all of the resources described by the deployment # manifest. # @param [String] project # The project ID for this request. # @param [Google::Apis::DeploymentmanagerAlpha::Deployment] deployment_object # @param [String] create_policy # # @param [Boolean] preview # If set to true, creates a deployment and creates "shell" resources but does # not actually instantiate these resources. This allows you to preview what your # deployment looks like. After previewing a deployment, you can deploy your # resources by making a request with the update() method or you can use the # cancelPreview() method to cancel the preview altogether. Note that the # deployment will still exist after you cancel the preview and you must # separately delete this deployment if you want to remove it. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_deployment(project, deployment_object = nil, create_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::Deployment::Representation command.request_object = deployment_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.query['createPolicy'] = create_policy unless create_policy.nil? command.query['preview'] = preview unless preview.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 deployments for a given project. # @param [String] project # The project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::DeploymentsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::DeploymentsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deployments(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::DeploymentsListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::DeploymentsListResponse command.params['project'] = project unless project.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['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 a deployment and all of the resources described by the deployment # manifest. This method supports patch semantics. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [Google::Apis::DeploymentmanagerAlpha::Deployment] deployment_object # @param [String] create_policy # Sets the policy to use for creating new resources. # @param [String] delete_policy # Sets the policy to use for deleting resources. # @param [Boolean] preview # If set to true, updates the deployment and creates and updates the "shell" # resources but does not actually alter or instantiate these resources. This # allows you to preview what your deployment will look like. You can use this # intent to preview how an update would affect your deployment. You must provide # a target.config with a configuration if this is set to true. After previewing # a deployment, you can deploy your resources by making a request with the # update() or you can cancelPreview() to remove the preview altogether. Note # that the deployment will still exist after you cancel the preview and you must # separately delete this deployment if you want to remove it. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/deployments/{deployment}', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::Deployment::Representation command.request_object = deployment_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['createPolicy'] = create_policy unless create_policy.nil? command.query['deletePolicy'] = delete_policy unless delete_policy.nil? command.query['preview'] = preview unless preview.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] resource # Name of the resource for this request. # @param [Google::Apis::DeploymentmanagerAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_deployment_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Policy::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Policy command.params['project'] = project unless project.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 # Stops an ongoing operation. This does not roll back any work that has already # been completed, but prevents any new work from being started. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [Google::Apis::DeploymentmanagerAlpha::DeploymentsStopRequest] deployments_stop_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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 stop_deployment(project, deployment, deployments_stop_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments/{deployment}/stop', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::DeploymentsStopRequest::Representation command.request_object = deployments_stop_request_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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] resource # Name of the resource for this request. # @param [Google::Apis::DeploymentmanagerAlpha::TestPermissionsRequest] test_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::TestPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_deployment_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments/{resource}/testIamPermissions', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::TestPermissionsRequest::Representation command.request_object = test_permissions_request_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::TestPermissionsResponse::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::TestPermissionsResponse command.params['project'] = project unless project.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 # Updates a deployment and all of the resources described by the deployment # manifest. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [Google::Apis::DeploymentmanagerAlpha::Deployment] deployment_object # @param [String] create_policy # Sets the policy to use for creating new resources. # @param [String] delete_policy # Sets the policy to use for deleting resources. # @param [Boolean] preview # If set to true, updates the deployment and creates and updates the "shell" # resources but does not actually alter or instantiate these resources. This # allows you to preview what your deployment will look like. You can use this # intent to preview how an update would affect your deployment. You must provide # a target.config with a configuration if this is set to true. After previewing # a deployment, you can deploy your resources by making a request with the # update() or you can cancelPreview() to remove the preview altogether. Note # that the deployment will still exist after you cancel the preview and you must # separately delete this deployment if you want to remove it. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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 update_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/deployments/{deployment}', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::Deployment::Representation command.request_object = deployment_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['createPolicy'] = create_policy unless create_policy.nil? command.query['deletePolicy'] = delete_policy unless delete_policy.nil? command.query['preview'] = preview unless preview.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 information about a specific manifest. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [String] manifest # The name of the manifest for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Manifest] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::Manifest] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_manifest(project, deployment, manifest, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/manifests/{manifest}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::Manifest::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Manifest command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.params['manifest'] = manifest unless manifest.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 manifests for a given deployment. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::ManifestsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::ManifestsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_manifests(project, deployment, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/manifests', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::ManifestsListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::ManifestsListResponse command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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['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 information about a specific operation. # @param [String] project # The project ID for this request. # @param [String] operation # The name of the operation for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations/{operation}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['operation'] = operation unless operation.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 operations for a project. # @param [String] project # The project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::OperationsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::OperationsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::OperationsListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::OperationsListResponse command.params['project'] = project unless project.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['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 information about a single resource. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [String] resource # The name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Resource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::Resource] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_resource(project, deployment, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/resources/{resource}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::Resource::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Resource command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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 # Lists all resources in a given deployment. # @param [String] project # The project ID for this request. # @param [String] deployment # The name of the deployment for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::ResourcesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::ResourcesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_resources(project, deployment, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/resources', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::ResourcesListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::ResourcesListResponse command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.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['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 a type provider. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_type_provider(project, type_provider, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/typeProviders/{typeProvider}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.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 information about a specific type provider. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::TypeProvider] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::TypeProvider] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_type_provider(project, type_provider, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/typeProviders/{typeProvider}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvider::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::TypeProvider command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.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 type info for a type provided by a TypeProvider. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this request. # @param [String] type # The name of the type provider for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::TypeInfo] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::TypeInfo] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_type_provider_type(project, type_provider, type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/typeProviders/{typeProvider}/types/{type}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::TypeInfo::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::TypeInfo command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.nil? command.params['type'] = type unless 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 # Creates a type provider. # @param [String] project # The project ID for this request. # @param [Google::Apis::DeploymentmanagerAlpha::TypeProvider] type_provider_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_type_provider(project, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/typeProviders', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvider::Representation command.request_object = type_provider_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.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 resource type providers for Deployment Manager. # @param [String] project # The project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::TypeProvidersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::TypeProvidersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_type_providers(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/typeProviders', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvidersListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::TypeProvidersListResponse command.params['project'] = project unless project.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['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 type info for a TypeProvider. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::TypeProvidersListTypesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::TypeProvidersListTypesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_type_provider_types(project, type_provider, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/typeProviders/{typeProvider}/types', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvidersListTypesResponse::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::TypeProvidersListTypesResponse command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.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['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 a type provider. This method supports patch semantics. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this request. # @param [Google::Apis::DeploymentmanagerAlpha::TypeProvider] type_provider_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_type_provider(project, type_provider, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/typeProviders/{typeProvider}', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvider::Representation command.request_object = type_provider_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.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 a type provider. # @param [String] project # The project ID for this request. # @param [String] type_provider # The name of the type provider for this request. # @param [Google::Apis::DeploymentmanagerAlpha::TypeProvider] type_provider_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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 update_type_provider(project, type_provider, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/typeProviders/{typeProvider}', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvider::Representation command.request_object = type_provider_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['typeProvider'] = type_provider unless type_provider.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 a type and all of the resources in the type. # @param [String] project # The project ID for this request. # @param [String] type # The name of the type for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_type(project, type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/types/{type}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['type'] = type unless 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 # Gets information about a specific type. # @param [String] project # The project ID for this request. # @param [String] type # The name of the type for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Type] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::Type] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_type(project, type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/types/{type}', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::Type::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Type command.params['project'] = project unless project.nil? command.params['type'] = type unless 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 # Creates a type. # @param [String] project # The project ID for this request. # @param [Google::Apis::DeploymentmanagerAlpha::Type] type_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_type(project, type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/types', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::Type::Representation command.request_object = type_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.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 resource types for Deployment Manager. # @param [String] project # The project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::TypesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::TypesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/types', options) command.response_representation = Google::Apis::DeploymentmanagerAlpha::TypesListResponse::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::TypesListResponse command.params['project'] = project unless project.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['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 a type. This method supports patch semantics. # @param [String] project # The project ID for this request. # @param [String] type # The name of the type for this request. # @param [Google::Apis::DeploymentmanagerAlpha::Type] type_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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_type(project, type, type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/types/{type}', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::Type::Representation command.request_object = type_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['type'] = type unless 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 a type. # @param [String] project # The project ID for this request. # @param [String] type # The name of the type for this request. # @param [Google::Apis::DeploymentmanagerAlpha::Type] type_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DeploymentmanagerAlpha::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DeploymentmanagerAlpha::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 update_type(project, type, type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/types/{type}', options) command.request_representation = Google::Apis::DeploymentmanagerAlpha::Type::Representation command.request_object = type_object command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation command.params['project'] = project unless project.nil? command.params['type'] = type unless 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 protected 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 end end google-api-client-0.19.8/generated/google/apis/kgsearch_v1/0000755000004100000410000000000013252673043023510 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/kgsearch_v1/representations.rb0000644000004100000410000000240513252673043027263 0ustar www-datawww-data# 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 KgsearchV1 class SearchResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :_context, as: '@context' property :_type, as: '@type' collection :item_list_element, as: 'itemListElement' end end end end end google-api-client-0.19.8/generated/google/apis/kgsearch_v1/classes.rb0000644000004100000410000000376313252673043025503 0ustar www-datawww-data# 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 KgsearchV1 # Response message includes the context and a list of matching results # which contain the detail of associated entities. class SearchResponse include Google::Apis::Core::Hashable # The local context applicable for the response. See more details at # http://www.w3.org/TR/json-ld/#context-definitions. # Corresponds to the JSON property `@context` # @return [Object] attr_accessor :_context # The schema type of top-level JSON-LD object, e.g. ItemList. # Corresponds to the JSON property `@type` # @return [Object] attr_accessor :_type # The item list of search results. # Corresponds to the JSON property `itemListElement` # @return [Array] attr_accessor :item_list_element def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @_context = args[:_context] if args.key?(:_context) @_type = args[:_type] if args.key?(:_type) @item_list_element = args[:item_list_element] if args.key?(:item_list_element) end end end end end google-api-client-0.19.8/generated/google/apis/kgsearch_v1/service.rb0000644000004100000410000001237713252673043025507 0ustar www-datawww-data# 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 KgsearchV1 # Knowledge Graph Search API # # Searches the Google Knowledge Graph for entities. # # @example # require 'google/apis/kgsearch_v1' # # Kgsearch = Google::Apis::KgsearchV1 # Alias the module # service = Kgsearch::KgsearchService.new # # @see https://developers.google.com/knowledge-graph/ class KgsearchService < 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://kgsearch.googleapis.com/', '') @batch_path = 'batch' end # Searches Knowledge Graph for entities that match the constraints. # A list of matched entities will be returned in response, which will be in # JSON-LD format and compatible with http://schema.org # @param [Array, String] ids # The list of entity id to be used for search instead of query string. # To specify multiple ids in the HTTP request, repeat the parameter in the # URL as in ...?ids=A&ids=B # @param [Boolean] indent # Enables indenting of json results. # @param [Array, String] languages # The list of language codes (defined in ISO 693) to run the query with, # e.g. 'en'. # @param [Fixnum] limit # Limits the number of entities to be returned. # @param [Boolean] prefix # Enables prefix match against names and aliases of entities # @param [String] query # The literal query string for search. # @param [Array, String] types # Restricts returned entities with these types, e.g. Person # (as defined in http://schema.org/Person). If multiple types are specified, # returned entities will contain one or more of these types. # @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::KgsearchV1::SearchResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::KgsearchV1::SearchResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_entities(ids: nil, indent: nil, languages: nil, limit: nil, prefix: nil, query: nil, types: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/entities:search', options) command.response_representation = Google::Apis::KgsearchV1::SearchResponse::Representation command.response_class = Google::Apis::KgsearchV1::SearchResponse command.query['ids'] = ids unless ids.nil? command.query['indent'] = indent unless indent.nil? command.query['languages'] = languages unless languages.nil? command.query['limit'] = limit unless limit.nil? command.query['prefix'] = prefix unless prefix.nil? command.query['query'] = query unless query.nil? command.query['types'] = types unless types.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 google-api-client-0.19.8/generated/google/apis/searchconsole_v1/0000755000004100000410000000000013252673044024552 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/searchconsole_v1/representations.rb0000644000004100000410000001063313252673044030327 0ustar www-datawww-data# 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 SearchconsoleV1 class BlockedResource 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 MobileFriendlyIssue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceIssue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RunMobileFriendlyTestRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RunMobileFriendlyTestResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BlockedResource # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, :base64 => true, as: 'data' property :mime_type, as: 'mimeType' end end class MobileFriendlyIssue # @private class Representation < Google::Apis::Core::JsonRepresentation property :rule, as: 'rule' end end class ResourceIssue # @private class Representation < Google::Apis::Core::JsonRepresentation property :blocked_resource, as: 'blockedResource', class: Google::Apis::SearchconsoleV1::BlockedResource, decorator: Google::Apis::SearchconsoleV1::BlockedResource::Representation end end class RunMobileFriendlyTestRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :request_screenshot, as: 'requestScreenshot' property :url, as: 'url' end end class RunMobileFriendlyTestResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :mobile_friendliness, as: 'mobileFriendliness' collection :mobile_friendly_issues, as: 'mobileFriendlyIssues', class: Google::Apis::SearchconsoleV1::MobileFriendlyIssue, decorator: Google::Apis::SearchconsoleV1::MobileFriendlyIssue::Representation collection :resource_issues, as: 'resourceIssues', class: Google::Apis::SearchconsoleV1::ResourceIssue, decorator: Google::Apis::SearchconsoleV1::ResourceIssue::Representation property :screenshot, as: 'screenshot', class: Google::Apis::SearchconsoleV1::Image, decorator: Google::Apis::SearchconsoleV1::Image::Representation property :test_status, as: 'testStatus', class: Google::Apis::SearchconsoleV1::TestStatus, decorator: Google::Apis::SearchconsoleV1::TestStatus::Representation end end class TestStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :details, as: 'details' property :status, as: 'status' end end end end end google-api-client-0.19.8/generated/google/apis/searchconsole_v1/classes.rb0000644000004100000410000001516413252673044026543 0ustar www-datawww-data# 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 SearchconsoleV1 # Blocked resource. class BlockedResource include Google::Apis::Core::Hashable # URL of the blocked resource. # 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 # Describe image data. class Image include Google::Apis::Core::Hashable # Image data in format determined by the mime type. Currently, the format # will always be "image/png", but this might change in the future. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data # The mime-type of the image data. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data = args[:data] if args.key?(:data) @mime_type = args[:mime_type] if args.key?(:mime_type) end end # Mobile-friendly issue. class MobileFriendlyIssue include Google::Apis::Core::Hashable # Rule violated. # Corresponds to the JSON property `rule` # @return [String] attr_accessor :rule def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @rule = args[:rule] if args.key?(:rule) end end # Information about a resource with issue. class ResourceIssue include Google::Apis::Core::Hashable # Blocked resource. # Corresponds to the JSON property `blockedResource` # @return [Google::Apis::SearchconsoleV1::BlockedResource] attr_accessor :blocked_resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @blocked_resource = args[:blocked_resource] if args.key?(:blocked_resource) end end # Mobile-friendly test request. class RunMobileFriendlyTestRequest include Google::Apis::Core::Hashable # Whether or not screenshot is requested. Default is false. # Corresponds to the JSON property `requestScreenshot` # @return [Boolean] attr_accessor :request_screenshot alias_method :request_screenshot?, :request_screenshot # URL for inspection. # 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) @request_screenshot = args[:request_screenshot] if args.key?(:request_screenshot) @url = args[:url] if args.key?(:url) end end # Mobile-friendly test response, including mobile-friendly issues and resource # issues. class RunMobileFriendlyTestResponse include Google::Apis::Core::Hashable # Test verdict, whether the page is mobile friendly or not. # Corresponds to the JSON property `mobileFriendliness` # @return [String] attr_accessor :mobile_friendliness # List of mobile-usability issues. # Corresponds to the JSON property `mobileFriendlyIssues` # @return [Array] attr_accessor :mobile_friendly_issues # Information about embedded resources issues. # Corresponds to the JSON property `resourceIssues` # @return [Array] attr_accessor :resource_issues # Describe image data. # Corresponds to the JSON property `screenshot` # @return [Google::Apis::SearchconsoleV1::Image] attr_accessor :screenshot # Final state of the test, including error details if necessary. # Corresponds to the JSON property `testStatus` # @return [Google::Apis::SearchconsoleV1::TestStatus] attr_accessor :test_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @mobile_friendliness = args[:mobile_friendliness] if args.key?(:mobile_friendliness) @mobile_friendly_issues = args[:mobile_friendly_issues] if args.key?(:mobile_friendly_issues) @resource_issues = args[:resource_issues] if args.key?(:resource_issues) @screenshot = args[:screenshot] if args.key?(:screenshot) @test_status = args[:test_status] if args.key?(:test_status) end end # Final state of the test, including error details if necessary. class TestStatus include Google::Apis::Core::Hashable # Error details if applicable. # Corresponds to the JSON property `details` # @return [String] attr_accessor :details # Status of the test. # 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) @details = args[:details] if args.key?(:details) @status = args[:status] if args.key?(:status) end end end end end google-api-client-0.19.8/generated/google/apis/searchconsole_v1/service.rb0000644000004100000410000001017113252673044026537 0ustar www-datawww-data# 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 SearchconsoleV1 # Google Search Console URL Testing Tools API # # Provides tools for running validation tests against single URLs # # @example # require 'google/apis/searchconsole_v1' # # Searchconsole = Google::Apis::SearchconsoleV1 # Alias the module # service = Searchconsole::SearchConsoleService.new # # @see https://developers.google.com/webmaster-tools/search-console-api/ class SearchConsoleService < 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://searchconsole.googleapis.com/', '') @batch_path = 'batch' end # Runs Mobile-Friendly Test for a given URL. # @param [Google::Apis::SearchconsoleV1::RunMobileFriendlyTestRequest] run_mobile_friendly_test_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::SearchconsoleV1::RunMobileFriendlyTestResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def run_mobile_friendly_test(run_mobile_friendly_test_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/urlTestingTools/mobileFriendlyTest:run', options) command.request_representation = Google::Apis::SearchconsoleV1::RunMobileFriendlyTestRequest::Representation command.request_object = run_mobile_friendly_test_request_object command.response_representation = Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse::Representation command.response_class = Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse 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 google-api-client-0.19.8/generated/google/apis/sourcerepo_v1/0000755000004100000410000000000013252673044024110 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/sourcerepo_v1/representations.rb0000644000004100000410000001545213252673044027671 0ustar www-datawww-data# 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 SourcerepoV1 class AuditConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditLogConfig 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 Empty 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 ListReposResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MirrorConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Repo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::SourcerepoV1::AuditLogConfig, decorator: Google::Apis::SourcerepoV1::AuditLogConfig::Representation collection :exempted_members, as: 'exemptedMembers' property :service, as: 'service' end end class AuditLogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exempted_members, as: 'exemptedMembers' property :log_type, as: 'logType' end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation property :condition, as: 'condition', class: Google::Apis::SourcerepoV1::Expr, decorator: Google::Apis::SourcerepoV1::Expr::Representation collection :members, as: 'members' property :role, as: 'role' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation 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 ListReposResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :repos, as: 'repos', class: Google::Apis::SourcerepoV1::Repo, decorator: Google::Apis::SourcerepoV1::Repo::Representation end end class MirrorConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :deploy_key_id, as: 'deployKeyId' property :url, as: 'url' property :webhook_id, as: 'webhookId' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_configs, as: 'auditConfigs', class: Google::Apis::SourcerepoV1::AuditConfig, decorator: Google::Apis::SourcerepoV1::AuditConfig::Representation collection :bindings, as: 'bindings', class: Google::Apis::SourcerepoV1::Binding, decorator: Google::Apis::SourcerepoV1::Binding::Representation property :etag, :base64 => true, as: 'etag' property :iam_owned, as: 'iamOwned' property :version, as: 'version' end end class Repo # @private class Representation < Google::Apis::Core::JsonRepresentation property :mirror_config, as: 'mirrorConfig', class: Google::Apis::SourcerepoV1::MirrorConfig, decorator: Google::Apis::SourcerepoV1::MirrorConfig::Representation property :name, as: 'name' property :size, :numeric_string => true, as: 'size' property :url, as: 'url' end end class SetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :policy, as: 'policy', class: Google::Apis::SourcerepoV1::Policy, decorator: Google::Apis::SourcerepoV1::Policy::Representation property :update_mask, as: 'updateMask' end end class TestIamPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestIamPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end end end end google-api-client-0.19.8/generated/google/apis/sourcerepo_v1/classes.rb0000644000004100000410000004756213252673044026110 0ustar www-datawww-data# 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 SourcerepoV1 # 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 # AuditConfig are exempted. # Example Policy with multiple AuditConfigs: # ` # "audit_configs": [ # ` # "service": "allServices" # "audit_log_configs": [ # ` # "log_type": "DATA_READ", # "exempted_members": [ # "user:foo@gmail.com" # ] # `, # ` # "log_type": "DATA_WRITE", # `, # ` # "log_type": "ADMIN_READ", # ` # ] # `, # ` # "service": "fooservice.googleapis.com" # "audit_log_configs": [ # ` # "log_type": "DATA_READ", # `, # ` # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:bar@gmail.com" # ] # ` # ] # ` # ] # ` # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and # bar@gmail.com from DATA_WRITE logging. class AuditConfig include Google::Apis::Core::Hashable # The configuration for logging of each type of permission. # Next ID: 4 # Corresponds to the JSON property `auditLogConfigs` # @return [Array] attr_accessor :audit_log_configs # # Corresponds to the JSON property `exemptedMembers` # @return [Array] attr_accessor :exempted_members # 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) @exempted_members = args[:exempted_members] if args.key?(:exempted_members) @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:foo@gmail.com" # ] # `, # ` # "log_type": "DATA_WRITE", # ` # ] # ` # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # foo@gmail.com from DATA_READ logging. class AuditLogConfig include Google::Apis::Core::Hashable # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. # Corresponds to the JSON property `exemptedMembers` # @return [Array] 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 Binding include Google::Apis::Core::Hashable # Represents an expression text. Example: # title: "User account presence" # description: "Determines whether the request has a user account" # expression: "size(request.user) > 0" # Corresponds to the JSON property `condition` # @return [Google::Apis::SourcerepoV1::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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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`. # Required # 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 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 # Represents an expression text. Example: # title: "User account presence" # description: "Determines whether the request has a user account" # expression: "size(request.user) > 0" class Expr include Google::Apis::Core::Hashable # An 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. # The application context of the containing message determines which # well-known feature set of CEL is supported. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression # An 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 # An 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 # Response for ListRepos. The size is not set in the returned repositories. class ListReposResponse include Google::Apis::Core::Hashable # If non-empty, additional repositories exist within the project. These # can be retrieved by including this value in the next ListReposRequest's # page_token field. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The listed repos. # Corresponds to the JSON property `repos` # @return [Array] attr_accessor :repos 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) @repos = args[:repos] if args.key?(:repos) end end # Configuration to automatically mirror a repository from another # hosting service, for example GitHub or Bitbucket. class MirrorConfig include Google::Apis::Core::Hashable # ID of the SSH deploy key at the other hosting service. # Removing this key from the other service would deauthorize # Google Cloud Source Repositories from mirroring. # Corresponds to the JSON property `deployKeyId` # @return [String] attr_accessor :deploy_key_id # URL of the main repository at the other hosting service. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # ID of the webhook listening to updates to trigger mirroring. # Removing this webhook from the other hosting service will stop # Google Cloud Source Repositories from receiving notifications, # and thereby disabling mirroring. # Corresponds to the JSON property `webhookId` # @return [String] attr_accessor :webhook_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deploy_key_id = args[:deploy_key_id] if args.key?(:deploy_key_id) @url = args[:url] if args.key?(:url) @webhook_id = args[:webhook_id] if args.key?(:webhook_id) end end # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam). class Policy 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`. # `bindings` with no members will result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # # Corresponds to the JSON property `iamOwned` # @return [Boolean] attr_accessor :iam_owned alias_method :iam_owned?, :iam_owned # Version of the `Policy`. The default version is 0. # 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) @iam_owned = args[:iam_owned] if args.key?(:iam_owned) @version = args[:version] if args.key?(:version) end end # A repository (or repo) is a Git repository storing versioned source content. class Repo include Google::Apis::Core::Hashable # Configuration to automatically mirror a repository from another # hosting service, for example GitHub or Bitbucket. # Corresponds to the JSON property `mirrorConfig` # @return [Google::Apis::SourcerepoV1::MirrorConfig] attr_accessor :mirror_config # Resource name of the repository, of the form # `projects//repos/`. The repo name may contain slashes. # eg, `projects/myproject/repos/name/with/slash` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The disk usage of the repo, in bytes. Read-only field. Size is only # returned by GetRepo. # Corresponds to the JSON property `size` # @return [Fixnum] attr_accessor :size # URL to clone the repository from Google Cloud Source Repositories. # Read-only field. # 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) @mirror_config = args[:mirror_config] if args.key?(:mirror_config) @name = args[:name] if args.key?(:name) @size = args[:size] if args.key?(:size) @url = args[:url] if args.key?(:url) end end # Request message for `SetIamPolicy` method. class SetIamPolicyRequest include Google::Apis::Core::Hashable # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam). # Corresponds to the JSON property `policy` # @return [Google::Apis::SourcerepoV1::Policy] attr_accessor :policy # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: # paths: "bindings, etag" # This field is only used by Cloud IAM. # 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 TestIamPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the `resource`. Permissions with # wildcards (such as '*' or 'storage.*') are not allowed. For more # information see # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permissions = args[:permissions] if args.key?(:permissions) end end # Response message for `TestIamPermissions` method. class TestIamPermissionsResponse include Google::Apis::Core::Hashable # A subset of `TestPermissionsRequest.permissions` that the caller is # allowed. # Corresponds to the JSON property `permissions` # @return [Array] 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 end end end google-api-client-0.19.8/generated/google/apis/sourcerepo_v1/service.rb0000644000004100000410000004135513252673044026105 0ustar www-datawww-data# 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 SourcerepoV1 # Cloud Source Repositories API # # Access source code repositories hosted by Google. # # @example # require 'google/apis/sourcerepo_v1' # # Sourcerepo = Google::Apis::SourcerepoV1 # Alias the module # service = Sourcerepo::CloudSourceRepositoriesService.new # # @see https://cloud.google.com/source-repositories/docs/apis class CloudSourceRepositoriesService < 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://sourcerepo.googleapis.com/', '') @batch_path = 'batch' end # Creates a repo in the given project with the given name. # If the named repository already exists, `CreateRepo` returns # `ALREADY_EXISTS`. # @param [String] parent # The project in which to create the repo. Values are of the form # `projects/`. # @param [Google::Apis::SourcerepoV1::Repo] repo_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::SourcerepoV1::Repo] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SourcerepoV1::Repo] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_repo(parent, repo_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/repos', options) command.request_representation = Google::Apis::SourcerepoV1::Repo::Representation command.request_object = repo_object command.response_representation = Google::Apis::SourcerepoV1::Repo::Representation command.response_class = Google::Apis::SourcerepoV1::Repo 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 repo. # @param [String] name # The name of the repo to delete. Values are of the form # `projects//repos/`. # @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::SourcerepoV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SourcerepoV1::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_repo(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::SourcerepoV1::Empty::Representation command.response_class = Google::Apis::SourcerepoV1::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 # Returns information about a repo. # @param [String] name # The name of the requested repository. Values are of the form # `projects//repos/`. # @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::SourcerepoV1::Repo] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SourcerepoV1::Repo] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_repo(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::SourcerepoV1::Repo::Representation command.response_class = Google::Apis::SourcerepoV1::Repo 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 access control policy for a resource. # Returns an empty policy if the resource exists and does not have a policy # set. # @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 [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::SourcerepoV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SourcerepoV1::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_project_repo_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) command.response_representation = Google::Apis::SourcerepoV1::Policy::Representation command.response_class = Google::Apis::SourcerepoV1::Policy 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 # Returns all repos belonging to a project. The sizes of the repos are # not set by ListRepos. To get the size of a repo, use GetRepo. # @param [String] name # The project ID whose repos should be listed. Values are of the form # `projects/`. # @param [Fixnum] page_size # Maximum number of repositories to return; between 1 and 500. # If not set or zero, defaults to 100 at the server. # @param [String] page_token # Resume listing repositories where a prior ListReposResponse # left off. This is an opaque token that must be obtained from # a recent, prior ListReposResponse's next_page_token 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::SourcerepoV1::ListReposResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SourcerepoV1::ListReposResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_repos(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/repos', options) command.response_representation = Google::Apis::SourcerepoV1::ListReposResponse::Representation command.response_class = Google::Apis::SourcerepoV1::ListReposResponse command.params['name'] = name unless 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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @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::SourcerepoV1::SetIamPolicyRequest] 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::SourcerepoV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SourcerepoV1::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_repo_iam_policy(resource, 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::SourcerepoV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::SourcerepoV1::Policy::Representation command.response_class = Google::Apis::SourcerepoV1::Policy 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 # 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. # @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::SourcerepoV1::TestIamPermissionsRequest] 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::SourcerepoV1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SourcerepoV1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_repo_iam_permissions(resource, 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::SourcerepoV1::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::SourcerepoV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::SourcerepoV1::TestIamPermissionsResponse 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 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 google-api-client-0.19.8/generated/google/apis/adexchangeseller_v2_0.rb0000644000004100000410000000246613252673043025774 0ustar www-datawww-data# 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/adexchangeseller_v2_0/service.rb' require 'google/apis/adexchangeseller_v2_0/classes.rb' require 'google/apis/adexchangeseller_v2_0/representations.rb' module Google module Apis # Ad Exchange Seller API # # Accesses the inventory of Ad Exchange seller users and generates reports. # # @see https://developers.google.com/ad-exchange/seller-rest/ module AdexchangesellerV2_0 VERSION = 'V2_0' REVISION = '20160805' # View and manage your Ad Exchange data AUTH_ADEXCHANGE_SELLER = 'https://www.googleapis.com/auth/adexchange.seller' # View your Ad Exchange data AUTH_ADEXCHANGE_SELLER_READONLY = 'https://www.googleapis.com/auth/adexchange.seller.readonly' end end end google-api-client-0.19.8/generated/google/apis/abusiveexperiencereport_v1/0000755000004100000410000000000013252673043026663 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/abusiveexperiencereport_v1/representations.rb0000644000004100000410000000410013252673043032430 0ustar www-datawww-data# 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 AbusiveexperiencereportV1 class SiteSummaryResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ViolatingSitesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SiteSummaryResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :abusive_status, as: 'abusiveStatus' property :enforcement_time, as: 'enforcementTime' property :filter_status, as: 'filterStatus' property :last_change_time, as: 'lastChangeTime' property :report_url, as: 'reportUrl' property :reviewed_site, as: 'reviewedSite' property :under_review, as: 'underReview' end end class ViolatingSitesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :violating_sites, as: 'violatingSites', class: Google::Apis::AbusiveexperiencereportV1::SiteSummaryResponse, decorator: Google::Apis::AbusiveexperiencereportV1::SiteSummaryResponse::Representation end end end end end google-api-client-0.19.8/generated/google/apis/abusiveexperiencereport_v1/classes.rb0000644000004100000410000000714013252673043030647 0ustar www-datawww-data# 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 AbusiveexperiencereportV1 # Response message for GetSiteSummary. class SiteSummaryResponse include Google::Apis::Core::Hashable # The status of the site reviewed for the abusive experiences. # Corresponds to the JSON property `abusiveStatus` # @return [String] attr_accessor :abusive_status # The date on which enforcement begins. # Corresponds to the JSON property `enforcementTime` # @return [String] attr_accessor :enforcement_time # The abusive experience enforcement status of the site. # Corresponds to the JSON property `filterStatus` # @return [String] attr_accessor :filter_status # The last time that the site changed status. # Corresponds to the JSON property `lastChangeTime` # @return [String] attr_accessor :last_change_time # A link that leads to a full abusive experience report. # Corresponds to the JSON property `reportUrl` # @return [String] attr_accessor :report_url # The name of the site reviewed. # Corresponds to the JSON property `reviewedSite` # @return [String] attr_accessor :reviewed_site # Whether the site is currently under review. # Corresponds to the JSON property `underReview` # @return [Boolean] attr_accessor :under_review alias_method :under_review?, :under_review def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @abusive_status = args[:abusive_status] if args.key?(:abusive_status) @enforcement_time = args[:enforcement_time] if args.key?(:enforcement_time) @filter_status = args[:filter_status] if args.key?(:filter_status) @last_change_time = args[:last_change_time] if args.key?(:last_change_time) @report_url = args[:report_url] if args.key?(:report_url) @reviewed_site = args[:reviewed_site] if args.key?(:reviewed_site) @under_review = args[:under_review] if args.key?(:under_review) end end # Response message for ListViolatingSites. class ViolatingSitesResponse include Google::Apis::Core::Hashable # A list of summaries of violating sites. # Corresponds to the JSON property `violatingSites` # @return [Array] attr_accessor :violating_sites def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @violating_sites = args[:violating_sites] if args.key?(:violating_sites) end end end end end google-api-client-0.19.8/generated/google/apis/abusiveexperiencereport_v1/service.rb0000644000004100000410000001440013252673043030647 0ustar www-datawww-data# 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 AbusiveexperiencereportV1 # Google Abusive Experience Report API # # View Abusive Experience Report data, and get a list of sites that have a # significant number of abusive experiences. # # @example # require 'google/apis/abusiveexperiencereport_v1' # # Abusiveexperiencereport = Google::Apis::AbusiveexperiencereportV1 # Alias the module # service = Abusiveexperiencereport::AbusiveExperienceReportService.new # # @see https://developers.google.com/abusive-experience-report/ class AbusiveExperienceReportService < 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://abusiveexperiencereport.googleapis.com/', '') @batch_path = 'batch' end # Gets a summary of the abusive experience rating of a site. # @param [String] name # The required site name. This is the site property whose abusive # experiences have been reviewed, and it must be URL-encoded. For example, # sites/https%3A%2F%2Fwww.google.com. The server will return an error of # BAD_REQUEST if this field is not filled in. Note that if the site property # is not yet verified in Search Console, the reportUrl field # returned by the API will lead to the verification page, prompting the user # to go through that process before they can gain access to the Abusive # Experience 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::AbusiveexperiencereportV1::SiteSummaryResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AbusiveexperiencereportV1::SiteSummaryResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AbusiveexperiencereportV1::SiteSummaryResponse::Representation command.response_class = Google::Apis::AbusiveexperiencereportV1::SiteSummaryResponse 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 sites with Abusive Experience Report statuses of "Failing". # @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::AbusiveexperiencereportV1::ViolatingSitesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AbusiveexperiencereportV1::ViolatingSitesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_violating_sites(fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/violatingSites', options) command.response_representation = Google::Apis::AbusiveexperiencereportV1::ViolatingSitesResponse::Representation command.response_class = Google::Apis::AbusiveexperiencereportV1::ViolatingSitesResponse 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 google-api-client-0.19.8/generated/google/apis/dataflow_v1b3.rb0000644000004100000410000000275713252673043024307 0ustar www-datawww-data# 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/dataflow_v1b3/service.rb' require 'google/apis/dataflow_v1b3/classes.rb' require 'google/apis/dataflow_v1b3/representations.rb' module Google module Apis # Google Dataflow API # # Manages Google Cloud Dataflow projects on Google Cloud Platform. # # @see https://cloud.google.com/dataflow module DataflowV1b3 VERSION = 'V1b3' REVISION = '20171222' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View and manage your Google Compute Engine resources AUTH_COMPUTE = 'https://www.googleapis.com/auth/compute' # View your Google Compute Engine resources AUTH_COMPUTE_READONLY = 'https://www.googleapis.com/auth/compute.readonly' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' end end end google-api-client-0.19.8/generated/google/apis/language_v1beta2.rb0000644000004100000410000000267713252673044024764 0ustar www-datawww-data# 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/language_v1beta2/service.rb' require 'google/apis/language_v1beta2/classes.rb' require 'google/apis/language_v1beta2/representations.rb' module Google module Apis # Google Cloud Natural Language API # # Provides natural language understanding technologies to developers. Examples # include sentiment analysis, entity recognition, entity sentiment analysis, and # text annotations. # # @see https://cloud.google.com/natural-language/ module LanguageV1beta2 VERSION = 'V1beta2' REVISION = '20171031' # Apply machine learning models to reveal the structure and meaning of text AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end google-api-client-0.19.8/generated/google/apis/datastore_v1beta1/0000755000004100000410000000000013252673043024624 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/datastore_v1beta1/representations.rb0000644000004100000410000002002113252673043030371 0ustar www-datawww-data# 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 DatastoreV1beta1 class GoogleDatastoreAdminV1beta1CommonMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1EntityFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1ExportEntitiesMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1ExportEntitiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1ExportEntitiesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1ImportEntitiesMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1ImportEntitiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1Progress 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 Status class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleDatastoreAdminV1beta1CommonMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime' hash :labels, as: 'labels' property :operation_type, as: 'operationType' property :start_time, as: 'startTime' property :state, as: 'state' end end class GoogleDatastoreAdminV1beta1EntityFilter # @private class Representation < Google::Apis::Core::JsonRepresentation collection :kinds, as: 'kinds' collection :namespace_ids, as: 'namespaceIds' end end class GoogleDatastoreAdminV1beta1ExportEntitiesMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1CommonMetadata, decorator: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1CommonMetadata::Representation property :entity_filter, as: 'entityFilter', class: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter, decorator: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter::Representation property :output_url_prefix, as: 'outputUrlPrefix' property :progress_bytes, as: 'progressBytes', class: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress, decorator: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress::Representation property :progress_entities, as: 'progressEntities', class: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress, decorator: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress::Representation end end class GoogleDatastoreAdminV1beta1ExportEntitiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :entity_filter, as: 'entityFilter', class: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter, decorator: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter::Representation hash :labels, as: 'labels' property :output_url_prefix, as: 'outputUrlPrefix' end end class GoogleDatastoreAdminV1beta1ExportEntitiesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :output_url, as: 'outputUrl' end end class GoogleDatastoreAdminV1beta1ImportEntitiesMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1CommonMetadata, decorator: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1CommonMetadata::Representation property :entity_filter, as: 'entityFilter', class: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter, decorator: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter::Representation property :input_url, as: 'inputUrl' property :progress_bytes, as: 'progressBytes', class: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress, decorator: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress::Representation property :progress_entities, as: 'progressEntities', class: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress, decorator: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress::Representation end end class GoogleDatastoreAdminV1beta1ImportEntitiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :entity_filter, as: 'entityFilter', class: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter, decorator: Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter::Representation property :input_url, as: 'inputUrl' hash :labels, as: 'labels' end end class GoogleDatastoreAdminV1beta1Progress # @private class Representation < Google::Apis::Core::JsonRepresentation property :work_completed, :numeric_string => true, as: 'workCompleted' property :work_estimated, :numeric_string => true, as: 'workEstimated' end end class GoogleLongrunningOperation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::DatastoreV1beta1::Status, decorator: Google::Apis::DatastoreV1beta1::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 end end end google-api-client-0.19.8/generated/google/apis/datastore_v1beta1/classes.rb0000644000004100000410000006361713252673043026623 0ustar www-datawww-data# 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 DatastoreV1beta1 # Metadata common to all Datastore Admin operations. class GoogleDatastoreAdminV1beta1CommonMetadata include Google::Apis::Core::Hashable # The time the operation ended, either successfully or otherwise. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # The client-assigned labels which were provided when the operation was # created. May also include additional labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The type of the operation. Can be used as a filter in # ListOperationsRequest. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # The time that work began on the operation. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # The current state of the Operation. # 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) @end_time = args[:end_time] if args.key?(:end_time) @labels = args[:labels] if args.key?(:labels) @operation_type = args[:operation_type] if args.key?(:operation_type) @start_time = args[:start_time] if args.key?(:start_time) @state = args[:state] if args.key?(:state) end end # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). # Example usage: # Entire project: # kinds=[], namespace_ids=[] # Kinds Foo and Bar in all namespaces: # kinds=['Foo', 'Bar'], namespace_ids=[] # Kinds Foo and Bar only in the default namespace: # kinds=['Foo', 'Bar'], namespace_ids=[''] # Kinds Foo and Bar in both the default and Baz namespaces: # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] # The entire Baz namespace: # kinds=[], namespace_ids=['Baz'] class GoogleDatastoreAdminV1beta1EntityFilter include Google::Apis::Core::Hashable # If empty, then this represents all kinds. # Corresponds to the JSON property `kinds` # @return [Array] attr_accessor :kinds # An empty list represents all namespaces. This is the preferred # usage for projects that don't use namespaces. # An empty string element represents the default namespace. This should be # used if the project has data in non-default namespaces, but doesn't want to # include them. # Each namespace in this list must be unique. # Corresponds to the JSON property `namespaceIds` # @return [Array] attr_accessor :namespace_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kinds = args[:kinds] if args.key?(:kinds) @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids) end end # Metadata for ExportEntities operations. class GoogleDatastoreAdminV1beta1ExportEntitiesMetadata include Google::Apis::Core::Hashable # Metadata common to all Datastore Admin operations. # Corresponds to the JSON property `common` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1CommonMetadata] attr_accessor :common # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). # Example usage: # Entire project: # kinds=[], namespace_ids=[] # Kinds Foo and Bar in all namespaces: # kinds=['Foo', 'Bar'], namespace_ids=[] # Kinds Foo and Bar only in the default namespace: # kinds=['Foo', 'Bar'], namespace_ids=[''] # Kinds Foo and Bar in both the default and Baz namespaces: # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] # The entire Baz namespace: # kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter # Location for the export metadata and data files. This will be the same # value as the # google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix # field. The final output location is provided in # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix # Measures the progress of a particular metric. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_bytes # Measures the progress of a particular metric. # Corresponds to the JSON property `progressEntities` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_entities def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @output_url_prefix = args[:output_url_prefix] if args.key?(:output_url_prefix) @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) @progress_entities = args[:progress_entities] if args.key?(:progress_entities) end end # The request for # google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1beta1ExportEntitiesRequest include Google::Apis::Core::Hashable # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). # Example usage: # Entire project: # kinds=[], namespace_ids=[] # Kinds Foo and Bar in all namespaces: # kinds=['Foo', 'Bar'], namespace_ids=[] # Kinds Foo and Bar only in the default namespace: # kinds=['Foo', 'Bar'], namespace_ids=[''] # Kinds Foo and Bar in both the default and Baz namespaces: # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] # The entire Baz namespace: # kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter # Client-assigned labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Location for the export metadata and data files. # The full resource URL of the external storage location. Currently, only # Google Cloud Storage is supported. So output_url_prefix should be of the # form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the # name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud # Storage namespace path (this is not a Cloud Datastore namespace). For more # information about Cloud Storage namespace paths, see # [Object name # considerations](https://cloud.google.com/storage/docs/naming#object- # considerations). # The resulting files will be nested deeper than the specified URL prefix. # The final output URL will be provided in the # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url # field. That value should be used for subsequent ImportEntities operations. # By nesting the data files deeper, the same Cloud Storage bucket can be used # in multiple ExportEntities operations without conflict. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @labels = args[:labels] if args.key?(:labels) @output_url_prefix = args[:output_url_prefix] if args.key?(:output_url_prefix) end end # The response for # google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1beta1ExportEntitiesResponse include Google::Apis::Core::Hashable # Location of the output metadata file. This can be used to begin an import # into Cloud Datastore (this project or another project). See # google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. # Only present if the operation completed successfully. # Corresponds to the JSON property `outputUrl` # @return [String] attr_accessor :output_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @output_url = args[:output_url] if args.key?(:output_url) end end # Metadata for ImportEntities operations. class GoogleDatastoreAdminV1beta1ImportEntitiesMetadata include Google::Apis::Core::Hashable # Metadata common to all Datastore Admin operations. # Corresponds to the JSON property `common` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1CommonMetadata] attr_accessor :common # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). # Example usage: # Entire project: # kinds=[], namespace_ids=[] # Kinds Foo and Bar in all namespaces: # kinds=['Foo', 'Bar'], namespace_ids=[] # Kinds Foo and Bar only in the default namespace: # kinds=['Foo', 'Bar'], namespace_ids=[''] # Kinds Foo and Bar in both the default and Baz namespaces: # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] # The entire Baz namespace: # kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter # The location of the import metadata file. This will be the same value as # the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url # field. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url # Measures the progress of a particular metric. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_bytes # Measures the progress of a particular metric. # Corresponds to the JSON property `progressEntities` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_entities def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @input_url = args[:input_url] if args.key?(:input_url) @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) @progress_entities = args[:progress_entities] if args.key?(:progress_entities) end end # The request for # google.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities. class GoogleDatastoreAdminV1beta1ImportEntitiesRequest include Google::Apis::Core::Hashable # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). # Example usage: # Entire project: # kinds=[], namespace_ids=[] # Kinds Foo and Bar in all namespaces: # kinds=['Foo', 'Bar'], namespace_ids=[] # Kinds Foo and Bar only in the default namespace: # kinds=['Foo', 'Bar'], namespace_ids=[''] # Kinds Foo and Bar in both the default and Baz namespaces: # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] # The entire Baz namespace: # kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter # The full resource URL of the external storage location. Currently, only # Google Cloud Storage is supported. So input_url should be of the form: # `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where # `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is # an optional Cloud Storage namespace path (this is not a Cloud Datastore # namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written # by the ExportEntities operation. For more information about Cloud Storage # namespace paths, see # [Object name # considerations](https://cloud.google.com/storage/docs/naming#object- # considerations). # For more information, see # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url # Client-assigned labels. # 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) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @input_url = args[:input_url] if args.key?(:input_url) @labels = args[:labels] if args.key?(:labels) end end # Measures the progress of a particular metric. class GoogleDatastoreAdminV1beta1Progress include Google::Apis::Core::Hashable # The amount of work that has been completed. Note that this may be greater # than work_estimated. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed # An estimate of how much work needs to be performed. May be zero if the # work estimate is unavailable. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @work_completed = args[:work_completed] if args.key?(:work_completed) @work_estimated = args[:work_estimated] if args.key?(:work_estimated) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::DatastoreV1beta1::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 have the format of `operations/some/unique/name`. # 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 google-api-client-0.19.8/generated/google/apis/datastore_v1beta1/service.rb0000644000004100000410000001707513252673043026623 0ustar www-datawww-data# 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 DatastoreV1beta1 # Google Cloud Datastore API # # Accesses the schemaless NoSQL database to provide fully managed, robust, # scalable storage for your application. # # @example # require 'google/apis/datastore_v1beta1' # # Datastore = Google::Apis::DatastoreV1beta1 # Alias the module # service = Datastore::DatastoreService.new # # @see https://cloud.google.com/datastore/ class DatastoreService < 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://datastore.googleapis.com/', '') @batch_path = 'batch' end # Exports a copy of all or a subset of entities from Google Cloud Datastore # to another storage system, such as Google Cloud Storage. Recent updates to # entities may not be reflected in the export. The export occurs in the # background and its progress can be monitored and managed via the # Operation resource that is created. The output of an export may only be # used once the associated operation is done. If an export operation is # cancelled before completion it may leave partial data behind in Google # Cloud Storage. # @param [String] project_id # Project ID against which to make the request. # @param [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1ExportEntitiesRequest] google_datastore_admin_v1beta1_export_entities_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::DatastoreV1beta1::GoogleLongrunningOperation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DatastoreV1beta1::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 export_project(project_id, google_datastore_admin_v1beta1_export_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}:export', options) command.request_representation = Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1ExportEntitiesRequest::Representation command.request_object = google_datastore_admin_v1beta1_export_entities_request_object command.response_representation = Google::Apis::DatastoreV1beta1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::DatastoreV1beta1::GoogleLongrunningOperation 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 # Imports entities into Google Cloud Datastore. Existing entities with the # same key are overwritten. The import occurs in the background and its # progress can be monitored and managed via the Operation resource that is # created. If an ImportEntities operation is cancelled, it is possible # that a subset of the data has already been imported to Cloud Datastore. # @param [String] project_id # Project ID against which to make the request. # @param [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1ImportEntitiesRequest] google_datastore_admin_v1beta1_import_entities_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::DatastoreV1beta1::GoogleLongrunningOperation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DatastoreV1beta1::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 import_project(project_id, google_datastore_admin_v1beta1_import_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}:import', options) command.request_representation = Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1ImportEntitiesRequest::Representation command.request_object = google_datastore_admin_v1beta1_import_entities_request_object command.response_representation = Google::Apis::DatastoreV1beta1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::DatastoreV1beta1::GoogleLongrunningOperation 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 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 google-api-client-0.19.8/generated/google/apis/content_v2.rb0000644000004100000410000000221513252673043023721 0ustar www-datawww-data# 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/content_v2/service.rb' require 'google/apis/content_v2/classes.rb' require 'google/apis/content_v2/representations.rb' module Google module Apis # Content API for Shopping # # Manages product items, inventory, and Merchant Center accounts for Google # Shopping. # # @see https://developers.google.com/shopping-content module ContentV2 VERSION = 'V2' REVISION = '20180122' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' end end end google-api-client-0.19.8/generated/google/apis/ml_v1.rb0000644000004100000410000000214613252673044022662 0ustar www-datawww-data# 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/ml_v1/service.rb' require 'google/apis/ml_v1/classes.rb' require 'google/apis/ml_v1/representations.rb' module Google module Apis # Google Cloud Machine Learning Engine # # An API to enable creating and using machine learning models. # # @see https://cloud.google.com/ml/ module MlV1 VERSION = 'V1' REVISION = '20180210' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end google-api-client-0.19.8/generated/google/apis/androidenterprise_v1/0000755000004100000410000000000013252673043025442 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/androidenterprise_v1/representations.rb0000644000004100000410000012241213252673043031216 0ustar www-datawww-data# 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 AndroidenterpriseV1 class Administrator class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdministratorWebToken class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdministratorWebTokenSpec class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AndroidDevicePolicyConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AppRestrictionsSchema class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AppRestrictionsSchemaChangeEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AppRestrictionsSchemaRestriction class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AppRestrictionsSchemaRestrictionRestrictionValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AppUpdateEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AppVersion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApprovalUrlInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthenticationToken class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConfigurationVariables class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Device class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeviceState class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDevicesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Enterprise class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EnterpriseAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListEnterprisesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SendTestPushNotificationResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Entitlement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListEntitlementsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GroupLicense class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListGroupLicenseUsersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListGroupLicensesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Install class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstallFailureEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListInstallsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LocalizedText class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedConfigurationsForDeviceListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedConfigurationsForUserListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedConfigurationsSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedConfigurationsSettingsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedProperty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedPropertyBundle class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NewDeviceEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NewPermissionsEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Notification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NotificationSet 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 Permission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Product class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductApprovalEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductAvailabilityChangeEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductPermission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductPermissions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductSigningCertificate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductVisibility class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApproveProductRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GenerateProductApprovalUrlResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceAccountKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceAccountKeysListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SignupInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StoreCluster class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StoreLayout class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StoreLayoutClustersListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StoreLayoutPagesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StorePage 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 User class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserToken class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListUsersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VariableSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Administrator # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' end end class AdministratorWebToken # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :token, as: 'token' end end class AdministratorWebTokenSpec # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :parent, as: 'parent' collection :permission, as: 'permission' end end class AndroidDevicePolicyConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :state, as: 'state' end end class AppRestrictionsSchema # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :restrictions, as: 'restrictions', class: Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaRestriction, decorator: Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaRestriction::Representation end end class AppRestrictionsSchemaChangeEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :product_id, as: 'productId' end end class AppRestrictionsSchemaRestriction # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_value, as: 'defaultValue', class: Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaRestrictionRestrictionValue, decorator: Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaRestrictionRestrictionValue::Representation property :description, as: 'description' collection :entry, as: 'entry' collection :entry_value, as: 'entryValue' property :key, as: 'key' collection :nested_restriction, as: 'nestedRestriction', class: Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaRestriction, decorator: Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaRestriction::Representation property :restriction_type, as: 'restrictionType' property :title, as: 'title' end end class AppRestrictionsSchemaRestrictionRestrictionValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' property :value_bool, as: 'valueBool' property :value_integer, as: 'valueInteger' collection :value_multiselect, as: 'valueMultiselect' property :value_string, as: 'valueString' end end class AppUpdateEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :product_id, as: 'productId' end end class AppVersion # @private class Representation < Google::Apis::Core::JsonRepresentation property :track, as: 'track' property :version_code, as: 'versionCode' property :version_string, as: 'versionString' end end class ApprovalUrlInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :approval_url, as: 'approvalUrl' property :kind, as: 'kind' end end class AuthenticationToken # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :token, as: 'token' end end class ConfigurationVariables # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :mcm_id, as: 'mcmId' collection :variable_set, as: 'variableSet', class: Google::Apis::AndroidenterpriseV1::VariableSet, decorator: Google::Apis::AndroidenterpriseV1::VariableSet::Representation end end class Device # @private class Representation < Google::Apis::Core::JsonRepresentation property :android_id, as: 'androidId' property :kind, as: 'kind' property :management_type, as: 'managementType' property :policy, as: 'policy', class: Google::Apis::AndroidenterpriseV1::Policy, decorator: Google::Apis::AndroidenterpriseV1::Policy::Representation end end class DeviceState # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_state, as: 'accountState' property :kind, as: 'kind' end end class ListDevicesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :device, as: 'device', class: Google::Apis::AndroidenterpriseV1::Device, decorator: Google::Apis::AndroidenterpriseV1::Device::Representation property :kind, as: 'kind' end end class Enterprise # @private class Representation < Google::Apis::Core::JsonRepresentation collection :administrator, as: 'administrator', class: Google::Apis::AndroidenterpriseV1::Administrator, decorator: Google::Apis::AndroidenterpriseV1::Administrator::Representation property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :primary_domain, as: 'primaryDomain' end end class EnterpriseAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_email, as: 'accountEmail' property :kind, as: 'kind' end end class ListEnterprisesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :enterprise, as: 'enterprise', class: Google::Apis::AndroidenterpriseV1::Enterprise, decorator: Google::Apis::AndroidenterpriseV1::Enterprise::Representation property :kind, as: 'kind' end end class SendTestPushNotificationResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :message_id, as: 'messageId' property :topic_name, as: 'topicName' end end class Entitlement # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :product_id, as: 'productId' property :reason, as: 'reason' end end class ListEntitlementsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entitlement, as: 'entitlement', class: Google::Apis::AndroidenterpriseV1::Entitlement, decorator: Google::Apis::AndroidenterpriseV1::Entitlement::Representation property :kind, as: 'kind' end end class GroupLicense # @private class Representation < Google::Apis::Core::JsonRepresentation property :acquisition_kind, as: 'acquisitionKind' property :approval, as: 'approval' property :kind, as: 'kind' property :num_provisioned, as: 'numProvisioned' property :num_purchased, as: 'numPurchased' property :permissions, as: 'permissions' property :product_id, as: 'productId' end end class ListGroupLicenseUsersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :user, as: 'user', class: Google::Apis::AndroidenterpriseV1::User, decorator: Google::Apis::AndroidenterpriseV1::User::Representation end end class ListGroupLicensesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :group_license, as: 'groupLicense', class: Google::Apis::AndroidenterpriseV1::GroupLicense, decorator: Google::Apis::AndroidenterpriseV1::GroupLicense::Representation property :kind, as: 'kind' end end class Install # @private class Representation < Google::Apis::Core::JsonRepresentation property :install_state, as: 'installState' property :kind, as: 'kind' property :product_id, as: 'productId' property :version_code, as: 'versionCode' end end class InstallFailureEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :device_id, as: 'deviceId' property :failure_details, as: 'failureDetails' property :failure_reason, as: 'failureReason' property :product_id, as: 'productId' property :user_id, as: 'userId' end end class ListInstallsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :install, as: 'install', class: Google::Apis::AndroidenterpriseV1::Install, decorator: Google::Apis::AndroidenterpriseV1::Install::Representation property :kind, as: 'kind' end end class LocalizedText # @private class Representation < Google::Apis::Core::JsonRepresentation property :locale, as: 'locale' property :text, as: 'text' end end class ManagedConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :configuration_variables, as: 'configurationVariables', class: Google::Apis::AndroidenterpriseV1::ConfigurationVariables, decorator: Google::Apis::AndroidenterpriseV1::ConfigurationVariables::Representation property :kind, as: 'kind' collection :managed_property, as: 'managedProperty', class: Google::Apis::AndroidenterpriseV1::ManagedProperty, decorator: Google::Apis::AndroidenterpriseV1::ManagedProperty::Representation property :product_id, as: 'productId' end end class ManagedConfigurationsForDeviceListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :managed_configuration_for_device, as: 'managedConfigurationForDevice', class: Google::Apis::AndroidenterpriseV1::ManagedConfiguration, decorator: Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation end end class ManagedConfigurationsForUserListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :managed_configuration_for_user, as: 'managedConfigurationForUser', class: Google::Apis::AndroidenterpriseV1::ManagedConfiguration, decorator: Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation end end class ManagedConfigurationsSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :last_updated_timestamp_millis, :numeric_string => true, as: 'lastUpdatedTimestampMillis' collection :managed_property, as: 'managedProperty', class: Google::Apis::AndroidenterpriseV1::ManagedProperty, decorator: Google::Apis::AndroidenterpriseV1::ManagedProperty::Representation property :mcm_id, as: 'mcmId' property :name, as: 'name' end end class ManagedConfigurationsSettingsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :managed_configurations_settings, as: 'managedConfigurationsSettings', class: Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettings, decorator: Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettings::Representation end end class ManagedProperty # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value_bool, as: 'valueBool' property :value_bundle, as: 'valueBundle', class: Google::Apis::AndroidenterpriseV1::ManagedPropertyBundle, decorator: Google::Apis::AndroidenterpriseV1::ManagedPropertyBundle::Representation collection :value_bundle_array, as: 'valueBundleArray', class: Google::Apis::AndroidenterpriseV1::ManagedPropertyBundle, decorator: Google::Apis::AndroidenterpriseV1::ManagedPropertyBundle::Representation property :value_integer, as: 'valueInteger' property :value_string, as: 'valueString' collection :value_string_array, as: 'valueStringArray' end end class ManagedPropertyBundle # @private class Representation < Google::Apis::Core::JsonRepresentation collection :managed_property, as: 'managedProperty', class: Google::Apis::AndroidenterpriseV1::ManagedProperty, decorator: Google::Apis::AndroidenterpriseV1::ManagedProperty::Representation end end class NewDeviceEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :device_id, as: 'deviceId' property :dpc_package_name, as: 'dpcPackageName' property :management_type, as: 'managementType' property :user_id, as: 'userId' end end class NewPermissionsEvent # @private class Representation < Google::Apis::Core::JsonRepresentation collection :approved_permissions, as: 'approvedPermissions' property :product_id, as: 'productId' collection :requested_permissions, as: 'requestedPermissions' end end class Notification # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_restrictions_schema_change_event, as: 'appRestrictionsSchemaChangeEvent', class: Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaChangeEvent, decorator: Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaChangeEvent::Representation property :app_update_event, as: 'appUpdateEvent', class: Google::Apis::AndroidenterpriseV1::AppUpdateEvent, decorator: Google::Apis::AndroidenterpriseV1::AppUpdateEvent::Representation property :enterprise_id, as: 'enterpriseId' property :install_failure_event, as: 'installFailureEvent', class: Google::Apis::AndroidenterpriseV1::InstallFailureEvent, decorator: Google::Apis::AndroidenterpriseV1::InstallFailureEvent::Representation property :new_device_event, as: 'newDeviceEvent', class: Google::Apis::AndroidenterpriseV1::NewDeviceEvent, decorator: Google::Apis::AndroidenterpriseV1::NewDeviceEvent::Representation property :new_permissions_event, as: 'newPermissionsEvent', class: Google::Apis::AndroidenterpriseV1::NewPermissionsEvent, decorator: Google::Apis::AndroidenterpriseV1::NewPermissionsEvent::Representation property :notification_type, as: 'notificationType' property :product_approval_event, as: 'productApprovalEvent', class: Google::Apis::AndroidenterpriseV1::ProductApprovalEvent, decorator: Google::Apis::AndroidenterpriseV1::ProductApprovalEvent::Representation property :product_availability_change_event, as: 'productAvailabilityChangeEvent', class: Google::Apis::AndroidenterpriseV1::ProductAvailabilityChangeEvent, decorator: Google::Apis::AndroidenterpriseV1::ProductAvailabilityChangeEvent::Representation property :timestamp_millis, :numeric_string => true, as: 'timestampMillis' end end class NotificationSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :notification, as: 'notification', class: Google::Apis::AndroidenterpriseV1::Notification, decorator: Google::Apis::AndroidenterpriseV1::Notification::Representation property :notification_set_id, as: 'notificationSetId' end end class PageInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :result_per_page, as: 'resultPerPage' property :start_index, as: 'startIndex' property :total_results, as: 'totalResults' end end class Permission # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :kind, as: 'kind' property :name, as: 'name' property :permission_id, as: 'permissionId' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation property :product_availability_policy, as: 'productAvailabilityPolicy' collection :product_policy, as: 'productPolicy', class: Google::Apis::AndroidenterpriseV1::ProductPolicy, decorator: Google::Apis::AndroidenterpriseV1::ProductPolicy::Representation end end class Product # @private class Representation < Google::Apis::Core::JsonRepresentation collection :app_version, as: 'appVersion', class: Google::Apis::AndroidenterpriseV1::AppVersion, decorator: Google::Apis::AndroidenterpriseV1::AppVersion::Representation property :author_name, as: 'authorName' collection :available_countries, as: 'availableCountries' collection :available_tracks, as: 'availableTracks' property :category, as: 'category' property :content_rating, as: 'contentRating' property :description, as: 'description' property :details_url, as: 'detailsUrl' property :distribution_channel, as: 'distributionChannel' property :icon_url, as: 'iconUrl' property :kind, as: 'kind' property :last_updated_timestamp_millis, :numeric_string => true, as: 'lastUpdatedTimestampMillis' property :min_android_sdk_version, as: 'minAndroidSdkVersion' collection :permissions, as: 'permissions', class: Google::Apis::AndroidenterpriseV1::ProductPermission, decorator: Google::Apis::AndroidenterpriseV1::ProductPermission::Representation property :product_id, as: 'productId' property :product_pricing, as: 'productPricing' property :recent_changes, as: 'recentChanges' property :requires_container_app, as: 'requiresContainerApp' collection :screenshot_urls, as: 'screenshotUrls' property :signing_certificate, as: 'signingCertificate', class: Google::Apis::AndroidenterpriseV1::ProductSigningCertificate, decorator: Google::Apis::AndroidenterpriseV1::ProductSigningCertificate::Representation property :small_icon_url, as: 'smallIconUrl' property :title, as: 'title' property :work_details_url, as: 'workDetailsUrl' end end class ProductApprovalEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :approved, as: 'approved' property :product_id, as: 'productId' end end class ProductAvailabilityChangeEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :availability_status, as: 'availabilityStatus' property :product_id, as: 'productId' end end class ProductPermission # @private class Representation < Google::Apis::Core::JsonRepresentation property :permission_id, as: 'permissionId' property :state, as: 'state' end end class ProductPermissions # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :permission, as: 'permission', class: Google::Apis::AndroidenterpriseV1::ProductPermission, decorator: Google::Apis::AndroidenterpriseV1::ProductPermission::Representation property :product_id, as: 'productId' end end class ProductPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :product_id, as: 'productId' collection :tracks, as: 'tracks' end end class ProductSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :product_id, as: 'productId' property :product_set_behavior, as: 'productSetBehavior' collection :product_visibility, as: 'productVisibility', class: Google::Apis::AndroidenterpriseV1::ProductVisibility, decorator: Google::Apis::AndroidenterpriseV1::ProductVisibility::Representation end end class ProductSigningCertificate # @private class Representation < Google::Apis::Core::JsonRepresentation property :certificate_hash_sha1, as: 'certificateHashSha1' property :certificate_hash_sha256, as: 'certificateHashSha256' end end class ProductVisibility # @private class Representation < Google::Apis::Core::JsonRepresentation property :product_id, as: 'productId' collection :tracks, as: 'tracks' end end class ApproveProductRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :approval_url_info, as: 'approvalUrlInfo', class: Google::Apis::AndroidenterpriseV1::ApprovalUrlInfo, decorator: Google::Apis::AndroidenterpriseV1::ApprovalUrlInfo::Representation property :approved_permissions, as: 'approvedPermissions' end end class GenerateProductApprovalUrlResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class ProductsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :page_info, as: 'pageInfo', class: Google::Apis::AndroidenterpriseV1::PageInfo, decorator: Google::Apis::AndroidenterpriseV1::PageInfo::Representation collection :product, as: 'product', class: Google::Apis::AndroidenterpriseV1::Product, decorator: Google::Apis::AndroidenterpriseV1::Product::Representation property :token_pagination, as: 'tokenPagination', class: Google::Apis::AndroidenterpriseV1::TokenPagination, decorator: Google::Apis::AndroidenterpriseV1::TokenPagination::Representation end end class ServiceAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key', class: Google::Apis::AndroidenterpriseV1::ServiceAccountKey, decorator: Google::Apis::AndroidenterpriseV1::ServiceAccountKey::Representation property :kind, as: 'kind' property :name, as: 'name' end end class ServiceAccountKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, as: 'data' property :id, as: 'id' property :kind, as: 'kind' property :public_data, as: 'publicData' property :type, as: 'type' end end class ServiceAccountKeysListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :service_account_key, as: 'serviceAccountKey', class: Google::Apis::AndroidenterpriseV1::ServiceAccountKey, decorator: Google::Apis::AndroidenterpriseV1::ServiceAccountKey::Representation end end class SignupInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :completion_token, as: 'completionToken' property :kind, as: 'kind' property :url, as: 'url' end end class StoreCluster # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' collection :name, as: 'name', class: Google::Apis::AndroidenterpriseV1::LocalizedText, decorator: Google::Apis::AndroidenterpriseV1::LocalizedText::Representation property :order_in_page, as: 'orderInPage' collection :product_id, as: 'productId' end end class StoreLayout # @private class Representation < Google::Apis::Core::JsonRepresentation property :homepage_id, as: 'homepageId' property :kind, as: 'kind' property :store_layout_type, as: 'storeLayoutType' end end class StoreLayoutClustersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :cluster, as: 'cluster', class: Google::Apis::AndroidenterpriseV1::StoreCluster, decorator: Google::Apis::AndroidenterpriseV1::StoreCluster::Representation property :kind, as: 'kind' end end class StoreLayoutPagesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :page, as: 'page', class: Google::Apis::AndroidenterpriseV1::StorePage, decorator: Google::Apis::AndroidenterpriseV1::StorePage::Representation end end class StorePage # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' collection :link, as: 'link' collection :name, as: 'name', class: Google::Apis::AndroidenterpriseV1::LocalizedText, decorator: Google::Apis::AndroidenterpriseV1::LocalizedText::Representation end end class TokenPagination # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' property :previous_page_token, as: 'previousPageToken' end end class User # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_identifier, as: 'accountIdentifier' property :account_type, as: 'accountType' property :display_name, as: 'displayName' property :id, as: 'id' property :kind, as: 'kind' property :management_type, as: 'managementType' property :primary_email, as: 'primaryEmail' end end class UserToken # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :token, as: 'token' property :user_id, as: 'userId' end end class ListUsersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :user, as: 'user', class: Google::Apis::AndroidenterpriseV1::User, decorator: Google::Apis::AndroidenterpriseV1::User::Representation end end class VariableSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :placeholder, as: 'placeholder' property :user_value, as: 'userValue' end end end end end google-api-client-0.19.8/generated/google/apis/androidenterprise_v1/classes.rb0000644000004100000410000033275213252673043027440 0ustar www-datawww-data# 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 AndroidenterpriseV1 # This represents an enterprise admin who can manage the enterprise in the # managed Google Play store. class Administrator include Google::Apis::Core::Hashable # The admin's email address. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) end end # A token authorizing an admin to access an iframe. class AdministratorWebToken include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#administratorWebToken". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # An opaque token to be passed to the Play front-end to generate an iframe. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @token = args[:token] if args.key?(:token) end end # Specification for a token used to generate iframes. The token specifies what # data the admin is allowed to modify and the URI the iframe is allowed to # communiate with. class AdministratorWebTokenSpec include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#administratorWebTokenSpec". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may # not be hosted at other URIs. This URI must be https. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent # The list of permissions the admin is granted within the iframe. The admin will # only be allowed to view an iframe if they have all of the permissions # associated with it. The only valid value is "approveApps" that will allow the # admin to access the iframe in "approve" mode. # Corresponds to the JSON property `permission` # @return [Array] attr_accessor :permission def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @parent = args[:parent] if args.key?(:parent) @permission = args[:permission] if args.key?(:permission) end end # The Android Device Policy configuration of an enterprise. class AndroidDevicePolicyConfig include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#androidDevicePolicyConfig". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The state of Android Device Policy. "enabled" indicates that Android Device # Policy is enabled for the enterprise and the EMM is allowed to manage devices # with Android Device Policy, while "disabled" means that it cannot. # 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) @kind = args[:kind] if args.key?(:kind) @state = args[:state] if args.key?(:state) end end # Represents the list of app restrictions available to be pre-configured for the # product. class AppRestrictionsSchema include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#appRestrictionsSchema". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The set of restrictions that make up this schema. # Corresponds to the JSON property `restrictions` # @return [Array] attr_accessor :restrictions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @restrictions = args[:restrictions] if args.key?(:restrictions) end end # An event generated when a new app version is uploaded to Google Play and its # app restrictions schema changed. To fetch the app restrictions schema for an # app, use Products.getAppRestrictionsSchema on the EMM API. class AppRestrictionsSchemaChangeEvent include Google::Apis::Core::Hashable # The id of the product (e.g. "app:com.google.android.gm") for which the app # restriction schema changed. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @product_id = args[:product_id] if args.key?(:product_id) end end # A restriction in the App Restriction Schema represents a piece of # configuration that may be pre-applied. class AppRestrictionsSchemaRestriction include Google::Apis::Core::Hashable # A typed value for the restriction. # Corresponds to the JSON property `defaultValue` # @return [Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaRestrictionRestrictionValue] attr_accessor :default_value # A longer description of the restriction, giving more detail of what it affects. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # For choice or multiselect restrictions, the list of possible entries' human- # readable names. # Corresponds to the JSON property `entry` # @return [Array] attr_accessor :entry # For choice or multiselect restrictions, the list of possible entries' machine- # readable values. These values should be used in the configuration, either as a # single string value for a choice restriction or in a stringArray for a # multiselect restriction. # Corresponds to the JSON property `entryValue` # @return [Array] attr_accessor :entry_value # The unique key that the product uses to identify the restriction, e.g. "com. # google.android.gm.fieldname". # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # For bundle or bundleArray restrictions, the list of nested restrictions. A # bundle restriction is always nested within a bundleArray restriction, and a # bundleArray restriction is at most two levels deep. # Corresponds to the JSON property `nestedRestriction` # @return [Array] attr_accessor :nested_restriction # The type of the restriction. # Corresponds to the JSON property `restrictionType` # @return [String] attr_accessor :restriction_type # The name of the restriction. # 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) @default_value = args[:default_value] if args.key?(:default_value) @description = args[:description] if args.key?(:description) @entry = args[:entry] if args.key?(:entry) @entry_value = args[:entry_value] if args.key?(:entry_value) @key = args[:key] if args.key?(:key) @nested_restriction = args[:nested_restriction] if args.key?(:nested_restriction) @restriction_type = args[:restriction_type] if args.key?(:restriction_type) @title = args[:title] if args.key?(:title) end end # A typed value for the restriction. class AppRestrictionsSchemaRestrictionRestrictionValue include Google::Apis::Core::Hashable # The type of the value being provided. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The boolean value - this will only be present if type is bool. # Corresponds to the JSON property `valueBool` # @return [Boolean] attr_accessor :value_bool alias_method :value_bool?, :value_bool # The integer value - this will only be present if type is integer. # Corresponds to the JSON property `valueInteger` # @return [Fixnum] attr_accessor :value_integer # The list of string values - this will only be present if type is multiselect. # Corresponds to the JSON property `valueMultiselect` # @return [Array] attr_accessor :value_multiselect # The string value - this will be present for types string, choice and hidden. # Corresponds to the JSON property `valueString` # @return [String] attr_accessor :value_string def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @type = args[:type] if args.key?(:type) @value_bool = args[:value_bool] if args.key?(:value_bool) @value_integer = args[:value_integer] if args.key?(:value_integer) @value_multiselect = args[:value_multiselect] if args.key?(:value_multiselect) @value_string = args[:value_string] if args.key?(:value_string) end end # An event generated when a new version of an app is uploaded to Google Play. # Notifications are sent for new public versions only: alpha, beta, or canary # versions do not generate this event. To fetch up-to-date version history for # an app, use Products.Get on the EMM API. class AppUpdateEvent include Google::Apis::Core::Hashable # The id of the product (e.g. "app:com.google.android.gm") that was updated. # This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @product_id = args[:product_id] if args.key?(:product_id) end end # This represents a single version of the app. class AppVersion include Google::Apis::Core::Hashable # The track that this app was published in. For example if track is "alpha", # this is an alpha version of the app. # Corresponds to the JSON property `track` # @return [String] attr_accessor :track # Unique increasing identifier for the app version. # Corresponds to the JSON property `versionCode` # @return [Fixnum] attr_accessor :version_code # The string used in the Play store by the app developer to identify the version. # The string is not necessarily unique or localized (for example, the string # could be "1.4"). # Corresponds to the JSON property `versionString` # @return [String] attr_accessor :version_string def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @track = args[:track] if args.key?(:track) @version_code = args[:version_code] if args.key?(:version_code) @version_string = args[:version_string] if args.key?(:version_string) end end # Information on an approval URL. class ApprovalUrlInfo include Google::Apis::Core::Hashable # A URL that displays a product's permissions and that can also be used to # approve the product with the Products.approve call. # Corresponds to the JSON property `approvalUrl` # @return [String] attr_accessor :approval_url # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#approvalUrlInfo". # 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) @approval_url = args[:approval_url] if args.key?(:approval_url) @kind = args[:kind] if args.key?(:kind) end end # An AuthenticationToken is used by the EMM's device policy client on a device # to provision the given EMM-managed user on that device. class AuthenticationToken include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#authenticationToken". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The authentication token to be passed to the device policy client on the # device where it can be used to provision the account for which this token was # generated. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @token = args[:token] if args.key?(:token) end end # A configuration variables resource contains the managed configuration settings # ID to be applied to a single user, as well as the variable set that is # attributed to the user. The variable set will be used to replace placeholders # in the managed configuration settings. class ConfigurationVariables include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#configurationVariables". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The ID of the managed configurations settings. # Corresponds to the JSON property `mcmId` # @return [String] attr_accessor :mcm_id # The variable set that is attributed to the user. # Corresponds to the JSON property `variableSet` # @return [Array] attr_accessor :variable_set def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @mcm_id = args[:mcm_id] if args.key?(:mcm_id) @variable_set = args[:variable_set] if args.key?(:variable_set) end end # A Devices resource represents a mobile device managed by the EMM and belonging # to a specific enterprise user. class Device include Google::Apis::Core::Hashable # The Google Play Services Android ID for the device encoded as a lowercase hex # string. For example, "123456789abcdef0". # Corresponds to the JSON property `androidId` # @return [String] attr_accessor :android_id # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#device". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Identifies the extent to which the device is controlled by a managed Google # Play EMM in various deployment configurations. # Possible values include: # - "managedDevice", a device that has the EMM's device policy controller (DPC) # as the device owner. # - "managedProfile", a device that has a profile managed by the DPC (DPC is # profile owner) in addition to a separate, personal profile that is unavailable # to the DPC. # - "containerApp", no longer used (deprecated). # - "unmanagedProfile", a device that has been allowed (by the domain's admin, # using the Admin Console to enable the privilege) to use managed Google Play, # but the profile is itself not owned by a DPC. # Corresponds to the JSON property `managementType` # @return [String] attr_accessor :management_type # The device policy for a given managed device. # Corresponds to the JSON property `policy` # @return [Google::Apis::AndroidenterpriseV1::Policy] attr_accessor :policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @android_id = args[:android_id] if args.key?(:android_id) @kind = args[:kind] if args.key?(:kind) @management_type = args[:management_type] if args.key?(:management_type) @policy = args[:policy] if args.key?(:policy) end end # The state of a user's device, as accessed by the getState and setState methods # on device resources. class DeviceState include Google::Apis::Core::Hashable # The state of the Google account on the device. "enabled" indicates that the # Google account on the device can be used to access Google services (including # Google Play), while "disabled" means that it cannot. A new device is initially # in the "disabled" state. # Corresponds to the JSON property `accountState` # @return [String] attr_accessor :account_state # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#deviceState". # 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) @account_state = args[:account_state] if args.key?(:account_state) @kind = args[:kind] if args.key?(:kind) end end # The device resources for the user. class ListDevicesResponse include Google::Apis::Core::Hashable # A managed device. # Corresponds to the JSON property `device` # @return [Array] attr_accessor :device # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#devicesListResponse". # 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) @device = args[:device] if args.key?(:device) @kind = args[:kind] if args.key?(:kind) end end # An Enterprises resource represents the binding between an EMM and a specific # organization. That binding can be instantiated in one of two different ways # using this API as follows: # - For Google managed domain customers, the process involves using Enterprises. # enroll and Enterprises.setAccount (in conjunction with artifacts obtained from # the Admin console and the Google API Console) and submitted to the EMM through # a more-or-less manual process. # - For managed Google Play Accounts customers, the process involves using # Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction # with the managed Google Play sign-up UI (Google-provided mechanism) to create # the binding without manual steps. As an EMM, you can support either or both # approaches in your EMM console. See Create an Enterprise for details. class Enterprise include Google::Apis::Core::Hashable # Admins of the enterprise. This is only supported for enterprises created via # the EMM-initiated flow. # Corresponds to the JSON property `administrator` # @return [Array] attr_accessor :administrator # The unique ID for the enterprise. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#enterprise". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the enterprise, for example, "Example, Inc". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The enterprise's primary domain, such as "example.com". # Corresponds to the JSON property `primaryDomain` # @return [String] attr_accessor :primary_domain def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @administrator = args[:administrator] if args.key?(:administrator) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @primary_domain = args[:primary_domain] if args.key?(:primary_domain) end end # A service account that can be used to authenticate as the enterprise to API # calls that require such authentication. class EnterpriseAccount include Google::Apis::Core::Hashable # The email address of the service account. # Corresponds to the JSON property `accountEmail` # @return [String] attr_accessor :account_email # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#enterpriseAccount". # 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) @account_email = args[:account_email] if args.key?(:account_email) @kind = args[:kind] if args.key?(:kind) end end # The matching enterprise resources. class ListEnterprisesResponse include Google::Apis::Core::Hashable # An enterprise. # Corresponds to the JSON property `enterprise` # @return [Array] attr_accessor :enterprise # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#enterprisesListResponse". # 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) @enterprise = args[:enterprise] if args.key?(:enterprise) @kind = args[:kind] if args.key?(:kind) end end # class SendTestPushNotificationResponse include Google::Apis::Core::Hashable # The message ID of the test push notification that was sent. # Corresponds to the JSON property `messageId` # @return [String] attr_accessor :message_id # The name of the Cloud Pub/Sub topic to which notifications for this enterprise' # s enrolled account will be sent. # Corresponds to the JSON property `topicName` # @return [String] attr_accessor :topic_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @message_id = args[:message_id] if args.key?(:message_id) @topic_name = args[:topic_name] if args.key?(:topic_name) end end # The presence of an Entitlements resource indicates that a user has the right # to use a particular app. Entitlements are user specific, not device specific. # This allows a user with an entitlement to an app to install the app on all # their devices. It's also possible for a user to hold an entitlement to an app # without installing the app on any device. # The API can be used to create an entitlement. As an option, you can also use # the API to trigger the installation of an app on all a user's managed devices # at the same time the entitlement is created. # If the app is free, creating the entitlement also creates a group license for # that app. For paid apps, creating the entitlement consumes one license, and # that license remains consumed until the entitlement is removed. If the # enterprise hasn't purchased enough licenses, then no entitlement is created # and the installation fails. An entitlement is also not created for an app if # the app requires permissions that the enterprise hasn't accepted. # If an entitlement is deleted, the app may be uninstalled from a user's device. # As a best practice, uninstall the app by calling Installs.delete() before # deleting the entitlement. # Entitlements for apps that a user pays for on an unmanaged profile have " # userPurchase" as the entitlement reason. These entitlements cannot be removed # via the API. class Entitlement include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#entitlement". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The ID of the product that the entitlement is for. For example, "app:com. # google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The reason for the entitlement. For example, "free" for free apps. This # property is temporary: it will be replaced by the acquisition kind field of # group licenses. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @product_id = args[:product_id] if args.key?(:product_id) @reason = args[:reason] if args.key?(:reason) end end # The entitlement resources for the user. class ListEntitlementsResponse include Google::Apis::Core::Hashable # An entitlement of a user to a product (e.g. an app). For example, a free app # that they have installed, or a paid app that they have been allocated a # license to. # Corresponds to the JSON property `entitlement` # @return [Array] attr_accessor :entitlement # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#entitlementsListResponse". # 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) @entitlement = args[:entitlement] if args.key?(:entitlement) @kind = args[:kind] if args.key?(:kind) end end # Group license objects allow you to keep track of licenses (called entitlements) # for both free and paid apps. For a free app, a group license is created when # an enterprise admin first approves the product in Google Play or when the # first entitlement for the product is created for a user via the API. For a # paid app, a group license object is only created when an enterprise admin # purchases the product in Google Play for the first time. # Use the API to query group licenses. A Grouplicenses resource includes the # total number of licenses purchased (paid apps only) and the total number of # licenses currently in use. In other words, the total number of Entitlements # that exist for the product. # Only one group license object is created per product and group license objects # are never deleted. If a product is unapproved, its group license remains. This # allows enterprise admins to keep track of any remaining entitlements for the # product. class GroupLicense include Google::Apis::Core::Hashable # How this group license was acquired. "bulkPurchase" means that this # Grouplicenses resource was created because the enterprise purchased licenses # for this product; otherwise, the value is "free" (for free products). # Corresponds to the JSON property `acquisitionKind` # @return [String] attr_accessor :acquisition_kind # Whether the product to which this group license relates is currently approved # by the enterprise. Products are approved when a group license is first created, # but this approval may be revoked by an enterprise admin via Google Play. # Unapproved products will not be visible to end users in collections, and new # entitlements to them should not normally be created. # Corresponds to the JSON property `approval` # @return [String] attr_accessor :approval # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#groupLicense". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The total number of provisioned licenses for this product. Returned by read # operations, but ignored in write operations. # Corresponds to the JSON property `numProvisioned` # @return [Fixnum] attr_accessor :num_provisioned # The number of purchased licenses (possibly in multiple purchases). If this # field is omitted, then there is no limit on the number of licenses that can be # provisioned (for example, if the acquisition kind is "free"). # Corresponds to the JSON property `numPurchased` # @return [Fixnum] attr_accessor :num_purchased # The permission approval status of the product. This field is only set if the # product is approved. Possible states are: # - "currentApproved", the current set of permissions is approved, but # additional permissions will require the administrator to reapprove the product # (If the product was approved without specifying the approved permissions # setting, then this is the default behavior.), # - "needsReapproval", the product has unapproved permissions. No additional # product licenses can be assigned until the product is reapproved, # - "allCurrentAndFutureApproved", the current permissions are approved and any # future permission updates will be automatically approved without administrator # review. # Corresponds to the JSON property `permissions` # @return [String] attr_accessor :permissions # The ID of the product that the license is for. For example, "app:com.google. # android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @acquisition_kind = args[:acquisition_kind] if args.key?(:acquisition_kind) @approval = args[:approval] if args.key?(:approval) @kind = args[:kind] if args.key?(:kind) @num_provisioned = args[:num_provisioned] if args.key?(:num_provisioned) @num_purchased = args[:num_purchased] if args.key?(:num_purchased) @permissions = args[:permissions] if args.key?(:permissions) @product_id = args[:product_id] if args.key?(:product_id) end end # The user resources for the group license. class ListGroupLicenseUsersResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#groupLicenseUsersListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A user of an enterprise. # Corresponds to the JSON property `user` # @return [Array] attr_accessor :user def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @user = args[:user] if args.key?(:user) end end # The grouplicense resources for the enterprise. class ListGroupLicensesResponse include Google::Apis::Core::Hashable # A group license for a product approved for use in the enterprise. # Corresponds to the JSON property `groupLicense` # @return [Array] attr_accessor :group_license # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#groupLicensesListResponse". # 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) @group_license = args[:group_license] if args.key?(:group_license) @kind = args[:kind] if args.key?(:kind) end end # The existence of an Installs resource indicates that an app is installed on a # particular device (or that an install is pending). # The API can be used to create an install resource using the update method. # This triggers the actual install of the app on the device. If the user does # not already have an entitlement for the app, then an attempt is made to create # one. If this fails (for example, because the app is not free and there is no # available license), then the creation of the install fails. # The API can also be used to update an installed app. If the update method is # used on an existing install, then the app will be updated to the latest # available version. # Note that it is not possible to force the installation of a specific version # of an app: the version code is read-only. # If a user installs an app themselves (as permitted by the enterprise), then # again an install resource and possibly an entitlement resource are # automatically created. # The API can also be used to delete an install resource, which triggers the # removal of the app from the device. Note that deleting an install does not # automatically remove the corresponding entitlement, even if there are no # remaining installs. The install resource will also be deleted if the user # uninstalls the app themselves. class Install include Google::Apis::Core::Hashable # Install state. The state "installPending" means that an install request has # recently been made and download to the device is in progress. The state " # installed" means that the app has been installed. This field is read-only. # Corresponds to the JSON property `installState` # @return [String] attr_accessor :install_state # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#install". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The ID of the product that the install is for. For example, "app:com.google. # android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The version of the installed product. Guaranteed to be set only if the install # state is "installed". # 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) @install_state = args[:install_state] if args.key?(:install_state) @kind = args[:kind] if args.key?(:kind) @product_id = args[:product_id] if args.key?(:product_id) @version_code = args[:version_code] if args.key?(:version_code) end end # An event generated when an app installation failed on a device class InstallFailureEvent include Google::Apis::Core::Hashable # The Android ID of the device. This field will always be present. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id # Additional details on the failure if applicable. # Corresponds to the JSON property `failureDetails` # @return [String] attr_accessor :failure_details # The reason for the installation failure. This field will always be present. # Corresponds to the JSON property `failureReason` # @return [String] attr_accessor :failure_reason # The id of the product (e.g. "app:com.google.android.gm") for which the install # failure event occured. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The ID of the user. This field will always be present. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @device_id = args[:device_id] if args.key?(:device_id) @failure_details = args[:failure_details] if args.key?(:failure_details) @failure_reason = args[:failure_reason] if args.key?(:failure_reason) @product_id = args[:product_id] if args.key?(:product_id) @user_id = args[:user_id] if args.key?(:user_id) end end # The install resources for the device. class ListInstallsResponse include Google::Apis::Core::Hashable # An installation of an app for a user on a specific device. The existence of an # install implies that the user must have an entitlement to the app. # Corresponds to the JSON property `install` # @return [Array] attr_accessor :install # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#installsListResponse". # 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) @install = args[:install] if args.key?(:install) @kind = args[:kind] if args.key?(:kind) end end # A localized string with its locale. class LocalizedText include Google::Apis::Core::Hashable # The BCP47 tag for a locale. (e.g. "en-US", "de"). # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # The text localized in the associated locale. # 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) @locale = args[:locale] if args.key?(:locale) @text = args[:text] if args.key?(:text) end end # A managed configuration resource contains the set of managed properties # defined by the app developer in the app's managed configurations schema, as # well as any configuration variables defined for the user. class ManagedConfiguration include Google::Apis::Core::Hashable # A configuration variables resource contains the managed configuration settings # ID to be applied to a single user, as well as the variable set that is # attributed to the user. The variable set will be used to replace placeholders # in the managed configuration settings. # Corresponds to the JSON property `configurationVariables` # @return [Google::Apis::AndroidenterpriseV1::ConfigurationVariables] attr_accessor :configuration_variables # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#managedConfiguration". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The set of managed properties for this configuration. # Corresponds to the JSON property `managedProperty` # @return [Array] attr_accessor :managed_property # The ID of the product that the managed configuration is for, e.g. "app:com. # google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @configuration_variables = args[:configuration_variables] if args.key?(:configuration_variables) @kind = args[:kind] if args.key?(:kind) @managed_property = args[:managed_property] if args.key?(:managed_property) @product_id = args[:product_id] if args.key?(:product_id) end end # The managed configuration resources for the device. class ManagedConfigurationsForDeviceListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#managedConfigurationsForDeviceListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A managed configuration for an app on a specific device. # Corresponds to the JSON property `managedConfigurationForDevice` # @return [Array] attr_accessor :managed_configuration_for_device def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @managed_configuration_for_device = args[:managed_configuration_for_device] if args.key?(:managed_configuration_for_device) end end # The managed configuration resources for the user. class ManagedConfigurationsForUserListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#managedConfigurationsForUserListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A managed configuration for an app for a specific user. # Corresponds to the JSON property `managedConfigurationForUser` # @return [Array] attr_accessor :managed_configuration_for_user def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @managed_configuration_for_user = args[:managed_configuration_for_user] if args.key?(:managed_configuration_for_user) end end # A managed configurations settings resource contains the set of managed # properties that have been configured for an Android app to be applied to a set # of users. The app's developer would have defined configurable properties in # the managed configurations schema. class ManagedConfigurationsSettings include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#managedConfigurationsSettings". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The last updated time of the managed configuration settings in milliseconds # since 1970-01-01T00:00:00Z. # Corresponds to the JSON property `lastUpdatedTimestampMillis` # @return [Fixnum] attr_accessor :last_updated_timestamp_millis # The set of managed properties for this configuration. # Corresponds to the JSON property `managedProperty` # @return [Array] attr_accessor :managed_property # The ID of the managed configurations settings. # Corresponds to the JSON property `mcmId` # @return [String] attr_accessor :mcm_id # The name of the managed configurations settings. # 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) @kind = args[:kind] if args.key?(:kind) @last_updated_timestamp_millis = args[:last_updated_timestamp_millis] if args.key?(:last_updated_timestamp_millis) @managed_property = args[:managed_property] if args.key?(:managed_property) @mcm_id = args[:mcm_id] if args.key?(:mcm_id) @name = args[:name] if args.key?(:name) end end # The managed configurations settings for a product. class ManagedConfigurationsSettingsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#managedConfigurationsSettingsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A managed configurations settings for an app that may be assigned to a group # of users in an enterprise. # Corresponds to the JSON property `managedConfigurationsSettings` # @return [Array] attr_accessor :managed_configurations_settings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @managed_configurations_settings = args[:managed_configurations_settings] if args.key?(:managed_configurations_settings) end end # A managed property of a managed configuration. The property must match one of # the properties in the app restrictions schema of the product. Exactly one of # the value fields must be populated, and it must match the property's type in # the app restrictions schema. class ManagedProperty include Google::Apis::Core::Hashable # The unique key that identifies the property. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # The boolean value - this will only be present if type of the property is bool. # Corresponds to the JSON property `valueBool` # @return [Boolean] attr_accessor :value_bool alias_method :value_bool?, :value_bool # A bundle of managed properties. # Corresponds to the JSON property `valueBundle` # @return [Google::Apis::AndroidenterpriseV1::ManagedPropertyBundle] attr_accessor :value_bundle # The list of bundles of properties - this will only be present if type of the # property is bundle_array. # Corresponds to the JSON property `valueBundleArray` # @return [Array] attr_accessor :value_bundle_array # The integer value - this will only be present if type of the property is # integer. # Corresponds to the JSON property `valueInteger` # @return [Fixnum] attr_accessor :value_integer # The string value - this will only be present if type of the property is string, # choice or hidden. # Corresponds to the JSON property `valueString` # @return [String] attr_accessor :value_string # The list of string values - this will only be present if type of the property # is multiselect. # Corresponds to the JSON property `valueStringArray` # @return [Array] attr_accessor :value_string_array def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key = args[:key] if args.key?(:key) @value_bool = args[:value_bool] if args.key?(:value_bool) @value_bundle = args[:value_bundle] if args.key?(:value_bundle) @value_bundle_array = args[:value_bundle_array] if args.key?(:value_bundle_array) @value_integer = args[:value_integer] if args.key?(:value_integer) @value_string = args[:value_string] if args.key?(:value_string) @value_string_array = args[:value_string_array] if args.key?(:value_string_array) end end # A bundle of managed properties. class ManagedPropertyBundle include Google::Apis::Core::Hashable # The list of managed properties. # Corresponds to the JSON property `managedProperty` # @return [Array] attr_accessor :managed_property def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @managed_property = args[:managed_property] if args.key?(:managed_property) end end # An event generated when a new device is ready to be managed. class NewDeviceEvent include Google::Apis::Core::Hashable # The Android ID of the device. This field will always be present. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id # Policy app on the device. # Corresponds to the JSON property `dpcPackageName` # @return [String] attr_accessor :dpc_package_name # Identifies the extent to which the device is controlled by an Android EMM in # various deployment configurations. # Possible values include: # - "managedDevice", a device where the DPC is set as device owner, # - "managedProfile", a device where the DPC is set as profile owner. # Corresponds to the JSON property `managementType` # @return [String] attr_accessor :management_type # The ID of the user. This field will always be present. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @device_id = args[:device_id] if args.key?(:device_id) @dpc_package_name = args[:dpc_package_name] if args.key?(:dpc_package_name) @management_type = args[:management_type] if args.key?(:management_type) @user_id = args[:user_id] if args.key?(:user_id) end end # An event generated when new permissions are added to an app. class NewPermissionsEvent include Google::Apis::Core::Hashable # The set of permissions that the enterprise admin has already approved for this # application. Use Permissions.Get on the EMM API to retrieve details about # these permissions. # Corresponds to the JSON property `approvedPermissions` # @return [Array] attr_accessor :approved_permissions # The id of the product (e.g. "app:com.google.android.gm") for which new # permissions were added. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The set of permissions that the app is currently requesting. Use Permissions. # Get on the EMM API to retrieve details about these permissions. # Corresponds to the JSON property `requestedPermissions` # @return [Array] attr_accessor :requested_permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @approved_permissions = args[:approved_permissions] if args.key?(:approved_permissions) @product_id = args[:product_id] if args.key?(:product_id) @requested_permissions = args[:requested_permissions] if args.key?(:requested_permissions) end end # A notification of one event relating to an enterprise. class Notification include Google::Apis::Core::Hashable # An event generated when a new app version is uploaded to Google Play and its # app restrictions schema changed. To fetch the app restrictions schema for an # app, use Products.getAppRestrictionsSchema on the EMM API. # Corresponds to the JSON property `appRestrictionsSchemaChangeEvent` # @return [Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaChangeEvent] attr_accessor :app_restrictions_schema_change_event # An event generated when a new version of an app is uploaded to Google Play. # Notifications are sent for new public versions only: alpha, beta, or canary # versions do not generate this event. To fetch up-to-date version history for # an app, use Products.Get on the EMM API. # Corresponds to the JSON property `appUpdateEvent` # @return [Google::Apis::AndroidenterpriseV1::AppUpdateEvent] attr_accessor :app_update_event # The ID of the enterprise for which the notification is sent. This will always # be present. # Corresponds to the JSON property `enterpriseId` # @return [String] attr_accessor :enterprise_id # An event generated when an app installation failed on a device # Corresponds to the JSON property `installFailureEvent` # @return [Google::Apis::AndroidenterpriseV1::InstallFailureEvent] attr_accessor :install_failure_event # An event generated when a new device is ready to be managed. # Corresponds to the JSON property `newDeviceEvent` # @return [Google::Apis::AndroidenterpriseV1::NewDeviceEvent] attr_accessor :new_device_event # An event generated when new permissions are added to an app. # Corresponds to the JSON property `newPermissionsEvent` # @return [Google::Apis::AndroidenterpriseV1::NewPermissionsEvent] attr_accessor :new_permissions_event # Type of the notification. # Corresponds to the JSON property `notificationType` # @return [String] attr_accessor :notification_type # An event generated when a product's approval status is changed. # Corresponds to the JSON property `productApprovalEvent` # @return [Google::Apis::AndroidenterpriseV1::ProductApprovalEvent] attr_accessor :product_approval_event # An event generated whenever a product's availability changes. # Corresponds to the JSON property `productAvailabilityChangeEvent` # @return [Google::Apis::AndroidenterpriseV1::ProductAvailabilityChangeEvent] attr_accessor :product_availability_change_event # The time when the notification was published in milliseconds since 1970-01- # 01T00:00:00Z. This will always be present. # Corresponds to the JSON property `timestampMillis` # @return [Fixnum] attr_accessor :timestamp_millis def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @app_restrictions_schema_change_event = args[:app_restrictions_schema_change_event] if args.key?(:app_restrictions_schema_change_event) @app_update_event = args[:app_update_event] if args.key?(:app_update_event) @enterprise_id = args[:enterprise_id] if args.key?(:enterprise_id) @install_failure_event = args[:install_failure_event] if args.key?(:install_failure_event) @new_device_event = args[:new_device_event] if args.key?(:new_device_event) @new_permissions_event = args[:new_permissions_event] if args.key?(:new_permissions_event) @notification_type = args[:notification_type] if args.key?(:notification_type) @product_approval_event = args[:product_approval_event] if args.key?(:product_approval_event) @product_availability_change_event = args[:product_availability_change_event] if args.key?(:product_availability_change_event) @timestamp_millis = args[:timestamp_millis] if args.key?(:timestamp_millis) end end # A resource returned by the PullNotificationSet API, which contains a # collection of notifications for enterprises associated with the service # account authenticated for the request. class NotificationSet include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#notificationSet". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The notifications received, or empty if no notifications are present. # Corresponds to the JSON property `notification` # @return [Array] attr_accessor :notification # The notification set ID, required to mark the notification as received with # the Enterprises.AcknowledgeNotification API. This will be omitted if no # notifications are present. # Corresponds to the JSON property `notificationSetId` # @return [String] attr_accessor :notification_set_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @notification = args[:notification] if args.key?(:notification) @notification_set_id = args[:notification_set_id] if args.key?(:notification_set_id) end end # class PageInfo include Google::Apis::Core::Hashable # # Corresponds to the JSON property `resultPerPage` # @return [Fixnum] attr_accessor :result_per_page # # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @result_per_page = args[:result_per_page] if args.key?(:result_per_page) @start_index = args[:start_index] if args.key?(:start_index) @total_results = args[:total_results] if args.key?(:total_results) end end # A Permissions resource represents some extra capability, to be granted to an # Android app, which requires explicit consent. An enterprise admin must consent # to these permissions on behalf of their users before an entitlement for the # app can be created. # The permissions collection is read-only. The information provided for each # permission (localized name and description) is intended to be used in the MDM # user interface when obtaining consent from the enterprise. class Permission include Google::Apis::Core::Hashable # A longer description of the Permissions resource, giving more details of what # it affects. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#permission". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the permission. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An opaque string uniquely identifying the permission. # Corresponds to the JSON property `permissionId` # @return [String] attr_accessor :permission_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @permission_id = args[:permission_id] if args.key?(:permission_id) end end # The device policy for a given managed device. class Policy include Google::Apis::Core::Hashable # The availability granted to the device for the specified products. "all" gives # the device access to all products, regardless of approval status. "allApproved" # entitles the device to access all products that are approved for the # enterprise. "allApproved" and "all" do not enable automatic visibility of " # alpha" or "beta" tracks. "whitelist" grants the device access the products # specified in productPolicy[]. Only products that are approved or products that # were previously approved (products with revoked approval) by the enterprise # can be whitelisted. If no value is provided, the availability set at the user # level is applied by default. # Corresponds to the JSON property `productAvailabilityPolicy` # @return [String] attr_accessor :product_availability_policy # The list of product policies. # Corresponds to the JSON property `productPolicy` # @return [Array] attr_accessor :product_policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @product_availability_policy = args[:product_availability_policy] if args.key?(:product_availability_policy) @product_policy = args[:product_policy] if args.key?(:product_policy) end end # A Products resource represents an app in the Google Play store that is # available to at least some users in the enterprise. (Some apps are restricted # to a single enterprise, and no information about them is made available # outside that enterprise.) # The information provided for each product (localized name, icon, link to the # full Google Play details page) is intended to allow a basic representation of # the product within an EMM user interface. class Product include Google::Apis::Core::Hashable # App versions currently available for this product. # Corresponds to the JSON property `appVersion` # @return [Array] attr_accessor :app_version # The name of the author of the product (for example, the app developer). # Corresponds to the JSON property `authorName` # @return [String] attr_accessor :author_name # The countries which this app is available in. # Corresponds to the JSON property `availableCountries` # @return [Array] attr_accessor :available_countries # The tracks that are visible to the enterprise. # Corresponds to the JSON property `availableTracks` # @return [Array] attr_accessor :available_tracks # The app category (e.g. RACING, SOCIAL, etc.) # Corresponds to the JSON property `category` # @return [String] attr_accessor :category # The content rating for this app. # Corresponds to the JSON property `contentRating` # @return [String] attr_accessor :content_rating # The localized promotional description, if available. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # A link to the (consumer) Google Play details page for the product. # Corresponds to the JSON property `detailsUrl` # @return [String] attr_accessor :details_url # How and to whom the package is made available. The value publicGoogleHosted # means that the package is available through the Play store and not restricted # to a specific enterprise. The value privateGoogleHosted means that the package # is a private app (restricted to an enterprise) but hosted by Google. The value # privateSelfHosted means that the package is a private app (restricted to an # enterprise) and is privately hosted. # Corresponds to the JSON property `distributionChannel` # @return [String] attr_accessor :distribution_channel # A link to an image that can be used as an icon for the product. This image is # suitable for use at up to 512px x 512px. # Corresponds to the JSON property `iconUrl` # @return [String] attr_accessor :icon_url # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#product". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The approximate time (within 7 days) the app was last published, expressed in # milliseconds since epoch. # Corresponds to the JSON property `lastUpdatedTimestampMillis` # @return [Fixnum] attr_accessor :last_updated_timestamp_millis # The minimum Android SDK necessary to run the app. # Corresponds to the JSON property `minAndroidSdkVersion` # @return [Fixnum] attr_accessor :min_android_sdk_version # A list of permissions required by the app. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions # A string of the form app:. For example, app:com.google.android. # gm represents the Gmail app. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Whether this product is free, free with in-app purchases, or paid. If the # pricing is unknown, this means the product is not generally available anymore ( # even though it might still be available to people who own it). # Corresponds to the JSON property `productPricing` # @return [String] attr_accessor :product_pricing # A description of the recent changes made to the app. # Corresponds to the JSON property `recentChanges` # @return [String] attr_accessor :recent_changes # Deprecated. # Corresponds to the JSON property `requiresContainerApp` # @return [Boolean] attr_accessor :requires_container_app alias_method :requires_container_app?, :requires_container_app # A list of screenshot links representing the app. # Corresponds to the JSON property `screenshotUrls` # @return [Array] attr_accessor :screenshot_urls # The certificate used to sign this product. # Corresponds to the JSON property `signingCertificate` # @return [Google::Apis::AndroidenterpriseV1::ProductSigningCertificate] attr_accessor :signing_certificate # A link to a smaller image that can be used as an icon for the product. This # image is suitable for use at up to 128px x 128px. # Corresponds to the JSON property `smallIconUrl` # @return [String] attr_accessor :small_icon_url # The name of the product. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # A link to the managed Google Play details page for the product, for use by an # Enterprise admin. # Corresponds to the JSON property `workDetailsUrl` # @return [String] attr_accessor :work_details_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @app_version = args[:app_version] if args.key?(:app_version) @author_name = args[:author_name] if args.key?(:author_name) @available_countries = args[:available_countries] if args.key?(:available_countries) @available_tracks = args[:available_tracks] if args.key?(:available_tracks) @category = args[:category] if args.key?(:category) @content_rating = args[:content_rating] if args.key?(:content_rating) @description = args[:description] if args.key?(:description) @details_url = args[:details_url] if args.key?(:details_url) @distribution_channel = args[:distribution_channel] if args.key?(:distribution_channel) @icon_url = args[:icon_url] if args.key?(:icon_url) @kind = args[:kind] if args.key?(:kind) @last_updated_timestamp_millis = args[:last_updated_timestamp_millis] if args.key?(:last_updated_timestamp_millis) @min_android_sdk_version = args[:min_android_sdk_version] if args.key?(:min_android_sdk_version) @permissions = args[:permissions] if args.key?(:permissions) @product_id = args[:product_id] if args.key?(:product_id) @product_pricing = args[:product_pricing] if args.key?(:product_pricing) @recent_changes = args[:recent_changes] if args.key?(:recent_changes) @requires_container_app = args[:requires_container_app] if args.key?(:requires_container_app) @screenshot_urls = args[:screenshot_urls] if args.key?(:screenshot_urls) @signing_certificate = args[:signing_certificate] if args.key?(:signing_certificate) @small_icon_url = args[:small_icon_url] if args.key?(:small_icon_url) @title = args[:title] if args.key?(:title) @work_details_url = args[:work_details_url] if args.key?(:work_details_url) end end # An event generated when a product's approval status is changed. class ProductApprovalEvent include Google::Apis::Core::Hashable # Whether the product was approved or unapproved. This field will always be # present. # Corresponds to the JSON property `approved` # @return [String] attr_accessor :approved # The id of the product (e.g. "app:com.google.android.gm") for which the # approval status has changed. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @approved = args[:approved] if args.key?(:approved) @product_id = args[:product_id] if args.key?(:product_id) end end # An event generated whenever a product's availability changes. class ProductAvailabilityChangeEvent include Google::Apis::Core::Hashable # The new state of the product. This field will always be present. # Corresponds to the JSON property `availabilityStatus` # @return [String] attr_accessor :availability_status # The id of the product (e.g. "app:com.google.android.gm") for which the product # availability changed. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @availability_status = args[:availability_status] if args.key?(:availability_status) @product_id = args[:product_id] if args.key?(:product_id) end end # A product permissions resource represents the set of permissions required by a # specific app and whether or not they have been accepted by an enterprise admin. # The API can be used to read the set of permissions, and also to update the set # to indicate that permissions have been accepted. class ProductPermission include Google::Apis::Core::Hashable # An opaque string uniquely identifying the permission. # Corresponds to the JSON property `permissionId` # @return [String] attr_accessor :permission_id # Whether the permission has been accepted or not. # 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) @permission_id = args[:permission_id] if args.key?(:permission_id) @state = args[:state] if args.key?(:state) end end # Information about the permissions required by a specific app and whether they # have been accepted by the enterprise. class ProductPermissions include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#productPermissions". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The permissions required by the app. # Corresponds to the JSON property `permission` # @return [Array] attr_accessor :permission # The ID of the app that the permissions relate to, e.g. "app:com.google.android. # gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @permission = args[:permission] if args.key?(:permission) @product_id = args[:product_id] if args.key?(:product_id) end end # The policy for a product. class ProductPolicy include Google::Apis::Core::Hashable # The ID of the product. For example, "app:com.google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Grants visibility to the specified track(s) of the product to the device. The # track available to the device is based on the following order of preference: # alpha, beta, production. For example, if an app has a prod version, a beta # version and an alpha version and the enterprise has been granted visibility to # both the alpha and beta tracks, if tracks is `"beta", "production"` then the # beta version of the app is made available to the device. If there are no app # versions in the specified track adding the "alpha" and "beta" values to the # list of tracks will have no effect. Note that the enterprise requires access # to alpha and/or beta tracks before users can be granted visibility to apps in # those tracks. # The allowed sets are: `` (considered equivalent to `"production"`) `" # production"` `"beta", "production"` `"alpha", "beta", "production"` The order # of elements is not relevant. Any other set of tracks will be rejected with an # error. # 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) @product_id = args[:product_id] if args.key?(:product_id) @tracks = args[:tracks] if args.key?(:tracks) end end # A set of products. class ProductSet include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#productSet". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The list of product IDs making up the set of products. # Corresponds to the JSON property `productId` # @return [Array] attr_accessor :product_id # The interpretation of this product set. "unknown" should never be sent and is # ignored if received. "whitelist" means that the user is entitled to access the # product set. "includeAll" means that all products are accessible, including # products that are approved, products with revoked approval, and products that # have never been approved. "allApproved" means that the user is entitled to # access all products that are approved for the enterprise. If the value is " # allApproved" or "includeAll", the productId field is ignored. If no value is # provided, it is interpreted as "whitelist" for backwards compatibility. # Further "allApproved" or "includeAll" does not enable automatic visibility of " # alpha" or "beta" tracks for Android app. Use ProductVisibility to enable " # alpha" or "beta" tracks per user. # Corresponds to the JSON property `productSetBehavior` # @return [String] attr_accessor :product_set_behavior # Additional list of product IDs making up the product set. Unlike the productID # array, in this list It's possible to specify which tracks (alpha, beta, # production) of a product are visible to the user. See ProductVisibility and # its fields for more information. Specifying the same product ID both here and # in the productId array is not allowed and it will result in an error. # Corresponds to the JSON property `productVisibility` # @return [Array] attr_accessor :product_visibility def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @product_id = args[:product_id] if args.key?(:product_id) @product_set_behavior = args[:product_set_behavior] if args.key?(:product_set_behavior) @product_visibility = args[:product_visibility] if args.key?(:product_visibility) end end # class ProductSigningCertificate include Google::Apis::Core::Hashable # The base64 urlsafe encoded SHA1 hash of the certificate. (This field is # deprecated in favor of SHA2-256. It should not be used and may be removed at # any time.) # Corresponds to the JSON property `certificateHashSha1` # @return [String] attr_accessor :certificate_hash_sha1 # The base64 urlsafe encoded SHA2-256 hash of the certificate. # Corresponds to the JSON property `certificateHashSha256` # @return [String] attr_accessor :certificate_hash_sha256 def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @certificate_hash_sha1 = args[:certificate_hash_sha1] if args.key?(:certificate_hash_sha1) @certificate_hash_sha256 = args[:certificate_hash_sha256] if args.key?(:certificate_hash_sha256) end end # A product to be made visible to a user. class ProductVisibility include Google::Apis::Core::Hashable # The product ID to make visible to the user. Required for each item in the # productVisibility list. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Grants visibility to the specified track(s) of the product to the user. The # track available to the user is based on the following order of preference: # alpha, beta, production. For example, if an app has a prod version, a beta # version and an alpha version and the enterprise has been granted visibility to # both the alpha and beta tracks, if tracks is `"beta", "production"` the user # will be able to install the app and they will get the beta version of the app. # If there are no app versions in the specified track adding the "alpha" and " # beta" values to the list of tracks will have no effect. Note that the # enterprise requires access to alpha and/or beta tracks before users can be # granted visibility to apps in those tracks. # The allowed sets are: `` (considered equivalent to `"production"`) `" # production"` `"beta", "production"` `"alpha", "beta", "production"` The order # of elements is not relevant. Any other set of tracks will be rejected with an # error. # 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) @product_id = args[:product_id] if args.key?(:product_id) @tracks = args[:tracks] if args.key?(:tracks) end end # class ApproveProductRequest include Google::Apis::Core::Hashable # Information on an approval URL. # Corresponds to the JSON property `approvalUrlInfo` # @return [Google::Apis::AndroidenterpriseV1::ApprovalUrlInfo] attr_accessor :approval_url_info # Sets how new permission requests for the product are handled. "allPermissions" # automatically approves all current and future permissions for the product. " # currentPermissionsOnly" approves the current set of permissions for the # product, but any future permissions added through updates will require manual # reapproval. If not specified, only the current set of permissions will be # approved. # Corresponds to the JSON property `approvedPermissions` # @return [String] attr_accessor :approved_permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @approval_url_info = args[:approval_url_info] if args.key?(:approval_url_info) @approved_permissions = args[:approved_permissions] if args.key?(:approved_permissions) end end # class GenerateProductApprovalUrlResponse include Google::Apis::Core::Hashable # A URL that can be rendered in an iframe to display the permissions (if any) of # a product. This URL can be used to approve the product only once and only # within 24 hours of being generated, using the Products.approve call. If the # product is currently unapproved and has no permissions, this URL will point to # an empty page. If the product is currently approved, a URL will only be # generated if that product has added permissions since it was last approved, # and the URL will only display those new permissions that have not yet been # accepted. # 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 # The matching products. class ProductsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#productsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # General pagination information. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::AndroidenterpriseV1::PageInfo] attr_accessor :page_info # Information about a product (e.g. an app) in the Google Play store, for # display to an enterprise admin. # Corresponds to the JSON property `product` # @return [Array] attr_accessor :product # Pagination information for token pagination. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::AndroidenterpriseV1::TokenPagination] attr_accessor :token_pagination def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @page_info = args[:page_info] if args.key?(:page_info) @product = args[:product] if args.key?(:product) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) end end # A service account identity, including the name and credentials that can be # used to authenticate as the service account. class ServiceAccount include Google::Apis::Core::Hashable # Credentials that can be used to authenticate as a service account. # Corresponds to the JSON property `key` # @return [Google::Apis::AndroidenterpriseV1::ServiceAccountKey] attr_accessor :key # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#serviceAccount". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The account name of the service account, in the form of an email address. # Assigned by the server. # 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) @key = args[:key] if args.key?(:key) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Credentials that can be used to authenticate as a service account. class ServiceAccountKey include Google::Apis::Core::Hashable # The body of the private key credentials file, in string format. This is only # populated when the ServiceAccountKey is created, and is not stored by Google. # Corresponds to the JSON property `data` # @return [String] attr_accessor :data # An opaque, unique identifier for this ServiceAccountKey. Assigned by the # server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#serviceAccountKey". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Public key data for the credentials file. This is an X.509 cert. If you are # using the googleCredentials key type, this is identical to the cert that can # be retrieved by using the X.509 cert url inside of the credentials file. # Corresponds to the JSON property `publicData` # @return [String] attr_accessor :public_data # The file format of the generated key data. # 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) @data = args[:data] if args.key?(:data) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @public_data = args[:public_data] if args.key?(:public_data) @type = args[:type] if args.key?(:type) end end # class ServiceAccountKeysListResponse include Google::Apis::Core::Hashable # The service account credentials. # Corresponds to the JSON property `serviceAccountKey` # @return [Array] attr_accessor :service_account_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @service_account_key = args[:service_account_key] if args.key?(:service_account_key) end end # A resource returned by the GenerateSignupUrl API, which contains the Signup # URL and Completion Token. class SignupInfo include Google::Apis::Core::Hashable # An opaque token that will be required, along with the Enterprise Token, for # obtaining the enterprise resource from CompleteSignup. # Corresponds to the JSON property `completionToken` # @return [String] attr_accessor :completion_token # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#signupInfo". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A URL under which the Admin can sign up for an enterprise. The page pointed to # cannot be rendered in an iframe. # 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) @completion_token = args[:completion_token] if args.key?(:completion_token) @kind = args[:kind] if args.key?(:kind) @url = args[:url] if args.key?(:url) end end # Definition of a managed Google Play store cluster, a list of products # displayed as part of a store page. class StoreCluster include Google::Apis::Core::Hashable # Unique ID of this cluster. Assigned by the server. Immutable once assigned. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#storeCluster". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Ordered list of localized strings giving the name of this page. The text # displayed is the one that best matches the user locale, or the first entry if # there is no good match. There needs to be at least one entry. # Corresponds to the JSON property `name` # @return [Array] attr_accessor :name # String (US-ASCII only) used to determine order of this cluster within the # parent page's elements. Page elements are sorted in lexicographic order of # this field. Duplicated values are allowed, but ordering between elements with # duplicate order is undefined. # The value of this field is never visible to a user, it is used solely for the # purpose of defining an ordering. Maximum length is 256 characters. # Corresponds to the JSON property `orderInPage` # @return [String] attr_accessor :order_in_page # List of products in the order they are displayed in the cluster. There should # not be duplicates within a cluster. # Corresponds to the JSON property `productId` # @return [Array] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @order_in_page = args[:order_in_page] if args.key?(:order_in_page) @product_id = args[:product_id] if args.key?(:product_id) end end # General setting for the managed Google Play store layout, currently only # specifying the page to display the first time the store is opened. class StoreLayout include Google::Apis::Core::Hashable # The ID of the store page to be used as the homepage. The homepage is the first # page shown in the managed Google Play Store. # Not specifying a homepage is equivalent to setting the store layout type to " # basic". # Corresponds to the JSON property `homepageId` # @return [String] attr_accessor :homepage_id # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#storeLayout". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The store layout type. By default, this value is set to "basic" if the # homepageId field is not set, and to "custom" otherwise. If set to "basic", the # layout will consist of all approved apps that have been whitelisted for the # user. # Corresponds to the JSON property `storeLayoutType` # @return [String] attr_accessor :store_layout_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @homepage_id = args[:homepage_id] if args.key?(:homepage_id) @kind = args[:kind] if args.key?(:kind) @store_layout_type = args[:store_layout_type] if args.key?(:store_layout_type) end end # The store page resources for the enterprise. class StoreLayoutClustersListResponse include Google::Apis::Core::Hashable # A store cluster of an enterprise. # Corresponds to the JSON property `cluster` # @return [Array] attr_accessor :cluster # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#storeLayoutClustersListResponse". # 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) @cluster = args[:cluster] if args.key?(:cluster) @kind = args[:kind] if args.key?(:kind) end end # The store page resources for the enterprise. class StoreLayoutPagesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#storeLayoutPagesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A store page of an enterprise. # Corresponds to the JSON property `page` # @return [Array] attr_accessor :page def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @page = args[:page] if args.key?(:page) end end # Definition of a managed Google Play store page, made of a localized name and # links to other pages. A page also contains clusters defined as a subcollection. class StorePage include Google::Apis::Core::Hashable # Unique ID of this page. Assigned by the server. Immutable once assigned. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#storePage". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Ordered list of pages a user should be able to reach from this page. The pages # must exist, must not be this page, and once a link is created the page linked # to cannot be deleted until all links to it are removed. It is recommended that # the basic pages are created first, before adding the links between pages. # No attempt is made to verify that all pages are reachable from the homepage. # Corresponds to the JSON property `link` # @return [Array] attr_accessor :link # Ordered list of localized strings giving the name of this page. The text # displayed is the one that best matches the user locale, or the first entry if # there is no good match. There needs to be at least one entry. # Corresponds to the JSON property `name` # @return [Array] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @link = args[:link] if args.key?(:link) @name = args[:name] if args.key?(:name) end end # class TokenPagination include Google::Apis::Core::Hashable # # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # # Corresponds to the JSON property `previousPageToken` # @return [String] attr_accessor :previous_page_token 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) @previous_page_token = args[:previous_page_token] if args.key?(:previous_page_token) end end # A Users resource represents an account associated with an enterprise. The # account may be specific to a device or to an individual user (who can then use # the account across multiple devices). The account may provide access to # managed Google Play only, or to other Google services, depending on the # identity model: # - The Google managed domain identity model requires synchronization to Google # account sources (via primaryEmail). # - The managed Google Play Accounts identity model provides a dynamic means for # enterprises to create user or device accounts as needed. These accounts # provide access to managed Google Play. class User include Google::Apis::Core::Hashable # A unique identifier you create for this user, such as "user342" or "asset# # 44418". Do not use personally identifiable information (PII) for this property. # Must always be set for EMM-managed users. Not set for Google-managed users. # Corresponds to the JSON property `accountIdentifier` # @return [String] attr_accessor :account_identifier # The type of account that this user represents. A userAccount can be installed # on multiple devices, but a deviceAccount is specific to a single device. An # EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), # but a Google-managed user (googleManaged) is always a userAccount. # Corresponds to the JSON property `accountType` # @return [String] attr_accessor :account_type # The name that will appear in user interfaces. Setting this property is # optional when creating EMM-managed users. If you do set this property, use # something generic about the organization (such as "Example, Inc.") or your # name (as EMM). Not used for Google-managed user accounts. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The unique ID for the user. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#user". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The entity that manages the user. With googleManaged users, the source of # truth is Google so EMMs have to make sure a Google Account exists for the user. # With emmManaged users, the EMM is in charge. # Corresponds to the JSON property `managementType` # @return [String] attr_accessor :management_type # The user's primary email address, for example, "jsmith@example.com". Will # always be set for Google managed users and not set for EMM managed users. # Corresponds to the JSON property `primaryEmail` # @return [String] attr_accessor :primary_email def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_identifier = args[:account_identifier] if args.key?(:account_identifier) @account_type = args[:account_type] if args.key?(:account_type) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @management_type = args[:management_type] if args.key?(:management_type) @primary_email = args[:primary_email] if args.key?(:primary_email) end end # A UserToken is used by a user when setting up a managed device or profile with # their managed Google Play account on a device. When the user enters their # email address and token (activation code) the appropriate EMM app can be # automatically downloaded. class UserToken include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#userToken". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token (activation code) to be entered by the user. This consists of a # sequence of decimal digits. Note that the leading digit may be 0. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token # The unique ID for the user. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @token = args[:token] if args.key?(:token) @user_id = args[:user_id] if args.key?(:user_id) end end # The matching user resources. class ListUsersResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#usersListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A user of an enterprise. # Corresponds to the JSON property `user` # @return [Array] attr_accessor :user def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @user = args[:user] if args.key?(:user) end end # A variable set is a key-value pair of EMM-provided placeholders and its # corresponding value, which is attributed to a user. For example, $FIRSTNAME # could be a placeholder, and its value could be Alice. Placeholders should # start with a '$' sign and should be alphanumeric only. class VariableSet include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#variableSet". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The placeholder string; defined by EMM. # Corresponds to the JSON property `placeholder` # @return [String] attr_accessor :placeholder # The value of the placeholder, specific to the user. # Corresponds to the JSON property `userValue` # @return [String] attr_accessor :user_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @placeholder = args[:placeholder] if args.key?(:placeholder) @user_value = args[:user_value] if args.key?(:user_value) end end end end end google-api-client-0.19.8/generated/google/apis/androidenterprise_v1/service.rb0000644000004100000410000065762113252673043027450 0ustar www-datawww-data# 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 AndroidenterpriseV1 # Google Play EMM API # # Manages the deployment of apps to Android for Work users. # # @example # require 'google/apis/androidenterprise_v1' # # Androidenterprise = Google::Apis::AndroidenterpriseV1 # Alias the module # service = Androidenterprise::AndroidEnterpriseService.new # # @see https://developers.google.com/android/work/play/emm-api class AndroidEnterpriseService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'androidenterprise/v1/') @batch_path = 'batch/androidenterprise/v1' end # Retrieves the details of a device. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The ID of the device. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Device] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Device] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_device(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Device::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Device command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_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 whether a device's access to Google services is enabled or disabled. # The device state takes effect only if enforcing EMM policies on Android # devices is enabled in the Google Admin Console. Otherwise, the device state is # ignored and all devices are allowed access to Google services. This is only # supported for Google-managed users. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The ID of the device. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::DeviceState] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::DeviceState] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_device_state(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state', options) command.response_representation = Google::Apis::AndroidenterpriseV1::DeviceState::Representation command.response_class = Google::Apis::AndroidenterpriseV1::DeviceState command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_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 the IDs of all of a user's devices. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ListDevicesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ListDevicesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_devices(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListDevicesResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListDevicesResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 device policy. This method supports patch semantics. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The ID of the device. # @param [Google::Apis::AndroidenterpriseV1::Device] device_object # @param [String] update_mask # Mask that identifies which fields to update. If not set, all modifiable fields # will be modified. # When set in a query parameter, this field should be specified as updateMask=< # field1>,,... # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Device] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Device] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_device(enterprise_id, user_id, device_id, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Device::Representation command.request_object = device_object command.response_representation = Google::Apis::AndroidenterpriseV1::Device::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Device command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Sets whether a device's access to Google services is enabled or disabled. The # device state takes effect only if enforcing EMM policies on Android devices is # enabled in the Google Admin Console. Otherwise, the device state is ignored # and all devices are allowed access to Google services. This is only supported # for Google-managed users. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The ID of the device. # @param [Google::Apis::AndroidenterpriseV1::DeviceState] device_state_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::DeviceState] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::DeviceState] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_device_state(enterprise_id, user_id, device_id, device_state_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state', options) command.request_representation = Google::Apis::AndroidenterpriseV1::DeviceState::Representation command.request_object = device_state_object command.response_representation = Google::Apis::AndroidenterpriseV1::DeviceState::Representation command.response_class = Google::Apis::AndroidenterpriseV1::DeviceState command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_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 device policy # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The ID of the device. # @param [Google::Apis::AndroidenterpriseV1::Device] device_object # @param [String] update_mask # Mask that identifies which fields to update. If not set, all modifiable fields # will be modified. # When set in a query parameter, this field should be specified as updateMask=< # field1>,,... # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Device] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Device] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_device(enterprise_id, user_id, device_id, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Device::Representation command.request_object = device_object command.response_representation = Google::Apis::AndroidenterpriseV1::Device::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Device command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Acknowledges notifications that were received from Enterprises. # PullNotificationSet to prevent subsequent calls from returning the same # notifications. # @param [String] notification_set_id # The notification set ID as returned by Enterprises.PullNotificationSet. This # must be 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 acknowledge_enterprise_notification_set(notification_set_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/acknowledgeNotificationSet', options) command.query['notificationSetId'] = notification_set_id unless notification_set_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 # Completes the signup flow, by specifying the Completion token and Enterprise # token. This request must not be called multiple times for a given Enterprise # Token. # @param [String] completion_token # The Completion token initially returned by GenerateSignupUrl. # @param [String] enterprise_token # The Enterprise token appended to the Callback URL. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Enterprise] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Enterprise] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def complete_enterprise_signup(completion_token: nil, enterprise_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/completeSignup', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Enterprise command.query['completionToken'] = completion_token unless completion_token.nil? command.query['enterpriseToken'] = enterprise_token unless enterprise_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 # Returns a unique token to access an embeddable UI. To generate a web UI, pass # the generated token into the managed Google Play javascript API. Each token # may only be used to start one UI session. See the javascript API documentation # for further information. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpec] administrator_web_token_spec_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::AdministratorWebToken] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::AdministratorWebToken] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_web_token(enterprise_id, administrator_web_token_spec_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/createWebToken', options) command.request_representation = Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpec::Representation command.request_object = administrator_web_token_spec_object command.response_representation = Google::Apis::AndroidenterpriseV1::AdministratorWebToken::Representation command.response_class = Google::Apis::AndroidenterpriseV1::AdministratorWebToken command.params['enterpriseId'] = enterprise_id unless enterprise_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 binding between the EMM and enterprise. This is now deprecated. # Use this method only to unenroll customers that were previously enrolled with # the insert call, then enroll them again with the enroll call. # @param [String] enterprise_id # The ID of the enterprise. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_enterprise(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_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 # Enrolls an enterprise with the calling EMM. # @param [String] token # The token provided by the enterprise to register the EMM. # @param [Google::Apis::AndroidenterpriseV1::Enterprise] enterprise_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Enterprise] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Enterprise] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def enroll_enterprise(token, enterprise_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/enroll', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation command.request_object = enterprise_object command.response_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Enterprise 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 # Generates a sign-up URL. # @param [String] callback_url # The callback URL to which the Admin will be redirected after successfully # creating an enterprise. Before redirecting there the system will add a single # query parameter to this URL named "enterpriseToken" which will contain an # opaque token to be used for the CompleteSignup request. # Beware that this means that the URL will be parsed, the parameter added and # then a new URL formatted, i.e. there may be some minor formatting changes and, # more importantly, the URL must be well-formed so that it can be parsed. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::SignupInfo] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::SignupInfo] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_signup_url(callback_url: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/signupUrl', options) command.response_representation = Google::Apis::AndroidenterpriseV1::SignupInfo::Representation command.response_class = Google::Apis::AndroidenterpriseV1::SignupInfo command.query['callbackUrl'] = callback_url unless callback_url.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 the name and domain of an enterprise. # @param [String] enterprise_id # The ID of the enterprise. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Enterprise] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Enterprise] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Enterprise command.params['enterpriseId'] = enterprise_id unless enterprise_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 Android Device Policy config resource. # @param [String] enterprise_id # The ID of the enterprise. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::AndroidDevicePolicyConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::AndroidDevicePolicyConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_android_device_policy_config(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/androidDevicePolicyConfig', options) command.response_representation = Google::Apis::AndroidenterpriseV1::AndroidDevicePolicyConfig::Representation command.response_class = Google::Apis::AndroidenterpriseV1::AndroidDevicePolicyConfig command.params['enterpriseId'] = enterprise_id unless enterprise_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 a service account and credentials. The service account can be bound to # the enterprise by calling setAccount. The service account is unique to this # enterprise and EMM, and will be deleted if the enterprise is unbound. The # credentials contain private key data and are not stored server-side. # This method can only be called after calling Enterprises.Enroll or Enterprises. # CompleteSignup, and before Enterprises.SetAccount; at other times it will # return an error. # Subsequent calls after the first will generate a new, unique set of # credentials, and invalidate the previously generated credentials. # Once the service account is bound to the enterprise, it can be managed using # the serviceAccountKeys resource. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] key_type # The type of credential to return with the service account. 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ServiceAccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ServiceAccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_service_account(enterprise_id, key_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/serviceAccount', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ServiceAccount::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ServiceAccount command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.query['keyType'] = key_type unless key_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 # Returns the store layout for the enterprise. If the store layout has not been # set, returns "basic" as the store layout type and no homepage. # @param [String] enterprise_id # The ID of the enterprise. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StoreLayout] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StoreLayout] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_store_layout(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout', options) command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayout::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayout command.params['enterpriseId'] = enterprise_id unless enterprise_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 # Establishes the binding between the EMM and an enterprise. This is now # deprecated; use enroll instead. # @param [String] token # The token provided by the enterprise to register the EMM. # @param [Google::Apis::AndroidenterpriseV1::Enterprise] enterprise_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Enterprise] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Enterprise] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise(token, enterprise_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation command.request_object = enterprise_object command.response_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Enterprise 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 # Looks up an enterprise by domain name. This is only supported for enterprises # created via the Google-initiated creation flow. Lookup of the id is not needed # for enterprises created via the EMM-initiated flow since the EMM learns the # enterprise ID in the callback specified in the Enterprises.generateSignupUrl # call. # @param [String] domain # The exact primary domain name of the enterprise to look up. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ListEnterprisesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ListEnterprisesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprises(domain, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListEnterprisesResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListEnterprisesResponse command.query['domain'] = domain unless domain.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 # Pulls and returns a notification set for the enterprises associated with the # service account authenticated for the request. The notification set may be # empty if no notification are pending. # A notification set returned needs to be acknowledged within 20 seconds by # calling Enterprises.AcknowledgeNotificationSet, unless the notification set is # empty. # Notifications that are not acknowledged within the 20 seconds will eventually # be included again in the response to another PullNotificationSet request, and # those that are never acknowledged will ultimately be deleted according to the # Google Cloud Platform Pub/Sub system policy. # Multiple requests might be performed concurrently to retrieve notifications, # in which case the pending notifications (if any) will be split among each # caller, if any are pending. # If no notifications are present, an empty notification list is returned. # Subsequent requests may return more notifications once they become available. # @param [String] request_mode # The request mode for pulling notifications. # Specifying waitForNotifications will cause the request to block and wait until # one or more notifications are present, or return an empty notification list if # no notifications are present after some time. # Speciying returnImmediately will cause the request to immediately return the # pending notifications, or an empty list if no notifications are present. # If omitted, defaults to waitForNotifications. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::NotificationSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::NotificationSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def pull_enterprise_notification_set(request_mode: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/pullNotificationSet', options) command.response_representation = Google::Apis::AndroidenterpriseV1::NotificationSet::Representation command.response_class = Google::Apis::AndroidenterpriseV1::NotificationSet command.query['requestMode'] = request_mode unless request_mode.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 # Sends a test notification to validate the EMM integration with the Google # Cloud Pub/Sub service for this enterprise. # @param [String] enterprise_id # The ID of the enterprise. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::SendTestPushNotificationResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::SendTestPushNotificationResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def send_enterprise_test_push_notification(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/sendTestPushNotification', options) command.response_representation = Google::Apis::AndroidenterpriseV1::SendTestPushNotificationResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::SendTestPushNotificationResponse command.params['enterpriseId'] = enterprise_id unless enterprise_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 # Sets the account that will be used to authenticate to the API as the # enterprise. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::EnterpriseAccount] enterprise_account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::EnterpriseAccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::EnterpriseAccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_account(enterprise_id, enterprise_account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/account', options) command.request_representation = Google::Apis::AndroidenterpriseV1::EnterpriseAccount::Representation command.request_object = enterprise_account_object command.response_representation = Google::Apis::AndroidenterpriseV1::EnterpriseAccount::Representation command.response_class = Google::Apis::AndroidenterpriseV1::EnterpriseAccount command.params['enterpriseId'] = enterprise_id unless enterprise_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 # Sets the Android Device Policy config resource. EMM may use this method to # enable or disable Android Device Policy support for the specified enterprise. # To learn more about managing devices and apps with Android Device Policy, see # the Android Management API. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::AndroidDevicePolicyConfig] android_device_policy_config_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::AndroidDevicePolicyConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::AndroidDevicePolicyConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_android_device_policy_config(enterprise_id, android_device_policy_config_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/androidDevicePolicyConfig', options) command.request_representation = Google::Apis::AndroidenterpriseV1::AndroidDevicePolicyConfig::Representation command.request_object = android_device_policy_config_object command.response_representation = Google::Apis::AndroidenterpriseV1::AndroidDevicePolicyConfig::Representation command.response_class = Google::Apis::AndroidenterpriseV1::AndroidDevicePolicyConfig command.params['enterpriseId'] = enterprise_id unless enterprise_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 # Sets the store layout for the enterprise. By default, storeLayoutType is set # to "basic" and the basic store layout is enabled. The basic layout only # contains apps approved by the admin, and that have been added to the available # product set for a user (using the setAvailableProductSet call). Apps on the # page are sorted in order of their product ID value. If you create a custom # store layout (by setting storeLayoutType = "custom" and setting a homepage), # the basic store layout is disabled. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::StoreLayout] store_layout_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StoreLayout] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StoreLayout] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_store_layout(enterprise_id, store_layout_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/storeLayout', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StoreLayout::Representation command.request_object = store_layout_object command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayout::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayout command.params['enterpriseId'] = enterprise_id unless enterprise_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 # Unenrolls an enterprise from the calling EMM. # @param [String] enterprise_id # The ID of the enterprise. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 unenroll_enterprise(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/unenroll', options) command.params['enterpriseId'] = enterprise_id unless enterprise_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 # Removes an entitlement to an app for a user. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] entitlement_id # The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['entitlementId'] = entitlement_id unless entitlement_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 details of an entitlement. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] entitlement_id # The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Entitlement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Entitlement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Entitlement command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['entitlementId'] = entitlement_id unless entitlement_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 all entitlements for the specified user. Only the ID is set. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ListEntitlementsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ListEntitlementsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_entitlements(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/entitlements', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListEntitlementsResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListEntitlementsResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 # Adds or updates an entitlement to an app for a user. This method supports # patch semantics. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] entitlement_id # The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". # @param [Google::Apis::AndroidenterpriseV1::Entitlement] entitlement_object # @param [Boolean] install # Set to true to also install the product on all the user's devices where # possible. Failure to install on one or more devices will not prevent this # operation from returning successfully, as long as the entitlement was # successfully assigned to the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Entitlement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Entitlement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_entitlement(enterprise_id, user_id, entitlement_id, entitlement_object = nil, install: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation command.request_object = entitlement_object command.response_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Entitlement command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['entitlementId'] = entitlement_id unless entitlement_id.nil? command.query['install'] = install unless install.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 # Adds or updates an entitlement to an app for a user. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] entitlement_id # The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". # @param [Google::Apis::AndroidenterpriseV1::Entitlement] entitlement_object # @param [Boolean] install # Set to true to also install the product on all the user's devices where # possible. Failure to install on one or more devices will not prevent this # operation from returning successfully, as long as the entitlement was # successfully assigned to the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Entitlement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Entitlement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_entitlement(enterprise_id, user_id, entitlement_id, entitlement_object = nil, install: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation command.request_object = entitlement_object command.response_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Entitlement command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['entitlementId'] = entitlement_id unless entitlement_id.nil? command.query['install'] = install unless install.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 details of an enterprise's group license for a product. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] group_license_id # The ID of the product the group license is for, e.g. "app:com.google.android. # gm". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::GroupLicense] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::GroupLicense] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group_license(enterprise_id, group_license_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::GroupLicense::Representation command.response_class = Google::Apis::AndroidenterpriseV1::GroupLicense command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['groupLicenseId'] = group_license_id unless group_license_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 IDs of all products for which the enterprise has a group license. # @param [String] enterprise_id # The ID of the enterprise. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ListGroupLicensesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ListGroupLicensesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group_licenses(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/groupLicenses', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListGroupLicensesResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListGroupLicensesResponse command.params['enterpriseId'] = enterprise_id unless enterprise_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 the IDs of the users who have been granted entitlements under the # license. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] group_license_id # The ID of the product the group license is for, e.g. "app:com.google.android. # gm". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ListGroupLicenseUsersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ListGroupLicenseUsersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group_license_users(enterprise_id, group_license_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListGroupLicenseUsersResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListGroupLicenseUsersResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['groupLicenseId'] = group_license_id unless group_license_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 # Requests to remove an app from a device. A call to get or list will still show # the app as installed on the device until it is actually removed. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The Android ID of the device. # @param [String] install_id # The ID of the product represented by the install, e.g. "app:com.google.android. # gm". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_id.nil? command.params['installId'] = install_id unless install_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 details of an installation of an app on a device. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The Android ID of the device. # @param [String] install_id # The ID of the product represented by the install, e.g. "app:com.google.android. # gm". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Install] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Install] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Install::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Install command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_id.nil? command.params['installId'] = install_id unless install_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 the details of all apps installed on the specified device. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The Android ID of the device. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ListInstallsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ListInstallsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_installs(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListInstallsResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListInstallsResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_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 # Requests to install the latest version of an app to a device. If the app is # already installed, then it is updated to the latest version if necessary. This # method supports patch semantics. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The Android ID of the device. # @param [String] install_id # The ID of the product represented by the install, e.g. "app:com.google.android. # gm". # @param [Google::Apis::AndroidenterpriseV1::Install] install_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Install] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Install] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_install(enterprise_id, user_id, device_id, install_id, install_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Install::Representation command.request_object = install_object command.response_representation = Google::Apis::AndroidenterpriseV1::Install::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Install command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_id.nil? command.params['installId'] = install_id unless install_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 # Requests to install the latest version of an app to a device. If the app is # already installed, then it is updated to the latest version if necessary. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The Android ID of the device. # @param [String] install_id # The ID of the product represented by the install, e.g. "app:com.google.android. # gm". # @param [Google::Apis::AndroidenterpriseV1::Install] install_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Install] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Install] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_install(enterprise_id, user_id, device_id, install_id, install_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Install::Representation command.request_object = install_object command.response_representation = Google::Apis::AndroidenterpriseV1::Install::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Install command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_id.nil? command.params['installId'] = install_id unless install_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 # Removes a per-device managed configuration for an app for the specified device. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The Android ID of the device. # @param [String] managed_configuration_for_device_id # The ID of the managed configuration (a product ID), e.g. "app:com.google. # android.gm". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_id.nil? command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_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 details of a per-device managed configuration. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The Android ID of the device. # @param [String] managed_configuration_for_device_id # The ID of the managed configuration (a product ID), e.g. "app:com.google. # android.gm". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_id.nil? command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_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 all the per-device managed configurations for the specified device. Only # the ID is set. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The Android ID of the device. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForDeviceListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForDeviceListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managedconfigurationsfordevices(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForDeviceListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForDeviceListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_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 # Adds or updates a per-device managed configuration for an app for the # specified device. This method supports patch semantics. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The Android ID of the device. # @param [String] managed_configuration_for_device_id # The ID of the managed configuration (a product ID), e.g. "app:com.google. # android.gm". # @param [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] managed_configuration_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.request_object = managed_configuration_object command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_id.nil? command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_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 # Adds or updates a per-device managed configuration for an app for the # specified device. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] device_id # The Android ID of the device. # @param [String] managed_configuration_for_device_id # The ID of the managed configuration (a product ID), e.g. "app:com.google. # android.gm". # @param [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] managed_configuration_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.request_object = managed_configuration_object command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_id.nil? command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_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 # Removes a per-user managed configuration for an app for the specified user. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] managed_configuration_for_user_id # The ID of the managed configuration (a product ID), e.g. "app:com.google. # android.gm". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_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 details of a per-user managed configuration for an app for the # specified user. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] managed_configuration_for_user_id # The ID of the managed configuration (a product ID), e.g. "app:com.google. # android.gm". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_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 all the per-user managed configurations for the specified user. Only the # ID is set. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForUserListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForUserListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managedconfigurationsforusers(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForUserListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForUserListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 # Adds or updates the managed configuration settings for an app for the # specified user. If you support the Managed configurations iframe, you can # apply managed configurations to a user by specifying an mcmId and its # associated configuration variables (if any) in the request. Alternatively, all # EMMs can apply managed configurations by passing a list of managed properties. # This method supports patch semantics. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] managed_configuration_for_user_id # The ID of the managed configuration (a product ID), e.g. "app:com.google. # android.gm". # @param [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] managed_configuration_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.request_object = managed_configuration_object command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_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 # Adds or updates the managed configuration settings for an app for the # specified user. If you support the Managed configurations iframe, you can # apply managed configurations to a user by specifying an mcmId and its # associated configuration variables (if any) in the request. Alternatively, all # EMMs can apply managed configurations by passing a list of managed properties. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] managed_configuration_for_user_id # The ID of the managed configuration (a product ID), e.g. "app:com.google. # android.gm". # @param [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] managed_configuration_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.request_object = managed_configuration_object command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_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 all the managed configurations settings for the specified app. Only the # ID and the name is set. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id # The ID of the product for which the managed configurations settings applies to. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_managedconfigurationssettings(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}/managedConfigurationsSettings', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_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 details of an Android app permission for display to an enterprise # admin. # @param [String] permission_id # The ID of the permission. # @param [String] language # The BCP47 tag for the user's preferred language (e.g. "en-US", "de") # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Permission] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Permission] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_permission(permission_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'permissions/{permissionId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Permission::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Permission command.params['permissionId'] = permission_id unless permission_id.nil? command.query['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 # Approves the specified product and the relevant app permissions, if any. The # maximum number of products that you can approve per enterprise customer is 1, # 000. # To learn how to use managed Google Play to design and create a store layout to # display approved products to your users, see Store Layout Design. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id # The ID of the product. # @param [Google::Apis::AndroidenterpriseV1::ApproveProductRequest] approve_product_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 approve_product(enterprise_id, product_id, approve_product_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/products/{productId}/approve', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ApproveProductRequest::Representation command.request_object = approve_product_request_object command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_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 # Generates a URL that can be rendered in an iframe to display the permissions ( # if any) of a product. An enterprise admin must view these permissions and # accept them on behalf of their organization in order to approve that product. # Admins should accept the displayed permissions by interacting with a separate # UI element in the EMM console, which in turn should trigger the use of this # URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to # approve the product. This URL can only be used to display permissions for up # to 1 day. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id # The ID of the product. # @param [String] language_code # The BCP 47 language code used for permission names and descriptions in the # returned iframe, for instance "en-US". # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::GenerateProductApprovalUrlResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::GenerateProductApprovalUrlResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_approval_url(enterprise_id, product_id, language_code: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl', options) command.response_representation = Google::Apis::AndroidenterpriseV1::GenerateProductApprovalUrlResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::GenerateProductApprovalUrlResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_id.nil? command.query['languageCode'] = language_code unless language_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 # Retrieves details of a product for display to an enterprise admin. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id # The ID of the product, e.g. "app:com.google.android.gm". # @param [String] language # The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::Product] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::Product] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Product::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Product command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_id.nil? command.query['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 # Retrieves the schema that defines the configurable properties for this product. # All products have a schema, but this schema may be empty if no managed # configurations have been defined. This schema can be used to populate a UI # that allows an admin to configure the product. To apply a managed # configuration based on the schema obtained using this API, see Managed # Configurations through Play. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id # The ID of the product. # @param [String] language # The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::AppRestrictionsSchema] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::AppRestrictionsSchema] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_app_restrictions_schema(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema', options) command.response_representation = Google::Apis::AndroidenterpriseV1::AppRestrictionsSchema::Representation command.response_class = Google::Apis::AndroidenterpriseV1::AppRestrictionsSchema command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_id.nil? command.query['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 # Retrieves the Android app permissions required by this app. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id # The ID of the product. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ProductPermissions] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ProductPermissions] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_permissions(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}/permissions', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ProductPermissions::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ProductPermissions command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_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 # Finds approved products that match a query, or all approved products if there # is no query. # @param [String] enterprise_id # The ID of the enterprise. # @param [Boolean] approved # Specifies whether to search among all products (false) or among only products # that have been approved (true). Only "true" is supported, and should be # specified. # @param [String] language # The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results # are returned in the language best matching the preferred language. # @param [Fixnum] max_results # Specifies the maximum number of products that can be returned per request. If # not specified, uses a default value of 100, which is also the maximum # retrievable within a single response. # @param [String] query # The search query as typed in the Google Play store search box. If omitted, all # approved apps will be returned (using the pagination parameters), including # apps that are not available in the store (e.g. unpublished apps). # @param [String] token # A pagination token is contained in a request''s response when there are more # products. The token can be used in a subsequent request to obtain more # products, and so forth. This parameter cannot be used in the initial 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ProductsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ProductsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_products(enterprise_id, approved: nil, language: nil, max_results: nil, query: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/products', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ProductsListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ProductsListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.query['approved'] = approved unless approved.nil? command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['query'] = query unless query.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 # Unapproves the specified product (and the relevant app permissions, if any) # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id # The ID of the product. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 unapprove_product(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/products/{productId}/unapprove', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_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 # Removes and invalidates the specified credentials for the service account # associated with this enterprise. The calling service account must have been # retrieved by calling Enterprises.GetServiceAccount and must have been set as # the enterprise service account by calling Enterprises.SetAccount. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] key_id # The ID of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_serviceaccountkey(enterprise_id, key_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}/serviceAccountKeys/{keyId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['keyId'] = key_id unless key_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 # Generates new credentials for the service account associated with this # enterprise. The calling service account must have been retrieved by calling # Enterprises.GetServiceAccount and must have been set as the enterprise service # account by calling Enterprises.SetAccount. # Only the type of the key should be populated in the resource to be inserted. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::ServiceAccountKey] service_account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ServiceAccountKey] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ServiceAccountKey] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_serviceaccountkey(enterprise_id, service_account_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/serviceAccountKeys', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ServiceAccountKey::Representation command.request_object = service_account_key_object command.response_representation = Google::Apis::AndroidenterpriseV1::ServiceAccountKey::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ServiceAccountKey command.params['enterpriseId'] = enterprise_id unless enterprise_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 all active credentials for the service account associated with this # enterprise. Only the ID and key type are returned. The calling service account # must have been retrieved by calling Enterprises.GetServiceAccount and must # have been set as the enterprise service account by calling Enterprises. # SetAccount. # @param [String] enterprise_id # The ID of the enterprise. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ServiceAccountKeysListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ServiceAccountKeysListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_serviceaccountkeys(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/serviceAccountKeys', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ServiceAccountKeysListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ServiceAccountKeysListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_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 a cluster. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] page_id # The ID of the page. # @param [String] cluster_id # The ID of the cluster. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_id.nil? 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 # Retrieves details of a cluster. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] page_id # The ID of the page. # @param [String] cluster_id # The ID of the cluster. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StoreCluster] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StoreCluster] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreCluster command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_id.nil? 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 # Inserts a new cluster in a page. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] page_id # The ID of the page. # @param [Google::Apis::AndroidenterpriseV1::StoreCluster] store_cluster_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StoreCluster] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StoreCluster] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_storelayoutcluster(enterprise_id, page_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation command.request_object = store_cluster_object command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreCluster command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_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 the details of all clusters on the specified page. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] page_id # The ID of the page. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StoreLayoutClustersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StoreLayoutClustersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_storelayoutclusters(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters', options) command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayoutClustersListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayoutClustersListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_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 a cluster. This method supports patch semantics. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] page_id # The ID of the page. # @param [String] cluster_id # The ID of the cluster. # @param [Google::Apis::AndroidenterpriseV1::StoreCluster] store_cluster_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StoreCluster] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StoreCluster] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_storelayoutcluster(enterprise_id, page_id, cluster_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation command.request_object = store_cluster_object command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreCluster command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_id.nil? 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 # Updates a cluster. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] page_id # The ID of the page. # @param [String] cluster_id # The ID of the cluster. # @param [Google::Apis::AndroidenterpriseV1::StoreCluster] store_cluster_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StoreCluster] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StoreCluster] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_storelayoutcluster(enterprise_id, page_id, cluster_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation command.request_object = store_cluster_object command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreCluster command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_id.nil? 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 # Deletes a store page. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] page_id # The ID of the page. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_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 details of a store page. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] page_id # The ID of the page. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StorePage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StorePage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StorePage command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_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 # Inserts a new store page. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::StorePage] store_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StorePage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StorePage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_storelayoutpage(enterprise_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/storeLayout/pages', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation command.request_object = store_page_object command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StorePage command.params['enterpriseId'] = enterprise_id unless enterprise_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 the details of all pages in the store. # @param [String] enterprise_id # The ID of the enterprise. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StoreLayoutPagesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StoreLayoutPagesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_storelayoutpages(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages', options) command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayoutPagesListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayoutPagesListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_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 content of a store page. This method supports patch semantics. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] page_id # The ID of the page. # @param [Google::Apis::AndroidenterpriseV1::StorePage] store_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StorePage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StorePage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_storelayoutpage(enterprise_id, page_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation command.request_object = store_page_object command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StorePage command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_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 content of a store page. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] page_id # The ID of the page. # @param [Google::Apis::AndroidenterpriseV1::StorePage] store_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::StorePage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::StorePage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_storelayoutpage(enterprise_id, page_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation command.request_object = store_page_object command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StorePage command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_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 # Deleted an EMM-managed user. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_user(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 # Generates an authentication token which the device policy client can use to # provision the given EMM-managed user account on a device. The generated token # is single-use and expires after a few minutes. # This call only works with EMM-managed accounts. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::AuthenticationToken] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::AuthenticationToken] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_authentication_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/users/{userId}/authenticationToken', options) command.response_representation = Google::Apis::AndroidenterpriseV1::AuthenticationToken::Representation command.response_class = Google::Apis::AndroidenterpriseV1::AuthenticationToken command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 # Generates a token (activation code) to allow this user to configure their # managed account in the Android Setup Wizard. Revokes any previously generated # token. # This call only works with Google managed accounts. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::UserToken] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::UserToken] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/users/{userId}/token', options) command.response_representation = Google::Apis::AndroidenterpriseV1::UserToken::Representation command.response_class = Google::Apis::AndroidenterpriseV1::UserToken command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 user's details. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::User] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::User] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation command.response_class = Google::Apis::AndroidenterpriseV1::User command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 the set of products a user is entitled to access. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ProductSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ProductSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_available_product_set(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/availableProductSet', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ProductSet::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ProductSet command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 EMM-managed user. # The Users resource passed in the body of the request should include an # accountIdentifier and an accountType. # If a corresponding user already exists with the same account identifier, the # user will be updated with the resource. In this case only the displayName # field can be changed. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::User] user_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::User] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::User] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user(enterprise_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'enterprises/{enterpriseId}/users', options) command.request_representation = Google::Apis::AndroidenterpriseV1::User::Representation command.request_object = user_object command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation command.response_class = Google::Apis::AndroidenterpriseV1::User command.params['enterpriseId'] = enterprise_id unless enterprise_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 # Looks up a user by primary email address. This is only supported for Google- # managed users. Lookup of the id is not needed for EMM-managed users because # the id is already returned in the result of the Users.insert call. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] email # The exact primary email address of the user to look up. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ListUsersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ListUsersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_users(enterprise_id, email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'enterprises/{enterpriseId}/users', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListUsersResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListUsersResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.query['email'] = email unless email.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 EMM-managed user. # Can be used with EMM-managed users only (not Google managed users). Pass the # new details in the Users resource in the request body. Only the displayName # field can be changed. Other fields must either be unset or have the currently # active value. This method supports patch semantics. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [Google::Apis::AndroidenterpriseV1::User] user_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::User] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::User] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user(enterprise_id, user_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::User::Representation command.request_object = user_object command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation command.response_class = Google::Apis::AndroidenterpriseV1::User command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 # Revokes access to all devices currently provisioned to the user. The user will # no longer be able to use the managed Play store on any of their managed # devices. # This call only works with EMM-managed accounts. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_user_device_access(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/deviceAccess', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 # Revokes a previously generated token (activation code) for the user. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_user_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/token', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 # Modifies the set of products that a user is entitled to access (referred to as # whitelisted products). Only products that are approved or products that were # previously approved (products with revoked approval) can be whitelisted. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [Google::Apis::AndroidenterpriseV1::ProductSet] product_set_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::ProductSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::ProductSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_available_product_set(enterprise_id, user_id, product_set_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/availableProductSet', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ProductSet::Representation command.request_object = product_set_object command.response_representation = Google::Apis::AndroidenterpriseV1::ProductSet::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ProductSet command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 details of an EMM-managed user. # Can be used with EMM-managed users only (not Google managed users). Pass the # new details in the Users resource in the request body. Only the displayName # field can be changed. Other fields must either be unset or have the currently # active value. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [Google::Apis::AndroidenterpriseV1::User] user_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AndroidenterpriseV1::User] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidenterpriseV1::User] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user(enterprise_id, user_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::User::Representation command.request_object = user_object command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation command.response_class = Google::Apis::AndroidenterpriseV1::User command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 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 end end google-api-client-0.19.8/generated/google/apis/logging_v2beta1/0000755000004100000410000000000013252673044024266 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/logging_v2beta1/representations.rb0000644000004100000410000004567713252673044030063 0ustar www-datawww-data# 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 LoggingV2beta1 class BucketOptions 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 Explicit class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Exponential class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LabelDescriptor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Linear class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLogEntriesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLogEntriesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLogMetricsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLogsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListMonitoredResourceDescriptorsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListSinksResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogEntryOperation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogEntrySourceLocation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogLine class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogMetric class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogSink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricDescriptor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MonitoredResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MonitoredResourceDescriptor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RequestLog class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SourceLocation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SourceReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WriteLogEntriesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WriteLogEntriesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BucketOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :explicit_buckets, as: 'explicitBuckets', class: Google::Apis::LoggingV2beta1::Explicit, decorator: Google::Apis::LoggingV2beta1::Explicit::Representation property :exponential_buckets, as: 'exponentialBuckets', class: Google::Apis::LoggingV2beta1::Exponential, decorator: Google::Apis::LoggingV2beta1::Exponential::Representation property :linear_buckets, as: 'linearBuckets', class: Google::Apis::LoggingV2beta1::Linear, decorator: Google::Apis::LoggingV2beta1::Linear::Representation end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Explicit # @private class Representation < Google::Apis::Core::JsonRepresentation collection :bounds, as: 'bounds' end end class Exponential # @private class Representation < Google::Apis::Core::JsonRepresentation property :growth_factor, as: 'growthFactor' property :num_finite_buckets, as: 'numFiniteBuckets' property :scale, as: 'scale' end end class HttpRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cache_fill_bytes, :numeric_string => true, as: 'cacheFillBytes' property :cache_hit, as: 'cacheHit' property :cache_lookup, as: 'cacheLookup' property :cache_validated_with_origin_server, as: 'cacheValidatedWithOriginServer' property :latency, as: 'latency' property :protocol, as: 'protocol' property :referer, as: 'referer' property :remote_ip, as: 'remoteIp' property :request_method, as: 'requestMethod' property :request_size, :numeric_string => true, as: 'requestSize' property :request_url, as: 'requestUrl' property :response_size, :numeric_string => true, as: 'responseSize' property :server_ip, as: 'serverIp' property :status, as: 'status' property :user_agent, as: 'userAgent' end end class LabelDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :key, as: 'key' property :value_type, as: 'valueType' end end class Linear # @private class Representation < Google::Apis::Core::JsonRepresentation property :num_finite_buckets, as: 'numFiniteBuckets' property :offset, as: 'offset' property :width, as: 'width' end end class ListLogEntriesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :filter, as: 'filter' property :order_by, as: 'orderBy' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' collection :project_ids, as: 'projectIds' collection :resource_names, as: 'resourceNames' end end class ListLogEntriesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::LoggingV2beta1::LogEntry, decorator: Google::Apis::LoggingV2beta1::LogEntry::Representation property :next_page_token, as: 'nextPageToken' end end class ListLogMetricsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :metrics, as: 'metrics', class: Google::Apis::LoggingV2beta1::LogMetric, decorator: Google::Apis::LoggingV2beta1::LogMetric::Representation property :next_page_token, as: 'nextPageToken' end end class ListLogsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :log_names, as: 'logNames' property :next_page_token, as: 'nextPageToken' end end class ListMonitoredResourceDescriptorsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :resource_descriptors, as: 'resourceDescriptors', class: Google::Apis::LoggingV2beta1::MonitoredResourceDescriptor, decorator: Google::Apis::LoggingV2beta1::MonitoredResourceDescriptor::Representation end end class ListSinksResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :sinks, as: 'sinks', class: Google::Apis::LoggingV2beta1::LogSink, decorator: Google::Apis::LoggingV2beta1::LogSink::Representation end end class LogEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :http_request, as: 'httpRequest', class: Google::Apis::LoggingV2beta1::HttpRequest, decorator: Google::Apis::LoggingV2beta1::HttpRequest::Representation property :insert_id, as: 'insertId' hash :json_payload, as: 'jsonPayload' hash :labels, as: 'labels' property :log_name, as: 'logName' property :operation, as: 'operation', class: Google::Apis::LoggingV2beta1::LogEntryOperation, decorator: Google::Apis::LoggingV2beta1::LogEntryOperation::Representation hash :proto_payload, as: 'protoPayload' property :receive_timestamp, as: 'receiveTimestamp' property :resource, as: 'resource', class: Google::Apis::LoggingV2beta1::MonitoredResource, decorator: Google::Apis::LoggingV2beta1::MonitoredResource::Representation property :severity, as: 'severity' property :source_location, as: 'sourceLocation', class: Google::Apis::LoggingV2beta1::LogEntrySourceLocation, decorator: Google::Apis::LoggingV2beta1::LogEntrySourceLocation::Representation property :span_id, as: 'spanId' property :text_payload, as: 'textPayload' property :timestamp, as: 'timestamp' property :trace, as: 'trace' end end class LogEntryOperation # @private class Representation < Google::Apis::Core::JsonRepresentation property :first, as: 'first' property :id, as: 'id' property :last, as: 'last' property :producer, as: 'producer' end end class LogEntrySourceLocation # @private class Representation < Google::Apis::Core::JsonRepresentation property :file, as: 'file' property :function, as: 'function' property :line, :numeric_string => true, as: 'line' end end class LogLine # @private class Representation < Google::Apis::Core::JsonRepresentation property :log_message, as: 'logMessage' property :severity, as: 'severity' property :source_location, as: 'sourceLocation', class: Google::Apis::LoggingV2beta1::SourceLocation, decorator: Google::Apis::LoggingV2beta1::SourceLocation::Representation property :time, as: 'time' end end class LogMetric # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_options, as: 'bucketOptions', class: Google::Apis::LoggingV2beta1::BucketOptions, decorator: Google::Apis::LoggingV2beta1::BucketOptions::Representation property :description, as: 'description' property :filter, as: 'filter' hash :label_extractors, as: 'labelExtractors' property :metric_descriptor, as: 'metricDescriptor', class: Google::Apis::LoggingV2beta1::MetricDescriptor, decorator: Google::Apis::LoggingV2beta1::MetricDescriptor::Representation property :name, as: 'name' property :value_extractor, as: 'valueExtractor' property :version, as: 'version' end end class LogSink # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination, as: 'destination' property :end_time, as: 'endTime' property :filter, as: 'filter' property :include_children, as: 'includeChildren' property :name, as: 'name' property :output_version_format, as: 'outputVersionFormat' property :start_time, as: 'startTime' property :writer_identity, as: 'writerIdentity' end end class MetricDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :display_name, as: 'displayName' collection :labels, as: 'labels', class: Google::Apis::LoggingV2beta1::LabelDescriptor, decorator: Google::Apis::LoggingV2beta1::LabelDescriptor::Representation property :metric_kind, as: 'metricKind' property :name, as: 'name' property :type, as: 'type' property :unit, as: 'unit' property :value_type, as: 'valueType' end end class MonitoredResource # @private class Representation < Google::Apis::Core::JsonRepresentation hash :labels, as: 'labels' property :type, as: 'type' end end class MonitoredResourceDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :display_name, as: 'displayName' collection :labels, as: 'labels', class: Google::Apis::LoggingV2beta1::LabelDescriptor, decorator: Google::Apis::LoggingV2beta1::LabelDescriptor::Representation property :name, as: 'name' property :type, as: 'type' end end class RequestLog # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_engine_release, as: 'appEngineRelease' property :app_id, as: 'appId' property :cost, as: 'cost' property :end_time, as: 'endTime' property :finished, as: 'finished' property :first, as: 'first' property :host, as: 'host' property :http_version, as: 'httpVersion' property :instance_id, as: 'instanceId' property :instance_index, as: 'instanceIndex' property :ip, as: 'ip' property :latency, as: 'latency' collection :line, as: 'line', class: Google::Apis::LoggingV2beta1::LogLine, decorator: Google::Apis::LoggingV2beta1::LogLine::Representation property :mega_cycles, :numeric_string => true, as: 'megaCycles' property :method_prop, as: 'method' property :module_id, as: 'moduleId' property :nickname, as: 'nickname' property :pending_time, as: 'pendingTime' property :referrer, as: 'referrer' property :request_id, as: 'requestId' property :resource, as: 'resource' property :response_size, :numeric_string => true, as: 'responseSize' collection :source_reference, as: 'sourceReference', class: Google::Apis::LoggingV2beta1::SourceReference, decorator: Google::Apis::LoggingV2beta1::SourceReference::Representation property :start_time, as: 'startTime' property :status, as: 'status' property :task_name, as: 'taskName' property :task_queue_name, as: 'taskQueueName' property :trace_id, as: 'traceId' property :url_map_entry, as: 'urlMapEntry' property :user_agent, as: 'userAgent' property :version_id, as: 'versionId' property :was_loading_request, as: 'wasLoadingRequest' end end class SourceLocation # @private class Representation < Google::Apis::Core::JsonRepresentation property :file, as: 'file' property :function_name, as: 'functionName' property :line, :numeric_string => true, as: 'line' end end class SourceReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :repository, as: 'repository' property :revision_id, as: 'revisionId' end end class WriteLogEntriesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :dry_run, as: 'dryRun' collection :entries, as: 'entries', class: Google::Apis::LoggingV2beta1::LogEntry, decorator: Google::Apis::LoggingV2beta1::LogEntry::Representation hash :labels, as: 'labels' property :log_name, as: 'logName' property :partial_success, as: 'partialSuccess' property :resource, as: 'resource', class: Google::Apis::LoggingV2beta1::MonitoredResource, decorator: Google::Apis::LoggingV2beta1::MonitoredResource::Representation end end class WriteLogEntriesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation end end end end end google-api-client-0.19.8/generated/google/apis/logging_v2beta1/classes.rb0000644000004100000410000022637113252673044026263 0ustar www-datawww-data# 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 LoggingV2beta1 # BucketOptions describes the bucket boundaries used to create a histogram for # the distribution. The buckets can be in a linear sequence, an exponential # sequence, or each bucket can be specified explicitly. BucketOptions does not # include the number of values in each bucket.A bucket has an inclusive lower # bound and exclusive upper bound for the values that are counted for that # bucket. The upper bound of a bucket must be strictly greater than the lower # bound. The sequence of N buckets for a distribution consists of an underflow # bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an # overflow bucket (number N - 1). The buckets are contiguous: the lower bound of # bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets # span the whole range of finite values: lower bound of the underflow bucket is - # infinity and the upper bound of the overflow bucket is +infinity. The finite # buckets are so-called because both bounds are finite. class BucketOptions include Google::Apis::Core::Hashable # Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= # N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): # boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at # least one element. If bounds has only one element, then there are no finite # buckets, and that single element is the common boundary of the overflow and # underflow buckets. # Corresponds to the JSON property `explicitBuckets` # @return [Google::Apis::LoggingV2beta1::Explicit] attr_accessor :explicit_buckets # Specifies an exponential sequence of buckets that have a width that is # proportional to the value of the lower bound. Each bucket represents a # constant relative uncertainty on a specific value in the bucket.There are # num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: # Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < # N): scale * (growth_factor ^ (i - 1)). # Corresponds to the JSON property `exponentialBuckets` # @return [Google::Apis::LoggingV2beta1::Exponential] attr_accessor :exponential_buckets # Specifies a linear sequence of buckets that all have the same width (except # overflow and underflow). Each bucket represents a constant absolute # uncertainty on the specific value in the bucket.There are num_finite_buckets + # 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N- # 1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)) # . # Corresponds to the JSON property `linearBuckets` # @return [Google::Apis::LoggingV2beta1::Linear] attr_accessor :linear_buckets def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @explicit_buckets = args[:explicit_buckets] if args.key?(:explicit_buckets) @exponential_buckets = args[:exponential_buckets] if args.key?(:exponential_buckets) @linear_buckets = args[:linear_buckets] if args.key?(:linear_buckets) 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 # Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= # N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): # boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at # least one element. If bounds has only one element, then there are no finite # buckets, and that single element is the common boundary of the overflow and # underflow buckets. class Explicit include Google::Apis::Core::Hashable # The values must be monotonically increasing. # Corresponds to the JSON property `bounds` # @return [Array] attr_accessor :bounds def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bounds = args[:bounds] if args.key?(:bounds) end end # Specifies an exponential sequence of buckets that have a width that is # proportional to the value of the lower bound. Each bucket represents a # constant relative uncertainty on a specific value in the bucket.There are # num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: # Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < # N): scale * (growth_factor ^ (i - 1)). class Exponential include Google::Apis::Core::Hashable # Must be greater than 1. # Corresponds to the JSON property `growthFactor` # @return [Float] attr_accessor :growth_factor # Must be greater than 0. # Corresponds to the JSON property `numFiniteBuckets` # @return [Fixnum] attr_accessor :num_finite_buckets # Must be greater than 0. # Corresponds to the JSON property `scale` # @return [Float] attr_accessor :scale def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @growth_factor = args[:growth_factor] if args.key?(:growth_factor) @num_finite_buckets = args[:num_finite_buckets] if args.key?(:num_finite_buckets) @scale = args[:scale] if args.key?(:scale) end end # A common proto for logging HTTP requests. Only contains semantics defined by # the HTTP specification. Product-specific logging information MUST be defined # in a separate message. class HttpRequest include Google::Apis::Core::Hashable # The number of HTTP response bytes inserted into cache. Set only when a cache # fill was attempted. # Corresponds to the JSON property `cacheFillBytes` # @return [Fixnum] attr_accessor :cache_fill_bytes # Whether or not an entity was served from cache (with or without validation). # Corresponds to the JSON property `cacheHit` # @return [Boolean] attr_accessor :cache_hit alias_method :cache_hit?, :cache_hit # Whether or not a cache lookup was attempted. # Corresponds to the JSON property `cacheLookup` # @return [Boolean] attr_accessor :cache_lookup alias_method :cache_lookup?, :cache_lookup # Whether or not the response was validated with the origin server before being # served from cache. This field is only meaningful if cache_hit is True. # Corresponds to the JSON property `cacheValidatedWithOriginServer` # @return [Boolean] attr_accessor :cache_validated_with_origin_server alias_method :cache_validated_with_origin_server?, :cache_validated_with_origin_server # The request processing latency on the server, from the time the request was # received until the response was sent. # Corresponds to the JSON property `latency` # @return [String] attr_accessor :latency # Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket" # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol # The referer URL of the request, as defined in HTTP/1.1 Header Field # Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). # Corresponds to the JSON property `referer` # @return [String] attr_accessor :referer # The IP address (IPv4 or IPv6) of the client that issued the HTTP request. # Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329". # Corresponds to the JSON property `remoteIp` # @return [String] attr_accessor :remote_ip # The request method. Examples: "GET", "HEAD", "PUT", "POST". # Corresponds to the JSON property `requestMethod` # @return [String] attr_accessor :request_method # The size of the HTTP request message in bytes, including the request headers # and the request body. # Corresponds to the JSON property `requestSize` # @return [Fixnum] attr_accessor :request_size # The scheme (http, https), the host name, the path and the query portion of the # URL that was requested. Example: "http://example.com/some/info?color=red". # Corresponds to the JSON property `requestUrl` # @return [String] attr_accessor :request_url # The size of the HTTP response message sent back to the client, in bytes, # including the response headers and the response body. # Corresponds to the JSON property `responseSize` # @return [Fixnum] attr_accessor :response_size # The IP address (IPv4 or IPv6) of the origin server that the request was sent # to. # Corresponds to the JSON property `serverIp` # @return [String] attr_accessor :server_ip # The response code indicating the status of response. Examples: 200, 404. # Corresponds to the JSON property `status` # @return [Fixnum] attr_accessor :status # The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; # Windows 98; Q312461; .NET CLR 1.0.3705)". # Corresponds to the JSON property `userAgent` # @return [String] attr_accessor :user_agent def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cache_fill_bytes = args[:cache_fill_bytes] if args.key?(:cache_fill_bytes) @cache_hit = args[:cache_hit] if args.key?(:cache_hit) @cache_lookup = args[:cache_lookup] if args.key?(:cache_lookup) @cache_validated_with_origin_server = args[:cache_validated_with_origin_server] if args.key?(:cache_validated_with_origin_server) @latency = args[:latency] if args.key?(:latency) @protocol = args[:protocol] if args.key?(:protocol) @referer = args[:referer] if args.key?(:referer) @remote_ip = args[:remote_ip] if args.key?(:remote_ip) @request_method = args[:request_method] if args.key?(:request_method) @request_size = args[:request_size] if args.key?(:request_size) @request_url = args[:request_url] if args.key?(:request_url) @response_size = args[:response_size] if args.key?(:response_size) @server_ip = args[:server_ip] if args.key?(:server_ip) @status = args[:status] if args.key?(:status) @user_agent = args[:user_agent] if args.key?(:user_agent) end end # A description of a label. class LabelDescriptor include Google::Apis::Core::Hashable # A human-readable description for the label. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The label key. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # The type of data that can be assigned to the label. # Corresponds to the JSON property `valueType` # @return [String] attr_accessor :value_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @key = args[:key] if args.key?(:key) @value_type = args[:value_type] if args.key?(:value_type) end end # Specifies a linear sequence of buckets that all have the same width (except # overflow and underflow). Each bucket represents a constant absolute # uncertainty on the specific value in the bucket.There are num_finite_buckets + # 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N- # 1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)) # . class Linear include Google::Apis::Core::Hashable # Must be greater than 0. # Corresponds to the JSON property `numFiniteBuckets` # @return [Fixnum] attr_accessor :num_finite_buckets # Lower bound of the first bucket. # Corresponds to the JSON property `offset` # @return [Float] attr_accessor :offset # Must be greater than 0. # Corresponds to the JSON property `width` # @return [Float] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @num_finite_buckets = args[:num_finite_buckets] if args.key?(:num_finite_buckets) @offset = args[:offset] if args.key?(:offset) @width = args[:width] if args.key?(:width) end end # The parameters to ListLogEntries. class ListLogEntriesRequest include Google::Apis::Core::Hashable # Optional. A filter that chooses which log entries to return. See Advanced Logs # Filters. Only log entries that match the filter are returned. An empty filter # matches all log entries in the resources listed in resource_names. Referencing # a parent resource that is not listed in resource_names will cause the filter # to return no results. The maximum length of the filter is 20000 characters. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # Optional. How the results should be sorted. Presently, the only permitted # values are "timestamp asc" (default) and "timestamp desc". The first option # returns entries in order of increasing values of LogEntry.timestamp (oldest # first), and the second option returns entries in order of decreasing # timestamps (newest first). Entries with equal timestamps are returned in order # of their insert_id values. # Corresponds to the JSON property `orderBy` # @return [String] attr_accessor :order_by # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of next_page_token in the response # indicates that more results might be available. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # Optional. If present, then retrieve the next batch of results from the # preceding call to this method. page_token must be the value of next_page_token # from the previous response. The values of other method parameters should be # identical to those in the previous call. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token # Deprecated. Use resource_names instead. One or more project identifiers or # project numbers from which to retrieve log entries. Example: "my-project-1A". # If present, these project identifiers are converted to resource name format # and added to the list of resources in resource_names. # Corresponds to the JSON property `projectIds` # @return [Array] attr_accessor :project_ids # Required. Names of one or more parent resources from which to retrieve log # entries: # "projects/[PROJECT_ID]" # "organizations/[ORGANIZATION_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]" # "folders/[FOLDER_ID]" # Projects listed in the project_ids field are added to this list. # Corresponds to the JSON property `resourceNames` # @return [Array] attr_accessor :resource_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filter = args[:filter] if args.key?(:filter) @order_by = args[:order_by] if args.key?(:order_by) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @project_ids = args[:project_ids] if args.key?(:project_ids) @resource_names = args[:resource_names] if args.key?(:resource_names) end end # Result returned from ListLogEntries. class ListLogEntriesResponse include Google::Apis::Core::Hashable # A list of log entries. If entries is empty, nextPageToken may still be # returned, indicating that more entries may exist. See nextPageToken for more # information. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # If there might be more results than those appearing in this response, then # nextPageToken is included. To get the next set of results, call this method # again using the value of nextPageToken as pageToken.If a value for # next_page_token appears and the entries field is empty, it means that the # search found no log entries so far but it did not have time to search all the # possible log entries. Retry the method with this value for page_token to # continue the search. Alternatively, consider speeding up the search by # changing your filter to specify a single log name or resource type, or to # narrow the time range of the search. # 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) @entries = args[:entries] if args.key?(:entries) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Result returned from ListLogMetrics. class ListLogMetricsResponse include Google::Apis::Core::Hashable # A list of logs-based metrics. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # If there might be more results than appear in this response, then # nextPageToken is included. To get the next set of results, call this method # again using the value of nextPageToken as pageToken. # 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) @metrics = args[:metrics] if args.key?(:metrics) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Result returned from ListLogs. class ListLogsResponse include Google::Apis::Core::Hashable # A list of log names. For example, "projects/my-project/syslog" or " # organizations/123/cloudresourcemanager.googleapis.com%2Factivity". # Corresponds to the JSON property `logNames` # @return [Array] attr_accessor :log_names # If there might be more results than those appearing in this response, then # nextPageToken is included. To get the next set of results, call this method # again using the value of nextPageToken as pageToken. # 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) @log_names = args[:log_names] if args.key?(:log_names) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Result returned from ListMonitoredResourceDescriptors. class ListMonitoredResourceDescriptorsResponse include Google::Apis::Core::Hashable # If there might be more results than those appearing in this response, then # nextPageToken is included. To get the next set of results, call this method # again using the value of nextPageToken as pageToken. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # A list of resource descriptors. # Corresponds to the JSON property `resourceDescriptors` # @return [Array] attr_accessor :resource_descriptors 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) @resource_descriptors = args[:resource_descriptors] if args.key?(:resource_descriptors) end end # Result returned from ListSinks. class ListSinksResponse include Google::Apis::Core::Hashable # If there might be more results than appear in this response, then # nextPageToken is included. To get the next set of results, call the same # method again using the value of nextPageToken as pageToken. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # A list of sinks. # Corresponds to the JSON property `sinks` # @return [Array] attr_accessor :sinks 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) @sinks = args[:sinks] if args.key?(:sinks) end end # An individual entry in a log. class LogEntry include Google::Apis::Core::Hashable # A common proto for logging HTTP requests. Only contains semantics defined by # the HTTP specification. Product-specific logging information MUST be defined # in a separate message. # Corresponds to the JSON property `httpRequest` # @return [Google::Apis::LoggingV2beta1::HttpRequest] attr_accessor :http_request # Optional. A unique identifier for the log entry. If you provide a value, then # Stackdriver Logging considers other log entries in the same project, with the # same timestamp, and with the same insert_id to be duplicates which can be # removed. If omitted in new log entries, then Stackdriver Logging assigns its # own unique identifier. The insert_id is also used to order log entries that # have the same timestamp value. # Corresponds to the JSON property `insertId` # @return [String] attr_accessor :insert_id # The log entry payload, represented as a structure that is expressed as a JSON # object. # Corresponds to the JSON property `jsonPayload` # @return [Hash] attr_accessor :json_payload # Optional. A set of user-defined (key, value) data that provides additional # information about the log entry. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Required. The resource name of the log to which this log entry belongs: # "projects/[PROJECT_ID]/logs/[LOG_ID]" # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" # "folders/[FOLDER_ID]/logs/[LOG_ID]" # A project number may optionally be used in place of PROJECT_ID. The project # number is translated to its corresponding PROJECT_ID internally and the # log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be # URL-encoded within log_name. Example: "organizations/1234567890/logs/ # cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than # 512 characters long and can only include the following characters: upper and # lower case alphanumeric characters, forward-slash, underscore, hyphen, and # period.For backward compatibility, if log_name begins with a forward-slash, # such as /projects/..., then the log entry is ingested as usual but the forward- # slash is removed. Listing the log entry will not show the leading slash and # filtering for a log name with a leading slash will never return any results. # Corresponds to the JSON property `logName` # @return [String] attr_accessor :log_name # Additional information about a potentially long-running operation with which a # log entry is associated. # Corresponds to the JSON property `operation` # @return [Google::Apis::LoggingV2beta1::LogEntryOperation] attr_accessor :operation # The log entry payload, represented as a protocol buffer. Some Google Cloud # Platform services use this field for their log entry payloads. # Corresponds to the JSON property `protoPayload` # @return [Hash] attr_accessor :proto_payload # Output only. The time the log entry was received by Stackdriver Logging. # Corresponds to the JSON property `receiveTimestamp` # @return [String] attr_accessor :receive_timestamp # An object representing a resource that can be used for monitoring, logging, # billing, or other purposes. Examples include virtual machine instances, # databases, and storage devices such as disks. The type field identifies a # MonitoredResourceDescriptor object that describes the resource's schema. # Information in the labels field identifies the actual resource and its # attributes according to the schema. For example, a particular Compute Engine # VM instance could be represented by the following object, because the # MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and " # zone": # ` "type": "gce_instance", # "labels": ` "instance_id": "12345678901234", # "zone": "us-central1-a" `` # Corresponds to the JSON property `resource` # @return [Google::Apis::LoggingV2beta1::MonitoredResource] attr_accessor :resource # Optional. The severity of the log entry. The default value is LogSeverity. # DEFAULT. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity # Additional information about the source code location that produced the log # entry. # Corresponds to the JSON property `sourceLocation` # @return [Google::Apis::LoggingV2beta1::LogEntrySourceLocation] attr_accessor :source_location # Optional. The span ID within the trace associated with the log entry. For # Stackdriver Trace spans, this is the same format that the Stackdriver Trace # API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as < # code>"000000000000004a". # Corresponds to the JSON property `spanId` # @return [String] attr_accessor :span_id # The log entry payload, represented as a Unicode string (UTF-8). # Corresponds to the JSON property `textPayload` # @return [String] attr_accessor :text_payload # Optional. The time the event described by the log entry occurred. This time is # used to compute the log entry's age and to enforce the logs retention period. # If this field is omitted in a new log entry, then Stackdriver Logging assigns # it the current time.Incoming log entries should have timestamps that are no # more than the logs retention period in the past, and no more than 24 hours in # the future. Log entries outside those time boundaries will not be available # when calling entries.list, but those log entries can still be exported with # LogSinks. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp # Optional. Resource name of the trace associated with the log entry, if any. If # it contains a relative resource name, the name is assumed to be relative to // # tracing.googleapis.com. Example: projects/my-projectid/traces/ # 06796866738c859f2f19b7cfb3214824 # Corresponds to the JSON property `trace` # @return [String] attr_accessor :trace def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @http_request = args[:http_request] if args.key?(:http_request) @insert_id = args[:insert_id] if args.key?(:insert_id) @json_payload = args[:json_payload] if args.key?(:json_payload) @labels = args[:labels] if args.key?(:labels) @log_name = args[:log_name] if args.key?(:log_name) @operation = args[:operation] if args.key?(:operation) @proto_payload = args[:proto_payload] if args.key?(:proto_payload) @receive_timestamp = args[:receive_timestamp] if args.key?(:receive_timestamp) @resource = args[:resource] if args.key?(:resource) @severity = args[:severity] if args.key?(:severity) @source_location = args[:source_location] if args.key?(:source_location) @span_id = args[:span_id] if args.key?(:span_id) @text_payload = args[:text_payload] if args.key?(:text_payload) @timestamp = args[:timestamp] if args.key?(:timestamp) @trace = args[:trace] if args.key?(:trace) end end # Additional information about a potentially long-running operation with which a # log entry is associated. class LogEntryOperation include Google::Apis::Core::Hashable # Optional. Set this to True if this is the first log entry in the operation. # Corresponds to the JSON property `first` # @return [Boolean] attr_accessor :first alias_method :first?, :first # Optional. An arbitrary operation identifier. Log entries with the same # identifier are assumed to be part of the same operation. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Optional. Set this to True if this is the last log entry in the operation. # Corresponds to the JSON property `last` # @return [Boolean] attr_accessor :last alias_method :last?, :last # Optional. An arbitrary producer identifier. The combination of id and producer # must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", # "github.com/MyProject/MyApplication". # Corresponds to the JSON property `producer` # @return [String] attr_accessor :producer def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @first = args[:first] if args.key?(:first) @id = args[:id] if args.key?(:id) @last = args[:last] if args.key?(:last) @producer = args[:producer] if args.key?(:producer) end end # Additional information about the source code location that produced the log # entry. class LogEntrySourceLocation include Google::Apis::Core::Hashable # Optional. Source file name. Depending on the runtime environment, this might # be a simple name or a fully-qualified name. # Corresponds to the JSON property `file` # @return [String] attr_accessor :file # Optional. Human-readable name of the function or method being invoked, with # optional context such as the class or package name. This information may be # used in contexts such as the logs viewer, where a file and line number are # less meaningful. The format can vary by language. For example: qual.if.ied. # Class.method (Java), dir/package.func (Go), function (Python). # Corresponds to the JSON property `function` # @return [String] attr_accessor :function # Optional. Line within the source file. 1-based; 0 indicates no line number # available. # Corresponds to the JSON property `line` # @return [Fixnum] attr_accessor :line def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file = args[:file] if args.key?(:file) @function = args[:function] if args.key?(:function) @line = args[:line] if args.key?(:line) end end # Application log line emitted while processing a request. class LogLine include Google::Apis::Core::Hashable # App-provided log message. # Corresponds to the JSON property `logMessage` # @return [String] attr_accessor :log_message # Severity of this log entry. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity # Specifies a location in a source code file. # Corresponds to the JSON property `sourceLocation` # @return [Google::Apis::LoggingV2beta1::SourceLocation] attr_accessor :source_location # Approximate time when this log entry was made. # 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) @log_message = args[:log_message] if args.key?(:log_message) @severity = args[:severity] if args.key?(:severity) @source_location = args[:source_location] if args.key?(:source_location) @time = args[:time] if args.key?(:time) end end # Describes a logs-based metric. The value of the metric is the number of log # entries that match a logs filter in a given time interval.Logs-based metric # can also be used to extract values from logs and create a a distribution of # the values. The distribution records the statistics of the extracted values # along with an optional histogram of the values as specified by the bucket # options. class LogMetric include Google::Apis::Core::Hashable # BucketOptions describes the bucket boundaries used to create a histogram for # the distribution. The buckets can be in a linear sequence, an exponential # sequence, or each bucket can be specified explicitly. BucketOptions does not # include the number of values in each bucket.A bucket has an inclusive lower # bound and exclusive upper bound for the values that are counted for that # bucket. The upper bound of a bucket must be strictly greater than the lower # bound. The sequence of N buckets for a distribution consists of an underflow # bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an # overflow bucket (number N - 1). The buckets are contiguous: the lower bound of # bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets # span the whole range of finite values: lower bound of the underflow bucket is - # infinity and the upper bound of the overflow bucket is +infinity. The finite # buckets are so-called because both bounds are finite. # Corresponds to the JSON property `bucketOptions` # @return [Google::Apis::LoggingV2beta1::BucketOptions] attr_accessor :bucket_options # Optional. A description of this metric, which is used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Required. An advanced logs filter which is used to match log entries. Example: # "resource.type=gae_app AND severity>=ERROR" # The maximum length of the filter is 20000 characters. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # Optional. A map from a label key string to an extractor expression which is # used to extract data from a log entry field and assign as the label value. # Each label key specified in the LabelDescriptor must have an associated # extractor expression in this map. The syntax of the extractor expression is # the same as for the value_extractor field.The extracted value is converted to # the type defined in the label descriptor. If the either the extraction or the # type conversion fails, the label will have a default value. The default value # for a string label is an empty string, for an integer label its 0, and for a # boolean label its false.Note that there are upper bounds on the maximum number # of labels and the number of active time series that are allowed in a project. # Corresponds to the JSON property `labelExtractors` # @return [Hash] attr_accessor :label_extractors # Defines a metric type and its schema. Once a metric descriptor is created, # deleting or altering it stops data collection and makes the metric type's # existing data unusable. # Corresponds to the JSON property `metricDescriptor` # @return [Google::Apis::LoggingV2beta1::MetricDescriptor] attr_accessor :metric_descriptor # Required. The client-assigned metric identifier. Examples: "error_count", " # nginx/requests".Metric identifiers are limited to 100 characters and can # include only the following characters: A-Z, a-z, 0-9, and the special # characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy # of name pieces, and it cannot be the first character of the name.The metric # identifier in this field must not be URL-encoded (https://en.wikipedia.org/ # wiki/Percent-encoding). However, when the metric identifier appears as the [ # METRIC_ID] part of a metric_name API parameter, then the metric identifier # must be URL-encoded. Example: "projects/my-project/metrics/nginx%2Frequests". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. A value_extractor is required when using a distribution logs-based # metric to extract the values to record from a log entry. Two functions are # supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). # The argument are: 1. field: The name of the log entry field from which the # value is to be extracted. 2. regex: A regular expression using the Google # RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture # group to extract data from the specified log entry field. The value of the # field is converted to a string before applying the regex. It is an error to # specify a regex that does not include exactly one capture group.The result of # the extraction must be convertible to a double type, as the distribution # always records double values. If either the extraction or the conversion to # double fails, then those values are not recorded in the distribution.Example: # REGEXP_EXTRACT(jsonPayload.request, ".*quantity=(\d+).*") # Corresponds to the JSON property `valueExtractor` # @return [String] attr_accessor :value_extractor # Deprecated. The API version that created or updated this metric. The v2 format # is used by default and cannot be changed. # 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) @bucket_options = args[:bucket_options] if args.key?(:bucket_options) @description = args[:description] if args.key?(:description) @filter = args[:filter] if args.key?(:filter) @label_extractors = args[:label_extractors] if args.key?(:label_extractors) @metric_descriptor = args[:metric_descriptor] if args.key?(:metric_descriptor) @name = args[:name] if args.key?(:name) @value_extractor = args[:value_extractor] if args.key?(:value_extractor) @version = args[:version] if args.key?(:version) end end # Describes a sink used to export log entries to one of the following # destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a # Cloud Pub/Sub topic. A logs filter controls which log entries are exported. # The sink must be created within a project, organization, billing account, or # folder. class LogSink include Google::Apis::Core::Hashable # Required. The export destination: # "storage.googleapis.com/[GCS_BUCKET]" # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" # "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" # The sink's writer_identity, set when the sink is created, must have permission # to write to the destination or else the log entries are not exported. For more # information, see Exporting Logs With Sinks. # Corresponds to the JSON property `destination` # @return [String] attr_accessor :destination # Deprecated. This field is ignored when creating or updating sinks. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Optional. An advanced logs filter. The only exported log entries are those # that are in the resource owning the sink and that match the filter. For # example: # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # Optional. This field applies only to sinks owned by organizations and folders. # If the field is false, the default, only the logs owned by the sink's parent # resource are available for export. If the field is true, then logs from all # the projects, folders, and billing accounts contained in the sink's parent # resource are also available for export. Whether a particular log entry from # the children is exported depends on the sink's filter expression. For example, # if this field is true, then the filter resource.type=gce_instance would export # all Compute Engine VM instance log entries from all projects in the sink's # parent. To only export entries from certain child projects, filter on the # project part of the log name: # logName:("projects/test-project1/" OR "projects/test-project2/") AND # resource.type=gce_instance # Corresponds to the JSON property `includeChildren` # @return [Boolean] attr_accessor :include_children alias_method :include_children?, :include_children # Required. The client-assigned sink identifier, unique within the project. # Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 # characters and can include only the following characters: upper and lower-case # alphanumeric characters, underscores, hyphens, and periods. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Deprecated. The log entry format to use for this sink's exported log entries. # The v2 format is used by default and cannot be changed. # Corresponds to the JSON property `outputVersionFormat` # @return [String] attr_accessor :output_version_format # Deprecated. This field is ignored when creating or updating sinks. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Output only. An IAM identity—a service account or group—under # which Stackdriver Logging writes the exported log entries to the sink's # destination. This field is set by sinks.create and sinks.update, based on the # setting of unique_writer_identity in those methods.Until you grant this # identity write-access to the destination, log entry exports from this sink # will fail. For more information, see Granting access for a resource. Consult # the destination service's documentation to determine the appropriate IAM roles # to assign to the identity. # Corresponds to the JSON property `writerIdentity` # @return [String] attr_accessor :writer_identity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @destination = args[:destination] if args.key?(:destination) @end_time = args[:end_time] if args.key?(:end_time) @filter = args[:filter] if args.key?(:filter) @include_children = args[:include_children] if args.key?(:include_children) @name = args[:name] if args.key?(:name) @output_version_format = args[:output_version_format] if args.key?(:output_version_format) @start_time = args[:start_time] if args.key?(:start_time) @writer_identity = args[:writer_identity] if args.key?(:writer_identity) end end # Defines a metric type and its schema. Once a metric descriptor is created, # deleting or altering it stops data collection and makes the metric type's # existing data unusable. class MetricDescriptor include Google::Apis::Core::Hashable # A detailed description of the metric, which can be used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # A concise name for the metric, which can be displayed in user interfaces. Use # sentence case without an ending period, for example "Request count". This # field is optional but it is recommended to be set for any metrics associated # with user-visible concepts, such as Quota. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The set of labels that can be used to describe a specific instance of this # metric type. For example, the appengine.googleapis.com/http/server/ # response_latencies metric type has a label for the HTTP response code, # response_code, so you can look at latencies for successful responses or just # for responses that failed. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Whether the metric records instantaneous values, changes to a value, etc. Some # combinations of metric_kind and value_type might not be supported. # Corresponds to the JSON property `metricKind` # @return [String] attr_accessor :metric_kind # The resource name of the metric descriptor. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The metric type, including its DNS name prefix. The type is not URL-encoded. # All user-defined custom metric types have the DNS name custom.googleapis.com. # Metric types should use a natural hierarchical grouping. For example: # "custom.googleapis.com/invoice/paid/amount" # "appengine.googleapis.com/http/server/response_latencies" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The unit in which the metric value is reported. It is only applicable if the # value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset # of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) # standard:Basic units (UNIT) # bit bit # By byte # s second # min minute # h hour # d dayPrefixes (PREFIX) # k kilo (10**3) # M mega (10**6) # G giga (10**9) # T tera (10**12) # P peta (10**15) # E exa (10**18) # Z zetta (10**21) # Y yotta (10**24) # m milli (10**-3) # u micro (10**-6) # n nano (10**-9) # p pico (10**-12) # f femto (10**-15) # a atto (10**-18) # z zepto (10**-21) # y yocto (10**-24) # Ki kibi (2**10) # Mi mebi (2**20) # Gi gibi (2**30) # Ti tebi (2**40)GrammarThe grammar also includes these connectors: # / division (as an infix operator, e.g. 1/s). # . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is # as follows: # Expression = Component ` "." Component ` ` "/" Component ` ; # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] # | Annotation # | "1" # ; # Annotation = "`" NAME "`" ; # Notes: # Annotation is just a comment if it follows a UNIT and is equivalent to 1 if # it is used alone. For examples, `requests`/s == 1/s, By`transmitted`/s == By/ # s. # NAME is a sequence of non-blank printable ASCII characters not containing '`' # or '`'. # 1 represents dimensionless value 1, such as in 1/s. # % represents dimensionless value 1/100, and annotates values giving a # percentage. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # Whether the measurement is an integer, a floating-point number, etc. Some # combinations of metric_kind and value_type might not be supported. # Corresponds to the JSON property `valueType` # @return [String] attr_accessor :value_type 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) @labels = args[:labels] if args.key?(:labels) @metric_kind = args[:metric_kind] if args.key?(:metric_kind) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) @unit = args[:unit] if args.key?(:unit) @value_type = args[:value_type] if args.key?(:value_type) end end # An object representing a resource that can be used for monitoring, logging, # billing, or other purposes. Examples include virtual machine instances, # databases, and storage devices such as disks. The type field identifies a # MonitoredResourceDescriptor object that describes the resource's schema. # Information in the labels field identifies the actual resource and its # attributes according to the schema. For example, a particular Compute Engine # VM instance could be represented by the following object, because the # MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and " # zone": # ` "type": "gce_instance", # "labels": ` "instance_id": "12345678901234", # "zone": "us-central1-a" `` class MonitoredResource include Google::Apis::Core::Hashable # Required. Values for all of the labels listed in the associated monitored # resource descriptor. For example, Compute Engine VM instances use the labels " # project_id", "instance_id", and "zone". # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Required. The monitored resource type. This field must match the type field of # a MonitoredResourceDescriptor object. For example, the type of a Compute # Engine VM instance is gce_instance. # 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) @labels = args[:labels] if args.key?(:labels) @type = args[:type] if args.key?(:type) end end # An object that describes the schema of a MonitoredResource object using a type # name and a set of labels. For example, the monitored resource descriptor for # Google Compute Engine VM instances has a type of "gce_instance" and specifies # the use of the labels "instance_id" and "zone" to identify particular VM # instances.Different APIs can support different monitored resource types. APIs # generally provide a list method that returns the monitored resource # descriptors used by the API. class MonitoredResourceDescriptor include Google::Apis::Core::Hashable # Optional. A detailed description of the monitored resource type that might be # used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional. A concise name for the monitored resource type that might be # displayed in user interfaces. It should be a Title Cased Noun Phrase, without # any article or other determiners. For example, "Google Cloud SQL Database". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Required. A set of labels used to describe instances of this monitored # resource type. For example, an individual Google Cloud SQL database is # identified by values for the labels "database_id" and "zone". # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Optional. The resource name of the monitored resource descriptor: "projects/` # project_id`/monitoredResourceDescriptors/`type`" where `type` is the value of # the type field in this object and `project_id` is a project ID that provides # API-specific context for accessing the type. APIs that do not use project # information can use the resource name format "monitoredResourceDescriptors/` # type`". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. The monitored resource type. For example, the type " # cloudsql_database" represents databases in Google Cloud SQL. The maximum # length of this value is 256 characters. # 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) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) end end # Complete log information about a single HTTP request to an App Engine # application. class RequestLog include Google::Apis::Core::Hashable # App Engine release version. # Corresponds to the JSON property `appEngineRelease` # @return [String] attr_accessor :app_engine_release # Application that handled this request. # Corresponds to the JSON property `appId` # @return [String] attr_accessor :app_id # An indication of the relative cost of serving this request. # Corresponds to the JSON property `cost` # @return [Float] attr_accessor :cost # Time when the request finished. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Whether this request is finished or active. # Corresponds to the JSON property `finished` # @return [Boolean] attr_accessor :finished alias_method :finished?, :finished # Whether this is the first RequestLog entry for this request. If an active # request has several RequestLog entries written to Stackdriver Logging, then # this field will be set for one of them. # Corresponds to the JSON property `first` # @return [Boolean] attr_accessor :first alias_method :first?, :first # Internet host and port number of the resource being requested. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # HTTP version of request. Example: "HTTP/1.1". # Corresponds to the JSON property `httpVersion` # @return [String] attr_accessor :http_version # An identifier for the instance that handled the request. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id # If the instance processing this request belongs to a manually scaled module, # then this is the 0-based index of the instance. Otherwise, this value is -1. # Corresponds to the JSON property `instanceIndex` # @return [Fixnum] attr_accessor :instance_index # Origin IP address. # Corresponds to the JSON property `ip` # @return [String] attr_accessor :ip # Latency of the request. # Corresponds to the JSON property `latency` # @return [String] attr_accessor :latency # A list of log lines emitted by the application while serving this request. # Corresponds to the JSON property `line` # @return [Array] attr_accessor :line # Number of CPU megacycles used to process request. # Corresponds to the JSON property `megaCycles` # @return [Fixnum] attr_accessor :mega_cycles # Request method. Example: "GET", "HEAD", "PUT", "POST", "DELETE". # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # Module of the application that handled this request. # Corresponds to the JSON property `moduleId` # @return [String] attr_accessor :module_id # The logged-in user who made the request.Most likely, this is the part of the # user's email before the @ sign. The field value is the same for different # requests from the same user, but different users can have similar names. This # information is also available to the application via the App Engine Users API. # This field will be populated starting with App Engine 1.9.21. # Corresponds to the JSON property `nickname` # @return [String] attr_accessor :nickname # Time this request spent in the pending request queue. # Corresponds to the JSON property `pendingTime` # @return [String] attr_accessor :pending_time # Referrer URL of request. # Corresponds to the JSON property `referrer` # @return [String] attr_accessor :referrer # Globally unique identifier for a request, which is based on the request start # time. Request IDs for requests which started later will compare greater as # strings than those for requests which started earlier. # Corresponds to the JSON property `requestId` # @return [String] attr_accessor :request_id # Contains the path and query portion of the URL that was requested. For example, # if the URL was "http://example.com/app?name=val", the resource would be "/app? # name=val". The fragment identifier, which is identified by the # character, is # not included. # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource # Size in bytes sent back to client by request. # Corresponds to the JSON property `responseSize` # @return [Fixnum] attr_accessor :response_size # Source code for the application that handled this request. There can be more # than one source reference per deployed application if source code is # distributed among multiple repositories. # Corresponds to the JSON property `sourceReference` # @return [Array] attr_accessor :source_reference # Time when the request started. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # HTTP response status code. Example: 200, 404. # Corresponds to the JSON property `status` # @return [Fixnum] attr_accessor :status # Task name of the request, in the case of an offline request. # Corresponds to the JSON property `taskName` # @return [String] attr_accessor :task_name # Queue name of the request, in the case of an offline request. # Corresponds to the JSON property `taskQueueName` # @return [String] attr_accessor :task_queue_name # Stackdriver Trace identifier for this request. # Corresponds to the JSON property `traceId` # @return [String] attr_accessor :trace_id # File or class that handled the request. # Corresponds to the JSON property `urlMapEntry` # @return [String] attr_accessor :url_map_entry # User agent that made the request. # Corresponds to the JSON property `userAgent` # @return [String] attr_accessor :user_agent # Version of the application that handled this request. # Corresponds to the JSON property `versionId` # @return [String] attr_accessor :version_id # Whether this was a loading request for the instance. # Corresponds to the JSON property `wasLoadingRequest` # @return [Boolean] attr_accessor :was_loading_request alias_method :was_loading_request?, :was_loading_request def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @app_engine_release = args[:app_engine_release] if args.key?(:app_engine_release) @app_id = args[:app_id] if args.key?(:app_id) @cost = args[:cost] if args.key?(:cost) @end_time = args[:end_time] if args.key?(:end_time) @finished = args[:finished] if args.key?(:finished) @first = args[:first] if args.key?(:first) @host = args[:host] if args.key?(:host) @http_version = args[:http_version] if args.key?(:http_version) @instance_id = args[:instance_id] if args.key?(:instance_id) @instance_index = args[:instance_index] if args.key?(:instance_index) @ip = args[:ip] if args.key?(:ip) @latency = args[:latency] if args.key?(:latency) @line = args[:line] if args.key?(:line) @mega_cycles = args[:mega_cycles] if args.key?(:mega_cycles) @method_prop = args[:method_prop] if args.key?(:method_prop) @module_id = args[:module_id] if args.key?(:module_id) @nickname = args[:nickname] if args.key?(:nickname) @pending_time = args[:pending_time] if args.key?(:pending_time) @referrer = args[:referrer] if args.key?(:referrer) @request_id = args[:request_id] if args.key?(:request_id) @resource = args[:resource] if args.key?(:resource) @response_size = args[:response_size] if args.key?(:response_size) @source_reference = args[:source_reference] if args.key?(:source_reference) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @task_name = args[:task_name] if args.key?(:task_name) @task_queue_name = args[:task_queue_name] if args.key?(:task_queue_name) @trace_id = args[:trace_id] if args.key?(:trace_id) @url_map_entry = args[:url_map_entry] if args.key?(:url_map_entry) @user_agent = args[:user_agent] if args.key?(:user_agent) @version_id = args[:version_id] if args.key?(:version_id) @was_loading_request = args[:was_loading_request] if args.key?(:was_loading_request) end end # Specifies a location in a source code file. class SourceLocation include Google::Apis::Core::Hashable # Source file name. Depending on the runtime environment, this might be a simple # name or a fully-qualified name. # Corresponds to the JSON property `file` # @return [String] attr_accessor :file # Human-readable name of the function or method being invoked, with optional # context such as the class or package name. This information is used in # contexts such as the logs viewer, where a file and line number are less # meaningful. The format can vary by language. For example: qual.if.ied.Class. # method (Java), dir/package.func (Go), function (Python). # Corresponds to the JSON property `functionName` # @return [String] attr_accessor :function_name # Line within the source file. # Corresponds to the JSON property `line` # @return [Fixnum] attr_accessor :line def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file = args[:file] if args.key?(:file) @function_name = args[:function_name] if args.key?(:function_name) @line = args[:line] if args.key?(:line) end end # A reference to a particular snapshot of the source tree used to build and # deploy an application. class SourceReference include Google::Apis::Core::Hashable # Optional. A URI string identifying the repository. Example: "https://github. # com/GoogleCloudPlatform/kubernetes.git" # Corresponds to the JSON property `repository` # @return [String] attr_accessor :repository # The canonical and persistent identifier of the deployed revision. Example (git) # : "0035781c50ec7aa23385dc841529ce8a4b70db1b" # Corresponds to the JSON property `revisionId` # @return [String] attr_accessor :revision_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @repository = args[:repository] if args.key?(:repository) @revision_id = args[:revision_id] if args.key?(:revision_id) end end # The parameters to WriteLogEntries. class WriteLogEntriesRequest include Google::Apis::Core::Hashable # Optional. If true, the request should expect normal response, but the entries # won't be persisted nor exported. Useful for checking whether the logging API # endpoints are working properly before sending valuable data. # Corresponds to the JSON property `dryRun` # @return [Boolean] attr_accessor :dry_run alias_method :dry_run?, :dry_run # Required. The log entries to send to Stackdriver Logging. The order of log # entries in this list does not matter. Values supplied in this method's # log_name, resource, and labels fields are copied into those log entries in # this list that do not include values for their corresponding fields. For more # information, see the LogEntry type.If the timestamp or insert_id fields are # missing in log entries, then this method supplies the current time or a unique # identifier, respectively. The supplied values are chosen so that, among the # log entries that did not supply their own values, the entries earlier in the # list will sort before the entries later in the list. See the entries.list # method.Log entries with timestamps that are more than the logs retention # period in the past or more than 24 hours in the future will not be available # when calling entries.list. However, those log entries can still be exported # with LogSinks.To improve throughput and to avoid exceeding the quota limit for # calls to entries.write, you should try to include several log entries in this # list, rather than calling this method for each individual log entry. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Optional. Default labels that are added to the labels field of all log entries # in entries. If a log entry already has a label with the same key as a label in # this parameter, then the log entry's label is not changed. See LogEntry. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Optional. A default log resource name that is assigned to all log entries in # entries that do not specify a value for log_name: # "projects/[PROJECT_ID]/logs/[LOG_ID]" # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" # "folders/[FOLDER_ID]/logs/[LOG_ID]" # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" # or "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% # 2Factivity". For more information about log names, see LogEntry. # Corresponds to the JSON property `logName` # @return [String] attr_accessor :log_name # Optional. Whether valid entries should be written even if some other entries # fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not # written, then the response status is the error associated with one of the # failed entries and the response includes error details keyed by the entries' # zero-based index in the entries.write method. # Corresponds to the JSON property `partialSuccess` # @return [Boolean] attr_accessor :partial_success alias_method :partial_success?, :partial_success # An object representing a resource that can be used for monitoring, logging, # billing, or other purposes. Examples include virtual machine instances, # databases, and storage devices such as disks. The type field identifies a # MonitoredResourceDescriptor object that describes the resource's schema. # Information in the labels field identifies the actual resource and its # attributes according to the schema. For example, a particular Compute Engine # VM instance could be represented by the following object, because the # MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and " # zone": # ` "type": "gce_instance", # "labels": ` "instance_id": "12345678901234", # "zone": "us-central1-a" `` # Corresponds to the JSON property `resource` # @return [Google::Apis::LoggingV2beta1::MonitoredResource] attr_accessor :resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dry_run = args[:dry_run] if args.key?(:dry_run) @entries = args[:entries] if args.key?(:entries) @labels = args[:labels] if args.key?(:labels) @log_name = args[:log_name] if args.key?(:log_name) @partial_success = args[:partial_success] if args.key?(:partial_success) @resource = args[:resource] if args.key?(:resource) end end # Result returned from WriteLogEntries. empty class WriteLogEntriesResponse include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end end end end google-api-client-0.19.8/generated/google/apis/logging_v2beta1/service.rb0000644000004100000410000014304713252673044026264 0ustar www-datawww-data# 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 LoggingV2beta1 # Stackdriver Logging API # # Writes log entries and manages your Stackdriver Logging configuration. # # @example # require 'google/apis/logging_v2beta1' # # Logging = Google::Apis::LoggingV2beta1 # Alias the module # service = Logging::LoggingService.new # # @see https://cloud.google.com/logging/docs/ class LoggingService < 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://logging.googleapis.com/', '') @batch_path = 'batch' end # Deletes all the log entries in a log. The log reappears if it receives new # entries. Log entries written shortly before the delete operation might not be # deleted. # @param [String] log_name # Required. The resource name of the log to delete: # "projects/[PROJECT_ID]/logs/[LOG_ID]" # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" # "folders/[FOLDER_ID]/logs/[LOG_ID]" # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% # 2Factivity". For more information about log names, see LogEntry. # @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::LoggingV2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::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_billing_account_log(log_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+logName}', options) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['logName'] = log_name unless log_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 logs in projects, organizations, folders, or billing accounts. Only # logs that have entries are listed. # @param [String] parent # Required. The resource name that owns the logs: # "projects/[PROJECT_ID]" # "organizations/[ORGANIZATION_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]" # "folders/[FOLDER_ID]" # @param [Fixnum] page_size # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. # @param [String] page_token # Optional. If present, then retrieve the next batch of results from the # preceding call to this method. pageToken must be the value of nextPageToken # from the previous response. The values of other method parameters should be # identical to those in the previous call. # @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::LoggingV2beta1::ListLogsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::ListLogsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_billing_account_logs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options) command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse 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 # Lists log entries. Use this method to retrieve log entries from Stackdriver # Logging. For ways to export log entries, see Exporting Logs. # @param [Google::Apis::LoggingV2beta1::ListLogEntriesRequest] list_log_entries_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::LoggingV2beta1::ListLogEntriesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::ListLogEntriesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_entry_log_entries(list_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/entries:list', options) command.request_representation = Google::Apis::LoggingV2beta1::ListLogEntriesRequest::Representation command.request_object = list_log_entries_request_object command.response_representation = Google::Apis::LoggingV2beta1::ListLogEntriesResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogEntriesResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Log entry resourcesWrites log entries to Stackdriver Logging. This API method # is the only way to send log entries to Stackdriver Logging. This method is # used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and # all logging libraries configured to use Stackdriver Logging. # @param [Google::Apis::LoggingV2beta1::WriteLogEntriesRequest] write_log_entries_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::LoggingV2beta1::WriteLogEntriesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::WriteLogEntriesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def write_entry_log_entries(write_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/entries:write', options) command.request_representation = Google::Apis::LoggingV2beta1::WriteLogEntriesRequest::Representation command.request_object = write_log_entries_request_object command.response_representation = Google::Apis::LoggingV2beta1::WriteLogEntriesResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::WriteLogEntriesResponse 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 descriptors for monitored resource types used by Stackdriver Logging. # @param [Fixnum] page_size # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. # @param [String] page_token # Optional. If present, then retrieve the next batch of results from the # preceding call to this method. pageToken must be the value of nextPageToken # from the previous response. The values of other method parameters should be # identical to those in the previous call. # @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::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_monitored_resource_descriptors(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/monitoredResourceDescriptors', options) command.response_representation = Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse 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 the log entries in a log. The log reappears if it receives new # entries. Log entries written shortly before the delete operation might not be # deleted. # @param [String] log_name # Required. The resource name of the log to delete: # "projects/[PROJECT_ID]/logs/[LOG_ID]" # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" # "folders/[FOLDER_ID]/logs/[LOG_ID]" # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% # 2Factivity". For more information about log names, see LogEntry. # @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::LoggingV2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::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_organization_log(log_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+logName}', options) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['logName'] = log_name unless log_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 logs in projects, organizations, folders, or billing accounts. Only # logs that have entries are listed. # @param [String] parent # Required. The resource name that owns the logs: # "projects/[PROJECT_ID]" # "organizations/[ORGANIZATION_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]" # "folders/[FOLDER_ID]" # @param [Fixnum] page_size # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. # @param [String] page_token # Optional. If present, then retrieve the next batch of results from the # preceding call to this method. pageToken must be the value of nextPageToken # from the previous response. The values of other method parameters should be # identical to those in the previous call. # @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::LoggingV2beta1::ListLogsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::ListLogsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_logs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options) command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse 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 the log entries in a log. The log reappears if it receives new # entries. Log entries written shortly before the delete operation might not be # deleted. # @param [String] log_name # Required. The resource name of the log to delete: # "projects/[PROJECT_ID]/logs/[LOG_ID]" # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" # "folders/[FOLDER_ID]/logs/[LOG_ID]" # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% # 2Factivity". For more information about log names, see LogEntry. # @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::LoggingV2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::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_log(log_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+logName}', options) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['logName'] = log_name unless log_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 logs in projects, organizations, folders, or billing accounts. Only # logs that have entries are listed. # @param [String] parent # Required. The resource name that owns the logs: # "projects/[PROJECT_ID]" # "organizations/[ORGANIZATION_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]" # "folders/[FOLDER_ID]" # @param [Fixnum] page_size # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. # @param [String] page_token # Optional. If present, then retrieve the next batch of results from the # preceding call to this method. pageToken must be the value of nextPageToken # from the previous response. The values of other method parameters should be # identical to those in the previous call. # @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::LoggingV2beta1::ListLogsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::ListLogsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_logs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options) command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse 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 # Creates a logs-based metric. # @param [String] parent # The resource name of the project in which to create the metric: # "projects/[PROJECT_ID]" # The new metric must be provided in the request. # @param [Google::Apis::LoggingV2beta1::LogMetric] log_metric_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::LoggingV2beta1::LogMetric] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::LogMetric] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metric(parent, log_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+parent}/metrics', options) command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.request_object = log_metric_object command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.response_class = Google::Apis::LoggingV2beta1::LogMetric 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 logs-based metric. # @param [String] metric_name # The resource name of the metric to delete: # "projects/[PROJECT_ID]/metrics/[METRIC_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::LoggingV2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::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_metric(metric_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+metricName}', options) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['metricName'] = metric_name unless metric_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 logs-based metric. # @param [String] metric_name # The resource name of the desired metric: # "projects/[PROJECT_ID]/metrics/[METRIC_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::LoggingV2beta1::LogMetric] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::LogMetric] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metric(metric_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+metricName}', options) command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.response_class = Google::Apis::LoggingV2beta1::LogMetric command.params['metricName'] = metric_name unless metric_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 logs-based metrics. # @param [String] parent # Required. The name of the project containing the metrics: # "projects/[PROJECT_ID]" # @param [Fixnum] page_size # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. # @param [String] page_token # Optional. If present, then retrieve the next batch of results from the # preceding call to this method. pageToken must be the value of nextPageToken # from the previous response. The values of other method parameters should be # identical to those in the previous call. # @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::LoggingV2beta1::ListLogMetricsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::ListLogMetricsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/metrics', options) command.response_representation = Google::Apis::LoggingV2beta1::ListLogMetricsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogMetricsResponse 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 # Creates or updates a logs-based metric. # @param [String] metric_name # The resource name of the metric to update: # "projects/[PROJECT_ID]/metrics/[METRIC_ID]" # The updated metric must be provided in the request and it's name field must be # the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a # new metric is created. # @param [Google::Apis::LoggingV2beta1::LogMetric] log_metric_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::LoggingV2beta1::LogMetric] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::LogMetric] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_metric(metric_name, log_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v2beta1/{+metricName}', options) command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.request_object = log_metric_object command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.response_class = Google::Apis::LoggingV2beta1::LogMetric command.params['metricName'] = metric_name unless metric_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 sink that exports specified log entries to a destination. The export # of newly-ingested log entries begins immediately, unless the sink's # writer_identity is not permitted to write to the destination. A sink can # export log entries only from the resource owning the sink. # @param [String] parent # Required. The resource in which to create the sink: # "projects/[PROJECT_ID]" # "organizations/[ORGANIZATION_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]" # "folders/[FOLDER_ID]" # Examples: "projects/my-logging-project", "organizations/123456789". # @param [Google::Apis::LoggingV2beta1::LogSink] log_sink_object # @param [Boolean] unique_writer_identity # Optional. Determines the kind of IAM identity returned as writer_identity in # the new sink. If this value is omitted or set to false, and if the sink's # parent is a project, then the value returned as writer_identity is the same # group or service account used by Stackdriver Logging before the addition of # writer identities to this API. The sink's destination must be in the same # project as the sink itself.If this field is set to true, or if the sink is # owned by a non-project resource such as an organization, then the value of # writer_identity will be a unique service account used only for exports from # the new sink. For more information, see writer_identity in LogSink. # @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::LoggingV2beta1::LogSink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::LogSink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_sink(parent, log_sink_object = nil, unique_writer_identity: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+parent}/sinks', options) command.request_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.request_object = log_sink_object command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.response_class = Google::Apis::LoggingV2beta1::LogSink command.params['parent'] = parent unless parent.nil? command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.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 sink. If the sink has a unique writer_identity, then that service # account is also deleted. # @param [String] sink_name # Required. The full resource name of the sink to delete, including the parent # resource and the sink identifier: # "projects/[PROJECT_ID]/sinks/[SINK_ID]" # "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" # "folders/[FOLDER_ID]/sinks/[SINK_ID]" # Example: "projects/my-project-id/sinks/my-sink-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::LoggingV2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::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_sink(sink_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+sinkName}', options) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['sinkName'] = sink_name unless sink_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 sink. # @param [String] sink_name # Required. The resource name of the sink: # "projects/[PROJECT_ID]/sinks/[SINK_ID]" # "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" # "folders/[FOLDER_ID]/sinks/[SINK_ID]" # Example: "projects/my-project-id/sinks/my-sink-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::LoggingV2beta1::LogSink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::LogSink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_sink(sink_name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+sinkName}', options) command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.response_class = Google::Apis::LoggingV2beta1::LogSink command.params['sinkName'] = sink_name unless sink_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 sinks. # @param [String] parent # Required. The parent resource whose sinks are to be listed: # "projects/[PROJECT_ID]" # "organizations/[ORGANIZATION_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]" # "folders/[FOLDER_ID]" # @param [Fixnum] page_size # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. # @param [String] page_token # Optional. If present, then retrieve the next batch of results from the # preceding call to this method. pageToken must be the value of nextPageToken # from the previous response. The values of other method parameters should be # identical to those in the previous call. # @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::LoggingV2beta1::ListSinksResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::ListSinksResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_sinks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/sinks', options) command.response_representation = Google::Apis::LoggingV2beta1::ListSinksResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListSinksResponse 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 # Updates a sink. This method replaces the following fields in the existing sink # with values from the new sink: destination, and filter. The updated sink might # also have a new writer_identity; see the unique_writer_identity field. # @param [String] sink_name # Required. The full resource name of the sink to update, including the parent # resource and the sink identifier: # "projects/[PROJECT_ID]/sinks/[SINK_ID]" # "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" # "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" # "folders/[FOLDER_ID]/sinks/[SINK_ID]" # Example: "projects/my-project-id/sinks/my-sink-id". # @param [Google::Apis::LoggingV2beta1::LogSink] log_sink_object # @param [Boolean] unique_writer_identity # Optional. See sinks.create for a description of this field. When updating a # sink, the effect of this field on the value of writer_identity in the updated # sink depends on both the old and new values of this field: # If the old and new values of this field are both false or both true, then # there is no change to the sink's writer_identity. # If the old value is false and the new value is true, then writer_identity is # changed to a unique service account. # It is an error if the old value is true and the new value is set to false or # defaulted to false. # @param [String] update_mask # Optional. Field mask that specifies the fields in sink that need an update. A # sink field will be overwritten if, and only if, it is in the update mask. name # and output only fields cannot be updated.An empty updateMask is temporarily # treated as using the following mask for backwards compatibility purposes: # destination,filter,includeChildren At some point in the future, behavior will # be removed and specifying an empty updateMask will be an error.For a detailed # FieldMask definition, see https://developers.google.com/protocol-buffers/docs/ # reference/google.protobuf#fieldmaskExample: updateMask=filter. # @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::LoggingV2beta1::LogSink] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LoggingV2beta1::LogSink] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_sink(sink_name, log_sink_object = nil, unique_writer_identity: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v2beta1/{+sinkName}', options) command.request_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.request_object = log_sink_object command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.response_class = Google::Apis::LoggingV2beta1::LogSink command.params['sinkName'] = sink_name unless sink_name.nil? command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.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 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 google-api-client-0.19.8/generated/google/apis/plus_domains_v1/0000755000004100000410000000000013252673044024417 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/plus_domains_v1/representations.rb0000644000004100000410000012604013252673044030174 0ustar www-datawww-data# 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 PlusDomainsV1 class Acl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Activity class Representation < Google::Apis::Core::JsonRepresentation; end class Actor class Representation < Google::Apis::Core::JsonRepresentation; end class ClientSpecificActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end class YoutubeActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Image class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Name class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Verification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Object class Representation < Google::Apis::Core::JsonRepresentation; end class Actor class Representation < Google::Apis::Core::JsonRepresentation; end class ClientSpecificActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end class YoutubeActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Image class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Verification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Attachment class Representation < Google::Apis::Core::JsonRepresentation; end class Embed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FullImage 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 PreviewThumbnail class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Thumbnail class Representation < Google::Apis::Core::JsonRepresentation; end class Image 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 Plusoners class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Replies class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Resharers class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StatusForViewer class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Provider class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ActivityFeed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Audience class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AudiencesFeed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Circle class Representation < Google::Apis::Core::JsonRepresentation; end class People class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class CircleFeed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Comment class Representation < Google::Apis::Core::JsonRepresentation; end class Actor class Representation < Google::Apis::Core::JsonRepresentation; end class ClientSpecificActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end class YoutubeActorInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Image class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Verification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class InReplyTo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Object class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Plusoners class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class CommentFeed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Media class Representation < Google::Apis::Core::JsonRepresentation; end class Author class Representation < Google::Apis::Core::JsonRepresentation; end class Image class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Exif class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class PeopleFeed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Person class Representation < Google::Apis::Core::JsonRepresentation; end class Cover class Representation < Google::Apis::Core::JsonRepresentation; end class CoverInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CoverPhoto class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Email 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 Name class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Organization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacesLived class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Url class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Place class Representation < Google::Apis::Core::JsonRepresentation; end class Address class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Position class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class PlusDomainsAclentryResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Videostream class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Acl # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :domain_restricted, as: 'domainRestricted' collection :items, as: 'items', class: Google::Apis::PlusDomainsV1::PlusDomainsAclentryResource, decorator: Google::Apis::PlusDomainsV1::PlusDomainsAclentryResource::Representation property :kind, as: 'kind' end end class Activity # @private class Representation < Google::Apis::Core::JsonRepresentation property :access, as: 'access', class: Google::Apis::PlusDomainsV1::Acl, decorator: Google::Apis::PlusDomainsV1::Acl::Representation property :actor, as: 'actor', class: Google::Apis::PlusDomainsV1::Activity::Actor, decorator: Google::Apis::PlusDomainsV1::Activity::Actor::Representation property :address, as: 'address' property :annotation, as: 'annotation' property :crosspost_source, as: 'crosspostSource' property :etag, as: 'etag' property :geocode, as: 'geocode' property :id, as: 'id' property :kind, as: 'kind' property :location, as: 'location', class: Google::Apis::PlusDomainsV1::Place, decorator: Google::Apis::PlusDomainsV1::Place::Representation property :object, as: 'object', class: Google::Apis::PlusDomainsV1::Activity::Object, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Representation property :place_id, as: 'placeId' property :place_name, as: 'placeName' property :provider, as: 'provider', class: Google::Apis::PlusDomainsV1::Activity::Provider, decorator: Google::Apis::PlusDomainsV1::Activity::Provider::Representation property :published, as: 'published', type: DateTime property :radius, as: 'radius' property :title, as: 'title' property :updated, as: 'updated', type: DateTime property :url, as: 'url' property :verb, as: 'verb' end class Actor # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_specific_actor_info, as: 'clientSpecificActorInfo', class: Google::Apis::PlusDomainsV1::Activity::Actor::ClientSpecificActorInfo, decorator: Google::Apis::PlusDomainsV1::Activity::Actor::ClientSpecificActorInfo::Representation property :display_name, as: 'displayName' property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusDomainsV1::Activity::Actor::Image, decorator: Google::Apis::PlusDomainsV1::Activity::Actor::Image::Representation property :name, as: 'name', class: Google::Apis::PlusDomainsV1::Activity::Actor::Name, decorator: Google::Apis::PlusDomainsV1::Activity::Actor::Name::Representation property :url, as: 'url' property :verification, as: 'verification', class: Google::Apis::PlusDomainsV1::Activity::Actor::Verification, decorator: Google::Apis::PlusDomainsV1::Activity::Actor::Verification::Representation end class ClientSpecificActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :youtube_actor_info, as: 'youtubeActorInfo', class: Google::Apis::PlusDomainsV1::Activity::Actor::ClientSpecificActorInfo::YoutubeActorInfo, decorator: Google::Apis::PlusDomainsV1::Activity::Actor::ClientSpecificActorInfo::YoutubeActorInfo::Representation end class YoutubeActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' end end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class Name # @private class Representation < Google::Apis::Core::JsonRepresentation property :family_name, as: 'familyName' property :given_name, as: 'givenName' end end class Verification # @private class Representation < Google::Apis::Core::JsonRepresentation property :ad_hoc_verified, as: 'adHocVerified' end end end class Object # @private class Representation < Google::Apis::Core::JsonRepresentation property :actor, as: 'actor', class: Google::Apis::PlusDomainsV1::Activity::Object::Actor, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Actor::Representation collection :attachments, as: 'attachments', class: Google::Apis::PlusDomainsV1::Activity::Object::Attachment, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Representation property :content, as: 'content' property :id, as: 'id' property :object_type, as: 'objectType' property :original_content, as: 'originalContent' property :plusoners, as: 'plusoners', class: Google::Apis::PlusDomainsV1::Activity::Object::Plusoners, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Plusoners::Representation property :replies, as: 'replies', class: Google::Apis::PlusDomainsV1::Activity::Object::Replies, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Replies::Representation property :resharers, as: 'resharers', class: Google::Apis::PlusDomainsV1::Activity::Object::Resharers, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Resharers::Representation property :status_for_viewer, as: 'statusForViewer', class: Google::Apis::PlusDomainsV1::Activity::Object::StatusForViewer, decorator: Google::Apis::PlusDomainsV1::Activity::Object::StatusForViewer::Representation property :url, as: 'url' end class Actor # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_specific_actor_info, as: 'clientSpecificActorInfo', class: Google::Apis::PlusDomainsV1::Activity::Object::Actor::ClientSpecificActorInfo, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Actor::ClientSpecificActorInfo::Representation property :display_name, as: 'displayName' property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusDomainsV1::Activity::Object::Actor::Image, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Actor::Image::Representation property :url, as: 'url' property :verification, as: 'verification', class: Google::Apis::PlusDomainsV1::Activity::Object::Actor::Verification, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Actor::Verification::Representation end class ClientSpecificActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :youtube_actor_info, as: 'youtubeActorInfo', class: Google::Apis::PlusDomainsV1::Activity::Object::Actor::ClientSpecificActorInfo::YoutubeActorInfo, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Actor::ClientSpecificActorInfo::YoutubeActorInfo::Representation end class YoutubeActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' end end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class Verification # @private class Representation < Google::Apis::Core::JsonRepresentation property :ad_hoc_verified, as: 'adHocVerified' end end end class Attachment # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :display_name, as: 'displayName' property :embed, as: 'embed', class: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Embed, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Embed::Representation property :full_image, as: 'fullImage', class: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::FullImage, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::FullImage::Representation property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Image, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Image::Representation property :object_type, as: 'objectType' collection :preview_thumbnails, as: 'previewThumbnails', class: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::PreviewThumbnail, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::PreviewThumbnail::Representation collection :thumbnails, as: 'thumbnails', class: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Thumbnail, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Thumbnail::Representation property :url, as: 'url' end class Embed # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' property :url, as: 'url' end end class FullImage # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :type, as: 'type' property :url, as: 'url' property :width, as: 'width' end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :type, as: 'type' property :url, as: 'url' property :width, as: 'width' end end class PreviewThumbnail # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class Thumbnail # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :image, as: 'image', class: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Thumbnail::Image, decorator: Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Thumbnail::Image::Representation property :url, as: 'url' end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :type, as: 'type' property :url, as: 'url' property :width, as: 'width' end end end end class Plusoners # @private class Representation < Google::Apis::Core::JsonRepresentation property :self_link, as: 'selfLink' property :total_items, as: 'totalItems' end end class Replies # @private class Representation < Google::Apis::Core::JsonRepresentation property :self_link, as: 'selfLink' property :total_items, as: 'totalItems' end end class Resharers # @private class Representation < Google::Apis::Core::JsonRepresentation property :self_link, as: 'selfLink' property :total_items, as: 'totalItems' end end class StatusForViewer # @private class Representation < Google::Apis::Core::JsonRepresentation property :can_comment, as: 'canComment' property :can_plusone, as: 'canPlusone' property :can_update, as: 'canUpdate' property :is_plus_oned, as: 'isPlusOned' property :resharing_disabled, as: 'resharingDisabled' end end end class Provider # @private class Representation < Google::Apis::Core::JsonRepresentation property :title, as: 'title' end end end class ActivityFeed # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::PlusDomainsV1::Activity, decorator: Google::Apis::PlusDomainsV1::Activity::Representation property :kind, as: 'kind' property :next_link, as: 'nextLink' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :title, as: 'title' property :updated, as: 'updated', type: DateTime end end class Audience # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :item, as: 'item', class: Google::Apis::PlusDomainsV1::PlusDomainsAclentryResource, decorator: Google::Apis::PlusDomainsV1::PlusDomainsAclentryResource::Representation property :kind, as: 'kind' property :member_count, as: 'memberCount' property :visibility, as: 'visibility' end end class AudiencesFeed # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::PlusDomainsV1::Audience, decorator: Google::Apis::PlusDomainsV1::Audience::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :total_items, as: 'totalItems' end end class Circle # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :display_name, as: 'displayName' property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :people, as: 'people', class: Google::Apis::PlusDomainsV1::Circle::People, decorator: Google::Apis::PlusDomainsV1::Circle::People::Representation property :self_link, as: 'selfLink' end class People # @private class Representation < Google::Apis::Core::JsonRepresentation property :total_items, as: 'totalItems' end end end class CircleFeed # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::PlusDomainsV1::Circle, decorator: Google::Apis::PlusDomainsV1::Circle::Representation property :kind, as: 'kind' property :next_link, as: 'nextLink' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :title, as: 'title' property :total_items, as: 'totalItems' end end class Comment # @private class Representation < Google::Apis::Core::JsonRepresentation property :actor, as: 'actor', class: Google::Apis::PlusDomainsV1::Comment::Actor, decorator: Google::Apis::PlusDomainsV1::Comment::Actor::Representation property :etag, as: 'etag' property :id, as: 'id' collection :in_reply_to, as: 'inReplyTo', class: Google::Apis::PlusDomainsV1::Comment::InReplyTo, decorator: Google::Apis::PlusDomainsV1::Comment::InReplyTo::Representation property :kind, as: 'kind' property :object, as: 'object', class: Google::Apis::PlusDomainsV1::Comment::Object, decorator: Google::Apis::PlusDomainsV1::Comment::Object::Representation property :plusoners, as: 'plusoners', class: Google::Apis::PlusDomainsV1::Comment::Plusoners, decorator: Google::Apis::PlusDomainsV1::Comment::Plusoners::Representation property :published, as: 'published', type: DateTime property :self_link, as: 'selfLink' property :updated, as: 'updated', type: DateTime property :verb, as: 'verb' end class Actor # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_specific_actor_info, as: 'clientSpecificActorInfo', class: Google::Apis::PlusDomainsV1::Comment::Actor::ClientSpecificActorInfo, decorator: Google::Apis::PlusDomainsV1::Comment::Actor::ClientSpecificActorInfo::Representation property :display_name, as: 'displayName' property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusDomainsV1::Comment::Actor::Image, decorator: Google::Apis::PlusDomainsV1::Comment::Actor::Image::Representation property :url, as: 'url' property :verification, as: 'verification', class: Google::Apis::PlusDomainsV1::Comment::Actor::Verification, decorator: Google::Apis::PlusDomainsV1::Comment::Actor::Verification::Representation end class ClientSpecificActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :youtube_actor_info, as: 'youtubeActorInfo', class: Google::Apis::PlusDomainsV1::Comment::Actor::ClientSpecificActorInfo::YoutubeActorInfo, decorator: Google::Apis::PlusDomainsV1::Comment::Actor::ClientSpecificActorInfo::YoutubeActorInfo::Representation end class YoutubeActorInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' end end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class Verification # @private class Representation < Google::Apis::Core::JsonRepresentation property :ad_hoc_verified, as: 'adHocVerified' end end end class InReplyTo # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :url, as: 'url' end end class Object # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :object_type, as: 'objectType' property :original_content, as: 'originalContent' end end class Plusoners # @private class Representation < Google::Apis::Core::JsonRepresentation property :total_items, as: 'totalItems' end end end class CommentFeed # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::PlusDomainsV1::Comment, decorator: Google::Apis::PlusDomainsV1::Comment::Representation property :kind, as: 'kind' property :next_link, as: 'nextLink' property :next_page_token, as: 'nextPageToken' property :title, as: 'title' property :updated, as: 'updated', type: DateTime end end class Media # @private class Representation < Google::Apis::Core::JsonRepresentation property :author, as: 'author', class: Google::Apis::PlusDomainsV1::Media::Author, decorator: Google::Apis::PlusDomainsV1::Media::Author::Representation property :display_name, as: 'displayName' property :etag, as: 'etag' property :exif, as: 'exif', class: Google::Apis::PlusDomainsV1::Media::Exif, decorator: Google::Apis::PlusDomainsV1::Media::Exif::Representation property :height, as: 'height' property :id, as: 'id' property :kind, as: 'kind' property :media_created_time, as: 'mediaCreatedTime', type: DateTime property :media_url, as: 'mediaUrl' property :published, as: 'published', type: DateTime property :size_bytes, :numeric_string => true, as: 'sizeBytes' collection :streams, as: 'streams', class: Google::Apis::PlusDomainsV1::Videostream, decorator: Google::Apis::PlusDomainsV1::Videostream::Representation property :summary, as: 'summary' property :updated, as: 'updated', type: DateTime property :url, as: 'url' property :video_duration, :numeric_string => true, as: 'videoDuration' property :video_status, as: 'videoStatus' property :width, as: 'width' end class Author # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusDomainsV1::Media::Author::Image, decorator: Google::Apis::PlusDomainsV1::Media::Author::Image::Representation property :url, as: 'url' end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end end class Exif # @private class Representation < Google::Apis::Core::JsonRepresentation property :time, as: 'time', type: DateTime end end end class PeopleFeed # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::PlusDomainsV1::Person, decorator: Google::Apis::PlusDomainsV1::Person::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :title, as: 'title' property :total_items, as: 'totalItems' end end class Person # @private class Representation < Google::Apis::Core::JsonRepresentation property :about_me, as: 'aboutMe' property :birthday, as: 'birthday' property :bragging_rights, as: 'braggingRights' property :circled_by_count, as: 'circledByCount' property :cover, as: 'cover', class: Google::Apis::PlusDomainsV1::Person::Cover, decorator: Google::Apis::PlusDomainsV1::Person::Cover::Representation property :current_location, as: 'currentLocation' property :display_name, as: 'displayName' property :domain, as: 'domain' collection :emails, as: 'emails', class: Google::Apis::PlusDomainsV1::Person::Email, decorator: Google::Apis::PlusDomainsV1::Person::Email::Representation property :etag, as: 'etag' property :gender, as: 'gender' property :id, as: 'id' property :image, as: 'image', class: Google::Apis::PlusDomainsV1::Person::Image, decorator: Google::Apis::PlusDomainsV1::Person::Image::Representation property :is_plus_user, as: 'isPlusUser' property :kind, as: 'kind' property :name, as: 'name', class: Google::Apis::PlusDomainsV1::Person::Name, decorator: Google::Apis::PlusDomainsV1::Person::Name::Representation property :nickname, as: 'nickname' property :object_type, as: 'objectType' property :occupation, as: 'occupation' collection :organizations, as: 'organizations', class: Google::Apis::PlusDomainsV1::Person::Organization, decorator: Google::Apis::PlusDomainsV1::Person::Organization::Representation collection :places_lived, as: 'placesLived', class: Google::Apis::PlusDomainsV1::Person::PlacesLived, decorator: Google::Apis::PlusDomainsV1::Person::PlacesLived::Representation property :plus_one_count, as: 'plusOneCount' property :relationship_status, as: 'relationshipStatus' property :skills, as: 'skills' property :tagline, as: 'tagline' property :url, as: 'url' collection :urls, as: 'urls', class: Google::Apis::PlusDomainsV1::Person::Url, decorator: Google::Apis::PlusDomainsV1::Person::Url::Representation property :verified, as: 'verified' end class Cover # @private class Representation < Google::Apis::Core::JsonRepresentation property :cover_info, as: 'coverInfo', class: Google::Apis::PlusDomainsV1::Person::Cover::CoverInfo, decorator: Google::Apis::PlusDomainsV1::Person::Cover::CoverInfo::Representation property :cover_photo, as: 'coverPhoto', class: Google::Apis::PlusDomainsV1::Person::Cover::CoverPhoto, decorator: Google::Apis::PlusDomainsV1::Person::Cover::CoverPhoto::Representation property :layout, as: 'layout' end class CoverInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :left_image_offset, as: 'leftImageOffset' property :top_image_offset, as: 'topImageOffset' end end class CoverPhoto # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :url, as: 'url' property :width, as: 'width' end end end class Email # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' property :value, as: 'value' end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :is_default, as: 'isDefault' property :url, as: 'url' end end class Name # @private class Representation < Google::Apis::Core::JsonRepresentation property :family_name, as: 'familyName' property :formatted, as: 'formatted' property :given_name, as: 'givenName' property :honorific_prefix, as: 'honorificPrefix' property :honorific_suffix, as: 'honorificSuffix' property :middle_name, as: 'middleName' end end class Organization # @private class Representation < Google::Apis::Core::JsonRepresentation property :department, as: 'department' property :description, as: 'description' property :end_date, as: 'endDate' property :location, as: 'location' property :name, as: 'name' property :primary, as: 'primary' property :start_date, as: 'startDate' property :title, as: 'title' property :type, as: 'type' end end class PlacesLived # @private class Representation < Google::Apis::Core::JsonRepresentation property :primary, as: 'primary' property :value, as: 'value' end end class Url # @private class Representation < Google::Apis::Core::JsonRepresentation property :label, as: 'label' property :type, as: 'type' property :value, as: 'value' end end end class Place # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address', class: Google::Apis::PlusDomainsV1::Place::Address, decorator: Google::Apis::PlusDomainsV1::Place::Address::Representation property :display_name, as: 'displayName' property :id, as: 'id' property :kind, as: 'kind' property :position, as: 'position', class: Google::Apis::PlusDomainsV1::Place::Position, decorator: Google::Apis::PlusDomainsV1::Place::Position::Representation end class Address # @private class Representation < Google::Apis::Core::JsonRepresentation property :formatted, as: 'formatted' end end class Position # @private class Representation < Google::Apis::Core::JsonRepresentation property :latitude, as: 'latitude' property :longitude, as: 'longitude' end end end class PlusDomainsAclentryResource # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :id, as: 'id' property :type, as: 'type' end end class Videostream # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :type, as: 'type' property :url, as: 'url' property :width, as: 'width' end end end end end google-api-client-0.19.8/generated/google/apis/plus_domains_v1/classes.rb0000644000004100000410000030112013252673044026376 0ustar www-datawww-data# 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 PlusDomainsV1 # class Acl include Google::Apis::Core::Hashable # Description of the access granted, suitable for display. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Whether access is restricted to the domain. # Corresponds to the JSON property `domainRestricted` # @return [Boolean] attr_accessor :domain_restricted alias_method :domain_restricted?, :domain_restricted # The list of access entries. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies this resource as a collection of access controls. Value: "plus#acl". # 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) @description = args[:description] if args.key?(:description) @domain_restricted = args[:domain_restricted] if args.key?(:domain_restricted) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class Activity include Google::Apis::Core::Hashable # Identifies who has access to see this activity. # Corresponds to the JSON property `access` # @return [Google::Apis::PlusDomainsV1::Acl] attr_accessor :access # The person who performed this activity. # Corresponds to the JSON property `actor` # @return [Google::Apis::PlusDomainsV1::Activity::Actor] attr_accessor :actor # Street address where this activity occurred. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Additional content added by the person who shared this activity, applicable # only when resharing an activity. # Corresponds to the JSON property `annotation` # @return [String] attr_accessor :annotation # If this activity is a crosspost from another system, this property specifies # the ID of the original activity. # Corresponds to the JSON property `crosspostSource` # @return [String] attr_accessor :crosspost_source # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Latitude and longitude where this activity occurred. Format is latitude # followed by longitude, space separated. # Corresponds to the JSON property `geocode` # @return [String] attr_accessor :geocode # The ID of this activity. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies this resource as an activity. Value: "plus#activity". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The location where this activity occurred. # Corresponds to the JSON property `location` # @return [Google::Apis::PlusDomainsV1::Place] attr_accessor :location # The object of this activity. # Corresponds to the JSON property `object` # @return [Google::Apis::PlusDomainsV1::Activity::Object] attr_accessor :object # ID of the place where this activity occurred. # Corresponds to the JSON property `placeId` # @return [String] attr_accessor :place_id # Name of the place where this activity occurred. # Corresponds to the JSON property `placeName` # @return [String] attr_accessor :place_name # The service provider that initially published this activity. # Corresponds to the JSON property `provider` # @return [Google::Apis::PlusDomainsV1::Activity::Provider] attr_accessor :provider # The time at which this activity was initially published. Formatted as an RFC # 3339 timestamp. # Corresponds to the JSON property `published` # @return [DateTime] attr_accessor :published # Radius, in meters, of the region where this activity occurred, centered at the # latitude and longitude identified in geocode. # Corresponds to the JSON property `radius` # @return [String] attr_accessor :radius # Title of this activity. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The time at which this activity was last updated. Formatted as an RFC 3339 # timestamp. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # The link to this activity. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # This activity's verb, which indicates the action that was performed. Possible # values include, but are not limited to, the following values: # - "post" - Publish content to the stream. # - "share" - Reshare an activity. # 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) @access = args[:access] if args.key?(:access) @actor = args[:actor] if args.key?(:actor) @address = args[:address] if args.key?(:address) @annotation = args[:annotation] if args.key?(:annotation) @crosspost_source = args[:crosspost_source] if args.key?(:crosspost_source) @etag = args[:etag] if args.key?(:etag) @geocode = args[:geocode] if args.key?(:geocode) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @location = args[:location] if args.key?(:location) @object = args[:object] if args.key?(:object) @place_id = args[:place_id] if args.key?(:place_id) @place_name = args[:place_name] if args.key?(:place_name) @provider = args[:provider] if args.key?(:provider) @published = args[:published] if args.key?(:published) @radius = args[:radius] if args.key?(:radius) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) @url = args[:url] if args.key?(:url) @verb = args[:verb] if args.key?(:verb) end # The person who performed this activity. class Actor include Google::Apis::Core::Hashable # Actor info specific to particular clients. # Corresponds to the JSON property `clientSpecificActorInfo` # @return [Google::Apis::PlusDomainsV1::Activity::Actor::ClientSpecificActorInfo] attr_accessor :client_specific_actor_info # The name of the actor, suitable for display. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The ID of the actor's Person resource. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The image representation of the actor. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusDomainsV1::Activity::Actor::Image] attr_accessor :image # An object representation of the individual components of name. # Corresponds to the JSON property `name` # @return [Google::Apis::PlusDomainsV1::Activity::Actor::Name] attr_accessor :name # The link to the actor's Google profile. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Verification status of actor. # Corresponds to the JSON property `verification` # @return [Google::Apis::PlusDomainsV1::Activity::Actor::Verification] attr_accessor :verification def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_specific_actor_info = args[:client_specific_actor_info] if args.key?(:client_specific_actor_info) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @name = args[:name] if args.key?(:name) @url = args[:url] if args.key?(:url) @verification = args[:verification] if args.key?(:verification) end # Actor info specific to particular clients. class ClientSpecificActorInfo include Google::Apis::Core::Hashable # Actor info specific to YouTube clients. # Corresponds to the JSON property `youtubeActorInfo` # @return [Google::Apis::PlusDomainsV1::Activity::Actor::ClientSpecificActorInfo::YoutubeActorInfo] attr_accessor :youtube_actor_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @youtube_actor_info = args[:youtube_actor_info] if args.key?(:youtube_actor_info) end # Actor info specific to YouTube clients. class YoutubeActorInfo include Google::Apis::Core::Hashable # ID of the YouTube channel owned by the Actor. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel_id = args[:channel_id] if args.key?(:channel_id) end end end # The image representation of the actor. class Image include Google::Apis::Core::Hashable # The URL of the actor's profile photo. To resize the image and crop it to a # square, append the query string ?sz=x, where x is the dimension in pixels of # each side. # 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 # An object representation of the individual components of name. class Name include Google::Apis::Core::Hashable # The family name ("last name") of the actor. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name # The given name ("first name") of the actor. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @family_name = args[:family_name] if args.key?(:family_name) @given_name = args[:given_name] if args.key?(:given_name) end end # Verification status of actor. class Verification include Google::Apis::Core::Hashable # Verification for one-time or manual processes. # Corresponds to the JSON property `adHocVerified` # @return [String] attr_accessor :ad_hoc_verified def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_hoc_verified = args[:ad_hoc_verified] if args.key?(:ad_hoc_verified) end end end # The object of this activity. class Object include Google::Apis::Core::Hashable # If this activity's object is itself another activity, such as when a person # reshares an activity, this property specifies the original activity's actor. # Corresponds to the JSON property `actor` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Actor] attr_accessor :actor # The media objects attached to this activity. # Corresponds to the JSON property `attachments` # @return [Array] attr_accessor :attachments # The HTML-formatted content, which is suitable for display. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The ID of the object. When resharing an activity, this is the ID of the # activity that is being reshared. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the object. Possible values include, but are not limited to, the # following values: # - "note" - Textual content. # - "activity" - A Google+ activity. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # The content (text) as provided by the author, which is stored without any HTML # formatting. When creating or updating an activity, this value must be supplied # as plain text in the request. # Corresponds to the JSON property `originalContent` # @return [String] attr_accessor :original_content # People who +1'd this activity. # Corresponds to the JSON property `plusoners` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Plusoners] attr_accessor :plusoners # Comments in reply to this activity. # Corresponds to the JSON property `replies` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Replies] attr_accessor :replies # People who reshared this activity. # Corresponds to the JSON property `resharers` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Resharers] attr_accessor :resharers # Status of the activity as seen by the viewer. # Corresponds to the JSON property `statusForViewer` # @return [Google::Apis::PlusDomainsV1::Activity::Object::StatusForViewer] attr_accessor :status_for_viewer # The URL that points to the linked resource. # 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) @actor = args[:actor] if args.key?(:actor) @attachments = args[:attachments] if args.key?(:attachments) @content = args[:content] if args.key?(:content) @id = args[:id] if args.key?(:id) @object_type = args[:object_type] if args.key?(:object_type) @original_content = args[:original_content] if args.key?(:original_content) @plusoners = args[:plusoners] if args.key?(:plusoners) @replies = args[:replies] if args.key?(:replies) @resharers = args[:resharers] if args.key?(:resharers) @status_for_viewer = args[:status_for_viewer] if args.key?(:status_for_viewer) @url = args[:url] if args.key?(:url) end # If this activity's object is itself another activity, such as when a person # reshares an activity, this property specifies the original activity's actor. class Actor include Google::Apis::Core::Hashable # Actor info specific to particular clients. # Corresponds to the JSON property `clientSpecificActorInfo` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Actor::ClientSpecificActorInfo] attr_accessor :client_specific_actor_info # The original actor's name, which is suitable for display. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # ID of the original actor. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The image representation of the original actor. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Actor::Image] attr_accessor :image # A link to the original actor's Google profile. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Verification status of actor. # Corresponds to the JSON property `verification` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Actor::Verification] attr_accessor :verification def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_specific_actor_info = args[:client_specific_actor_info] if args.key?(:client_specific_actor_info) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @url = args[:url] if args.key?(:url) @verification = args[:verification] if args.key?(:verification) end # Actor info specific to particular clients. class ClientSpecificActorInfo include Google::Apis::Core::Hashable # Actor info specific to YouTube clients. # Corresponds to the JSON property `youtubeActorInfo` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Actor::ClientSpecificActorInfo::YoutubeActorInfo] attr_accessor :youtube_actor_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @youtube_actor_info = args[:youtube_actor_info] if args.key?(:youtube_actor_info) end # Actor info specific to YouTube clients. class YoutubeActorInfo include Google::Apis::Core::Hashable # ID of the YouTube channel owned by the Actor. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel_id = args[:channel_id] if args.key?(:channel_id) end end end # The image representation of the original actor. class Image include Google::Apis::Core::Hashable # A URL that points to a thumbnail photo of the original actor. # 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 # Verification status of actor. class Verification include Google::Apis::Core::Hashable # Verification for one-time or manual processes. # Corresponds to the JSON property `adHocVerified` # @return [String] attr_accessor :ad_hoc_verified def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_hoc_verified = args[:ad_hoc_verified] if args.key?(:ad_hoc_verified) end end end # class Attachment include Google::Apis::Core::Hashable # If the attachment is an article, this property contains a snippet of text from # the article. It can also include descriptions for other types. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The title of the attachment, such as a photo caption or an article title. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # If the attachment is a video, the embeddable link. # Corresponds to the JSON property `embed` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Embed] attr_accessor :embed # The full image URL for photo attachments. # Corresponds to the JSON property `fullImage` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Attachment::FullImage] attr_accessor :full_image # The ID of the attachment. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The preview image for photos or videos. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Image] attr_accessor :image # The type of media object. Possible values include, but are not limited to, the # following values: # - "photo" - A photo. # - "album" - A photo album. # - "video" - A video. # - "article" - An article, specified by a link. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # When previewing, these are the optional thumbnails for the post. When posting # an article, choose one by setting the attachment.image.url property. If you # don't choose one, one will be chosen for you. # Corresponds to the JSON property `previewThumbnails` # @return [Array] attr_accessor :preview_thumbnails # If the attachment is an album, this property is a list of potential additional # thumbnails from the album. # Corresponds to the JSON property `thumbnails` # @return [Array] attr_accessor :thumbnails # The link to the attachment, which should be of type text/html. # 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) @content = args[:content] if args.key?(:content) @display_name = args[:display_name] if args.key?(:display_name) @embed = args[:embed] if args.key?(:embed) @full_image = args[:full_image] if args.key?(:full_image) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @object_type = args[:object_type] if args.key?(:object_type) @preview_thumbnails = args[:preview_thumbnails] if args.key?(:preview_thumbnails) @thumbnails = args[:thumbnails] if args.key?(:thumbnails) @url = args[:url] if args.key?(:url) end # If the attachment is a video, the embeddable link. class Embed include Google::Apis::Core::Hashable # Media type of the link. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # URL of the link. # 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 # The full image URL for photo attachments. class FullImage include Google::Apis::Core::Hashable # The height, in pixels, of the linked resource. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Media type of the link. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # URL of the image. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width, in pixels, of the linked resource. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end # The preview image for photos or videos. class Image include Google::Apis::Core::Hashable # The height, in pixels, of the linked resource. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Media type of the link. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Image URL. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width, in pixels, of the linked resource. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end # class PreviewThumbnail include Google::Apis::Core::Hashable # URL of the thumbnail 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) @url = args[:url] if args.key?(:url) end end # class Thumbnail include Google::Apis::Core::Hashable # Potential name of the thumbnail. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Image resource. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusDomainsV1::Activity::Object::Attachment::Thumbnail::Image] attr_accessor :image # URL of the webpage containing 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) @description = args[:description] if args.key?(:description) @image = args[:image] if args.key?(:image) @url = args[:url] if args.key?(:url) end # Image resource. class Image include Google::Apis::Core::Hashable # The height, in pixels, of the linked resource. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Media type of the link. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Image url. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width, in pixels, of the linked resource. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end end end # People who +1'd this activity. class Plusoners include Google::Apis::Core::Hashable # The URL for the collection of people who +1'd this activity. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Total number of people who +1'd this activity. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @self_link = args[:self_link] if args.key?(:self_link) @total_items = args[:total_items] if args.key?(:total_items) end end # Comments in reply to this activity. class Replies include Google::Apis::Core::Hashable # The URL for the collection of comments in reply to this activity. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Total number of comments on this activity. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @self_link = args[:self_link] if args.key?(:self_link) @total_items = args[:total_items] if args.key?(:total_items) end end # People who reshared this activity. class Resharers include Google::Apis::Core::Hashable # The URL for the collection of resharers. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Total number of people who reshared this activity. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @self_link = args[:self_link] if args.key?(:self_link) @total_items = args[:total_items] if args.key?(:total_items) end end # Status of the activity as seen by the viewer. class StatusForViewer include Google::Apis::Core::Hashable # Whether the viewer can comment on the activity. # Corresponds to the JSON property `canComment` # @return [Boolean] attr_accessor :can_comment alias_method :can_comment?, :can_comment # Whether the viewer can +1 the activity. # Corresponds to the JSON property `canPlusone` # @return [Boolean] attr_accessor :can_plusone alias_method :can_plusone?, :can_plusone # Whether the viewer can edit or delete the activity. # Corresponds to the JSON property `canUpdate` # @return [Boolean] attr_accessor :can_update alias_method :can_update?, :can_update # Whether the viewer has +1'd the activity. # Corresponds to the JSON property `isPlusOned` # @return [Boolean] attr_accessor :is_plus_oned alias_method :is_plus_oned?, :is_plus_oned # Whether reshares are disabled for the activity. # Corresponds to the JSON property `resharingDisabled` # @return [Boolean] attr_accessor :resharing_disabled alias_method :resharing_disabled?, :resharing_disabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @can_comment = args[:can_comment] if args.key?(:can_comment) @can_plusone = args[:can_plusone] if args.key?(:can_plusone) @can_update = args[:can_update] if args.key?(:can_update) @is_plus_oned = args[:is_plus_oned] if args.key?(:is_plus_oned) @resharing_disabled = args[:resharing_disabled] if args.key?(:resharing_disabled) end end end # The service provider that initially published this activity. class Provider include Google::Apis::Core::Hashable # Name of the service provider. # 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) @title = args[:title] if args.key?(:title) end end end # class ActivityFeed include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of this collection of activities. Deprecated. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The activities in this page of results. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies this resource as a collection of activities. Value: "plus# # activityFeed". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to the next page of activities. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Link to this activity resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The title of this collection of activities, which is a truncated portion of # the content. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The time at which this collection of activities was last updated. Formatted as # an RFC 3339 timestamp. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) end end # class Audience include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The access control list entry. # Corresponds to the JSON property `item` # @return [Google::Apis::PlusDomainsV1::PlusDomainsAclentryResource] attr_accessor :item # Identifies this resource as an audience. Value: "plus#audience". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The number of people in this circle. This only applies if entity_type is # CIRCLE. # Corresponds to the JSON property `memberCount` # @return [Fixnum] attr_accessor :member_count # The circle members' visibility as chosen by the owner of the circle. This only # applies for items with "item.type" equals "circle". Possible values are: # - "public" - Members are visible to the public. # - "limited" - Members are visible to a limited audience. # - "private" - Members are visible to the owner only. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @item = args[:item] if args.key?(:item) @kind = args[:kind] if args.key?(:kind) @member_count = args[:member_count] if args.key?(:member_count) @visibility = args[:visibility] if args.key?(:visibility) end end # class AudiencesFeed include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The audiences in this result. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies this resource as a collection of audiences. Value: "plus# # audienceFeed". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The total number of ACL entries. The number of entries in this response may be # smaller due to paging. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @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) @total_items = args[:total_items] if args.key?(:total_items) end end # class Circle include Google::Apis::Core::Hashable # The description of this circle. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The circle name. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of the circle. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies this resource as a circle. Value: "plus#circle". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The people in this circle. # Corresponds to the JSON property `people` # @return [Google::Apis::PlusDomainsV1::Circle::People] attr_accessor :people # Link to this circle 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) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @people = args[:people] if args.key?(:people) @self_link = args[:self_link] if args.key?(:self_link) end # The people in this circle. class People include Google::Apis::Core::Hashable # The total number of people in this circle. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @total_items = args[:total_items] if args.key?(:total_items) end end end # class CircleFeed include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The circles in this page of results. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies this resource as a collection of circles. Value: "plus#circleFeed". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to the next page of circles. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Link to this page of circles. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The title of this list of resources. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The total number of circles. The number of circles in this response may be # smaller due to paging. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) @title = args[:title] if args.key?(:title) @total_items = args[:total_items] if args.key?(:total_items) end end # class Comment include Google::Apis::Core::Hashable # The person who posted this comment. # Corresponds to the JSON property `actor` # @return [Google::Apis::PlusDomainsV1::Comment::Actor] attr_accessor :actor # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of this comment. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The activity this comment replied to. # Corresponds to the JSON property `inReplyTo` # @return [Array] attr_accessor :in_reply_to # Identifies this resource as a comment. Value: "plus#comment". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The object of this comment. # Corresponds to the JSON property `object` # @return [Google::Apis::PlusDomainsV1::Comment::Object] attr_accessor :object # People who +1'd this comment. # Corresponds to the JSON property `plusoners` # @return [Google::Apis::PlusDomainsV1::Comment::Plusoners] attr_accessor :plusoners # The time at which this comment was initially published. Formatted as an RFC # 3339 timestamp. # Corresponds to the JSON property `published` # @return [DateTime] attr_accessor :published # Link to this comment resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The time at which this comment was last updated. Formatted as an RFC 3339 # timestamp. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # This comment's verb, indicating what action was performed. Possible values are: # # - "post" - Publish content to the stream. # 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) @actor = args[:actor] if args.key?(:actor) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @in_reply_to = args[:in_reply_to] if args.key?(:in_reply_to) @kind = args[:kind] if args.key?(:kind) @object = args[:object] if args.key?(:object) @plusoners = args[:plusoners] if args.key?(:plusoners) @published = args[:published] if args.key?(:published) @self_link = args[:self_link] if args.key?(:self_link) @updated = args[:updated] if args.key?(:updated) @verb = args[:verb] if args.key?(:verb) end # The person who posted this comment. class Actor include Google::Apis::Core::Hashable # Actor info specific to particular clients. # Corresponds to the JSON property `clientSpecificActorInfo` # @return [Google::Apis::PlusDomainsV1::Comment::Actor::ClientSpecificActorInfo] attr_accessor :client_specific_actor_info # The name of this actor, suitable for display. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The ID of the actor. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The image representation of this actor. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusDomainsV1::Comment::Actor::Image] attr_accessor :image # A link to the Person resource for this actor. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Verification status of actor. # Corresponds to the JSON property `verification` # @return [Google::Apis::PlusDomainsV1::Comment::Actor::Verification] attr_accessor :verification def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_specific_actor_info = args[:client_specific_actor_info] if args.key?(:client_specific_actor_info) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @url = args[:url] if args.key?(:url) @verification = args[:verification] if args.key?(:verification) end # Actor info specific to particular clients. class ClientSpecificActorInfo include Google::Apis::Core::Hashable # Actor info specific to YouTube clients. # Corresponds to the JSON property `youtubeActorInfo` # @return [Google::Apis::PlusDomainsV1::Comment::Actor::ClientSpecificActorInfo::YoutubeActorInfo] attr_accessor :youtube_actor_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @youtube_actor_info = args[:youtube_actor_info] if args.key?(:youtube_actor_info) end # Actor info specific to YouTube clients. class YoutubeActorInfo include Google::Apis::Core::Hashable # ID of the YouTube channel owned by the Actor. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel_id = args[:channel_id] if args.key?(:channel_id) end end end # The image representation of this actor. class Image include Google::Apis::Core::Hashable # The URL of the actor's profile photo. To resize the image and crop it to a # square, append the query string ?sz=x, where x is the dimension in pixels of # each side. # 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 # Verification status of actor. class Verification include Google::Apis::Core::Hashable # Verification for one-time or manual processes. # Corresponds to the JSON property `adHocVerified` # @return [String] attr_accessor :ad_hoc_verified def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_hoc_verified = args[:ad_hoc_verified] if args.key?(:ad_hoc_verified) end end end # class InReplyTo include Google::Apis::Core::Hashable # The ID of the activity. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The URL of the activity. # 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) @url = args[:url] if args.key?(:url) end end # The object of this comment. class Object include Google::Apis::Core::Hashable # The HTML-formatted content, suitable for display. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The object type of this comment. Possible values are: # - "comment" - A comment in reply to an activity. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # The content (text) as provided by the author, stored without any HTML # formatting. When creating or updating a comment, this value must be supplied # as plain text in the request. # Corresponds to the JSON property `originalContent` # @return [String] attr_accessor :original_content def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content = args[:content] if args.key?(:content) @object_type = args[:object_type] if args.key?(:object_type) @original_content = args[:original_content] if args.key?(:original_content) end end # People who +1'd this comment. class Plusoners include Google::Apis::Core::Hashable # Total number of people who +1'd this comment. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @total_items = args[:total_items] if args.key?(:total_items) end end end # class CommentFeed include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID of this collection of comments. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The comments in this page of results. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies this resource as a collection of comments. Value: "plus#commentFeed" # . # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Link to the next page of activities. # Corresponds to the JSON property `nextLink` # @return [String] attr_accessor :next_link # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The title of this collection of comments. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The time at which this collection of comments was last updated. Formatted as # an RFC 3339 timestamp. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @next_link = args[:next_link] if args.key?(:next_link) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) end end # class Media include Google::Apis::Core::Hashable # The person who uploaded this media. # Corresponds to the JSON property `author` # @return [Google::Apis::PlusDomainsV1::Media::Author] attr_accessor :author # The display name for this media. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Exif information of the media item. # Corresponds to the JSON property `exif` # @return [Google::Apis::PlusDomainsV1::Media::Exif] attr_accessor :exif # The height in pixels of the original image. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # ID of this media, which is generated by the API. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The time at which this media was originally created in UTC. Formatted as an # RFC 3339 timestamp that matches this example: 2010-11-25T14:30:27.655Z # Corresponds to the JSON property `mediaCreatedTime` # @return [DateTime] attr_accessor :media_created_time # The URL of this photo or video's still image. # Corresponds to the JSON property `mediaUrl` # @return [String] attr_accessor :media_url # The time at which this media was uploaded. Formatted as an RFC 3339 timestamp. # Corresponds to the JSON property `published` # @return [DateTime] attr_accessor :published # The size in bytes of this video. # Corresponds to the JSON property `sizeBytes` # @return [Fixnum] attr_accessor :size_bytes # The list of video streams for this video. There might be several different # streams available for a single video, either Flash or MPEG, of various sizes # Corresponds to the JSON property `streams` # @return [Array] attr_accessor :streams # A description, or caption, for this media. # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary # The time at which this media was last updated. This includes changes to media # metadata. Formatted as an RFC 3339 timestamp. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # The URL for the page that hosts this media. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The duration in milliseconds of this video. # Corresponds to the JSON property `videoDuration` # @return [Fixnum] attr_accessor :video_duration # The encoding status of this video. Possible values are: # - "UPLOADING" - Not all the video bytes have been received. # - "PENDING" - Video not yet processed. # - "FAILED" - Video processing failed. # - "READY" - A single video stream is playable. # - "FINAL" - All video streams are playable. # Corresponds to the JSON property `videoStatus` # @return [String] attr_accessor :video_status # The width in pixels of the original image. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @author = args[:author] if args.key?(:author) @display_name = args[:display_name] if args.key?(:display_name) @etag = args[:etag] if args.key?(:etag) @exif = args[:exif] if args.key?(:exif) @height = args[:height] if args.key?(:height) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @media_created_time = args[:media_created_time] if args.key?(:media_created_time) @media_url = args[:media_url] if args.key?(:media_url) @published = args[:published] if args.key?(:published) @size_bytes = args[:size_bytes] if args.key?(:size_bytes) @streams = args[:streams] if args.key?(:streams) @summary = args[:summary] if args.key?(:summary) @updated = args[:updated] if args.key?(:updated) @url = args[:url] if args.key?(:url) @video_duration = args[:video_duration] if args.key?(:video_duration) @video_status = args[:video_status] if args.key?(:video_status) @width = args[:width] if args.key?(:width) end # The person who uploaded this media. class Author include Google::Apis::Core::Hashable # The author's name. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # ID of the author. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The author's Google profile image. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusDomainsV1::Media::Author::Image] attr_accessor :image # A link to the author's Google profile. # 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) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @url = args[:url] if args.key?(:url) end # The author's Google profile image. class Image include Google::Apis::Core::Hashable # The URL of the author's profile photo. To resize the image and crop it to a # square, append the query string ?sz=x, where x is the dimension in pixels of # each side. # 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 end # Exif information of the media item. class Exif include Google::Apis::Core::Hashable # The time the media was captured. Formatted as an RFC 3339 timestamp. # Corresponds to the JSON property `time` # @return [DateTime] attr_accessor :time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @time = args[:time] if args.key?(:time) end end end # class PeopleFeed include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The people in this page of results. Each item includes the id, displayName, # image, and url for the person. To retrieve additional profile data, see the # people.get method. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies this resource as a collection of people. Value: "plus#peopleFeed". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, which is used to page through large result sets. # Provide this value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Link to this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The title of this collection of people. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The total number of people available in this list. The number of people in a # response might be smaller due to paging. This might not be set for all # collections. # Corresponds to the JSON property `totalItems` # @return [Fixnum] attr_accessor :total_items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @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) @title = args[:title] if args.key?(:title) @total_items = args[:total_items] if args.key?(:total_items) end end # class Person include Google::Apis::Core::Hashable # A short biography for this person. # Corresponds to the JSON property `aboutMe` # @return [String] attr_accessor :about_me # The person's date of birth, represented as YYYY-MM-DD. # Corresponds to the JSON property `birthday` # @return [String] attr_accessor :birthday # The "bragging rights" line of this person. # Corresponds to the JSON property `braggingRights` # @return [String] attr_accessor :bragging_rights # For followers who are visible, the number of people who have added this person # or page to a circle. # Corresponds to the JSON property `circledByCount` # @return [Fixnum] attr_accessor :circled_by_count # The cover photo content. # Corresponds to the JSON property `cover` # @return [Google::Apis::PlusDomainsV1::Person::Cover] attr_accessor :cover # (this field is not currently used) # Corresponds to the JSON property `currentLocation` # @return [String] attr_accessor :current_location # The name of this person, which is suitable for display. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The hosted domain name for the user's Google Apps account. For instance, # example.com. The plus.profile.emails.read or email scope is needed to get this # domain name. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # A list of email addresses that this person has, including their Google account # email address, and the public verified email addresses on their Google+ # profile. The plus.profile.emails.read scope is needed to retrieve these email # addresses, or the email scope can be used to retrieve just the Google account # email address. # Corresponds to the JSON property `emails` # @return [Array] attr_accessor :emails # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The person's gender. Possible values include, but are not limited to, the # following values: # - "male" - Male gender. # - "female" - Female gender. # - "other" - Other. # Corresponds to the JSON property `gender` # @return [String] attr_accessor :gender # The ID of this person. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The representation of the person's profile photo. # Corresponds to the JSON property `image` # @return [Google::Apis::PlusDomainsV1::Person::Image] attr_accessor :image # Whether this user has signed up for Google+. # Corresponds to the JSON property `isPlusUser` # @return [Boolean] attr_accessor :is_plus_user alias_method :is_plus_user?, :is_plus_user # Identifies this resource as a person. Value: "plus#person". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # An object representation of the individual components of a person's name. # Corresponds to the JSON property `name` # @return [Google::Apis::PlusDomainsV1::Person::Name] attr_accessor :name # The nickname of this person. # Corresponds to the JSON property `nickname` # @return [String] attr_accessor :nickname # Type of person within Google+. Possible values include, but are not limited to, # the following values: # - "person" - represents an actual person. # - "page" - represents a page. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # The occupation of this person. # Corresponds to the JSON property `occupation` # @return [String] attr_accessor :occupation # A list of current or past organizations with which this person is associated. # Corresponds to the JSON property `organizations` # @return [Array] attr_accessor :organizations # A list of places where this person has lived. # Corresponds to the JSON property `placesLived` # @return [Array] attr_accessor :places_lived # If a Google+ Page, the number of people who have +1'd this page. # Corresponds to the JSON property `plusOneCount` # @return [Fixnum] attr_accessor :plus_one_count # The person's relationship status. Possible values include, but are not limited # to, the following values: # - "single" - Person is single. # - "in_a_relationship" - Person is in a relationship. # - "engaged" - Person is engaged. # - "married" - Person is married. # - "its_complicated" - The relationship is complicated. # - "open_relationship" - Person is in an open relationship. # - "widowed" - Person is widowed. # - "in_domestic_partnership" - Person is in a domestic partnership. # - "in_civil_union" - Person is in a civil union. # Corresponds to the JSON property `relationshipStatus` # @return [String] attr_accessor :relationship_status # The person's skills. # Corresponds to the JSON property `skills` # @return [String] attr_accessor :skills # The brief description (tagline) of this person. # Corresponds to the JSON property `tagline` # @return [String] attr_accessor :tagline # The URL of this person's profile. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # A list of URLs for this person. # Corresponds to the JSON property `urls` # @return [Array] attr_accessor :urls # Whether the person or Google+ Page has been verified. # Corresponds to the JSON property `verified` # @return [Boolean] attr_accessor :verified alias_method :verified?, :verified def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @about_me = args[:about_me] if args.key?(:about_me) @birthday = args[:birthday] if args.key?(:birthday) @bragging_rights = args[:bragging_rights] if args.key?(:bragging_rights) @circled_by_count = args[:circled_by_count] if args.key?(:circled_by_count) @cover = args[:cover] if args.key?(:cover) @current_location = args[:current_location] if args.key?(:current_location) @display_name = args[:display_name] if args.key?(:display_name) @domain = args[:domain] if args.key?(:domain) @emails = args[:emails] if args.key?(:emails) @etag = args[:etag] if args.key?(:etag) @gender = args[:gender] if args.key?(:gender) @id = args[:id] if args.key?(:id) @image = args[:image] if args.key?(:image) @is_plus_user = args[:is_plus_user] if args.key?(:is_plus_user) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @nickname = args[:nickname] if args.key?(:nickname) @object_type = args[:object_type] if args.key?(:object_type) @occupation = args[:occupation] if args.key?(:occupation) @organizations = args[:organizations] if args.key?(:organizations) @places_lived = args[:places_lived] if args.key?(:places_lived) @plus_one_count = args[:plus_one_count] if args.key?(:plus_one_count) @relationship_status = args[:relationship_status] if args.key?(:relationship_status) @skills = args[:skills] if args.key?(:skills) @tagline = args[:tagline] if args.key?(:tagline) @url = args[:url] if args.key?(:url) @urls = args[:urls] if args.key?(:urls) @verified = args[:verified] if args.key?(:verified) end # The cover photo content. class Cover include Google::Apis::Core::Hashable # Extra information about the cover photo. # Corresponds to the JSON property `coverInfo` # @return [Google::Apis::PlusDomainsV1::Person::Cover::CoverInfo] attr_accessor :cover_info # The person's primary cover image. # Corresponds to the JSON property `coverPhoto` # @return [Google::Apis::PlusDomainsV1::Person::Cover::CoverPhoto] attr_accessor :cover_photo # The layout of the cover art. Possible values include, but are not limited to, # the following values: # - "banner" - One large image banner. # Corresponds to the JSON property `layout` # @return [String] attr_accessor :layout def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cover_info = args[:cover_info] if args.key?(:cover_info) @cover_photo = args[:cover_photo] if args.key?(:cover_photo) @layout = args[:layout] if args.key?(:layout) end # Extra information about the cover photo. class CoverInfo include Google::Apis::Core::Hashable # The difference between the left position of the cover image and the actual # displayed cover image. Only valid for banner layout. # Corresponds to the JSON property `leftImageOffset` # @return [Fixnum] attr_accessor :left_image_offset # The difference between the top position of the cover image and the actual # displayed cover image. Only valid for banner layout. # Corresponds to the JSON property `topImageOffset` # @return [Fixnum] attr_accessor :top_image_offset def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @left_image_offset = args[:left_image_offset] if args.key?(:left_image_offset) @top_image_offset = args[:top_image_offset] if args.key?(:top_image_offset) end end # The person's primary cover image. class CoverPhoto include Google::Apis::Core::Hashable # The height of the image. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # The URL of the image. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width of the image. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end end # class Email include Google::Apis::Core::Hashable # The type of address. Possible values include, but are not limited to, the # following values: # - "account" - Google account email address. # - "home" - Home email address. # - "work" - Work email address. # - "other" - Other. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The email address. # 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) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end # The representation of the person's profile photo. class Image include Google::Apis::Core::Hashable # Whether the person's profile photo is the default one # Corresponds to the JSON property `isDefault` # @return [Boolean] attr_accessor :is_default alias_method :is_default?, :is_default # The URL of the person's profile photo. To resize the image and crop it to a # square, append the query string ?sz=x, where x is the dimension in pixels of # each side. # 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) @is_default = args[:is_default] if args.key?(:is_default) @url = args[:url] if args.key?(:url) end end # An object representation of the individual components of a person's name. class Name include Google::Apis::Core::Hashable # The family name (last name) of this person. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name # The full name of this person, including middle names, suffixes, etc. # Corresponds to the JSON property `formatted` # @return [String] attr_accessor :formatted # The given name (first name) of this person. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name # The honorific prefixes (such as "Dr." or "Mrs.") for this person. # Corresponds to the JSON property `honorificPrefix` # @return [String] attr_accessor :honorific_prefix # The honorific suffixes (such as "Jr.") for this person. # Corresponds to the JSON property `honorificSuffix` # @return [String] attr_accessor :honorific_suffix # The middle name of this person. # Corresponds to the JSON property `middleName` # @return [String] attr_accessor :middle_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @family_name = args[:family_name] if args.key?(:family_name) @formatted = args[:formatted] if args.key?(:formatted) @given_name = args[:given_name] if args.key?(:given_name) @honorific_prefix = args[:honorific_prefix] if args.key?(:honorific_prefix) @honorific_suffix = args[:honorific_suffix] if args.key?(:honorific_suffix) @middle_name = args[:middle_name] if args.key?(:middle_name) end end # class Organization include Google::Apis::Core::Hashable # The department within the organization. Deprecated. # Corresponds to the JSON property `department` # @return [String] attr_accessor :department # A short description of the person's role in this organization. Deprecated. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The date that the person left this organization. # Corresponds to the JSON property `endDate` # @return [String] attr_accessor :end_date # The location of this organization. Deprecated. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The name of the organization. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # If "true", indicates this organization is the person's primary one, which is # typically interpreted as the current one. # Corresponds to the JSON property `primary` # @return [Boolean] attr_accessor :primary alias_method :primary?, :primary # The date that the person joined this organization. # Corresponds to the JSON property `startDate` # @return [String] attr_accessor :start_date # The person's job title or role within the organization. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The type of organization. Possible values include, but are not limited to, the # following values: # - "work" - Work. # - "school" - School. # 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) @department = args[:department] if args.key?(:department) @description = args[:description] if args.key?(:description) @end_date = args[:end_date] if args.key?(:end_date) @location = args[:location] if args.key?(:location) @name = args[:name] if args.key?(:name) @primary = args[:primary] if args.key?(:primary) @start_date = args[:start_date] if args.key?(:start_date) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) end end # class PlacesLived include Google::Apis::Core::Hashable # If "true", this place of residence is this person's primary residence. # Corresponds to the JSON property `primary` # @return [Boolean] attr_accessor :primary alias_method :primary?, :primary # A place where this person has lived. For example: "Seattle, WA", "Near Toronto" # . # 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) @primary = args[:primary] if args.key?(:primary) @value = args[:value] if args.key?(:value) end end # class Url include Google::Apis::Core::Hashable # The label of the URL. # Corresponds to the JSON property `label` # @return [String] attr_accessor :label # The type of URL. Possible values include, but are not limited to, the # following values: # - "otherProfile" - URL for another profile. # - "contributor" - URL to a site for which this person is a contributor. # - "website" - URL for this Google+ Page's primary website. # - "other" - Other URL. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The URL 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) @label = args[:label] if args.key?(:label) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end end # class Place include Google::Apis::Core::Hashable # The physical address of the place. # Corresponds to the JSON property `address` # @return [Google::Apis::PlusDomainsV1::Place::Address] attr_accessor :address # The display name of the place. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The id of the place. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies this resource as a place. Value: "plus#place". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The position of the place. # Corresponds to the JSON property `position` # @return [Google::Apis::PlusDomainsV1::Place::Position] attr_accessor :position def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @address = args[:address] if args.key?(:address) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @position = args[:position] if args.key?(:position) end # The physical address of the place. class Address include Google::Apis::Core::Hashable # The formatted address for display. # Corresponds to the JSON property `formatted` # @return [String] attr_accessor :formatted def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @formatted = args[:formatted] if args.key?(:formatted) end end # The position of the place. class Position include Google::Apis::Core::Hashable # The latitude of this position. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude # The longitude of this position. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @latitude = args[:latitude] if args.key?(:latitude) @longitude = args[:longitude] if args.key?(:longitude) end end end # class PlusDomainsAclentryResource include Google::Apis::Core::Hashable # A descriptive name for this entry. Suitable for display. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The ID of the entry. For entries of type "person" or "circle", this is the ID # of the resource. For other types, this property is not set. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of entry describing to whom access is granted. Possible values are: # - "person" - Access to an individual. # - "circle" - Access to members of a circle. # - "myCircles" - Access to members of all the person's circles. # - "extendedCircles" - Access to members of all the person's circles, plus all # of the people in their circles. # - "domain" - Access to members of the person's Google Apps domain. # - "public" - Access to anyone on the web. # 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) @id = args[:id] if args.key?(:id) @type = args[:type] if args.key?(:type) end end # class Videostream include Google::Apis::Core::Hashable # The height, in pixels, of the video resource. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # MIME type of the video stream. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # URL of the video stream. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width, in pixels, of the video resource. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end end end end google-api-client-0.19.8/generated/google/apis/plus_domains_v1/service.rb0000644000004100000410000015032513252673044026412 0ustar www-datawww-data# 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 PlusDomainsV1 # Google+ Domains API # # Builds on top of the Google+ platform for Google Apps Domains. # # @example # require 'google/apis/plus_domains_v1' # # PlusDomains = Google::Apis::PlusDomainsV1 # Alias the module # service = PlusDomains::PlusDomainsService.new # # @see https://developers.google.com/+/domains/ class PlusDomainsService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'plusDomains/v1/') @batch_path = 'batch/plusDomains/v1' end # Get an activity. # @param [String] activity_id # The ID of the activity to get. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Activity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Activity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity(activity_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities/{activityId}', options) command.response_representation = Google::Apis::PlusDomainsV1::Activity::Representation command.response_class = Google::Apis::PlusDomainsV1::Activity command.params['activityId'] = activity_id unless activity_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 # Create a new activity for the authenticated user. # @param [String] user_id # The ID of the user to create the activity on behalf of. Its value should be " # me", to indicate the authenticated user. # @param [Google::Apis::PlusDomainsV1::Activity] activity_object # @param [Boolean] preview # If "true", extract the potential media attachments for a URL. The response # will include all possible attachments for a URL, including video, photos, and # articles based on the content of the page. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Activity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Activity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity(user_id, activity_object = nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'people/{userId}/activities', options) command.request_representation = Google::Apis::PlusDomainsV1::Activity::Representation command.request_object = activity_object command.response_representation = Google::Apis::PlusDomainsV1::Activity::Representation command.response_class = Google::Apis::PlusDomainsV1::Activity command.params['userId'] = user_id unless user_id.nil? command.query['preview'] = preview unless preview.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 of the activities in the specified collection for a particular user. # @param [String] user_id # The ID of the user to get activities for. The special value "me" can be used # to indicate the authenticated user. # @param [String] collection # The collection of activities to list. # @param [Fixnum] max_results # The maximum number of activities to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::ActivityFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::ActivityFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activities(user_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}/activities/{collection}', options) command.response_representation = Google::Apis::PlusDomainsV1::ActivityFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::ActivityFeed command.params['userId'] = user_id unless user_id.nil? command.params['collection'] = collection unless collection.nil? command.query['maxResults'] = max_results unless max_results.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 # List all of the audiences to which a user can share. # @param [String] user_id # The ID of the user to get audiences for. The special value "me" can be used to # indicate the authenticated user. # @param [Fixnum] max_results # The maximum number of circles to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::AudiencesFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::AudiencesFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_audiences(user_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}/audiences', options) command.response_representation = Google::Apis::PlusDomainsV1::AudiencesFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::AudiencesFeed command.params['userId'] = user_id unless user_id.nil? command.query['maxResults'] = max_results unless max_results.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 # Add a person to a circle. Google+ limits certain circle operations, including # the number of circle adds. Learn More. # @param [String] circle_id # The ID of the circle to add the person to. # @param [Array, String] email # Email of the people to add to the circle. Optional, can be repeated. # @param [Array, String] user_id # IDs of the people to add to the circle. Optional, can be repeated. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Circle] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Circle] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_people(circle_id, email: nil, user_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'circles/{circleId}/people', options) command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.response_class = Google::Apis::PlusDomainsV1::Circle command.params['circleId'] = circle_id unless circle_id.nil? command.query['email'] = email unless email.nil? command.query['userId'] = user_id unless user_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 # Get a circle. # @param [String] circle_id # The ID of the circle to get. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Circle] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Circle] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_circle(circle_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'circles/{circleId}', options) command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.response_class = Google::Apis::PlusDomainsV1::Circle command.params['circleId'] = circle_id unless circle_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 # Create a new circle for the authenticated user. # @param [String] user_id # The ID of the user to create the circle on behalf of. The value "me" can be # used to indicate the authenticated user. # @param [Google::Apis::PlusDomainsV1::Circle] circle_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Circle] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Circle] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_circle(user_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'people/{userId}/circles', options) command.request_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.request_object = circle_object command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.response_class = Google::Apis::PlusDomainsV1::Circle command.params['userId'] = user_id unless user_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 # List all of the circles for a user. # @param [String] user_id # The ID of the user to get circles for. The special value "me" can be used to # indicate the authenticated user. # @param [Fixnum] max_results # The maximum number of circles to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::CircleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::CircleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_circles(user_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}/circles', options) command.response_representation = Google::Apis::PlusDomainsV1::CircleFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::CircleFeed command.params['userId'] = user_id unless user_id.nil? command.query['maxResults'] = max_results unless max_results.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 # Update a circle's description. This method supports patch semantics. # @param [String] circle_id # The ID of the circle to update. # @param [Google::Apis::PlusDomainsV1::Circle] circle_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Circle] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Circle] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_circle(circle_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'circles/{circleId}', options) command.request_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.request_object = circle_object command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.response_class = Google::Apis::PlusDomainsV1::Circle command.params['circleId'] = circle_id unless circle_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 # Delete a circle. # @param [String] circle_id # The ID of the circle 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 remove_circle(circle_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'circles/{circleId}', options) command.params['circleId'] = circle_id unless circle_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 # Remove a person from a circle. # @param [String] circle_id # The ID of the circle to remove the person from. # @param [Array, String] email # Email of the people to add to the circle. Optional, can be repeated. # @param [Array, String] user_id # IDs of the people to remove from the circle. Optional, can be repeated. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 remove_people(circle_id, email: nil, user_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'circles/{circleId}/people', options) command.params['circleId'] = circle_id unless circle_id.nil? command.query['email'] = email unless email.nil? command.query['userId'] = user_id unless user_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 # Update a circle's description. # @param [String] circle_id # The ID of the circle to update. # @param [Google::Apis::PlusDomainsV1::Circle] circle_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Circle] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Circle] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_circle(circle_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'circles/{circleId}', options) command.request_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.request_object = circle_object command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation command.response_class = Google::Apis::PlusDomainsV1::Circle command.params['circleId'] = circle_id unless circle_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 # Get a comment. # @param [String] comment_id # The ID of the comment to get. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Comment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Comment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_comment(comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'comments/{commentId}', options) command.response_representation = Google::Apis::PlusDomainsV1::Comment::Representation command.response_class = Google::Apis::PlusDomainsV1::Comment command.params['commentId'] = comment_id unless comment_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 # Create a new comment in reply to an activity. # @param [String] activity_id # The ID of the activity to reply to. # @param [Google::Apis::PlusDomainsV1::Comment] comment_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Comment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Comment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_comment(activity_id, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'activities/{activityId}/comments', options) command.request_representation = Google::Apis::PlusDomainsV1::Comment::Representation command.request_object = comment_object command.response_representation = Google::Apis::PlusDomainsV1::Comment::Representation command.response_class = Google::Apis::PlusDomainsV1::Comment command.params['activityId'] = activity_id unless activity_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 # List all of the comments for an activity. # @param [String] activity_id # The ID of the activity to get comments for. # @param [Fixnum] max_results # The maximum number of comments to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous response. # @param [String] sort_order # The order in which to sort the list of comments. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::CommentFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::CommentFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_comments(activity_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities/{activityId}/comments', options) command.response_representation = Google::Apis::PlusDomainsV1::CommentFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::CommentFeed command.params['activityId'] = activity_id unless activity_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortOrder'] = sort_order unless sort_order.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 # Add a new media item to an album. The current upload size limitations are 36MB # for a photo and 1GB for a video. Uploads do not count against quota if photos # are less than 2048 pixels on their longest side or videos are less than 15 # minutes in length. # @param [String] user_id # The ID of the user to create the activity on behalf of. # @param [String] collection # @param [Google::Apis::PlusDomainsV1::Media] media_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::PlusDomainsV1::Media] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Media] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_medium(user_id, collection, media_object = 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, 'people/{userId}/media/{collection}', options) else command = make_upload_command(:post, 'people/{userId}/media/{collection}', options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::PlusDomainsV1::Media::Representation command.request_object = media_object command.response_representation = Google::Apis::PlusDomainsV1::Media::Representation command.response_class = Google::Apis::PlusDomainsV1::Media command.params['userId'] = user_id unless user_id.nil? command.params['collection'] = collection unless collection.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 # Get a person's profile. # @param [String] user_id # The ID of the person to get the profile for. The special value "me" can be # used to indicate the authenticated user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::Person] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::Person] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_person(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}', options) command.response_representation = Google::Apis::PlusDomainsV1::Person::Representation command.response_class = Google::Apis::PlusDomainsV1::Person command.params['userId'] = user_id unless user_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 # List all of the people in the specified collection. # @param [String] user_id # Get the collection of people for the person identified. Use "me" to indicate # the authenticated user. # @param [String] collection # The collection of people to list. # @param [Fixnum] max_results # The maximum number of people to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] order_by # The order to return people in. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::PeopleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::PeopleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_people(user_id, collection, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}/people/{collection}', options) command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed command.params['userId'] = user_id unless user_id.nil? command.params['collection'] = collection unless collection.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['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 of the people in the specified collection for a particular activity. # @param [String] activity_id # The ID of the activity to get the list of people for. # @param [String] collection # The collection of people to list. # @param [Fixnum] max_results # The maximum number of people to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::PeopleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::PeopleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_people_by_activity(activity_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities/{activityId}/people/{collection}', options) command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed command.params['activityId'] = activity_id unless activity_id.nil? command.params['collection'] = collection unless collection.nil? command.query['maxResults'] = max_results unless max_results.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 # List all of the people who are members of a circle. # @param [String] circle_id # The ID of the circle to get the members of. # @param [Fixnum] max_results # The maximum number of people to include in the response, which is used for # paging. For any response, the actual number returned might be less than the # specified maxResults. # @param [String] page_token # The continuation token, which is used to page through large result sets. To # get the next page of results, set this parameter to the value of " # nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PlusDomainsV1::PeopleFeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PlusDomainsV1::PeopleFeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_people_by_circle(circle_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'circles/{circleId}/people', options) command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed command.params['circleId'] = circle_id unless circle_id.nil? command.query['maxResults'] = max_results unless max_results.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 protected 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 end end google-api-client-0.19.8/generated/google/apis/customsearch_v1/0000755000004100000410000000000013252673043024421 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/customsearch_v1/representations.rb0000644000004100000410000002630113252673043030175 0ustar www-datawww-data# 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 CustomsearchV1 class Context class Representation < Google::Apis::Core::JsonRepresentation; end class Facet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Promotion class Representation < Google::Apis::Core::JsonRepresentation; end class BodyLine 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 include Google::Apis::Core::JsonObjectSupport end class Query class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Result class Representation < Google::Apis::Core::JsonRepresentation; end class Image class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Label class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Search class Representation < Google::Apis::Core::JsonRepresentation; end class SearchInformation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Spelling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Url class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Context # @private class Representation < Google::Apis::Core::JsonRepresentation collection :facets, as: 'facets', :class => Array do include Representable::JSON::Collection items class: Google::Apis::CustomsearchV1::Context::Facet, decorator: Google::Apis::CustomsearchV1::Context::Facet::Representation end property :title, as: 'title' end class Facet # @private class Representation < Google::Apis::Core::JsonRepresentation property :anchor, as: 'anchor' property :label, as: 'label' property :label_with_op, as: 'label_with_op' end end end class Promotion # @private class Representation < Google::Apis::Core::JsonRepresentation collection :body_lines, as: 'bodyLines', class: Google::Apis::CustomsearchV1::Promotion::BodyLine, decorator: Google::Apis::CustomsearchV1::Promotion::BodyLine::Representation property :display_link, as: 'displayLink' property :html_title, as: 'htmlTitle' property :image, as: 'image', class: Google::Apis::CustomsearchV1::Promotion::Image, decorator: Google::Apis::CustomsearchV1::Promotion::Image::Representation property :link, as: 'link' property :title, as: 'title' end class BodyLine # @private class Representation < Google::Apis::Core::JsonRepresentation property :html_title, as: 'htmlTitle' property :link, as: 'link' property :title, as: 'title' property :url, as: 'url' end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :source, as: 'source' property :width, as: 'width' end end end class Query # @private class Representation < Google::Apis::Core::JsonRepresentation property :count, as: 'count' property :cr, as: 'cr' property :cx, as: 'cx' property :date_restrict, as: 'dateRestrict' property :disable_cn_tw_translation, as: 'disableCnTwTranslation' property :exact_terms, as: 'exactTerms' property :exclude_terms, as: 'excludeTerms' property :file_type, as: 'fileType' property :filter, as: 'filter' property :gl, as: 'gl' property :google_host, as: 'googleHost' property :high_range, as: 'highRange' property :hl, as: 'hl' property :hq, as: 'hq' property :img_color_type, as: 'imgColorType' property :img_dominant_color, as: 'imgDominantColor' property :img_size, as: 'imgSize' property :img_type, as: 'imgType' property :input_encoding, as: 'inputEncoding' property :language, as: 'language' property :link_site, as: 'linkSite' property :low_range, as: 'lowRange' property :or_terms, as: 'orTerms' property :output_encoding, as: 'outputEncoding' property :related_site, as: 'relatedSite' property :rights, as: 'rights' property :safe, as: 'safe' property :search_terms, as: 'searchTerms' property :search_type, as: 'searchType' property :site_search, as: 'siteSearch' property :site_search_filter, as: 'siteSearchFilter' property :sort, as: 'sort' property :start_index, as: 'startIndex' property :start_page, as: 'startPage' property :title, as: 'title' property :total_results, :numeric_string => true, as: 'totalResults' end end class Result # @private class Representation < Google::Apis::Core::JsonRepresentation property :cache_id, as: 'cacheId' property :display_link, as: 'displayLink' property :file_format, as: 'fileFormat' property :formatted_url, as: 'formattedUrl' property :html_formatted_url, as: 'htmlFormattedUrl' property :html_snippet, as: 'htmlSnippet' property :html_title, as: 'htmlTitle' property :image, as: 'image', class: Google::Apis::CustomsearchV1::Result::Image, decorator: Google::Apis::CustomsearchV1::Result::Image::Representation property :kind, as: 'kind' collection :labels, as: 'labels', class: Google::Apis::CustomsearchV1::Result::Label, decorator: Google::Apis::CustomsearchV1::Result::Label::Representation property :link, as: 'link' property :mime, as: 'mime' hash :pagemap, as: 'pagemap', :class => Array do include Representable::JSON::Collection items end property :snippet, as: 'snippet' property :title, as: 'title' end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :byte_size, as: 'byteSize' property :context_link, as: 'contextLink' property :height, as: 'height' property :thumbnail_height, as: 'thumbnailHeight' property :thumbnail_link, as: 'thumbnailLink' property :thumbnail_width, as: 'thumbnailWidth' property :width, as: 'width' end end class Label # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :label_with_op, as: 'label_with_op' property :name, as: 'name' end end end class Search # @private class Representation < Google::Apis::Core::JsonRepresentation property :context, as: 'context', class: Google::Apis::CustomsearchV1::Context, decorator: Google::Apis::CustomsearchV1::Context::Representation collection :items, as: 'items', class: Google::Apis::CustomsearchV1::Result, decorator: Google::Apis::CustomsearchV1::Result::Representation property :kind, as: 'kind' collection :promotions, as: 'promotions', class: Google::Apis::CustomsearchV1::Promotion, decorator: Google::Apis::CustomsearchV1::Promotion::Representation hash :queries, as: 'queries', :class => Array do include Representable::JSON::Collection items class: Google::Apis::CustomsearchV1::Query, decorator: Google::Apis::CustomsearchV1::Query::Representation end property :search_information, as: 'searchInformation', class: Google::Apis::CustomsearchV1::Search::SearchInformation, decorator: Google::Apis::CustomsearchV1::Search::SearchInformation::Representation property :spelling, as: 'spelling', class: Google::Apis::CustomsearchV1::Search::Spelling, decorator: Google::Apis::CustomsearchV1::Search::Spelling::Representation property :url, as: 'url', class: Google::Apis::CustomsearchV1::Search::Url, decorator: Google::Apis::CustomsearchV1::Search::Url::Representation end class SearchInformation # @private class Representation < Google::Apis::Core::JsonRepresentation property :formatted_search_time, as: 'formattedSearchTime' property :formatted_total_results, as: 'formattedTotalResults' property :search_time, as: 'searchTime' property :total_results, :numeric_string => true, as: 'totalResults' end end class Spelling # @private class Representation < Google::Apis::Core::JsonRepresentation property :corrected_query, as: 'correctedQuery' property :html_corrected_query, as: 'htmlCorrectedQuery' end end class Url # @private class Representation < Google::Apis::Core::JsonRepresentation property :template, as: 'template' property :type, as: 'type' end end end end end end google-api-client-0.19.8/generated/google/apis/customsearch_v1/classes.rb0000644000004100000410000005701513252673043026413 0ustar www-datawww-data# 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 CustomsearchV1 # class Context include Google::Apis::Core::Hashable # # Corresponds to the JSON property `facets` # @return [Array>] attr_accessor :facets # # 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) @facets = args[:facets] if args.key?(:facets) @title = args[:title] if args.key?(:title) end # class Facet include Google::Apis::Core::Hashable # # Corresponds to the JSON property `anchor` # @return [String] attr_accessor :anchor # # Corresponds to the JSON property `label` # @return [String] attr_accessor :label # # Corresponds to the JSON property `label_with_op` # @return [String] attr_accessor :label_with_op def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @anchor = args[:anchor] if args.key?(:anchor) @label = args[:label] if args.key?(:label) @label_with_op = args[:label_with_op] if args.key?(:label_with_op) end end end # class Promotion include Google::Apis::Core::Hashable # # Corresponds to the JSON property `bodyLines` # @return [Array] attr_accessor :body_lines # # Corresponds to the JSON property `displayLink` # @return [String] attr_accessor :display_link # # Corresponds to the JSON property `htmlTitle` # @return [String] attr_accessor :html_title # # Corresponds to the JSON property `image` # @return [Google::Apis::CustomsearchV1::Promotion::Image] attr_accessor :image # # Corresponds to the JSON property `link` # @return [String] attr_accessor :link # # 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) @body_lines = args[:body_lines] if args.key?(:body_lines) @display_link = args[:display_link] if args.key?(:display_link) @html_title = args[:html_title] if args.key?(:html_title) @image = args[:image] if args.key?(:image) @link = args[:link] if args.key?(:link) @title = args[:title] if args.key?(:title) end # class BodyLine include Google::Apis::Core::Hashable # # Corresponds to the JSON property `htmlTitle` # @return [String] attr_accessor :html_title # # Corresponds to the JSON property `link` # @return [String] attr_accessor :link # # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # # 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) @html_title = args[:html_title] if args.key?(:html_title) @link = args[:link] if args.key?(:link) @title = args[:title] if args.key?(:title) @url = args[:url] if args.key?(:url) end end # class Image include Google::Apis::Core::Hashable # # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # # Corresponds to the JSON property `source` # @return [String] attr_accessor :source # # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @source = args[:source] if args.key?(:source) @width = args[:width] if args.key?(:width) end end end # class Query include Google::Apis::Core::Hashable # # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # # Corresponds to the JSON property `cr` # @return [String] attr_accessor :cr # # Corresponds to the JSON property `cx` # @return [String] attr_accessor :cx # # Corresponds to the JSON property `dateRestrict` # @return [String] attr_accessor :date_restrict # # Corresponds to the JSON property `disableCnTwTranslation` # @return [String] attr_accessor :disable_cn_tw_translation # # Corresponds to the JSON property `exactTerms` # @return [String] attr_accessor :exact_terms # # Corresponds to the JSON property `excludeTerms` # @return [String] attr_accessor :exclude_terms # # Corresponds to the JSON property `fileType` # @return [String] attr_accessor :file_type # # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # # Corresponds to the JSON property `gl` # @return [String] attr_accessor :gl # # Corresponds to the JSON property `googleHost` # @return [String] attr_accessor :google_host # # Corresponds to the JSON property `highRange` # @return [String] attr_accessor :high_range # # Corresponds to the JSON property `hl` # @return [String] attr_accessor :hl # # Corresponds to the JSON property `hq` # @return [String] attr_accessor :hq # # Corresponds to the JSON property `imgColorType` # @return [String] attr_accessor :img_color_type # # Corresponds to the JSON property `imgDominantColor` # @return [String] attr_accessor :img_dominant_color # # Corresponds to the JSON property `imgSize` # @return [String] attr_accessor :img_size # # Corresponds to the JSON property `imgType` # @return [String] attr_accessor :img_type # # Corresponds to the JSON property `inputEncoding` # @return [String] attr_accessor :input_encoding # # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # # Corresponds to the JSON property `linkSite` # @return [String] attr_accessor :link_site # # Corresponds to the JSON property `lowRange` # @return [String] attr_accessor :low_range # # Corresponds to the JSON property `orTerms` # @return [String] attr_accessor :or_terms # # Corresponds to the JSON property `outputEncoding` # @return [String] attr_accessor :output_encoding # # Corresponds to the JSON property `relatedSite` # @return [String] attr_accessor :related_site # # Corresponds to the JSON property `rights` # @return [String] attr_accessor :rights # # Corresponds to the JSON property `safe` # @return [String] attr_accessor :safe # # Corresponds to the JSON property `searchTerms` # @return [String] attr_accessor :search_terms # # Corresponds to the JSON property `searchType` # @return [String] attr_accessor :search_type # # Corresponds to the JSON property `siteSearch` # @return [String] attr_accessor :site_search # # Corresponds to the JSON property `siteSearchFilter` # @return [String] attr_accessor :site_search_filter # # Corresponds to the JSON property `sort` # @return [String] attr_accessor :sort # # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index # # Corresponds to the JSON property `startPage` # @return [Fixnum] attr_accessor :start_page # # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @count = args[:count] if args.key?(:count) @cr = args[:cr] if args.key?(:cr) @cx = args[:cx] if args.key?(:cx) @date_restrict = args[:date_restrict] if args.key?(:date_restrict) @disable_cn_tw_translation = args[:disable_cn_tw_translation] if args.key?(:disable_cn_tw_translation) @exact_terms = args[:exact_terms] if args.key?(:exact_terms) @exclude_terms = args[:exclude_terms] if args.key?(:exclude_terms) @file_type = args[:file_type] if args.key?(:file_type) @filter = args[:filter] if args.key?(:filter) @gl = args[:gl] if args.key?(:gl) @google_host = args[:google_host] if args.key?(:google_host) @high_range = args[:high_range] if args.key?(:high_range) @hl = args[:hl] if args.key?(:hl) @hq = args[:hq] if args.key?(:hq) @img_color_type = args[:img_color_type] if args.key?(:img_color_type) @img_dominant_color = args[:img_dominant_color] if args.key?(:img_dominant_color) @img_size = args[:img_size] if args.key?(:img_size) @img_type = args[:img_type] if args.key?(:img_type) @input_encoding = args[:input_encoding] if args.key?(:input_encoding) @language = args[:language] if args.key?(:language) @link_site = args[:link_site] if args.key?(:link_site) @low_range = args[:low_range] if args.key?(:low_range) @or_terms = args[:or_terms] if args.key?(:or_terms) @output_encoding = args[:output_encoding] if args.key?(:output_encoding) @related_site = args[:related_site] if args.key?(:related_site) @rights = args[:rights] if args.key?(:rights) @safe = args[:safe] if args.key?(:safe) @search_terms = args[:search_terms] if args.key?(:search_terms) @search_type = args[:search_type] if args.key?(:search_type) @site_search = args[:site_search] if args.key?(:site_search) @site_search_filter = args[:site_search_filter] if args.key?(:site_search_filter) @sort = args[:sort] if args.key?(:sort) @start_index = args[:start_index] if args.key?(:start_index) @start_page = args[:start_page] if args.key?(:start_page) @title = args[:title] if args.key?(:title) @total_results = args[:total_results] if args.key?(:total_results) end end # class Result include Google::Apis::Core::Hashable # # Corresponds to the JSON property `cacheId` # @return [String] attr_accessor :cache_id # # Corresponds to the JSON property `displayLink` # @return [String] attr_accessor :display_link # # Corresponds to the JSON property `fileFormat` # @return [String] attr_accessor :file_format # # Corresponds to the JSON property `formattedUrl` # @return [String] attr_accessor :formatted_url # # Corresponds to the JSON property `htmlFormattedUrl` # @return [String] attr_accessor :html_formatted_url # # Corresponds to the JSON property `htmlSnippet` # @return [String] attr_accessor :html_snippet # # Corresponds to the JSON property `htmlTitle` # @return [String] attr_accessor :html_title # # Corresponds to the JSON property `image` # @return [Google::Apis::CustomsearchV1::Result::Image] attr_accessor :image # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # # Corresponds to the JSON property `link` # @return [String] attr_accessor :link # # Corresponds to the JSON property `mime` # @return [String] attr_accessor :mime # # Corresponds to the JSON property `pagemap` # @return [Hash>>] attr_accessor :pagemap # # Corresponds to the JSON property `snippet` # @return [String] attr_accessor :snippet # # 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) @cache_id = args[:cache_id] if args.key?(:cache_id) @display_link = args[:display_link] if args.key?(:display_link) @file_format = args[:file_format] if args.key?(:file_format) @formatted_url = args[:formatted_url] if args.key?(:formatted_url) @html_formatted_url = args[:html_formatted_url] if args.key?(:html_formatted_url) @html_snippet = args[:html_snippet] if args.key?(:html_snippet) @html_title = args[:html_title] if args.key?(:html_title) @image = args[:image] if args.key?(:image) @kind = args[:kind] if args.key?(:kind) @labels = args[:labels] if args.key?(:labels) @link = args[:link] if args.key?(:link) @mime = args[:mime] if args.key?(:mime) @pagemap = args[:pagemap] if args.key?(:pagemap) @snippet = args[:snippet] if args.key?(:snippet) @title = args[:title] if args.key?(:title) end # class Image include Google::Apis::Core::Hashable # # Corresponds to the JSON property `byteSize` # @return [Fixnum] attr_accessor :byte_size # # Corresponds to the JSON property `contextLink` # @return [String] attr_accessor :context_link # # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # # Corresponds to the JSON property `thumbnailHeight` # @return [Fixnum] attr_accessor :thumbnail_height # # Corresponds to the JSON property `thumbnailLink` # @return [String] attr_accessor :thumbnail_link # # Corresponds to the JSON property `thumbnailWidth` # @return [Fixnum] attr_accessor :thumbnail_width # # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @byte_size = args[:byte_size] if args.key?(:byte_size) @context_link = args[:context_link] if args.key?(:context_link) @height = args[:height] if args.key?(:height) @thumbnail_height = args[:thumbnail_height] if args.key?(:thumbnail_height) @thumbnail_link = args[:thumbnail_link] if args.key?(:thumbnail_link) @thumbnail_width = args[:thumbnail_width] if args.key?(:thumbnail_width) @width = args[:width] if args.key?(:width) end end # class Label include Google::Apis::Core::Hashable # # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # # Corresponds to the JSON property `label_with_op` # @return [String] attr_accessor :label_with_op # # 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) @label_with_op = args[:label_with_op] if args.key?(:label_with_op) @name = args[:name] if args.key?(:name) end end end # class Search include Google::Apis::Core::Hashable # # Corresponds to the JSON property `context` # @return [Google::Apis::CustomsearchV1::Context] attr_accessor :context # # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # # Corresponds to the JSON property `promotions` # @return [Array] attr_accessor :promotions # # Corresponds to the JSON property `queries` # @return [Hash>] attr_accessor :queries # # Corresponds to the JSON property `searchInformation` # @return [Google::Apis::CustomsearchV1::Search::SearchInformation] attr_accessor :search_information # # Corresponds to the JSON property `spelling` # @return [Google::Apis::CustomsearchV1::Search::Spelling] attr_accessor :spelling # # Corresponds to the JSON property `url` # @return [Google::Apis::CustomsearchV1::Search::Url] attr_accessor :url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @context = args[:context] if args.key?(:context) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @promotions = args[:promotions] if args.key?(:promotions) @queries = args[:queries] if args.key?(:queries) @search_information = args[:search_information] if args.key?(:search_information) @spelling = args[:spelling] if args.key?(:spelling) @url = args[:url] if args.key?(:url) end # class SearchInformation include Google::Apis::Core::Hashable # # Corresponds to the JSON property `formattedSearchTime` # @return [String] attr_accessor :formatted_search_time # # Corresponds to the JSON property `formattedTotalResults` # @return [String] attr_accessor :formatted_total_results # # Corresponds to the JSON property `searchTime` # @return [Float] attr_accessor :search_time # # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @formatted_search_time = args[:formatted_search_time] if args.key?(:formatted_search_time) @formatted_total_results = args[:formatted_total_results] if args.key?(:formatted_total_results) @search_time = args[:search_time] if args.key?(:search_time) @total_results = args[:total_results] if args.key?(:total_results) end end # class Spelling include Google::Apis::Core::Hashable # # Corresponds to the JSON property `correctedQuery` # @return [String] attr_accessor :corrected_query # # Corresponds to the JSON property `htmlCorrectedQuery` # @return [String] attr_accessor :html_corrected_query def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @corrected_query = args[:corrected_query] if args.key?(:corrected_query) @html_corrected_query = args[:html_corrected_query] if args.key?(:html_corrected_query) end end # class Url include Google::Apis::Core::Hashable # # Corresponds to the JSON property `template` # @return [String] attr_accessor :template # # 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) @template = args[:template] if args.key?(:template) @type = args[:type] if args.key?(:type) end end end end end end google-api-client-0.19.8/generated/google/apis/customsearch_v1/service.rb0000644000004100000410000004464113252673043026417 0ustar www-datawww-data# 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 CustomsearchV1 # CustomSearch API # # Searches over a website or collection of websites # # @example # require 'google/apis/customsearch_v1' # # Customsearch = Google::Apis::CustomsearchV1 # Alias the module # service = Customsearch::CustomsearchService.new # # @see https://developers.google.com/custom-search/v1/using_rest class CustomsearchService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'customsearch/') @batch_path = 'batch/customsearch/v1' end # Returns metadata about the search performed, metadata about the custom search # engine used for the search, and the search results. # @param [String] q # Query # @param [String] c2coff # Turns off the translation between zh-CN and zh-TW. # @param [String] cr # Country restrict(s). # @param [String] cx # The custom search engine ID to scope this search query # @param [String] date_restrict # Specifies all search results are from a time period # @param [String] exact_terms # Identifies a phrase that all documents in the search results must contain # @param [String] exclude_terms # Identifies a word or phrase that should not appear in any documents in the # search results # @param [String] file_type # Returns images of a specified type. Some of the allowed values are: bmp, gif, # png, jpg, svg, pdf, ... # @param [String] filter # Controls turning on or off the duplicate content filter. # @param [String] gl # Geolocation of end user. # @param [String] googlehost # The local Google domain to use to perform the search. # @param [String] high_range # Creates a range in form as_nlo value..as_nhi value and attempts to append it # to query # @param [String] hl # Sets the user interface language. # @param [String] hq # Appends the extra query terms to the query. # @param [String] img_color_type # Returns black and white, grayscale, or color images: mono, gray, and color. # @param [String] img_dominant_color # Returns images of a specific dominant color: yellow, green, teal, blue, purple, # pink, white, gray, black and brown. # @param [String] img_size # Returns images of a specified size, where size can be one of: icon, small, # medium, large, xlarge, xxlarge, and huge. # @param [String] img_type # Returns images of a type, which can be one of: clipart, face, lineart, news, # and photo. # @param [String] link_site # Specifies that all search results should contain a link to a particular URL # @param [String] low_range # Creates a range in form as_nlo value..as_nhi value and attempts to append it # to query # @param [String] lr # The language restriction for the search results # @param [Fixnum] num # Number of search results to return # @param [String] or_terms # Provides additional search terms to check for in a document, where each # document in the search results must contain at least one of the additional # search terms # @param [String] related_site # Specifies that all search results should be pages that are related to the # specified URL # @param [String] rights # Filters based on licensing. Supported values include: cc_publicdomain, # cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations # of these. # @param [String] safe # Search safety level # @param [String] search_type # Specifies the search type: image. # @param [String] site_search # Specifies all search results should be pages from a given site # @param [String] site_search_filter # Controls whether to include or exclude results from the site named in the # as_sitesearch parameter # @param [String] sort # The sort expression to apply to the results # @param [Fixnum] start # The index of the first result to return # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::CustomsearchV1::Search] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CustomsearchV1::Search] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_cses(q, c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'v1', options) command.response_representation = Google::Apis::CustomsearchV1::Search::Representation command.response_class = Google::Apis::CustomsearchV1::Search command.query['c2coff'] = c2coff unless c2coff.nil? command.query['cr'] = cr unless cr.nil? command.query['cx'] = cx unless cx.nil? command.query['dateRestrict'] = date_restrict unless date_restrict.nil? command.query['exactTerms'] = exact_terms unless exact_terms.nil? command.query['excludeTerms'] = exclude_terms unless exclude_terms.nil? command.query['fileType'] = file_type unless file_type.nil? command.query['filter'] = filter unless filter.nil? command.query['gl'] = gl unless gl.nil? command.query['googlehost'] = googlehost unless googlehost.nil? command.query['highRange'] = high_range unless high_range.nil? command.query['hl'] = hl unless hl.nil? command.query['hq'] = hq unless hq.nil? command.query['imgColorType'] = img_color_type unless img_color_type.nil? command.query['imgDominantColor'] = img_dominant_color unless img_dominant_color.nil? command.query['imgSize'] = img_size unless img_size.nil? command.query['imgType'] = img_type unless img_type.nil? command.query['linkSite'] = link_site unless link_site.nil? command.query['lowRange'] = low_range unless low_range.nil? command.query['lr'] = lr unless lr.nil? command.query['num'] = num unless num.nil? command.query['orTerms'] = or_terms unless or_terms.nil? command.query['q'] = q unless q.nil? command.query['relatedSite'] = related_site unless related_site.nil? command.query['rights'] = rights unless rights.nil? command.query['safe'] = safe unless safe.nil? command.query['searchType'] = search_type unless search_type.nil? command.query['siteSearch'] = site_search unless site_search.nil? command.query['siteSearchFilter'] = site_search_filter unless site_search_filter.nil? command.query['sort'] = sort unless sort.nil? command.query['start'] = start unless start.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 # (Closed Beta API) Returns metadata about the search performed, metadata about # the custom search engine used for the search, and the search results only for # site-restrict cses. # @param [String] q # Query # @param [String] c2coff # Turns off the translation between zh-CN and zh-TW. # @param [String] cr # Country restrict(s). # @param [String] cx # The custom search engine ID to scope this search query # @param [String] date_restrict # Specifies all search results are from a time period # @param [String] exact_terms # Identifies a phrase that all documents in the search results must contain # @param [String] exclude_terms # Identifies a word or phrase that should not appear in any documents in the # search results # @param [String] file_type # Returns images of a specified type. Some of the allowed values are: bmp, gif, # png, jpg, svg, pdf, ... # @param [String] filter # Controls turning on or off the duplicate content filter. # @param [String] gl # Geolocation of end user. # @param [String] googlehost # The local Google domain to use to perform the search. # @param [String] high_range # Creates a range in form as_nlo value..as_nhi value and attempts to append it # to query # @param [String] hl # Sets the user interface language. # @param [String] hq # Appends the extra query terms to the query. # @param [String] img_color_type # Returns black and white, grayscale, or color images: mono, gray, and color. # @param [String] img_dominant_color # Returns images of a specific dominant color: yellow, green, teal, blue, purple, # pink, white, gray, black and brown. # @param [String] img_size # Returns images of a specified size, where size can be one of: icon, small, # medium, large, xlarge, xxlarge, and huge. # @param [String] img_type # Returns images of a type, which can be one of: clipart, face, lineart, news, # and photo. # @param [String] link_site # Specifies that all search results should contain a link to a particular URL # @param [String] low_range # Creates a range in form as_nlo value..as_nhi value and attempts to append it # to query # @param [String] lr # The language restriction for the search results # @param [Fixnum] num # Number of search results to return # @param [String] or_terms # Provides additional search terms to check for in a document, where each # document in the search results must contain at least one of the additional # search terms # @param [String] related_site # Specifies that all search results should be pages that are related to the # specified URL # @param [String] rights # Filters based on licensing. Supported values include: cc_publicdomain, # cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations # of these. # @param [String] safe # Search safety level # @param [String] search_type # Specifies the search type: image. # @param [String] site_search # Specifies all search results should be pages from a given site # @param [String] site_search_filter # Controls whether to include or exclude results from the site named in the # as_sitesearch parameter # @param [String] sort # The sort expression to apply to the results # @param [Fixnum] start # The index of the first result to return # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::CustomsearchV1::Search] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CustomsearchV1::Search] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_cse_siterestricts(q, c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'v1/siterestrict', options) command.response_representation = Google::Apis::CustomsearchV1::Search::Representation command.response_class = Google::Apis::CustomsearchV1::Search command.query['c2coff'] = c2coff unless c2coff.nil? command.query['cr'] = cr unless cr.nil? command.query['cx'] = cx unless cx.nil? command.query['dateRestrict'] = date_restrict unless date_restrict.nil? command.query['exactTerms'] = exact_terms unless exact_terms.nil? command.query['excludeTerms'] = exclude_terms unless exclude_terms.nil? command.query['fileType'] = file_type unless file_type.nil? command.query['filter'] = filter unless filter.nil? command.query['gl'] = gl unless gl.nil? command.query['googlehost'] = googlehost unless googlehost.nil? command.query['highRange'] = high_range unless high_range.nil? command.query['hl'] = hl unless hl.nil? command.query['hq'] = hq unless hq.nil? command.query['imgColorType'] = img_color_type unless img_color_type.nil? command.query['imgDominantColor'] = img_dominant_color unless img_dominant_color.nil? command.query['imgSize'] = img_size unless img_size.nil? command.query['imgType'] = img_type unless img_type.nil? command.query['linkSite'] = link_site unless link_site.nil? command.query['lowRange'] = low_range unless low_range.nil? command.query['lr'] = lr unless lr.nil? command.query['num'] = num unless num.nil? command.query['orTerms'] = or_terms unless or_terms.nil? command.query['q'] = q unless q.nil? command.query['relatedSite'] = related_site unless related_site.nil? command.query['rights'] = rights unless rights.nil? command.query['safe'] = safe unless safe.nil? command.query['searchType'] = search_type unless search_type.nil? command.query['siteSearch'] = site_search unless site_search.nil? command.query['siteSearchFilter'] = site_search_filter unless site_search_filter.nil? command.query['sort'] = sort unless sort.nil? command.query['start'] = start unless start.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 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 end end google-api-client-0.19.8/generated/google/apis/replicapool_v1beta2/0000755000004100000410000000000013252673044025151 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/replicapool_v1beta2/representations.rb0000644000004100000410000002304413252673044030726 0ustar www-datawww-data# 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 ReplicapoolV1beta2 class InstanceGroupManager class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagerList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AbandonInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RecreateInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetInstanceTemplateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetTargetPoolsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Operation class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport 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 OperationList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReplicaPoolAutoHealingPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManager # @private class Representation < Google::Apis::Core::JsonRepresentation collection :auto_healing_policies, as: 'autoHealingPolicies', class: Google::Apis::ReplicapoolV1beta2::ReplicaPoolAutoHealingPolicy, decorator: Google::Apis::ReplicapoolV1beta2::ReplicaPoolAutoHealingPolicy::Representation property :base_instance_name, as: 'baseInstanceName' property :creation_timestamp, as: 'creationTimestamp' property :current_size, as: 'currentSize' property :description, as: 'description' property :fingerprint, :base64 => true, as: 'fingerprint' property :group, as: 'group' property :id, :numeric_string => true, as: 'id' property :instance_template, as: 'instanceTemplate' property :kind, as: 'kind' property :name, as: 'name' property :self_link, as: 'selfLink' collection :target_pools, as: 'targetPools' property :target_size, as: 'targetSize' end end class InstanceGroupManagerList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ReplicapoolV1beta2::InstanceGroupManager, decorator: Google::Apis::ReplicapoolV1beta2::InstanceGroupManager::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end class AbandonInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class DeleteInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class RecreateInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class SetInstanceTemplateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance_template, as: 'instanceTemplate' end end class SetTargetPoolsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' collection :target_pools, as: 'targetPools' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_operation_id, as: 'clientOperationId' property :creation_timestamp, as: 'creationTimestamp' property :end_time, as: 'endTime' property :error, as: 'error', class: Google::Apis::ReplicapoolV1beta2::Operation::Error, decorator: Google::Apis::ReplicapoolV1beta2::Operation::Error::Representation property :http_error_message, as: 'httpErrorMessage' property :http_error_status_code, as: 'httpErrorStatusCode' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' property :kind, as: 'kind' property :name, as: 'name' property :operation_type, as: 'operationType' property :progress, as: 'progress' property :region, as: 'region' property :self_link, as: 'selfLink' property :start_time, as: 'startTime' property :status, as: 'status' property :status_message, as: 'statusMessage' property :target_id, :numeric_string => true, as: 'targetId' property :target_link, as: 'targetLink' property :user, as: 'user' collection :warnings, as: 'warnings', class: Google::Apis::ReplicapoolV1beta2::Operation::Warning, decorator: Google::Apis::ReplicapoolV1beta2::Operation::Warning::Representation property :zone, as: 'zone' end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::ReplicapoolV1beta2::Operation::Error::Error, decorator: Google::Apis::ReplicapoolV1beta2::Operation::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ReplicapoolV1beta2::Operation::Warning::Datum, decorator: Google::Apis::ReplicapoolV1beta2::Operation::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 OperationList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ReplicapoolV1beta2::Operation, decorator: Google::Apis::ReplicapoolV1beta2::Operation::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end class ReplicaPoolAutoHealingPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :action_type, as: 'actionType' property :health_check, as: 'healthCheck' end end end end end google-api-client-0.19.8/generated/google/apis/replicapool_v1beta2/classes.rb0000644000004100000410000006002013252673044027131 0ustar www-datawww-data# 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 ReplicapoolV1beta2 # An Instance Group Manager resource. class InstanceGroupManager include Google::Apis::Core::Hashable # The autohealing policy for this managed instance group. You can specify only # one value. # Corresponds to the JSON property `autoHealingPolicies` # @return [Array] attr_accessor :auto_healing_policies # The base instance name to use for instances in this group. The value must be a # valid RFC1035 name. Supported characters are lowercase letters, numbers, and # hyphens (-). Instances are named by appending a hyphen and a random four- # character string to the base instance name. # Corresponds to the JSON property `baseInstanceName` # @return [String] attr_accessor :base_instance_name # [Output only] The time the instance group manager was created, in RFC3339 text # format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output only] The number of instances that currently exist and are a part of # this group. This includes instances that are starting but are not yet RUNNING, # and instances that are in the process of being deleted or abandoned. # Corresponds to the JSON property `currentSize` # @return [Fixnum] attr_accessor :current_size # An optional textual description of the instance group manager. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output only] Fingerprint of the instance group manager. This field is used # for optimistic locking. An up-to-date fingerprint must be provided in order to # modify the Instance Group Manager resource. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # [Output only] The full URL of the instance group created by the manager. This # group contains all of the instances being managed, and cannot contain non- # managed instances. # Corresponds to the JSON property `group` # @return [String] attr_accessor :group # [Output only] A server-assigned unique identifier for the resource. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The full URL to an instance template from which all new instances will be # created. # Corresponds to the JSON property `instanceTemplate` # @return [String] attr_accessor :instance_template # [Output only] The resource type. Always replicapool#instanceGroupManager. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the instance group manager. Must be 1-63 characters long and # comply with RFC1035. Supported characters include lowercase letters, numbers, # and hyphens. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output only] The fully qualified URL for this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The full URL of all target pools to which new instances in the group are added. # Updating the target pool values does not affect existing instances. # Corresponds to the JSON property `targetPools` # @return [Array] attr_accessor :target_pools # [Output only] The number of instances that the manager is attempting to # maintain. Deleting or abandoning instances affects this number, as does # resizing the group. # Corresponds to the JSON property `targetSize` # @return [Fixnum] attr_accessor :target_size def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_healing_policies = args[:auto_healing_policies] if args.key?(:auto_healing_policies) @base_instance_name = args[:base_instance_name] if args.key?(:base_instance_name) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @current_size = args[:current_size] if args.key?(:current_size) @description = args[:description] if args.key?(:description) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @group = args[:group] if args.key?(:group) @id = args[:id] if args.key?(:id) @instance_template = args[:instance_template] if args.key?(:instance_template) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) @target_pools = args[:target_pools] if args.key?(:target_pools) @target_size = args[:target_size] if args.key?(:target_size) end end # class InstanceGroupManagerList include Google::Apis::Core::Hashable # Unique identifier for the resource; defined by the server (output only). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A list of instance resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A token used to continue a truncated list request (output only). # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Server defined URL for this resource (output only). # 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) @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) end end # class AbandonInstancesRequest include Google::Apis::Core::Hashable # The names of one or more instances to abandon. For example: # ` 'instances': [ 'instance-c3po', 'instance-r2d2' ] ` # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class DeleteInstancesRequest include Google::Apis::Core::Hashable # Names of instances to delete. # Example: 'instance-foo', 'instance-bar' # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class RecreateInstancesRequest include Google::Apis::Core::Hashable # The names of one or more instances to recreate. For example: # ` 'instances': [ 'instance-c3po', 'instance-r2d2' ] ` # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class SetInstanceTemplateRequest include Google::Apis::Core::Hashable # The full URL to an Instance Template from which all new instances will be # created. # Corresponds to the JSON property `instanceTemplate` # @return [String] attr_accessor :instance_template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance_template = args[:instance_template] if args.key?(:instance_template) end end # class SetTargetPoolsRequest include Google::Apis::Core::Hashable # The current fingerprint of the Instance Group Manager resource. If this does # not match the server-side fingerprint of the resource, then the request will # be rejected. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # A list of fully-qualified URLs to existing Target Pool resources. New # instances in the Instance Group Manager will be added to the specified target # pools; existing instances are not affected. # Corresponds to the JSON property `targetPools` # @return [Array] attr_accessor :target_pools def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @target_pools = args[:target_pools] if args.key?(:target_pools) end end # An operation resource, used to manage asynchronous API requests. class Operation include Google::Apis::Core::Hashable # [Output only] An optional identifier specified by the client when the mutation # was initiated. Must be unique for all operation resources in the project. # Corresponds to the JSON property `clientOperationId` # @return [String] attr_accessor :client_operation_id # [Output Only] The time that this operation was requested, in RFC3339 text # format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] The time that this operation was completed, in RFC3339 text # format. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # [Output Only] If errors occurred during processing of this operation, this # field will be populated. # Corresponds to the JSON property `error` # @return [Google::Apis::ReplicapoolV1beta2::Operation::Error] attr_accessor :error # [Output only] If operation fails, the HTTP error message returned. # Corresponds to the JSON property `httpErrorMessage` # @return [String] attr_accessor :http_error_message # [Output only] If operation fails, the HTTP error status code returned. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] attr_accessor :http_error_status_code # [Output Only] Unique identifier for the resource, generated by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The time that this operation was requested, in RFC3339 text # format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # [Output only] Type of the resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output only] Type of the operation. Operations include insert, update, and # delete. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # [Output only] An optional progress indicator that ranges from 0 to 100. There # is no requirement that this be linear or support any granularity of operations. # This should not be used to guess at when the operation will be complete. This # number should be monotonically increasing as the operation progresses. # Corresponds to the JSON property `progress` # @return [Fixnum] attr_accessor :progress # [Output Only] URL of the region where the operation resides. Only available # when performing regional operations. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # [Output Only] Server-defined fully-qualified URL for this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] The time that this operation was started by the server, in # RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # [Output Only] Status of the operation. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional textual description of the current status of the # operation. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # [Output Only] Unique target ID which identifies a particular incarnation of # the target. # Corresponds to the JSON property `targetId` # @return [Fixnum] attr_accessor :target_id # [Output only] URL of the resource the operation is mutating. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link # [Output Only] User who requested the operation, for example: user@example.com. # Corresponds to the JSON property `user` # @return [String] attr_accessor :user # [Output Only] If there are issues with this operation, a warning is returned. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings # [Output Only] URL of the zone where the operation resides. Only available when # performing per-zone operations. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @end_time = args[:end_time] if args.key?(:end_time) @error = args[:error] if args.key?(:error) @http_error_message = args[:http_error_message] if args.key?(:http_error_message) @http_error_status_code = args[:http_error_status_code] if args.key?(:http_error_status_code) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @operation_type = args[:operation_type] if args.key?(:operation_type) @progress = args[:progress] if args.key?(:progress) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @target_id = args[:target_id] if args.key?(:target_id) @target_link = args[:target_link] if args.key?(:target_link) @user = args[:user] if args.key?(:user) @warnings = args[:warnings] if args.key?(:warnings) @zone = args[:zone] if args.key?(:zone) end # [Output Only] If errors occurred during processing of this operation, this # field will be populated. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request which caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end # class Warning include Google::Apis::Core::Hashable # [Output only] The warning type identifier for this warning. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output only] Metadata for this warning in key:value format. # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data # [Output only] Optional human-readable details for this warning. # 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] Metadata key for this warning. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # [Output Only] Metadata value for this warning. # 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 # class OperationList include Google::Apis::Core::Hashable # Unique identifier for the resource; defined by the server (output only). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The operation resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A token used to continue a truncated list request (output only). # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Server defined URL for this resource (output only). # 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) @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) end end # class ReplicaPoolAutoHealingPolicy include Google::Apis::Core::Hashable # The action to perform when an instance becomes unhealthy. Possible values are # RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new # instance that is based on the instance template for this managed instance # group. REBOOT performs a soft reboot on an instance. If the instance cannot # reboot, the instance performs a hard restart. # Corresponds to the JSON property `actionType` # @return [String] attr_accessor :action_type # The URL for the HealthCheck that signals autohealing. # Corresponds to the JSON property `healthCheck` # @return [String] attr_accessor :health_check def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action_type = args[:action_type] if args.key?(:action_type) @health_check = args[:health_check] if args.key?(:health_check) end end end end end google-api-client-0.19.8/generated/google/apis/replicapool_v1beta2/service.rb0000644000004100000410000011122213252673044027135 0ustar www-datawww-data# 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 ReplicapoolV1beta2 # Google Compute Engine Instance Group Manager API # # [Deprecated. Please use Instance Group Manager in Compute API] Provides groups # of homogenous Compute Engine instances. # # @example # require 'google/apis/replicapool_v1beta2' # # Replicapool = Google::Apis::ReplicapoolV1beta2 # Alias the module # service = Replicapool::ReplicapoolService.new # # @see https://developers.google.com/compute/docs/instance-groups/manager/v1beta2 class ReplicapoolService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'replicapool/v1beta2/projects/') @batch_path = 'batch/replicapool/v1beta2' end # Removes the specified instances from the managed instance group, and from any # target pools of which they were members, without deleting the instances. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the instance group manager resides. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Google::Apis::ReplicapoolV1beta2::AbandonInstancesRequest] abandon_instances_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::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 abandon_instances(project, zone, instance_group_manager, abandon_instances_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances', options) command.request_representation = Google::Apis::ReplicapoolV1beta2::AbandonInstancesRequest::Representation command.request_object = abandon_instances_request_object command.response_representation = Google::Apis::ReplicapoolV1beta2::Operation::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 instance group manager and all instances contained within. If you' # d like to delete the manager without deleting the instances, you must first # abandon the instances to remove them from the group. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the instance group manager resides. # @param [String] instance_group_manager # Name of the Instance Group Manager resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::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_instance_group_manager(project, zone, instance_group_manager, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}', options) command.response_representation = Google::Apis::ReplicapoolV1beta2::Operation::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 instances. The instances are deleted, then removed from # the instance group and any target pools of which they were a member. The # targetSize of the instance group manager is reduced by the number of instances # deleted. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the instance group manager resides. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Google::Apis::ReplicapoolV1beta2::DeleteInstancesRequest] delete_instances_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::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_instances(project, zone, instance_group_manager, delete_instances_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances', options) command.request_representation = Google::Apis::ReplicapoolV1beta2::DeleteInstancesRequest::Representation command.request_object = delete_instances_request_object command.response_representation = Google::Apis::ReplicapoolV1beta2::Operation::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 Instance Group Manager resource. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the instance group manager resides. # @param [String] instance_group_manager # Name of the instance resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::InstanceGroupManager] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::InstanceGroupManager] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_group_manager(project, zone, instance_group_manager, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}', options) command.response_representation = Google::Apis::ReplicapoolV1beta2::InstanceGroupManager::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::InstanceGroupManager command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 instance group manager, as well as the instance group and the # specified number of instances. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the instance group manager resides. # @param [Fixnum] size # Number of instances that should exist. # @param [Google::Apis::ReplicapoolV1beta2::InstanceGroupManager] instance_group_manager_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::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_instance_group_manager(project, zone, size, instance_group_manager_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers', options) command.request_representation = Google::Apis::ReplicapoolV1beta2::InstanceGroupManager::Representation command.request_object = instance_group_manager_object command.response_representation = Google::Apis::ReplicapoolV1beta2::Operation::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.query['size'] = size unless size.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 the list of Instance Group Manager resources contained within the # specified zone. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the instance group manager resides. # @param [String] filter # Optional. Filter expression for filtering listed resources. # @param [Fixnum] max_results # Optional. Maximum count of results to be returned. Maximum value is 500 and # default value is 500. # @param [String] page_token # Optional. Tag returned by a previous list request truncated by maxResults. # Used to continue 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::InstanceGroupManagerList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::InstanceGroupManagerList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_group_managers(project, zone, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instanceGroupManagers', options) command.response_representation = Google::Apis::ReplicapoolV1beta2::InstanceGroupManagerList::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::InstanceGroupManagerList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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 # Recreates the specified instances. The instances are deleted, then recreated # using the instance group manager's current instance template. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the instance group manager resides. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Google::Apis::ReplicapoolV1beta2::RecreateInstancesRequest] recreate_instances_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::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 recreate_instances(project, zone, instance_group_manager, recreate_instances_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances', options) command.request_representation = Google::Apis::ReplicapoolV1beta2::RecreateInstancesRequest::Representation command.request_object = recreate_instances_request_object command.response_representation = Google::Apis::ReplicapoolV1beta2::Operation::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Resizes the managed instance group up or down. If resized up, new instances # are created using the current instance template. If resized down, instances # are removed in the order outlined in Resizing a managed instance group. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the instance group manager resides. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Fixnum] size # Number of instances that should exist in this Instance Group Manager. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::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 resize_instance(project, zone, instance_group_manager, size, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize', options) command.response_representation = Google::Apis::ReplicapoolV1beta2::Operation::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['size'] = size unless size.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 instance template to use when creating new instances in this group. # Existing instances are not affected. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the instance group manager resides. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Google::Apis::ReplicapoolV1beta2::SetInstanceTemplateRequest] set_instance_template_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::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 set_instance_template(project, zone, instance_group_manager, set_instance_template_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate', options) command.request_representation = Google::Apis::ReplicapoolV1beta2::SetInstanceTemplateRequest::Representation command.request_object = set_instance_template_request_object command.response_representation = Google::Apis::ReplicapoolV1beta2::Operation::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Modifies the target pools to which all new instances in this group are # assigned. Existing instances in the group are not affected. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the instance group manager resides. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Google::Apis::ReplicapoolV1beta2::SetTargetPoolsRequest] set_target_pools_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::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 set_target_pools(project, zone, instance_group_manager, set_target_pools_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools', options) command.request_representation = Google::Apis::ReplicapoolV1beta2::SetTargetPoolsRequest::Representation command.request_object = set_target_pools_request_object command.response_representation = Google::Apis::ReplicapoolV1beta2::Operation::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 the specified zone-specific operation resource. # @param [String] project # Name of the project scoping this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] operation # Name of the operation resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::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_zone_operation(project, zone, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/operations/{operation}', options) command.response_representation = Google::Apis::ReplicapoolV1beta2::Operation::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['operation'] = operation unless operation.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 the list of operation resources contained within the specified zone. # @param [String] project # Name of the project scoping this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] filter # Optional. Filter expression for filtering listed resources. # @param [Fixnum] max_results # Optional. Maximum count of results to be returned. Maximum value is 500 and # default value is 500. # @param [String] page_token # Optional. Tag returned by a previous list request truncated by maxResults. # Used to continue 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolV1beta2::OperationList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolV1beta2::OperationList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zone_operations(project, zone, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/operations', options) command.response_representation = Google::Apis::ReplicapoolV1beta2::OperationList::Representation command.response_class = Google::Apis::ReplicapoolV1beta2::OperationList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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 protected 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 end end google-api-client-0.19.8/generated/google/apis/oslogin_v1beta/0000755000004100000410000000000013252673044024230 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/oslogin_v1beta/representations.rb0000644000004100000410000000706013252673044030005 0ustar www-datawww-data# 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 OsloginV1beta class Empty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportSshPublicKeyResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LoginProfile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PosixAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SshPublicKey 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 ImportSshPublicKeyResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :login_profile, as: 'loginProfile', class: Google::Apis::OsloginV1beta::LoginProfile, decorator: Google::Apis::OsloginV1beta::LoginProfile::Representation end end class LoginProfile # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' collection :posix_accounts, as: 'posixAccounts', class: Google::Apis::OsloginV1beta::PosixAccount, decorator: Google::Apis::OsloginV1beta::PosixAccount::Representation hash :ssh_public_keys, as: 'sshPublicKeys', class: Google::Apis::OsloginV1beta::SshPublicKey, decorator: Google::Apis::OsloginV1beta::SshPublicKey::Representation end end class PosixAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :gecos, as: 'gecos' property :gid, :numeric_string => true, as: 'gid' property :home_directory, as: 'homeDirectory' property :primary, as: 'primary' property :shell, as: 'shell' property :system_id, as: 'systemId' property :uid, :numeric_string => true, as: 'uid' property :username, as: 'username' end end class SshPublicKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :expiration_time_usec, :numeric_string => true, as: 'expirationTimeUsec' property :fingerprint, as: 'fingerprint' property :key, as: 'key' end end end end end google-api-client-0.19.8/generated/google/apis/oslogin_v1beta/classes.rb0000644000004100000410000001560613252673044026222 0ustar www-datawww-data# 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 OsloginV1beta # 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 response message for importing an SSH public key. class ImportSshPublicKeyResponse include Google::Apis::Core::Hashable # The user profile information used for logging in to a virtual machine on # Google Compute Engine. # Corresponds to the JSON property `loginProfile` # @return [Google::Apis::OsloginV1beta::LoginProfile] attr_accessor :login_profile def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @login_profile = args[:login_profile] if args.key?(:login_profile) end end # The user profile information used for logging in to a virtual machine on # Google Compute Engine. class LoginProfile include Google::Apis::Core::Hashable # A unique user ID. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The list of POSIX accounts associated with the user. # Corresponds to the JSON property `posixAccounts` # @return [Array] attr_accessor :posix_accounts # A map from SSH public key fingerprint to the associated key object. # Corresponds to the JSON property `sshPublicKeys` # @return [Hash] attr_accessor :ssh_public_keys def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @posix_accounts = args[:posix_accounts] if args.key?(:posix_accounts) @ssh_public_keys = args[:ssh_public_keys] if args.key?(:ssh_public_keys) end end # The POSIX account information associated with a Google account. class PosixAccount include Google::Apis::Core::Hashable # Output only. A POSIX account identifier. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # The GECOS (user information) entry for this account. # Corresponds to the JSON property `gecos` # @return [String] attr_accessor :gecos # The default group ID. # Corresponds to the JSON property `gid` # @return [Fixnum] attr_accessor :gid # The path to the home directory for this account. # Corresponds to the JSON property `homeDirectory` # @return [String] attr_accessor :home_directory # Only one POSIX account can be marked as primary. # Corresponds to the JSON property `primary` # @return [Boolean] attr_accessor :primary alias_method :primary?, :primary # The path to the logic shell for this account. # Corresponds to the JSON property `shell` # @return [String] attr_accessor :shell # System identifier for which account the username or uid applies to. # By default, the empty value is used. # Corresponds to the JSON property `systemId` # @return [String] attr_accessor :system_id # The user ID. # Corresponds to the JSON property `uid` # @return [Fixnum] attr_accessor :uid # The username of the POSIX account. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @gecos = args[:gecos] if args.key?(:gecos) @gid = args[:gid] if args.key?(:gid) @home_directory = args[:home_directory] if args.key?(:home_directory) @primary = args[:primary] if args.key?(:primary) @shell = args[:shell] if args.key?(:shell) @system_id = args[:system_id] if args.key?(:system_id) @uid = args[:uid] if args.key?(:uid) @username = args[:username] if args.key?(:username) end end # The SSH public key information associated with a Google account. class SshPublicKey include Google::Apis::Core::Hashable # An expiration time in microseconds since epoch. # Corresponds to the JSON property `expirationTimeUsec` # @return [Fixnum] attr_accessor :expiration_time_usec # Output only. The SHA-256 fingerprint of the SSH public key. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # Public key text in SSH format, defined by # RFC4253 # section 6.6. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expiration_time_usec = args[:expiration_time_usec] if args.key?(:expiration_time_usec) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @key = args[:key] if args.key?(:key) end end end end end google-api-client-0.19.8/generated/google/apis/oslogin_v1beta/service.rb0000644000004100000410000003463513252673044026230 0ustar www-datawww-data# 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 OsloginV1beta # Google Cloud OS Login API # # Manages OS login configuration for Google account users. # # @example # require 'google/apis/oslogin_v1beta' # # Oslogin = Google::Apis::OsloginV1beta # Alias the module # service = Oslogin::CloudOSLoginService.new # # @see https://cloud.google.com/compute/docs/oslogin/rest/ class CloudOSLoginService < 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://oslogin.googleapis.com/', '') @batch_path = 'batch' end # Retrieves the profile information used for logging in to a virtual machine # on Google Compute Engine. # @param [String] name # The unique ID for the user in format `users/`user``. # @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::OsloginV1beta::LoginProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1beta::LoginProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_login_profile(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}/loginProfile', options) command.response_representation = Google::Apis::OsloginV1beta::LoginProfile::Representation command.response_class = Google::Apis::OsloginV1beta::LoginProfile 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 SSH public key and returns the profile information. Default POSIX # account information is set when no username and UID exist as part of the # login profile. # @param [String] parent # The unique ID for the user in format `users/`user``. # @param [Google::Apis::OsloginV1beta::SshPublicKey] ssh_public_key_object # @param [String] project_id # The project ID of the Google Cloud Platform 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::OsloginV1beta::ImportSshPublicKeyResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1beta::ImportSshPublicKeyResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def import_user_ssh_public_key(parent, ssh_public_key_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/{+parent}:importSshPublicKey', options) command.request_representation = Google::Apis::OsloginV1beta::SshPublicKey::Representation command.request_object = ssh_public_key_object command.response_representation = Google::Apis::OsloginV1beta::ImportSshPublicKeyResponse::Representation command.response_class = Google::Apis::OsloginV1beta::ImportSshPublicKeyResponse command.params['parent'] = parent unless parent.nil? command.query['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 # Deletes a POSIX account. # @param [String] name # A reference to the POSIX account to update. POSIX accounts are identified # by the project ID they are associated with. A reference to the POSIX # account is in format `users/`user`/projects/`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::OsloginV1beta::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1beta::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_user_project(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta/{+name}', options) command.response_representation = Google::Apis::OsloginV1beta::Empty::Representation command.response_class = Google::Apis::OsloginV1beta::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 # Deletes an SSH public key. # @param [String] name # The fingerprint of the public key to update. Public keys are identified by # their SHA-256 fingerprint. The fingerprint of the public key is in format # `users/`user`/sshPublicKeys/`fingerprint``. # @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::OsloginV1beta::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1beta::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_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta/{+name}', options) command.response_representation = Google::Apis::OsloginV1beta::Empty::Representation command.response_class = Google::Apis::OsloginV1beta::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 # Retrieves an SSH public key. # @param [String] name # The fingerprint of the public key to retrieve. Public keys are identified # by their SHA-256 fingerprint. The fingerprint of the public key is in # format `users/`user`/sshPublicKeys/`fingerprint``. # @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::OsloginV1beta::SshPublicKey] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1beta::SshPublicKey] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}', options) command.response_representation = Google::Apis::OsloginV1beta::SshPublicKey::Representation command.response_class = Google::Apis::OsloginV1beta::SshPublicKey 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 SSH public key and returns the profile information. This method # supports patch semantics. # @param [String] name # The fingerprint of the public key to update. Public keys are identified by # their SHA-256 fingerprint. The fingerprint of the public key is in format # `users/`user`/sshPublicKeys/`fingerprint``. # @param [Google::Apis::OsloginV1beta::SshPublicKey] ssh_public_key_object # @param [String] update_mask # Mask to control which fields get updated. Updates all if not present. # @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::OsloginV1beta::SshPublicKey] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::OsloginV1beta::SshPublicKey] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_ssh_public_key(name, ssh_public_key_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::OsloginV1beta::SshPublicKey::Representation command.request_object = ssh_public_key_object command.response_representation = Google::Apis::OsloginV1beta::SshPublicKey::Representation command.response_class = Google::Apis::OsloginV1beta::SshPublicKey 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 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 google-api-client-0.19.8/generated/google/apis/acceleratedmobilepageurl_v1/0000755000004100000410000000000013252673043026725 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/acceleratedmobilepageurl_v1/representations.rb0000644000004100000410000000555313252673043032507 0ustar www-datawww-data# 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 AcceleratedmobilepageurlV1 class AmpUrl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AmpUrlError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchGetAmpUrlsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchGetAmpUrlsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AmpUrl # @private class Representation < Google::Apis::Core::JsonRepresentation property :amp_url, as: 'ampUrl' property :cdn_amp_url, as: 'cdnAmpUrl' property :original_url, as: 'originalUrl' end end class AmpUrlError # @private class Representation < Google::Apis::Core::JsonRepresentation property :error_code, as: 'errorCode' property :error_message, as: 'errorMessage' property :original_url, as: 'originalUrl' end end class BatchGetAmpUrlsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :lookup_strategy, as: 'lookupStrategy' collection :urls, as: 'urls' end end class BatchGetAmpUrlsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :amp_urls, as: 'ampUrls', class: Google::Apis::AcceleratedmobilepageurlV1::AmpUrl, decorator: Google::Apis::AcceleratedmobilepageurlV1::AmpUrl::Representation collection :url_errors, as: 'urlErrors', class: Google::Apis::AcceleratedmobilepageurlV1::AmpUrlError, decorator: Google::Apis::AcceleratedmobilepageurlV1::AmpUrlError::Representation end end end end end google-api-client-0.19.8/generated/google/apis/acceleratedmobilepageurl_v1/classes.rb0000644000004100000410000001157713252673043030722 0ustar www-datawww-data# 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 AcceleratedmobilepageurlV1 # AMP URL response for a requested URL. class AmpUrl include Google::Apis::Core::Hashable # The AMP URL pointing to the publisher's web server. # Corresponds to the JSON property `ampUrl` # @return [String] attr_accessor :amp_url # The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to # the cached document in the Google AMP Cache. # Corresponds to the JSON property `cdnAmpUrl` # @return [String] attr_accessor :cdn_amp_url # The original non-AMP URL. # Corresponds to the JSON property `originalUrl` # @return [String] attr_accessor :original_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @amp_url = args[:amp_url] if args.key?(:amp_url) @cdn_amp_url = args[:cdn_amp_url] if args.key?(:cdn_amp_url) @original_url = args[:original_url] if args.key?(:original_url) end end # AMP URL Error resource for a requested URL that couldn't be found. class AmpUrlError include Google::Apis::Core::Hashable # The error code of an API call. # Corresponds to the JSON property `errorCode` # @return [String] attr_accessor :error_code # An optional descriptive error message. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message # The original non-AMP URL. # Corresponds to the JSON property `originalUrl` # @return [String] attr_accessor :original_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_code = args[:error_code] if args.key?(:error_code) @error_message = args[:error_message] if args.key?(:error_message) @original_url = args[:original_url] if args.key?(:original_url) end end # AMP URL request for a batch of URLs. class BatchGetAmpUrlsRequest include Google::Apis::Core::Hashable # The lookup_strategy being requested. # Corresponds to the JSON property `lookupStrategy` # @return [String] attr_accessor :lookup_strategy # List of URLs to look up for the paired AMP URLs. # The URLs are case-sensitive. Up to 50 URLs per lookup # (see [Usage Limits](/amp/cache/reference/limits)). # Corresponds to the JSON property `urls` # @return [Array] attr_accessor :urls def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @lookup_strategy = args[:lookup_strategy] if args.key?(:lookup_strategy) @urls = args[:urls] if args.key?(:urls) end end # Batch AMP URL response. class BatchGetAmpUrlsResponse include Google::Apis::Core::Hashable # For each URL in BatchAmpUrlsRequest, the URL response. The response might # not be in the same order as URLs in the batch request. # If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated # only once. # Corresponds to the JSON property `ampUrls` # @return [Array] attr_accessor :amp_urls # The errors for requested URLs that have no AMP URL. # Corresponds to the JSON property `urlErrors` # @return [Array] attr_accessor :url_errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @amp_urls = args[:amp_urls] if args.key?(:amp_urls) @url_errors = args[:url_errors] if args.key?(:url_errors) end end end end end google-api-client-0.19.8/generated/google/apis/acceleratedmobilepageurl_v1/service.rb0000644000004100000410000001041513252673043030713 0ustar www-datawww-data# 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 AcceleratedmobilepageurlV1 # Accelerated Mobile Pages (AMP) URL API # # Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given # list of public URL(s). # # @example # require 'google/apis/acceleratedmobilepageurl_v1' # # Acceleratedmobilepageurl = Google::Apis::AcceleratedmobilepageurlV1 # Alias the module # service = Acceleratedmobilepageurl::AcceleratedmobilepageurlService.new # # @see https://developers.google.com/amp/cache/ class AcceleratedmobilepageurlService < 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://acceleratedmobilepageurl.googleapis.com/', '') @batch_path = 'batch' end # Returns AMP URL(s) and equivalent # [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format). # @param [Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsRequest] batch_get_amp_urls_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::AcceleratedmobilepageurlV1::BatchGetAmpUrlsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_get_amp_urls(batch_get_amp_urls_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/ampUrls:batchGet', options) command.request_representation = Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsRequest::Representation command.request_object = batch_get_amp_urls_request_object command.response_representation = Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsResponse::Representation command.response_class = Google::Apis::AcceleratedmobilepageurlV1::BatchGetAmpUrlsResponse 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 google-api-client-0.19.8/generated/google/apis/androidmanagement_v1/0000755000004100000410000000000013252673043025376 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/androidmanagement_v1/representations.rb0000644000004100000410000010413113252673043031150 0ustar www-datawww-data# 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 AndroidmanagementV1 class AlwaysOnVpnPackage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApiLevelCondition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Application class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApplicationPermission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApplicationPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Command class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ComplianceRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Device class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeviceSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DisplayProp 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 EnrollmentToken class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Enterprise class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ExternalData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HardwareInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HardwareStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDevicesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPoliciesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedProperty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedPropertyEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MemoryEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MemoryInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NonComplianceDetail class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NonComplianceDetailCondition 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 PackageNameList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PasswordRequirements class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PermissionGrant class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PersistentPreferredActivity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PowerManagementEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProxyInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SignupUrl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SoftwareInfo 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 StatusReportingSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SystemUpdate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserFacingMessage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WebToken class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AlwaysOnVpnPackage # @private class Representation < Google::Apis::Core::JsonRepresentation property :lockdown_enabled, as: 'lockdownEnabled' property :package_name, as: 'packageName' end end class ApiLevelCondition # @private class Representation < Google::Apis::Core::JsonRepresentation property :min_api_level, as: 'minApiLevel' end end class Application # @private class Representation < Google::Apis::Core::JsonRepresentation collection :managed_properties, as: 'managedProperties', class: Google::Apis::AndroidmanagementV1::ManagedProperty, decorator: Google::Apis::AndroidmanagementV1::ManagedProperty::Representation property :name, as: 'name' collection :permissions, as: 'permissions', class: Google::Apis::AndroidmanagementV1::ApplicationPermission, decorator: Google::Apis::AndroidmanagementV1::ApplicationPermission::Representation property :title, as: 'title' end end class ApplicationPermission # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :name, as: 'name' property :permission_id, as: 'permissionId' end end class ApplicationPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_permission_policy, as: 'defaultPermissionPolicy' collection :delegated_scopes, as: 'delegatedScopes' property :install_type, as: 'installType' property :lock_task_allowed, as: 'lockTaskAllowed' hash :managed_configuration, as: 'managedConfiguration' property :minimum_version_code, as: 'minimumVersionCode' property :package_name, as: 'packageName' collection :permission_grants, as: 'permissionGrants', class: Google::Apis::AndroidmanagementV1::PermissionGrant, decorator: Google::Apis::AndroidmanagementV1::PermissionGrant::Representation end end class Command # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :duration, as: 'duration' property :new_password, as: 'newPassword' collection :reset_password_flags, as: 'resetPasswordFlags' property :type, as: 'type' end end class ComplianceRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_level_condition, as: 'apiLevelCondition', class: Google::Apis::AndroidmanagementV1::ApiLevelCondition, decorator: Google::Apis::AndroidmanagementV1::ApiLevelCondition::Representation property :disable_apps, as: 'disableApps' property :non_compliance_detail_condition, as: 'nonComplianceDetailCondition', class: Google::Apis::AndroidmanagementV1::NonComplianceDetailCondition, decorator: Google::Apis::AndroidmanagementV1::NonComplianceDetailCondition::Representation end end class Device # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_level, as: 'apiLevel' property :applied_policy_name, as: 'appliedPolicyName' property :applied_policy_version, :numeric_string => true, as: 'appliedPolicyVersion' property :applied_state, as: 'appliedState' property :device_settings, as: 'deviceSettings', class: Google::Apis::AndroidmanagementV1::DeviceSettings, decorator: Google::Apis::AndroidmanagementV1::DeviceSettings::Representation property :disabled_reason, as: 'disabledReason', class: Google::Apis::AndroidmanagementV1::UserFacingMessage, decorator: Google::Apis::AndroidmanagementV1::UserFacingMessage::Representation collection :displays, as: 'displays', class: Google::Apis::AndroidmanagementV1::DisplayProp, decorator: Google::Apis::AndroidmanagementV1::DisplayProp::Representation property :enrollment_time, as: 'enrollmentTime' property :enrollment_token_data, as: 'enrollmentTokenData' property :enrollment_token_name, as: 'enrollmentTokenName' property :hardware_info, as: 'hardwareInfo', class: Google::Apis::AndroidmanagementV1::HardwareInfo, decorator: Google::Apis::AndroidmanagementV1::HardwareInfo::Representation collection :hardware_status_samples, as: 'hardwareStatusSamples', class: Google::Apis::AndroidmanagementV1::HardwareStatus, decorator: Google::Apis::AndroidmanagementV1::HardwareStatus::Representation property :last_policy_compliance_report_time, as: 'lastPolicyComplianceReportTime' property :last_policy_sync_time, as: 'lastPolicySyncTime' property :last_status_report_time, as: 'lastStatusReportTime' collection :memory_events, as: 'memoryEvents', class: Google::Apis::AndroidmanagementV1::MemoryEvent, decorator: Google::Apis::AndroidmanagementV1::MemoryEvent::Representation property :memory_info, as: 'memoryInfo', class: Google::Apis::AndroidmanagementV1::MemoryInfo, decorator: Google::Apis::AndroidmanagementV1::MemoryInfo::Representation property :name, as: 'name' property :network_info, as: 'networkInfo', class: Google::Apis::AndroidmanagementV1::NetworkInfo, decorator: Google::Apis::AndroidmanagementV1::NetworkInfo::Representation collection :non_compliance_details, as: 'nonComplianceDetails', class: Google::Apis::AndroidmanagementV1::NonComplianceDetail, decorator: Google::Apis::AndroidmanagementV1::NonComplianceDetail::Representation property :policy_compliant, as: 'policyCompliant' property :policy_name, as: 'policyName' collection :power_management_events, as: 'powerManagementEvents', class: Google::Apis::AndroidmanagementV1::PowerManagementEvent, decorator: Google::Apis::AndroidmanagementV1::PowerManagementEvent::Representation collection :previous_device_names, as: 'previousDeviceNames' property :software_info, as: 'softwareInfo', class: Google::Apis::AndroidmanagementV1::SoftwareInfo, decorator: Google::Apis::AndroidmanagementV1::SoftwareInfo::Representation property :state, as: 'state' property :user_name, as: 'userName' end end class DeviceSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :adb_enabled, as: 'adbEnabled' property :development_settings_enabled, as: 'developmentSettingsEnabled' property :encryption_status, as: 'encryptionStatus' property :is_device_secure, as: 'isDeviceSecure' property :is_encrypted, as: 'isEncrypted' property :unknown_sources_enabled, as: 'unknownSourcesEnabled' property :verify_apps_enabled, as: 'verifyAppsEnabled' end end class DisplayProp # @private class Representation < Google::Apis::Core::JsonRepresentation property :density, as: 'density' property :display_id, as: 'displayId' property :height, as: 'height' property :name, as: 'name' property :refresh_rate, as: 'refreshRate' property :state, as: 'state' property :width, as: 'width' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class EnrollmentToken # @private class Representation < Google::Apis::Core::JsonRepresentation property :additional_data, as: 'additionalData' property :duration, as: 'duration' property :expiration_timestamp, as: 'expirationTimestamp' property :name, as: 'name' property :policy_name, as: 'policyName' property :qr_code, as: 'qrCode' property :value, as: 'value' end end class Enterprise # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_auto_approval_enabled, as: 'appAutoApprovalEnabled' collection :enabled_notification_types, as: 'enabledNotificationTypes' property :enterprise_display_name, as: 'enterpriseDisplayName' property :logo, as: 'logo', class: Google::Apis::AndroidmanagementV1::ExternalData, decorator: Google::Apis::AndroidmanagementV1::ExternalData::Representation property :name, as: 'name' property :primary_color, as: 'primaryColor' property :pubsub_topic, as: 'pubsubTopic' end end class ExternalData # @private class Representation < Google::Apis::Core::JsonRepresentation property :sha256_hash, as: 'sha256Hash' property :url, as: 'url' end end class HardwareInfo # @private class Representation < Google::Apis::Core::JsonRepresentation collection :battery_shutdown_temperatures, as: 'batteryShutdownTemperatures' collection :battery_throttling_temperatures, as: 'batteryThrottlingTemperatures' property :brand, as: 'brand' collection :cpu_shutdown_temperatures, as: 'cpuShutdownTemperatures' collection :cpu_throttling_temperatures, as: 'cpuThrottlingTemperatures' property :device_baseband_version, as: 'deviceBasebandVersion' collection :gpu_shutdown_temperatures, as: 'gpuShutdownTemperatures' collection :gpu_throttling_temperatures, as: 'gpuThrottlingTemperatures' property :hardware, as: 'hardware' property :manufacturer, as: 'manufacturer' property :model, as: 'model' property :serial_number, as: 'serialNumber' collection :skin_shutdown_temperatures, as: 'skinShutdownTemperatures' collection :skin_throttling_temperatures, as: 'skinThrottlingTemperatures' end end class HardwareStatus # @private class Representation < Google::Apis::Core::JsonRepresentation collection :battery_temperatures, as: 'batteryTemperatures' collection :cpu_temperatures, as: 'cpuTemperatures' collection :cpu_usages, as: 'cpuUsages' property :create_time, as: 'createTime' collection :fan_speeds, as: 'fanSpeeds' collection :gpu_temperatures, as: 'gpuTemperatures' collection :skin_temperatures, as: 'skinTemperatures' end end class ListDevicesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :devices, as: 'devices', class: Google::Apis::AndroidmanagementV1::Device, decorator: Google::Apis::AndroidmanagementV1::Device::Representation property :next_page_token, as: 'nextPageToken' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::AndroidmanagementV1::Operation, decorator: Google::Apis::AndroidmanagementV1::Operation::Representation end end class ListPoliciesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :policies, as: 'policies', class: Google::Apis::AndroidmanagementV1::Policy, decorator: Google::Apis::AndroidmanagementV1::Policy::Representation end end class ManagedProperty # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_value, as: 'defaultValue' property :description, as: 'description' collection :entries, as: 'entries', class: Google::Apis::AndroidmanagementV1::ManagedPropertyEntry, decorator: Google::Apis::AndroidmanagementV1::ManagedPropertyEntry::Representation property :key, as: 'key' collection :nested_properties, as: 'nestedProperties', class: Google::Apis::AndroidmanagementV1::ManagedProperty, decorator: Google::Apis::AndroidmanagementV1::ManagedProperty::Representation property :title, as: 'title' property :type, as: 'type' end end class ManagedPropertyEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :value, as: 'value' end end class MemoryEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :byte_count, :numeric_string => true, as: 'byteCount' property :create_time, as: 'createTime' property :event_type, as: 'eventType' end end class MemoryInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :total_internal_storage, :numeric_string => true, as: 'totalInternalStorage' property :total_ram, :numeric_string => true, as: 'totalRam' end end class NetworkInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :imei, as: 'imei' property :meid, as: 'meid' property :network_operator_name, as: 'networkOperatorName' property :wifi_mac_address, as: 'wifiMacAddress' end end class NonComplianceDetail # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_value, as: 'currentValue' property :field_path, as: 'fieldPath' property :installation_failure_reason, as: 'installationFailureReason' property :non_compliance_reason, as: 'nonComplianceReason' property :package_name, as: 'packageName' property :setting_name, as: 'settingName' end end class NonComplianceDetailCondition # @private class Representation < Google::Apis::Core::JsonRepresentation property :non_compliance_reason, as: 'nonComplianceReason' property :package_name, as: 'packageName' property :setting_name, as: 'settingName' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::AndroidmanagementV1::Status, decorator: Google::Apis::AndroidmanagementV1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class PackageNameList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :package_names, as: 'packageNames' end end class PasswordRequirements # @private class Representation < Google::Apis::Core::JsonRepresentation property :maximum_failed_passwords_for_wipe, as: 'maximumFailedPasswordsForWipe' property :password_expiration_timeout, as: 'passwordExpirationTimeout' property :password_history_length, as: 'passwordHistoryLength' property :password_minimum_length, as: 'passwordMinimumLength' property :password_minimum_letters, as: 'passwordMinimumLetters' property :password_minimum_lower_case, as: 'passwordMinimumLowerCase' property :password_minimum_non_letter, as: 'passwordMinimumNonLetter' property :password_minimum_numeric, as: 'passwordMinimumNumeric' property :password_minimum_symbols, as: 'passwordMinimumSymbols' property :password_minimum_upper_case, as: 'passwordMinimumUpperCase' property :password_quality, as: 'passwordQuality' end end class PermissionGrant # @private class Representation < Google::Apis::Core::JsonRepresentation property :permission, as: 'permission' property :policy, as: 'policy' end end class PersistentPreferredActivity # @private class Representation < Google::Apis::Core::JsonRepresentation collection :actions, as: 'actions' collection :categories, as: 'categories' property :receiver_activity, as: 'receiverActivity' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_types_with_management_disabled, as: 'accountTypesWithManagementDisabled' property :add_user_disabled, as: 'addUserDisabled' property :adjust_volume_disabled, as: 'adjustVolumeDisabled' property :always_on_vpn_package, as: 'alwaysOnVpnPackage', class: Google::Apis::AndroidmanagementV1::AlwaysOnVpnPackage, decorator: Google::Apis::AndroidmanagementV1::AlwaysOnVpnPackage::Representation collection :android_device_policy_tracks, as: 'androidDevicePolicyTracks' collection :applications, as: 'applications', class: Google::Apis::AndroidmanagementV1::ApplicationPolicy, decorator: Google::Apis::AndroidmanagementV1::ApplicationPolicy::Representation property :auto_time_required, as: 'autoTimeRequired' property :block_applications_enabled, as: 'blockApplicationsEnabled' property :bluetooth_config_disabled, as: 'bluetoothConfigDisabled' property :bluetooth_contact_sharing_disabled, as: 'bluetoothContactSharingDisabled' property :bluetooth_disabled, as: 'bluetoothDisabled' property :camera_disabled, as: 'cameraDisabled' property :cell_broadcasts_config_disabled, as: 'cellBroadcastsConfigDisabled' collection :compliance_rules, as: 'complianceRules', class: Google::Apis::AndroidmanagementV1::ComplianceRule, decorator: Google::Apis::AndroidmanagementV1::ComplianceRule::Representation property :create_windows_disabled, as: 'createWindowsDisabled' property :credentials_config_disabled, as: 'credentialsConfigDisabled' property :data_roaming_disabled, as: 'dataRoamingDisabled' property :debugging_features_allowed, as: 'debuggingFeaturesAllowed' property :default_permission_policy, as: 'defaultPermissionPolicy' property :ensure_verify_apps_enabled, as: 'ensureVerifyAppsEnabled' property :factory_reset_disabled, as: 'factoryResetDisabled' collection :frp_admin_emails, as: 'frpAdminEmails' property :fun_disabled, as: 'funDisabled' property :install_apps_disabled, as: 'installAppsDisabled' property :install_unknown_sources_allowed, as: 'installUnknownSourcesAllowed' property :keyguard_disabled, as: 'keyguardDisabled' collection :keyguard_disabled_features, as: 'keyguardDisabledFeatures' property :kiosk_custom_launcher_enabled, as: 'kioskCustomLauncherEnabled' property :long_support_message, as: 'longSupportMessage', class: Google::Apis::AndroidmanagementV1::UserFacingMessage, decorator: Google::Apis::AndroidmanagementV1::UserFacingMessage::Representation property :maximum_time_to_lock, :numeric_string => true, as: 'maximumTimeToLock' property :mobile_networks_config_disabled, as: 'mobileNetworksConfigDisabled' property :modify_accounts_disabled, as: 'modifyAccountsDisabled' property :mount_physical_media_disabled, as: 'mountPhysicalMediaDisabled' property :name, as: 'name' property :network_escape_hatch_enabled, as: 'networkEscapeHatchEnabled' property :network_reset_disabled, as: 'networkResetDisabled' hash :open_network_configuration, as: 'openNetworkConfiguration' property :outgoing_beam_disabled, as: 'outgoingBeamDisabled' property :outgoing_calls_disabled, as: 'outgoingCallsDisabled' property :password_requirements, as: 'passwordRequirements', class: Google::Apis::AndroidmanagementV1::PasswordRequirements, decorator: Google::Apis::AndroidmanagementV1::PasswordRequirements::Representation property :permitted_input_methods, as: 'permittedInputMethods', class: Google::Apis::AndroidmanagementV1::PackageNameList, decorator: Google::Apis::AndroidmanagementV1::PackageNameList::Representation collection :persistent_preferred_activities, as: 'persistentPreferredActivities', class: Google::Apis::AndroidmanagementV1::PersistentPreferredActivity, decorator: Google::Apis::AndroidmanagementV1::PersistentPreferredActivity::Representation property :recommended_global_proxy, as: 'recommendedGlobalProxy', class: Google::Apis::AndroidmanagementV1::ProxyInfo, decorator: Google::Apis::AndroidmanagementV1::ProxyInfo::Representation property :remove_user_disabled, as: 'removeUserDisabled' property :safe_boot_disabled, as: 'safeBootDisabled' property :screen_capture_disabled, as: 'screenCaptureDisabled' property :set_user_icon_disabled, as: 'setUserIconDisabled' property :set_wallpaper_disabled, as: 'setWallpaperDisabled' property :short_support_message, as: 'shortSupportMessage', class: Google::Apis::AndroidmanagementV1::UserFacingMessage, decorator: Google::Apis::AndroidmanagementV1::UserFacingMessage::Representation property :sms_disabled, as: 'smsDisabled' property :status_bar_disabled, as: 'statusBarDisabled' property :status_reporting_settings, as: 'statusReportingSettings', class: Google::Apis::AndroidmanagementV1::StatusReportingSettings, decorator: Google::Apis::AndroidmanagementV1::StatusReportingSettings::Representation collection :stay_on_plugged_modes, as: 'stayOnPluggedModes' property :system_update, as: 'systemUpdate', class: Google::Apis::AndroidmanagementV1::SystemUpdate, decorator: Google::Apis::AndroidmanagementV1::SystemUpdate::Representation property :tethering_config_disabled, as: 'tetheringConfigDisabled' property :uninstall_apps_disabled, as: 'uninstallAppsDisabled' property :unmute_microphone_disabled, as: 'unmuteMicrophoneDisabled' property :usb_file_transfer_disabled, as: 'usbFileTransferDisabled' property :version, :numeric_string => true, as: 'version' property :vpn_config_disabled, as: 'vpnConfigDisabled' property :wifi_config_disabled, as: 'wifiConfigDisabled' property :wifi_configs_lockdown_enabled, as: 'wifiConfigsLockdownEnabled' end end class PowerManagementEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :battery_level, as: 'batteryLevel' property :create_time, as: 'createTime' property :event_type, as: 'eventType' end end class ProxyInfo # @private class Representation < Google::Apis::Core::JsonRepresentation collection :excluded_hosts, as: 'excludedHosts' property :host, as: 'host' property :pac_uri, as: 'pacUri' property :port, as: 'port' end end class SignupUrl # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :url, as: 'url' end end class SoftwareInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :android_build_number, as: 'androidBuildNumber' property :android_build_time, as: 'androidBuildTime' property :android_device_policy_version_code, as: 'androidDevicePolicyVersionCode' property :android_device_policy_version_name, as: 'androidDevicePolicyVersionName' property :android_version, as: 'androidVersion' property :bootloader_version, as: 'bootloaderVersion' property :device_build_signature, as: 'deviceBuildSignature' property :device_kernel_version, as: 'deviceKernelVersion' property :security_patch_level, as: 'securityPatchLevel' 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 StatusReportingSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :device_settings_enabled, as: 'deviceSettingsEnabled' property :display_info_enabled, as: 'displayInfoEnabled' property :hardware_status_enabled, as: 'hardwareStatusEnabled' property :memory_info_enabled, as: 'memoryInfoEnabled' property :network_info_enabled, as: 'networkInfoEnabled' property :power_management_events_enabled, as: 'powerManagementEventsEnabled' property :software_info_enabled, as: 'softwareInfoEnabled' end end class SystemUpdate # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_minutes, as: 'endMinutes' property :start_minutes, as: 'startMinutes' property :type, as: 'type' end end class UserFacingMessage # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_message, as: 'defaultMessage' hash :localized_messages, as: 'localizedMessages' end end class WebToken # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :parent_frame_url, as: 'parentFrameUrl' collection :permissions, as: 'permissions' property :value, as: 'value' end end end end end google-api-client-0.19.8/generated/google/apis/androidmanagement_v1/classes.rb0000644000004100000410000034156613252673043027377 0ustar www-datawww-data# 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 AndroidmanagementV1 # Configuration for an always-on VPN connection. class AlwaysOnVpnPackage include Google::Apis::Core::Hashable # Disallows networking when the VPN is not connected. # Corresponds to the JSON property `lockdownEnabled` # @return [Boolean] attr_accessor :lockdown_enabled alias_method :lockdown_enabled?, :lockdown_enabled # The package name of the VPN app. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @lockdown_enabled = args[:lockdown_enabled] if args.key?(:lockdown_enabled) @package_name = args[:package_name] if args.key?(:package_name) end end # A compliance rule condition which is satisfied if the Android Framework API # level on the device doesn't meet a minimum requirement. There can only be one # rule with this type of condition per policy. class ApiLevelCondition include Google::Apis::Core::Hashable # The minimum desired Android Framework API level. If the device doesn't meet # the minimum requirement, this condition is satisfied. Must be greater than # zero. # Corresponds to the JSON property `minApiLevel` # @return [Fixnum] attr_accessor :min_api_level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @min_api_level = args[:min_api_level] if args.key?(:min_api_level) end end # Information about an app. class Application include Google::Apis::Core::Hashable # The set of managed properties available to be pre-configured for the app. # Corresponds to the JSON property `managedProperties` # @return [Array] attr_accessor :managed_properties # The name of the app in the form enterprises/`enterpriseId`/applications/` # package_name`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The permissions required by the app. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions # The title of the app. Localized. # 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) @managed_properties = args[:managed_properties] if args.key?(:managed_properties) @name = args[:name] if args.key?(:name) @permissions = args[:permissions] if args.key?(:permissions) @title = args[:title] if args.key?(:title) end end # A permission required by the app. class ApplicationPermission include Google::Apis::Core::Hashable # A longer description of the permission, providing more detail on what it # affects. Localized. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The name of the permission. Localized. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An opaque string uniquely identifying the permission. Not localized. # Corresponds to the JSON property `permissionId` # @return [String] attr_accessor :permission_id 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) @permission_id = args[:permission_id] if args.key?(:permission_id) end end # Policy for an individual app. class ApplicationPolicy include Google::Apis::Core::Hashable # The default policy for all permissions requested by the app. If specified, # this overrides the policy-level default_permission_policy which applies to all # apps. # Corresponds to the JSON property `defaultPermissionPolicy` # @return [String] attr_accessor :default_permission_policy # The scopes delegated to the app from Android Device Policy. # Corresponds to the JSON property `delegatedScopes` # @return [Array] attr_accessor :delegated_scopes # The type of installation to perform. # Corresponds to the JSON property `installType` # @return [String] attr_accessor :install_type # Whether the app is allowed to lock itself in full-screen mode. # Corresponds to the JSON property `lockTaskAllowed` # @return [Boolean] attr_accessor :lock_task_allowed alias_method :lock_task_allowed?, :lock_task_allowed # Managed configuration applied to the app. The format for the configuration is # dictated by the ManagedProperty values supported by the app. Each field name # in the managed configuration must match the key field of the ManagedProperty. # The field value must be compatible with the type of the ManagedProperty: < # table> typeJSON value BOOLtrue or false STRINGstring # INTEGERnumber CHOICEstring < # td>MULTISELECTarray of strings HIDDEN # string BUNDLE_ARRAYarray of objects # Corresponds to the JSON property `managedConfiguration` # @return [Hash] attr_accessor :managed_configuration # The minimum version of the app that runs on the device. If set, the device # attempts to update the app to at least this version code. If the app is not up- # to-date, the device will contain a NonComplianceDetail with # non_compliance_reason set to APP_NOT_UPDATED. The app must already be # published to Google Play with a version code greater than or equal to this # value. At most 20 apps may specify a minimum version code per policy. # Corresponds to the JSON property `minimumVersionCode` # @return [Fixnum] attr_accessor :minimum_version_code # The package name of the app. For example, com.google.android.youtube for the # YouTube app. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name # Explicit permission grants or denials for the app. These values override the # default_permission_policy. # Corresponds to the JSON property `permissionGrants` # @return [Array] attr_accessor :permission_grants def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_permission_policy = args[:default_permission_policy] if args.key?(:default_permission_policy) @delegated_scopes = args[:delegated_scopes] if args.key?(:delegated_scopes) @install_type = args[:install_type] if args.key?(:install_type) @lock_task_allowed = args[:lock_task_allowed] if args.key?(:lock_task_allowed) @managed_configuration = args[:managed_configuration] if args.key?(:managed_configuration) @minimum_version_code = args[:minimum_version_code] if args.key?(:minimum_version_code) @package_name = args[:package_name] if args.key?(:package_name) @permission_grants = args[:permission_grants] if args.key?(:permission_grants) end end # A command. class Command include Google::Apis::Core::Hashable # The timestamp at which the command was created. The timestamp is automatically # generated by the server. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The duration for which the command is valid. The command will expire if not # executed by the device during this time. The default duration if unspecified # is ten minutes. There is no maximum duration. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration # For commands of type RESET_PASSWORD, optionally specifies the new password. # Corresponds to the JSON property `newPassword` # @return [String] attr_accessor :new_password # For commands of type RESET_PASSWORD, optionally specifies flags. # Corresponds to the JSON property `resetPasswordFlags` # @return [Array] attr_accessor :reset_password_flags # The type of the command. # 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) @duration = args[:duration] if args.key?(:duration) @new_password = args[:new_password] if args.key?(:new_password) @reset_password_flags = args[:reset_password_flags] if args.key?(:reset_password_flags) @type = args[:type] if args.key?(:type) end end # A rule declaring which mitigating actions to take when a device is not # compliant with its policy. For every rule, there is always an implicit # mitigating action to set policy_compliant to false for the Device resource, # and display a message on the device indicating that the device is not # compliant with its policy. Other mitigating actions may optionally be taken as # well, depending on the field values in the rule. class ComplianceRule include Google::Apis::Core::Hashable # A compliance rule condition which is satisfied if the Android Framework API # level on the device doesn't meet a minimum requirement. There can only be one # rule with this type of condition per policy. # Corresponds to the JSON property `apiLevelCondition` # @return [Google::Apis::AndroidmanagementV1::ApiLevelCondition] attr_accessor :api_level_condition # If set to true, the rule includes a mitigating action to disable apps so that # the device is effectively disabled, but app data is preserved. If the device # is running an app in locked task mode, the app will be closed and a UI showing # the reason for non-compliance will be displayed. # Corresponds to the JSON property `disableApps` # @return [Boolean] attr_accessor :disable_apps alias_method :disable_apps?, :disable_apps # A compliance rule condition which is satisfied if there exists any matching # NonComplianceDetail for the device. A NonComplianceDetail matches a # NonComplianceDetailCondition if all the fields which are set within the # NonComplianceDetailCondition match the corresponding NonComplianceDetail # fields. # Corresponds to the JSON property `nonComplianceDetailCondition` # @return [Google::Apis::AndroidmanagementV1::NonComplianceDetailCondition] attr_accessor :non_compliance_detail_condition def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @api_level_condition = args[:api_level_condition] if args.key?(:api_level_condition) @disable_apps = args[:disable_apps] if args.key?(:disable_apps) @non_compliance_detail_condition = args[:non_compliance_detail_condition] if args.key?(:non_compliance_detail_condition) end end # A device owned by an enterprise. Unless otherwise noted, all fields are read- # only and can't be modified by enterprises.devices.patch. class Device include Google::Apis::Core::Hashable # The API level of the Android platform version running on the device. # Corresponds to the JSON property `apiLevel` # @return [Fixnum] attr_accessor :api_level # The name of the policy currently applied to the device. # Corresponds to the JSON property `appliedPolicyName` # @return [String] attr_accessor :applied_policy_name # The version of the policy currently applied to the device. # Corresponds to the JSON property `appliedPolicyVersion` # @return [Fixnum] attr_accessor :applied_policy_version # The state currently applied to the device. # Corresponds to the JSON property `appliedState` # @return [String] attr_accessor :applied_state # Information about security related device settings on device. # Corresponds to the JSON property `deviceSettings` # @return [Google::Apis::AndroidmanagementV1::DeviceSettings] attr_accessor :device_settings # Provides a user-facing message with locale info. The maximum message length is # 4096 characters. # Corresponds to the JSON property `disabledReason` # @return [Google::Apis::AndroidmanagementV1::UserFacingMessage] attr_accessor :disabled_reason # Detailed information about displays on the device. This information is only # available if displayInfoEnabled is true in the device's policy. # Corresponds to the JSON property `displays` # @return [Array] attr_accessor :displays # The time of device enrollment. # Corresponds to the JSON property `enrollmentTime` # @return [String] attr_accessor :enrollment_time # If the device was enrolled with an enrollment token with additional data # provided, this field contains that data. # Corresponds to the JSON property `enrollmentTokenData` # @return [String] attr_accessor :enrollment_token_data # If the device was enrolled with an enrollment token, this field contains the # name of the token. # Corresponds to the JSON property `enrollmentTokenName` # @return [String] attr_accessor :enrollment_token_name # Information about device hardware. The fields related to temperature # thresholds are only available if hardwareStatusEnabled is true in the device's # policy. # Corresponds to the JSON property `hardwareInfo` # @return [Google::Apis::AndroidmanagementV1::HardwareInfo] attr_accessor :hardware_info # Hardware status samples in chronological order. This information is only # available if hardwareStatusEnabled is true in the device's policy. # Corresponds to the JSON property `hardwareStatusSamples` # @return [Array] attr_accessor :hardware_status_samples # The last time the device sent a policy compliance report. # Corresponds to the JSON property `lastPolicyComplianceReportTime` # @return [String] attr_accessor :last_policy_compliance_report_time # The last time the device fetched its policy. # Corresponds to the JSON property `lastPolicySyncTime` # @return [String] attr_accessor :last_policy_sync_time # The last time the device sent a status report. # Corresponds to the JSON property `lastStatusReportTime` # @return [String] attr_accessor :last_status_report_time # Events related to memory and storage measurements in chronological order. This # information is only available if memoryInfoEnabled is true in the device's # policy. # Corresponds to the JSON property `memoryEvents` # @return [Array] attr_accessor :memory_events # Information about device memory and storage. # Corresponds to the JSON property `memoryInfo` # @return [Google::Apis::AndroidmanagementV1::MemoryInfo] attr_accessor :memory_info # The name of the device in the form enterprises/`enterpriseId`/devices/` # deviceId`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Device network info. # Corresponds to the JSON property `networkInfo` # @return [Google::Apis::AndroidmanagementV1::NetworkInfo] attr_accessor :network_info # Details about policy settings that the device is not compliant with. # Corresponds to the JSON property `nonComplianceDetails` # @return [Array] attr_accessor :non_compliance_details # Whether the device is compliant with its policy. # Corresponds to the JSON property `policyCompliant` # @return [Boolean] attr_accessor :policy_compliant alias_method :policy_compliant?, :policy_compliant # The name of the policy applied to the device, in the form enterprises/` # enterpriseId`/policies/`policyId`. If not specified, the policy_name for the # device's user is applied. This field can be modified by a patch request. You # can specify only the policyId when calling enterprises.devices.patch, as long # as the policyId doesn’t contain any slashes. The rest of the policy name is # inferred. # Corresponds to the JSON property `policyName` # @return [String] attr_accessor :policy_name # Power management events on the device in chronological order. This information # is only available if powerManagementEventsEnabled is true in the device's # policy. # Corresponds to the JSON property `powerManagementEvents` # @return [Array] attr_accessor :power_management_events # If the same physical device has been enrolled multiple times, this field # contains its previous device names. The serial number is used as the unique # identifier to determine if the same physical device has enrolled previously. # The names are in chronological order. # Corresponds to the JSON property `previousDeviceNames` # @return [Array] attr_accessor :previous_device_names # Information about device software. # Corresponds to the JSON property `softwareInfo` # @return [Google::Apis::AndroidmanagementV1::SoftwareInfo] attr_accessor :software_info # The state to be applied to the device. This field can be modified by a patch # request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED # are the only allowable values. To enter the device into a DELETED state, call # enterprises.devices.delete. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # The resource name of the user that owns this device in the form enterprises/` # enterpriseId`/users/`userId`. # 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) @api_level = args[:api_level] if args.key?(:api_level) @applied_policy_name = args[:applied_policy_name] if args.key?(:applied_policy_name) @applied_policy_version = args[:applied_policy_version] if args.key?(:applied_policy_version) @applied_state = args[:applied_state] if args.key?(:applied_state) @device_settings = args[:device_settings] if args.key?(:device_settings) @disabled_reason = args[:disabled_reason] if args.key?(:disabled_reason) @displays = args[:displays] if args.key?(:displays) @enrollment_time = args[:enrollment_time] if args.key?(:enrollment_time) @enrollment_token_data = args[:enrollment_token_data] if args.key?(:enrollment_token_data) @enrollment_token_name = args[:enrollment_token_name] if args.key?(:enrollment_token_name) @hardware_info = args[:hardware_info] if args.key?(:hardware_info) @hardware_status_samples = args[:hardware_status_samples] if args.key?(:hardware_status_samples) @last_policy_compliance_report_time = args[:last_policy_compliance_report_time] if args.key?(:last_policy_compliance_report_time) @last_policy_sync_time = args[:last_policy_sync_time] if args.key?(:last_policy_sync_time) @last_status_report_time = args[:last_status_report_time] if args.key?(:last_status_report_time) @memory_events = args[:memory_events] if args.key?(:memory_events) @memory_info = args[:memory_info] if args.key?(:memory_info) @name = args[:name] if args.key?(:name) @network_info = args[:network_info] if args.key?(:network_info) @non_compliance_details = args[:non_compliance_details] if args.key?(:non_compliance_details) @policy_compliant = args[:policy_compliant] if args.key?(:policy_compliant) @policy_name = args[:policy_name] if args.key?(:policy_name) @power_management_events = args[:power_management_events] if args.key?(:power_management_events) @previous_device_names = args[:previous_device_names] if args.key?(:previous_device_names) @software_info = args[:software_info] if args.key?(:software_info) @state = args[:state] if args.key?(:state) @user_name = args[:user_name] if args.key?(:user_name) end end # Information about security related device settings on device. class DeviceSettings include Google::Apis::Core::Hashable # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is # enabled on the device. # Corresponds to the JSON property `adbEnabled` # @return [Boolean] attr_accessor :adb_enabled alias_method :adb_enabled?, :adb_enabled # Whether developer mode is enabled on the device. # Corresponds to the JSON property `developmentSettingsEnabled` # @return [Boolean] attr_accessor :development_settings_enabled alias_method :development_settings_enabled?, :development_settings_enabled # Encryption status from DevicePolicyManager. # Corresponds to the JSON property `encryptionStatus` # @return [String] attr_accessor :encryption_status # Whether the device is secured with PIN/password. # Corresponds to the JSON property `isDeviceSecure` # @return [Boolean] attr_accessor :is_device_secure alias_method :is_device_secure?, :is_device_secure # Whether the storage encryption is enabled. # Corresponds to the JSON property `isEncrypted` # @return [Boolean] attr_accessor :is_encrypted alias_method :is_encrypted?, :is_encrypted # Whether installing apps from unknown sources is enabled. # Corresponds to the JSON property `unknownSourcesEnabled` # @return [Boolean] attr_accessor :unknown_sources_enabled alias_method :unknown_sources_enabled?, :unknown_sources_enabled # Whether Verify Apps (Google Play Protect (https://support.google.com/ # googleplay/answer/2812853)) is enabled on the device. # Corresponds to the JSON property `verifyAppsEnabled` # @return [Boolean] attr_accessor :verify_apps_enabled alias_method :verify_apps_enabled?, :verify_apps_enabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @adb_enabled = args[:adb_enabled] if args.key?(:adb_enabled) @development_settings_enabled = args[:development_settings_enabled] if args.key?(:development_settings_enabled) @encryption_status = args[:encryption_status] if args.key?(:encryption_status) @is_device_secure = args[:is_device_secure] if args.key?(:is_device_secure) @is_encrypted = args[:is_encrypted] if args.key?(:is_encrypted) @unknown_sources_enabled = args[:unknown_sources_enabled] if args.key?(:unknown_sources_enabled) @verify_apps_enabled = args[:verify_apps_enabled] if args.key?(:verify_apps_enabled) end end # Device display information. class DisplayProp include Google::Apis::Core::Hashable # Display density expressed as dots-per-inch. # Corresponds to the JSON property `density` # @return [Fixnum] attr_accessor :density # Unique display id. # Corresponds to the JSON property `displayId` # @return [Fixnum] attr_accessor :display_id # Display height in pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Name of the display. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Refresh rate of the display in frames per second. # Corresponds to the JSON property `refreshRate` # @return [Fixnum] attr_accessor :refresh_rate # State of the display. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Display width in pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @density = args[:density] if args.key?(:density) @display_id = args[:display_id] if args.key?(:display_id) @height = args[:height] if args.key?(:height) @name = args[:name] if args.key?(:name) @refresh_rate = args[:refresh_rate] if args.key?(:refresh_rate) @state = args[:state] if args.key?(:state) @width = args[:width] if args.key?(:width) 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 # An enrollment token. class EnrollmentToken include Google::Apis::Core::Hashable # Optional, arbitrary data associated with the enrollment token. This could # contain, for example, the ID of an org unit the device is assigned to after # enrollment. After a device enrolls with the token, this data will be exposed # in the enrollment_token_data field of the Device resource. The data must be # 1024 characters or less; otherwise, the creation request will fail. # Corresponds to the JSON property `additionalData` # @return [String] attr_accessor :additional_data # The length of time the enrollment token is valid, ranging from 1 minute to 30 # days. If not specified, the default duration is 1 hour. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration # The expiration time of the token. This is a read-only field generated by the # server. # Corresponds to the JSON property `expirationTimestamp` # @return [String] attr_accessor :expiration_timestamp # The name of the enrollment token, which is generated by the server during # creation, in the form enterprises/`enterpriseId`/enrollmentTokens/` # enrollmentTokenId`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The name of the policy initially applied to the enrolled device, in the form # enterprises/`enterpriseId`/policies/`policyId`. If not specified, the # policy_name for the device’s user is applied. If user_name is also not # specified, enterprises/`enterpriseId`/policies/default is applied by default. # When updating this field, you can specify only the policyId as long as the # policyId doesn’t contain any slashes. The rest of the policy name will be # inferred. # Corresponds to the JSON property `policyName` # @return [String] attr_accessor :policy_name # A JSON string whose UTF-8 representation can be used to generate a QR code to # enroll a device with this enrollment token. To enroll a device using NFC, the # NFC record must contain a serialized java.util.Properties representation of # the properties in the JSON. # Corresponds to the JSON property `qrCode` # @return [String] attr_accessor :qr_code # The token value that's passed to the device and authorizes the device to # enroll. This is a read-only field generated by the server. # 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) @additional_data = args[:additional_data] if args.key?(:additional_data) @duration = args[:duration] if args.key?(:duration) @expiration_timestamp = args[:expiration_timestamp] if args.key?(:expiration_timestamp) @name = args[:name] if args.key?(:name) @policy_name = args[:policy_name] if args.key?(:policy_name) @qr_code = args[:qr_code] if args.key?(:qr_code) @value = args[:value] if args.key?(:value) end end # The configuration applied to an enterprise. class Enterprise include Google::Apis::Core::Hashable # Whether permissions for apps installed via policy are automatically approved. # If enabled, you must display an app's permissions to the enterprise admin # before setting the app to be installed in a policy. # Corresponds to the JSON property `appAutoApprovalEnabled` # @return [Boolean] attr_accessor :app_auto_approval_enabled alias_method :app_auto_approval_enabled?, :app_auto_approval_enabled # The types of Google Pub/Sub notifications enabled for the enterprise. # Corresponds to the JSON property `enabledNotificationTypes` # @return [Array] attr_accessor :enabled_notification_types # The name of the enterprise displayed to users. # Corresponds to the JSON property `enterpriseDisplayName` # @return [String] attr_accessor :enterprise_display_name # Data hosted at an external location. The data is to be downloaded by Android # Device Policy and verified against the hash. # Corresponds to the JSON property `logo` # @return [Google::Apis::AndroidmanagementV1::ExternalData] attr_accessor :logo # The name of the enterprise which is generated by the server during creation, # in the form enterprises/`enterpriseId`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A color in RGB format that indicates the predominant color to display in the # device management app UI. The color components are stored as follows: (red << # 16) | (green << 8) | blue, where the value of each component is between 0 and # 255, inclusive. # Corresponds to the JSON property `primaryColor` # @return [Fixnum] attr_accessor :primary_color # The topic that Cloud Pub/Sub notifications are published to, in the form # projects/`project`/topics/`topic`. This field is only required if Pub/Sub # notifications are enabled. # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @app_auto_approval_enabled = args[:app_auto_approval_enabled] if args.key?(:app_auto_approval_enabled) @enabled_notification_types = args[:enabled_notification_types] if args.key?(:enabled_notification_types) @enterprise_display_name = args[:enterprise_display_name] if args.key?(:enterprise_display_name) @logo = args[:logo] if args.key?(:logo) @name = args[:name] if args.key?(:name) @primary_color = args[:primary_color] if args.key?(:primary_color) @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic) end end # Data hosted at an external location. The data is to be downloaded by Android # Device Policy and verified against the hash. class ExternalData include Google::Apis::Core::Hashable # The base-64 encoded SHA-256 hash of the content hosted at url. If the content # doesn't match this hash, Android Device Policy won't use the data. # Corresponds to the JSON property `sha256Hash` # @return [String] attr_accessor :sha256_hash # The absolute URL to the data, which must use either the http or https scheme. # Android Device Policy doesn't provide any credentials in the GET request, so # the URL must be publicly accessible. Including a long, random component in the # URL may be used to prevent attackers from discovering the URL. # 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) @sha256_hash = args[:sha256_hash] if args.key?(:sha256_hash) @url = args[:url] if args.key?(:url) end end # Information about device hardware. The fields related to temperature # thresholds are only available if hardwareStatusEnabled is true in the device's # policy. class HardwareInfo include Google::Apis::Core::Hashable # Battery shutdown temperature thresholds in Celsius for each battery on the # device. # Corresponds to the JSON property `batteryShutdownTemperatures` # @return [Array] attr_accessor :battery_shutdown_temperatures # Battery throttling temperature thresholds in Celsius for each battery on the # device. # Corresponds to the JSON property `batteryThrottlingTemperatures` # @return [Array] attr_accessor :battery_throttling_temperatures # Brand of the device. For example, Google. # Corresponds to the JSON property `brand` # @return [String] attr_accessor :brand # CPU shutdown temperature thresholds in Celsius for each CPU on the device. # Corresponds to the JSON property `cpuShutdownTemperatures` # @return [Array] attr_accessor :cpu_shutdown_temperatures # CPU throttling temperature thresholds in Celsius for each CPU on the device. # Corresponds to the JSON property `cpuThrottlingTemperatures` # @return [Array] attr_accessor :cpu_throttling_temperatures # Baseband version. For example, MDM9625_104662.22.05.34p. # Corresponds to the JSON property `deviceBasebandVersion` # @return [String] attr_accessor :device_baseband_version # GPU shutdown temperature thresholds in Celsius for each GPU on the device. # Corresponds to the JSON property `gpuShutdownTemperatures` # @return [Array] attr_accessor :gpu_shutdown_temperatures # GPU throttling temperature thresholds in Celsius for each GPU on the device. # Corresponds to the JSON property `gpuThrottlingTemperatures` # @return [Array] attr_accessor :gpu_throttling_temperatures # Name of the hardware. For example, Angler. # Corresponds to the JSON property `hardware` # @return [String] attr_accessor :hardware # Manufacturer. For example, Motorola. # Corresponds to the JSON property `manufacturer` # @return [String] attr_accessor :manufacturer # The model of the device. For example, Asus Nexus 7. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model # The device serial number. # Corresponds to the JSON property `serialNumber` # @return [String] attr_accessor :serial_number # Device skin shutdown temperature thresholds in Celsius. # Corresponds to the JSON property `skinShutdownTemperatures` # @return [Array] attr_accessor :skin_shutdown_temperatures # Device skin throttling temperature thresholds in Celsius. # Corresponds to the JSON property `skinThrottlingTemperatures` # @return [Array] attr_accessor :skin_throttling_temperatures def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @battery_shutdown_temperatures = args[:battery_shutdown_temperatures] if args.key?(:battery_shutdown_temperatures) @battery_throttling_temperatures = args[:battery_throttling_temperatures] if args.key?(:battery_throttling_temperatures) @brand = args[:brand] if args.key?(:brand) @cpu_shutdown_temperatures = args[:cpu_shutdown_temperatures] if args.key?(:cpu_shutdown_temperatures) @cpu_throttling_temperatures = args[:cpu_throttling_temperatures] if args.key?(:cpu_throttling_temperatures) @device_baseband_version = args[:device_baseband_version] if args.key?(:device_baseband_version) @gpu_shutdown_temperatures = args[:gpu_shutdown_temperatures] if args.key?(:gpu_shutdown_temperatures) @gpu_throttling_temperatures = args[:gpu_throttling_temperatures] if args.key?(:gpu_throttling_temperatures) @hardware = args[:hardware] if args.key?(:hardware) @manufacturer = args[:manufacturer] if args.key?(:manufacturer) @model = args[:model] if args.key?(:model) @serial_number = args[:serial_number] if args.key?(:serial_number) @skin_shutdown_temperatures = args[:skin_shutdown_temperatures] if args.key?(:skin_shutdown_temperatures) @skin_throttling_temperatures = args[:skin_throttling_temperatures] if args.key?(:skin_throttling_temperatures) end end # Hardware status. Temperatures may be compared to the temperature thresholds # available in hardwareInfo to determine hardware health. class HardwareStatus include Google::Apis::Core::Hashable # Current battery temperatures in Celsius for each battery on the device. # Corresponds to the JSON property `batteryTemperatures` # @return [Array] attr_accessor :battery_temperatures # Current CPU temperatures in Celsius for each CPU on the device. # Corresponds to the JSON property `cpuTemperatures` # @return [Array] attr_accessor :cpu_temperatures # CPU usages in percentage for each core available on the device. Usage is 0 for # each unplugged core. Empty array implies that CPU usage is not supported in # the system. # Corresponds to the JSON property `cpuUsages` # @return [Array] attr_accessor :cpu_usages # The time the measurements were taken. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Fan speeds in RPM for each fan on the device. Empty array means that there are # no fans or fan speed is not supported on the system. # Corresponds to the JSON property `fanSpeeds` # @return [Array] attr_accessor :fan_speeds # Current GPU temperatures in Celsius for each GPU on the device. # Corresponds to the JSON property `gpuTemperatures` # @return [Array] attr_accessor :gpu_temperatures # Current device skin temperatures in Celsius. # Corresponds to the JSON property `skinTemperatures` # @return [Array] attr_accessor :skin_temperatures def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @battery_temperatures = args[:battery_temperatures] if args.key?(:battery_temperatures) @cpu_temperatures = args[:cpu_temperatures] if args.key?(:cpu_temperatures) @cpu_usages = args[:cpu_usages] if args.key?(:cpu_usages) @create_time = args[:create_time] if args.key?(:create_time) @fan_speeds = args[:fan_speeds] if args.key?(:fan_speeds) @gpu_temperatures = args[:gpu_temperatures] if args.key?(:gpu_temperatures) @skin_temperatures = args[:skin_temperatures] if args.key?(:skin_temperatures) end end # Response to a request to list devices for a given enterprise. class ListDevicesResponse include Google::Apis::Core::Hashable # The list of devices. # Corresponds to the JSON property `devices` # @return [Array] attr_accessor :devices # If there are more results, a token to retrieve 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) @devices = args[:devices] if args.key?(:devices) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Operations.ListOperations. class ListOperationsResponse 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 # Response to a request to list policies for a given enterprise. class ListPoliciesResponse include Google::Apis::Core::Hashable # If there are more results, a token to retrieve next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of policies. # Corresponds to the JSON property `policies` # @return [Array] attr_accessor :policies 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) @policies = args[:policies] if args.key?(:policies) end end # Managed property. class ManagedProperty include Google::Apis::Core::Hashable # The default value of the property. BUNDLE_ARRAY properties don't have a # default value. # Corresponds to the JSON property `defaultValue` # @return [Object] attr_accessor :default_value # A longer description of the property, providing more detail of what it affects. # Localized. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # For CHOICE or MULTISELECT properties, the list of possible entries. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # The unique key that the app uses to identify the property, e.g. "com.google. # android.gm.fieldname". # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # For BUNDLE_ARRAY properties, the list of nested properties. A BUNDLE_ARRAY # property is at most two levels deep. # Corresponds to the JSON property `nestedProperties` # @return [Array] attr_accessor :nested_properties # The name of the property. Localized. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The type of the property. # 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) @default_value = args[:default_value] if args.key?(:default_value) @description = args[:description] if args.key?(:description) @entries = args[:entries] if args.key?(:entries) @key = args[:key] if args.key?(:key) @nested_properties = args[:nested_properties] if args.key?(:nested_properties) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) end end # An entry of a managed property. class ManagedPropertyEntry include Google::Apis::Core::Hashable # The human-readable name of the value. Localized. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The machine-readable value of the entry, which should be used in the # configuration. Not localized. # 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 # An event related to memory and storage measurements. class MemoryEvent include Google::Apis::Core::Hashable # The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the # total capacity in bytes of the storage medium. # Corresponds to the JSON property `byteCount` # @return [Fixnum] attr_accessor :byte_count # The creation time of the event. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Event type. # Corresponds to the JSON property `eventType` # @return [String] attr_accessor :event_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @byte_count = args[:byte_count] if args.key?(:byte_count) @create_time = args[:create_time] if args.key?(:create_time) @event_type = args[:event_type] if args.key?(:event_type) end end # Information about device memory and storage. class MemoryInfo include Google::Apis::Core::Hashable # Total internal storage on device in bytes. # Corresponds to the JSON property `totalInternalStorage` # @return [Fixnum] attr_accessor :total_internal_storage # Total RAM on device in bytes. # Corresponds to the JSON property `totalRam` # @return [Fixnum] attr_accessor :total_ram def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @total_internal_storage = args[:total_internal_storage] if args.key?(:total_internal_storage) @total_ram = args[:total_ram] if args.key?(:total_ram) end end # Device network info. class NetworkInfo include Google::Apis::Core::Hashable # IMEI number of the GSM device. For example, A1000031212. # Corresponds to the JSON property `imei` # @return [String] attr_accessor :imei # MEID number of the CDMA device. For example, A00000292788E1. # Corresponds to the JSON property `meid` # @return [String] attr_accessor :meid # Alphabetic name of current registered operator. For example, Vodafone. # Corresponds to the JSON property `networkOperatorName` # @return [String] attr_accessor :network_operator_name # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11. # Corresponds to the JSON property `wifiMacAddress` # @return [String] attr_accessor :wifi_mac_address def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @imei = args[:imei] if args.key?(:imei) @meid = args[:meid] if args.key?(:meid) @network_operator_name = args[:network_operator_name] if args.key?(:network_operator_name) @wifi_mac_address = args[:wifi_mac_address] if args.key?(:wifi_mac_address) end end # Provides detail about non-compliance with a policy setting. class NonComplianceDetail include Google::Apis::Core::Hashable # If the policy setting could not be applied, the current value of the setting # on the device. # Corresponds to the JSON property `currentValue` # @return [Object] attr_accessor :current_value # For settings with nested fields, if a particular nested field is out of # compliance, this specifies the full path to the offending field. The path is # formatted in the same way the policy JSON field would be referenced in # JavaScript, that is: 1) For object-typed fields, the field name is followed by # a dot then by a subfield name. 2) For array-typed fields, the field name is # followed by the array index enclosed in brackets. For example, to indicate a # problem with the url field in the externalData field in the 3rd application, # the path would be applications[2].externalData.url # Corresponds to the JSON property `fieldPath` # @return [String] attr_accessor :field_path # If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or # APP_NOT_UPDATED, the detailed reason the app can't be installed or updated. # Corresponds to the JSON property `installationFailureReason` # @return [String] attr_accessor :installation_failure_reason # The reason the device is not in compliance with the setting. # Corresponds to the JSON property `nonComplianceReason` # @return [String] attr_accessor :non_compliance_reason # The package name indicating which app is out of compliance, if applicable. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name # The name of the policy setting. This is the JSON field name of a top-level # Policy field. # Corresponds to the JSON property `settingName` # @return [String] attr_accessor :setting_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_value = args[:current_value] if args.key?(:current_value) @field_path = args[:field_path] if args.key?(:field_path) @installation_failure_reason = args[:installation_failure_reason] if args.key?(:installation_failure_reason) @non_compliance_reason = args[:non_compliance_reason] if args.key?(:non_compliance_reason) @package_name = args[:package_name] if args.key?(:package_name) @setting_name = args[:setting_name] if args.key?(:setting_name) end end # A compliance rule condition which is satisfied if there exists any matching # NonComplianceDetail for the device. A NonComplianceDetail matches a # NonComplianceDetailCondition if all the fields which are set within the # NonComplianceDetailCondition match the corresponding NonComplianceDetail # fields. class NonComplianceDetailCondition include Google::Apis::Core::Hashable # The reason the device is not in compliance with the setting. If not set, then # this condition matches any reason. # Corresponds to the JSON property `nonComplianceReason` # @return [String] attr_accessor :non_compliance_reason # The package name of the app that's out of compliance. If not set, then this # condition matches any package name. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name # The name of the policy setting. This is the JSON field name of a top-level # Policy field. If not set, then this condition matches any setting name. # Corresponds to the JSON property `settingName` # @return [String] attr_accessor :setting_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @non_compliance_reason = args[:non_compliance_reason] if args.key?(:non_compliance_reason) @package_name = args[:package_name] if args.key?(:package_name) @setting_name = args[:setting_name] if args.key?(:setting_name) 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). The error model is designed to be: # Simple to use and understand for most users # Flexible enough to meet unexpected needsOverviewThe Status message contains # three pieces of data: error code, error message, and error details. The error # code should be an enum value of google.rpc.Code, but it may accept additional # error codes if needed. The error message should be a developer-facing English # message that helps developers understand and resolve the error. If a localized # user-facing error message is needed, put the localized message in the error # details or localize it in the client. The optional error details may contain # arbitrary information about the error. There is a predefined set of error # detail types in the package google.rpc that can be used for common error # conditions.Language mappingThe Status message is the logical representation of # the error model, but it is not necessarily the actual wire format. When the # Status message is exposed in different client libraries and different wire # protocols, it can be mapped differently. For example, it will likely be mapped # to some exceptions in Java, but more likely mapped to some error codes in C. # Other usesThe error model and the Status message can be used in a variety of # environments, either with or without APIs, to provide a consistent developer # experience across different environments.Example uses of this error model # include: # Partial errors. If a service needs to return partial errors to the client, it # may embed the Status in the normal response to indicate the partial errors. # Workflow errors. A typical workflow has multiple steps. Each step may have a # Status message for error reporting. # Batch operations. If a client uses batch request and batch response, the # Status message should be used directly inside batch response, one for each # error sub-response. # Asynchronous operations. If an API call embeds asynchronous operation results # in its response, the status of those operations should be represented directly # using the Status message. # Logging. If some API errors are stored in logs, the message Status could be # used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::AndroidmanagementV1::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 # have the format of operations/some/unique/name. # 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 list of package names. class PackageNameList include Google::Apis::Core::Hashable # A list of package names. # Corresponds to the JSON property `packageNames` # @return [Array] attr_accessor :package_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @package_names = args[:package_names] if args.key?(:package_names) end end # Requirements for the password used to unlock a device. class PasswordRequirements include Google::Apis::Core::Hashable # Number of incorrect device-unlock passwords that can be entered before a # device is wiped. A value of 0 means there is no restriction. # Corresponds to the JSON property `maximumFailedPasswordsForWipe` # @return [Fixnum] attr_accessor :maximum_failed_passwords_for_wipe # Password expiration timeout. # Corresponds to the JSON property `passwordExpirationTimeout` # @return [String] attr_accessor :password_expiration_timeout # The length of the password history. After setting this field, the user won't # be able to enter a new password that is the same as any password in the # history. A value of 0 means there is no restriction. # Corresponds to the JSON property `passwordHistoryLength` # @return [Fixnum] attr_accessor :password_history_length # The minimum allowed password length. A value of 0 means there is no # restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, # ALPHABETIC, ALPHANUMERIC, or COMPLEX. # Corresponds to the JSON property `passwordMinimumLength` # @return [Fixnum] attr_accessor :password_minimum_length # Minimum number of letters required in the password. Only enforced when # password_quality is COMPLEX. # Corresponds to the JSON property `passwordMinimumLetters` # @return [Fixnum] attr_accessor :password_minimum_letters # Minimum number of lower case letters required in the password. Only enforced # when password_quality is COMPLEX. # Corresponds to the JSON property `passwordMinimumLowerCase` # @return [Fixnum] attr_accessor :password_minimum_lower_case # Minimum number of non-letter characters (numerical digits or symbols) required # in the password. Only enforced when password_quality is COMPLEX. # Corresponds to the JSON property `passwordMinimumNonLetter` # @return [Fixnum] attr_accessor :password_minimum_non_letter # Minimum number of numerical digits required in the password. Only enforced # when password_quality is COMPLEX. # Corresponds to the JSON property `passwordMinimumNumeric` # @return [Fixnum] attr_accessor :password_minimum_numeric # Minimum number of symbols required in the password. Only enforced when # password_quality is COMPLEX. # Corresponds to the JSON property `passwordMinimumSymbols` # @return [Fixnum] attr_accessor :password_minimum_symbols # Minimum number of upper case letters required in the password. Only enforced # when password_quality is COMPLEX. # Corresponds to the JSON property `passwordMinimumUpperCase` # @return [Fixnum] attr_accessor :password_minimum_upper_case # The required password quality. # Corresponds to the JSON property `passwordQuality` # @return [String] attr_accessor :password_quality def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @maximum_failed_passwords_for_wipe = args[:maximum_failed_passwords_for_wipe] if args.key?(:maximum_failed_passwords_for_wipe) @password_expiration_timeout = args[:password_expiration_timeout] if args.key?(:password_expiration_timeout) @password_history_length = args[:password_history_length] if args.key?(:password_history_length) @password_minimum_length = args[:password_minimum_length] if args.key?(:password_minimum_length) @password_minimum_letters = args[:password_minimum_letters] if args.key?(:password_minimum_letters) @password_minimum_lower_case = args[:password_minimum_lower_case] if args.key?(:password_minimum_lower_case) @password_minimum_non_letter = args[:password_minimum_non_letter] if args.key?(:password_minimum_non_letter) @password_minimum_numeric = args[:password_minimum_numeric] if args.key?(:password_minimum_numeric) @password_minimum_symbols = args[:password_minimum_symbols] if args.key?(:password_minimum_symbols) @password_minimum_upper_case = args[:password_minimum_upper_case] if args.key?(:password_minimum_upper_case) @password_quality = args[:password_quality] if args.key?(:password_quality) end end # Configuration for an Android permission and its grant state. class PermissionGrant include Google::Apis::Core::Hashable # The android permission, e.g. android.permission.READ_CALENDAR. # Corresponds to the JSON property `permission` # @return [String] attr_accessor :permission # The policy for granting the permission. # Corresponds to the JSON property `policy` # @return [String] attr_accessor :policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permission = args[:permission] if args.key?(:permission) @policy = args[:policy] if args.key?(:policy) end end # A default activity for handling intents that match a particular intent filter. class PersistentPreferredActivity include Google::Apis::Core::Hashable # The intent actions to match in the filter. If any actions are included in the # filter, then an intent's action must be one of those values for it to match. # If no actions are included, the intent action is ignored. # Corresponds to the JSON property `actions` # @return [Array] attr_accessor :actions # The intent categories to match in the filter. An intent includes the # categories that it requires, all of which must be included in the filter in # order to match. In other words, adding a category to the filter has no impact # on matching unless that category is specified in the intent. # Corresponds to the JSON property `categories` # @return [Array] attr_accessor :categories # The activity that should be the default intent handler. This should be an # Android component name, e.g. com.android.enterprise.app/.MainActivity. # Alternatively, the value may be the package name of an app, which causes # Android Device Policy to choose an appropriate activity from the app to handle # the intent. # Corresponds to the JSON property `receiverActivity` # @return [String] attr_accessor :receiver_activity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @actions = args[:actions] if args.key?(:actions) @categories = args[:categories] if args.key?(:categories) @receiver_activity = args[:receiver_activity] if args.key?(:receiver_activity) end end # A policy resources represents a group settings that govern the behavior of a # managed device and the apps installed on it. class Policy include Google::Apis::Core::Hashable # Account types that can't be managed by the user. # Corresponds to the JSON property `accountTypesWithManagementDisabled` # @return [Array] attr_accessor :account_types_with_management_disabled # Whether adding new users and profiles is disabled. # Corresponds to the JSON property `addUserDisabled` # @return [Boolean] attr_accessor :add_user_disabled alias_method :add_user_disabled?, :add_user_disabled # Whether adjusting the master volume is disabled. # Corresponds to the JSON property `adjustVolumeDisabled` # @return [Boolean] attr_accessor :adjust_volume_disabled alias_method :adjust_volume_disabled?, :adjust_volume_disabled # Configuration for an always-on VPN connection. # Corresponds to the JSON property `alwaysOnVpnPackage` # @return [Google::Apis::AndroidmanagementV1::AlwaysOnVpnPackage] attr_accessor :always_on_vpn_package # The app tracks for Android Device Policy the device can access. The device # receives the latest version among all accessible tracks. If no tracks are # specified, then the device only uses the production track. # Corresponds to the JSON property `androidDevicePolicyTracks` # @return [Array] attr_accessor :android_device_policy_tracks # Policy applied to apps. # Corresponds to the JSON property `applications` # @return [Array] attr_accessor :applications # Whether auto time is required, which prevents the user from manually setting # the date and time. # Corresponds to the JSON property `autoTimeRequired` # @return [Boolean] attr_accessor :auto_time_required alias_method :auto_time_required?, :auto_time_required # Whether applications other than the ones configured in applications are # blocked from being installed. When set, applications that were installed under # a previous policy but no longer appear in the policy are automatically # uninstalled. # Corresponds to the JSON property `blockApplicationsEnabled` # @return [Boolean] attr_accessor :block_applications_enabled alias_method :block_applications_enabled?, :block_applications_enabled # Whether configuring bluetooth is disabled. # Corresponds to the JSON property `bluetoothConfigDisabled` # @return [Boolean] attr_accessor :bluetooth_config_disabled alias_method :bluetooth_config_disabled?, :bluetooth_config_disabled # Whether bluetooth contact sharing is disabled. # Corresponds to the JSON property `bluetoothContactSharingDisabled` # @return [Boolean] attr_accessor :bluetooth_contact_sharing_disabled alias_method :bluetooth_contact_sharing_disabled?, :bluetooth_contact_sharing_disabled # Whether bluetooth is disabled. Prefer this setting over # bluetooth_config_disabled because bluetooth_config_disabled can be bypassed by # the user. # Corresponds to the JSON property `bluetoothDisabled` # @return [Boolean] attr_accessor :bluetooth_disabled alias_method :bluetooth_disabled?, :bluetooth_disabled # Whether all cameras on the device are disabled. # Corresponds to the JSON property `cameraDisabled` # @return [Boolean] attr_accessor :camera_disabled alias_method :camera_disabled?, :camera_disabled # Whether configuring cell broadcast is disabled. # Corresponds to the JSON property `cellBroadcastsConfigDisabled` # @return [Boolean] attr_accessor :cell_broadcasts_config_disabled alias_method :cell_broadcasts_config_disabled?, :cell_broadcasts_config_disabled # Rules declaring which mitigating actions to take when a device is not # compliant with its policy. When the conditions for multiple rules are # satisfied, all of the mitigating actions for the rules are taken. There is a # maximum limit of 100 rules. # Corresponds to the JSON property `complianceRules` # @return [Array] attr_accessor :compliance_rules # Whether creating windows besides app windows is disabled. # Corresponds to the JSON property `createWindowsDisabled` # @return [Boolean] attr_accessor :create_windows_disabled alias_method :create_windows_disabled?, :create_windows_disabled # Whether configuring user credentials is disabled. # Corresponds to the JSON property `credentialsConfigDisabled` # @return [Boolean] attr_accessor :credentials_config_disabled alias_method :credentials_config_disabled?, :credentials_config_disabled # Whether roaming data services are disabled. # Corresponds to the JSON property `dataRoamingDisabled` # @return [Boolean] attr_accessor :data_roaming_disabled alias_method :data_roaming_disabled?, :data_roaming_disabled # Whether the user is allowed to enable debugging features. # Corresponds to the JSON property `debuggingFeaturesAllowed` # @return [Boolean] attr_accessor :debugging_features_allowed alias_method :debugging_features_allowed?, :debugging_features_allowed # The default permission policy for runtime permission requests. # Corresponds to the JSON property `defaultPermissionPolicy` # @return [String] attr_accessor :default_permission_policy # Whether app verification is force-enabled. # Corresponds to the JSON property `ensureVerifyAppsEnabled` # @return [Boolean] attr_accessor :ensure_verify_apps_enabled alias_method :ensure_verify_apps_enabled?, :ensure_verify_apps_enabled # Whether factory resetting from settings is disabled. # Corresponds to the JSON property `factoryResetDisabled` # @return [Boolean] attr_accessor :factory_reset_disabled alias_method :factory_reset_disabled?, :factory_reset_disabled # Email addresses of device administrators for factory reset protection. When # the device is factory reset, it will require one of these admins to log in # with the Google account email and password to unlock the device. If no admins # are specified, the device won't provide factory reset protection. # Corresponds to the JSON property `frpAdminEmails` # @return [Array] attr_accessor :frp_admin_emails # Whether the user is allowed to have fun. Controls whether the Easter egg game # in Settings is disabled. # Corresponds to the JSON property `funDisabled` # @return [Boolean] attr_accessor :fun_disabled alias_method :fun_disabled?, :fun_disabled # Whether user installation of apps is disabled. # Corresponds to the JSON property `installAppsDisabled` # @return [Boolean] attr_accessor :install_apps_disabled alias_method :install_apps_disabled?, :install_apps_disabled # Whether the user is allowed to enable the "Unknown Sources" setting, which # allows installation of apps from unknown sources. # Corresponds to the JSON property `installUnknownSourcesAllowed` # @return [Boolean] attr_accessor :install_unknown_sources_allowed alias_method :install_unknown_sources_allowed?, :install_unknown_sources_allowed # Whether the keyguard is disabled. # Corresponds to the JSON property `keyguardDisabled` # @return [Boolean] attr_accessor :keyguard_disabled alias_method :keyguard_disabled?, :keyguard_disabled # Disabled keyguard customizations, such as widgets. # Corresponds to the JSON property `keyguardDisabledFeatures` # @return [Array] attr_accessor :keyguard_disabled_features # Whether the kiosk custom launcher is enabled. This replaces the home screen # with a launcher that locks down the device to the apps installed via the # applications setting. The apps appear on a single page in alphabetical order. # It is recommended to also use status_bar_disabled to block access to device # settings. # Corresponds to the JSON property `kioskCustomLauncherEnabled` # @return [Boolean] attr_accessor :kiosk_custom_launcher_enabled alias_method :kiosk_custom_launcher_enabled?, :kiosk_custom_launcher_enabled # Provides a user-facing message with locale info. The maximum message length is # 4096 characters. # Corresponds to the JSON property `longSupportMessage` # @return [Google::Apis::AndroidmanagementV1::UserFacingMessage] attr_accessor :long_support_message # Maximum time in milliseconds for user activity until the device locks. A value # of 0 means there is no restriction. # Corresponds to the JSON property `maximumTimeToLock` # @return [Fixnum] attr_accessor :maximum_time_to_lock # Whether configuring mobile networks is disabled. # Corresponds to the JSON property `mobileNetworksConfigDisabled` # @return [Boolean] attr_accessor :mobile_networks_config_disabled alias_method :mobile_networks_config_disabled?, :mobile_networks_config_disabled # Whether adding or removing accounts is disabled. # Corresponds to the JSON property `modifyAccountsDisabled` # @return [Boolean] attr_accessor :modify_accounts_disabled alias_method :modify_accounts_disabled?, :modify_accounts_disabled # Whether the user mounting physical external media is disabled. # Corresponds to the JSON property `mountPhysicalMediaDisabled` # @return [Boolean] attr_accessor :mount_physical_media_disabled alias_method :mount_physical_media_disabled?, :mount_physical_media_disabled # The name of the policy in the form enterprises/`enterpriseId`/policies/` # policyId`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether the network escape hatch is enabled. If a network connection can't be # made at boot time, the escape hatch prompts the user to temporarily connect to # a network in order to refresh the device policy. After applying policy, the # temporary network will be forgotten and the device will continue booting. This # prevents being unable to connect to a network if there is no suitable network # in the last policy and the device boots into an app in lock task mode, or the # user is otherwise unable to reach device settings. # Corresponds to the JSON property `networkEscapeHatchEnabled` # @return [Boolean] attr_accessor :network_escape_hatch_enabled alias_method :network_escape_hatch_enabled?, :network_escape_hatch_enabled # Whether resetting network settings is disabled. # Corresponds to the JSON property `networkResetDisabled` # @return [Boolean] attr_accessor :network_reset_disabled alias_method :network_reset_disabled?, :network_reset_disabled # Network configuration for the device. See configure networks for more # information. # Corresponds to the JSON property `openNetworkConfiguration` # @return [Hash] attr_accessor :open_network_configuration # Whether using NFC to beam data from apps is disabled. # Corresponds to the JSON property `outgoingBeamDisabled` # @return [Boolean] attr_accessor :outgoing_beam_disabled alias_method :outgoing_beam_disabled?, :outgoing_beam_disabled # Whether outgoing calls are disabled. # Corresponds to the JSON property `outgoingCallsDisabled` # @return [Boolean] attr_accessor :outgoing_calls_disabled alias_method :outgoing_calls_disabled?, :outgoing_calls_disabled # Requirements for the password used to unlock a device. # Corresponds to the JSON property `passwordRequirements` # @return [Google::Apis::AndroidmanagementV1::PasswordRequirements] attr_accessor :password_requirements # A list of package names. # Corresponds to the JSON property `permittedInputMethods` # @return [Google::Apis::AndroidmanagementV1::PackageNameList] attr_accessor :permitted_input_methods # Default intent handler activities. # Corresponds to the JSON property `persistentPreferredActivities` # @return [Array] attr_accessor :persistent_preferred_activities # Configuration info for an HTTP proxy. For a direct proxy, set the host, port, # and excluded_hosts fields. For a PAC script proxy, set the pac_uri field. # Corresponds to the JSON property `recommendedGlobalProxy` # @return [Google::Apis::AndroidmanagementV1::ProxyInfo] attr_accessor :recommended_global_proxy # Whether removing other users is disabled. # Corresponds to the JSON property `removeUserDisabled` # @return [Boolean] attr_accessor :remove_user_disabled alias_method :remove_user_disabled?, :remove_user_disabled # Whether rebooting the device into safe boot is disabled. # Corresponds to the JSON property `safeBootDisabled` # @return [Boolean] attr_accessor :safe_boot_disabled alias_method :safe_boot_disabled?, :safe_boot_disabled # Whether screen capture is disabled. # Corresponds to the JSON property `screenCaptureDisabled` # @return [Boolean] attr_accessor :screen_capture_disabled alias_method :screen_capture_disabled?, :screen_capture_disabled # Whether changing the user icon is disabled. # Corresponds to the JSON property `setUserIconDisabled` # @return [Boolean] attr_accessor :set_user_icon_disabled alias_method :set_user_icon_disabled?, :set_user_icon_disabled # Whether changing the wallpaper is disabled. # Corresponds to the JSON property `setWallpaperDisabled` # @return [Boolean] attr_accessor :set_wallpaper_disabled alias_method :set_wallpaper_disabled?, :set_wallpaper_disabled # Provides a user-facing message with locale info. The maximum message length is # 4096 characters. # Corresponds to the JSON property `shortSupportMessage` # @return [Google::Apis::AndroidmanagementV1::UserFacingMessage] attr_accessor :short_support_message # Whether sending and receiving SMS messages is disabled. # Corresponds to the JSON property `smsDisabled` # @return [Boolean] attr_accessor :sms_disabled alias_method :sms_disabled?, :sms_disabled # Whether the status bar is disabled. This disables notifications, quick # settings, and other screen overlays that allow escape from full-screen mode. # Corresponds to the JSON property `statusBarDisabled` # @return [Boolean] attr_accessor :status_bar_disabled alias_method :status_bar_disabled?, :status_bar_disabled # Settings controlling the behavior of status reports. # Corresponds to the JSON property `statusReportingSettings` # @return [Google::Apis::AndroidmanagementV1::StatusReportingSettings] attr_accessor :status_reporting_settings # The battery plugged in modes for which the device stays on. When using this # setting, it is recommended to clear maximum_time_to_lock so that the device # doesn't lock itself while it stays on. # Corresponds to the JSON property `stayOnPluggedModes` # @return [Array] attr_accessor :stay_on_plugged_modes # Configuration for managing system updates # Corresponds to the JSON property `systemUpdate` # @return [Google::Apis::AndroidmanagementV1::SystemUpdate] attr_accessor :system_update # Whether configuring tethering and portable hotspots is disabled. # Corresponds to the JSON property `tetheringConfigDisabled` # @return [Boolean] attr_accessor :tethering_config_disabled alias_method :tethering_config_disabled?, :tethering_config_disabled # Whether user uninstallation of applications is disabled. # Corresponds to the JSON property `uninstallAppsDisabled` # @return [Boolean] attr_accessor :uninstall_apps_disabled alias_method :uninstall_apps_disabled?, :uninstall_apps_disabled # Whether the microphone is muted and adjusting microphone volume is disabled. # Corresponds to the JSON property `unmuteMicrophoneDisabled` # @return [Boolean] attr_accessor :unmute_microphone_disabled alias_method :unmute_microphone_disabled?, :unmute_microphone_disabled # Whether transferring files over USB is disabled. # Corresponds to the JSON property `usbFileTransferDisabled` # @return [Boolean] attr_accessor :usb_file_transfer_disabled alias_method :usb_file_transfer_disabled?, :usb_file_transfer_disabled # The version of the policy. This is a read-only field. The version is # incremented each time the policy is updated. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version # Whether configuring VPN is disabled. # Corresponds to the JSON property `vpnConfigDisabled` # @return [Boolean] attr_accessor :vpn_config_disabled alias_method :vpn_config_disabled?, :vpn_config_disabled # Whether configuring Wi-Fi access points is disabled. # Corresponds to the JSON property `wifiConfigDisabled` # @return [Boolean] attr_accessor :wifi_config_disabled alias_method :wifi_config_disabled?, :wifi_config_disabled # Whether Wi-Fi networks defined in Open Network Configuration are locked so # they can't be edited by the user. # Corresponds to the JSON property `wifiConfigsLockdownEnabled` # @return [Boolean] attr_accessor :wifi_configs_lockdown_enabled alias_method :wifi_configs_lockdown_enabled?, :wifi_configs_lockdown_enabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_types_with_management_disabled = args[:account_types_with_management_disabled] if args.key?(:account_types_with_management_disabled) @add_user_disabled = args[:add_user_disabled] if args.key?(:add_user_disabled) @adjust_volume_disabled = args[:adjust_volume_disabled] if args.key?(:adjust_volume_disabled) @always_on_vpn_package = args[:always_on_vpn_package] if args.key?(:always_on_vpn_package) @android_device_policy_tracks = args[:android_device_policy_tracks] if args.key?(:android_device_policy_tracks) @applications = args[:applications] if args.key?(:applications) @auto_time_required = args[:auto_time_required] if args.key?(:auto_time_required) @block_applications_enabled = args[:block_applications_enabled] if args.key?(:block_applications_enabled) @bluetooth_config_disabled = args[:bluetooth_config_disabled] if args.key?(:bluetooth_config_disabled) @bluetooth_contact_sharing_disabled = args[:bluetooth_contact_sharing_disabled] if args.key?(:bluetooth_contact_sharing_disabled) @bluetooth_disabled = args[:bluetooth_disabled] if args.key?(:bluetooth_disabled) @camera_disabled = args[:camera_disabled] if args.key?(:camera_disabled) @cell_broadcasts_config_disabled = args[:cell_broadcasts_config_disabled] if args.key?(:cell_broadcasts_config_disabled) @compliance_rules = args[:compliance_rules] if args.key?(:compliance_rules) @create_windows_disabled = args[:create_windows_disabled] if args.key?(:create_windows_disabled) @credentials_config_disabled = args[:credentials_config_disabled] if args.key?(:credentials_config_disabled) @data_roaming_disabled = args[:data_roaming_disabled] if args.key?(:data_roaming_disabled) @debugging_features_allowed = args[:debugging_features_allowed] if args.key?(:debugging_features_allowed) @default_permission_policy = args[:default_permission_policy] if args.key?(:default_permission_policy) @ensure_verify_apps_enabled = args[:ensure_verify_apps_enabled] if args.key?(:ensure_verify_apps_enabled) @factory_reset_disabled = args[:factory_reset_disabled] if args.key?(:factory_reset_disabled) @frp_admin_emails = args[:frp_admin_emails] if args.key?(:frp_admin_emails) @fun_disabled = args[:fun_disabled] if args.key?(:fun_disabled) @install_apps_disabled = args[:install_apps_disabled] if args.key?(:install_apps_disabled) @install_unknown_sources_allowed = args[:install_unknown_sources_allowed] if args.key?(:install_unknown_sources_allowed) @keyguard_disabled = args[:keyguard_disabled] if args.key?(:keyguard_disabled) @keyguard_disabled_features = args[:keyguard_disabled_features] if args.key?(:keyguard_disabled_features) @kiosk_custom_launcher_enabled = args[:kiosk_custom_launcher_enabled] if args.key?(:kiosk_custom_launcher_enabled) @long_support_message = args[:long_support_message] if args.key?(:long_support_message) @maximum_time_to_lock = args[:maximum_time_to_lock] if args.key?(:maximum_time_to_lock) @mobile_networks_config_disabled = args[:mobile_networks_config_disabled] if args.key?(:mobile_networks_config_disabled) @modify_accounts_disabled = args[:modify_accounts_disabled] if args.key?(:modify_accounts_disabled) @mount_physical_media_disabled = args[:mount_physical_media_disabled] if args.key?(:mount_physical_media_disabled) @name = args[:name] if args.key?(:name) @network_escape_hatch_enabled = args[:network_escape_hatch_enabled] if args.key?(:network_escape_hatch_enabled) @network_reset_disabled = args[:network_reset_disabled] if args.key?(:network_reset_disabled) @open_network_configuration = args[:open_network_configuration] if args.key?(:open_network_configuration) @outgoing_beam_disabled = args[:outgoing_beam_disabled] if args.key?(:outgoing_beam_disabled) @outgoing_calls_disabled = args[:outgoing_calls_disabled] if args.key?(:outgoing_calls_disabled) @password_requirements = args[:password_requirements] if args.key?(:password_requirements) @permitted_input_methods = args[:permitted_input_methods] if args.key?(:permitted_input_methods) @persistent_preferred_activities = args[:persistent_preferred_activities] if args.key?(:persistent_preferred_activities) @recommended_global_proxy = args[:recommended_global_proxy] if args.key?(:recommended_global_proxy) @remove_user_disabled = args[:remove_user_disabled] if args.key?(:remove_user_disabled) @safe_boot_disabled = args[:safe_boot_disabled] if args.key?(:safe_boot_disabled) @screen_capture_disabled = args[:screen_capture_disabled] if args.key?(:screen_capture_disabled) @set_user_icon_disabled = args[:set_user_icon_disabled] if args.key?(:set_user_icon_disabled) @set_wallpaper_disabled = args[:set_wallpaper_disabled] if args.key?(:set_wallpaper_disabled) @short_support_message = args[:short_support_message] if args.key?(:short_support_message) @sms_disabled = args[:sms_disabled] if args.key?(:sms_disabled) @status_bar_disabled = args[:status_bar_disabled] if args.key?(:status_bar_disabled) @status_reporting_settings = args[:status_reporting_settings] if args.key?(:status_reporting_settings) @stay_on_plugged_modes = args[:stay_on_plugged_modes] if args.key?(:stay_on_plugged_modes) @system_update = args[:system_update] if args.key?(:system_update) @tethering_config_disabled = args[:tethering_config_disabled] if args.key?(:tethering_config_disabled) @uninstall_apps_disabled = args[:uninstall_apps_disabled] if args.key?(:uninstall_apps_disabled) @unmute_microphone_disabled = args[:unmute_microphone_disabled] if args.key?(:unmute_microphone_disabled) @usb_file_transfer_disabled = args[:usb_file_transfer_disabled] if args.key?(:usb_file_transfer_disabled) @version = args[:version] if args.key?(:version) @vpn_config_disabled = args[:vpn_config_disabled] if args.key?(:vpn_config_disabled) @wifi_config_disabled = args[:wifi_config_disabled] if args.key?(:wifi_config_disabled) @wifi_configs_lockdown_enabled = args[:wifi_configs_lockdown_enabled] if args.key?(:wifi_configs_lockdown_enabled) end end # A power management event. class PowerManagementEvent include Google::Apis::Core::Hashable # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage. # Corresponds to the JSON property `batteryLevel` # @return [Float] attr_accessor :battery_level # The creation time of the event. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Event type. # Corresponds to the JSON property `eventType` # @return [String] attr_accessor :event_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @battery_level = args[:battery_level] if args.key?(:battery_level) @create_time = args[:create_time] if args.key?(:create_time) @event_type = args[:event_type] if args.key?(:event_type) end end # Configuration info for an HTTP proxy. For a direct proxy, set the host, port, # and excluded_hosts fields. For a PAC script proxy, set the pac_uri field. class ProxyInfo include Google::Apis::Core::Hashable # For a direct proxy, the hosts for which the proxy is bypassed. The host names # may contain wildcards such as *.example.com. # Corresponds to the JSON property `excludedHosts` # @return [Array] attr_accessor :excluded_hosts # The host of the direct proxy. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # The URI of the PAC script used to configure the proxy. # Corresponds to the JSON property `pacUri` # @return [String] attr_accessor :pac_uri # The port of the direct proxy. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @excluded_hosts = args[:excluded_hosts] if args.key?(:excluded_hosts) @host = args[:host] if args.key?(:host) @pac_uri = args[:pac_uri] if args.key?(:pac_uri) @port = args[:port] if args.key?(:port) end end # An enterprise signup URL. class SignupUrl include Google::Apis::Core::Hashable # The name of the resource. Use this value in the signupUrl field when calling # enterprises.create to complete the enterprise signup flow. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A URL where an enterprise admin can register their enterprise. The page can't # be rendered in an iframe. # 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 # Information about device software. class SoftwareInfo include Google::Apis::Core::Hashable # Android build ID string meant for displaying to the user. For example, shamu- # userdebug 6.0.1 MOB30I 2756745 dev-keys. # Corresponds to the JSON property `androidBuildNumber` # @return [String] attr_accessor :android_build_number # Build time. # Corresponds to the JSON property `androidBuildTime` # @return [String] attr_accessor :android_build_time # The Android Device Policy app version code. # Corresponds to the JSON property `androidDevicePolicyVersionCode` # @return [Fixnum] attr_accessor :android_device_policy_version_code # The Android Device Policy app version as displayed to the user. # Corresponds to the JSON property `androidDevicePolicyVersionName` # @return [String] attr_accessor :android_device_policy_version_name # The user-visible Android version string. For example, 6.0.1. # Corresponds to the JSON property `androidVersion` # @return [String] attr_accessor :android_version # The system bootloader version number, e.g. 0.6.7. # Corresponds to the JSON property `bootloaderVersion` # @return [String] attr_accessor :bootloader_version # SHA-256 hash of android.content.pm.Signature (https://developer.android.com/ # reference/android/content/pm/Signature.html) associated with the system # package, which can be used to verify that the system build hasn't been # modified. # Corresponds to the JSON property `deviceBuildSignature` # @return [String] attr_accessor :device_build_signature # Kernel version, for example, 2.6.32.9-g103d848. # Corresponds to the JSON property `deviceKernelVersion` # @return [String] attr_accessor :device_kernel_version # Security patch level, e.g. 2016-05-01. # Corresponds to the JSON property `securityPatchLevel` # @return [String] attr_accessor :security_patch_level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @android_build_number = args[:android_build_number] if args.key?(:android_build_number) @android_build_time = args[:android_build_time] if args.key?(:android_build_time) @android_device_policy_version_code = args[:android_device_policy_version_code] if args.key?(:android_device_policy_version_code) @android_device_policy_version_name = args[:android_device_policy_version_name] if args.key?(:android_device_policy_version_name) @android_version = args[:android_version] if args.key?(:android_version) @bootloader_version = args[:bootloader_version] if args.key?(:bootloader_version) @device_build_signature = args[:device_build_signature] if args.key?(:device_build_signature) @device_kernel_version = args[:device_kernel_version] if args.key?(:device_kernel_version) @security_patch_level = args[:security_patch_level] if args.key?(:security_patch_level) 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). The error model is designed to be: # Simple to use and understand for most users # Flexible enough to meet unexpected needsOverviewThe Status message contains # three pieces of data: error code, error message, and error details. The error # code should be an enum value of google.rpc.Code, but it may accept additional # error codes if needed. The error message should be a developer-facing English # message that helps developers understand and resolve the error. If a localized # user-facing error message is needed, put the localized message in the error # details or localize it in the client. The optional error details may contain # arbitrary information about the error. There is a predefined set of error # detail types in the package google.rpc that can be used for common error # conditions.Language mappingThe Status message is the logical representation of # the error model, but it is not necessarily the actual wire format. When the # Status message is exposed in different client libraries and different wire # protocols, it can be mapped differently. For example, it will likely be mapped # to some exceptions in Java, but more likely mapped to some error codes in C. # Other usesThe error model and the Status message can be used in a variety of # environments, either with or without APIs, to provide a consistent developer # experience across different environments.Example uses of this error model # include: # Partial errors. If a service needs to return partial errors to the client, it # may embed the Status in the normal response to indicate the partial errors. # Workflow errors. A typical workflow has multiple steps. Each step may have a # Status message for error reporting. # Batch operations. If a client uses batch request and batch response, the # Status message should be used directly inside batch response, one for each # error sub-response. # Asynchronous operations. If an API call embeds asynchronous operation results # in its response, the status of those operations should be represented directly # using the Status message. # Logging. If some API errors are stored in logs, the message Status could be # used directly after any stripping needed for security/privacy reasons. class Status 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 # Settings controlling the behavior of status reports. class StatusReportingSettings include Google::Apis::Core::Hashable # Whether device settings reporting is enabled. # Corresponds to the JSON property `deviceSettingsEnabled` # @return [Boolean] attr_accessor :device_settings_enabled alias_method :device_settings_enabled?, :device_settings_enabled # Whether displays reporting is enabled. # Corresponds to the JSON property `displayInfoEnabled` # @return [Boolean] attr_accessor :display_info_enabled alias_method :display_info_enabled?, :display_info_enabled # Whether hardware status reporting is enabled. # Corresponds to the JSON property `hardwareStatusEnabled` # @return [Boolean] attr_accessor :hardware_status_enabled alias_method :hardware_status_enabled?, :hardware_status_enabled # Whether memory info reporting is enabled. # Corresponds to the JSON property `memoryInfoEnabled` # @return [Boolean] attr_accessor :memory_info_enabled alias_method :memory_info_enabled?, :memory_info_enabled # Whether network info reporting is enabled. # Corresponds to the JSON property `networkInfoEnabled` # @return [Boolean] attr_accessor :network_info_enabled alias_method :network_info_enabled?, :network_info_enabled # Whether power management event reporting is enabled. # Corresponds to the JSON property `powerManagementEventsEnabled` # @return [Boolean] attr_accessor :power_management_events_enabled alias_method :power_management_events_enabled?, :power_management_events_enabled # Whether software info reporting is enabled. # Corresponds to the JSON property `softwareInfoEnabled` # @return [Boolean] attr_accessor :software_info_enabled alias_method :software_info_enabled?, :software_info_enabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @device_settings_enabled = args[:device_settings_enabled] if args.key?(:device_settings_enabled) @display_info_enabled = args[:display_info_enabled] if args.key?(:display_info_enabled) @hardware_status_enabled = args[:hardware_status_enabled] if args.key?(:hardware_status_enabled) @memory_info_enabled = args[:memory_info_enabled] if args.key?(:memory_info_enabled) @network_info_enabled = args[:network_info_enabled] if args.key?(:network_info_enabled) @power_management_events_enabled = args[:power_management_events_enabled] if args.key?(:power_management_events_enabled) @software_info_enabled = args[:software_info_enabled] if args.key?(:software_info_enabled) end end # Configuration for managing system updates class SystemUpdate include Google::Apis::Core::Hashable # If the type is WINDOWED, the end of the maintenance window, measured as the # number of minutes after midnight in device's local time. This value must be # between 0 and 1439, inclusive. If this value is less than start_minutes, then # the maintenance window spans midnight. If the maintenance window specified is # smaller than 30 minutes, the actual window is extended to 30 minutes beyond # the start time. # Corresponds to the JSON property `endMinutes` # @return [Fixnum] attr_accessor :end_minutes # If the type is WINDOWED, the start of the maintenance window, measured as the # number of minutes after midnight in the device's local time. This value must # be between 0 and 1439, inclusive. # Corresponds to the JSON property `startMinutes` # @return [Fixnum] attr_accessor :start_minutes # The type of system update to configure. # 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) @end_minutes = args[:end_minutes] if args.key?(:end_minutes) @start_minutes = args[:start_minutes] if args.key?(:start_minutes) @type = args[:type] if args.key?(:type) end end # Provides a user-facing message with locale info. The maximum message length is # 4096 characters. class UserFacingMessage include Google::Apis::Core::Hashable # The default message displayed if no localized message is specified or the user' # s locale doesn't match with any of the localized messages. A default message # must be provided if any localized messages are provided. # Corresponds to the JSON property `defaultMessage` # @return [String] attr_accessor :default_message # A map containing pairs, where locale is a well-formed BCP 47 # language (https://www.w3.org/International/articles/language-tags/) code, such # as en-US, es-ES, or fr. # Corresponds to the JSON property `localizedMessages` # @return [Hash] attr_accessor :localized_messages def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_message = args[:default_message] if args.key?(:default_message) @localized_messages = args[:localized_messages] if args.key?(:localized_messages) end end # A web token used to access the managed Google Play iframe. class WebToken include Google::Apis::Core::Hashable # The name of the web token, which is generated by the server during creation in # the form enterprises/`enterpriseId`/webTokens/`webTokenId`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The URL of the parent frame hosting the iframe with the embedded UI. To # prevent XSS, the iframe may not be hosted at other URLs. The URL must use the # https scheme. # Corresponds to the JSON property `parentFrameUrl` # @return [String] attr_accessor :parent_frame_url # Permissions available to an admin in the embedded UI. An admin must have all # of these permissions in order to view the UI. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions # The token value which is used in the hosting page to generate the iframe with # the embedded UI. This is a read-only field generated by the server. # 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) @parent_frame_url = args[:parent_frame_url] if args.key?(:parent_frame_url) @permissions = args[:permissions] if args.key?(:permissions) @value = args[:value] if args.key?(:value) end end end end end google-api-client-0.19.8/generated/google/apis/androidmanagement_v1/service.rb0000644000004100000410000013577013252673043027400 0ustar www-datawww-data# 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 AndroidmanagementV1 # Android Management API # # The Android Management API provides remote enterprise management of Android # devices and apps. # # @example # require 'google/apis/androidmanagement_v1' # # Androidmanagement = Google::Apis::AndroidmanagementV1 # Alias the module # service = Androidmanagement::AndroidManagementService.new # # @see https://developers.google.com/android/management class AndroidManagementService < 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://androidmanagement.googleapis.com/', '') @batch_path = 'batch' end # Creates an enterprise. This is the last step in the enterprise signup flow. # @param [Google::Apis::AndroidmanagementV1::Enterprise] enterprise_object # @param [String] enterprise_token # The enterprise token appended to the callback URL. # @param [String] project_id # The ID of the Google Cloud Platform project which will own the enterprise. # @param [String] signup_url_name # The name of the SignupUrl used to sign up for the enterprise. # @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::AndroidmanagementV1::Enterprise] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::Enterprise] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise(enterprise_object = nil, enterprise_token: nil, project_id: nil, signup_url_name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/enterprises', options) command.request_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation command.request_object = enterprise_object command.response_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation command.response_class = Google::Apis::AndroidmanagementV1::Enterprise command.query['enterpriseToken'] = enterprise_token unless enterprise_token.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['signupUrlName'] = signup_url_name unless signup_url_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 enterprise. # @param [String] name # The name of the enterprise in the form enterprises/`enterpriseId`. # @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::AndroidmanagementV1::Enterprise] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::Enterprise] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation command.response_class = Google::Apis::AndroidmanagementV1::Enterprise 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 enterprise. # @param [String] name # The name of the enterprise in the form enterprises/`enterpriseId`. # @param [Google::Apis::AndroidmanagementV1::Enterprise] enterprise_object # @param [String] update_mask # The field mask indicating the fields to update. If not set, all modifiable # fields will be modified. # @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::AndroidmanagementV1::Enterprise] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::Enterprise] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise(name, enterprise_object = 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::AndroidmanagementV1::Enterprise::Representation command.request_object = enterprise_object command.response_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation command.response_class = Google::Apis::AndroidmanagementV1::Enterprise 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 info about an application. # @param [String] name # The name of the application in the form enterprises/`enterpriseId`/ # applications/`package_name`. # @param [String] language_code # The preferred language for localized application info, as a BCP47 tag (e.g. " # en-US", "de"). If not specified the default language of the application will # be used. # @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::AndroidmanagementV1::Application] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::Application] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_application(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Application::Representation command.response_class = Google::Apis::AndroidmanagementV1::Application command.params['name'] = name unless name.nil? command.query['languageCode'] = language_code unless language_code.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 device. This operation wipes the device. # @param [String] name # The name of the device in the form enterprises/`enterpriseId`/devices/` # deviceId`. # @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::AndroidmanagementV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::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_enterprise_device(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::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 device. # @param [String] name # The name of the device in the form enterprises/`enterpriseId`/devices/` # deviceId`. # @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::AndroidmanagementV1::Device] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::Device] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_device(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Device::Representation command.response_class = Google::Apis::AndroidmanagementV1::Device 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 # Issues a command to a device. The Operation resource returned contains a # Command in its metadata field. Use the get operation method to get the status # of the command. # @param [String] name # The name of the device in the form enterprises/`enterpriseId`/devices/` # deviceId`. # @param [Google::Apis::AndroidmanagementV1::Command] command_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::AndroidmanagementV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::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 issue_enterprise_device_command(name, command_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:issueCommand', options) command.request_representation = Google::Apis::AndroidmanagementV1::Command::Representation command.request_object = command_object command.response_representation = Google::Apis::AndroidmanagementV1::Operation::Representation command.response_class = Google::Apis::AndroidmanagementV1::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 # Lists devices for a given enterprise. # @param [String] parent # The name of the enterprise in the form enterprises/`enterpriseId`. # @param [Fixnum] page_size # The requested page size. The actual page size may be fixed to a min or max # value. # @param [String] page_token # A token identifying a page of results returned by the server. # @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::AndroidmanagementV1::ListDevicesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::ListDevicesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_devices(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/devices', options) command.response_representation = Google::Apis::AndroidmanagementV1::ListDevicesResponse::Representation command.response_class = Google::Apis::AndroidmanagementV1::ListDevicesResponse 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 # Updates a device. # @param [String] name # The name of the device in the form enterprises/`enterpriseId`/devices/` # deviceId`. # @param [Google::Apis::AndroidmanagementV1::Device] device_object # @param [String] update_mask # The field mask indicating the fields to update. If not set, all modifiable # fields will be modified. # @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::AndroidmanagementV1::Device] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::Device] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_device(name, device_object = 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::AndroidmanagementV1::Device::Representation command.request_object = device_object command.response_representation = Google::Apis::AndroidmanagementV1::Device::Representation command.response_class = Google::Apis::AndroidmanagementV1::Device 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 # Starts asynchronous cancellation on a long-running operation. The server makes # a best effort to cancel the operation, but success is not guaranteed. If the # server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. # Clients can use Operations.GetOperation or other methods to check whether the # cancellation succeeded or whether the operation completed despite cancellation. # On successful cancellation, the operation is not deleted; instead, it becomes # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to Code.CANCELLED. # @param [String] name # The name of the operation resource to be cancelled. # @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::AndroidmanagementV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::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 cancel_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::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 # Deletes a long-running operation. This method indicates that the client is no # longer interested in the operation result. It does not cancel the operation. # If the server doesn't support this method, it returns google.rpc.Code. # UNIMPLEMENTED. # @param [String] name # The name of the operation resource 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::AndroidmanagementV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::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_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::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 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::AndroidmanagementV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::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_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Operation::Representation command.response_class = Google::Apis::AndroidmanagementV1::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 # 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::AndroidmanagementV1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_device_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}', options) command.response_representation = Google::Apis::AndroidmanagementV1::ListOperationsResponse::Representation command.response_class = Google::Apis::AndroidmanagementV1::ListOperationsResponse 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 an enrollment token for a given enterprise. # @param [String] parent # The name of the enterprise in the form enterprises/`enterpriseId`. # @param [Google::Apis::AndroidmanagementV1::EnrollmentToken] enrollment_token_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::AndroidmanagementV1::EnrollmentToken] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::EnrollmentToken] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_enrollment_token(parent, enrollment_token_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/enrollmentTokens', options) command.request_representation = Google::Apis::AndroidmanagementV1::EnrollmentToken::Representation command.request_object = enrollment_token_object command.response_representation = Google::Apis::AndroidmanagementV1::EnrollmentToken::Representation command.response_class = Google::Apis::AndroidmanagementV1::EnrollmentToken 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 enrollment token. This operation invalidates the token, preventing # its future use. # @param [String] name # The name of the enrollment token in the form enterprises/`enterpriseId`/ # enrollmentTokens/`enrollmentTokenId`. # @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::AndroidmanagementV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::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_enterprise_enrollment_token(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::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 # Deletes a policy. This operation is only permitted if no devices are currently # referencing the policy. # @param [String] name # The name of the policy in the form enterprises/`enterpriseId`/policies/` # policyId`. # @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::AndroidmanagementV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::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_enterprise_policy(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::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 policy. # @param [String] name # The name of the policy in the form enterprises/`enterpriseId`/policies/` # policyId`. # @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::AndroidmanagementV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::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_enterprise_policy(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Policy::Representation command.response_class = Google::Apis::AndroidmanagementV1::Policy 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 policies for a given enterprise. # @param [String] parent # The name of the enterprise in the form enterprises/`enterpriseId`. # @param [Fixnum] page_size # The requested page size. The actual page size may be fixed to a min or max # value. # @param [String] page_token # A token identifying a page of results returned by the server. # @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::AndroidmanagementV1::ListPoliciesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::ListPoliciesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/policies', options) command.response_representation = Google::Apis::AndroidmanagementV1::ListPoliciesResponse::Representation command.response_class = Google::Apis::AndroidmanagementV1::ListPoliciesResponse 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 # Updates or creates a policy. # @param [String] name # The name of the policy in the form enterprises/`enterpriseId`/policies/` # policyId`. # @param [Google::Apis::AndroidmanagementV1::Policy] policy_object # @param [String] update_mask # The field mask indicating the fields to update. If not set, all modifiable # fields will be modified. # @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::AndroidmanagementV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::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 patch_enterprise_policy(name, policy_object = 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::AndroidmanagementV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::AndroidmanagementV1::Policy::Representation command.response_class = Google::Apis::AndroidmanagementV1::Policy 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 # Creates a web token to access an embeddable managed Google Play web UI for a # given enterprise. # @param [String] parent # The name of the enterprise in the form enterprises/`enterpriseId`. # @param [Google::Apis::AndroidmanagementV1::WebToken] web_token_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::AndroidmanagementV1::WebToken] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::WebToken] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_enterprise_web_token(parent, web_token_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/webTokens', options) command.request_representation = Google::Apis::AndroidmanagementV1::WebToken::Representation command.request_object = web_token_object command.response_representation = Google::Apis::AndroidmanagementV1::WebToken::Representation command.response_class = Google::Apis::AndroidmanagementV1::WebToken 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 an enterprise signup URL. # @param [String] callback_url # The callback URL that the admin will be redirected to after successfully # creating an enterprise. Before redirecting there the system will add a query # parameter to this URL named enterpriseToken which will contain an opaque token # to be used for the create enterprise request. The URL will be parsed then # reformatted in order to add the enterpriseToken parameter, so there may be # some minor formatting changes. # @param [String] project_id # The ID of the Google Cloud Platform project which will own the enterprise. # @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::AndroidmanagementV1::SignupUrl] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AndroidmanagementV1::SignupUrl] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_signup_url(callback_url: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/signupUrls', options) command.response_representation = Google::Apis::AndroidmanagementV1::SignupUrl::Representation command.response_class = Google::Apis::AndroidmanagementV1::SignupUrl command.query['callbackUrl'] = callback_url unless callback_url.nil? command.query['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 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 google-api-client-0.19.8/generated/google/apis/language_v1beta2/0000755000004100000410000000000013252673044024423 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/language_v1beta2/representations.rb0000644000004100000410000003664213252673044030210 0ustar www-datawww-data# 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 LanguageV1beta2 class AnalyzeEntitiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeEntitiesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeEntitySentimentRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeEntitySentimentResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeSentimentRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeSentimentResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeSyntaxRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeSyntaxResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnnotateTextRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnnotateTextResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClassificationCategory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClassifyTextRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClassifyTextResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DependencyEdge class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Document class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Entity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EntityMention class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Features class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PartOfSpeech class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Sentence class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Sentiment 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 TextSpan class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Token class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeEntitiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :document, as: 'document', class: Google::Apis::LanguageV1beta2::Document, decorator: Google::Apis::LanguageV1beta2::Document::Representation property :encoding_type, as: 'encodingType' end end class AnalyzeEntitiesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entities, as: 'entities', class: Google::Apis::LanguageV1beta2::Entity, decorator: Google::Apis::LanguageV1beta2::Entity::Representation property :language, as: 'language' end end class AnalyzeEntitySentimentRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :document, as: 'document', class: Google::Apis::LanguageV1beta2::Document, decorator: Google::Apis::LanguageV1beta2::Document::Representation property :encoding_type, as: 'encodingType' end end class AnalyzeEntitySentimentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entities, as: 'entities', class: Google::Apis::LanguageV1beta2::Entity, decorator: Google::Apis::LanguageV1beta2::Entity::Representation property :language, as: 'language' end end class AnalyzeSentimentRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :document, as: 'document', class: Google::Apis::LanguageV1beta2::Document, decorator: Google::Apis::LanguageV1beta2::Document::Representation property :encoding_type, as: 'encodingType' end end class AnalyzeSentimentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :document_sentiment, as: 'documentSentiment', class: Google::Apis::LanguageV1beta2::Sentiment, decorator: Google::Apis::LanguageV1beta2::Sentiment::Representation property :language, as: 'language' collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta2::Sentence, decorator: Google::Apis::LanguageV1beta2::Sentence::Representation end end class AnalyzeSyntaxRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :document, as: 'document', class: Google::Apis::LanguageV1beta2::Document, decorator: Google::Apis::LanguageV1beta2::Document::Representation property :encoding_type, as: 'encodingType' end end class AnalyzeSyntaxResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :language, as: 'language' collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta2::Sentence, decorator: Google::Apis::LanguageV1beta2::Sentence::Representation collection :tokens, as: 'tokens', class: Google::Apis::LanguageV1beta2::Token, decorator: Google::Apis::LanguageV1beta2::Token::Representation end end class AnnotateTextRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :document, as: 'document', class: Google::Apis::LanguageV1beta2::Document, decorator: Google::Apis::LanguageV1beta2::Document::Representation property :encoding_type, as: 'encodingType' property :features, as: 'features', class: Google::Apis::LanguageV1beta2::Features, decorator: Google::Apis::LanguageV1beta2::Features::Representation end end class AnnotateTextResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :categories, as: 'categories', class: Google::Apis::LanguageV1beta2::ClassificationCategory, decorator: Google::Apis::LanguageV1beta2::ClassificationCategory::Representation property :document_sentiment, as: 'documentSentiment', class: Google::Apis::LanguageV1beta2::Sentiment, decorator: Google::Apis::LanguageV1beta2::Sentiment::Representation collection :entities, as: 'entities', class: Google::Apis::LanguageV1beta2::Entity, decorator: Google::Apis::LanguageV1beta2::Entity::Representation property :language, as: 'language' collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta2::Sentence, decorator: Google::Apis::LanguageV1beta2::Sentence::Representation collection :tokens, as: 'tokens', class: Google::Apis::LanguageV1beta2::Token, decorator: Google::Apis::LanguageV1beta2::Token::Representation end end class ClassificationCategory # @private class Representation < Google::Apis::Core::JsonRepresentation property :confidence, as: 'confidence' property :name, as: 'name' end end class ClassifyTextRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :document, as: 'document', class: Google::Apis::LanguageV1beta2::Document, decorator: Google::Apis::LanguageV1beta2::Document::Representation end end class ClassifyTextResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :categories, as: 'categories', class: Google::Apis::LanguageV1beta2::ClassificationCategory, decorator: Google::Apis::LanguageV1beta2::ClassificationCategory::Representation end end class DependencyEdge # @private class Representation < Google::Apis::Core::JsonRepresentation property :head_token_index, as: 'headTokenIndex' property :label, as: 'label' end end class Document # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :gcs_content_uri, as: 'gcsContentUri' property :language, as: 'language' property :type, as: 'type' end end class Entity # @private class Representation < Google::Apis::Core::JsonRepresentation collection :mentions, as: 'mentions', class: Google::Apis::LanguageV1beta2::EntityMention, decorator: Google::Apis::LanguageV1beta2::EntityMention::Representation hash :metadata, as: 'metadata' property :name, as: 'name' property :salience, as: 'salience' property :sentiment, as: 'sentiment', class: Google::Apis::LanguageV1beta2::Sentiment, decorator: Google::Apis::LanguageV1beta2::Sentiment::Representation property :type, as: 'type' end end class EntityMention # @private class Representation < Google::Apis::Core::JsonRepresentation property :sentiment, as: 'sentiment', class: Google::Apis::LanguageV1beta2::Sentiment, decorator: Google::Apis::LanguageV1beta2::Sentiment::Representation property :text, as: 'text', class: Google::Apis::LanguageV1beta2::TextSpan, decorator: Google::Apis::LanguageV1beta2::TextSpan::Representation property :type, as: 'type' end end class Features # @private class Representation < Google::Apis::Core::JsonRepresentation property :classify_text, as: 'classifyText' property :extract_document_sentiment, as: 'extractDocumentSentiment' property :extract_entities, as: 'extractEntities' property :extract_entity_sentiment, as: 'extractEntitySentiment' property :extract_syntax, as: 'extractSyntax' end end class PartOfSpeech # @private class Representation < Google::Apis::Core::JsonRepresentation property :aspect, as: 'aspect' property :case, as: 'case' property :form, as: 'form' property :gender, as: 'gender' property :mood, as: 'mood' property :number, as: 'number' property :person, as: 'person' property :proper, as: 'proper' property :reciprocity, as: 'reciprocity' property :tag, as: 'tag' property :tense, as: 'tense' property :voice, as: 'voice' end end class Sentence # @private class Representation < Google::Apis::Core::JsonRepresentation property :sentiment, as: 'sentiment', class: Google::Apis::LanguageV1beta2::Sentiment, decorator: Google::Apis::LanguageV1beta2::Sentiment::Representation property :text, as: 'text', class: Google::Apis::LanguageV1beta2::TextSpan, decorator: Google::Apis::LanguageV1beta2::TextSpan::Representation end end class Sentiment # @private class Representation < Google::Apis::Core::JsonRepresentation property :magnitude, as: 'magnitude' property :score, as: 'score' 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 TextSpan # @private class Representation < Google::Apis::Core::JsonRepresentation property :begin_offset, as: 'beginOffset' property :content, as: 'content' end end class Token # @private class Representation < Google::Apis::Core::JsonRepresentation property :dependency_edge, as: 'dependencyEdge', class: Google::Apis::LanguageV1beta2::DependencyEdge, decorator: Google::Apis::LanguageV1beta2::DependencyEdge::Representation property :lemma, as: 'lemma' property :part_of_speech, as: 'partOfSpeech', class: Google::Apis::LanguageV1beta2::PartOfSpeech, decorator: Google::Apis::LanguageV1beta2::PartOfSpeech::Representation property :text, as: 'text', class: Google::Apis::LanguageV1beta2::TextSpan, decorator: Google::Apis::LanguageV1beta2::TextSpan::Representation end end end end end google-api-client-0.19.8/generated/google/apis/language_v1beta2/classes.rb0000644000004100000410000010457313252673044026417 0ustar www-datawww-data# 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 LanguageV1beta2 # The entity analysis request message. class AnalyzeEntitiesRequest include Google::Apis::Core::Hashable # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document # The encoding type used by the API to calculate offsets. # Corresponds to the JSON property `encodingType` # @return [String] attr_accessor :encoding_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) end end # The entity analysis response message. class AnalyzeEntitiesResponse include Google::Apis::Core::Hashable # The recognized entities in the input document. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # The language of the text, which will be the same as the language specified # in the request or, if not specified, the automatically-detected language. # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entities = args[:entities] if args.key?(:entities) @language = args[:language] if args.key?(:language) end end # The entity-level sentiment analysis request message. class AnalyzeEntitySentimentRequest include Google::Apis::Core::Hashable # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document # The encoding type used by the API to calculate offsets. # Corresponds to the JSON property `encodingType` # @return [String] attr_accessor :encoding_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) end end # The entity-level sentiment analysis response message. class AnalyzeEntitySentimentResponse include Google::Apis::Core::Hashable # The recognized entities in the input document with associated sentiments. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # The language of the text, which will be the same as the language specified # in the request or, if not specified, the automatically-detected language. # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entities = args[:entities] if args.key?(:entities) @language = args[:language] if args.key?(:language) end end # The sentiment analysis request message. class AnalyzeSentimentRequest include Google::Apis::Core::Hashable # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document # The encoding type used by the API to calculate sentence offsets for the # sentence sentiment. # Corresponds to the JSON property `encodingType` # @return [String] attr_accessor :encoding_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) end end # The sentiment analysis response message. class AnalyzeSentimentResponse include Google::Apis::Core::Hashable # Represents the feeling associated with the entire text or entities in # the text. # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1beta2::Sentiment] attr_accessor :document_sentiment # The language of the text, which will be the same as the language specified # in the request or, if not specified, the automatically-detected language. # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # The sentiment for all the sentences in the document. # Corresponds to the JSON property `sentences` # @return [Array] attr_accessor :sentences def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document_sentiment = args[:document_sentiment] if args.key?(:document_sentiment) @language = args[:language] if args.key?(:language) @sentences = args[:sentences] if args.key?(:sentences) end end # The syntax analysis request message. class AnalyzeSyntaxRequest include Google::Apis::Core::Hashable # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document # The encoding type used by the API to calculate offsets. # Corresponds to the JSON property `encodingType` # @return [String] attr_accessor :encoding_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) end end # The syntax analysis response message. class AnalyzeSyntaxResponse include Google::Apis::Core::Hashable # The language of the text, which will be the same as the language specified # in the request or, if not specified, the automatically-detected language. # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # Sentences in the input document. # Corresponds to the JSON property `sentences` # @return [Array] attr_accessor :sentences # Tokens, along with their syntactic information, in the input document. # Corresponds to the JSON property `tokens` # @return [Array] attr_accessor :tokens def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @language = args[:language] if args.key?(:language) @sentences = args[:sentences] if args.key?(:sentences) @tokens = args[:tokens] if args.key?(:tokens) end end # The request message for the text annotation API, which can perform multiple # analysis types (sentiment, entities, and syntax) in one call. class AnnotateTextRequest include Google::Apis::Core::Hashable # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document # The encoding type used by the API to calculate offsets. # Corresponds to the JSON property `encodingType` # @return [String] attr_accessor :encoding_type # All available features for sentiment, syntax, and semantic analysis. # Setting each one to true will enable that specific analysis for the input. # Corresponds to the JSON property `features` # @return [Google::Apis::LanguageV1beta2::Features] attr_accessor :features def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) @features = args[:features] if args.key?(:features) end end # The text annotations response message. class AnnotateTextResponse include Google::Apis::Core::Hashable # Categories identified in the input document. # Corresponds to the JSON property `categories` # @return [Array] attr_accessor :categories # Represents the feeling associated with the entire text or entities in # the text. # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1beta2::Sentiment] attr_accessor :document_sentiment # Entities, along with their semantic information, in the input document. # Populated if the user enables # AnnotateTextRequest.Features.extract_entities. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # The language of the text, which will be the same as the language specified # in the request or, if not specified, the automatically-detected language. # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # Sentences in the input document. Populated if the user enables # AnnotateTextRequest.Features.extract_syntax. # Corresponds to the JSON property `sentences` # @return [Array] attr_accessor :sentences # Tokens, along with their syntactic information, in the input document. # Populated if the user enables # AnnotateTextRequest.Features.extract_syntax. # Corresponds to the JSON property `tokens` # @return [Array] attr_accessor :tokens def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @categories = args[:categories] if args.key?(:categories) @document_sentiment = args[:document_sentiment] if args.key?(:document_sentiment) @entities = args[:entities] if args.key?(:entities) @language = args[:language] if args.key?(:language) @sentences = args[:sentences] if args.key?(:sentences) @tokens = args[:tokens] if args.key?(:tokens) end end # Represents a category returned from the text classifier. class ClassificationCategory include Google::Apis::Core::Hashable # The classifier's confidence of the category. Number represents how certain # the classifier is that this category represents the given text. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence # The name of the category representing the document. # 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) @confidence = args[:confidence] if args.key?(:confidence) @name = args[:name] if args.key?(:name) end end # The document classification request message. class ClassifyTextRequest include Google::Apis::Core::Hashable # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document = args[:document] if args.key?(:document) end end # The document classification response message. class ClassifyTextResponse include Google::Apis::Core::Hashable # Categories representing the input document. # Corresponds to the JSON property `categories` # @return [Array] attr_accessor :categories def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @categories = args[:categories] if args.key?(:categories) end end # Represents dependency parse tree information for a token. class DependencyEdge include Google::Apis::Core::Hashable # Represents the head of this token in the dependency tree. # This is the index of the token which has an arc going to this token. # The index is the position of the token in the array of tokens returned # by the API method. If this token is a root token, then the # `head_token_index` is its own index. # Corresponds to the JSON property `headTokenIndex` # @return [Fixnum] attr_accessor :head_token_index # The parse label for the token. # Corresponds to the JSON property `label` # @return [String] attr_accessor :label def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @head_token_index = args[:head_token_index] if args.key?(:head_token_index) @label = args[:label] if args.key?(:label) end end # ################################################################ # # Represents the input to API methods. class Document include Google::Apis::Core::Hashable # The content of the input in string format. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The Google Cloud Storage URI where the file content is located. # This URI must be of the form: gs://bucket_name/object_name. For more # details, see https://cloud.google.com/storage/docs/reference-uris. # NOTE: Cloud Storage object versioning is not supported. # Corresponds to the JSON property `gcsContentUri` # @return [String] attr_accessor :gcs_content_uri # The language of the document (if not specified, the language is # automatically detected). Both ISO and BCP-47 language codes are # accepted.
# [Language Support](/natural-language/docs/languages) # lists currently supported languages for each API method. # If the language (either specified by the caller or automatically detected) # is not supported by the called API method, an `INVALID_ARGUMENT` error # is returned. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # Required. If the type is not set or is `TYPE_UNSPECIFIED`, # returns an `INVALID_ARGUMENT` error. # 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) @content = args[:content] if args.key?(:content) @gcs_content_uri = args[:gcs_content_uri] if args.key?(:gcs_content_uri) @language = args[:language] if args.key?(:language) @type = args[:type] if args.key?(:type) end end # Represents a phrase in the text that is a known entity, such as # a person, an organization, or location. The API associates information, such # as salience and mentions, with entities. class Entity include Google::Apis::Core::Hashable # The mentions of this entity in the input document. The API currently # supports proper noun mentions. # Corresponds to the JSON property `mentions` # @return [Array] attr_accessor :mentions # Metadata associated with the entity. # Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if # available. The associated keys are "wikipedia_url" and "mid", respectively. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The representative name for the entity. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The salience score associated with the entity in the [0, 1.0] range. # The salience score for an entity provides information about the # importance or centrality of that entity to the entire document text. # Scores closer to 0 are less salient, while scores closer to 1.0 are highly # salient. # Corresponds to the JSON property `salience` # @return [Float] attr_accessor :salience # Represents the feeling associated with the entire text or entities in # the text. # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1beta2::Sentiment] attr_accessor :sentiment # The entity 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) @mentions = args[:mentions] if args.key?(:mentions) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @salience = args[:salience] if args.key?(:salience) @sentiment = args[:sentiment] if args.key?(:sentiment) @type = args[:type] if args.key?(:type) end end # Represents a mention for an entity in the text. Currently, proper noun # mentions are supported. class EntityMention include Google::Apis::Core::Hashable # Represents the feeling associated with the entire text or entities in # the text. # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1beta2::Sentiment] attr_accessor :sentiment # Represents an output piece of text. # Corresponds to the JSON property `text` # @return [Google::Apis::LanguageV1beta2::TextSpan] attr_accessor :text # The type of the entity mention. # 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) @sentiment = args[:sentiment] if args.key?(:sentiment) @text = args[:text] if args.key?(:text) @type = args[:type] if args.key?(:type) end end # All available features for sentiment, syntax, and semantic analysis. # Setting each one to true will enable that specific analysis for the input. class Features include Google::Apis::Core::Hashable # Classify the full document into categories. If this is true, # the API will use the default model which classifies into a # [predefined taxonomy](/natural-language/docs/categories). # Corresponds to the JSON property `classifyText` # @return [Boolean] attr_accessor :classify_text alias_method :classify_text?, :classify_text # Extract document-level sentiment. # Corresponds to the JSON property `extractDocumentSentiment` # @return [Boolean] attr_accessor :extract_document_sentiment alias_method :extract_document_sentiment?, :extract_document_sentiment # Extract entities. # Corresponds to the JSON property `extractEntities` # @return [Boolean] attr_accessor :extract_entities alias_method :extract_entities?, :extract_entities # Extract entities and their associated sentiment. # Corresponds to the JSON property `extractEntitySentiment` # @return [Boolean] attr_accessor :extract_entity_sentiment alias_method :extract_entity_sentiment?, :extract_entity_sentiment # Extract syntax information. # Corresponds to the JSON property `extractSyntax` # @return [Boolean] attr_accessor :extract_syntax alias_method :extract_syntax?, :extract_syntax def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @classify_text = args[:classify_text] if args.key?(:classify_text) @extract_document_sentiment = args[:extract_document_sentiment] if args.key?(:extract_document_sentiment) @extract_entities = args[:extract_entities] if args.key?(:extract_entities) @extract_entity_sentiment = args[:extract_entity_sentiment] if args.key?(:extract_entity_sentiment) @extract_syntax = args[:extract_syntax] if args.key?(:extract_syntax) end end # Represents part of speech information for a token. class PartOfSpeech include Google::Apis::Core::Hashable # The grammatical aspect. # Corresponds to the JSON property `aspect` # @return [String] attr_accessor :aspect # The grammatical case. # Corresponds to the JSON property `case` # @return [String] attr_accessor :case # The grammatical form. # Corresponds to the JSON property `form` # @return [String] attr_accessor :form # The grammatical gender. # Corresponds to the JSON property `gender` # @return [String] attr_accessor :gender # The grammatical mood. # Corresponds to the JSON property `mood` # @return [String] attr_accessor :mood # The grammatical number. # Corresponds to the JSON property `number` # @return [String] attr_accessor :number # The grammatical person. # Corresponds to the JSON property `person` # @return [String] attr_accessor :person # The grammatical properness. # Corresponds to the JSON property `proper` # @return [String] attr_accessor :proper # The grammatical reciprocity. # Corresponds to the JSON property `reciprocity` # @return [String] attr_accessor :reciprocity # The part of speech tag. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag # The grammatical tense. # Corresponds to the JSON property `tense` # @return [String] attr_accessor :tense # The grammatical voice. # Corresponds to the JSON property `voice` # @return [String] attr_accessor :voice def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aspect = args[:aspect] if args.key?(:aspect) @case = args[:case] if args.key?(:case) @form = args[:form] if args.key?(:form) @gender = args[:gender] if args.key?(:gender) @mood = args[:mood] if args.key?(:mood) @number = args[:number] if args.key?(:number) @person = args[:person] if args.key?(:person) @proper = args[:proper] if args.key?(:proper) @reciprocity = args[:reciprocity] if args.key?(:reciprocity) @tag = args[:tag] if args.key?(:tag) @tense = args[:tense] if args.key?(:tense) @voice = args[:voice] if args.key?(:voice) end end # Represents a sentence in the input document. class Sentence include Google::Apis::Core::Hashable # Represents the feeling associated with the entire text or entities in # the text. # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1beta2::Sentiment] attr_accessor :sentiment # Represents an output piece of text. # Corresponds to the JSON property `text` # @return [Google::Apis::LanguageV1beta2::TextSpan] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @sentiment = args[:sentiment] if args.key?(:sentiment) @text = args[:text] if args.key?(:text) end end # Represents the feeling associated with the entire text or entities in # the text. class Sentiment include Google::Apis::Core::Hashable # A non-negative number in the [0, +inf) range, which represents # the absolute magnitude of sentiment regardless of score (positive or # negative). # Corresponds to the JSON property `magnitude` # @return [Float] attr_accessor :magnitude # Sentiment score between -1.0 (negative sentiment) and 1.0 # (positive sentiment). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @magnitude = args[:magnitude] if args.key?(:magnitude) @score = args[:score] if args.key?(:score) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 an output piece of text. class TextSpan include Google::Apis::Core::Hashable # The API calculates the beginning offset of the content in the original # document according to the EncodingType specified in the API request. # Corresponds to the JSON property `beginOffset` # @return [Fixnum] attr_accessor :begin_offset # The content of the output text. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @begin_offset = args[:begin_offset] if args.key?(:begin_offset) @content = args[:content] if args.key?(:content) end end # Represents the smallest syntactic building block of the text. class Token include Google::Apis::Core::Hashable # Represents dependency parse tree information for a token. # Corresponds to the JSON property `dependencyEdge` # @return [Google::Apis::LanguageV1beta2::DependencyEdge] attr_accessor :dependency_edge # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token. # Corresponds to the JSON property `lemma` # @return [String] attr_accessor :lemma # Represents part of speech information for a token. # Corresponds to the JSON property `partOfSpeech` # @return [Google::Apis::LanguageV1beta2::PartOfSpeech] attr_accessor :part_of_speech # Represents an output piece of text. # Corresponds to the JSON property `text` # @return [Google::Apis::LanguageV1beta2::TextSpan] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dependency_edge = args[:dependency_edge] if args.key?(:dependency_edge) @lemma = args[:lemma] if args.key?(:lemma) @part_of_speech = args[:part_of_speech] if args.key?(:part_of_speech) @text = args[:text] if args.key?(:text) end end end end end google-api-client-0.19.8/generated/google/apis/language_v1beta2/service.rb0000644000004100000410000003504213252673044026414 0ustar www-datawww-data# 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 LanguageV1beta2 # Google Cloud Natural Language API # # Provides natural language understanding technologies to developers. Examples # include sentiment analysis, entity recognition, entity sentiment analysis, and # text annotations. # # @example # require 'google/apis/language_v1beta2' # # Language = Google::Apis::LanguageV1beta2 # Alias the module # service = Language::CloudNaturalLanguageService.new # # @see https://cloud.google.com/natural-language/ class CloudNaturalLanguageService < 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://language.googleapis.com/', '') @batch_path = 'batch' end # Finds named entities (currently proper names and common nouns) in the text # along with entity types, salience, mentions for each entity, and # other properties. # @param [Google::Apis::LanguageV1beta2::AnalyzeEntitiesRequest] analyze_entities_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::LanguageV1beta2::AnalyzeEntitiesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LanguageV1beta2::AnalyzeEntitiesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_document_entities(analyze_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/documents:analyzeEntities', options) command.request_representation = Google::Apis::LanguageV1beta2::AnalyzeEntitiesRequest::Representation command.request_object = analyze_entities_request_object command.response_representation = Google::Apis::LanguageV1beta2::AnalyzeEntitiesResponse::Representation command.response_class = Google::Apis::LanguageV1beta2::AnalyzeEntitiesResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Finds entities, similar to AnalyzeEntities in the text and analyzes # sentiment associated with each entity and its mentions. # @param [Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentRequest] analyze_entity_sentiment_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::LanguageV1beta2::AnalyzeEntitySentimentResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_document_entity_sentiment(analyze_entity_sentiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/documents:analyzeEntitySentiment', options) command.request_representation = Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentRequest::Representation command.request_object = analyze_entity_sentiment_request_object command.response_representation = Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentResponse::Representation command.response_class = Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Analyzes the sentiment of the provided text. # @param [Google::Apis::LanguageV1beta2::AnalyzeSentimentRequest] analyze_sentiment_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::LanguageV1beta2::AnalyzeSentimentResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LanguageV1beta2::AnalyzeSentimentResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_document_sentiment(analyze_sentiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/documents:analyzeSentiment', options) command.request_representation = Google::Apis::LanguageV1beta2::AnalyzeSentimentRequest::Representation command.request_object = analyze_sentiment_request_object command.response_representation = Google::Apis::LanguageV1beta2::AnalyzeSentimentResponse::Representation command.response_class = Google::Apis::LanguageV1beta2::AnalyzeSentimentResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Analyzes the syntax of the text and provides sentence boundaries and # tokenization along with part of speech tags, dependency trees, and other # properties. # @param [Google::Apis::LanguageV1beta2::AnalyzeSyntaxRequest] analyze_syntax_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::LanguageV1beta2::AnalyzeSyntaxResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LanguageV1beta2::AnalyzeSyntaxResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_document_syntax(analyze_syntax_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/documents:analyzeSyntax', options) command.request_representation = Google::Apis::LanguageV1beta2::AnalyzeSyntaxRequest::Representation command.request_object = analyze_syntax_request_object command.response_representation = Google::Apis::LanguageV1beta2::AnalyzeSyntaxResponse::Representation command.response_class = Google::Apis::LanguageV1beta2::AnalyzeSyntaxResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # A convenience method that provides all syntax, sentiment, entity, and # classification features in one call. # @param [Google::Apis::LanguageV1beta2::AnnotateTextRequest] annotate_text_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::LanguageV1beta2::AnnotateTextResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LanguageV1beta2::AnnotateTextResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def annotate_document_text(annotate_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/documents:annotateText', options) command.request_representation = Google::Apis::LanguageV1beta2::AnnotateTextRequest::Representation command.request_object = annotate_text_request_object command.response_representation = Google::Apis::LanguageV1beta2::AnnotateTextResponse::Representation command.response_class = Google::Apis::LanguageV1beta2::AnnotateTextResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Classifies a document into categories. # @param [Google::Apis::LanguageV1beta2::ClassifyTextRequest] classify_text_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::LanguageV1beta2::ClassifyTextResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LanguageV1beta2::ClassifyTextResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def classify_document_text(classify_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/documents:classifyText', options) command.request_representation = Google::Apis::LanguageV1beta2::ClassifyTextRequest::Representation command.request_object = classify_text_request_object command.response_representation = Google::Apis::LanguageV1beta2::ClassifyTextResponse::Representation command.response_class = Google::Apis::LanguageV1beta2::ClassifyTextResponse 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 google-api-client-0.19.8/generated/google/apis/youtube_analytics_v1/0000755000004100000410000000000013252673044025465 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/youtube_analytics_v1/representations.rb0000644000004100000410000001363413252673044031246 0ustar www-datawww-data# 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 YoutubeAnalyticsV1 class Group class Representation < Google::Apis::Core::JsonRepresentation; end class ContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Snippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class GroupItem class Representation < Google::Apis::Core::JsonRepresentation; end class Resource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ListGroupItemResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListGroupsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResultTable class Representation < Google::Apis::Core::JsonRepresentation; end class ColumnHeader class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Group # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeAnalyticsV1::Group::ContentDetails, decorator: Google::Apis::YoutubeAnalyticsV1::Group::ContentDetails::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeAnalyticsV1::Group::Snippet, decorator: Google::Apis::YoutubeAnalyticsV1::Group::Snippet::Representation end class ContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :item_count, :numeric_string => true, as: 'itemCount' property :item_type, as: 'itemType' end end class Snippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :published_at, as: 'publishedAt', type: DateTime property :title, as: 'title' end end end class GroupItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :group_id, as: 'groupId' property :id, as: 'id' property :kind, as: 'kind' property :resource, as: 'resource', class: Google::Apis::YoutubeAnalyticsV1::GroupItem::Resource, decorator: Google::Apis::YoutubeAnalyticsV1::GroupItem::Resource::Representation end class Resource # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' end end end class ListGroupItemResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::YoutubeAnalyticsV1::GroupItem, decorator: Google::Apis::YoutubeAnalyticsV1::GroupItem::Representation property :kind, as: 'kind' end end class ListGroupsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::YoutubeAnalyticsV1::Group, decorator: Google::Apis::YoutubeAnalyticsV1::Group::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class ResultTable # @private class Representation < Google::Apis::Core::JsonRepresentation collection :column_headers, as: 'columnHeaders', class: Google::Apis::YoutubeAnalyticsV1::ResultTable::ColumnHeader, decorator: Google::Apis::YoutubeAnalyticsV1::ResultTable::ColumnHeader::Representation property :kind, as: 'kind' collection :rows, as: 'rows', :class => Array do include Representable::JSON::Collection items end end class ColumnHeader # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_type, as: 'columnType' property :data_type, as: 'dataType' property :name, as: 'name' end end end end end end google-api-client-0.19.8/generated/google/apis/youtube_analytics_v1/classes.rb0000644000004100000410000002556613252673044027465 0ustar www-datawww-data# 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 YoutubeAnalyticsV1 # class Group include Google::Apis::Core::Hashable # # Corresponds to the JSON property `contentDetails` # @return [Google::Apis::YoutubeAnalyticsV1::Group::ContentDetails] attr_accessor :content_details # # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeAnalyticsV1::Group::Snippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_details = args[:content_details] if args.key?(:content_details) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end # class ContentDetails include Google::Apis::Core::Hashable # # Corresponds to the JSON property `itemCount` # @return [Fixnum] attr_accessor :item_count # # Corresponds to the JSON property `itemType` # @return [String] attr_accessor :item_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @item_count = args[:item_count] if args.key?(:item_count) @item_type = args[:item_type] if args.key?(:item_type) end end # class Snippet include Google::Apis::Core::Hashable # # Corresponds to the JSON property `publishedAt` # @return [DateTime] attr_accessor :published_at # # 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) @published_at = args[:published_at] if args.key?(:published_at) @title = args[:title] if args.key?(:title) end end end # class GroupItem include Google::Apis::Core::Hashable # # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # # Corresponds to the JSON property `groupId` # @return [String] attr_accessor :group_id # # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # # Corresponds to the JSON property `resource` # @return [Google::Apis::YoutubeAnalyticsV1::GroupItem::Resource] attr_accessor :resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @group_id = args[:group_id] if args.key?(:group_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @resource = args[:resource] if args.key?(:resource) end # class Resource include Google::Apis::Core::Hashable # # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) end end end # A paginated list of grouList resources returned in response to a # youtubeAnalytics.groupApi.list request. class ListGroupItemResponse include Google::Apis::Core::Hashable # # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # # 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) @etag = args[:etag] if args.key?(:etag) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # A paginated list of grouList resources returned in response to a # youtubeAnalytics.groupApi.list request. class ListGroupsResponse include Google::Apis::Core::Hashable # # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # Contains a single result table. The table is returned as an array of rows that # contain the values for the cells of the table. Depending on the metric or # dimension, the cell can contain a string (video ID, country code) or a number ( # number of views or number of likes). class ResultTable include Google::Apis::Core::Hashable # This value specifies information about the data returned in the rows fields. # Each item in the columnHeaders list identifies a field returned in the rows # value, which contains a list of comma-delimited data. The columnHeaders list # will begin with the dimensions specified in the API request, which will be # followed by the metrics specified in the API request. The order of both # dimensions and metrics will match the ordering in the API request. For example, # if the API request contains the parameters dimensions=ageGroup,gender&metrics= # viewerPercentage, the API response will return columns in this order: ageGroup, # gender,viewerPercentage. # Corresponds to the JSON property `columnHeaders` # @return [Array] attr_accessor :column_headers # This value specifies the type of data included in the API response. For the # query method, the kind property value will be youtubeAnalytics#resultTable. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The list contains all rows of the result table. Each item in the list is an # array that contains comma-delimited data corresponding to a single row of data. # The order of the comma-delimited data fields will match the order of the # columns listed in the columnHeaders field. If no data is available for the # given query, the rows element will be omitted from the response. The response # for a query with the day dimension will not contain rows for the most recent # days. # Corresponds to the JSON property `rows` # @return [Array>] attr_accessor :rows def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_headers = args[:column_headers] if args.key?(:column_headers) @kind = args[:kind] if args.key?(:kind) @rows = args[:rows] if args.key?(:rows) end # class ColumnHeader include Google::Apis::Core::Hashable # The type of the column (DIMENSION or METRIC). # Corresponds to the JSON property `columnType` # @return [String] attr_accessor :column_type # The type of the data in the column (STRING, INTEGER, FLOAT, etc.). # Corresponds to the JSON property `dataType` # @return [String] attr_accessor :data_type # The name of the dimension or 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) @column_type = args[:column_type] if args.key?(:column_type) @data_type = args[:data_type] if args.key?(:data_type) @name = args[:name] if args.key?(:name) end end end end end end google-api-client-0.19.8/generated/google/apis/youtube_analytics_v1/service.rb0000644000004100000410000007427013252673044027464 0ustar www-datawww-data# 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 YoutubeAnalyticsV1 # YouTube Analytics API # # Retrieves your YouTube Analytics data. # # @example # require 'google/apis/youtube_analytics_v1' # # YoutubeAnalytics = Google::Apis::YoutubeAnalyticsV1 # Alias the module # service = YoutubeAnalytics::YouTubeAnalyticsService.new # # @see http://developers.google.com/youtube/analytics/ class YouTubeAnalyticsService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'youtube/analytics/v1/') @batch_path = 'batch/youtubeAnalytics/v1' end # Removes an item from a group. # @param [String] id # The id parameter specifies the YouTube group item ID for the group that is # being deleted. # @param [String] on_behalf_of_content_owner # Note: This parameter is intended exclusively for YouTube content partners. # The onBehalfOfContentOwner parameter indicates that the request's # authorization credentials identify a YouTube CMS user who is acting on behalf # of the content owner specified in the parameter value. This parameter is # intended for YouTube content partners that own and manage many different # YouTube channels. It allows content owners to authenticate once and get access # to all their video and channel data, without having to provide authentication # credentials for each individual channel. The CMS account that the user # authenticates with must be linked to the specified YouTube content owner. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_group_item(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'groupItems', options) command.query['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 group item. # @param [Google::Apis::YoutubeAnalyticsV1::GroupItem] group_item_object # @param [String] on_behalf_of_content_owner # Note: This parameter is intended exclusively for YouTube content partners. # The onBehalfOfContentOwner parameter indicates that the request's # authorization credentials identify a YouTube CMS user who is acting on behalf # of the content owner specified in the parameter value. This parameter is # intended for YouTube content partners that own and manage many different # YouTube channels. It allows content owners to authenticate once and get access # to all their video and channel data, without having to provide authentication # credentials for each individual channel. The CMS account that the user # authenticates with must be linked to the specified YouTube content owner. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubeAnalyticsV1::GroupItem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubeAnalyticsV1::GroupItem] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group_item(group_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'groupItems', options) command.request_representation = Google::Apis::YoutubeAnalyticsV1::GroupItem::Representation command.request_object = group_item_object command.response_representation = Google::Apis::YoutubeAnalyticsV1::GroupItem::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::GroupItem command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 collection of group items that match the API request parameters. # @param [String] group_id # The id parameter specifies the unique ID of the group for which you want to # retrieve group items. # @param [String] on_behalf_of_content_owner # Note: This parameter is intended exclusively for YouTube content partners. # The onBehalfOfContentOwner parameter indicates that the request's # authorization credentials identify a YouTube CMS user who is acting on behalf # of the content owner specified in the parameter value. This parameter is # intended for YouTube content partners that own and manage many different # YouTube channels. It allows content owners to authenticate once and get access # to all their video and channel data, without having to provide authentication # credentials for each individual channel. The CMS account that the user # authenticates with must be linked to the specified YouTube content owner. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group_items(group_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'groupItems', options) command.response_representation = Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse command.query['groupId'] = group_id unless group_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 a group. # @param [String] id # The id parameter specifies the YouTube group ID for the group that is being # deleted. # @param [String] on_behalf_of_content_owner # Note: This parameter is intended exclusively for YouTube content partners. # The onBehalfOfContentOwner parameter indicates that the request's # authorization credentials identify a YouTube CMS user who is acting on behalf # of the content owner specified in the parameter value. This parameter is # intended for YouTube content partners that own and manage many different # YouTube channels. It allows content owners to authenticate once and get access # to all their video and channel data, without having to provide authentication # credentials for each individual channel. The CMS account that the user # authenticates with must be linked to the specified YouTube content owner. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_group(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'groups', options) command.query['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 group. # @param [Google::Apis::YoutubeAnalyticsV1::Group] group_object # @param [String] on_behalf_of_content_owner # Note: This parameter is intended exclusively for YouTube content partners. # The onBehalfOfContentOwner parameter indicates that the request's # authorization credentials identify a YouTube CMS user who is acting on behalf # of the content owner specified in the parameter value. This parameter is # intended for YouTube content partners that own and manage many different # YouTube channels. It allows content owners to authenticate once and get access # to all their video and channel data, without having to provide authentication # credentials for each individual channel. The CMS account that the user # authenticates with must be linked to the specified YouTube content owner. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubeAnalyticsV1::Group] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubeAnalyticsV1::Group] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'groups', options) command.request_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation command.request_object = group_object command.response_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::Group command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 collection of groups that match the API request parameters. For # example, you can retrieve all groups that the authenticated user owns, or you # can retrieve one or more groups by their unique IDs. # @param [String] id # The id parameter specifies a comma-separated list of the YouTube group ID(s) # for the resource(s) that are being retrieved. In a group resource, the id # property specifies the group's YouTube group ID. # @param [Boolean] mine # Set this parameter's value to true to instruct the API to only return groups # owned by the authenticated user. # @param [String] on_behalf_of_content_owner # Note: This parameter is intended exclusively for YouTube content partners. # The onBehalfOfContentOwner parameter indicates that the request's # authorization credentials identify a YouTube CMS user who is acting on behalf # of the content owner specified in the parameter value. This parameter is # intended for YouTube content partners that own and manage many different # YouTube channels. It allows content owners to authenticate once and get access # to all their video and channel data, without having to provide authentication # credentials for each individual channel. The CMS account that the user # authenticates with must be linked to the specified YouTube content owner. # @param [String] page_token # The pageToken parameter identifies a specific page in the result set that # should be returned. In an API response, the nextPageToken property identifies # the next page that can be retrieved. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_groups(id: nil, mine: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'groups', options) command.response_representation = Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse command.query['id'] = id unless id.nil? command.query['mine'] = mine unless mine.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Modifies a group. For example, you could change a group's title. # @param [Google::Apis::YoutubeAnalyticsV1::Group] group_object # @param [String] on_behalf_of_content_owner # Note: This parameter is intended exclusively for YouTube content partners. # The onBehalfOfContentOwner parameter indicates that the request's # authorization credentials identify a YouTube CMS user who is acting on behalf # of the content owner specified in the parameter value. This parameter is # intended for YouTube content partners that own and manage many different # YouTube channels. It allows content owners to authenticate once and get access # to all their video and channel data, without having to provide authentication # credentials for each individual channel. The CMS account that the user # authenticates with must be linked to the specified YouTube content owner. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubeAnalyticsV1::Group] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubeAnalyticsV1::Group] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'groups', options) command.request_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation command.request_object = group_object command.response_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::Group command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 # Retrieve your YouTube Analytics reports. # @param [String] ids # Identifies the YouTube channel or content owner for which you are retrieving # YouTube Analytics data. # - To request data for a YouTube user, set the ids parameter value to channel== # CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID. # - To request data for a YouTube CMS content owner, set the ids parameter value # to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content # owner. # @param [String] start_date # The start date for fetching YouTube Analytics data. The value should be in # YYYY-MM-DD format. # @param [String] end_date # The end date for fetching YouTube Analytics data. The value should be in YYYY- # MM-DD format. # @param [String] metrics # A comma-separated list of YouTube Analytics metrics, such as views or likes, # dislikes. See the Available Reports document for a list of the reports that # you can retrieve and the metrics available in each report, and see the Metrics # document for definitions of those metrics. # @param [String] currency # The currency to which financial metrics should be converted. The default is US # Dollar (USD). If the result contains no financial metrics, this flag will be # ignored. Responds with an error if the specified currency is not recognized. # @param [String] dimensions # A comma-separated list of YouTube Analytics dimensions, such as views or # ageGroup,gender. See the Available Reports document for a list of the reports # that you can retrieve and the dimensions used for those reports. Also see the # Dimensions document for definitions of those dimensions. # @param [String] filters # A list of filters that should be applied when retrieving YouTube Analytics # data. The Available Reports document identifies the dimensions that can be # used to filter each report, and the Dimensions document defines those # dimensions. If a request uses multiple filters, join them together with a # semicolon (;), and the returned result table will satisfy both filters. For # example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts # the result set to include data for the given video in Italy. # @param [Boolean] include_historical_channel_data # If set to true historical data (i.e. channel data from before the linking of # the channel to the content owner) will be retrieved. # @param [Fixnum] max_results # The maximum number of rows to include in the response. # @param [String] sort # A comma-separated list of dimensions or metrics that determine the sort order # for YouTube Analytics data. By default the sort order is ascending. The '-' # prefix causes descending sort order. # @param [Fixnum] start_index # An index of the first entity to retrieve. Use this parameter as a pagination # mechanism along with the max-results parameter (one-based, inclusive). # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubeAnalyticsV1::ResultTable] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubeAnalyticsV1::ResultTable] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_report(ids, start_date, end_date, metrics, currency: nil, dimensions: nil, filters: nil, include_historical_channel_data: nil, max_results: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'reports', options) command.response_representation = Google::Apis::YoutubeAnalyticsV1::ResultTable::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::ResultTable command.query['currency'] = currency unless currency.nil? command.query['dimensions'] = dimensions unless dimensions.nil? command.query['end-date'] = end_date unless end_date.nil? command.query['filters'] = filters unless filters.nil? command.query['ids'] = ids unless ids.nil? command.query['include-historical-channel-data'] = include_historical_channel_data unless include_historical_channel_data.nil? command.query['max-results'] = max_results unless max_results.nil? command.query['metrics'] = metrics unless metrics.nil? command.query['sort'] = sort unless sort.nil? command.query['start-date'] = start_date unless start_date.nil? command.query['start-index'] = start_index unless start_index.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 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 end end google-api-client-0.19.8/generated/google/apis/cloudfunctions_v1/0000755000004100000410000000000013252673043024760 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/cloudfunctions_v1/representations.rb0000644000004100000410000002621213252673043030535 0ustar www-datawww-data# 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 CloudfunctionsV1 class CallFunctionRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CallFunctionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CloudFunction class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventTrigger class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FailurePolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GenerateDownloadUrlRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GenerateDownloadUrlResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GenerateUploadUrlRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GenerateUploadUrlResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpsTrigger class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListFunctionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLocationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Location 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 OperationMetadataV1 class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperationMetadataV1Beta2 class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Retry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SourceRepository 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 CallFunctionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, as: 'data' end end class CallFunctionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :error, as: 'error' property :execution_id, as: 'executionId' property :result, as: 'result' end end class CloudFunction # @private class Representation < Google::Apis::Core::JsonRepresentation property :available_memory_mb, as: 'availableMemoryMb' property :description, as: 'description' property :entry_point, as: 'entryPoint' property :event_trigger, as: 'eventTrigger', class: Google::Apis::CloudfunctionsV1::EventTrigger, decorator: Google::Apis::CloudfunctionsV1::EventTrigger::Representation property :https_trigger, as: 'httpsTrigger', class: Google::Apis::CloudfunctionsV1::HttpsTrigger, decorator: Google::Apis::CloudfunctionsV1::HttpsTrigger::Representation hash :labels, as: 'labels' property :name, as: 'name' property :service_account_email, as: 'serviceAccountEmail' property :source_archive_url, as: 'sourceArchiveUrl' property :source_repository, as: 'sourceRepository', class: Google::Apis::CloudfunctionsV1::SourceRepository, decorator: Google::Apis::CloudfunctionsV1::SourceRepository::Representation property :source_upload_url, as: 'sourceUploadUrl' property :status, as: 'status' property :timeout, as: 'timeout' property :update_time, as: 'updateTime' property :version_id, :numeric_string => true, as: 'versionId' end end class EventTrigger # @private class Representation < Google::Apis::Core::JsonRepresentation property :event_type, as: 'eventType' property :failure_policy, as: 'failurePolicy', class: Google::Apis::CloudfunctionsV1::FailurePolicy, decorator: Google::Apis::CloudfunctionsV1::FailurePolicy::Representation property :resource, as: 'resource' property :service, as: 'service' end end class FailurePolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :retry, as: 'retry', class: Google::Apis::CloudfunctionsV1::Retry, decorator: Google::Apis::CloudfunctionsV1::Retry::Representation end end class GenerateDownloadUrlRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :version_id, :numeric_string => true, as: 'versionId' end end class GenerateDownloadUrlResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :download_url, as: 'downloadUrl' end end class GenerateUploadUrlRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GenerateUploadUrlResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :upload_url, as: 'uploadUrl' end end class HttpsTrigger # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class ListFunctionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :functions, as: 'functions', class: Google::Apis::CloudfunctionsV1::CloudFunction, decorator: Google::Apis::CloudfunctionsV1::CloudFunction::Representation property :next_page_token, as: 'nextPageToken' end end class ListLocationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :locations, as: 'locations', class: Google::Apis::CloudfunctionsV1::Location, decorator: Google::Apis::CloudfunctionsV1::Location::Representation property :next_page_token, as: 'nextPageToken' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::CloudfunctionsV1::Operation, decorator: Google::Apis::CloudfunctionsV1::Operation::Representation end end class Location # @private class Representation < Google::Apis::Core::JsonRepresentation hash :labels, as: 'labels' property :location_id, as: 'locationId' hash :metadata, as: 'metadata' property :name, as: 'name' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::CloudfunctionsV1::Status, decorator: Google::Apis::CloudfunctionsV1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class OperationMetadataV1 # @private class Representation < Google::Apis::Core::JsonRepresentation hash :request, as: 'request' property :target, as: 'target' property :type, as: 'type' property :update_time, as: 'updateTime' property :version_id, :numeric_string => true, as: 'versionId' end end class OperationMetadataV1Beta2 # @private class Representation < Google::Apis::Core::JsonRepresentation hash :request, as: 'request' property :target, as: 'target' property :type, as: 'type' property :update_time, as: 'updateTime' property :version_id, :numeric_string => true, as: 'versionId' end end class Retry # @private class Representation < Google::Apis::Core::JsonRepresentation end end class SourceRepository # @private class Representation < Google::Apis::Core::JsonRepresentation property :deployed_url, as: 'deployedUrl' property :url, as: 'url' 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 google-api-client-0.19.8/generated/google/apis/cloudfunctions_v1/classes.rb0000644000004100000410000010253413252673043026747 0ustar www-datawww-data# 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 CloudfunctionsV1 # Request for the `CallFunction` method. class CallFunctionRequest include Google::Apis::Core::Hashable # Input to be passed to the function. # Corresponds to the JSON property `data` # @return [String] 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 # Response of `CallFunction` method. class CallFunctionResponse include Google::Apis::Core::Hashable # Either system or user-function generated error. Set if execution # was not successful. # Corresponds to the JSON property `error` # @return [String] attr_accessor :error # Execution id of function invocation. # Corresponds to the JSON property `executionId` # @return [String] attr_accessor :execution_id # Result populated for successful execution of synchronous function. Will # not be populated if function does not return a result through context. # Corresponds to the JSON property `result` # @return [String] attr_accessor :result def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error = args[:error] if args.key?(:error) @execution_id = args[:execution_id] if args.key?(:execution_id) @result = args[:result] if args.key?(:result) end end # Describes a Cloud Function that contains user computation executed in # response to an event. It encapsulate function and triggers configurations. class CloudFunction include Google::Apis::Core::Hashable # The amount of memory in MB available for a function. # Defaults to 256MB. # Corresponds to the JSON property `availableMemoryMb` # @return [Fixnum] attr_accessor :available_memory_mb # User-provided description of a function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The name of the function (as defined in source code) that will be # executed. Defaults to the resource name suffix, if not specified. For # backward compatibility, if function with given name is not found, then the # system will try to use function named "function". # For Node.js this is name of a function exported by the module specified # in `source_location`. # Corresponds to the JSON property `entryPoint` # @return [String] attr_accessor :entry_point # Describes EventTrigger, used to request events be sent from another # service. # Corresponds to the JSON property `eventTrigger` # @return [Google::Apis::CloudfunctionsV1::EventTrigger] attr_accessor :event_trigger # Describes HttpsTrigger, could be used to connect web hooks to function. # Corresponds to the JSON property `httpsTrigger` # @return [Google::Apis::CloudfunctionsV1::HttpsTrigger] attr_accessor :https_trigger # Labels associated with this Cloud Function. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # A user-defined name of the function. Function names must be unique # globally and match pattern `projects/*/locations/*/functions/*` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The email of the function's service account. # Corresponds to the JSON property `serviceAccountEmail` # @return [String] attr_accessor :service_account_email # The Google Cloud Storage URL, starting with gs://, pointing to the zip # archive which contains the function. # Corresponds to the JSON property `sourceArchiveUrl` # @return [String] attr_accessor :source_archive_url # Describes SourceRepository, used to represent parameters related to # source repository where a function is hosted. # Corresponds to the JSON property `sourceRepository` # @return [Google::Apis::CloudfunctionsV1::SourceRepository] attr_accessor :source_repository # The Google Cloud Storage signed URL used for source uploading, generated # by google.cloud.functions.v1.GenerateUploadUrl # Corresponds to the JSON property `sourceUploadUrl` # @return [String] attr_accessor :source_upload_url # Output only. Status of the function deployment. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The function execution timeout. Execution is considered failed and # can be terminated if the function is not completed at the end of the # timeout period. Defaults to 60 seconds. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout # Output only. The last update timestamp of a Cloud Function. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Output only. # The version identifier of the Cloud Function. Each deployment attempt # results in a new version of a function being created. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @available_memory_mb = args[:available_memory_mb] if args.key?(:available_memory_mb) @description = args[:description] if args.key?(:description) @entry_point = args[:entry_point] if args.key?(:entry_point) @event_trigger = args[:event_trigger] if args.key?(:event_trigger) @https_trigger = args[:https_trigger] if args.key?(:https_trigger) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @service_account_email = args[:service_account_email] if args.key?(:service_account_email) @source_archive_url = args[:source_archive_url] if args.key?(:source_archive_url) @source_repository = args[:source_repository] if args.key?(:source_repository) @source_upload_url = args[:source_upload_url] if args.key?(:source_upload_url) @status = args[:status] if args.key?(:status) @timeout = args[:timeout] if args.key?(:timeout) @update_time = args[:update_time] if args.key?(:update_time) @version_id = args[:version_id] if args.key?(:version_id) end end # Describes EventTrigger, used to request events be sent from another # service. class EventTrigger include Google::Apis::Core::Hashable # Required. The type of event to observe. For example: # `providers/cloud.storage/eventTypes/object.change` and # `providers/cloud.pubsub/eventTypes/topic.publish`. # Event types match pattern `providers/*/eventTypes/*.*`. # The pattern contains: # 1. namespace: For example, `cloud.storage` and # `google.firebase.analytics`. # 2. resource type: The type of resource on which event occurs. For # example, the Google Cloud Storage API includes the type `object`. # 3. action: The action that generates the event. For example, action for # a Google Cloud Storage Object is 'change'. # These parts are lower case. # Corresponds to the JSON property `eventType` # @return [String] attr_accessor :event_type # Describes the policy in case of function's execution failure. # If empty, then defaults to ignoring failures (i.e. not retrying them). # Corresponds to the JSON property `failurePolicy` # @return [Google::Apis::CloudfunctionsV1::FailurePolicy] attr_accessor :failure_policy # Required. The resource(s) from which to observe events, for example, # `projects/_/buckets/myBucket`. # Not all syntactically correct values are accepted by all services. For # example: # 1. The authorization model must support it. Google Cloud Functions # only allows EventTriggers to be deployed that observe resources in the # same project as the `CloudFunction`. # 2. The resource type must match the pattern expected for an # `event_type`. For example, an `EventTrigger` that has an # `event_type` of "google.pubsub.topic.publish" should have a resource # that matches Google Cloud Pub/Sub topics. # Additionally, some services may support short names when creating an # `EventTrigger`. These will always be returned in the normalized "long" # format. # See each *service's* documentation for supported formats. # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource # The hostname of the service that should be observed. # If no string is provided, the default service implementing the API will # be used. For example, `storage.googleapis.com` is the default for all # event types in the `google.storage` namespace. # 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) @event_type = args[:event_type] if args.key?(:event_type) @failure_policy = args[:failure_policy] if args.key?(:failure_policy) @resource = args[:resource] if args.key?(:resource) @service = args[:service] if args.key?(:service) end end # Describes the policy in case of function's execution failure. # If empty, then defaults to ignoring failures (i.e. not retrying them). class FailurePolicy include Google::Apis::Core::Hashable # Describes the retry policy in case of function's execution failure. # A function execution will be retried on any failure. # A failed execution will be retried up to 7 days with an exponential backoff # (capped at 10 seconds). # Retried execution is charged as any other execution. # Corresponds to the JSON property `retry` # @return [Google::Apis::CloudfunctionsV1::Retry] attr_accessor :retry def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @retry = args[:retry] if args.key?(:retry) end end # Request of `GenerateDownloadUrl` method. class GenerateDownloadUrlRequest include Google::Apis::Core::Hashable # The optional version of function. If not set, default, current version # is used. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @version_id = args[:version_id] if args.key?(:version_id) end end # Response of `GenerateDownloadUrl` method. class GenerateDownloadUrlResponse include Google::Apis::Core::Hashable # The generated Google Cloud Storage signed URL that should be used for # function source code download. # Corresponds to the JSON property `downloadUrl` # @return [String] attr_accessor :download_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @download_url = args[:download_url] if args.key?(:download_url) end end # Request of `GenerateSourceUploadUrl` method. class GenerateUploadUrlRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Response of `GenerateSourceUploadUrl` method. class GenerateUploadUrlResponse include Google::Apis::Core::Hashable # The generated Google Cloud Storage signed URL that should be used for a # function source code upload. The uploaded file should be a zip archive # which contains a function. # Corresponds to the JSON property `uploadUrl` # @return [String] attr_accessor :upload_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @upload_url = args[:upload_url] if args.key?(:upload_url) end end # Describes HttpsTrigger, could be used to connect web hooks to function. class HttpsTrigger include Google::Apis::Core::Hashable # Output only. The deployed url for the function. # 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 # Response for the `ListFunctions` method. class ListFunctionsResponse include Google::Apis::Core::Hashable # The functions that match the request. # Corresponds to the JSON property `functions` # @return [Array] attr_accessor :functions # If not empty, indicates that there may be more functions that match # the request; this value should be passed in a new # google.cloud.functions.v1.ListFunctionsRequest # to get more functions. # 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) @functions = args[:functions] if args.key?(:functions) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Locations.ListLocations. class ListLocationsResponse include Google::Apis::Core::Hashable # A list of locations that matches the specified filter in the request. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # The standard List next-page token. # 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) @locations = args[:locations] if args.key?(:locations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Operations.ListOperations. class ListOperationsResponse 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 # A resource that represents Google Cloud Platform location. class Location include Google::Apis::Core::Hashable # Cross-service attributes for the location. For example # `"cloud.googleapis.com/region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The canonical id for this location. For example: `"us-east1"`. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Service-specific metadata. For example the available capacity at the given # location. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # Resource name for the location, which may vary between implementations. # For example: `"projects/example-project/locations/us-east1"` # 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) @labels = args[:labels] if args.key?(:labels) @location_id = args[:location_id] if args.key?(:location_id) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::CloudfunctionsV1::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 have the format of `operations/some/unique/name`. # 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 # Metadata describing an Operation class OperationMetadataV1 include Google::Apis::Core::Hashable # The original request that started the operation. # Corresponds to the JSON property `request` # @return [Hash] attr_accessor :request # Target of the operation - for example # projects/project-1/locations/region-1/functions/function-1 # Corresponds to the JSON property `target` # @return [String] attr_accessor :target # Type of operation. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The last update timestamp of the operation. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Version id of the function created or updated by an API call. # This field is only pupulated for Create and Update operations. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @request = args[:request] if args.key?(:request) @target = args[:target] if args.key?(:target) @type = args[:type] if args.key?(:type) @update_time = args[:update_time] if args.key?(:update_time) @version_id = args[:version_id] if args.key?(:version_id) end end # Metadata describing an Operation class OperationMetadataV1Beta2 include Google::Apis::Core::Hashable # The original request that started the operation. # Corresponds to the JSON property `request` # @return [Hash] attr_accessor :request # Target of the operation - for example # projects/project-1/locations/region-1/functions/function-1 # Corresponds to the JSON property `target` # @return [String] attr_accessor :target # Type of operation. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The last update timestamp of the operation. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Version id of the function created or updated by an API call. # This field is only pupulated for Create and Update operations. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @request = args[:request] if args.key?(:request) @target = args[:target] if args.key?(:target) @type = args[:type] if args.key?(:type) @update_time = args[:update_time] if args.key?(:update_time) @version_id = args[:version_id] if args.key?(:version_id) end end # Describes the retry policy in case of function's execution failure. # A function execution will be retried on any failure. # A failed execution will be retried up to 7 days with an exponential backoff # (capped at 10 seconds). # Retried execution is charged as any other execution. class Retry include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Describes SourceRepository, used to represent parameters related to # source repository where a function is hosted. class SourceRepository include Google::Apis::Core::Hashable # Output only. The URL pointing to the hosted repository where the function # were defined at the time of deployment. It always points to a specific # commit in the format described above. # Corresponds to the JSON property `deployedUrl` # @return [String] attr_accessor :deployed_url # The URL pointing to the hosted repository where the function is defined. # There are supported Cloud Source Repository URLs in the following # formats: # To refer to a specific commit: # `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` # To refer to a moveable alias (branch): # `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/ # paths/*` # In particular, to refer to HEAD use `master` moveable alias. # To refer to a specific fixed alias (tag): # `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/ # *` # You may omit `paths/*` if you want to use the main directory. # 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) @deployed_url = args[:deployed_url] if args.key?(:deployed_url) @url = args[:url] if args.key?(:url) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 google-api-client-0.19.8/generated/google/apis/cloudfunctions_v1/service.rb0000644000004100000410000006725713252673043026766 0ustar www-datawww-data# 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 CloudfunctionsV1 # Google Cloud Functions API # # API for managing lightweight user-provided functions executed in response to # events. # # @example # require 'google/apis/cloudfunctions_v1' # # Cloudfunctions = Google::Apis::CloudfunctionsV1 # Alias the module # service = Cloudfunctions::CloudFunctionsService.new # # @see https://cloud.google.com/functions class CloudFunctionsService < 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://cloudfunctions.googleapis.com/', '') @batch_path = 'batch' 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::CloudfunctionsV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::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_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation command.response_class = Google::Apis::CloudfunctionsV1::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 # 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] filter # The standard list filter. # @param [String] name # The name of the operation's parent resource. # @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::CloudfunctionsV1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/operations', options) command.response_representation = Google::Apis::CloudfunctionsV1::ListOperationsResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1::ListOperationsResponse command.query['filter'] = filter unless filter.nil? command.query['name'] = name unless 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 # Lists information about the supported locations for this service. # @param [String] name # The resource that owns the locations collection, if applicable. # @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::CloudfunctionsV1::ListLocationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::ListLocationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/locations', options) command.response_representation = Google::Apis::CloudfunctionsV1::ListLocationsResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1::ListLocationsResponse 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 # Invokes synchronously deployed function. To be used for testing, very # limited traffic allowed. # @param [String] name # The name of the function to be called. # @param [Google::Apis::CloudfunctionsV1::CallFunctionRequest] call_function_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::CloudfunctionsV1::CallFunctionResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::CallFunctionResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def call_function(name, call_function_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:call', options) command.request_representation = Google::Apis::CloudfunctionsV1::CallFunctionRequest::Representation command.request_object = call_function_request_object command.response_representation = Google::Apis::CloudfunctionsV1::CallFunctionResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1::CallFunctionResponse 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 new function. If a function with the given name already exists in # the specified project, the long running operation will return # `ALREADY_EXISTS` error. # @param [String] location # The project and location in which the function should be created, specified # in the format `projects/*/locations/*` # @param [Google::Apis::CloudfunctionsV1::CloudFunction] cloud_function_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::CloudfunctionsV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::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_location_function(location, cloud_function_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+location}/functions', options) command.request_representation = Google::Apis::CloudfunctionsV1::CloudFunction::Representation command.request_object = cloud_function_object command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation command.response_class = Google::Apis::CloudfunctionsV1::Operation command.params['location'] = location unless location.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 function with the given name from the specified project. If the # given function is used by some trigger, the trigger will be updated to # remove this function. # @param [String] name # The name of the function which should 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::CloudfunctionsV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::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_project_location_function(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation command.response_class = Google::Apis::CloudfunctionsV1::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 # Returns a signed URL for downloading deployed function source code. # The URL is only valid for a limited period and should be used within # minutes after generation. # For more information about the signed URL usage see: # https://cloud.google.com/storage/docs/access-control/signed-urls # @param [String] name # The name of function for which source code Google Cloud Storage signed # URL should be generated. # @param [Google::Apis::CloudfunctionsV1::GenerateDownloadUrlRequest] generate_download_url_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::CloudfunctionsV1::GenerateDownloadUrlResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_function_download_url(name, generate_download_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:generateDownloadUrl', options) command.request_representation = Google::Apis::CloudfunctionsV1::GenerateDownloadUrlRequest::Representation command.request_object = generate_download_url_request_object command.response_representation = Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse 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 signed URL for uploading a function source code. # For more information about the signed URL usage see: # https://cloud.google.com/storage/docs/access-control/signed-urls. # Once the function source code upload is complete, the used signed # URL should be provided in CreateFunction or UpdateFunction request # as a reference to the function source code. # When uploading source code to the generated signed URL, please follow # these restrictions: # * Source file type should be a zip file. # * Source file size should not exceed 100MB limit. # When making a HTTP PUT request, these two headers need to be specified: # * `content-type: application/zip` # * `x-google-content-length-range: 0,104857600` # @param [String] parent # The project and location in which the Google Cloud Storage signed URL # should be generated, specified in the format `projects/*/locations/*`. # @param [Google::Apis::CloudfunctionsV1::GenerateUploadUrlRequest] generate_upload_url_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::CloudfunctionsV1::GenerateUploadUrlResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_function_upload_url(parent, generate_upload_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/functions:generateUploadUrl', options) command.request_representation = Google::Apis::CloudfunctionsV1::GenerateUploadUrlRequest::Representation command.request_object = generate_upload_url_request_object command.response_representation = Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse 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 # Returns a function with the given name from the requested project. # @param [String] name # The name of the function which details should be obtained. # @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::CloudfunctionsV1::CloudFunction] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::CloudFunction] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_function(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudfunctionsV1::CloudFunction::Representation command.response_class = Google::Apis::CloudfunctionsV1::CloudFunction 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 functions that belong to the requested project. # @param [String] parent # The project and location from which the function should be listed, # specified in the format `projects/*/locations/*` # If you want to list functions in all locations, use "-" in place of a # location. # @param [Fixnum] page_size # Maximum number of functions to return per call. # @param [String] page_token # The value returned by the last # `ListFunctionsResponse`; indicates that # this is a continuation of a prior `ListFunctions` call, and that the # system should return the next page of data. # @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::CloudfunctionsV1::ListFunctionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::ListFunctionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_functions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/functions', options) command.response_representation = Google::Apis::CloudfunctionsV1::ListFunctionsResponse::Representation command.response_class = Google::Apis::CloudfunctionsV1::ListFunctionsResponse 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 # Updates existing function. # @param [String] name # A user-defined name of the function. Function names must be unique # globally and match pattern `projects/*/locations/*/functions/*` # @param [Google::Apis::CloudfunctionsV1::CloudFunction] cloud_function_object # @param [String] update_mask # Required list of fields to be updated in this 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::CloudfunctionsV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudfunctionsV1::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_location_function(name, cloud_function_object = 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::CloudfunctionsV1::CloudFunction::Representation command.request_object = cloud_function_object command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation command.response_class = Google::Apis::CloudfunctionsV1::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 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 google-api-client-0.19.8/generated/google/apis/adexchangeseller_v1/0000755000004100000410000000000013252673043025217 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/adexchangeseller_v1/representations.rb0000644000004100000410000002036713252673043031001 0ustar www-datawww-data# 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 AdexchangesellerV1 class AdClient class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdClients class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdUnit class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdUnits class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomChannel class Representation < Google::Apis::Core::JsonRepresentation; end class TargetingInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class CustomChannels class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Report class Representation < Google::Apis::Core::JsonRepresentation; end class Header class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class SavedReport class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SavedReports class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlChannel class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlChannels class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdClient # @private class Representation < Google::Apis::Core::JsonRepresentation property :arc_opt_in, as: 'arcOptIn' property :id, as: 'id' property :kind, as: 'kind' property :product_code, as: 'productCode' property :supports_reporting, as: 'supportsReporting' end end class AdClients # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1::AdClient, decorator: Google::Apis::AdexchangesellerV1::AdClient::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class AdUnit # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :status, as: 'status' end end class AdUnits # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1::AdUnit, decorator: Google::Apis::AdexchangesellerV1::AdUnit::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CustomChannel # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :targeting_info, as: 'targetingInfo', class: Google::Apis::AdexchangesellerV1::CustomChannel::TargetingInfo, decorator: Google::Apis::AdexchangesellerV1::CustomChannel::TargetingInfo::Representation end class TargetingInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :ads_appear_on, as: 'adsAppearOn' property :description, as: 'description' property :location, as: 'location' property :site_language, as: 'siteLanguage' end end end class CustomChannels # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1::CustomChannel, decorator: Google::Apis::AdexchangesellerV1::CustomChannel::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Report # @private class Representation < Google::Apis::Core::JsonRepresentation collection :averages, as: 'averages' collection :headers, as: 'headers', class: Google::Apis::AdexchangesellerV1::Report::Header, decorator: Google::Apis::AdexchangesellerV1::Report::Header::Representation property :kind, as: 'kind' collection :rows, as: 'rows', :class => Array do include Representable::JSON::Collection items end property :total_matched_rows, :numeric_string => true, as: 'totalMatchedRows' collection :totals, as: 'totals' collection :warnings, as: 'warnings' end class Header # @private class Representation < Google::Apis::Core::JsonRepresentation property :currency, as: 'currency' property :name, as: 'name' property :type, as: 'type' end end end class SavedReport # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class SavedReports # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1::SavedReport, decorator: Google::Apis::AdexchangesellerV1::SavedReport::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class UrlChannel # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :url_pattern, as: 'urlPattern' end end class UrlChannels # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1::UrlChannel, decorator: Google::Apis::AdexchangesellerV1::UrlChannel::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end end end end google-api-client-0.19.8/generated/google/apis/adexchangeseller_v1/classes.rb0000644000004100000410000004754713252673043027222 0ustar www-datawww-data# 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 AdexchangesellerV1 # class AdClient include Google::Apis::Core::Hashable # Whether this ad client is opted in to ARC. # Corresponds to the JSON property `arcOptIn` # @return [Boolean] attr_accessor :arc_opt_in alias_method :arc_opt_in?, :arc_opt_in # Unique identifier of this ad client. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#adClient. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This ad client's product code, which corresponds to the PRODUCT_CODE report # dimension. # Corresponds to the JSON property `productCode` # @return [String] attr_accessor :product_code # Whether this ad client supports being reported on. # Corresponds to the JSON property `supportsReporting` # @return [Boolean] attr_accessor :supports_reporting alias_method :supports_reporting?, :supports_reporting def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @arc_opt_in = args[:arc_opt_in] if args.key?(:arc_opt_in) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @product_code = args[:product_code] if args.key?(:product_code) @supports_reporting = args[:supports_reporting] if args.key?(:supports_reporting) end end # class AdClients include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ad clients returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#adClients. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through ad clients. To retrieve the next page # of results, set the next request's "pageToken" value to this. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # class AdUnit include Google::Apis::Core::Hashable # Identity code of this ad unit, not necessarily unique across ad clients. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # Unique identifier of this ad unit. This should be considered an opaque # identifier; it is not safe to rely on it being in any particular format. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#adUnit. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this ad unit. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Status of this ad unit. Possible values are: # NEW: Indicates that the ad unit was created within the last seven days and # does not yet have any activity associated with it. # ACTIVE: Indicates that there has been activity on this ad unit in the last # seven days. # INACTIVE: Indicates that there has been no activity on this ad unit in the # last seven days. # 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) @code = args[:code] if args.key?(:code) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @status = args[:status] if args.key?(:status) end end # class AdUnits include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ad units returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#adUnits. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through ad units. To retrieve the next page of # results, set the next request's "pageToken" value to this. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # class CustomChannel include Google::Apis::Core::Hashable # Code of this custom channel, not necessarily unique across ad clients. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # Unique identifier of this custom channel. This should be considered an opaque # identifier; it is not safe to rely on it being in any particular format. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#customChannel. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this custom channel. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The targeting information of this custom channel, if activated. # Corresponds to the JSON property `targetingInfo` # @return [Google::Apis::AdexchangesellerV1::CustomChannel::TargetingInfo] attr_accessor :targeting_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @code = args[:code] if args.key?(:code) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @targeting_info = args[:targeting_info] if args.key?(:targeting_info) end # The targeting information of this custom channel, if activated. class TargetingInfo include Google::Apis::Core::Hashable # The name used to describe this channel externally. # Corresponds to the JSON property `adsAppearOn` # @return [String] attr_accessor :ads_appear_on # The external description of the channel. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The locations in which ads appear. (Only valid for content and mobile content # ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, # MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, # BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: # TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The language of the sites ads will be displayed on. # Corresponds to the JSON property `siteLanguage` # @return [String] attr_accessor :site_language def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ads_appear_on = args[:ads_appear_on] if args.key?(:ads_appear_on) @description = args[:description] if args.key?(:description) @location = args[:location] if args.key?(:location) @site_language = args[:site_language] if args.key?(:site_language) end end end # class CustomChannels include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The custom channels returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#customChannels. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through custom channels. To retrieve the next # page of results, set the next request's "pageToken" value to this. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # class Report include Google::Apis::Core::Hashable # The averages of the report. This is the same length as any other row in the # report; cells corresponding to dimension columns are empty. # Corresponds to the JSON property `averages` # @return [Array] attr_accessor :averages # The header information of the columns requested in the report. This is a list # of headers; one for each dimension in the request, followed by one for each # metric in the request. # Corresponds to the JSON property `headers` # @return [Array] attr_accessor :headers # Kind this is, in this case adexchangeseller#report. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The output rows of the report. Each row is a list of cells; one for each # dimension in the request, followed by one for each metric in the request. The # dimension cells contain strings, and the metric cells contain numbers. # Corresponds to the JSON property `rows` # @return [Array>] attr_accessor :rows # The total number of rows matched by the report request. Fewer rows may be # returned in the response due to being limited by the row count requested or # the report row limit. # Corresponds to the JSON property `totalMatchedRows` # @return [Fixnum] attr_accessor :total_matched_rows # The totals of the report. This is the same length as any other row in the # report; cells corresponding to dimension columns are empty. # Corresponds to the JSON property `totals` # @return [Array] attr_accessor :totals # Any warnings associated with generation of the report. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @averages = args[:averages] if args.key?(:averages) @headers = args[:headers] if args.key?(:headers) @kind = args[:kind] if args.key?(:kind) @rows = args[:rows] if args.key?(:rows) @total_matched_rows = args[:total_matched_rows] if args.key?(:total_matched_rows) @totals = args[:totals] if args.key?(:totals) @warnings = args[:warnings] if args.key?(:warnings) end # class Header include Google::Apis::Core::Hashable # The currency of this column. Only present if the header type is # METRIC_CURRENCY. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency # The name of the header. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or # METRIC_CURRENCY. # 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) @currency = args[:currency] if args.key?(:currency) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) end end end # class SavedReport include Google::Apis::Core::Hashable # Unique identifier of this saved report. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#savedReport. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This saved report's name. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # class SavedReports include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The saved reports returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#savedReports. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through saved reports. To retrieve the next # page of results, set the next request's "pageToken" value to this. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # class UrlChannel include Google::Apis::Core::Hashable # Unique identifier of this URL channel. This should be considered an opaque # identifier; it is not safe to rely on it being in any particular format. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Kind of resource this is, in this case adexchangeseller#urlChannel. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # URL Pattern of this URL channel. Does not include "http://" or "https://". # Example: www.example.com/home # Corresponds to the JSON property `urlPattern` # @return [String] attr_accessor :url_pattern def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @url_pattern = args[:url_pattern] if args.key?(:url_pattern) end end # class UrlChannels include Google::Apis::Core::Hashable # ETag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The URL channels returned in this list response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Kind of list this is, in this case adexchangeseller#urlChannels. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through URL channels. To retrieve the next # page of results, set the next request's "pageToken" value to this. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end end end end google-api-client-0.19.8/generated/google/apis/adexchangeseller_v1/service.rb0000644000004100000410000010174013252673043027207 0ustar www-datawww-data# 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 AdexchangesellerV1 # Ad Exchange Seller API # # Accesses the inventory of Ad Exchange seller users and generates reports. # # @example # require 'google/apis/adexchangeseller_v1' # # Adexchangeseller = Google::Apis::AdexchangesellerV1 # Alias the module # service = Adexchangeseller::AdExchangeSellerService.new # # @see https://developers.google.com/ad-exchange/seller-rest/ class AdExchangeSellerService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'adexchangeseller/v1/') @batch_path = 'batch/adexchangeseller/v1' end # List all ad clients in this Ad Exchange account. # @param [Fixnum] max_results # The maximum number of ad clients to include in the response, used for paging. # @param [String] page_token # A continuation token, used to page through ad clients. To retrieve the next # page, set this parameter to the value of "nextPageToken" from the previous # 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::AdClients] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::AdClients] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_adclients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'adclients', options) command.response_representation = Google::Apis::AdexchangesellerV1::AdClients::Representation command.response_class = Google::Apis::AdexchangesellerV1::AdClients command.query['maxResults'] = max_results unless max_results.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 # Gets the specified ad unit in the specified ad client. # @param [String] ad_client_id # Ad client for which to get the ad unit. # @param [String] ad_unit_id # Ad unit to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::AdUnit] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::AdUnit] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_adunit(ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}', options) command.response_representation = Google::Apis::AdexchangesellerV1::AdUnit::Representation command.response_class = Google::Apis::AdexchangesellerV1::AdUnit command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.params['adUnitId'] = ad_unit_id unless ad_unit_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 # List all ad units in the specified ad client for this Ad Exchange account. # @param [String] ad_client_id # Ad client for which to list ad units. # @param [Boolean] include_inactive # Whether to include inactive ad units. Default: true. # @param [Fixnum] max_results # The maximum number of ad units to include in the response, used for paging. # @param [String] page_token # A continuation token, used to page through ad units. To retrieve the next page, # set this parameter to the value of "nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::AdUnits] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::AdUnits] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_adunits(ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'adclients/{adClientId}/adunits', options) command.response_representation = Google::Apis::AdexchangesellerV1::AdUnits::Representation command.response_class = Google::Apis::AdexchangesellerV1::AdUnits command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.query['includeInactive'] = include_inactive unless include_inactive.nil? command.query['maxResults'] = max_results unless max_results.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 # List all custom channels which the specified ad unit belongs to. # @param [String] ad_client_id # Ad client which contains the ad unit. # @param [String] ad_unit_id # Ad unit for which to list custom channels. # @param [Fixnum] max_results # The maximum number of custom channels to include in the response, used for # paging. # @param [String] page_token # A continuation token, used to page through custom channels. To retrieve the # next page, set this parameter to the value of "nextPageToken" from the # previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::CustomChannels] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::CustomChannels] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_adunit_customchannels(ad_client_id, ad_unit_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}/customchannels', options) command.response_representation = Google::Apis::AdexchangesellerV1::CustomChannels::Representation command.response_class = Google::Apis::AdexchangesellerV1::CustomChannels command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil? command.query['maxResults'] = max_results unless max_results.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 # Get the specified custom channel from the specified ad client. # @param [String] ad_client_id # Ad client which contains the custom channel. # @param [String] custom_channel_id # Custom channel to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::CustomChannel] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::CustomChannel] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_customchannel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}', options) command.response_representation = Google::Apis::AdexchangesellerV1::CustomChannel::Representation command.response_class = Google::Apis::AdexchangesellerV1::CustomChannel command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.params['customChannelId'] = custom_channel_id unless custom_channel_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 # List all custom channels in the specified ad client for this Ad Exchange # account. # @param [String] ad_client_id # Ad client for which to list custom channels. # @param [Fixnum] max_results # The maximum number of custom channels to include in the response, used for # paging. # @param [String] page_token # A continuation token, used to page through custom channels. To retrieve the # next page, set this parameter to the value of "nextPageToken" from the # previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::CustomChannels] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::CustomChannels] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_customchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'adclients/{adClientId}/customchannels', options) command.response_representation = Google::Apis::AdexchangesellerV1::CustomChannels::Representation command.response_class = Google::Apis::AdexchangesellerV1::CustomChannels command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.query['maxResults'] = max_results unless max_results.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 # List all ad units in the specified custom channel. # @param [String] ad_client_id # Ad client which contains the custom channel. # @param [String] custom_channel_id # Custom channel for which to list ad units. # @param [Boolean] include_inactive # Whether to include inactive ad units. Default: true. # @param [Fixnum] max_results # The maximum number of ad units to include in the response, used for paging. # @param [String] page_token # A continuation token, used to page through ad units. To retrieve the next page, # set this parameter to the value of "nextPageToken" from the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::AdUnits] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::AdUnits] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_customchannel_adunits(ad_client_id, custom_channel_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}/adunits', options) command.response_representation = Google::Apis::AdexchangesellerV1::AdUnits::Representation command.response_class = Google::Apis::AdexchangesellerV1::AdUnits command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.params['customChannelId'] = custom_channel_id unless custom_channel_id.nil? command.query['includeInactive'] = include_inactive unless include_inactive.nil? command.query['maxResults'] = max_results unless max_results.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 # Generate an Ad Exchange report based on the report request sent in the query # parameters. Returns the result as JSON; to retrieve output in CSV format # specify "alt=csv" as a query parameter. # @param [String] start_date # Start of the date range to report on in "YYYY-MM-DD" format, inclusive. # @param [String] end_date # End of the date range to report on in "YYYY-MM-DD" format, inclusive. # @param [Array, String] dimension # Dimensions to base the report on. # @param [Array, String] filter # Filters to be run on the report. # @param [String] locale # Optional locale to use for translating report output to a local language. # Defaults to "en_US" if not specified. # @param [Fixnum] max_results # The maximum number of rows of report data to return. # @param [Array, String] metric # Numeric columns to include in the report. # @param [Array, String] sort # The name of a dimension or metric to sort the resulting report on, optionally # prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is # specified, the column is sorted ascending. # @param [Fixnum] start_index # Index of the first row of report data to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report(start_date, end_date, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'reports', options) else command = make_download_command(:get, 'reports', options) command.download_dest = download_dest end command.response_representation = Google::Apis::AdexchangesellerV1::Report::Representation command.response_class = Google::Apis::AdexchangesellerV1::Report command.query['dimension'] = dimension unless dimension.nil? command.query['endDate'] = end_date unless end_date.nil? command.query['filter'] = filter unless filter.nil? command.query['locale'] = locale unless locale.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['metric'] = metric unless metric.nil? command.query['sort'] = sort unless sort.nil? command.query['startDate'] = start_date unless start_date.nil? command.query['startIndex'] = start_index unless start_index.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 # Generate an Ad Exchange report based on the saved report ID sent in the query # parameters. # @param [String] saved_report_id # The saved report to retrieve. # @param [String] locale # Optional locale to use for translating report output to a local language. # Defaults to "en_US" if not specified. # @param [Fixnum] max_results # The maximum number of rows of report data to return. # @param [Fixnum] start_index # Index of the first row of report data to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report_saved(saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'reports/{savedReportId}', options) command.response_representation = Google::Apis::AdexchangesellerV1::Report::Representation command.response_class = Google::Apis::AdexchangesellerV1::Report command.params['savedReportId'] = saved_report_id unless saved_report_id.nil? command.query['locale'] = locale unless locale.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['startIndex'] = start_index unless start_index.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 saved reports in this Ad Exchange account. # @param [Fixnum] max_results # The maximum number of saved reports to include in the response, used for # paging. # @param [String] page_token # A continuation token, used to page through saved reports. To retrieve the next # page, set this parameter to the value of "nextPageToken" from the previous # 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::SavedReports] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::SavedReports] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report_saveds(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'reports/saved', options) command.response_representation = Google::Apis::AdexchangesellerV1::SavedReports::Representation command.response_class = Google::Apis::AdexchangesellerV1::SavedReports command.query['maxResults'] = max_results unless max_results.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 # List all URL channels in the specified ad client for this Ad Exchange account. # @param [String] ad_client_id # Ad client for which to list URL channels. # @param [Fixnum] max_results # The maximum number of URL channels to include in the response, used for paging. # @param [String] page_token # A continuation token, used to page through URL channels. To retrieve the next # page, set this parameter to the value of "nextPageToken" from the previous # 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AdexchangesellerV1::UrlChannels] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AdexchangesellerV1::UrlChannels] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_urlchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'adclients/{adClientId}/urlchannels', options) command.response_representation = Google::Apis::AdexchangesellerV1::UrlChannels::Representation command.response_class = Google::Apis::AdexchangesellerV1::UrlChannels command.params['adClientId'] = ad_client_id unless ad_client_id.nil? command.query['maxResults'] = max_results unless max_results.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 protected 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 end end google-api-client-0.19.8/generated/google/apis/compute_alpha/0000755000004100000410000000000013252673043024134 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/compute_alpha/representations.rb0000644000004100000410000141225113252673043027714 0ustar www-datawww-data# 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 ComputeAlpha class AcceleratorConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AcceleratorType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AcceleratorTypeAggregatedList 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 AcceleratorTypeList 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 AcceleratorTypesScopedList 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 AccessConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Address class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AddressAggregatedList 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 AddressList 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 AddressesScopedList 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 AliasIpRange class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AttachedDisk class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AttachedDiskInitializeParams class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditLogConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthorizationLoggingOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Autoscaler class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AutoscalerAggregatedList 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 AutoscalerList 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 AutoscalerStatusDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AutoscalersScopedList 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 AutoscalingPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AutoscalingPolicyCpuUtilization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AutoscalingPolicyCustomMetricUtilization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AutoscalingPolicyLoadBalancingUtilization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AutoscalingPolicyQueueBasedScaling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AutoscalingPolicyQueueBasedScalingCloudPubSub class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Backend class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendBucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendBucketCdnPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendBucketList 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 BackendService class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendServiceAggregatedList 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 BackendServiceAppEngineBackend class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendServiceCdnPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendServiceCloudFunctionBackend class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendServiceFailoverPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendServiceGroupHealth class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendServiceIap class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendServiceList 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 BackendServiceReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendServicesScopedList 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 Binding class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CacheInvalidationRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CacheKeyPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Commitment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CommitmentAggregatedList 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 CommitmentList 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 CommitmentsScopedList 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 Condition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConnectionDraining class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomerEncryptionKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomerEncryptionKeyProtectedDisk class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DailyMaintenanceWindow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeprecationStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Disk class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DiskAggregatedList 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 DiskInstantiationConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DiskList 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 DiskMoveRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DiskType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DiskTypeAggregatedList 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 DiskTypeList 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 DiskTypesScopedList 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 DisksResizeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DisksScopedList 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 DistributionPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DistributionPolicyZoneConfiguration 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 Firewall class Representation < Google::Apis::Core::JsonRepresentation; end class Allowed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Denied class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class FirewallList 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 FixedOrPercent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ForwardingRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ForwardingRuleAggregatedList 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 ForwardingRuleList 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 ForwardingRuleReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ForwardingRulesScopedList 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 GlobalSetLabelsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GuestAttributes class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GuestOsFeature class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Http2HealthCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpHealthCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpsHealthCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HealthCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HealthCheckList 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 HealthCheckReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HealthStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HealthStatusForNetworkEndpoint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Host class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HostAggregatedList 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 HostList 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 HostRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HostType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HostTypeAggregatedList 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 HostTypeList 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 HostTypesScopedList 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 HostsScopedList 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 HourlyMaintenanceWindow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpHealthCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpHealthCheckList 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 HttpsHealthCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpsHealthCheckList 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 Image class Representation < Google::Apis::Core::JsonRepresentation; end class RawDisk class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ImageList 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 Instance class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceAggregatedList 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 InstanceGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupAggregatedList 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 InstanceGroupList 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 InstanceGroupManager class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagerActionsSummary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagerActivities class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagerAggregatedList 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 InstanceGroupManagerAutoHealingPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagerList 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 InstanceGroupManagerPendingActionsSummary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagerUpdatePolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagerVersion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersAbandonInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersApplyUpdatesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersDeleteInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersDeletePerInstanceConfigsReq class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersListManagedInstancesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersListPerInstanceConfigsResp 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 InstanceGroupManagersRecreateInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersResizeAdvancedRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersScopedList 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 InstanceGroupManagersSetAutoHealingRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersSetInstanceTemplateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersSetTargetPoolsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupManagersUpdatePerInstanceConfigsReq class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupsAddInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupsListInstances 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 InstanceGroupsListInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupsRemoveInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceGroupsScopedList 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 InstanceGroupsSetNamedPortsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceList 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 InstanceListReferrers 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 InstanceMoveRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceTemplate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceTemplateList 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 InstanceWithNamedPorts class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesAddMaintenancePoliciesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesRemoveMaintenancePoliciesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesResumeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesScopedList 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 InstancesSetLabelsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesSetMachineResourcesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesSetMachineTypeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesSetMinCpuPlatformRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesSetServiceAccountRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstancesStartWithEncryptionKeyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Interconnect class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InterconnectAttachment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InterconnectAttachmentAggregatedList 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 InterconnectAttachmentList 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 InterconnectAttachmentPartnerMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InterconnectAttachmentPrivateInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InterconnectAttachmentsScopedList 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 InterconnectCircuitInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InterconnectList 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 InterconnectLocation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InterconnectLocationList 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 InterconnectLocationRegionInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InterconnectOutageNotification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InternalIpOwner class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IpOwnerList 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 License class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LicenseCode class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LicenseCodeLicenseAlias class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LicenseResourceRequirements class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LicensesListResponse 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 LogConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfigCloudAuditOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfigCounterOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogConfigDataAccessOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MachineType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MachineTypeAggregatedList 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 MachineTypeList 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 MachineTypesScopedList 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 MaintenancePoliciesList 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 MaintenancePoliciesScopedList 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 MaintenancePolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MaintenancePolicyAggregatedList 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 MaintenanceWindow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedInstance class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedInstanceLastAttempt class Representation < Google::Apis::Core::JsonRepresentation; end class Errors class Representation < Google::Apis::Core::JsonRepresentation; end class Error 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 ManagedInstanceOverride class Representation < Google::Apis::Core::JsonRepresentation; end class Metadatum class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ManagedInstanceOverrideDiskOverride class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ManagedInstanceVersion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Metadata class Representation < Google::Apis::Core::JsonRepresentation; end class Item class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class NamedPort class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Network class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkEndpoint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkEndpointGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkEndpointGroupAggregatedList 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 NetworkEndpointGroupLbNetworkEndpointGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkEndpointGroupList 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 NetworkEndpointGroupsAttachEndpointsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkEndpointGroupsDetachEndpointsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkEndpointGroupsListEndpointsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkEndpointGroupsListNetworkEndpoints 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 NetworkEndpointGroupsScopedList 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 NetworkEndpointWithHealthStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkInterface class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkList 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 NetworkPeering class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkRoutingConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworksAddPeeringRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworksRemovePeeringRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Operation class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport 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 OperationAggregatedList 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 OperationList 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 OperationsScopedList 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 PathMatcher class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PathRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PerInstanceConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Project class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectsDisableXpnResourceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectsEnableXpnResourceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectsGetXpnResources class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectsListXpnHostsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectsSetDefaultNetworkTierRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectsSetDefaultServiceAccountRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Quota class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Reference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Region class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionAutoscalerList 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 RegionDiskTypeList 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 RegionDisksResizeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupList 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 RegionInstanceGroupManagerDeleteInstanceConfigReq class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupManagerList 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 RegionInstanceGroupManagerUpdateInstanceConfigReq class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupManagersAbandonInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupManagersApplyUpdatesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupManagersDeleteInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupManagersListInstanceConfigsResp 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 RegionInstanceGroupManagersListInstancesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupManagersRecreateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupManagersSetAutoHealingRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupManagersSetTargetPoolsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupManagersSetTemplateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupsListInstances 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 RegionInstanceGroupsListInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionInstanceGroupsSetNamedPortsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionList 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 RegionSetLabelsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceCommitment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceGroupReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Route 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 RouteList 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 Router class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterAdvertisedIpRange class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterAdvertisedPrefix class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterAggregatedList 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 RouterBgp class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterBgpPeer class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterInterface class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterList 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 RouterNat class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterNatSubnetworkToNat class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterStatusBgpPeerStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterStatusNatStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RouterStatusResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoutersPreviewResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoutersScopedList 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 Rule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SslHealthCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Scheduling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SecurityPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SecurityPolicyList 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 SecurityPolicyReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SecurityPolicyRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SecurityPolicyRuleMatcher class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SecurityPolicyRuleMatcherConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SerialPortOutput class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceAccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShieldedVmConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SignedUrlKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Snapshot class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SnapshotList 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 SourceInstanceParams class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SslCertificate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SslCertificateList 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 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 SslPoliciesList 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 SslPoliciesListAvailableFeaturesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SslPolicy 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 SslPolicyReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StatefulPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StatefulPolicyPreservedDisk class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StatefulPolicyPreservedResources class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Subnetwork class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SubnetworkAggregatedList 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 SubnetworkList 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 SubnetworkSecondaryRange class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SubnetworksExpandIpCidrRangeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SubnetworksScopedList 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 SubnetworksSetPrivateIpGoogleAccessRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TcpHealthCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Tags class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetHttpProxy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetHttpProxyList 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 TargetHttpsProxiesSetQuicOverrideRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetHttpsProxiesSetSslCertificatesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetHttpsProxy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetHttpsProxyList 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 TargetInstance class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetInstanceAggregatedList 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 TargetInstanceList 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 TargetInstancesScopedList 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 TargetPool class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetPoolAggregatedList 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 TargetPoolInstanceHealth class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetPoolList 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 TargetPoolsAddHealthCheckRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetPoolsAddInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetPoolsRemoveHealthCheckRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetPoolsRemoveInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetPoolsScopedList 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 TargetReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetSslProxiesSetBackendServiceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetSslProxiesSetProxyHeaderRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetSslProxiesSetSslCertificatesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetSslProxy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetSslProxyList 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 TargetTcpProxiesSetBackendServiceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetTcpProxiesSetProxyHeaderRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetTcpProxy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetTcpProxyList 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 TargetVpnGateway class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetVpnGatewayAggregatedList 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 TargetVpnGatewayList 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 TargetVpnGatewaysScopedList 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 TestFailure class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UdpHealthCheck class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlMap class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlMapList 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 UrlMapReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlMapTest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlMapValidationResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlMapsValidateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UrlMapsValidateResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UsableSubnetwork class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UsableSubnetworksAggregatedList 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 UsageExportLocation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VmMaintenancePolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VpnTunnel class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VpnTunnelAggregatedList 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 VpnTunnelList 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 VpnTunnelsScopedList 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 XpnHostList 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 XpnResourceId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Zone class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ZoneList 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 ZoneSetLabelsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AcceleratorConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :accelerator_count, as: 'acceleratorCount' property :accelerator_type, as: 'acceleratorType' end end class AcceleratorType # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :deprecated, as: 'deprecated', class: Google::Apis::ComputeAlpha::DeprecationStatus, decorator: Google::Apis::ComputeAlpha::DeprecationStatus::Representation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :maximum_cards_per_instance, as: 'maximumCardsPerInstance' property :name, as: 'name' property :self_link, as: 'selfLink' property :zone, as: 'zone' end end class AcceleratorTypeAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::AcceleratorTypesScopedList, decorator: Google::Apis::ComputeAlpha::AcceleratorTypesScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList::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 AcceleratorTypeList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::AcceleratorType, decorator: Google::Apis::ComputeAlpha::AcceleratorType::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AcceleratorTypeList::Warning, decorator: Google::Apis::ComputeAlpha::AcceleratorTypeList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::AcceleratorTypeList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::AcceleratorTypeList::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 AcceleratorTypesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accelerator_types, as: 'acceleratorTypes', class: Google::Apis::ComputeAlpha::AcceleratorType, decorator: Google::Apis::ComputeAlpha::AcceleratorType::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AcceleratorTypesScopedList::Warning, decorator: Google::Apis::ComputeAlpha::AcceleratorTypesScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::AcceleratorTypesScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::AcceleratorTypesScopedList::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 AccessConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :name, as: 'name' property :nat_ip, as: 'natIP' property :network_tier, as: 'networkTier' property :public_dns_name, as: 'publicDnsName' property :public_ptr_domain_name, as: 'publicPtrDomainName' property :set_public_dns, as: 'setPublicDns' property :set_public_ptr, as: 'setPublicPtr' property :type, as: 'type' end end class Address # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address' property :address_type, as: 'addressType' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :ip_version, as: 'ipVersion' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' property :name, as: 'name' property :network_tier, as: 'networkTier' property :region, as: 'region' property :self_link, as: 'selfLink' property :status, as: 'status' property :subnetwork, as: 'subnetwork' collection :users, as: 'users' end end class AddressAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::AddressesScopedList, decorator: Google::Apis::ComputeAlpha::AddressesScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AddressAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::AddressAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::AddressAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::AddressAggregatedList::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 AddressList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Address, decorator: Google::Apis::ComputeAlpha::Address::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AddressList::Warning, decorator: Google::Apis::ComputeAlpha::AddressList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::AddressList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::AddressList::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 AddressesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :addresses, as: 'addresses', class: Google::Apis::ComputeAlpha::Address, decorator: Google::Apis::ComputeAlpha::Address::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AddressesScopedList::Warning, decorator: Google::Apis::ComputeAlpha::AddressesScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::AddressesScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::AddressesScopedList::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 AliasIpRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_cidr_range, as: 'ipCidrRange' property :subnetwork_range_name, as: 'subnetworkRangeName' end end class AttachedDisk # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_delete, as: 'autoDelete' property :boot, as: 'boot' property :device_name, as: 'deviceName' property :disk_encryption_key, as: 'diskEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :disk_size_gb, :numeric_string => true, as: 'diskSizeGb' collection :guest_os_features, as: 'guestOsFeatures', class: Google::Apis::ComputeAlpha::GuestOsFeature, decorator: Google::Apis::ComputeAlpha::GuestOsFeature::Representation property :index, as: 'index' property :initialize_params, as: 'initializeParams', class: Google::Apis::ComputeAlpha::AttachedDiskInitializeParams, decorator: Google::Apis::ComputeAlpha::AttachedDiskInitializeParams::Representation property :interface, as: 'interface' property :kind, as: 'kind' collection :licenses, as: 'licenses' property :mode, as: 'mode' property :saved_state, as: 'savedState' property :source, as: 'source' property :type, as: 'type' end end class AttachedDiskInitializeParams # @private class Representation < Google::Apis::Core::JsonRepresentation property :disk_name, as: 'diskName' property :disk_size_gb, :numeric_string => true, as: 'diskSizeGb' property :disk_storage_type, as: 'diskStorageType' property :disk_type, as: 'diskType' hash :labels, as: 'labels' property :source_image, as: 'sourceImage' property :source_image_encryption_key, as: 'sourceImageEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation end end class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::ComputeAlpha::AuditLogConfig, decorator: Google::Apis::ComputeAlpha::AuditLogConfig::Representation collection :exempted_members, as: 'exemptedMembers' property :service, as: 'service' end end class AuditLogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exempted_members, as: 'exemptedMembers' property :log_type, as: 'logType' end end class AuthorizationLoggingOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :permission_type, as: 'permissionType' end end class Autoscaler # @private class Representation < Google::Apis::Core::JsonRepresentation property :autoscaling_policy, as: 'autoscalingPolicy', class: Google::Apis::ComputeAlpha::AutoscalingPolicy, decorator: Google::Apis::ComputeAlpha::AutoscalingPolicy::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' property :recommended_size, as: 'recommendedSize' property :region, as: 'region' property :self_link, as: 'selfLink' property :status, as: 'status' collection :status_details, as: 'statusDetails', class: Google::Apis::ComputeAlpha::AutoscalerStatusDetails, decorator: Google::Apis::ComputeAlpha::AutoscalerStatusDetails::Representation property :target, as: 'target' property :zone, as: 'zone' end end class AutoscalerAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::AutoscalersScopedList, decorator: Google::Apis::ComputeAlpha::AutoscalersScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AutoscalerAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::AutoscalerAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::AutoscalerAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::AutoscalerAggregatedList::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 AutoscalerList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Autoscaler, decorator: Google::Apis::ComputeAlpha::Autoscaler::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AutoscalerList::Warning, decorator: Google::Apis::ComputeAlpha::AutoscalerList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::AutoscalerList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::AutoscalerList::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 AutoscalerStatusDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :message, as: 'message' property :type, as: 'type' end end class AutoscalersScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :autoscalers, as: 'autoscalers', class: Google::Apis::ComputeAlpha::Autoscaler, decorator: Google::Apis::ComputeAlpha::Autoscaler::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AutoscalersScopedList::Warning, decorator: Google::Apis::ComputeAlpha::AutoscalersScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::AutoscalersScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::AutoscalersScopedList::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 AutoscalingPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :cool_down_period_sec, as: 'coolDownPeriodSec' property :cpu_utilization, as: 'cpuUtilization', class: Google::Apis::ComputeAlpha::AutoscalingPolicyCpuUtilization, decorator: Google::Apis::ComputeAlpha::AutoscalingPolicyCpuUtilization::Representation collection :custom_metric_utilizations, as: 'customMetricUtilizations', class: Google::Apis::ComputeAlpha::AutoscalingPolicyCustomMetricUtilization, decorator: Google::Apis::ComputeAlpha::AutoscalingPolicyCustomMetricUtilization::Representation property :load_balancing_utilization, as: 'loadBalancingUtilization', class: Google::Apis::ComputeAlpha::AutoscalingPolicyLoadBalancingUtilization, decorator: Google::Apis::ComputeAlpha::AutoscalingPolicyLoadBalancingUtilization::Representation property :max_num_replicas, as: 'maxNumReplicas' property :min_num_replicas, as: 'minNumReplicas' property :mode, as: 'mode' property :queue_based_scaling, as: 'queueBasedScaling', class: Google::Apis::ComputeAlpha::AutoscalingPolicyQueueBasedScaling, decorator: Google::Apis::ComputeAlpha::AutoscalingPolicyQueueBasedScaling::Representation end end class AutoscalingPolicyCpuUtilization # @private class Representation < Google::Apis::Core::JsonRepresentation property :utilization_target, as: 'utilizationTarget' end end class AutoscalingPolicyCustomMetricUtilization # @private class Representation < Google::Apis::Core::JsonRepresentation property :filter, as: 'filter' property :metric, as: 'metric' property :single_instance_assignment, as: 'singleInstanceAssignment' property :utilization_target, as: 'utilizationTarget' property :utilization_target_type, as: 'utilizationTargetType' end end class AutoscalingPolicyLoadBalancingUtilization # @private class Representation < Google::Apis::Core::JsonRepresentation property :utilization_target, as: 'utilizationTarget' end end class AutoscalingPolicyQueueBasedScaling # @private class Representation < Google::Apis::Core::JsonRepresentation property :acceptable_backlog_per_instance, as: 'acceptableBacklogPerInstance' property :cloud_pub_sub, as: 'cloudPubSub', class: Google::Apis::ComputeAlpha::AutoscalingPolicyQueueBasedScalingCloudPubSub, decorator: Google::Apis::ComputeAlpha::AutoscalingPolicyQueueBasedScalingCloudPubSub::Representation property :single_worker_throughput_per_sec, as: 'singleWorkerThroughputPerSec' end end class AutoscalingPolicyQueueBasedScalingCloudPubSub # @private class Representation < Google::Apis::Core::JsonRepresentation property :subscription, as: 'subscription' property :topic, as: 'topic' end end class Backend # @private class Representation < Google::Apis::Core::JsonRepresentation property :balancing_mode, as: 'balancingMode' property :capacity_scaler, as: 'capacityScaler' property :description, as: 'description' property :failover, as: 'failover' property :group, as: 'group' property :max_connections, as: 'maxConnections' property :max_connections_per_endpoint, as: 'maxConnectionsPerEndpoint' property :max_connections_per_instance, as: 'maxConnectionsPerInstance' property :max_rate, as: 'maxRate' property :max_rate_per_endpoint, as: 'maxRatePerEndpoint' property :max_rate_per_instance, as: 'maxRatePerInstance' property :max_utilization, as: 'maxUtilization' end end class BackendBucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_name, as: 'bucketName' property :cdn_policy, as: 'cdnPolicy', class: Google::Apis::ComputeAlpha::BackendBucketCdnPolicy, decorator: Google::Apis::ComputeAlpha::BackendBucketCdnPolicy::Representation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :enable_cdn, as: 'enableCdn' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :self_link, as: 'selfLink' end end class BackendBucketCdnPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :signed_url_cache_max_age_sec, :numeric_string => true, as: 'signedUrlCacheMaxAgeSec' collection :signed_url_key_names, as: 'signedUrlKeyNames' end end class BackendBucketList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::BackendBucket, decorator: Google::Apis::ComputeAlpha::BackendBucket::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::BackendBucketList::Warning, decorator: Google::Apis::ComputeAlpha::BackendBucketList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::BackendBucketList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::BackendBucketList::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 BackendService # @private class Representation < Google::Apis::Core::JsonRepresentation property :affinity_cookie_ttl_sec, as: 'affinityCookieTtlSec' property :app_engine_backend, as: 'appEngineBackend', class: Google::Apis::ComputeAlpha::BackendServiceAppEngineBackend, decorator: Google::Apis::ComputeAlpha::BackendServiceAppEngineBackend::Representation collection :backends, as: 'backends', class: Google::Apis::ComputeAlpha::Backend, decorator: Google::Apis::ComputeAlpha::Backend::Representation property :cdn_policy, as: 'cdnPolicy', class: Google::Apis::ComputeAlpha::BackendServiceCdnPolicy, decorator: Google::Apis::ComputeAlpha::BackendServiceCdnPolicy::Representation property :cloud_function_backend, as: 'cloudFunctionBackend', class: Google::Apis::ComputeAlpha::BackendServiceCloudFunctionBackend, decorator: Google::Apis::ComputeAlpha::BackendServiceCloudFunctionBackend::Representation property :connection_draining, as: 'connectionDraining', class: Google::Apis::ComputeAlpha::ConnectionDraining, decorator: Google::Apis::ComputeAlpha::ConnectionDraining::Representation property :creation_timestamp, as: 'creationTimestamp' collection :custom_request_headers, as: 'customRequestHeaders' property :description, as: 'description' property :enable_cdn, as: 'enableCDN' property :failover_policy, as: 'failoverPolicy', class: Google::Apis::ComputeAlpha::BackendServiceFailoverPolicy, decorator: Google::Apis::ComputeAlpha::BackendServiceFailoverPolicy::Representation property :fingerprint, :base64 => true, as: 'fingerprint' collection :health_checks, as: 'healthChecks' property :iap, as: 'iap', class: Google::Apis::ComputeAlpha::BackendServiceIap, decorator: Google::Apis::ComputeAlpha::BackendServiceIap::Representation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :load_balancing_scheme, as: 'loadBalancingScheme' property :name, as: 'name' property :port, as: 'port' property :port_name, as: 'portName' property :protocol, as: 'protocol' property :region, as: 'region' property :security_policy, as: 'securityPolicy' property :self_link, as: 'selfLink' property :session_affinity, as: 'sessionAffinity' property :timeout_sec, as: 'timeoutSec' end end class BackendServiceAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::BackendServicesScopedList, decorator: Google::Apis::ComputeAlpha::BackendServicesScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::BackendServiceAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::BackendServiceAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::BackendServiceAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::BackendServiceAggregatedList::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 BackendServiceAppEngineBackend # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_engine_service, as: 'appEngineService' property :target_project, as: 'targetProject' property :version, as: 'version' end end class BackendServiceCdnPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :cache_key_policy, as: 'cacheKeyPolicy', class: Google::Apis::ComputeAlpha::CacheKeyPolicy, decorator: Google::Apis::ComputeAlpha::CacheKeyPolicy::Representation property :signed_url_cache_max_age_sec, :numeric_string => true, as: 'signedUrlCacheMaxAgeSec' collection :signed_url_key_names, as: 'signedUrlKeyNames' end end class BackendServiceCloudFunctionBackend # @private class Representation < Google::Apis::Core::JsonRepresentation property :function_name, as: 'functionName' property :target_project, as: 'targetProject' end end class BackendServiceFailoverPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :disable_connection_drain_on_failover, as: 'disableConnectionDrainOnFailover' property :drop_traffic_if_unhealthy, as: 'dropTrafficIfUnhealthy' property :failover_ratio, as: 'failoverRatio' end end class BackendServiceGroupHealth # @private class Representation < Google::Apis::Core::JsonRepresentation collection :health_status, as: 'healthStatus', class: Google::Apis::ComputeAlpha::HealthStatus, decorator: Google::Apis::ComputeAlpha::HealthStatus::Representation property :kind, as: 'kind' end end class BackendServiceIap # @private class Representation < Google::Apis::Core::JsonRepresentation property :enabled, as: 'enabled' property :oauth2_client_id, as: 'oauth2ClientId' property :oauth2_client_secret, as: 'oauth2ClientSecret' property :oauth2_client_secret_sha256, as: 'oauth2ClientSecretSha256' end end class BackendServiceList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::BackendService, decorator: Google::Apis::ComputeAlpha::BackendService::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::BackendServiceList::Warning, decorator: Google::Apis::ComputeAlpha::BackendServiceList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::BackendServiceList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::BackendServiceList::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 BackendServiceReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :backend_service, as: 'backendService' end end class BackendServicesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :backend_services, as: 'backendServices', class: Google::Apis::ComputeAlpha::BackendService, decorator: Google::Apis::ComputeAlpha::BackendService::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::BackendServicesScopedList::Warning, decorator: Google::Apis::ComputeAlpha::BackendServicesScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::BackendServicesScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::BackendServicesScopedList::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 Binding # @private class Representation < Google::Apis::Core::JsonRepresentation property :condition, as: 'condition', class: Google::Apis::ComputeAlpha::Expr, decorator: Google::Apis::ComputeAlpha::Expr::Representation collection :members, as: 'members' property :role, as: 'role' end end class CacheInvalidationRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :host, as: 'host' property :path, as: 'path' end end class CacheKeyPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :include_host, as: 'includeHost' property :include_protocol, as: 'includeProtocol' property :include_query_string, as: 'includeQueryString' collection :query_string_blacklist, as: 'queryStringBlacklist' collection :query_string_whitelist, as: 'queryStringWhitelist' end end class Commitment # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :end_timestamp, as: 'endTimestamp' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :plan, as: 'plan' property :region, as: 'region' collection :resources, as: 'resources', class: Google::Apis::ComputeAlpha::ResourceCommitment, decorator: Google::Apis::ComputeAlpha::ResourceCommitment::Representation property :self_link, as: 'selfLink' property :start_timestamp, as: 'startTimestamp' property :status, as: 'status' property :status_message, as: 'statusMessage' end end class CommitmentAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::CommitmentsScopedList, decorator: Google::Apis::ComputeAlpha::CommitmentsScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::CommitmentAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::CommitmentAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::CommitmentAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::CommitmentAggregatedList::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 CommitmentList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Commitment, decorator: Google::Apis::ComputeAlpha::Commitment::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::CommitmentList::Warning, decorator: Google::Apis::ComputeAlpha::CommitmentList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::CommitmentList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::CommitmentList::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 CommitmentsScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :commitments, as: 'commitments', class: Google::Apis::ComputeAlpha::Commitment, decorator: Google::Apis::ComputeAlpha::Commitment::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::CommitmentsScopedList::Warning, decorator: Google::Apis::ComputeAlpha::CommitmentsScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::CommitmentsScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::CommitmentsScopedList::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 Condition # @private class Representation < Google::Apis::Core::JsonRepresentation property :iam, as: 'iam' property :op, as: 'op' property :svc, as: 'svc' property :sys, as: 'sys' property :value, as: 'value' collection :values, as: 'values' end end class ConnectionDraining # @private class Representation < Google::Apis::Core::JsonRepresentation property :draining_timeout_sec, as: 'drainingTimeoutSec' end end class CustomerEncryptionKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :kms_key_name, as: 'kmsKeyName' property :raw_key, as: 'rawKey' property :rsa_encrypted_key, as: 'rsaEncryptedKey' property :sha256, as: 'sha256' end end class CustomerEncryptionKeyProtectedDisk # @private class Representation < Google::Apis::Core::JsonRepresentation property :disk_encryption_key, as: 'diskEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :source, as: 'source' end end class DailyMaintenanceWindow # @private class Representation < Google::Apis::Core::JsonRepresentation property :days_in_cycle, as: 'daysInCycle' property :duration, as: 'duration' property :start_time, as: 'startTime' end end class DeprecationStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :deleted, as: 'deleted' property :deprecated, as: 'deprecated' property :obsolete, as: 'obsolete' property :replacement, as: 'replacement' property :state, as: 'state' end end class Disk # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :disk_encryption_key, as: 'diskEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation collection :guest_os_features, as: 'guestOsFeatures', class: Google::Apis::ComputeAlpha::GuestOsFeature, decorator: Google::Apis::ComputeAlpha::GuestOsFeature::Representation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' property :last_attach_timestamp, as: 'lastAttachTimestamp' property :last_detach_timestamp, as: 'lastDetachTimestamp' collection :license_codes, as: 'licenseCodes' collection :licenses, as: 'licenses' property :name, as: 'name' property :options, as: 'options' property :physical_block_size_bytes, :numeric_string => true, as: 'physicalBlockSizeBytes' property :region, as: 'region' collection :replica_zones, as: 'replicaZones' property :self_link, as: 'selfLink' property :size_gb, :numeric_string => true, as: 'sizeGb' property :source_image, as: 'sourceImage' property :source_image_encryption_key, as: 'sourceImageEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :source_image_id, as: 'sourceImageId' property :source_snapshot, as: 'sourceSnapshot' property :source_snapshot_encryption_key, as: 'sourceSnapshotEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :source_snapshot_id, as: 'sourceSnapshotId' property :status, as: 'status' property :storage_type, as: 'storageType' property :type, as: 'type' collection :users, as: 'users' property :zone, as: 'zone' end end class DiskAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::DisksScopedList, decorator: Google::Apis::ComputeAlpha::DisksScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::DiskAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::DiskAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::DiskAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::DiskAggregatedList::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 DiskInstantiationConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_delete, as: 'autoDelete' property :custom_image, as: 'customImage' property :device_name, as: 'deviceName' property :instantiate_from, as: 'instantiateFrom' end end class DiskList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Disk, decorator: Google::Apis::ComputeAlpha::Disk::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::DiskList::Warning, decorator: Google::Apis::ComputeAlpha::DiskList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::DiskList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::DiskList::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 DiskMoveRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination_zone, as: 'destinationZone' property :target_disk, as: 'targetDisk' end end class DiskType # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :default_disk_size_gb, :numeric_string => true, as: 'defaultDiskSizeGb' property :deprecated, as: 'deprecated', class: Google::Apis::ComputeAlpha::DeprecationStatus, decorator: Google::Apis::ComputeAlpha::DeprecationStatus::Representation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :self_link, as: 'selfLink' property :valid_disk_size, as: 'validDiskSize' property :zone, as: 'zone' end end class DiskTypeAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::DiskTypesScopedList, decorator: Google::Apis::ComputeAlpha::DiskTypesScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::DiskTypeAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::DiskTypeAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::DiskTypeAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::DiskTypeAggregatedList::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 DiskTypeList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::DiskType, decorator: Google::Apis::ComputeAlpha::DiskType::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::DiskTypeList::Warning, decorator: Google::Apis::ComputeAlpha::DiskTypeList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::DiskTypeList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::DiskTypeList::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 DiskTypesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :disk_types, as: 'diskTypes', class: Google::Apis::ComputeAlpha::DiskType, decorator: Google::Apis::ComputeAlpha::DiskType::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::DiskTypesScopedList::Warning, decorator: Google::Apis::ComputeAlpha::DiskTypesScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::DiskTypesScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::DiskTypesScopedList::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 DisksResizeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :size_gb, :numeric_string => true, as: 'sizeGb' end end class DisksScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :disks, as: 'disks', class: Google::Apis::ComputeAlpha::Disk, decorator: Google::Apis::ComputeAlpha::Disk::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::DisksScopedList::Warning, decorator: Google::Apis::ComputeAlpha::DisksScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::DisksScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::DisksScopedList::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 DistributionPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :zones, as: 'zones', class: Google::Apis::ComputeAlpha::DistributionPolicyZoneConfiguration, decorator: Google::Apis::ComputeAlpha::DistributionPolicyZoneConfiguration::Representation end end class DistributionPolicyZoneConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :zone, as: 'zone' 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 Firewall # @private class Representation < Google::Apis::Core::JsonRepresentation collection :allowed, as: 'allowed', class: Google::Apis::ComputeAlpha::Firewall::Allowed, decorator: Google::Apis::ComputeAlpha::Firewall::Allowed::Representation property :creation_timestamp, as: 'creationTimestamp' collection :denied, as: 'denied', class: Google::Apis::ComputeAlpha::Firewall::Denied, decorator: Google::Apis::ComputeAlpha::Firewall::Denied::Representation property :description, as: 'description' collection :destination_ranges, as: 'destinationRanges' property :direction, as: 'direction' property :disabled, as: 'disabled' property :enable_logging, as: 'enableLogging' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :network, as: 'network' property :priority, as: 'priority' property :self_link, as: 'selfLink' collection :source_ranges, as: 'sourceRanges' collection :source_service_accounts, as: 'sourceServiceAccounts' collection :source_tags, as: 'sourceTags' collection :target_service_accounts, as: 'targetServiceAccounts' collection :target_tags, as: 'targetTags' end class Allowed # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_protocol, as: 'IPProtocol' collection :ports, as: 'ports' end end class Denied # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_protocol, as: 'IPProtocol' collection :ports, as: 'ports' end end end class FirewallList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Firewall, decorator: Google::Apis::ComputeAlpha::Firewall::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::FirewallList::Warning, decorator: Google::Apis::ComputeAlpha::FirewallList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::FirewallList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::FirewallList::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 FixedOrPercent # @private class Representation < Google::Apis::Core::JsonRepresentation property :calculated, as: 'calculated' property :fixed, as: 'fixed' property :percent, as: 'percent' end end class ForwardingRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_address, as: 'IPAddress' property :ip_protocol, as: 'IPProtocol' property :backend_service, as: 'backendService' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :fingerprint, :base64 => true, as: 'fingerprint' property :id, :numeric_string => true, as: 'id' property :ip_version, as: 'ipVersion' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' property :load_balancing_scheme, as: 'loadBalancingScheme' property :name, as: 'name' property :network, as: 'network' property :network_tier, as: 'networkTier' property :port_range, as: 'portRange' collection :ports, as: 'ports' property :region, as: 'region' property :self_link, as: 'selfLink' property :service_label, as: 'serviceLabel' property :service_name, as: 'serviceName' property :subnetwork, as: 'subnetwork' property :target, as: 'target' end end class ForwardingRuleAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::ForwardingRulesScopedList, decorator: Google::Apis::ComputeAlpha::ForwardingRulesScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList::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 ForwardingRuleList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::ForwardingRule, decorator: Google::Apis::ComputeAlpha::ForwardingRule::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::ForwardingRuleList::Warning, decorator: Google::Apis::ComputeAlpha::ForwardingRuleList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::ForwardingRuleList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::ForwardingRuleList::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 ForwardingRuleReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :forwarding_rule, as: 'forwardingRule' end end class ForwardingRulesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :forwarding_rules, as: 'forwardingRules', class: Google::Apis::ComputeAlpha::ForwardingRule, decorator: Google::Apis::ComputeAlpha::ForwardingRule::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::ForwardingRulesScopedList::Warning, decorator: Google::Apis::ComputeAlpha::ForwardingRulesScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::ForwardingRulesScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::ForwardingRulesScopedList::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 GlobalSetLabelsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' end end class GuestAttributes # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :self_link, as: 'selfLink' property :variable_key, as: 'variableKey' property :variable_value, as: 'variableValue' end end class GuestOsFeature # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' end end class Http2HealthCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :host, as: 'host' property :port, as: 'port' property :port_name, as: 'portName' property :port_specification, as: 'portSpecification' property :proxy_header, as: 'proxyHeader' property :request_path, as: 'requestPath' property :response, as: 'response' end end class HttpHealthCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :host, as: 'host' property :port, as: 'port' property :port_name, as: 'portName' property :port_specification, as: 'portSpecification' property :proxy_header, as: 'proxyHeader' property :request_path, as: 'requestPath' property :response, as: 'response' end end class HttpsHealthCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :host, as: 'host' property :port, as: 'port' property :port_name, as: 'portName' property :port_specification, as: 'portSpecification' property :proxy_header, as: 'proxyHeader' property :request_path, as: 'requestPath' property :response, as: 'response' end end class HealthCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :check_interval_sec, as: 'checkIntervalSec' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :healthy_threshold, as: 'healthyThreshold' property :http2_health_check, as: 'http2HealthCheck', class: Google::Apis::ComputeAlpha::Http2HealthCheck, decorator: Google::Apis::ComputeAlpha::Http2HealthCheck::Representation property :http_health_check, as: 'httpHealthCheck', class: Google::Apis::ComputeAlpha::HttpHealthCheck, decorator: Google::Apis::ComputeAlpha::HttpHealthCheck::Representation property :https_health_check, as: 'httpsHealthCheck', class: Google::Apis::ComputeAlpha::HttpsHealthCheck, decorator: Google::Apis::ComputeAlpha::HttpsHealthCheck::Representation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :self_link, as: 'selfLink' property :ssl_health_check, as: 'sslHealthCheck', class: Google::Apis::ComputeAlpha::SslHealthCheck, decorator: Google::Apis::ComputeAlpha::SslHealthCheck::Representation property :tcp_health_check, as: 'tcpHealthCheck', class: Google::Apis::ComputeAlpha::TcpHealthCheck, decorator: Google::Apis::ComputeAlpha::TcpHealthCheck::Representation property :timeout_sec, as: 'timeoutSec' property :type, as: 'type' property :udp_health_check, as: 'udpHealthCheck', class: Google::Apis::ComputeAlpha::UdpHealthCheck, decorator: Google::Apis::ComputeAlpha::UdpHealthCheck::Representation property :unhealthy_threshold, as: 'unhealthyThreshold' end end class HealthCheckList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::HealthCheck, decorator: Google::Apis::ComputeAlpha::HealthCheck::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::HealthCheckList::Warning, decorator: Google::Apis::ComputeAlpha::HealthCheckList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::HealthCheckList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::HealthCheckList::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 HealthCheckReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :health_check, as: 'healthCheck' end end class HealthStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :health_state, as: 'healthState' property :instance, as: 'instance' property :ip_address, as: 'ipAddress' property :port, as: 'port' end end class HealthStatusForNetworkEndpoint # @private class Representation < Google::Apis::Core::JsonRepresentation property :backend_service, as: 'backendService', class: Google::Apis::ComputeAlpha::BackendServiceReference, decorator: Google::Apis::ComputeAlpha::BackendServiceReference::Representation property :forwarding_rule, as: 'forwardingRule', class: Google::Apis::ComputeAlpha::ForwardingRuleReference, decorator: Google::Apis::ComputeAlpha::ForwardingRuleReference::Representation property :health_check, as: 'healthCheck', class: Google::Apis::ComputeAlpha::HealthCheckReference, decorator: Google::Apis::ComputeAlpha::HealthCheckReference::Representation property :health_state, as: 'healthState' end end class Host # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :host_type, as: 'hostType' property :id, :numeric_string => true, as: 'id' collection :instances, as: 'instances' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' property :name, as: 'name' property :self_link, as: 'selfLink' property :status, as: 'status' property :status_message, as: 'statusMessage' property :zone, as: 'zone' end end class HostAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::HostsScopedList, decorator: Google::Apis::ComputeAlpha::HostsScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::HostAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::HostAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::HostAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::HostAggregatedList::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 HostList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Host, decorator: Google::Apis::ComputeAlpha::Host::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::HostList::Warning, decorator: Google::Apis::ComputeAlpha::HostList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::HostList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::HostList::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 HostRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' collection :hosts, as: 'hosts' property :path_matcher, as: 'pathMatcher' end end class HostType # @private class Representation < Google::Apis::Core::JsonRepresentation property :cpu_platform, as: 'cpuPlatform' property :creation_timestamp, as: 'creationTimestamp' property :deprecated, as: 'deprecated', class: Google::Apis::ComputeAlpha::DeprecationStatus, decorator: Google::Apis::ComputeAlpha::DeprecationStatus::Representation property :description, as: 'description' property :guest_cpus, as: 'guestCpus' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :local_ssd_gb, as: 'localSsdGb' property :memory_mb, as: 'memoryMb' property :name, as: 'name' property :self_link, as: 'selfLink' property :zone, as: 'zone' end end class HostTypeAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::HostTypesScopedList, decorator: Google::Apis::ComputeAlpha::HostTypesScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::HostTypeAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::HostTypeAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::HostTypeAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::HostTypeAggregatedList::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 HostTypeList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::HostType, decorator: Google::Apis::ComputeAlpha::HostType::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::HostTypeList::Warning, decorator: Google::Apis::ComputeAlpha::HostTypeList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::HostTypeList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::HostTypeList::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 HostTypesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :host_types, as: 'hostTypes', class: Google::Apis::ComputeAlpha::HostType, decorator: Google::Apis::ComputeAlpha::HostType::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::HostTypesScopedList::Warning, decorator: Google::Apis::ComputeAlpha::HostTypesScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::HostTypesScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::HostTypesScopedList::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 HostsScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :hosts, as: 'hosts', class: Google::Apis::ComputeAlpha::Host, decorator: Google::Apis::ComputeAlpha::Host::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::HostsScopedList::Warning, decorator: Google::Apis::ComputeAlpha::HostsScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::HostsScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::HostsScopedList::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 HourlyMaintenanceWindow # @private class Representation < Google::Apis::Core::JsonRepresentation property :duration, as: 'duration' property :hours_in_cycle, as: 'hoursInCycle' property :start_time, as: 'startTime' end end class HttpHealthCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :check_interval_sec, as: 'checkIntervalSec' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :healthy_threshold, as: 'healthyThreshold' property :host, as: 'host' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :port, as: 'port' property :request_path, as: 'requestPath' property :self_link, as: 'selfLink' property :timeout_sec, as: 'timeoutSec' property :unhealthy_threshold, as: 'unhealthyThreshold' end end class HttpHealthCheckList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::HttpHealthCheck, decorator: Google::Apis::ComputeAlpha::HttpHealthCheck::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::HttpHealthCheckList::Warning, decorator: Google::Apis::ComputeAlpha::HttpHealthCheckList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::HttpHealthCheckList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::HttpHealthCheckList::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 HttpsHealthCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :check_interval_sec, as: 'checkIntervalSec' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :healthy_threshold, as: 'healthyThreshold' property :host, as: 'host' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :port, as: 'port' property :request_path, as: 'requestPath' property :self_link, as: 'selfLink' property :timeout_sec, as: 'timeoutSec' property :unhealthy_threshold, as: 'unhealthyThreshold' end end class HttpsHealthCheckList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::HttpsHealthCheck, decorator: Google::Apis::ComputeAlpha::HttpsHealthCheck::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::HttpsHealthCheckList::Warning, decorator: Google::Apis::ComputeAlpha::HttpsHealthCheckList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::HttpsHealthCheckList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::HttpsHealthCheckList::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 Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :archive_size_bytes, :numeric_string => true, as: 'archiveSizeBytes' property :creation_timestamp, as: 'creationTimestamp' property :deprecated, as: 'deprecated', class: Google::Apis::ComputeAlpha::DeprecationStatus, decorator: Google::Apis::ComputeAlpha::DeprecationStatus::Representation property :description, as: 'description' property :disk_size_gb, :numeric_string => true, as: 'diskSizeGb' property :family, as: 'family' collection :guest_os_features, as: 'guestOsFeatures', class: Google::Apis::ComputeAlpha::GuestOsFeature, decorator: Google::Apis::ComputeAlpha::GuestOsFeature::Representation property :id, :numeric_string => true, as: 'id' property :image_encryption_key, as: 'imageEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' collection :license_codes, as: 'licenseCodes' collection :licenses, as: 'licenses' property :name, as: 'name' property :raw_disk, as: 'rawDisk', class: Google::Apis::ComputeAlpha::Image::RawDisk, decorator: Google::Apis::ComputeAlpha::Image::RawDisk::Representation property :self_link, as: 'selfLink' property :source_disk, as: 'sourceDisk' property :source_disk_encryption_key, as: 'sourceDiskEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :source_disk_id, as: 'sourceDiskId' property :source_image, as: 'sourceImage' property :source_image_encryption_key, as: 'sourceImageEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :source_image_id, as: 'sourceImageId' property :source_snapshot, as: 'sourceSnapshot' property :source_snapshot_encryption_key, as: 'sourceSnapshotEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :source_snapshot_id, as: 'sourceSnapshotId' property :source_type, as: 'sourceType' property :status, as: 'status' end class RawDisk # @private class Representation < Google::Apis::Core::JsonRepresentation property :container_type, as: 'containerType' property :sha1_checksum, as: 'sha1Checksum' property :source, as: 'source' end end end class ImageList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Image, decorator: Google::Apis::ComputeAlpha::Image::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::ImageList::Warning, decorator: Google::Apis::ComputeAlpha::ImageList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::ImageList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::ImageList::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 Instance # @private class Representation < Google::Apis::Core::JsonRepresentation property :can_ip_forward, as: 'canIpForward' property :cpu_platform, as: 'cpuPlatform' property :creation_timestamp, as: 'creationTimestamp' property :deletion_protection, as: 'deletionProtection' property :description, as: 'description' collection :disks, as: 'disks', class: Google::Apis::ComputeAlpha::AttachedDisk, decorator: Google::Apis::ComputeAlpha::AttachedDisk::Representation collection :guest_accelerators, as: 'guestAccelerators', class: Google::Apis::ComputeAlpha::AcceleratorConfig, decorator: Google::Apis::ComputeAlpha::AcceleratorConfig::Representation property :host, as: 'host' property :id, :numeric_string => true, as: 'id' property :instance_encryption_key, as: 'instanceEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' property :machine_type, as: 'machineType' collection :maintenance_policies, as: 'maintenancePolicies' property :metadata, as: 'metadata', class: Google::Apis::ComputeAlpha::Metadata, decorator: Google::Apis::ComputeAlpha::Metadata::Representation property :min_cpu_platform, as: 'minCpuPlatform' property :name, as: 'name' collection :network_interfaces, as: 'networkInterfaces', class: Google::Apis::ComputeAlpha::NetworkInterface, decorator: Google::Apis::ComputeAlpha::NetworkInterface::Representation property :preserved_state_size_gb, :numeric_string => true, as: 'preservedStateSizeGb' property :scheduling, as: 'scheduling', class: Google::Apis::ComputeAlpha::Scheduling, decorator: Google::Apis::ComputeAlpha::Scheduling::Representation property :self_link, as: 'selfLink' collection :service_accounts, as: 'serviceAccounts', class: Google::Apis::ComputeAlpha::ServiceAccount, decorator: Google::Apis::ComputeAlpha::ServiceAccount::Representation property :shielded_vm_config, as: 'shieldedVmConfig', class: Google::Apis::ComputeAlpha::ShieldedVmConfig, decorator: Google::Apis::ComputeAlpha::ShieldedVmConfig::Representation property :start_restricted, as: 'startRestricted' property :status, as: 'status' property :status_message, as: 'statusMessage' property :tags, as: 'tags', class: Google::Apis::ComputeAlpha::Tags, decorator: Google::Apis::ComputeAlpha::Tags::Representation property :zone, as: 'zone' end end class InstanceAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::InstancesScopedList, decorator: Google::Apis::ComputeAlpha::InstancesScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceAggregatedList::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 InstanceGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :fingerprint, :base64 => true, as: 'fingerprint' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' collection :named_ports, as: 'namedPorts', class: Google::Apis::ComputeAlpha::NamedPort, decorator: Google::Apis::ComputeAlpha::NamedPort::Representation property :network, as: 'network' property :region, as: 'region' property :self_link, as: 'selfLink' property :size, as: 'size' property :subnetwork, as: 'subnetwork' property :zone, as: 'zone' end end class InstanceGroupAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::InstanceGroupsScopedList, decorator: Google::Apis::ComputeAlpha::InstanceGroupsScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceGroupAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceGroupAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceGroupAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceGroupAggregatedList::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 InstanceGroupList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InstanceGroup, decorator: Google::Apis::ComputeAlpha::InstanceGroup::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceGroupList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceGroupList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceGroupList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceGroupList::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 InstanceGroupManager # @private class Representation < Google::Apis::Core::JsonRepresentation property :activities, as: 'activities', class: Google::Apis::ComputeAlpha::InstanceGroupManagerActivities, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerActivities::Representation collection :auto_healing_policies, as: 'autoHealingPolicies', class: Google::Apis::ComputeAlpha::InstanceGroupManagerAutoHealingPolicy, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerAutoHealingPolicy::Representation property :base_instance_name, as: 'baseInstanceName' property :creation_timestamp, as: 'creationTimestamp' property :current_actions, as: 'currentActions', class: Google::Apis::ComputeAlpha::InstanceGroupManagerActionsSummary, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerActionsSummary::Representation property :description, as: 'description' property :distribution_policy, as: 'distributionPolicy', class: Google::Apis::ComputeAlpha::DistributionPolicy, decorator: Google::Apis::ComputeAlpha::DistributionPolicy::Representation property :failover_action, as: 'failoverAction' property :fingerprint, :base64 => true, as: 'fingerprint' property :id, :numeric_string => true, as: 'id' property :instance_group, as: 'instanceGroup' property :instance_template, as: 'instanceTemplate' property :kind, as: 'kind' property :name, as: 'name' collection :named_ports, as: 'namedPorts', class: Google::Apis::ComputeAlpha::NamedPort, decorator: Google::Apis::ComputeAlpha::NamedPort::Representation property :pending_actions, as: 'pendingActions', class: Google::Apis::ComputeAlpha::InstanceGroupManagerPendingActionsSummary, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerPendingActionsSummary::Representation property :region, as: 'region' property :self_link, as: 'selfLink' property :service_account, as: 'serviceAccount' property :stateful_policy, as: 'statefulPolicy', class: Google::Apis::ComputeAlpha::StatefulPolicy, decorator: Google::Apis::ComputeAlpha::StatefulPolicy::Representation collection :target_pools, as: 'targetPools' property :target_size, as: 'targetSize' property :update_policy, as: 'updatePolicy', class: Google::Apis::ComputeAlpha::InstanceGroupManagerUpdatePolicy, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerUpdatePolicy::Representation collection :versions, as: 'versions', class: Google::Apis::ComputeAlpha::InstanceGroupManagerVersion, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerVersion::Representation property :zone, as: 'zone' end end class InstanceGroupManagerActionsSummary # @private class Representation < Google::Apis::Core::JsonRepresentation property :abandoning, as: 'abandoning' property :creating, as: 'creating' property :creating_without_retries, as: 'creatingWithoutRetries' property :deleting, as: 'deleting' property :none, as: 'none' property :recreating, as: 'recreating' property :refreshing, as: 'refreshing' property :restarting, as: 'restarting' property :verifying, as: 'verifying' end end class InstanceGroupManagerActivities # @private class Representation < Google::Apis::Core::JsonRepresentation property :autohealing, as: 'autohealing' property :autohealing_health_check_based, as: 'autohealingHealthCheckBased' property :autoscaling_down, as: 'autoscalingDown' property :autoscaling_up, as: 'autoscalingUp' property :creating_instances, as: 'creatingInstances' property :deleting_instances, as: 'deletingInstances' property :recreating_instances, as: 'recreatingInstances' end end class InstanceGroupManagerAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::InstanceGroupManagersScopedList, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagersScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList::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 InstanceGroupManagerAutoHealingPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :health_check, as: 'healthCheck' property :initial_delay_sec, as: 'initialDelaySec' property :max_unavailable, as: 'maxUnavailable', class: Google::Apis::ComputeAlpha::FixedOrPercent, decorator: Google::Apis::ComputeAlpha::FixedOrPercent::Representation property :mode, as: 'mode' end end class InstanceGroupManagerList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InstanceGroupManager, decorator: Google::Apis::ComputeAlpha::InstanceGroupManager::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceGroupManagerList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceGroupManagerList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerList::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 InstanceGroupManagerPendingActionsSummary # @private class Representation < Google::Apis::Core::JsonRepresentation property :creating, as: 'creating' property :deleting, as: 'deleting' property :recreating, as: 'recreating' property :restarting, as: 'restarting' end end class InstanceGroupManagerUpdatePolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_surge, as: 'maxSurge', class: Google::Apis::ComputeAlpha::FixedOrPercent, decorator: Google::Apis::ComputeAlpha::FixedOrPercent::Representation property :max_unavailable, as: 'maxUnavailable', class: Google::Apis::ComputeAlpha::FixedOrPercent, decorator: Google::Apis::ComputeAlpha::FixedOrPercent::Representation property :min_ready_sec, as: 'minReadySec' property :minimal_action, as: 'minimalAction' property :type, as: 'type' end end class InstanceGroupManagerVersion # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance_template, as: 'instanceTemplate' property :name, as: 'name' property :tag, as: 'tag' property :target_size, as: 'targetSize', class: Google::Apis::ComputeAlpha::FixedOrPercent, decorator: Google::Apis::ComputeAlpha::FixedOrPercent::Representation end end class InstanceGroupManagersAbandonInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class InstanceGroupManagersApplyUpdatesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' property :maximal_action, as: 'maximalAction' property :minimal_action, as: 'minimalAction' end end class InstanceGroupManagersDeleteInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class InstanceGroupManagersDeletePerInstanceConfigsReq # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class InstanceGroupManagersListManagedInstancesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :managed_instances, as: 'managedInstances', class: Google::Apis::ComputeAlpha::ManagedInstance, decorator: Google::Apis::ComputeAlpha::ManagedInstance::Representation property :next_page_token, as: 'nextPageToken' end end class InstanceGroupManagersListPerInstanceConfigsResp # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::ComputeAlpha::PerInstanceConfig, decorator: Google::Apis::ComputeAlpha::PerInstanceConfig::Representation property :next_page_token, as: 'nextPageToken' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp::Warning, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp::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 InstanceGroupManagersRecreateInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class InstanceGroupManagersResizeAdvancedRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :no_creation_retries, as: 'noCreationRetries' property :target_size, as: 'targetSize' end end class InstanceGroupManagersScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instance_group_managers, as: 'instanceGroupManagers', class: Google::Apis::ComputeAlpha::InstanceGroupManager, decorator: Google::Apis::ComputeAlpha::InstanceGroupManager::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceGroupManagersScopedList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagersScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceGroupManagersScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagersScopedList::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 InstanceGroupManagersSetAutoHealingRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :auto_healing_policies, as: 'autoHealingPolicies', class: Google::Apis::ComputeAlpha::InstanceGroupManagerAutoHealingPolicy, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerAutoHealingPolicy::Representation end end class InstanceGroupManagersSetInstanceTemplateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance_template, as: 'instanceTemplate' end end class InstanceGroupManagersSetTargetPoolsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' collection :target_pools, as: 'targetPools' end end class InstanceGroupManagersUpdatePerInstanceConfigsReq # @private class Representation < Google::Apis::Core::JsonRepresentation collection :per_instance_configs, as: 'perInstanceConfigs', class: Google::Apis::ComputeAlpha::PerInstanceConfig, decorator: Google::Apis::ComputeAlpha::PerInstanceConfig::Representation end end class InstanceGroupsAddInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances', class: Google::Apis::ComputeAlpha::InstanceReference, decorator: Google::Apis::ComputeAlpha::InstanceReference::Representation end end class InstanceGroupsListInstances # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InstanceWithNamedPorts, decorator: Google::Apis::ComputeAlpha::InstanceWithNamedPorts::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceGroupsListInstances::Warning, decorator: Google::Apis::ComputeAlpha::InstanceGroupsListInstances::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceGroupsListInstances::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceGroupsListInstances::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 InstanceGroupsListInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance_state, as: 'instanceState' end end class InstanceGroupsRemoveInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances', class: Google::Apis::ComputeAlpha::InstanceReference, decorator: Google::Apis::ComputeAlpha::InstanceReference::Representation end end class InstanceGroupsScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instance_groups, as: 'instanceGroups', class: Google::Apis::ComputeAlpha::InstanceGroup, decorator: Google::Apis::ComputeAlpha::InstanceGroup::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceGroupsScopedList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceGroupsScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceGroupsScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceGroupsScopedList::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 InstanceGroupsSetNamedPortsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' collection :named_ports, as: 'namedPorts', class: Google::Apis::ComputeAlpha::NamedPort, decorator: Google::Apis::ComputeAlpha::NamedPort::Representation end end class InstanceList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Instance, decorator: Google::Apis::ComputeAlpha::Instance::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceList::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 InstanceListReferrers # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Reference, decorator: Google::Apis::ComputeAlpha::Reference::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceListReferrers::Warning, decorator: Google::Apis::ComputeAlpha::InstanceListReferrers::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceListReferrers::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceListReferrers::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 InstanceMoveRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination_zone, as: 'destinationZone' property :target_instance, as: 'targetInstance' end end class InstanceProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :can_ip_forward, as: 'canIpForward' property :description, as: 'description' collection :disks, as: 'disks', class: Google::Apis::ComputeAlpha::AttachedDisk, decorator: Google::Apis::ComputeAlpha::AttachedDisk::Representation collection :guest_accelerators, as: 'guestAccelerators', class: Google::Apis::ComputeAlpha::AcceleratorConfig, decorator: Google::Apis::ComputeAlpha::AcceleratorConfig::Representation hash :labels, as: 'labels' property :machine_type, as: 'machineType' property :metadata, as: 'metadata', class: Google::Apis::ComputeAlpha::Metadata, decorator: Google::Apis::ComputeAlpha::Metadata::Representation property :min_cpu_platform, as: 'minCpuPlatform' collection :network_interfaces, as: 'networkInterfaces', class: Google::Apis::ComputeAlpha::NetworkInterface, decorator: Google::Apis::ComputeAlpha::NetworkInterface::Representation property :scheduling, as: 'scheduling', class: Google::Apis::ComputeAlpha::Scheduling, decorator: Google::Apis::ComputeAlpha::Scheduling::Representation collection :service_accounts, as: 'serviceAccounts', class: Google::Apis::ComputeAlpha::ServiceAccount, decorator: Google::Apis::ComputeAlpha::ServiceAccount::Representation property :shielded_vm_config, as: 'shieldedVmConfig', class: Google::Apis::ComputeAlpha::ShieldedVmConfig, decorator: Google::Apis::ComputeAlpha::ShieldedVmConfig::Representation property :tags, as: 'tags', class: Google::Apis::ComputeAlpha::Tags, decorator: Google::Apis::ComputeAlpha::Tags::Representation end end class InstanceReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance, as: 'instance' end end class InstanceTemplate # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :properties, as: 'properties', class: Google::Apis::ComputeAlpha::InstanceProperties, decorator: Google::Apis::ComputeAlpha::InstanceProperties::Representation property :self_link, as: 'selfLink' property :source_instance, as: 'sourceInstance' property :source_instance_params, as: 'sourceInstanceParams', class: Google::Apis::ComputeAlpha::SourceInstanceParams, decorator: Google::Apis::ComputeAlpha::SourceInstanceParams::Representation end end class InstanceTemplateList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InstanceTemplate, decorator: Google::Apis::ComputeAlpha::InstanceTemplate::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceTemplateList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceTemplateList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstanceTemplateList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstanceTemplateList::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 InstanceWithNamedPorts # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance, as: 'instance' collection :named_ports, as: 'namedPorts', class: Google::Apis::ComputeAlpha::NamedPort, decorator: Google::Apis::ComputeAlpha::NamedPort::Representation property :status, as: 'status' end end class InstancesAddMaintenancePoliciesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :maintenance_policies, as: 'maintenancePolicies' end end class InstancesRemoveMaintenancePoliciesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :maintenance_policies, as: 'maintenancePolicies' end end class InstancesResumeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :disks, as: 'disks', class: Google::Apis::ComputeAlpha::CustomerEncryptionKeyProtectedDisk, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKeyProtectedDisk::Representation property :instance_encryption_key, as: 'instanceEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation end end class InstancesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances', class: Google::Apis::ComputeAlpha::Instance, decorator: Google::Apis::ComputeAlpha::Instance::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstancesScopedList::Warning, decorator: Google::Apis::ComputeAlpha::InstancesScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InstancesScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InstancesScopedList::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 InstancesSetLabelsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' end end class InstancesSetMachineResourcesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :guest_accelerators, as: 'guestAccelerators', class: Google::Apis::ComputeAlpha::AcceleratorConfig, decorator: Google::Apis::ComputeAlpha::AcceleratorConfig::Representation end end class InstancesSetMachineTypeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :machine_type, as: 'machineType' end end class InstancesSetMinCpuPlatformRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :min_cpu_platform, as: 'minCpuPlatform' end end class InstancesSetServiceAccountRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' collection :scopes, as: 'scopes' end end class InstancesStartWithEncryptionKeyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :disks, as: 'disks', class: Google::Apis::ComputeAlpha::CustomerEncryptionKeyProtectedDisk, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKeyProtectedDisk::Representation property :instance_encryption_key, as: 'instanceEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation end end class Interconnect # @private class Representation < Google::Apis::Core::JsonRepresentation property :admin_enabled, as: 'adminEnabled' collection :circuit_infos, as: 'circuitInfos', class: Google::Apis::ComputeAlpha::InterconnectCircuitInfo, decorator: Google::Apis::ComputeAlpha::InterconnectCircuitInfo::Representation property :creation_timestamp, as: 'creationTimestamp' property :customer_name, as: 'customerName' property :description, as: 'description' collection :expected_outages, as: 'expectedOutages', class: Google::Apis::ComputeAlpha::InterconnectOutageNotification, decorator: Google::Apis::ComputeAlpha::InterconnectOutageNotification::Representation property :google_ip_address, as: 'googleIpAddress' property :google_reference_id, as: 'googleReferenceId' property :id, :numeric_string => true, as: 'id' collection :interconnect_attachments, as: 'interconnectAttachments' property :interconnect_type, as: 'interconnectType' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' property :link_type, as: 'linkType' property :location, as: 'location' property :name, as: 'name' property :noc_contact_email, as: 'nocContactEmail' property :operational_status, as: 'operationalStatus' property :peer_ip_address, as: 'peerIpAddress' property :provisioned_link_count, as: 'provisionedLinkCount' property :requested_link_count, as: 'requestedLinkCount' property :self_link, as: 'selfLink' property :state, as: 'state' end end class InterconnectAttachment # @private class Representation < Google::Apis::Core::JsonRepresentation property :admin_enabled, as: 'adminEnabled' property :availability_zone, as: 'availabilityZone' property :bandwidth, as: 'bandwidth' collection :candidate_subnets, as: 'candidateSubnets' property :cloud_router_ip_address, as: 'cloudRouterIpAddress' property :creation_timestamp, as: 'creationTimestamp' property :customer_router_ip_address, as: 'customerRouterIpAddress' property :description, as: 'description' property :edge_availability_domain, as: 'edgeAvailabilityDomain' property :google_reference_id, as: 'googleReferenceId' property :id, :numeric_string => true, as: 'id' property :interconnect, as: 'interconnect' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' property :name, as: 'name' property :operational_status, as: 'operationalStatus' property :pairing_key, as: 'pairingKey' property :partner_asn, :numeric_string => true, as: 'partnerAsn' property :partner_metadata, as: 'partnerMetadata', class: Google::Apis::ComputeAlpha::InterconnectAttachmentPartnerMetadata, decorator: Google::Apis::ComputeAlpha::InterconnectAttachmentPartnerMetadata::Representation property :private_interconnect_info, as: 'privateInterconnectInfo', class: Google::Apis::ComputeAlpha::InterconnectAttachmentPrivateInfo, decorator: Google::Apis::ComputeAlpha::InterconnectAttachmentPrivateInfo::Representation property :region, as: 'region' property :router, as: 'router' property :self_link, as: 'selfLink' property :state, as: 'state' property :type, as: 'type' property :vlan_tag8021q, as: 'vlanTag8021q' end end class InterconnectAttachmentAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::InterconnectAttachmentsScopedList, decorator: Google::Apis::ComputeAlpha::InterconnectAttachmentsScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList::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 InterconnectAttachmentList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InterconnectAttachment, decorator: Google::Apis::ComputeAlpha::InterconnectAttachment::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InterconnectAttachmentList::Warning, decorator: Google::Apis::ComputeAlpha::InterconnectAttachmentList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InterconnectAttachmentList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InterconnectAttachmentList::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 InterconnectAttachmentPartnerMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :interconnect_name, as: 'interconnectName' property :partner_name, as: 'partnerName' property :portal_url, as: 'portalUrl' end end class InterconnectAttachmentPrivateInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :tag8021q, as: 'tag8021q' end end class InterconnectAttachmentsScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :interconnect_attachments, as: 'interconnectAttachments', class: Google::Apis::ComputeAlpha::InterconnectAttachment, decorator: Google::Apis::ComputeAlpha::InterconnectAttachment::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InterconnectAttachmentsScopedList::Warning, decorator: Google::Apis::ComputeAlpha::InterconnectAttachmentsScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InterconnectAttachmentsScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InterconnectAttachmentsScopedList::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 InterconnectCircuitInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :customer_demarc_id, as: 'customerDemarcId' property :google_circuit_id, as: 'googleCircuitId' property :google_demarc_id, as: 'googleDemarcId' end end class InterconnectList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Interconnect, decorator: Google::Apis::ComputeAlpha::Interconnect::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InterconnectList::Warning, decorator: Google::Apis::ComputeAlpha::InterconnectList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InterconnectList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InterconnectList::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 InterconnectLocation # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address' property :availability_zone, as: 'availabilityZone' property :city, as: 'city' property :continent, as: 'continent' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :facility_provider, as: 'facilityProvider' property :facility_provider_facility_id, as: 'facilityProviderFacilityId' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :peeringdb_facility_id, as: 'peeringdbFacilityId' collection :region_infos, as: 'regionInfos', class: Google::Apis::ComputeAlpha::InterconnectLocationRegionInfo, decorator: Google::Apis::ComputeAlpha::InterconnectLocationRegionInfo::Representation property :self_link, as: 'selfLink' end end class InterconnectLocationList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InterconnectLocation, decorator: Google::Apis::ComputeAlpha::InterconnectLocation::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InterconnectLocationList::Warning, decorator: Google::Apis::ComputeAlpha::InterconnectLocationList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InterconnectLocationList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InterconnectLocationList::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 InterconnectLocationRegionInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :expected_rtt_ms, :numeric_string => true, as: 'expectedRttMs' property :location_presence, as: 'locationPresence' property :region, as: 'region' end end class InterconnectOutageNotification # @private class Representation < Google::Apis::Core::JsonRepresentation collection :affected_circuits, as: 'affectedCircuits' property :description, as: 'description' property :end_time, :numeric_string => true, as: 'endTime' property :issue_type, as: 'issueType' property :name, as: 'name' property :source, as: 'source' property :start_time, :numeric_string => true, as: 'startTime' property :state, as: 'state' end end class InternalIpOwner # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_cidr_range, as: 'ipCidrRange' collection :owners, as: 'owners' property :system_owned, as: 'systemOwned' end end class IpOwnerList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InternalIpOwner, decorator: Google::Apis::ComputeAlpha::InternalIpOwner::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::IpOwnerList::Warning, decorator: Google::Apis::ComputeAlpha::IpOwnerList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::IpOwnerList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::IpOwnerList::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 License # @private class Representation < Google::Apis::Core::JsonRepresentation property :charges_use_fee, as: 'chargesUseFee' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :license_code, :numeric_string => true, as: 'licenseCode' property :name, as: 'name' property :resource_requirements, as: 'resourceRequirements', class: Google::Apis::ComputeAlpha::LicenseResourceRequirements, decorator: Google::Apis::ComputeAlpha::LicenseResourceRequirements::Representation property :self_link, as: 'selfLink' property :transferable, as: 'transferable' end end class LicenseCode # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' collection :license_alias, as: 'licenseAlias', class: Google::Apis::ComputeAlpha::LicenseCodeLicenseAlias, decorator: Google::Apis::ComputeAlpha::LicenseCodeLicenseAlias::Representation property :name, as: 'name' property :self_link, as: 'selfLink' property :state, as: 'state' property :transferable, as: 'transferable' end end class LicenseCodeLicenseAlias # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :self_link, as: 'selfLink' end end class LicenseResourceRequirements # @private class Representation < Google::Apis::Core::JsonRepresentation property :min_guest_cpu_count, as: 'minGuestCpuCount' property :min_memory_mb, as: 'minMemoryMb' end end class LicensesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::License, decorator: Google::Apis::ComputeAlpha::License::Representation property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::LicensesListResponse::Warning, decorator: Google::Apis::ComputeAlpha::LicensesListResponse::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::LicensesListResponse::Warning::Datum, decorator: Google::Apis::ComputeAlpha::LicensesListResponse::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 LogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :cloud_audit, as: 'cloudAudit', class: Google::Apis::ComputeAlpha::LogConfigCloudAuditOptions, decorator: Google::Apis::ComputeAlpha::LogConfigCloudAuditOptions::Representation property :counter, as: 'counter', class: Google::Apis::ComputeAlpha::LogConfigCounterOptions, decorator: Google::Apis::ComputeAlpha::LogConfigCounterOptions::Representation property :data_access, as: 'dataAccess', class: Google::Apis::ComputeAlpha::LogConfigDataAccessOptions, decorator: Google::Apis::ComputeAlpha::LogConfigDataAccessOptions::Representation end end class LogConfigCloudAuditOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :authorization_logging_options, as: 'authorizationLoggingOptions', class: Google::Apis::ComputeAlpha::AuthorizationLoggingOptions, decorator: Google::Apis::ComputeAlpha::AuthorizationLoggingOptions::Representation property :log_name, as: 'logName' end end class LogConfigCounterOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field' property :metric, as: 'metric' end end class LogConfigDataAccessOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :log_mode, as: 'logMode' end end class MachineType # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :deprecated, as: 'deprecated', class: Google::Apis::ComputeAlpha::DeprecationStatus, decorator: Google::Apis::ComputeAlpha::DeprecationStatus::Representation property :description, as: 'description' property :guest_cpus, as: 'guestCpus' property :id, :numeric_string => true, as: 'id' property :is_shared_cpu, as: 'isSharedCpu' property :kind, as: 'kind' property :maximum_persistent_disks, as: 'maximumPersistentDisks' property :maximum_persistent_disks_size_gb, :numeric_string => true, as: 'maximumPersistentDisksSizeGb' property :memory_mb, as: 'memoryMb' property :name, as: 'name' property :self_link, as: 'selfLink' property :zone, as: 'zone' end end class MachineTypeAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::MachineTypesScopedList, decorator: Google::Apis::ComputeAlpha::MachineTypesScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::MachineTypeAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::MachineTypeAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::MachineTypeAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::MachineTypeAggregatedList::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 MachineTypeList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::MachineType, decorator: Google::Apis::ComputeAlpha::MachineType::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::MachineTypeList::Warning, decorator: Google::Apis::ComputeAlpha::MachineTypeList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::MachineTypeList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::MachineTypeList::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 MachineTypesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :machine_types, as: 'machineTypes', class: Google::Apis::ComputeAlpha::MachineType, decorator: Google::Apis::ComputeAlpha::MachineType::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::MachineTypesScopedList::Warning, decorator: Google::Apis::ComputeAlpha::MachineTypesScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::MachineTypesScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::MachineTypesScopedList::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 MaintenancePoliciesList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::MaintenancePolicy, decorator: Google::Apis::ComputeAlpha::MaintenancePolicy::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::MaintenancePoliciesList::Warning, decorator: Google::Apis::ComputeAlpha::MaintenancePoliciesList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::MaintenancePoliciesList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::MaintenancePoliciesList::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 MaintenancePoliciesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :maintenance_policies, as: 'maintenancePolicies', class: Google::Apis::ComputeAlpha::MaintenancePolicy, decorator: Google::Apis::ComputeAlpha::MaintenancePolicy::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::MaintenancePoliciesScopedList::Warning, decorator: Google::Apis::ComputeAlpha::MaintenancePoliciesScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::MaintenancePoliciesScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::MaintenancePoliciesScopedList::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 MaintenancePolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :region, as: 'region' property :self_link, as: 'selfLink' property :vm_maintenance_policy, as: 'vmMaintenancePolicy', class: Google::Apis::ComputeAlpha::VmMaintenancePolicy, decorator: Google::Apis::ComputeAlpha::VmMaintenancePolicy::Representation end end class MaintenancePolicyAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::MaintenancePoliciesScopedList, decorator: Google::Apis::ComputeAlpha::MaintenancePoliciesScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::MaintenancePolicyAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::MaintenancePolicyAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::MaintenancePolicyAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::MaintenancePolicyAggregatedList::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 MaintenanceWindow # @private class Representation < Google::Apis::Core::JsonRepresentation property :daily_maintenance_window, as: 'dailyMaintenanceWindow', class: Google::Apis::ComputeAlpha::DailyMaintenanceWindow, decorator: Google::Apis::ComputeAlpha::DailyMaintenanceWindow::Representation property :hourly_maintenance_window, as: 'hourlyMaintenanceWindow', class: Google::Apis::ComputeAlpha::HourlyMaintenanceWindow, decorator: Google::Apis::ComputeAlpha::HourlyMaintenanceWindow::Representation end end class ManagedInstance # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_action, as: 'currentAction' property :id, :numeric_string => true, as: 'id' property :instance, as: 'instance' property :instance_status, as: 'instanceStatus' property :instance_template, as: 'instanceTemplate' property :last_attempt, as: 'lastAttempt', class: Google::Apis::ComputeAlpha::ManagedInstanceLastAttempt, decorator: Google::Apis::ComputeAlpha::ManagedInstanceLastAttempt::Representation property :override, as: 'override', class: Google::Apis::ComputeAlpha::ManagedInstanceOverride, decorator: Google::Apis::ComputeAlpha::ManagedInstanceOverride::Representation property :standby_mode, as: 'standbyMode' property :tag, as: 'tag' property :version, as: 'version', class: Google::Apis::ComputeAlpha::ManagedInstanceVersion, decorator: Google::Apis::ComputeAlpha::ManagedInstanceVersion::Representation end end class ManagedInstanceLastAttempt # @private class Representation < Google::Apis::Core::JsonRepresentation property :errors, as: 'errors', class: Google::Apis::ComputeAlpha::ManagedInstanceLastAttempt::Errors, decorator: Google::Apis::ComputeAlpha::ManagedInstanceLastAttempt::Errors::Representation end class Errors # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::ComputeAlpha::ManagedInstanceLastAttempt::Errors::Error, decorator: Google::Apis::ComputeAlpha::ManagedInstanceLastAttempt::Errors::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end end class ManagedInstanceOverride # @private class Representation < Google::Apis::Core::JsonRepresentation collection :disks, as: 'disks', class: Google::Apis::ComputeAlpha::ManagedInstanceOverrideDiskOverride, decorator: Google::Apis::ComputeAlpha::ManagedInstanceOverrideDiskOverride::Representation collection :metadata, as: 'metadata', class: Google::Apis::ComputeAlpha::ManagedInstanceOverride::Metadatum, decorator: Google::Apis::ComputeAlpha::ManagedInstanceOverride::Metadatum::Representation property :origin, as: 'origin' end class Metadatum # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end end class ManagedInstanceOverrideDiskOverride # @private class Representation < Google::Apis::Core::JsonRepresentation property :device_name, as: 'deviceName' property :mode, as: 'mode' property :source, as: 'source' end end class ManagedInstanceVersion # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance_template, as: 'instanceTemplate' property :name, as: 'name' end end class Metadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Metadata::Item, decorator: Google::Apis::ComputeAlpha::Metadata::Item::Representation property :kind, as: 'kind' end class Item # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end end class NamedPort # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :port, as: 'port' end end class Network # @private class Representation < Google::Apis::Core::JsonRepresentation property :i_pv4_range, as: 'IPv4Range' property :auto_create_subnetworks, as: 'autoCreateSubnetworks' property :creation_timestamp, as: 'creationTimestamp' property :cross_vm_encryption, as: 'crossVmEncryption' property :description, as: 'description' property :gateway_i_pv4, as: 'gatewayIPv4' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :load_balancer_vm_encryption, as: 'loadBalancerVmEncryption' property :name, as: 'name' collection :peerings, as: 'peerings', class: Google::Apis::ComputeAlpha::NetworkPeering, decorator: Google::Apis::ComputeAlpha::NetworkPeering::Representation property :routing_config, as: 'routingConfig', class: Google::Apis::ComputeAlpha::NetworkRoutingConfig, decorator: Google::Apis::ComputeAlpha::NetworkRoutingConfig::Representation property :self_link, as: 'selfLink' collection :subnetworks, as: 'subnetworks' end end class NetworkEndpoint # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance, as: 'instance' property :ip_address, as: 'ipAddress' property :port, as: 'port' end end class NetworkEndpointGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :load_balancer, as: 'loadBalancer', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupLbNetworkEndpointGroup, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupLbNetworkEndpointGroup::Representation property :name, as: 'name' property :network_endpoint_type, as: 'networkEndpointType' property :self_link, as: 'selfLink' property :size, as: 'size' property :type, as: 'type' end end class NetworkEndpointGroupAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupsScopedList, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupsScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList::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 NetworkEndpointGroupLbNetworkEndpointGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_port, as: 'defaultPort' property :network, as: 'network' property :subnetwork, as: 'subnetwork' property :zone, as: 'zone' end end class NetworkEndpointGroupList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::NetworkEndpointGroup, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroup::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupList::Warning, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupList::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 NetworkEndpointGroupsAttachEndpointsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :network_endpoints, as: 'networkEndpoints', class: Google::Apis::ComputeAlpha::NetworkEndpoint, decorator: Google::Apis::ComputeAlpha::NetworkEndpoint::Representation end end class NetworkEndpointGroupsDetachEndpointsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :network_endpoints, as: 'networkEndpoints', class: Google::Apis::ComputeAlpha::NetworkEndpoint, decorator: Google::Apis::ComputeAlpha::NetworkEndpoint::Representation end end class NetworkEndpointGroupsListEndpointsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :health_status, as: 'healthStatus' end end class NetworkEndpointGroupsListNetworkEndpoints # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::NetworkEndpointWithHealthStatus, decorator: Google::Apis::ComputeAlpha::NetworkEndpointWithHealthStatus::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints::Warning, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints::Warning::Datum, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints::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 NetworkEndpointGroupsScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :network_endpoint_groups, as: 'networkEndpointGroups', class: Google::Apis::ComputeAlpha::NetworkEndpointGroup, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroup::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupsScopedList::Warning, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupsScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupsScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupsScopedList::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 NetworkEndpointWithHealthStatus # @private class Representation < Google::Apis::Core::JsonRepresentation collection :healths, as: 'healths', class: Google::Apis::ComputeAlpha::HealthStatusForNetworkEndpoint, decorator: Google::Apis::ComputeAlpha::HealthStatusForNetworkEndpoint::Representation property :network_endpoint, as: 'networkEndpoint', class: Google::Apis::ComputeAlpha::NetworkEndpoint, decorator: Google::Apis::ComputeAlpha::NetworkEndpoint::Representation end end class NetworkInterface # @private class Representation < Google::Apis::Core::JsonRepresentation collection :access_configs, as: 'accessConfigs', class: Google::Apis::ComputeAlpha::AccessConfig, decorator: Google::Apis::ComputeAlpha::AccessConfig::Representation collection :alias_ip_ranges, as: 'aliasIpRanges', class: Google::Apis::ComputeAlpha::AliasIpRange, decorator: Google::Apis::ComputeAlpha::AliasIpRange::Representation property :fingerprint, :base64 => true, as: 'fingerprint' property :kind, as: 'kind' property :name, as: 'name' property :network, as: 'network' property :network_ip, as: 'networkIP' property :subnetwork, as: 'subnetwork' end end class NetworkList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Network, decorator: Google::Apis::ComputeAlpha::Network::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::NetworkList::Warning, decorator: Google::Apis::ComputeAlpha::NetworkList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::NetworkList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::NetworkList::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 NetworkPeering # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_create_routes, as: 'autoCreateRoutes' property :name, as: 'name' property :network, as: 'network' property :state, as: 'state' property :state_details, as: 'stateDetails' end end class NetworkRoutingConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :routing_mode, as: 'routingMode' end end class NetworksAddPeeringRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_create_routes, as: 'autoCreateRoutes' property :name, as: 'name' property :peer_network, as: 'peerNetwork' end end class NetworksRemovePeeringRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_operation_id, as: 'clientOperationId' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :end_time, as: 'endTime' property :error, as: 'error', class: Google::Apis::ComputeAlpha::Operation::Error, decorator: Google::Apis::ComputeAlpha::Operation::Error::Representation property :http_error_message, as: 'httpErrorMessage' property :http_error_status_code, as: 'httpErrorStatusCode' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' property :kind, as: 'kind' property :name, as: 'name' property :operation_type, as: 'operationType' property :progress, as: 'progress' property :region, as: 'region' property :self_link, as: 'selfLink' property :start_time, as: 'startTime' property :status, as: 'status' property :status_message, as: 'statusMessage' property :target_id, :numeric_string => true, as: 'targetId' property :target_link, as: 'targetLink' property :user, as: 'user' collection :warnings, as: 'warnings', class: Google::Apis::ComputeAlpha::Operation::Warning, decorator: Google::Apis::ComputeAlpha::Operation::Warning::Representation property :zone, as: 'zone' end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::ComputeAlpha::Operation::Error::Error, decorator: Google::Apis::ComputeAlpha::Operation::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::Operation::Warning::Datum, decorator: Google::Apis::ComputeAlpha::Operation::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 OperationAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::OperationsScopedList, decorator: Google::Apis::ComputeAlpha::OperationsScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::OperationAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::OperationAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::OperationAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::OperationAggregatedList::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 OperationList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Operation, decorator: Google::Apis::ComputeAlpha::Operation::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::OperationList::Warning, decorator: Google::Apis::ComputeAlpha::OperationList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::OperationList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::OperationList::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 OperationsScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :operations, as: 'operations', class: Google::Apis::ComputeAlpha::Operation, decorator: Google::Apis::ComputeAlpha::Operation::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::OperationsScopedList::Warning, decorator: Google::Apis::ComputeAlpha::OperationsScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::OperationsScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::OperationsScopedList::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 PathMatcher # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_service, as: 'defaultService' property :description, as: 'description' property :name, as: 'name' collection :path_rules, as: 'pathRules', class: Google::Apis::ComputeAlpha::PathRule, decorator: Google::Apis::ComputeAlpha::PathRule::Representation end end class PathRule # @private class Representation < Google::Apis::Core::JsonRepresentation collection :paths, as: 'paths' property :service, as: 'service' end end class PerInstanceConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance, as: 'instance' property :override, as: 'override', class: Google::Apis::ComputeAlpha::ManagedInstanceOverride, decorator: Google::Apis::ComputeAlpha::ManagedInstanceOverride::Representation end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_configs, as: 'auditConfigs', class: Google::Apis::ComputeAlpha::AuditConfig, decorator: Google::Apis::ComputeAlpha::AuditConfig::Representation collection :bindings, as: 'bindings', class: Google::Apis::ComputeAlpha::Binding, decorator: Google::Apis::ComputeAlpha::Binding::Representation property :etag, :base64 => true, as: 'etag' property :iam_owned, as: 'iamOwned' collection :rules, as: 'rules', class: Google::Apis::ComputeAlpha::Rule, decorator: Google::Apis::ComputeAlpha::Rule::Representation property :version, as: 'version' end end class Project # @private class Representation < Google::Apis::Core::JsonRepresentation property :common_instance_metadata, as: 'commonInstanceMetadata', class: Google::Apis::ComputeAlpha::Metadata, decorator: Google::Apis::ComputeAlpha::Metadata::Representation property :creation_timestamp, as: 'creationTimestamp' property :default_network_tier, as: 'defaultNetworkTier' property :default_service_account, as: 'defaultServiceAccount' property :description, as: 'description' collection :enabled_features, as: 'enabledFeatures' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' collection :quotas, as: 'quotas', class: Google::Apis::ComputeAlpha::Quota, decorator: Google::Apis::ComputeAlpha::Quota::Representation property :self_link, as: 'selfLink' property :usage_export_location, as: 'usageExportLocation', class: Google::Apis::ComputeAlpha::UsageExportLocation, decorator: Google::Apis::ComputeAlpha::UsageExportLocation::Representation property :xpn_project_status, as: 'xpnProjectStatus' end end class ProjectsDisableXpnResourceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :xpn_resource, as: 'xpnResource', class: Google::Apis::ComputeAlpha::XpnResourceId, decorator: Google::Apis::ComputeAlpha::XpnResourceId::Representation end end class ProjectsEnableXpnResourceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :xpn_resource, as: 'xpnResource', class: Google::Apis::ComputeAlpha::XpnResourceId, decorator: Google::Apis::ComputeAlpha::XpnResourceId::Representation end end class ProjectsGetXpnResources # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :resources, as: 'resources', class: Google::Apis::ComputeAlpha::XpnResourceId, decorator: Google::Apis::ComputeAlpha::XpnResourceId::Representation end end class ProjectsListXpnHostsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :organization, as: 'organization' end end class ProjectsSetDefaultNetworkTierRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :network_tier, as: 'networkTier' end end class ProjectsSetDefaultServiceAccountRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' end end class Quota # @private class Representation < Google::Apis::Core::JsonRepresentation property :limit, as: 'limit' property :metric, as: 'metric' property :usage, as: 'usage' end end class Reference # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :reference_type, as: 'referenceType' property :referrer, as: 'referrer' property :target, as: 'target' end end class Region # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :deprecated, as: 'deprecated', class: Google::Apis::ComputeAlpha::DeprecationStatus, decorator: Google::Apis::ComputeAlpha::DeprecationStatus::Representation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' collection :quotas, as: 'quotas', class: Google::Apis::ComputeAlpha::Quota, decorator: Google::Apis::ComputeAlpha::Quota::Representation property :self_link, as: 'selfLink' property :status, as: 'status' collection :zones, as: 'zones' end end class RegionAutoscalerList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Autoscaler, decorator: Google::Apis::ComputeAlpha::Autoscaler::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RegionAutoscalerList::Warning, decorator: Google::Apis::ComputeAlpha::RegionAutoscalerList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RegionAutoscalerList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RegionAutoscalerList::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 RegionDiskTypeList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::DiskType, decorator: Google::Apis::ComputeAlpha::DiskType::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RegionDiskTypeList::Warning, decorator: Google::Apis::ComputeAlpha::RegionDiskTypeList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RegionDiskTypeList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RegionDiskTypeList::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 RegionDisksResizeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :size_gb, :numeric_string => true, as: 'sizeGb' end end class RegionInstanceGroupList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InstanceGroup, decorator: Google::Apis::ComputeAlpha::InstanceGroup::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RegionInstanceGroupList::Warning, decorator: Google::Apis::ComputeAlpha::RegionInstanceGroupList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RegionInstanceGroupList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RegionInstanceGroupList::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 RegionInstanceGroupManagerDeleteInstanceConfigReq # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class RegionInstanceGroupManagerList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InstanceGroupManager, decorator: Google::Apis::ComputeAlpha::InstanceGroupManager::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RegionInstanceGroupManagerList::Warning, decorator: Google::Apis::ComputeAlpha::RegionInstanceGroupManagerList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RegionInstanceGroupManagerList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RegionInstanceGroupManagerList::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 RegionInstanceGroupManagerUpdateInstanceConfigReq # @private class Representation < Google::Apis::Core::JsonRepresentation collection :per_instance_configs, as: 'perInstanceConfigs', class: Google::Apis::ComputeAlpha::PerInstanceConfig, decorator: Google::Apis::ComputeAlpha::PerInstanceConfig::Representation end end class RegionInstanceGroupManagersAbandonInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class RegionInstanceGroupManagersApplyUpdatesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' property :maximal_action, as: 'maximalAction' property :minimal_action, as: 'minimalAction' end end class RegionInstanceGroupManagersDeleteInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class RegionInstanceGroupManagersListInstanceConfigsResp # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::ComputeAlpha::PerInstanceConfig, decorator: Google::Apis::ComputeAlpha::PerInstanceConfig::Representation property :next_page_token, as: 'nextPageToken' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp::Warning, decorator: Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp::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 RegionInstanceGroupManagersListInstancesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :managed_instances, as: 'managedInstances', class: Google::Apis::ComputeAlpha::ManagedInstance, decorator: Google::Apis::ComputeAlpha::ManagedInstance::Representation property :next_page_token, as: 'nextPageToken' end end class RegionInstanceGroupManagersRecreateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances' end end class RegionInstanceGroupManagersSetAutoHealingRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :auto_healing_policies, as: 'autoHealingPolicies', class: Google::Apis::ComputeAlpha::InstanceGroupManagerAutoHealingPolicy, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerAutoHealingPolicy::Representation end end class RegionInstanceGroupManagersSetTargetPoolsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' collection :target_pools, as: 'targetPools' end end class RegionInstanceGroupManagersSetTemplateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance_template, as: 'instanceTemplate' end end class RegionInstanceGroupsListInstances # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InstanceWithNamedPorts, decorator: Google::Apis::ComputeAlpha::InstanceWithNamedPorts::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstances::Warning, decorator: Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstances::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstances::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstances::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 RegionInstanceGroupsListInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance_state, as: 'instanceState' property :port_name, as: 'portName' end end class RegionInstanceGroupsSetNamedPortsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' collection :named_ports, as: 'namedPorts', class: Google::Apis::ComputeAlpha::NamedPort, decorator: Google::Apis::ComputeAlpha::NamedPort::Representation end end class RegionList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Region, decorator: Google::Apis::ComputeAlpha::Region::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RegionList::Warning, decorator: Google::Apis::ComputeAlpha::RegionList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RegionList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RegionList::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 RegionSetLabelsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' end end class ResourceCommitment # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount, :numeric_string => true, as: 'amount' property :type, as: 'type' end end class ResourceGroupReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :group, as: 'group' end end class Route # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :dest_range, as: 'destRange' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :network, as: 'network' property :next_hop_gateway, as: 'nextHopGateway' property :next_hop_instance, as: 'nextHopInstance' property :next_hop_ip, as: 'nextHopIp' property :next_hop_network, as: 'nextHopNetwork' property :next_hop_peering, as: 'nextHopPeering' property :next_hop_vpn_tunnel, as: 'nextHopVpnTunnel' property :priority, as: 'priority' property :self_link, as: 'selfLink' collection :tags, as: 'tags' collection :warnings, as: 'warnings', class: Google::Apis::ComputeAlpha::Route::Warning, decorator: Google::Apis::ComputeAlpha::Route::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::Route::Warning::Datum, decorator: Google::Apis::ComputeAlpha::Route::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 RouteList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Route, decorator: Google::Apis::ComputeAlpha::Route::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RouteList::Warning, decorator: Google::Apis::ComputeAlpha::RouteList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RouteList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RouteList::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 Router # @private class Representation < Google::Apis::Core::JsonRepresentation property :bgp, as: 'bgp', class: Google::Apis::ComputeAlpha::RouterBgp, decorator: Google::Apis::ComputeAlpha::RouterBgp::Representation collection :bgp_peers, as: 'bgpPeers', class: Google::Apis::ComputeAlpha::RouterBgpPeer, decorator: Google::Apis::ComputeAlpha::RouterBgpPeer::Representation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' collection :interfaces, as: 'interfaces', class: Google::Apis::ComputeAlpha::RouterInterface, decorator: Google::Apis::ComputeAlpha::RouterInterface::Representation property :kind, as: 'kind' property :name, as: 'name' collection :nats, as: 'nats', class: Google::Apis::ComputeAlpha::RouterNat, decorator: Google::Apis::ComputeAlpha::RouterNat::Representation property :network, as: 'network' property :region, as: 'region' property :self_link, as: 'selfLink' end end class RouterAdvertisedIpRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :range, as: 'range' end end class RouterAdvertisedPrefix # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :prefix, as: 'prefix' end end class RouterAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::RoutersScopedList, decorator: Google::Apis::ComputeAlpha::RoutersScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RouterAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::RouterAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RouterAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RouterAggregatedList::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 RouterBgp # @private class Representation < Google::Apis::Core::JsonRepresentation property :advertise_mode, as: 'advertiseMode' collection :advertised_groups, as: 'advertisedGroups' collection :advertised_ip_ranges, as: 'advertisedIpRanges', class: Google::Apis::ComputeAlpha::RouterAdvertisedIpRange, decorator: Google::Apis::ComputeAlpha::RouterAdvertisedIpRange::Representation collection :advertised_prefixs, as: 'advertisedPrefixs', class: Google::Apis::ComputeAlpha::RouterAdvertisedPrefix, decorator: Google::Apis::ComputeAlpha::RouterAdvertisedPrefix::Representation property :asn, as: 'asn' end end class RouterBgpPeer # @private class Representation < Google::Apis::Core::JsonRepresentation property :advertise_mode, as: 'advertiseMode' collection :advertised_groups, as: 'advertisedGroups' collection :advertised_ip_ranges, as: 'advertisedIpRanges', class: Google::Apis::ComputeAlpha::RouterAdvertisedIpRange, decorator: Google::Apis::ComputeAlpha::RouterAdvertisedIpRange::Representation collection :advertised_prefixs, as: 'advertisedPrefixs', class: Google::Apis::ComputeAlpha::RouterAdvertisedPrefix, decorator: Google::Apis::ComputeAlpha::RouterAdvertisedPrefix::Representation property :advertised_route_priority, as: 'advertisedRoutePriority' property :interface_name, as: 'interfaceName' property :ip_address, as: 'ipAddress' property :name, as: 'name' property :peer_asn, as: 'peerAsn' property :peer_ip_address, as: 'peerIpAddress' end end class RouterInterface # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_range, as: 'ipRange' property :linked_interconnect_attachment, as: 'linkedInterconnectAttachment' property :linked_vpn_tunnel, as: 'linkedVpnTunnel' property :name, as: 'name' end end class RouterList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Router, decorator: Google::Apis::ComputeAlpha::Router::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RouterList::Warning, decorator: Google::Apis::ComputeAlpha::RouterList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RouterList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RouterList::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 RouterNat # @private class Representation < Google::Apis::Core::JsonRepresentation collection :auto_allocated_nat_ips, as: 'autoAllocatedNatIps' property :name, as: 'name' property :nat_ip_allocate_option, as: 'natIpAllocateOption' collection :nat_ips, as: 'natIps' property :source_subnetwork_ip_ranges_to_nat, as: 'sourceSubnetworkIpRangesToNat' collection :subnetworks, as: 'subnetworks', class: Google::Apis::ComputeAlpha::RouterNatSubnetworkToNat, decorator: Google::Apis::ComputeAlpha::RouterNatSubnetworkToNat::Representation end end class RouterNatSubnetworkToNat # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' collection :secondary_ip_range_names, as: 'secondaryIpRangeNames' collection :source_ip_ranges_to_nats, as: 'sourceIpRangesToNats' end end class RouterStatus # @private class Representation < Google::Apis::Core::JsonRepresentation collection :best_routes, as: 'bestRoutes', class: Google::Apis::ComputeAlpha::Route, decorator: Google::Apis::ComputeAlpha::Route::Representation collection :best_routes_for_router, as: 'bestRoutesForRouter', class: Google::Apis::ComputeAlpha::Route, decorator: Google::Apis::ComputeAlpha::Route::Representation collection :bgp_peer_status, as: 'bgpPeerStatus', class: Google::Apis::ComputeAlpha::RouterStatusBgpPeerStatus, decorator: Google::Apis::ComputeAlpha::RouterStatusBgpPeerStatus::Representation collection :nat_status, as: 'natStatus', class: Google::Apis::ComputeAlpha::RouterStatusNatStatus, decorator: Google::Apis::ComputeAlpha::RouterStatusNatStatus::Representation property :network, as: 'network' end end class RouterStatusBgpPeerStatus # @private class Representation < Google::Apis::Core::JsonRepresentation collection :advertised_routes, as: 'advertisedRoutes', class: Google::Apis::ComputeAlpha::Route, decorator: Google::Apis::ComputeAlpha::Route::Representation property :ip_address, as: 'ipAddress' property :linked_vpn_tunnel, as: 'linkedVpnTunnel' property :name, as: 'name' property :num_learned_routes, as: 'numLearnedRoutes' property :peer_ip_address, as: 'peerIpAddress' property :state, as: 'state' property :status, as: 'status' property :uptime, as: 'uptime' property :uptime_seconds, as: 'uptimeSeconds' end end class RouterStatusNatStatus # @private class Representation < Google::Apis::Core::JsonRepresentation collection :auto_allocated_nat_ips, as: 'autoAllocatedNatIps' property :min_extra_nat_ips_needed, as: 'minExtraNatIpsNeeded' property :name, as: 'name' property :num_vm_endpoints_with_nat_mappings, as: 'numVmEndpointsWithNatMappings' collection :user_allocated_nat_ip_resources, as: 'userAllocatedNatIpResources' collection :user_allocated_nat_ips, as: 'userAllocatedNatIps' end end class RouterStatusResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :result, as: 'result', class: Google::Apis::ComputeAlpha::RouterStatus, decorator: Google::Apis::ComputeAlpha::RouterStatus::Representation end end class RoutersPreviewResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource, as: 'resource', class: Google::Apis::ComputeAlpha::Router, decorator: Google::Apis::ComputeAlpha::Router::Representation end end class RoutersScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :routers, as: 'routers', class: Google::Apis::ComputeAlpha::Router, decorator: Google::Apis::ComputeAlpha::Router::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RoutersScopedList::Warning, decorator: Google::Apis::ComputeAlpha::RoutersScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::RoutersScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::RoutersScopedList::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 Rule # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' collection :conditions, as: 'conditions', class: Google::Apis::ComputeAlpha::Condition, decorator: Google::Apis::ComputeAlpha::Condition::Representation property :description, as: 'description' collection :ins, as: 'ins' collection :log_configs, as: 'logConfigs', class: Google::Apis::ComputeAlpha::LogConfig, decorator: Google::Apis::ComputeAlpha::LogConfig::Representation collection :not_ins, as: 'notIns' collection :permissions, as: 'permissions' end end class SslHealthCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :port, as: 'port' property :port_name, as: 'portName' property :port_specification, as: 'portSpecification' property :proxy_header, as: 'proxyHeader' property :request, as: 'request' property :response, as: 'response' end end class Scheduling # @private class Representation < Google::Apis::Core::JsonRepresentation property :automatic_restart, as: 'automaticRestart' property :on_host_maintenance, as: 'onHostMaintenance' property :preemptible, as: 'preemptible' end end class SecurityPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :fingerprint, :base64 => true, as: 'fingerprint' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' collection :rules, as: 'rules', class: Google::Apis::ComputeAlpha::SecurityPolicyRule, decorator: Google::Apis::ComputeAlpha::SecurityPolicyRule::Representation property :self_link, as: 'selfLink' end end class SecurityPolicyList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::SecurityPolicy, decorator: Google::Apis::ComputeAlpha::SecurityPolicy::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::SecurityPolicyList::Warning, decorator: Google::Apis::ComputeAlpha::SecurityPolicyList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::SecurityPolicyList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::SecurityPolicyList::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 SecurityPolicyReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :security_policy, as: 'securityPolicy' end end class SecurityPolicyRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' property :description, as: 'description' property :kind, as: 'kind' property :match, as: 'match', class: Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcher, decorator: Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcher::Representation property :preview, as: 'preview' property :priority, as: 'priority' end end class SecurityPolicyRuleMatcher # @private class Representation < Google::Apis::Core::JsonRepresentation property :config, as: 'config', class: Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcherConfig, decorator: Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcherConfig::Representation property :expr, as: 'expr', class: Google::Apis::ComputeAlpha::Expr, decorator: Google::Apis::ComputeAlpha::Expr::Representation collection :src_ip_ranges, as: 'srcIpRanges' property :versioned_expr, as: 'versionedExpr' end end class SecurityPolicyRuleMatcherConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :src_ip_ranges, as: 'srcIpRanges' end end class SerialPortOutput # @private class Representation < Google::Apis::Core::JsonRepresentation property :contents, as: 'contents' property :kind, as: 'kind' property :next, :numeric_string => true, as: 'next' property :self_link, as: 'selfLink' property :start, :numeric_string => true, as: 'start' end end class ServiceAccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' collection :scopes, as: 'scopes' end end class ShieldedVmConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :enable_secure_boot, as: 'enableSecureBoot' property :enable_vtpm, as: 'enableVtpm' end end class SignedUrlKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :key_name, as: 'keyName' property :key_value, as: 'keyValue' end end class Snapshot # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :disk_size_gb, :numeric_string => true, as: 'diskSizeGb' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' collection :license_codes, as: 'licenseCodes' collection :licenses, as: 'licenses' property :name, as: 'name' property :self_link, as: 'selfLink' property :snapshot_encryption_key, as: 'snapshotEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :source_disk, as: 'sourceDisk' property :source_disk_encryption_key, as: 'sourceDiskEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :source_disk_id, as: 'sourceDiskId' property :status, as: 'status' property :storage_bytes, :numeric_string => true, as: 'storageBytes' property :storage_bytes_status, as: 'storageBytesStatus' collection :storage_locations, as: 'storageLocations' end end class SnapshotList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Snapshot, decorator: Google::Apis::ComputeAlpha::Snapshot::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::SnapshotList::Warning, decorator: Google::Apis::ComputeAlpha::SnapshotList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::SnapshotList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::SnapshotList::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 SourceInstanceParams # @private class Representation < Google::Apis::Core::JsonRepresentation collection :disk_configs, as: 'diskConfigs', class: Google::Apis::ComputeAlpha::DiskInstantiationConfig, decorator: Google::Apis::ComputeAlpha::DiskInstantiationConfig::Representation end end class SslCertificate # @private class Representation < Google::Apis::Core::JsonRepresentation 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::ComputeAlpha::SslCertificateManagedSslCertificate, decorator: Google::Apis::ComputeAlpha::SslCertificateManagedSslCertificate::Representation property :name, as: 'name' property :private_key, as: 'privateKey' property :self_link, as: 'selfLink' property :self_managed, as: 'selfManaged', class: Google::Apis::ComputeAlpha::SslCertificateSelfManagedSslCertificate, decorator: Google::Apis::ComputeAlpha::SslCertificateSelfManagedSslCertificate::Representation collection :subject_alternative_names, as: 'subjectAlternativeNames' property :type, as: 'type' end end class SslCertificateList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::SslCertificate, decorator: Google::Apis::ComputeAlpha::SslCertificate::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::SslCertificateList::Warning, decorator: Google::Apis::ComputeAlpha::SslCertificateList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::SslCertificateList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::SslCertificateList::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 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 SslPoliciesList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::SslPolicy, decorator: Google::Apis::ComputeAlpha::SslPolicy::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::SslPoliciesList::Warning, decorator: Google::Apis::ComputeAlpha::SslPoliciesList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::SslPoliciesList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::SslPoliciesList::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 SslPoliciesListAvailableFeaturesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :features, as: 'features' end end class SslPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' collection :custom_features, as: 'customFeatures' property :description, as: 'description' collection :enabled_features, as: 'enabledFeatures' property :fingerprint, :base64 => true, as: 'fingerprint' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :min_tls_version, as: 'minTlsVersion' property :name, as: 'name' property :profile, as: 'profile' property :self_link, as: 'selfLink' collection :warnings, as: 'warnings', class: Google::Apis::ComputeAlpha::SslPolicy::Warning, decorator: Google::Apis::ComputeAlpha::SslPolicy::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::SslPolicy::Warning::Datum, decorator: Google::Apis::ComputeAlpha::SslPolicy::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 SslPolicyReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :ssl_policy, as: 'sslPolicy' end end class StatefulPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :preserved_resources, as: 'preservedResources', class: Google::Apis::ComputeAlpha::StatefulPolicyPreservedResources, decorator: Google::Apis::ComputeAlpha::StatefulPolicyPreservedResources::Representation end end class StatefulPolicyPreservedDisk # @private class Representation < Google::Apis::Core::JsonRepresentation property :device_name, as: 'deviceName' end end class StatefulPolicyPreservedResources # @private class Representation < Google::Apis::Core::JsonRepresentation collection :disks, as: 'disks', class: Google::Apis::ComputeAlpha::StatefulPolicyPreservedDisk, decorator: Google::Apis::ComputeAlpha::StatefulPolicyPreservedDisk::Representation end end class Subnetwork # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_subnet_cidr_routes_overlap, as: 'allowSubnetCidrRoutesOverlap' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :enable_flow_logs, as: 'enableFlowLogs' property :enable_private_v6_access, as: 'enablePrivateV6Access' property :fingerprint, :base64 => true, as: 'fingerprint' property :gateway_address, as: 'gatewayAddress' property :id, :numeric_string => true, as: 'id' property :ip_cidr_range, as: 'ipCidrRange' property :kind, as: 'kind' property :name, as: 'name' property :network, as: 'network' property :private_ip_google_access, as: 'privateIpGoogleAccess' property :region, as: 'region' collection :secondary_ip_ranges, as: 'secondaryIpRanges', class: Google::Apis::ComputeAlpha::SubnetworkSecondaryRange, decorator: Google::Apis::ComputeAlpha::SubnetworkSecondaryRange::Representation property :self_link, as: 'selfLink' end end class SubnetworkAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::SubnetworksScopedList, decorator: Google::Apis::ComputeAlpha::SubnetworksScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::SubnetworkAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::SubnetworkAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::SubnetworkAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::SubnetworkAggregatedList::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 SubnetworkList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Subnetwork, decorator: Google::Apis::ComputeAlpha::Subnetwork::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::SubnetworkList::Warning, decorator: Google::Apis::ComputeAlpha::SubnetworkList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::SubnetworkList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::SubnetworkList::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 SubnetworkSecondaryRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_cidr_range, as: 'ipCidrRange' property :range_name, as: 'rangeName' end end class SubnetworksExpandIpCidrRangeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_cidr_range, as: 'ipCidrRange' end end class SubnetworksScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :subnetworks, as: 'subnetworks', class: Google::Apis::ComputeAlpha::Subnetwork, decorator: Google::Apis::ComputeAlpha::Subnetwork::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::SubnetworksScopedList::Warning, decorator: Google::Apis::ComputeAlpha::SubnetworksScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::SubnetworksScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::SubnetworksScopedList::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 SubnetworksSetPrivateIpGoogleAccessRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :private_ip_google_access, as: 'privateIpGoogleAccess' end end class TcpHealthCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :port, as: 'port' property :port_name, as: 'portName' property :port_specification, as: 'portSpecification' property :proxy_header, as: 'proxyHeader' property :request, as: 'request' property :response, as: 'response' end end class Tags # @private class Representation < Google::Apis::Core::JsonRepresentation property :fingerprint, :base64 => true, as: 'fingerprint' collection :items, as: 'items' end end class TargetHttpProxy # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :self_link, as: 'selfLink' property :url_map, as: 'urlMap' end end class TargetHttpProxyList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetHttpProxy, decorator: Google::Apis::ComputeAlpha::TargetHttpProxy::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetHttpProxyList::Warning, decorator: Google::Apis::ComputeAlpha::TargetHttpProxyList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetHttpProxyList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetHttpProxyList::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 TargetHttpsProxiesSetQuicOverrideRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :quic_override, as: 'quicOverride' end end class TargetHttpsProxiesSetSslCertificatesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ssl_certificates, as: 'sslCertificates' end end class TargetHttpsProxy # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_ssl_policy, as: 'clientSslPolicy' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :quic_override, as: 'quicOverride' property :self_link, as: 'selfLink' collection :ssl_certificates, as: 'sslCertificates' property :ssl_policy, as: 'sslPolicy' property :url_map, as: 'urlMap' end end class TargetHttpsProxyList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetHttpsProxy, decorator: Google::Apis::ComputeAlpha::TargetHttpsProxy::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetHttpsProxyList::Warning, decorator: Google::Apis::ComputeAlpha::TargetHttpsProxyList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetHttpsProxyList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetHttpsProxyList::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 TargetInstance # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :instance, as: 'instance' property :kind, as: 'kind' property :name, as: 'name' property :nat_policy, as: 'natPolicy' property :self_link, as: 'selfLink' property :zone, as: 'zone' end end class TargetInstanceAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetInstancesScopedList, decorator: Google::Apis::ComputeAlpha::TargetInstancesScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetInstanceAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetInstanceAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetInstanceAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetInstanceAggregatedList::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 TargetInstanceList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetInstance, decorator: Google::Apis::ComputeAlpha::TargetInstance::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetInstanceList::Warning, decorator: Google::Apis::ComputeAlpha::TargetInstanceList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetInstanceList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetInstanceList::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 TargetInstancesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :target_instances, as: 'targetInstances', class: Google::Apis::ComputeAlpha::TargetInstance, decorator: Google::Apis::ComputeAlpha::TargetInstance::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetInstancesScopedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetInstancesScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetInstancesScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetInstancesScopedList::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 TargetPool # @private class Representation < Google::Apis::Core::JsonRepresentation property :backup_pool, as: 'backupPool' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :failover_ratio, as: 'failoverRatio' collection :health_checks, as: 'healthChecks' property :id, :numeric_string => true, as: 'id' collection :instances, as: 'instances' property :kind, as: 'kind' property :name, as: 'name' property :region, as: 'region' property :self_link, as: 'selfLink' property :session_affinity, as: 'sessionAffinity' end end class TargetPoolAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetPoolsScopedList, decorator: Google::Apis::ComputeAlpha::TargetPoolsScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetPoolAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetPoolAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetPoolAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetPoolAggregatedList::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 TargetPoolInstanceHealth # @private class Representation < Google::Apis::Core::JsonRepresentation collection :health_status, as: 'healthStatus', class: Google::Apis::ComputeAlpha::HealthStatus, decorator: Google::Apis::ComputeAlpha::HealthStatus::Representation property :kind, as: 'kind' end end class TargetPoolList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetPool, decorator: Google::Apis::ComputeAlpha::TargetPool::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetPoolList::Warning, decorator: Google::Apis::ComputeAlpha::TargetPoolList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetPoolList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetPoolList::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 TargetPoolsAddHealthCheckRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :health_checks, as: 'healthChecks', class: Google::Apis::ComputeAlpha::HealthCheckReference, decorator: Google::Apis::ComputeAlpha::HealthCheckReference::Representation end end class TargetPoolsAddInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances', class: Google::Apis::ComputeAlpha::InstanceReference, decorator: Google::Apis::ComputeAlpha::InstanceReference::Representation end end class TargetPoolsRemoveHealthCheckRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :health_checks, as: 'healthChecks', class: Google::Apis::ComputeAlpha::HealthCheckReference, decorator: Google::Apis::ComputeAlpha::HealthCheckReference::Representation end end class TargetPoolsRemoveInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :instances, as: 'instances', class: Google::Apis::ComputeAlpha::InstanceReference, decorator: Google::Apis::ComputeAlpha::InstanceReference::Representation end end class TargetPoolsScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :target_pools, as: 'targetPools', class: Google::Apis::ComputeAlpha::TargetPool, decorator: Google::Apis::ComputeAlpha::TargetPool::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetPoolsScopedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetPoolsScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetPoolsScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetPoolsScopedList::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 TargetReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :target, as: 'target' end end class TargetSslProxiesSetBackendServiceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :service, as: 'service' end end class TargetSslProxiesSetProxyHeaderRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :proxy_header, as: 'proxyHeader' end end class TargetSslProxiesSetSslCertificatesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ssl_certificates, as: 'sslCertificates' end end class TargetSslProxy # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_ssl_policy, as: 'clientSslPolicy' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :proxy_header, as: 'proxyHeader' property :self_link, as: 'selfLink' property :service, as: 'service' collection :ssl_certificates, as: 'sslCertificates' property :ssl_policy, as: 'sslPolicy' end end class TargetSslProxyList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetSslProxy, decorator: Google::Apis::ComputeAlpha::TargetSslProxy::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetSslProxyList::Warning, decorator: Google::Apis::ComputeAlpha::TargetSslProxyList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetSslProxyList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetSslProxyList::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 TargetTcpProxiesSetBackendServiceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :service, as: 'service' end end class TargetTcpProxiesSetProxyHeaderRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :proxy_header, as: 'proxyHeader' end end class TargetTcpProxy # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :proxy_header, as: 'proxyHeader' property :self_link, as: 'selfLink' property :service, as: 'service' end end class TargetTcpProxyList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetTcpProxy, decorator: Google::Apis::ComputeAlpha::TargetTcpProxy::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetTcpProxyList::Warning, decorator: Google::Apis::ComputeAlpha::TargetTcpProxyList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetTcpProxyList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetTcpProxyList::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 TargetVpnGateway # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' collection :forwarding_rules, as: 'forwardingRules' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' property :name, as: 'name' property :network, as: 'network' property :region, as: 'region' property :self_link, as: 'selfLink' property :status, as: 'status' collection :tunnels, as: 'tunnels' end end class TargetVpnGatewayAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetVpnGatewaysScopedList, decorator: Google::Apis::ComputeAlpha::TargetVpnGatewaysScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList::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 TargetVpnGatewayList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetVpnGateway, decorator: Google::Apis::ComputeAlpha::TargetVpnGateway::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetVpnGatewayList::Warning, decorator: Google::Apis::ComputeAlpha::TargetVpnGatewayList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetVpnGatewayList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetVpnGatewayList::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 TargetVpnGatewaysScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :target_vpn_gateways, as: 'targetVpnGateways', class: Google::Apis::ComputeAlpha::TargetVpnGateway, decorator: Google::Apis::ComputeAlpha::TargetVpnGateway::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetVpnGatewaysScopedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetVpnGatewaysScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetVpnGatewaysScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetVpnGatewaysScopedList::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 TestFailure # @private class Representation < Google::Apis::Core::JsonRepresentation property :actual_service, as: 'actualService' property :expected_service, as: 'expectedService' property :host, as: 'host' property :path, as: 'path' end end class TestPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class UdpHealthCheck # @private class Representation < Google::Apis::Core::JsonRepresentation property :port, as: 'port' property :port_name, as: 'portName' property :request, as: 'request' property :response, as: 'response' end end class UrlMap # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :default_service, as: 'defaultService' property :description, as: 'description' property :fingerprint, :base64 => true, as: 'fingerprint' collection :host_rules, as: 'hostRules', class: Google::Apis::ComputeAlpha::HostRule, decorator: Google::Apis::ComputeAlpha::HostRule::Representation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' collection :path_matchers, as: 'pathMatchers', class: Google::Apis::ComputeAlpha::PathMatcher, decorator: Google::Apis::ComputeAlpha::PathMatcher::Representation property :self_link, as: 'selfLink' collection :tests, as: 'tests', class: Google::Apis::ComputeAlpha::UrlMapTest, decorator: Google::Apis::ComputeAlpha::UrlMapTest::Representation end end class UrlMapList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::UrlMap, decorator: Google::Apis::ComputeAlpha::UrlMap::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::UrlMapList::Warning, decorator: Google::Apis::ComputeAlpha::UrlMapList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::UrlMapList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::UrlMapList::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 UrlMapReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :url_map, as: 'urlMap' end end class UrlMapTest # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :host, as: 'host' property :path, as: 'path' property :service, as: 'service' end end class UrlMapValidationResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :load_errors, as: 'loadErrors' property :load_succeeded, as: 'loadSucceeded' collection :test_failures, as: 'testFailures', class: Google::Apis::ComputeAlpha::TestFailure, decorator: Google::Apis::ComputeAlpha::TestFailure::Representation property :test_passed, as: 'testPassed' end end class UrlMapsValidateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource, as: 'resource', class: Google::Apis::ComputeAlpha::UrlMap, decorator: Google::Apis::ComputeAlpha::UrlMap::Representation end end class UrlMapsValidateResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :result, as: 'result', class: Google::Apis::ComputeAlpha::UrlMapValidationResult, decorator: Google::Apis::ComputeAlpha::UrlMapValidationResult::Representation end end class UsableSubnetwork # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_cidr_range, as: 'ipCidrRange' property :network, as: 'network' property :subnetwork, as: 'subnetwork' end end class UsableSubnetworksAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::UsableSubnetwork, decorator: Google::Apis::ComputeAlpha::UsableSubnetwork::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::UsableSubnetworksAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::UsableSubnetworksAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::UsableSubnetworksAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::UsableSubnetworksAggregatedList::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 UsageExportLocation # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_name, as: 'bucketName' property :report_name_prefix, as: 'reportNamePrefix' end end class VmMaintenancePolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :maintenance_window, as: 'maintenanceWindow', class: Google::Apis::ComputeAlpha::MaintenanceWindow, decorator: Google::Apis::ComputeAlpha::MaintenanceWindow::Representation end end class VpnTunnel # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :detailed_status, as: 'detailedStatus' property :id, :numeric_string => true, as: 'id' property :ike_version, as: 'ikeVersion' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' collection :local_traffic_selector, as: 'localTrafficSelector' property :name, as: 'name' property :peer_ip, as: 'peerIp' property :region, as: 'region' collection :remote_traffic_selector, as: 'remoteTrafficSelector' property :router, as: 'router' property :self_link, as: 'selfLink' property :shared_secret, as: 'sharedSecret' property :shared_secret_hash, as: 'sharedSecretHash' property :status, as: 'status' property :target_vpn_gateway, as: 'targetVpnGateway' end end class VpnTunnelAggregatedList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' hash :items, as: 'items', class: Google::Apis::ComputeAlpha::VpnTunnelsScopedList, decorator: Google::Apis::ComputeAlpha::VpnTunnelsScopedList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::VpnTunnelAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::VpnTunnelAggregatedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::VpnTunnelAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::VpnTunnelAggregatedList::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 VpnTunnelList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::VpnTunnel, decorator: Google::Apis::ComputeAlpha::VpnTunnel::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::VpnTunnelList::Warning, decorator: Google::Apis::ComputeAlpha::VpnTunnelList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::VpnTunnelList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::VpnTunnelList::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 VpnTunnelsScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :vpn_tunnels, as: 'vpnTunnels', class: Google::Apis::ComputeAlpha::VpnTunnel, decorator: Google::Apis::ComputeAlpha::VpnTunnel::Representation property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::VpnTunnelsScopedList::Warning, decorator: Google::Apis::ComputeAlpha::VpnTunnelsScopedList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::VpnTunnelsScopedList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::VpnTunnelsScopedList::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 XpnHostList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Project, decorator: Google::Apis::ComputeAlpha::Project::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::XpnHostList::Warning, decorator: Google::Apis::ComputeAlpha::XpnHostList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::XpnHostList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::XpnHostList::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 XpnResourceId # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :type, as: 'type' end end class Zone # @private class Representation < Google::Apis::Core::JsonRepresentation collection :available_cpu_platforms, as: 'availableCpuPlatforms' property :creation_timestamp, as: 'creationTimestamp' property :deprecated, as: 'deprecated', class: Google::Apis::ComputeAlpha::DeprecationStatus, decorator: Google::Apis::ComputeAlpha::DeprecationStatus::Representation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :region, as: 'region' property :self_link, as: 'selfLink' property :status, as: 'status' end end class ZoneList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ComputeAlpha::Zone, decorator: Google::Apis::ComputeAlpha::Zone::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::ZoneList::Warning, decorator: Google::Apis::ComputeAlpha::ZoneList::Warning::Representation end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ComputeAlpha::ZoneList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::ZoneList::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 ZoneSetLabelsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' end end end end end google-api-client-0.19.8/generated/google/apis/compute_alpha/classes.rb0000644000004100000410000412241713252673043026131 0ustar www-datawww-data# 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 ComputeAlpha # A specification of the type and number of accelerator cards attached to the # instance. class AcceleratorConfig include Google::Apis::Core::Hashable # The number of the guest accelerator cards exposed to this instance. # Corresponds to the JSON property `acceleratorCount` # @return [Fixnum] attr_accessor :accelerator_count # Full or partial URL of the accelerator type resource to attach to this # instance. If you are creating an instance template, specify only the # accelerator name. # Corresponds to the JSON property `acceleratorType` # @return [String] attr_accessor :accelerator_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accelerator_count = args[:accelerator_count] if args.key?(:accelerator_count) @accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type) end end # An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) (== # resource_for v1.acceleratorTypes ==) class AcceleratorType include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # Deprecation status for a public resource. # Corresponds to the JSON property `deprecated` # @return [Google::Apis::ComputeAlpha::DeprecationStatus] attr_accessor :deprecated # [Output Only] An optional textual description of the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The type of the resource. Always compute#acceleratorType for # accelerator types. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Maximum accelerator cards allowed per instance. # Corresponds to the JSON property `maximumCardsPerInstance` # @return [Fixnum] attr_accessor :maximum_cards_per_instance # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] Server-defined fully-qualified URL for this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] The name of the zone where the accelerator type resides, such as # us-central1-a. 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 `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @deprecated = args[:deprecated] if args.key?(:deprecated) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @maximum_cards_per_instance = args[:maximum_cards_per_instance] if args.key?(:maximum_cards_per_instance) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) @zone = args[:zone] if args.key?(:zone) end end # class AcceleratorTypeAggregatedList 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 AcceleratorTypesScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList # for aggregated lists of accelerator types. # 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::AcceleratorTypeAggregatedList::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 # Contains a list of accelerator types. class AcceleratorTypeList 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 AcceleratorType resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#acceleratorTypeList for lists # of accelerator types. # 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::AcceleratorTypeList::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 # class AcceleratorTypesScopedList include Google::Apis::Core::Hashable # [Output Only] List of accelerator types contained in this scope. # Corresponds to the JSON property `acceleratorTypes` # @return [Array] attr_accessor :accelerator_types # [Output Only] An informational warning that appears when the accelerator types # list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::AcceleratorTypesScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accelerator_types = args[:accelerator_types] if args.key?(:accelerator_types) @warning = args[:warning] if args.key?(:warning) end # [Output Only] An informational warning that appears when the accelerator types # list is empty. 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 # An access configuration attached to an instance's network interface. Only one # access config per instance is supported. class AccessConfig include Google::Apis::Core::Hashable # [Output Only] Type of the resource. Always compute#accessConfig for access # configs. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of this access configuration. The default and recommended name is # External NAT but you can use any arbitrary string you would like. For example, # My external IP or Network Access. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An external IP address associated with this instance. Specify an unused static # external IP address available to the project or leave this field undefined to # use an IP from a shared ephemeral IP address pool. If you specify a static # external IP address, it must live in the same region as the zone of the # instance. # Corresponds to the JSON property `natIP` # @return [String] attr_accessor :nat_ip # This signifies the networking tier used for configuring this access # configuration and can only take the following values: PREMIUM, STANDARD. # If an AccessConfig is specified without a valid external IP address, an # ephemeral IP will be created with this networkTier. # If an AccessConfig with a valid external IP address is specified, it must # match that of the networkTier associated with the Address resource owning that # IP. # Corresponds to the JSON property `networkTier` # @return [String] attr_accessor :network_tier # [Output Only] The public DNS domain name for the instance. # Corresponds to the JSON property `publicDnsName` # @return [String] attr_accessor :public_dns_name # The DNS domain name for the public PTR record. This field can only be set when # the set_public_ptr field is enabled. # Corresponds to the JSON property `publicPtrDomainName` # @return [String] attr_accessor :public_ptr_domain_name # Specifies whether a public DNS ?A? record should be created for the external # IP address of this access configuration. # Corresponds to the JSON property `setPublicDns` # @return [Boolean] attr_accessor :set_public_dns alias_method :set_public_dns?, :set_public_dns # Specifies whether a public DNS ?PTR? record should be created to map the # external IP address of the instance to a DNS domain name. # Corresponds to the JSON property `setPublicPtr` # @return [Boolean] attr_accessor :set_public_ptr alias_method :set_public_ptr?, :set_public_ptr # The type of configuration. The default and only option is ONE_TO_ONE_NAT. # 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) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @nat_ip = args[:nat_ip] if args.key?(:nat_ip) @network_tier = args[:network_tier] if args.key?(:network_tier) @public_dns_name = args[:public_dns_name] if args.key?(:public_dns_name) @public_ptr_domain_name = args[:public_ptr_domain_name] if args.key?(:public_ptr_domain_name) @set_public_dns = args[:set_public_dns] if args.key?(:set_public_dns) @set_public_ptr = args[:set_public_ptr] if args.key?(:set_public_ptr) @type = args[:type] if args.key?(:type) end end # A reserved address resource. (== resource_for beta.addresses ==) (== # resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== # resource_for v1.globalAddresses ==) class Address include Google::Apis::Core::Hashable # The static IP address represented by this resource. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, # defaults to EXTERNAL. # Corresponds to the JSON property `addressType` # @return [String] attr_accessor :address_type # [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. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The IP Version that will be used by this address. Valid options are IPV4 or # IPV6. This can only be specified for a global address. # Corresponds to the JSON property `ipVersion` # @return [String] attr_accessor :ip_version # [Output Only] Type of the resource. Always compute#address for addresses. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for the labels being applied to this Address, which is # essentially a hash of the labels set used for optimistic locking. The # fingerprint is initially generated by Compute Engine and changes after every # request to modify or update labels. You must always provide an up-to-date # fingerprint hash in order to update or change labels. # To see the latest fingerprint, make a get() request to retrieve an Address. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # 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 # This signifies the networking tier used for configuring this Address and can # only take the following values: PREMIUM , STANDARD. # If this field is not specified, it is assumed to be PREMIUM. # Corresponds to the JSON property `networkTier` # @return [String] attr_accessor :network_tier # [Output Only] URL of the region where the regional address resides. This field # is not applicable to global addresses. You must specify this field as part of # the HTTP request URL. You cannot set this 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 # [Output Only] The status of the address, which can be one of RESERVING, # RESERVED, or IN_USE. An address that is RESERVING is currently in the process # of being reserved. A RESERVED address is currently reserved and available to # use. An IN_USE address is currently being used by another resource and is not # available. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The URL of the subnetwork in which to reserve the address. If an IP address is # specified, it must be within the subnetwork's IP range. This field can only be # used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork # [Output Only] The URLs of the resources that are using this address. # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @address = args[:address] if args.key?(:address) @address_type = args[:address_type] if args.key?(:address_type) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @ip_version = args[:ip_version] if args.key?(:ip_version) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @network_tier = args[:network_tier] if args.key?(:network_tier) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) @users = args[:users] if args.key?(:users) end end # class AddressAggregatedList 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 AddressesScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#addressAggregatedList for # aggregated lists of addresses. # 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::AddressAggregatedList::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 # Contains a list of addresses. class AddressList 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 Address resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#addressList for lists of # addresses. # 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::AddressList::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 # class AddressesScopedList include Google::Apis::Core::Hashable # [Output Only] List of addresses contained in this scope. # Corresponds to the JSON property `addresses` # @return [Array] attr_accessor :addresses # [Output Only] Informational warning which replaces the list of addresses when # the list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::AddressesScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @addresses = args[:addresses] if args.key?(:addresses) @warning = args[:warning] if args.key?(:warning) end # [Output Only] Informational warning which replaces the list of addresses when # the list is empty. 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 # An alias IP range attached to an instance's network interface. class AliasIpRange include Google::Apis::Core::Hashable # The IP CIDR range represented by this alias IP range. This IP CIDR range must # belong to the specified subnetwork and cannot contain IP addresses reserved by # system or used by other network interfaces. This range may be a single IP # address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10. # 1.2.0/24). # Corresponds to the JSON property `ipCidrRange` # @return [String] attr_accessor :ip_cidr_range # Optional subnetwork secondary range name specifying the secondary range from # which to allocate the IP CIDR range for this alias IP range. If left # unspecified, the primary range of the subnetwork will be used. # Corresponds to the JSON property `subnetworkRangeName` # @return [String] attr_accessor :subnetwork_range_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range) @subnetwork_range_name = args[:subnetwork_range_name] if args.key?(:subnetwork_range_name) end end # An instance-attached disk resource. class AttachedDisk include Google::Apis::Core::Hashable # Specifies whether the disk will be auto-deleted when the instance is deleted ( # but not when the disk is detached from the instance). # Corresponds to the JSON property `autoDelete` # @return [Boolean] attr_accessor :auto_delete alias_method :auto_delete?, :auto_delete # Indicates that this is a boot disk. The virtual machine will use the first # partition of the disk for its root filesystem. # Corresponds to the JSON property `boot` # @return [Boolean] attr_accessor :boot alias_method :boot?, :boot # Specifies a unique device name of your choice that is reflected into the /dev/ # disk/by-id/google-* tree of a Linux operating system running within the # instance. This name can be used to reference the device for mounting, resizing, # and so on, from within the instance. # If not specified, the server chooses a default device name to apply to this # disk, in the form persistent-disks-x, where x is a number assigned by Google # Compute Engine. This field is only applicable for persistent disks. # Corresponds to the JSON property `deviceName` # @return [String] attr_accessor :device_name # Represents a customer-supplied encryption key # Corresponds to the JSON property `diskEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :disk_encryption_key # The size of the disk in base-2 GB. This supersedes disk_size_gb in # InitializeParams. # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] attr_accessor :disk_size_gb # A list of features to enable on the guest operating system. Applicable only # for bootable images. Read Enabling guest operating system features to see a # list of available options. # Corresponds to the JSON property `guestOsFeatures` # @return [Array] attr_accessor :guest_os_features # [Output Only] A zero-based index to this disk, where 0 is reserved for the # boot disk. If you have many disks attached to an instance, each disk would # have a unique index number. # Corresponds to the JSON property `index` # @return [Fixnum] attr_accessor :index # [Input Only] Specifies the parameters for a new disk that will be created # alongside the new instance. Use initialization parameters to create boot disks # or local SSDs attached to the new instance. # This property is mutually exclusive with the source property; you can only # define one or the other, but not both. # Corresponds to the JSON property `initializeParams` # @return [Google::Apis::ComputeAlpha::AttachedDiskInitializeParams] attr_accessor :initialize_params # Specifies the disk interface to use for attaching this disk, which is either # SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and # the request will fail if you attempt to attach a persistent disk in any other # format than SCSI. Local SSDs can use either NVME or SCSI. For performance # characteristics of SCSI over NVMe, see Local SSD performance. # Corresponds to the JSON property `interface` # @return [String] attr_accessor :interface # [Output Only] Type of the resource. Always compute#attachedDisk for attached # disks. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Any valid publicly visible licenses. # Corresponds to the JSON property `licenses` # @return [Array] attr_accessor :licenses # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not # specified, the default is to attach the disk in READ_WRITE mode. # Corresponds to the JSON property `mode` # @return [String] attr_accessor :mode # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field # is set to PRESERVED iff the LocalSSD data has been saved to a persistent # location by customer request. (see the discard_local_ssd option on Stop/ # Suspend). Read-only in the api. # Corresponds to the JSON property `savedState` # @return [String] attr_accessor :saved_state # Specifies a valid partial or full URL to an existing Persistent Disk resource. # When creating a new instance, one of initializeParams.sourceImage or disks. # source is required except for local SSD. # If desired, you can also attach existing non-root persistent disks using this # property. This field is only applicable for persistent disks. # Note that for InstanceTemplate, specify the disk name, not the URL for the # disk. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, # the default is PERSISTENT. # 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) @auto_delete = args[:auto_delete] if args.key?(:auto_delete) @boot = args[:boot] if args.key?(:boot) @device_name = args[:device_name] if args.key?(:device_name) @disk_encryption_key = args[:disk_encryption_key] if args.key?(:disk_encryption_key) @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features) @index = args[:index] if args.key?(:index) @initialize_params = args[:initialize_params] if args.key?(:initialize_params) @interface = args[:interface] if args.key?(:interface) @kind = args[:kind] if args.key?(:kind) @licenses = args[:licenses] if args.key?(:licenses) @mode = args[:mode] if args.key?(:mode) @saved_state = args[:saved_state] if args.key?(:saved_state) @source = args[:source] if args.key?(:source) @type = args[:type] if args.key?(:type) end end # [Input Only] Specifies the parameters for a new disk that will be created # alongside the new instance. Use initialization parameters to create boot disks # or local SSDs attached to the new instance. # This property is mutually exclusive with the source property; you can only # define one or the other, but not both. class AttachedDiskInitializeParams include Google::Apis::Core::Hashable # Specifies the disk name. If not specified, the default is to use the name of # the instance. # Corresponds to the JSON property `diskName` # @return [String] attr_accessor :disk_name # Specifies the size of the disk in base-2 GB. # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] attr_accessor :disk_size_gb # [Deprecated] Storage type of the disk. # Corresponds to the JSON property `diskStorageType` # @return [String] attr_accessor :disk_storage_type # Specifies the disk type to use to create the instance. If not specified, the # default is pd-standard, specified using the full URL. For example: # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd- # standard # Other values include pd-ssd and local-ssd. If you define this field, you can # provide either the full or partial URL. For example, the following are valid # values: # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/ # diskType # - projects/project/zones/zone/diskTypes/diskType # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the # name of the disk type, not URL. # Corresponds to the JSON property `diskType` # @return [String] attr_accessor :disk_type # Labels to apply to this disk. These can be later modified by the disks. # setLabels method. This field is only applicable for persistent disks. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The source image to create this disk. When creating a new instance, one of # initializeParams.sourceImage or disks.source is required except for local SSD. # To create a disk with one of the public operating system images, specify the # image by its family name. For example, specify family/debian-8 to use the # latest Debian 8 image: # projects/debian-cloud/global/images/family/debian-8 # Alternatively, use a specific version of a public operating system image: # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD # To create a disk with a custom image that you created, specify the image name # in the following format: # global/images/my-custom-image # You can also specify a custom image by its image family, which returns the # latest version of the image in that family. Replace the image name with family/ # family-name: # global/images/family/my-image-family # If the source image is deleted later, this field will not be set. # Corresponds to the JSON property `sourceImage` # @return [String] attr_accessor :source_image # Represents a customer-supplied encryption key # Corresponds to the JSON property `sourceImageEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :source_image_encryption_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disk_name = args[:disk_name] if args.key?(:disk_name) @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) @disk_storage_type = args[:disk_storage_type] if args.key?(:disk_storage_type) @disk_type = args[:disk_type] if args.key?(:disk_type) @labels = args[:labels] if args.key?(:labels) @source_image = args[:source_image] if args.key?(:source_image) @source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key) 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:foo@gmail.com" ] `, ` " # log_type": "DATA_WRITE", `, ` "log_type": "ADMIN_READ", ` ] `, ` "service": " # fooservice.googleapis.com" "audit_log_configs": [ ` "log_type": "DATA_READ", `, # ` "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] ` ] ` # ] ` # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail. # com from DATA_WRITE logging. class AuditConfig include Google::Apis::Core::Hashable # The configuration for logging of each type of permission. # Corresponds to the JSON property `auditLogConfigs` # @return [Array] attr_accessor :audit_log_configs # # Corresponds to the JSON property `exemptedMembers` # @return [Array] attr_accessor :exempted_members # 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) @exempted_members = args[:exempted_members] if args.key?(:exempted_members) @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:foo@gmail.com" ] `, ` "log_type": "DATA_WRITE", ` ] ` # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail. # com from DATA_READ logging. class AuditLogConfig include Google::Apis::Core::Hashable # Specifies the identities that do not cause logging for this type of permission. # Follows the same format of [Binding.members][]. # Corresponds to the JSON property `exemptedMembers` # @return [Array] 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 # Authorization-related information used by Cloud Audit Logging. class AuthorizationLoggingOptions include Google::Apis::Core::Hashable # The type of the permission that was checked. # Corresponds to the JSON property `permissionType` # @return [String] attr_accessor :permission_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permission_type = args[:permission_type] if args.key?(:permission_type) end end # Represents an Autoscaler resource. Autoscalers allow you to automatically # scale virtual machine instances in managed instance groups according to an # autoscaling policy that you define. For more information, read Autoscaling # Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1. # autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for # v1.regionAutoscalers ==) class Autoscaler include Google::Apis::Core::Hashable # Cloud Autoscaler policy. # Corresponds to the JSON property `autoscalingPolicy` # @return [Google::Apis::ComputeAlpha::AutoscalingPolicy] attr_accessor :autoscaling_policy # [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. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. # 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 # [Output Only] Target recommended MIG size computed by autoscaler. Autoscaler # calculates recommended MIG size even when autoscaling policy mode is different # from ON. This field is empty when autoscaler is not connected to the existing # managed instance group or autoscaler did not generate its first prediction. # Corresponds to the JSON property `recommendedSize` # @return [Fixnum] attr_accessor :recommended_size # [Output Only] URL of the region where the instance group resides (for # autoscalers living in regional scope). # 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 # [Output Only] The status of the autoscaler configuration. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] Human-readable details about the current state of the autoscaler. # Read the documentation for Commonly returned status messages for examples of # status messages you might encounter. # Corresponds to the JSON property `statusDetails` # @return [Array] attr_accessor :status_details # URL of the managed instance group that this autoscaler will scale. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target # [Output Only] URL of the zone where the instance group resides (for # autoscalers living in zonal scope). # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @autoscaling_policy = args[:autoscaling_policy] if args.key?(:autoscaling_policy) @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) @recommended_size = args[:recommended_size] if args.key?(:recommended_size) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) @status_details = args[:status_details] if args.key?(:status_details) @target = args[:target] if args.key?(:target) @zone = args[:zone] if args.key?(:zone) end end # class AutoscalerAggregatedList 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 AutoscalersScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#autoscalerAggregatedList for # aggregated lists of autoscalers. # 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::AutoscalerAggregatedList::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 # Contains a list of Autoscaler resources. class AutoscalerList 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 Autoscaler resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#autoscalerList for lists of # autoscalers. # 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::AutoscalerList::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 # class AutoscalerStatusDetails include Google::Apis::Core::Hashable # The status message. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message # The type of error returned. # 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) @message = args[:message] if args.key?(:message) @type = args[:type] if args.key?(:type) end end # class AutoscalersScopedList include Google::Apis::Core::Hashable # [Output Only] List of autoscalers contained in this scope. # Corresponds to the JSON property `autoscalers` # @return [Array] attr_accessor :autoscalers # [Output Only] Informational warning which replaces the list of autoscalers # when the list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::AutoscalersScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @autoscalers = args[:autoscalers] if args.key?(:autoscalers) @warning = args[:warning] if args.key?(:warning) end # [Output Only] Informational warning which replaces the list of autoscalers # when the list is empty. 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 # Cloud Autoscaler policy. class AutoscalingPolicy include Google::Apis::Core::Hashable # The number of seconds that the autoscaler should wait before it starts # collecting information from a new instance. This prevents the autoscaler from # collecting information when the instance is initializing, during which the # collected usage would not be reliable. The default time autoscaler waits is 60 # seconds. # Virtual machine initialization times might vary because of numerous factors. # We recommend that you test how long an instance may take to initialize. To do # this, create an instance and time the startup process. # Corresponds to the JSON property `coolDownPeriodSec` # @return [Fixnum] attr_accessor :cool_down_period_sec # CPU utilization policy. # Corresponds to the JSON property `cpuUtilization` # @return [Google::Apis::ComputeAlpha::AutoscalingPolicyCpuUtilization] attr_accessor :cpu_utilization # Configuration parameters of autoscaling based on a custom metric. # Corresponds to the JSON property `customMetricUtilizations` # @return [Array] attr_accessor :custom_metric_utilizations # Configuration parameters of autoscaling based on load balancing. # Corresponds to the JSON property `loadBalancingUtilization` # @return [Google::Apis::ComputeAlpha::AutoscalingPolicyLoadBalancingUtilization] attr_accessor :load_balancing_utilization # The maximum number of instances that the autoscaler can scale up to. This is # required when creating or updating an autoscaler. The maximum number of # replicas should not be lower than minimal number of replicas. # Corresponds to the JSON property `maxNumReplicas` # @return [Fixnum] attr_accessor :max_num_replicas # The minimum number of replicas that the autoscaler can scale down to. This # cannot be less than 0. If not provided, autoscaler will choose a default value # depending on maximum number of instances allowed. # Corresponds to the JSON property `minNumReplicas` # @return [Fixnum] attr_accessor :min_num_replicas # Defines operating mode for this policy. # Corresponds to the JSON property `mode` # @return [String] attr_accessor :mode # Configuration parameters of autoscaling based on queuing system. # Corresponds to the JSON property `queueBasedScaling` # @return [Google::Apis::ComputeAlpha::AutoscalingPolicyQueueBasedScaling] attr_accessor :queue_based_scaling def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cool_down_period_sec = args[:cool_down_period_sec] if args.key?(:cool_down_period_sec) @cpu_utilization = args[:cpu_utilization] if args.key?(:cpu_utilization) @custom_metric_utilizations = args[:custom_metric_utilizations] if args.key?(:custom_metric_utilizations) @load_balancing_utilization = args[:load_balancing_utilization] if args.key?(:load_balancing_utilization) @max_num_replicas = args[:max_num_replicas] if args.key?(:max_num_replicas) @min_num_replicas = args[:min_num_replicas] if args.key?(:min_num_replicas) @mode = args[:mode] if args.key?(:mode) @queue_based_scaling = args[:queue_based_scaling] if args.key?(:queue_based_scaling) end end # CPU utilization policy. class AutoscalingPolicyCpuUtilization include Google::Apis::Core::Hashable # The target CPU utilization that the autoscaler should maintain. Must be a # float value in the range (0, 1]. If not specified, the default is 0.6. # If the CPU level is below the target utilization, the autoscaler scales down # the number of instances until it reaches the minimum number of instances you # specified or until the average CPU of your instances reaches the target # utilization. # If the average CPU is above the target utilization, the autoscaler scales up # until it reaches the maximum number of instances you specified or until the # average utilization reaches the target utilization. # Corresponds to the JSON property `utilizationTarget` # @return [Float] attr_accessor :utilization_target def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @utilization_target = args[:utilization_target] if args.key?(:utilization_target) end end # Custom utilization metric policy. class AutoscalingPolicyCustomMetricUtilization include Google::Apis::Core::Hashable # A filter string, compatible with a Stackdriver Monitoring filter string for # TimeSeries.list API call. This filter is used to select a specific TimeSeries # for the purpose of autoscaling and to determine whether the metric is # exporting per-instance or per-group data. # For the filter to be valid for autoscaling purposes, the following rules apply: # # - You can only use the AND operator for joining selectors. # - You can only use direct equality comparison operator (=) without any # functions for each selector. # - You can specify the metric in both the filter string and in the metric field. # However, if specified in both places, the metric must be identical. # - The monitored resource type determines what kind of values are expected for # the metric. If it is a gce_instance, the autoscaler expects the metric to # include a separate TimeSeries for each instance in a group. In such a case, # you cannot filter on resource labels. # If the resource type is any other value, the autoscaler expects this metric to # contain values that apply to the entire autoscaled instance group and resource # label filtering can be performed to point autoscaler at the correct TimeSeries # to scale upon. This is called a per-group metric for the purpose of # autoscaling. # If not specified, the type defaults to gce_instance. # You should provide a filter that is selective enough to pick just one # TimeSeries for the autoscaled group or for each of the instances (if you are # using gce_instance resource type). If multiple TimeSeries are returned upon # the query execution, the autoscaler will sum their respective values to obtain # its scaling value. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot # have negative values. # The metric must have a value type of INT64 or DOUBLE. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric # If scaling is based on a per-group metric value that represents the total # amount of work to be done or resource usage, set this value to an amount # assigned for a single instance of the scaled group. Autoscaler will keep the # number of instances proportional to the value of this metric, the metric # itself should not change value due to group resizing. # A good metric to use with the target is for example pubsub.googleapis.com/ # subscription/num_undelivered_messages or a custom metric exporting the total # number of requests coming to your instances. # A bad example would be a metric exporting an average or median latency, since # this value can't include a chunk assignable to a single instance, it could be # better used with utilization_target instead. # Corresponds to the JSON property `singleInstanceAssignment` # @return [Float] attr_accessor :single_instance_assignment # The target value of the metric that autoscaler should maintain. This must be a # positive value. A utilization metric scales number of virtual machines # handling requests to increase or decrease proportionally to the metric. # For example, a good metric to use as a utilization_target is compute. # googleapis.com/instance/network/received_bytes_count. The autoscaler will work # to keep this value constant for each of the instances. # Corresponds to the JSON property `utilizationTarget` # @return [Float] attr_accessor :utilization_target # Defines how target utilization value is expressed for a Stackdriver Monitoring # metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, # the default is GAUGE. # Corresponds to the JSON property `utilizationTargetType` # @return [String] attr_accessor :utilization_target_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filter = args[:filter] if args.key?(:filter) @metric = args[:metric] if args.key?(:metric) @single_instance_assignment = args[:single_instance_assignment] if args.key?(:single_instance_assignment) @utilization_target = args[:utilization_target] if args.key?(:utilization_target) @utilization_target_type = args[:utilization_target_type] if args.key?(:utilization_target_type) end end # Configuration parameters of autoscaling based on load balancing. class AutoscalingPolicyLoadBalancingUtilization include Google::Apis::Core::Hashable # Fraction of backend capacity utilization (set in HTTP(s) load balancing # configuration) that autoscaler should maintain. Must be a positive float value. # If not defined, the default is 0.8. # Corresponds to the JSON property `utilizationTarget` # @return [Float] attr_accessor :utilization_target def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @utilization_target = args[:utilization_target] if args.key?(:utilization_target) end end # Configuration parameters of autoscaling based on queuing system. class AutoscalingPolicyQueueBasedScaling include Google::Apis::Core::Hashable # Scaling based on the average number of tasks in the queue per each active # instance. The autoscaler keeps the average number of tasks per instance below # this number, based on data collected in the last couple of minutes. The # autoscaler will also take into account incoming tasks when calculating when to # scale. # Corresponds to the JSON property `acceptableBacklogPerInstance` # @return [Float] attr_accessor :acceptable_backlog_per_instance # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Corresponds to the JSON property `cloudPubSub` # @return [Google::Apis::ComputeAlpha::AutoscalingPolicyQueueBasedScalingCloudPubSub] attr_accessor :cloud_pub_sub # The scaling algorithm will also calculate throughput estimates on its own; if # you explicitly provide this value, the autoscaler will take into account your # value as well as automatic estimates when deciding how to scale. # Corresponds to the JSON property `singleWorkerThroughputPerSec` # @return [Float] attr_accessor :single_worker_throughput_per_sec def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @acceptable_backlog_per_instance = args[:acceptable_backlog_per_instance] if args.key?(:acceptable_backlog_per_instance) @cloud_pub_sub = args[:cloud_pub_sub] if args.key?(:cloud_pub_sub) @single_worker_throughput_per_sec = args[:single_worker_throughput_per_sec] if args.key?(:single_worker_throughput_per_sec) end end # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. class AutoscalingPolicyQueueBasedScalingCloudPubSub include Google::Apis::Core::Hashable # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting # with projects/) or just the subscription name. The subscription must be # assigned to the topic specified in topicName and must be in a pull # configuration. The subscription must belong to the same project as the # Autoscaler. # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL ( # starting with projects/) or just the topic name. The topic must belong to the # same project as the Autoscaler resource. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @subscription = args[:subscription] if args.key?(:subscription) @topic = args[:topic] if args.key?(:topic) end end # Message containing information of one individual backend. class Backend include Google::Apis::Core::Hashable # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL # load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE # (for HTTP(S)) and CONNECTION (for TCP/SSL). # For Internal Load Balancing, the default and only supported mode is CONNECTION. # Corresponds to the JSON property `balancingMode` # @return [String] attr_accessor :balancing_mode # A multiplier applied to the group's maximum servicing capacity (based on # UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group # will serve up to 100% of its configured capacity (depending on balancingMode). # A setting of 0 means the group is completely drained, offering 0% of its # available Capacity. Valid range is [0.0,1.0]. # This cannot be used for internal load balancing. # Corresponds to the JSON property `capacityScaler` # @return [Float] attr_accessor :capacity_scaler # 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 # This field designates whether this is a failover backend. More than one # failover backend can be configured for a given BackendService. # Corresponds to the JSON property `failover` # @return [Boolean] attr_accessor :failover alias_method :failover?, :failover # The fully-qualified URL of a Instance Group resource. This instance group # defines the list of instances that serve traffic. Member virtual machine # instances from each instance group must live in the same zone as the instance # group itself. No two backends in a backend service are allowed to use same # Instance Group resource. # Note that you must specify an Instance Group resource using the fully- # qualified URL, rather than a partial URL. # When the BackendService has load balancing scheme INTERNAL, the instance group # must be within the same region as the BackendService. # Corresponds to the JSON property `group` # @return [String] attr_accessor :group # The max number of simultaneous connections for the group. Can be used with # either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either # maxConnections or maxConnectionsPerInstance must be set. # This cannot be used for internal load balancing. # Corresponds to the JSON property `maxConnections` # @return [Fixnum] attr_accessor :max_connections # The max number of simultaneous connections that a single backend network # endpoint can handle. This is used to calculate the capacity of the group. Can # be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION # mode, either maxConnections or maxConnectionsPerEndpoint must be set. # This cannot be used for internal load balancing. # Corresponds to the JSON property `maxConnectionsPerEndpoint` # @return [Fixnum] attr_accessor :max_connections_per_endpoint # The max number of simultaneous connections that a single backend instance can # handle. This is used to calculate the capacity of the group. Can be used in # either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either # maxConnections or maxConnectionsPerInstance must be set. # This cannot be used for internal load balancing. # Corresponds to the JSON property `maxConnectionsPerInstance` # @return [Fixnum] attr_accessor :max_connections_per_instance # The max requests per second (RPS) of the group. Can be used with either RATE # or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, # either maxRate or maxRatePerInstance must be set. # This cannot be used for internal load balancing. # Corresponds to the JSON property `maxRate` # @return [Fixnum] attr_accessor :max_rate # The max requests per second (RPS) that a single backend network endpoint can # handle. This is used to calculate the capacity of the group. Can be used in # either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint # must be set. # This cannot be used for internal load balancing. # Corresponds to the JSON property `maxRatePerEndpoint` # @return [Float] attr_accessor :max_rate_per_endpoint # The max requests per second (RPS) that a single backend instance can handle. # This is used to calculate the capacity of the group. Can be used in either # balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be # set. # This cannot be used for internal load balancing. # Corresponds to the JSON property `maxRatePerInstance` # @return [Float] attr_accessor :max_rate_per_instance # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization # target for the group. The default is 0.8. Valid range is [0.0, 1.0]. # This cannot be used for internal load balancing. # Corresponds to the JSON property `maxUtilization` # @return [Float] attr_accessor :max_utilization def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @balancing_mode = args[:balancing_mode] if args.key?(:balancing_mode) @capacity_scaler = args[:capacity_scaler] if args.key?(:capacity_scaler) @description = args[:description] if args.key?(:description) @failover = args[:failover] if args.key?(:failover) @group = args[:group] if args.key?(:group) @max_connections = args[:max_connections] if args.key?(:max_connections) @max_connections_per_endpoint = args[:max_connections_per_endpoint] if args.key?(:max_connections_per_endpoint) @max_connections_per_instance = args[:max_connections_per_instance] if args.key?(:max_connections_per_instance) @max_rate = args[:max_rate] if args.key?(:max_rate) @max_rate_per_endpoint = args[:max_rate_per_endpoint] if args.key?(:max_rate_per_endpoint) @max_rate_per_instance = args[:max_rate_per_instance] if args.key?(:max_rate_per_instance) @max_utilization = args[:max_utilization] if args.key?(:max_utilization) end end # A BackendBucket resource. This resource defines a Cloud Storage bucket. class BackendBucket include Google::Apis::Core::Hashable # Cloud Storage bucket name. # Corresponds to the JSON property `bucketName` # @return [String] attr_accessor :bucket_name # Message containing Cloud CDN configuration for a backend bucket. # Corresponds to the JSON property `cdnPolicy` # @return [Google::Apis::ComputeAlpha::BackendBucketCdnPolicy] attr_accessor :cdn_policy # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # If true, enable Cloud CDN for this BackendBucket. # Corresponds to the JSON property `enableCdn` # @return [Boolean] attr_accessor :enable_cdn alias_method :enable_cdn?, :enable_cdn # [Output Only] Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Type of the resource. # 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 # [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) @bucket_name = args[:bucket_name] if args.key?(:bucket_name) @cdn_policy = args[:cdn_policy] if args.key?(:cdn_policy) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @enable_cdn = args[:enable_cdn] if args.key?(:enable_cdn) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) end end # Message containing Cloud CDN configuration for a backend bucket. class BackendBucketCdnPolicy include Google::Apis::Core::Hashable # Number of seconds up to which the response to a signed URL request will be # cached in the CDN. After this time period, the Signed URL will be revalidated # before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN # will internally act as though all responses from this bucket had a ?Cache- # Control: public, max-age=[TTL]? header, regardless of any existing Cache- # Control header. The actual headers served in responses will not be altered. # Corresponds to the JSON property `signedUrlCacheMaxAgeSec` # @return [Fixnum] attr_accessor :signed_url_cache_max_age_sec # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL # on this backend bucket. # Corresponds to the JSON property `signedUrlKeyNames` # @return [Array] attr_accessor :signed_url_key_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @signed_url_cache_max_age_sec = args[:signed_url_cache_max_age_sec] if args.key?(:signed_url_cache_max_age_sec) @signed_url_key_names = args[:signed_url_key_names] if args.key?(:signed_url_key_names) end end # Contains a list of BackendBucket resources. class BackendBucketList 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 BackendBucket resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::BackendBucketList::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 BackendService resource. This resource defines a group of backend virtual # machines and their serving capacity. (== resource_for v1.backendService ==) (== # resource_for beta.backendService ==) class BackendService include Google::Apis::Core::Hashable # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set # to 0, the cookie is non-persistent and lasts only until the end of the browser # session (or equivalent). The maximum allowed value for TTL is one day. # When the load balancing scheme is INTERNAL, this field is not used. # Corresponds to the JSON property `affinityCookieTtlSec` # @return [Fixnum] attr_accessor :affinity_cookie_ttl_sec # Configuration of a App Engine backend. # Corresponds to the JSON property `appEngineBackend` # @return [Google::Apis::ComputeAlpha::BackendServiceAppEngineBackend] attr_accessor :app_engine_backend # The list of backends that serve this BackendService. # Corresponds to the JSON property `backends` # @return [Array] attr_accessor :backends # Message containing Cloud CDN configuration for a backend service. # Corresponds to the JSON property `cdnPolicy` # @return [Google::Apis::ComputeAlpha::BackendServiceCdnPolicy] attr_accessor :cdn_policy # Configuration of a Cloud Function backend. # Corresponds to the JSON property `cloudFunctionBackend` # @return [Google::Apis::ComputeAlpha::BackendServiceCloudFunctionBackend] attr_accessor :cloud_function_backend # Message containing connection draining configuration. # Corresponds to the JSON property `connectionDraining` # @return [Google::Apis::ComputeAlpha::ConnectionDraining] attr_accessor :connection_draining # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # Headers that the HTTP/S load balancer should add to proxied requests. # Corresponds to the JSON property `customRequestHeaders` # @return [Array] attr_accessor :custom_request_headers # 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 # If true, enable Cloud CDN for this BackendService. # When the load balancing scheme is INTERNAL, this field is not used. # Corresponds to the JSON property `enableCDN` # @return [Boolean] attr_accessor :enable_cdn alias_method :enable_cdn?, :enable_cdn # # Corresponds to the JSON property `failoverPolicy` # @return [Google::Apis::ComputeAlpha::BackendServiceFailoverPolicy] attr_accessor :failover_policy # Fingerprint of this resource. A hash of the contents stored in this object. # This field is used in optimistic locking. This field will be ignored when # inserting a BackendService. An up-to-date fingerprint must be provided in # order to update the BackendService. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for # health checking this BackendService. Currently at most one health check can be # specified, and a health check is required for Compute Engine backend services. # A health check must not be specified for App Engine backend and Cloud Function # backend. # For internal load balancing, a URL to a HealthCheck resource must be specified # instead. # Corresponds to the JSON property `healthChecks` # @return [Array] attr_accessor :health_checks # Identity-Aware Proxy # Corresponds to the JSON property `iap` # @return [Google::Apis::ComputeAlpha::BackendServiceIap] attr_accessor :iap # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of resource. Always compute#backendService for backend # services. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Indicates whether the backend service will be used with internal or external # load balancing. A backend service created for one type of load balancing # cannot be used with the other. Possible values are INTERNAL and EXTERNAL. # Corresponds to the JSON property `loadBalancingScheme` # @return [String] attr_accessor :load_balancing_scheme # 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 # Deprecated in favor of portName. The TCP port to connect on the backend. The # default value is 80. # This cannot be used for internal load balancing. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port # Name of backend port. The same name should appear in the instance groups # referenced by this service. Required when the load balancing scheme is # EXTERNAL. # When the load balancing scheme is INTERNAL, this field is not used. # Corresponds to the JSON property `portName` # @return [String] attr_accessor :port_name # The protocol this BackendService uses to communicate with backends. # Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. # For internal load balancing, the possible values are TCP and UDP, and the # default is TCP. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol # [Output Only] URL of the region where the regional backend service resides. # This field is not applicable to global backend services. 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] The resource URL for the security policy associated with this # backend service. # Corresponds to the JSON property `securityPolicy` # @return [String] attr_accessor :security_policy # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Type of session affinity to use. The default is NONE. # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or # GENERATED_COOKIE. # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, # CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. # When the protocol is UDP, this field is not used. # Corresponds to the JSON property `sessionAffinity` # @return [String] attr_accessor :session_affinity # How many seconds to wait for the backend before considering it a failed # request. Default is 30 seconds. # Corresponds to the JSON property `timeoutSec` # @return [Fixnum] attr_accessor :timeout_sec def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @affinity_cookie_ttl_sec = args[:affinity_cookie_ttl_sec] if args.key?(:affinity_cookie_ttl_sec) @app_engine_backend = args[:app_engine_backend] if args.key?(:app_engine_backend) @backends = args[:backends] if args.key?(:backends) @cdn_policy = args[:cdn_policy] if args.key?(:cdn_policy) @cloud_function_backend = args[:cloud_function_backend] if args.key?(:cloud_function_backend) @connection_draining = args[:connection_draining] if args.key?(:connection_draining) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @custom_request_headers = args[:custom_request_headers] if args.key?(:custom_request_headers) @description = args[:description] if args.key?(:description) @enable_cdn = args[:enable_cdn] if args.key?(:enable_cdn) @failover_policy = args[:failover_policy] if args.key?(:failover_policy) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @health_checks = args[:health_checks] if args.key?(:health_checks) @iap = args[:iap] if args.key?(:iap) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @load_balancing_scheme = args[:load_balancing_scheme] if args.key?(:load_balancing_scheme) @name = args[:name] if args.key?(:name) @port = args[:port] if args.key?(:port) @port_name = args[:port_name] if args.key?(:port_name) @protocol = args[:protocol] if args.key?(:protocol) @region = args[:region] if args.key?(:region) @security_policy = args[:security_policy] if args.key?(:security_policy) @self_link = args[:self_link] if args.key?(:self_link) @session_affinity = args[:session_affinity] if args.key?(:session_affinity) @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec) end end # Contains a list of BackendServicesScopedList. class BackendServiceAggregatedList 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 BackendServicesScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # Type of resource. # 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::BackendServiceAggregatedList::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 # Configuration of a App Engine backend. class BackendServiceAppEngineBackend include Google::Apis::Core::Hashable # Optional. App Engine app service name. # Corresponds to the JSON property `appEngineService` # @return [String] attr_accessor :app_engine_service # Required. Project ID of the project hosting the app. This is the project ID of # this project. Reference to another project is not allowed. # Corresponds to the JSON property `targetProject` # @return [String] attr_accessor :target_project # Optional. Version of App Engine app service. When empty, App Engine will do # its normal traffic split. # 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) @app_engine_service = args[:app_engine_service] if args.key?(:app_engine_service) @target_project = args[:target_project] if args.key?(:target_project) @version = args[:version] if args.key?(:version) end end # Message containing Cloud CDN configuration for a backend service. class BackendServiceCdnPolicy include Google::Apis::Core::Hashable # Message containing what to include in the cache key for a request for Cloud # CDN. # Corresponds to the JSON property `cacheKeyPolicy` # @return [Google::Apis::ComputeAlpha::CacheKeyPolicy] attr_accessor :cache_key_policy # Number of seconds up to which the response to a signed URL request will be # cached in the CDN. After this time period, the Signed URL will be revalidated # before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN # will internally act as though all responses from this backend had a ?Cache- # Control: public, max-age=[TTL]? header, regardless of any existing Cache- # Control header. The actual headers served in responses will not be altered. # Corresponds to the JSON property `signedUrlCacheMaxAgeSec` # @return [Fixnum] attr_accessor :signed_url_cache_max_age_sec # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL # on this backend service. # Corresponds to the JSON property `signedUrlKeyNames` # @return [Array] attr_accessor :signed_url_key_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cache_key_policy = args[:cache_key_policy] if args.key?(:cache_key_policy) @signed_url_cache_max_age_sec = args[:signed_url_cache_max_age_sec] if args.key?(:signed_url_cache_max_age_sec) @signed_url_key_names = args[:signed_url_key_names] if args.key?(:signed_url_key_names) end end # Configuration of a Cloud Function backend. class BackendServiceCloudFunctionBackend include Google::Apis::Core::Hashable # Required. A cloud function name. Special value ?*? represents all cloud # functions in the project. # Corresponds to the JSON property `functionName` # @return [String] attr_accessor :function_name # Required. Project ID of the project hosting the cloud function. # Corresponds to the JSON property `targetProject` # @return [String] attr_accessor :target_project def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @function_name = args[:function_name] if args.key?(:function_name) @target_project = args[:target_project] if args.key?(:target_project) end end # class BackendServiceFailoverPolicy include Google::Apis::Core::Hashable # On failover or failback, this field indicates whether connection drain will be # honored. Setting this to true has the following effect: connections to the old # active pool are not drained. Connections to the new active pool use the # timeout of 10 min (currently fixed). Setting to false has the following effect: # both old and new connections will have a drain timeout of 10 min. # This can be set to true only if the protocol is TCP. # The default is false. # Corresponds to the JSON property `disableConnectionDrainOnFailover` # @return [Boolean] attr_accessor :disable_connection_drain_on_failover alias_method :disable_connection_drain_on_failover?, :disable_connection_drain_on_failover # This option is used only when no healthy VMs are detected in the primary and # backup instance groups. When set to true, traffic is dropped. When set to # false, new connections are sent across all VMs in the primary group. # The default is false. # Corresponds to the JSON property `dropTrafficIfUnhealthy` # @return [Boolean] attr_accessor :drop_traffic_if_unhealthy alias_method :drop_traffic_if_unhealthy?, :drop_traffic_if_unhealthy # The value of the field must be in [0, 1]. If the ratio of the healthy VMs in # the primary backend is at or below this number, traffic arriving at the load- # balanced IP will be directed to the failover backend. # In case where 'failoverRatio' is not set or all the VMs in the backup backend # are unhealthy, the traffic will be directed back to the primary backend in the # "force" mode, where traffic will be spread to the healthy VMs with the best # effort, or to all VMs when no VM is healthy. # This field is only used with l4 load balancing. # Corresponds to the JSON property `failoverRatio` # @return [Float] attr_accessor :failover_ratio def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disable_connection_drain_on_failover = args[:disable_connection_drain_on_failover] if args.key?(:disable_connection_drain_on_failover) @drop_traffic_if_unhealthy = args[:drop_traffic_if_unhealthy] if args.key?(:drop_traffic_if_unhealthy) @failover_ratio = args[:failover_ratio] if args.key?(:failover_ratio) end end # class BackendServiceGroupHealth include Google::Apis::Core::Hashable # # Corresponds to the JSON property `healthStatus` # @return [Array] attr_accessor :health_status # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for # the health of backend services. # 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) @health_status = args[:health_status] if args.key?(:health_status) @kind = args[:kind] if args.key?(:kind) end end # Identity-Aware Proxy class BackendServiceIap include Google::Apis::Core::Hashable # # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # # Corresponds to the JSON property `oauth2ClientId` # @return [String] attr_accessor :oauth2_client_id # # Corresponds to the JSON property `oauth2ClientSecret` # @return [String] attr_accessor :oauth2_client_secret # [Output Only] SHA256 hash value for the field oauth2_client_secret above. # Corresponds to the JSON property `oauth2ClientSecretSha256` # @return [String] attr_accessor :oauth2_client_secret_sha256 def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enabled = args[:enabled] if args.key?(:enabled) @oauth2_client_id = args[:oauth2_client_id] if args.key?(:oauth2_client_id) @oauth2_client_secret = args[:oauth2_client_secret] if args.key?(:oauth2_client_secret) @oauth2_client_secret_sha256 = args[:oauth2_client_secret_sha256] if args.key?(:oauth2_client_secret_sha256) end end # Contains a list of BackendService resources. class BackendServiceList 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 BackendService resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#backendServiceList for lists of # backend services. # 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::BackendServiceList::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 # class BackendServiceReference include Google::Apis::Core::Hashable # # Corresponds to the JSON property `backendService` # @return [String] attr_accessor :backend_service def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @backend_service = args[:backend_service] if args.key?(:backend_service) end end # class BackendServicesScopedList include Google::Apis::Core::Hashable # List of BackendServices contained in this scope. # Corresponds to the JSON property `backendServices` # @return [Array] attr_accessor :backend_services # Informational warning which replaces the list of backend services when the # list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::BackendServicesScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @backend_services = args[:backend_services] if args.key?(:backend_services) @warning = args[:warning] if args.key?(:warning) end # Informational warning which replaces the list of backend services when the # list is empty. 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 # Associates `members` with a `role`. class Binding include Google::Apis::Core::Hashable # Represents an expression text. Example: # title: "User account presence" description: "Determines whether the request # has a user account" expression: "size(request.user) > 0" # Corresponds to the JSON property `condition` # @return [Google::Apis::ComputeAlpha::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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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 # class CacheInvalidationRule include Google::Apis::Core::Hashable # If set, this invalidation rule will only apply to requests with a Host header # matching host. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # # Corresponds to the JSON property `path` # @return [String] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @host = args[:host] if args.key?(:host) @path = args[:path] if args.key?(:path) end end # Message containing what to include in the cache key for a request for Cloud # CDN. class CacheKeyPolicy include Google::Apis::Core::Hashable # If true, requests to different hosts will be cached separately. # Corresponds to the JSON property `includeHost` # @return [Boolean] attr_accessor :include_host alias_method :include_host?, :include_host # If true, http and https requests will be cached separately. # Corresponds to the JSON property `includeProtocol` # @return [Boolean] attr_accessor :include_protocol alias_method :include_protocol?, :include_protocol # If true, include query string parameters in the cache key according to # query_string_whitelist and query_string_blacklist. If neither is set, the # entire query string will be included. If false, the query string will be # excluded from the cache key entirely. # Corresponds to the JSON property `includeQueryString` # @return [Boolean] attr_accessor :include_query_string alias_method :include_query_string?, :include_query_string # Names of query string parameters to exclude in cache keys. All other # parameters will be included. Either specify query_string_whitelist or # query_string_blacklist, not both. '&' and '=' will be percent encoded and not # treated as delimiters. # Corresponds to the JSON property `queryStringBlacklist` # @return [Array] attr_accessor :query_string_blacklist # Names of query string parameters to include in cache keys. All other # parameters will be excluded. Either specify query_string_whitelist or # query_string_blacklist, not both. '&' and '=' will be percent encoded and not # treated as delimiters. # Corresponds to the JSON property `queryStringWhitelist` # @return [Array] attr_accessor :query_string_whitelist def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @include_host = args[:include_host] if args.key?(:include_host) @include_protocol = args[:include_protocol] if args.key?(:include_protocol) @include_query_string = args[:include_query_string] if args.key?(:include_query_string) @query_string_blacklist = args[:query_string_blacklist] if args.key?(:query_string_blacklist) @query_string_whitelist = args[:query_string_whitelist] if args.key?(:query_string_whitelist) end end # Represents a Commitment resource. Creating a Commitment resource means that # you are purchasing a committed use contract with an explicit start and end # time. You can create commitments based on vCPUs and memory usage and receive # discounted rates. For full details, read Signing Up for Committed Use # Discounts. # Committed use discounts are subject to Google Cloud Platform's Service # Specific Terms. By purchasing a committed use discount, you agree to these # terms. Committed use discounts will not renew, so you must purchase a new # commitment to continue receiving discounts. (== resource_for beta.commitments = # =) (== resource_for v1.commitments ==) class Commitment include Google::Apis::Core::Hashable # [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] Commitment end time in RFC3339 text format. # Corresponds to the JSON property `endTimestamp` # @return [String] attr_accessor :end_timestamp # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#commitment for commitments. # 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 # The plan for this commitment, which determines duration and discount rate. The # currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 # years). # Corresponds to the JSON property `plan` # @return [String] attr_accessor :plan # [Output Only] URL of the region where this commitment may be used. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # List of commitment amounts for particular resources. Note that VCPU and MEMORY # resource commitments must occur together. # Corresponds to the JSON property `resources` # @return [Array] attr_accessor :resources # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] Commitment start time in RFC3339 text format. # Corresponds to the JSON property `startTimestamp` # @return [String] attr_accessor :start_timestamp # [Output Only] Status of the commitment with regards to eventual expiration ( # each commitment has an end date defined). One of the following values: # NOT_YET_ACTIVE, ACTIVE, EXPIRED. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional, human-readable explanation of the status. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @end_timestamp = args[:end_timestamp] if args.key?(:end_timestamp) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @plan = args[:plan] if args.key?(:plan) @region = args[:region] if args.key?(:region) @resources = args[:resources] if args.key?(:resources) @self_link = args[:self_link] if args.key?(:self_link) @start_timestamp = args[:start_timestamp] if args.key?(:start_timestamp) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) end end # class CommitmentAggregatedList 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 CommitmentsScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#commitmentAggregatedList for # aggregated lists of commitments. # 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::CommitmentAggregatedList::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 # Contains a list of Commitment resources. class CommitmentList 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 Commitment resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#commitmentList for lists of # commitments. # 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::CommitmentList::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 # class CommitmentsScopedList include Google::Apis::Core::Hashable # [Output Only] List of commitments contained in this scope. # Corresponds to the JSON property `commitments` # @return [Array] attr_accessor :commitments # [Output Only] Informational warning which replaces the list of commitments # when the list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::CommitmentsScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @commitments = args[:commitments] if args.key?(:commitments) @warning = args[:warning] if args.key?(:warning) end # [Output Only] Informational warning which replaces the list of commitments # when the list is empty. 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 condition to be met. class Condition include Google::Apis::Core::Hashable # Trusted attributes supplied by the IAM system. # Corresponds to the JSON property `iam` # @return [String] attr_accessor :iam # An operator to apply the subject with. # Corresponds to the JSON property `op` # @return [String] attr_accessor :op # Trusted attributes discharged by the service. # Corresponds to the JSON property `svc` # @return [String] attr_accessor :svc # Trusted attributes supplied by any service that owns resources and uses the # IAM system for access control. # Corresponds to the JSON property `sys` # @return [String] attr_accessor :sys # DEPRECATED. Use 'values' instead. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value # The objects of the condition. This is mutually exclusive with 'value'. # 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) @iam = args[:iam] if args.key?(:iam) @op = args[:op] if args.key?(:op) @svc = args[:svc] if args.key?(:svc) @sys = args[:sys] if args.key?(:sys) @value = args[:value] if args.key?(:value) @values = args[:values] if args.key?(:values) end end # Message containing connection draining configuration. class ConnectionDraining include Google::Apis::Core::Hashable # Time for which instance will be drained (not accept new connections, but still # work to finish started). # Corresponds to the JSON property `drainingTimeoutSec` # @return [Fixnum] attr_accessor :draining_timeout_sec def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @draining_timeout_sec = args[:draining_timeout_sec] if args.key?(:draining_timeout_sec) end end # Represents a customer-supplied encryption key class CustomerEncryptionKey include Google::Apis::Core::Hashable # The name of the encryption key that is stored in Google Cloud KMS. # Corresponds to the JSON property `kmsKeyName` # @return [String] attr_accessor :kms_key_name # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 # base64 to either encrypt or decrypt this resource. # Corresponds to the JSON property `rawKey` # @return [String] attr_accessor :raw_key # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied # encryption key to either encrypt or decrypt this resource. # The key must meet the following requirements before you can provide it to # Compute Engine: # - The key is wrapped using a RSA public key certificate provided by Google. # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. # Get the RSA public key certificate provided by Google at: # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem # Corresponds to the JSON property `rsaEncryptedKey` # @return [String] attr_accessor :rsa_encrypted_key # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer- # supplied encryption key that protects this resource. # 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) @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name) @raw_key = args[:raw_key] if args.key?(:raw_key) @rsa_encrypted_key = args[:rsa_encrypted_key] if args.key?(:rsa_encrypted_key) @sha256 = args[:sha256] if args.key?(:sha256) end end # class CustomerEncryptionKeyProtectedDisk include Google::Apis::Core::Hashable # Represents a customer-supplied encryption key # Corresponds to the JSON property `diskEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :disk_encryption_key # Specifies a valid partial or full URL to an existing Persistent Disk resource. # This field is only applicable for persistent disks. # 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) @disk_encryption_key = args[:disk_encryption_key] if args.key?(:disk_encryption_key) @source = args[:source] if args.key?(:source) end end # Time window specified for daily maintenance operations. class DailyMaintenanceWindow include Google::Apis::Core::Hashable # Allows to define schedule that runs every nth day of the month. # Corresponds to the JSON property `daysInCycle` # @return [Fixnum] attr_accessor :days_in_cycle # [Output only] Duration of the time window, automatically chosen to be smallest # possible in the given scenario. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration # Time within the maintenance window to start the maintenance operations. It # must be in format "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. # 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) @days_in_cycle = args[:days_in_cycle] if args.key?(:days_in_cycle) @duration = args[:duration] if args.key?(:duration) @start_time = args[:start_time] if args.key?(:start_time) end end # Deprecation status for a public resource. class DeprecationStatus include Google::Apis::Core::Hashable # An optional RFC3339 timestamp on or after which the state of this resource is # intended to change to DELETED. This is only informational and the status will # not change unless the client explicitly changes it. # Corresponds to the JSON property `deleted` # @return [String] attr_accessor :deleted # An optional RFC3339 timestamp on or after which the state of this resource is # intended to change to DEPRECATED. This is only informational and the status # will not change unless the client explicitly changes it. # Corresponds to the JSON property `deprecated` # @return [String] attr_accessor :deprecated # An optional RFC3339 timestamp on or after which the state of this resource is # intended to change to OBSOLETE. This is only informational and the status will # not change unless the client explicitly changes it. # Corresponds to the JSON property `obsolete` # @return [String] attr_accessor :obsolete # The URL of the suggested replacement for a deprecated resource. The suggested # replacement resource must be the same kind of resource as the deprecated # resource. # Corresponds to the JSON property `replacement` # @return [String] attr_accessor :replacement # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or # DELETED. Operations which create a new resource using a DEPRECATED resource # will return successfully, but with a warning indicating the deprecated # resource and recommending its replacement. Operations which use OBSOLETE or # DELETED resources will be rejected and result in an error. # 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) @deleted = args[:deleted] if args.key?(:deleted) @deprecated = args[:deprecated] if args.key?(:deprecated) @obsolete = args[:obsolete] if args.key?(:obsolete) @replacement = args[:replacement] if args.key?(:replacement) @state = args[:state] if args.key?(:state) end end # A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==) class Disk include Google::Apis::Core::Hashable # [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 # Represents a customer-supplied encryption key # Corresponds to the JSON property `diskEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :disk_encryption_key # A list of features to enable on the guest operating system. Applicable only # for bootable images. Read Enabling guest operating system features to see a # list of available options. # Corresponds to the JSON property `guestOsFeatures` # @return [Array] attr_accessor :guest_os_features # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#disk for disks. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for the labels being applied to this disk, which is essentially # a hash of the labels set used for optimistic locking. The fingerprint is # initially generated by Compute Engine and changes after every request to # modify or update labels. You must always provide an up-to-date fingerprint # hash in order to update or change labels. # To see the latest fingerprint, make a get() request to retrieve a disk. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :label_fingerprint # Labels to apply to this disk. These can be later modified by the setLabels # method. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # [Output Only] Last attach timestamp in RFC3339 text format. # Corresponds to the JSON property `lastAttachTimestamp` # @return [String] attr_accessor :last_attach_timestamp # [Output Only] Last detach timestamp in RFC3339 text format. # Corresponds to the JSON property `lastDetachTimestamp` # @return [String] attr_accessor :last_detach_timestamp # Integer license codes indicating which licenses are attached to this disk. # Corresponds to the JSON property `licenseCodes` # @return [Array] attr_accessor :license_codes # Any applicable publicly visible licenses. # Corresponds to the JSON property `licenses` # @return [Array] attr_accessor :licenses # 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 # Internal use only. # Corresponds to the JSON property `options` # @return [String] attr_accessor :options # Physical block size of the persistent disk, in bytes. If not present in a # request, a default value is used. Initially only 4096 is supported, but other # powers of two may be added. If an unsupported value is requested, the error # message will list the supported values, but even a supported value may be # allowed for only some projects. # Corresponds to the JSON property `physicalBlockSizeBytes` # @return [Fixnum] attr_accessor :physical_block_size_bytes # [Output Only] URL of the region where the disk resides. Only applicable for # regional resources. 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 # URLs of the zones where the disk should be replicated to. Only applicable for # regional resources. # Corresponds to the JSON property `replicaZones` # @return [Array] attr_accessor :replica_zones # [Output Only] Server-defined fully-qualified URL for this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Size of the persistent disk, specified in GB. You can specify this field when # creating a persistent disk using the sourceImage or sourceSnapshot parameter, # or specify it alone to create an empty persistent disk. # If you specify this field along with sourceImage or sourceSnapshot, the value # of sizeGb must not be less than the size of the sourceImage or the size of the # snapshot. Acceptable values are 1 to 65536, inclusive. # Corresponds to the JSON property `sizeGb` # @return [Fixnum] attr_accessor :size_gb # The source image used to create this disk. If the source image is deleted, # this field will not be set. # To create a disk with one of the public operating system images, specify the # image by its family name. For example, specify family/debian-8 to use the # latest Debian 8 image: # projects/debian-cloud/global/images/family/debian-8 # Alternatively, use a specific version of a public operating system image: # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD # To create a disk with a custom image that you created, specify the image name # in the following format: # global/images/my-custom-image # You can also specify a custom image by its image family, which returns the # latest version of the image in that family. Replace the image name with family/ # family-name: # global/images/family/my-image-family # Corresponds to the JSON property `sourceImage` # @return [String] attr_accessor :source_image # Represents a customer-supplied encryption key # Corresponds to the JSON property `sourceImageEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :source_image_encryption_key # [Output Only] The ID value of the image used to create this disk. This value # identifies the exact image that was used to create this persistent disk. For # example, if you created the persistent disk from an image that was later # deleted and recreated under the same name, the source image ID would identify # the exact version of the image that was used. # Corresponds to the JSON property `sourceImageId` # @return [String] attr_accessor :source_image_id # The source snapshot used to create this disk. You can provide this as a # partial or full URL to the resource. For example, the following are valid # values: # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/ # snapshot # - projects/project/global/snapshots/snapshot # - global/snapshots/snapshot # Corresponds to the JSON property `sourceSnapshot` # @return [String] attr_accessor :source_snapshot # Represents a customer-supplied encryption key # Corresponds to the JSON property `sourceSnapshotEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :source_snapshot_encryption_key # [Output Only] The unique ID of the snapshot used to create this disk. This # value identifies the exact snapshot that was used to create this persistent # disk. For example, if you created the persistent disk from a snapshot that was # later deleted and recreated under the same name, the source snapshot ID would # identify the exact version of the snapshot that was used. # Corresponds to the JSON property `sourceSnapshotId` # @return [String] attr_accessor :source_snapshot_id # [Output Only] The status of disk creation. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Deprecated] Storage type of the persistent disk. # Corresponds to the JSON property `storageType` # @return [String] attr_accessor :storage_type # URL of the disk type resource describing which disk type to use to create the # disk. Provide this when creating the disk. For example: project/zones/zone/ # diskTypes/pd-standard or pd-ssd # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # [Output Only] Links to the users of the disk (attached instances) in form: # project/zones/zone/instances/instance # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users # [Output Only] URL of the zone where the disk resides. 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 `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @disk_encryption_key = args[:disk_encryption_key] if args.key?(:disk_encryption_key) @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @last_attach_timestamp = args[:last_attach_timestamp] if args.key?(:last_attach_timestamp) @last_detach_timestamp = args[:last_detach_timestamp] if args.key?(:last_detach_timestamp) @license_codes = args[:license_codes] if args.key?(:license_codes) @licenses = args[:licenses] if args.key?(:licenses) @name = args[:name] if args.key?(:name) @options = args[:options] if args.key?(:options) @physical_block_size_bytes = args[:physical_block_size_bytes] if args.key?(:physical_block_size_bytes) @region = args[:region] if args.key?(:region) @replica_zones = args[:replica_zones] if args.key?(:replica_zones) @self_link = args[:self_link] if args.key?(:self_link) @size_gb = args[:size_gb] if args.key?(:size_gb) @source_image = args[:source_image] if args.key?(:source_image) @source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key) @source_image_id = args[:source_image_id] if args.key?(:source_image_id) @source_snapshot = args[:source_snapshot] if args.key?(:source_snapshot) @source_snapshot_encryption_key = args[:source_snapshot_encryption_key] if args.key?(:source_snapshot_encryption_key) @source_snapshot_id = args[:source_snapshot_id] if args.key?(:source_snapshot_id) @status = args[:status] if args.key?(:status) @storage_type = args[:storage_type] if args.key?(:storage_type) @type = args[:type] if args.key?(:type) @users = args[:users] if args.key?(:users) @zone = args[:zone] if args.key?(:zone) end end # class DiskAggregatedList 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 DisksScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#diskAggregatedList for # aggregated lists of persistent disks. # 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::DiskAggregatedList::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 specification of the desired way to instantiate a disk in the instance # template when its created from a source instance. class DiskInstantiationConfig include Google::Apis::Core::Hashable # Specifies whether the disk will be auto-deleted when the instance is deleted ( # but not when the disk is detached from the instance). # Corresponds to the JSON property `autoDelete` # @return [Boolean] attr_accessor :auto_delete alias_method :auto_delete?, :auto_delete # The custom source image to be used to restore this disk when instantiating # this instance template. # Corresponds to the JSON property `customImage` # @return [String] attr_accessor :custom_image # Specifies the device name of the disk to which the configurations apply to. # Corresponds to the JSON property `deviceName` # @return [String] attr_accessor :device_name # Specifies whether to include the disk and what image to use. # Corresponds to the JSON property `instantiateFrom` # @return [String] attr_accessor :instantiate_from def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_delete = args[:auto_delete] if args.key?(:auto_delete) @custom_image = args[:custom_image] if args.key?(:custom_image) @device_name = args[:device_name] if args.key?(:device_name) @instantiate_from = args[:instantiate_from] if args.key?(:instantiate_from) end end # A list of Disk resources. class DiskList 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 Disk resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#diskList for lists of disks. # 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::DiskList::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 # class DiskMoveRequest include Google::Apis::Core::Hashable # The URL of the destination zone to move the disk. This can be a full or # partial URL. For example, the following are all valid URLs to a zone: # - https://www.googleapis.com/compute/v1/projects/project/zones/zone # - projects/project/zones/zone # - zones/zone # Corresponds to the JSON property `destinationZone` # @return [String] attr_accessor :destination_zone # The URL of the target disk to move. This can be a full or partial URL. For # example, the following are all valid URLs to a disk: # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk # - projects/project/zones/zone/disks/disk # - zones/zone/disks/disk # Corresponds to the JSON property `targetDisk` # @return [String] attr_accessor :target_disk def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @destination_zone = args[:destination_zone] if args.key?(:destination_zone) @target_disk = args[:target_disk] if args.key?(:target_disk) end end # A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for v1. # diskTypes ==) class DiskType include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] Server-defined default disk size in GB. # Corresponds to the JSON property `defaultDiskSizeGb` # @return [Fixnum] attr_accessor :default_disk_size_gb # Deprecation status for a public resource. # Corresponds to the JSON property `deprecated` # @return [Google::Apis::ComputeAlpha::DeprecationStatus] attr_accessor :deprecated # [Output Only] An optional description of this resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#diskType for disk types. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] An optional textual description of the valid disk size, such as " # 10GB-10TB". # Corresponds to the JSON property `validDiskSize` # @return [String] attr_accessor :valid_disk_size # [Output Only] URL of the zone where the disk type resides. 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 `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @default_disk_size_gb = args[:default_disk_size_gb] if args.key?(:default_disk_size_gb) @deprecated = args[:deprecated] if args.key?(:deprecated) @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) @self_link = args[:self_link] if args.key?(:self_link) @valid_disk_size = args[:valid_disk_size] if args.key?(:valid_disk_size) @zone = args[:zone] if args.key?(:zone) end end # class DiskTypeAggregatedList 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 DiskTypesScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#diskTypeAggregatedList. # 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::DiskTypeAggregatedList::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 # Contains a list of disk types. class DiskTypeList 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 DiskType resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#diskTypeList for disk types. # 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::DiskTypeList::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 # class DiskTypesScopedList include Google::Apis::Core::Hashable # [Output Only] List of disk types contained in this scope. # Corresponds to the JSON property `diskTypes` # @return [Array] attr_accessor :disk_types # [Output Only] Informational warning which replaces the list of disk types when # the list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::DiskTypesScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disk_types = args[:disk_types] if args.key?(:disk_types) @warning = args[:warning] if args.key?(:warning) end # [Output Only] Informational warning which replaces the list of disk types when # the list is empty. 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 # class DisksResizeRequest include Google::Apis::Core::Hashable # The new size of the persistent disk, which is specified in GB. # Corresponds to the JSON property `sizeGb` # @return [Fixnum] attr_accessor :size_gb def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @size_gb = args[:size_gb] if args.key?(:size_gb) end end # class DisksScopedList include Google::Apis::Core::Hashable # [Output Only] List of disks contained in this scope. # Corresponds to the JSON property `disks` # @return [Array] attr_accessor :disks # [Output Only] Informational warning which replaces the list of disks when the # list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::DisksScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disks = args[:disks] if args.key?(:disks) @warning = args[:warning] if args.key?(:warning) end # [Output Only] Informational warning which replaces the list of disks when the # list is empty. 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 # class DistributionPolicy include Google::Apis::Core::Hashable # # 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) @zones = args[:zones] if args.key?(:zones) end end # class DistributionPolicyZoneConfiguration include Google::Apis::Core::Hashable # URL of the zone where managed instance group is spawning instances (for # regional resources). Zone has to belong to the region where managed instance # group is located. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @zone = args[:zone] if args.key?(:zone) end end # Represents an expression text. Example: # title: "User account presence" description: "Determines whether the request # has a user account" expression: "size(request.user) > 0" class Expr include Google::Apis::Core::Hashable # An 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. # The application context of the containing message determines which well-known # feature set of CEL is supported. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression # An 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 # An 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 # Represents a Firewall resource. class Firewall include Google::Apis::Core::Hashable # The list of ALLOW rules specified by this firewall. Each rule specifies a # protocol and port-range tuple that describes a permitted connection. # Corresponds to the JSON property `allowed` # @return [Array] attr_accessor :allowed # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # The list of DENY rules specified by this firewall. Each rule specifies a # protocol and port-range tuple that describes a denied connection. # Corresponds to the JSON property `denied` # @return [Array] attr_accessor :denied # 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 # If destination ranges are specified, the firewall will apply only to traffic # that has destination IP address in these ranges. These ranges must be # expressed in CIDR format. Only IPv4 is supported. # Corresponds to the JSON property `destinationRanges` # @return [Array] attr_accessor :destination_ranges # Direction of traffic to which this firewall applies; default is INGRESS. Note: # For INGRESS traffic, it is NOT supported to specify destinationRanges; For # EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags. # Corresponds to the JSON property `direction` # @return [String] attr_accessor :direction # Denotes whether the firewall rule is disabled, i.e not applied to the network # it is associated with. When set to true, the firewall rule is not enforced and # the network behaves as if it did not exist. If this is unspecified, the # firewall rule will be enabled. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled alias_method :disabled?, :disabled # This field denotes whether to enable logging for a particular firewall rule. # If logging is enabled, logs will be exported to the configured export # destination for all firewall logs in the network. Logs may be exported to # BigQuery or Pub/Sub. # Corresponds to the JSON property `enableLogging` # @return [Boolean] attr_accessor :enable_logging alias_method :enable_logging?, :enable_logging # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#firewall for firewall rules. # 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 # URL of the network resource for this firewall rule. If not specified when # creating a firewall rule, the default network is used: # global/networks/default # If you choose to specify this property, you can specify the network as a full # or partial URL. For example, the following are all valid URLs: # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my- # network # - projects/myproject/global/networks/my-network # - global/networks/default # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Priority for this rule. This is an integer between 0 and 65535, both inclusive. # When not specified, the value assumed is 1000. Relative priorities determine # precedence of conflicting rules. Lower value of priority implies higher # precedence (eg, a rule with priority 0 has higher precedence than a rule with # priority 1). DENY rules take precedence over ALLOW rules having equal priority. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # If source ranges are specified, the firewall will apply only to traffic that # has source IP address in these ranges. These ranges must be expressed in CIDR # format. One or both of sourceRanges and sourceTags may be set. If both # properties are set, the firewall will apply to traffic that has source IP # address within sourceRanges OR the source IP that belongs to a tag listed in # the sourceTags property. The connection does not need to match both properties # for the firewall to apply. Only IPv4 is supported. # Corresponds to the JSON property `sourceRanges` # @return [Array] attr_accessor :source_ranges # If source service accounts are specified, the firewall will apply only to # traffic originating from an instance with a service account in this list. # Source service accounts cannot be used to control traffic to an instance's # external IP address because service accounts are associated with an instance, # not an IP address. sourceRanges can be set at the same time as # sourceServiceAccounts. If both are set, the firewall will apply to traffic # that has source IP address within sourceRanges OR the source IP belongs to an # instance with service account listed in sourceServiceAccount. The connection # does not need to match both properties for the firewall to apply. # sourceServiceAccounts cannot be used at the same time as sourceTags or # targetTags. # Corresponds to the JSON property `sourceServiceAccounts` # @return [Array] attr_accessor :source_service_accounts # If source tags are specified, the firewall rule applies only to traffic with # source IPs that match the primary network interfaces of VM instances that have # the tag and are in the same VPC network. Source tags cannot be used to control # traffic to an instance's external IP address, it only applies to traffic # between instances in the same virtual network. Because tags are associated # with instances, not IP addresses. One or both of sourceRanges and sourceTags # may be set. If both properties are set, the firewall will apply to traffic # that has source IP address within sourceRanges OR the source IP that belongs # to a tag listed in the sourceTags property. The connection does not need to # match both properties for the firewall to apply. # Corresponds to the JSON property `sourceTags` # @return [Array] attr_accessor :source_tags # A list of service accounts indicating sets of instances located in the network # that may make network connections as specified in allowed[]. # targetServiceAccounts cannot be used at the same time as targetTags or # sourceTags. If neither targetServiceAccounts nor targetTags are specified, the # firewall rule applies to all instances on the specified network. # Corresponds to the JSON property `targetServiceAccounts` # @return [Array] attr_accessor :target_service_accounts # A list of tags that controls which instances the firewall rule applies to. If # targetTags are specified, then the firewall rule applies only to instances in # the VPC network that have one of those tags. If no targetTags are specified, # the firewall rule applies to all instances on the specified network. # Corresponds to the JSON property `targetTags` # @return [Array] attr_accessor :target_tags def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allowed = args[:allowed] if args.key?(:allowed) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @denied = args[:denied] if args.key?(:denied) @description = args[:description] if args.key?(:description) @destination_ranges = args[:destination_ranges] if args.key?(:destination_ranges) @direction = args[:direction] if args.key?(:direction) @disabled = args[:disabled] if args.key?(:disabled) @enable_logging = args[:enable_logging] if args.key?(:enable_logging) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @priority = args[:priority] if args.key?(:priority) @self_link = args[:self_link] if args.key?(:self_link) @source_ranges = args[:source_ranges] if args.key?(:source_ranges) @source_service_accounts = args[:source_service_accounts] if args.key?(:source_service_accounts) @source_tags = args[:source_tags] if args.key?(:source_tags) @target_service_accounts = args[:target_service_accounts] if args.key?(:target_service_accounts) @target_tags = args[:target_tags] if args.key?(:target_tags) end # class Allowed include Google::Apis::Core::Hashable # The IP protocol to which this rule applies. The protocol type is required when # creating a firewall rule. This value can either be one of the following well # known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP # protocol number. # Corresponds to the JSON property `IPProtocol` # @return [String] attr_accessor :ip_protocol # An optional list of ports to which this rule applies. This field is only # applicable for UDP or TCP protocol. Each entry must be either an integer or a # range. If not specified, this rule applies to connections through any port. # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. # Corresponds to the JSON property `ports` # @return [Array] attr_accessor :ports def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol) @ports = args[:ports] if args.key?(:ports) end end # class Denied include Google::Apis::Core::Hashable # The IP protocol to which this rule applies. The protocol type is required when # creating a firewall rule. This value can either be one of the following well # known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP # protocol number. # Corresponds to the JSON property `IPProtocol` # @return [String] attr_accessor :ip_protocol # An optional list of ports to which this rule applies. This field is only # applicable for UDP or TCP protocol. Each entry must be either an integer or a # range. If not specified, this rule applies to connections through any port. # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. # Corresponds to the JSON property `ports` # @return [Array] attr_accessor :ports def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol) @ports = args[:ports] if args.key?(:ports) end end end # Contains a list of firewalls. class FirewallList 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 Firewall resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#firewallList for lists of # firewalls. # 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::FirewallList::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 # Encapsulates numeric value that can be either absolute or relative. class FixedOrPercent include Google::Apis::Core::Hashable # [Output Only] Absolute value of VM instances calculated based on the specific # mode. # # - If the value is fixed, then the caculated value is equal to the fixed value. # - If the value is a percent, then the calculated value is percent/100 * # targetSize. For example, the calculated value of a 80% of a managed instance # group with 150 instances would be (80/100 * 150) = 120 VM instances. If there # is a remainder, the number is rounded up. # Corresponds to the JSON property `calculated` # @return [Fixnum] attr_accessor :calculated # Specifies a fixed number of VM instances. This must be a positive integer. # Corresponds to the JSON property `fixed` # @return [Fixnum] attr_accessor :fixed # Specifies a percentage of instances between 0 to 100%, inclusive. For example, # specify 80 for 80%. # Corresponds to the JSON property `percent` # @return [Fixnum] attr_accessor :percent def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @calculated = args[:calculated] if args.key?(:calculated) @fixed = args[:fixed] if args.key?(:fixed) @percent = args[:percent] if args.key?(:percent) end end # A ForwardingRule resource. A ForwardingRule resource specifies which pool of # target virtual machines to forward a packet to if it matches the given [ # IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules ==) # (== resource_for v1.forwardingRules ==) (== resource_for beta. # globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== # resource_for beta.regionForwardingRules ==) (== resource_for v1. # regionForwardingRules ==) class ForwardingRule include Google::Apis::Core::Hashable # The IP address that this forwarding rule is serving on behalf of. # Addresses are restricted based on the forwarding rule's load balancing scheme ( # EXTERNAL or INTERNAL) and scope (global or regional). # When the load balancing scheme is EXTERNAL, for global forwarding rules, the # address must be a global IP, and for regional forwarding rules, the address # must live in the same region as the forwarding rule. If this field is empty, # an ephemeral IPv4 address from the same scope (global or regional) will be # assigned. A regional forwarding rule supports IPv4 only. A global forwarding # rule supports either IPv4 or IPv6. # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP # address belonging to the network/subnet configured for the forwarding rule. By # default, if this field is empty, an ephemeral internal IP address will be # automatically allocated from the IP range of the subnet or network configured # for this forwarding rule. # An address can be specified either by a literal IP address or a URL reference # to an existing Address resource. The following examples are all valid: # - 100.1.2.3 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/ # addresses/address # - projects/project/regions/region/addresses/address # - regions/region/addresses/address # - global/addresses/address # - address # Corresponds to the JSON property `IPAddress` # @return [String] attr_accessor :ip_address # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, # AH, SCTP or ICMP. # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. # Corresponds to the JSON property `IPProtocol` # @return [String] attr_accessor :ip_protocol # This field is not used for external load balancing. # For internal load balancing, this field identifies the BackendService resource # to receive the matched traffic. # Corresponds to the JSON property `backendService` # @return [String] attr_accessor :backend_service # [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 # Fingerprint of this resource. A hash of the contents stored in this object. # This field is used in optimistic locking. This field will be ignored when # inserting a ForwardingRule. Include the fingerprint in patch request to ensure # that you do not overwrite changes that were applied from another concurrent # request. # To see the latest fingerprint, make a get() request to retrieve a # ForwardingRule. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The IP Version that will be used by this forwarding rule. Valid options are # IPV4 or IPV6. This can only be specified for a global forwarding rule. # Corresponds to the JSON property `ipVersion` # @return [String] attr_accessor :ip_version # [Output Only] Type of the resource. Always compute#forwardingRule for # Forwarding Rule resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for the labels being applied to this resource, which is # essentially a hash of the labels set used for optimistic locking. The # fingerprint is initially generated by Compute Engine and changes after every # request to modify or update labels. You must always provide an up-to-date # fingerprint hash in order to update or change labels. # To see the latest fingerprint, make a get() request to retrieve a # ForwardingRule. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :label_fingerprint # Labels to apply to this resource. These can be later 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 # This signifies what the ForwardingRule will be used for and can only take the # following values: INTERNAL, EXTERNAL The value of INTERNAL means that this # will be used for Internal Network Load Balancing (TCP, UDP). The value of # EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, # External TCP/UDP LB, SSL Proxy) # Corresponds to the JSON property `loadBalancingScheme` # @return [String] attr_accessor :load_balancing_scheme # 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 # This field is not used for external load balancing. # For internal load balancing, this field identifies the network that the load # balanced IP should belong to for this Forwarding Rule. If this field is not # specified, the default network will be used. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # This signifies the networking tier used for configuring this load balancer and # can only take the following values: PREMIUM , STANDARD. # For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For # GlobalForwardingRule, the valid value is PREMIUM. # If this field is not specified, it is assumed to be PREMIUM. If IPAddress is # specified, this value must be equal to the networkTier of the Address. # Corresponds to the JSON property `networkTier` # @return [String] attr_accessor :network_tier # This field is used along with the target field for TargetHttpProxy, # TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, # TargetInstance. # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed # to ports in the specified range will be forwarded to target. Forwarding rules # with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. # Some types of forwarding target have constraints on the acceptable ports: # - TargetHttpProxy: 80, 8080 # - TargetHttpsProxy: 443 # - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, # 1883, 5222 # - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, # 1883, 5222 # - TargetVpnGateway: 500, 4500 # Corresponds to the JSON property `portRange` # @return [String] attr_accessor :port_range # This field is used along with the backend_service field for internal load # balancing. # When the load balancing scheme is INTERNAL, a single port or a comma separated # list of ports can be configured. Only packets addressed to these ports will be # forwarded to the backends configured with this forwarding rule. # You may specify a maximum of up to 5 ports. # Corresponds to the JSON property `ports` # @return [Array] attr_accessor :ports # [Output Only] URL of the region where the regional forwarding rule resides. # This field is not applicable to global forwarding rules. 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 # An optional prefix to the service name for this Forwarding Rule. If specified, # will be the first label of the fully qualified service name. # The label must be 1-63 characters long, and comply with RFC1035. Specifically, # the label 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. # This field is only used for internal load balancing. # Corresponds to the JSON property `serviceLabel` # @return [String] attr_accessor :service_label # [Output Only] The internal fully qualified service name for this Forwarding # Rule. # This field is only used for internal load balancing. # Corresponds to the JSON property `serviceName` # @return [String] attr_accessor :service_name # This field is not used for external load balancing. # For internal load balancing, this field identifies the subnetwork that the # load balanced IP should belong to for this Forwarding Rule. # If the network specified is in auto subnet mode, this field is optional. # However, if the network is in custom subnet mode, a subnetwork must be # specified. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork # The URL of the target resource to receive the matched traffic. For regional # forwarding rules, this target must live in the same region as the forwarding # rule. For global forwarding rules, this target must be a global load balancing # resource. The forwarded traffic must be of a type appropriate to the target # object. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ip_address = args[:ip_address] if args.key?(:ip_address) @ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol) @backend_service = args[:backend_service] if args.key?(:backend_service) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @ip_version = args[:ip_version] if args.key?(:ip_version) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @load_balancing_scheme = args[:load_balancing_scheme] if args.key?(:load_balancing_scheme) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @network_tier = args[:network_tier] if args.key?(:network_tier) @port_range = args[:port_range] if args.key?(:port_range) @ports = args[:ports] if args.key?(:ports) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @service_label = args[:service_label] if args.key?(:service_label) @service_name = args[:service_name] if args.key?(:service_name) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) @target = args[:target] if args.key?(:target) end end # class ForwardingRuleAggregatedList 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 ForwardingRulesScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList # for lists of forwarding rules. # 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::ForwardingRuleAggregatedList::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 # Contains a list of ForwardingRule resources. class ForwardingRuleList 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 ForwardingRule resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::ForwardingRuleList::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 # class ForwardingRuleReference include Google::Apis::Core::Hashable # # Corresponds to the JSON property `forwardingRule` # @return [String] attr_accessor :forwarding_rule def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @forwarding_rule = args[:forwarding_rule] if args.key?(:forwarding_rule) end end # class ForwardingRulesScopedList include Google::Apis::Core::Hashable # List of forwarding rules contained in this scope. # Corresponds to the JSON property `forwardingRules` # @return [Array] attr_accessor :forwarding_rules # Informational warning which replaces the list of forwarding rules when the # list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::ForwardingRulesScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @forwarding_rules = args[:forwarding_rules] if args.key?(:forwarding_rules) @warning = args[:warning] if args.key?(:warning) end # Informational warning which replaces the list of forwarding rules when the # list is empty. 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 # class GlobalSetLabelsRequest include Google::Apis::Core::Hashable # The fingerprint of the previous set of labels for this resource, used to # detect conflicts. The fingerprint is initially generated by Compute Engine and # changes after every request to modify or update labels. You must always # provide an up-to-date fingerprint hash when updating or changing labels. Make # a get() request to the resource to get the latest fingerprint. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :label_fingerprint # A list of labels to apply for this resource. Each label key & value must # 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. For example, "webserver-frontend": "images". A label value can also be # empty (e.g. "my-label": ""). # 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) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) end end # A guest attributes entry. class GuestAttributes include Google::Apis::Core::Hashable # [Output Only] Type of the resource. Always compute#guestAttributes for guest # attributes entry. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Server-defined URL for this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The key to search for. # Corresponds to the JSON property `variableKey` # @return [String] attr_accessor :variable_key # [Output Only] The value found for the requested key. # Corresponds to the JSON property `variableValue` # @return [String] attr_accessor :variable_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @self_link = args[:self_link] if args.key?(:self_link) @variable_key = args[:variable_key] if args.key?(:variable_key) @variable_value = args[:variable_value] if args.key?(:variable_value) end end # Guest OS features. class GuestOsFeature include Google::Apis::Core::Hashable # The ID of a supported feature. Read Enabling guest operating system features # to see a list of available options. # 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) @type = args[:type] if args.key?(:type) end end # class Http2HealthCheck include Google::Apis::Core::Hashable # The value of the host header in the HTTP/2 health check request. If left empty # (default value), the IP on behalf of which this health check is performed will # be used. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # The TCP port number for the health check request. The default value is 443. # Valid values are 1 through 65535. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port # Port name as defined in InstanceGroup#NamedPort#name. If both port and # port_name are defined, port takes precedence. # Corresponds to the JSON property `portName` # @return [String] attr_accessor :port_name # Specifies how port is selected for health checking, can be one of following # values: # USE_FIXED_PORT: The port number in # port # is used for health checking. # USE_NAMED_PORT: The # portName # is used for health checking. # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each # network endpoint is used for health checking. For other backends, the port or # named port specified in the Backend Service is used for health checking. # If not specified, HTTP2 health check follows behavior specified in # port # and # portName # fields. # Corresponds to the JSON property `portSpecification` # @return [String] attr_accessor :port_specification # Specifies the type of proxy header to append before sending data to the # backend, either NONE or PROXY_V1. The default is NONE. # Corresponds to the JSON property `proxyHeader` # @return [String] attr_accessor :proxy_header # The request path of the HTTP/2 health check request. The default value is /. # Corresponds to the JSON property `requestPath` # @return [String] attr_accessor :request_path # The string to match anywhere in the first 1024 bytes of the response body. If # left empty (the default value), the status code determines health. The # response data can only be ASCII. # Corresponds to the JSON property `response` # @return [String] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @host = args[:host] if args.key?(:host) @port = args[:port] if args.key?(:port) @port_name = args[:port_name] if args.key?(:port_name) @port_specification = args[:port_specification] if args.key?(:port_specification) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) @request_path = args[:request_path] if args.key?(:request_path) @response = args[:response] if args.key?(:response) end end # class HttpHealthCheck include Google::Apis::Core::Hashable # The value of the host header in the HTTP health check request. If left empty ( # default value), the IP on behalf of which this health check is performed will # be used. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # The TCP port number for the health check request. The default value is 80. # Valid values are 1 through 65535. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port # Port name as defined in InstanceGroup#NamedPort#name. If both port and # port_name are defined, port takes precedence. # Corresponds to the JSON property `portName` # @return [String] attr_accessor :port_name # Specifies how port is selected for health checking, can be one of following # values: # USE_FIXED_PORT: The port number in # port # is used for health checking. # USE_NAMED_PORT: The # portName # is used for health checking. # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each # network endpoint is used for health checking. For other backends, the port or # named port specified in the Backend Service is used for health checking. # If not specified, HTTP health check follows behavior specified in # port # and # portName # fields. # Corresponds to the JSON property `portSpecification` # @return [String] attr_accessor :port_specification # Specifies the type of proxy header to append before sending data to the # backend, either NONE or PROXY_V1. The default is NONE. # Corresponds to the JSON property `proxyHeader` # @return [String] attr_accessor :proxy_header # The request path of the HTTP health check request. The default value is /. # Corresponds to the JSON property `requestPath` # @return [String] attr_accessor :request_path # The string to match anywhere in the first 1024 bytes of the response body. If # left empty (the default value), the status code determines health. The # response data can only be ASCII. # Corresponds to the JSON property `response` # @return [String] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @host = args[:host] if args.key?(:host) @port = args[:port] if args.key?(:port) @port_name = args[:port_name] if args.key?(:port_name) @port_specification = args[:port_specification] if args.key?(:port_specification) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) @request_path = args[:request_path] if args.key?(:request_path) @response = args[:response] if args.key?(:response) end end # class HttpsHealthCheck include Google::Apis::Core::Hashable # The value of the host header in the HTTPS health check request. If left empty ( # default value), the IP on behalf of which this health check is performed will # be used. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # The TCP port number for the health check request. The default value is 443. # Valid values are 1 through 65535. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port # Port name as defined in InstanceGroup#NamedPort#name. If both port and # port_name are defined, port takes precedence. # Corresponds to the JSON property `portName` # @return [String] attr_accessor :port_name # Specifies how port is selected for health checking, can be one of following # values: # USE_FIXED_PORT: The port number in # port # is used for health checking. # USE_NAMED_PORT: The # portName # is used for health checking. # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each # network endpoint is used for health checking. For other backends, the port or # named port specified in the Backend Service is used for health checking. # If not specified, HTTPS health check follows behavior specified in # port # and # portName # fields. # Corresponds to the JSON property `portSpecification` # @return [String] attr_accessor :port_specification # Specifies the type of proxy header to append before sending data to the # backend, either NONE or PROXY_V1. The default is NONE. # Corresponds to the JSON property `proxyHeader` # @return [String] attr_accessor :proxy_header # The request path of the HTTPS health check request. The default value is /. # Corresponds to the JSON property `requestPath` # @return [String] attr_accessor :request_path # The string to match anywhere in the first 1024 bytes of the response body. If # left empty (the default value), the status code determines health. The # response data can only be ASCII. # Corresponds to the JSON property `response` # @return [String] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @host = args[:host] if args.key?(:host) @port = args[:port] if args.key?(:port) @port_name = args[:port_name] if args.key?(:port_name) @port_specification = args[:port_specification] if args.key?(:port_specification) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) @request_path = args[:request_path] if args.key?(:request_path) @response = args[:response] if args.key?(:response) end end # An HealthCheck resource. This resource defines a template for how individual # virtual machines should be checked for health, via one of the supported # protocols. class HealthCheck include Google::Apis::Core::Hashable # How often (in seconds) to send a health check. The default value is 5 seconds. # Corresponds to the JSON property `checkIntervalSec` # @return [Fixnum] attr_accessor :check_interval_sec # [Output Only] Creation timestamp in 3339 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 # A so-far unhealthy instance will be marked healthy after this many consecutive # successes. The default value is 2. # Corresponds to the JSON property `healthyThreshold` # @return [Fixnum] attr_accessor :healthy_threshold # # Corresponds to the JSON property `http2HealthCheck` # @return [Google::Apis::ComputeAlpha::Http2HealthCheck] attr_accessor :http2_health_check # # Corresponds to the JSON property `httpHealthCheck` # @return [Google::Apis::ComputeAlpha::HttpHealthCheck] attr_accessor :http_health_check # # Corresponds to the JSON property `httpsHealthCheck` # @return [Google::Apis::ComputeAlpha::HttpsHealthCheck] attr_accessor :https_health_check # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Type of the resource. # 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 # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # # Corresponds to the JSON property `sslHealthCheck` # @return [Google::Apis::ComputeAlpha::SslHealthCheck] attr_accessor :ssl_health_check # # Corresponds to the JSON property `tcpHealthCheck` # @return [Google::Apis::ComputeAlpha::TcpHealthCheck] attr_accessor :tcp_health_check # How long (in seconds) to wait before claiming failure. The default value is 5 # seconds. It is invalid for timeoutSec to have greater value than # checkIntervalSec. # Corresponds to the JSON property `timeoutSec` # @return [Fixnum] attr_accessor :timeout_sec # Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not # specified, the default is TCP. Exactly one of the protocol-specific health # check field must be specified, which must match type field. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # # Corresponds to the JSON property `udpHealthCheck` # @return [Google::Apis::ComputeAlpha::UdpHealthCheck] attr_accessor :udp_health_check # A so-far healthy instance will be marked unhealthy after this many consecutive # failures. The default value is 2. # Corresponds to the JSON property `unhealthyThreshold` # @return [Fixnum] attr_accessor :unhealthy_threshold def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @check_interval_sec = args[:check_interval_sec] if args.key?(:check_interval_sec) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold) @http2_health_check = args[:http2_health_check] if args.key?(:http2_health_check) @http_health_check = args[:http_health_check] if args.key?(:http_health_check) @https_health_check = args[:https_health_check] if args.key?(:https_health_check) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) @ssl_health_check = args[:ssl_health_check] if args.key?(:ssl_health_check) @tcp_health_check = args[:tcp_health_check] if args.key?(:tcp_health_check) @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec) @type = args[:type] if args.key?(:type) @udp_health_check = args[:udp_health_check] if args.key?(:udp_health_check) @unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold) end end # Contains a list of HealthCheck resources. class HealthCheckList 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 HealthCheck resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::HealthCheckList::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 full or valid partial URL to a health check. For example, the following are # valid URLs: # - https://www.googleapis.com/compute/beta/projects/project-id/global/ # httpHealthChecks/health-check # - projects/project-id/global/httpHealthChecks/health-check # - global/httpHealthChecks/health-check class HealthCheckReference include Google::Apis::Core::Hashable # # Corresponds to the JSON property `healthCheck` # @return [String] attr_accessor :health_check def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @health_check = args[:health_check] if args.key?(:health_check) end end # class HealthStatus include Google::Apis::Core::Hashable # Health state of the instance. # Corresponds to the JSON property `healthState` # @return [String] attr_accessor :health_state # URL of the instance resource. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # The IP address represented by this resource. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address # The port on the instance. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @health_state = args[:health_state] if args.key?(:health_state) @instance = args[:instance] if args.key?(:instance) @ip_address = args[:ip_address] if args.key?(:ip_address) @port = args[:port] if args.key?(:port) end end # class HealthStatusForNetworkEndpoint include Google::Apis::Core::Hashable # URL of the backend service associated with the health state of the network # endpoint. # Corresponds to the JSON property `backendService` # @return [Google::Apis::ComputeAlpha::BackendServiceReference] attr_accessor :backend_service # URL of the forwarding rule associated with the health state of the network # endpoint. # Corresponds to the JSON property `forwardingRule` # @return [Google::Apis::ComputeAlpha::ForwardingRuleReference] attr_accessor :forwarding_rule # A full or valid partial URL to a health check. For example, the following are # valid URLs: # - https://www.googleapis.com/compute/beta/projects/project-id/global/ # httpHealthChecks/health-check # - projects/project-id/global/httpHealthChecks/health-check # - global/httpHealthChecks/health-check # Corresponds to the JSON property `healthCheck` # @return [Google::Apis::ComputeAlpha::HealthCheckReference] attr_accessor :health_check # Health state of the network endpoint determined based on the health checks # configured. # Corresponds to the JSON property `healthState` # @return [String] attr_accessor :health_state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @backend_service = args[:backend_service] if args.key?(:backend_service) @forwarding_rule = args[:forwarding_rule] if args.key?(:forwarding_rule) @health_check = args[:health_check] if args.key?(:health_check) @health_state = args[:health_state] if args.key?(:health_state) end end # class Host include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] An optional textual description of the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Full or partial URL of the host type resource to use for this host, in the # format: zones/zone/hostTypes/host-type. This is provided by the client when # the host is created. For example, the following is a valid partial url to a # predefined host type: # zones/us-central1-b/hostTypes/n1-host-64-416 # Corresponds to the JSON property `hostType` # @return [String] attr_accessor :host_type # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # A list of resource URLs to the virtual machine instances in this host. They # must live in zones contained in the same region as this host. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances # [Output Only] The type of the resource. Always compute#host for host. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for this request, which is essentially a hash of the metadata's # contents and used for optimistic locking. The fingerprint is initially # generated by Compute Engine and changes after every request to modify or # update metadata. You must always provide an up-to-date fingerprint hash in # order to update or change metadata. # To see the latest fingerprint, make get() request to the host. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :label_fingerprint # Labels to apply to this host. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The name of the resource, provided by the client when initially creating the # resource. The resource 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 # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] The status of the host. One of the following values: CREATING, # READY, REPAIR, and DELETING. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional, human-readable explanation of the status. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # [Output Only] The name of the zone where the host resides, such as us-central1- # a. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @host_type = args[:host_type] if args.key?(:host_type) @id = args[:id] if args.key?(:id) @instances = args[:instances] if args.key?(:instances) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @zone = args[:zone] if args.key?(:zone) end end # class HostAggregatedList 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 HostsScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#hostAggregatedList for # aggregated lists of hosts. # 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::HostAggregatedList::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 # Contains a list of hosts. class HostList 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 Host resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#hostList for lists of hosts. # 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::HostList::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 # UrlMaps A host-matching rule for a URL. If matched, will use the named # PathMatcher to select the BackendService. class HostRule include Google::Apis::Core::Hashable # 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 # The list of host patterns to match. They must be valid hostnames, except * # will match any string of ([a-z0-9-.]*). In that case, * must be the first # character and must be followed in the pattern by either - or .. # Corresponds to the JSON property `hosts` # @return [Array] attr_accessor :hosts # The name of the PathMatcher to use to match the path portion of the URL if the # hostRule matches the URL's host portion. # Corresponds to the JSON property `pathMatcher` # @return [String] attr_accessor :path_matcher def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @hosts = args[:hosts] if args.key?(:hosts) @path_matcher = args[:path_matcher] if args.key?(:path_matcher) end end # A Host Type resource. class HostType include Google::Apis::Core::Hashable # [Output Only] The CPU platform used by this host type. # Corresponds to the JSON property `cpuPlatform` # @return [String] attr_accessor :cpu_platform # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # Deprecation status for a public resource. # Corresponds to the JSON property `deprecated` # @return [Google::Apis::ComputeAlpha::DeprecationStatus] attr_accessor :deprecated # [Output Only] An optional textual description of the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The number of virtual CPUs that are available to the host type. # Corresponds to the JSON property `guestCpus` # @return [Fixnum] attr_accessor :guest_cpus # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The type of the resource. Always compute#hostType for host types. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Local SSD available to the host type, defined in GB. # Corresponds to the JSON property `localSsdGb` # @return [Fixnum] attr_accessor :local_ssd_gb # [Output Only] The amount of physical memory available to the host type, # defined in MB. # Corresponds to the JSON property `memoryMb` # @return [Fixnum] attr_accessor :memory_mb # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] The name of the zone where the host type resides, such as us- # central1-a. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cpu_platform = args[:cpu_platform] if args.key?(:cpu_platform) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @deprecated = args[:deprecated] if args.key?(:deprecated) @description = args[:description] if args.key?(:description) @guest_cpus = args[:guest_cpus] if args.key?(:guest_cpus) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @local_ssd_gb = args[:local_ssd_gb] if args.key?(:local_ssd_gb) @memory_mb = args[:memory_mb] if args.key?(:memory_mb) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) @zone = args[:zone] if args.key?(:zone) end end # class HostTypeAggregatedList 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 HostTypesScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource.Always compute#hostTypeAggregatedList for # aggregated lists of host types. # 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::HostTypeAggregatedList::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 # Contains a list of host types. class HostTypeList 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 HostType resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource.Always compute#hostTypeList for lists of host # types. # 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::HostTypeList::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 # class HostTypesScopedList include Google::Apis::Core::Hashable # [Output Only] List of host types contained in this scope. # Corresponds to the JSON property `hostTypes` # @return [Array] attr_accessor :host_types # [Output Only] An informational warning that appears when the host types list # is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::HostTypesScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @host_types = args[:host_types] if args.key?(:host_types) @warning = args[:warning] if args.key?(:warning) end # [Output Only] An informational warning that appears when the host types list # is empty. 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 # class HostsScopedList include Google::Apis::Core::Hashable # [Output Only] List of hosts contained in this scope. # Corresponds to the JSON property `hosts` # @return [Array] attr_accessor :hosts # [Output Only] An informational warning that appears when the host list is # empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::HostsScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @hosts = args[:hosts] if args.key?(:hosts) @warning = args[:warning] if args.key?(:warning) end # [Output Only] An informational warning that appears when the host list is # empty. 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 # Time window specified for hourly maintenance operations. class HourlyMaintenanceWindow include Google::Apis::Core::Hashable # [Output only] Duration of the time window, automatically chosen to be smallest # possible in the given scenario. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration # Allows to define schedule that runs every nth hour. # Corresponds to the JSON property `hoursInCycle` # @return [Fixnum] attr_accessor :hours_in_cycle # Time within the maintenance window to start the maintenance operations. It # must be in format "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. # 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) @duration = args[:duration] if args.key?(:duration) @hours_in_cycle = args[:hours_in_cycle] if args.key?(:hours_in_cycle) @start_time = args[:start_time] if args.key?(:start_time) end end # An HttpHealthCheck resource. This resource defines a template for how # individual instances should be checked for health, via HTTP. class HttpHealthCheck include Google::Apis::Core::Hashable # How often (in seconds) to send a health check. The default value is 5 seconds. # Corresponds to the JSON property `checkIntervalSec` # @return [Fixnum] attr_accessor :check_interval_sec # [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 # A so-far unhealthy instance will be marked healthy after this many consecutive # successes. The default value is 2. # Corresponds to the JSON property `healthyThreshold` # @return [Fixnum] attr_accessor :healthy_threshold # The value of the host header in the HTTP health check request. If left empty ( # default value), the public IP on behalf of which this health check is # performed will be used. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP # health checks. # 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 # The TCP port number for the HTTP health check request. The default value is 80. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port # The request path of the HTTP health check request. The default value is /. # Corresponds to the JSON property `requestPath` # @return [String] attr_accessor :request_path # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # How long (in seconds) to wait before claiming failure. The default value is 5 # seconds. It is invalid for timeoutSec to have greater value than # checkIntervalSec. # Corresponds to the JSON property `timeoutSec` # @return [Fixnum] attr_accessor :timeout_sec # A so-far healthy instance will be marked unhealthy after this many consecutive # failures. The default value is 2. # Corresponds to the JSON property `unhealthyThreshold` # @return [Fixnum] attr_accessor :unhealthy_threshold def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @check_interval_sec = args[:check_interval_sec] if args.key?(:check_interval_sec) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold) @host = args[:host] if args.key?(:host) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @port = args[:port] if args.key?(:port) @request_path = args[:request_path] if args.key?(:request_path) @self_link = args[:self_link] if args.key?(:self_link) @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec) @unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold) end end # Contains a list of HttpHealthCheck resources. class HttpHealthCheckList 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 HttpHealthCheck resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::HttpHealthCheckList::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 # An HttpsHealthCheck resource. This resource defines a template for how # individual instances should be checked for health, via HTTPS. class HttpsHealthCheck include Google::Apis::Core::Hashable # How often (in seconds) to send a health check. The default value is 5 seconds. # Corresponds to the JSON property `checkIntervalSec` # @return [Fixnum] attr_accessor :check_interval_sec # [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 # A so-far unhealthy instance will be marked healthy after this many consecutive # successes. The default value is 2. # Corresponds to the JSON property `healthyThreshold` # @return [Fixnum] attr_accessor :healthy_threshold # The value of the host header in the HTTPS health check request. If left empty ( # default value), the public IP on behalf of which this health check is # performed will be used. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Type of the resource. # 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 # The TCP port number for the HTTPS health check request. The default value is # 443. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port # The request path of the HTTPS health check request. The default value is "/". # Corresponds to the JSON property `requestPath` # @return [String] attr_accessor :request_path # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # How long (in seconds) to wait before claiming failure. The default value is 5 # seconds. It is invalid for timeoutSec to have a greater value than # checkIntervalSec. # Corresponds to the JSON property `timeoutSec` # @return [Fixnum] attr_accessor :timeout_sec # A so-far healthy instance will be marked unhealthy after this many consecutive # failures. The default value is 2. # Corresponds to the JSON property `unhealthyThreshold` # @return [Fixnum] attr_accessor :unhealthy_threshold def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @check_interval_sec = args[:check_interval_sec] if args.key?(:check_interval_sec) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold) @host = args[:host] if args.key?(:host) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @port = args[:port] if args.key?(:port) @request_path = args[:request_path] if args.key?(:request_path) @self_link = args[:self_link] if args.key?(:self_link) @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec) @unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold) end end # Contains a list of HttpsHealthCheck resources. class HttpsHealthCheckList 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 HttpsHealthCheck resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::HttpsHealthCheckList::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 # An Image resource. (== resource_for beta.images ==) (== resource_for v1.images # ==) class Image include Google::Apis::Core::Hashable # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). # Corresponds to the JSON property `archiveSizeBytes` # @return [Fixnum] attr_accessor :archive_size_bytes # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # Deprecation status for a public resource. # Corresponds to the JSON property `deprecated` # @return [Google::Apis::ComputeAlpha::DeprecationStatus] attr_accessor :deprecated # 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 # Size of the image when restored onto a persistent disk (in GB). # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] attr_accessor :disk_size_gb # The name of the image family to which this image belongs. You can create disks # by specifying an image family instead of a specific image name. The image # family always returns its latest image that is not deprecated. The name of the # image family must comply with RFC1035. # Corresponds to the JSON property `family` # @return [String] attr_accessor :family # A list of features to enable on the guest operating system. Applicable only # for bootable images. Read Enabling guest operating system features to see a # list of available options. # Corresponds to the JSON property `guestOsFeatures` # @return [Array] attr_accessor :guest_os_features # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a customer-supplied encryption key # Corresponds to the JSON property `imageEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :image_encryption_key # [Output Only] Type of the resource. Always compute#image for images. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for the labels being applied to this image, which is essentially # a hash of the labels used for optimistic locking. The fingerprint is initially # generated by Compute Engine and changes after every request to modify or # update labels. You must always provide an up-to-date fingerprint hash in order # to update or change labels. # To see the latest fingerprint, make a get() request to retrieve an image. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :label_fingerprint # Labels to apply to this image. These can be later modified by the setLabels # method. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Integer license codes indicating which licenses are attached to this image. # Corresponds to the JSON property `licenseCodes` # @return [Array] attr_accessor :license_codes # Any applicable license URI. # Corresponds to the JSON property `licenses` # @return [Array] attr_accessor :licenses # 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 # The parameters of the raw disk image. # Corresponds to the JSON property `rawDisk` # @return [Google::Apis::ComputeAlpha::Image::RawDisk] attr_accessor :raw_disk # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # URL of the source disk used to create this image. This can be a full or valid # partial URL. You must provide either this property or the rawDisk.source # property but not both to create an image. For example, the following are valid # values: # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk # - projects/project/zones/zone/disks/disk # - zones/zone/disks/disk # Corresponds to the JSON property `sourceDisk` # @return [String] attr_accessor :source_disk # Represents a customer-supplied encryption key # Corresponds to the JSON property `sourceDiskEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :source_disk_encryption_key # The ID value of the disk used to create this image. This value may be used to # determine whether the image was taken from the current or a previous instance # of a given disk name. # Corresponds to the JSON property `sourceDiskId` # @return [String] attr_accessor :source_disk_id # URL of the source image used to create this image. This can be a full or valid # partial URL. You must provide exactly one of: # - this property, or # - the rawDisk.source property, or # - the sourceDisk property in order to create an image. # Corresponds to the JSON property `sourceImage` # @return [String] attr_accessor :source_image # Represents a customer-supplied encryption key # Corresponds to the JSON property `sourceImageEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :source_image_encryption_key # [Output Only] The ID value of the image used to create this image. This value # may be used to determine whether the image was taken from the current or a # previous instance of a given image name. # Corresponds to the JSON property `sourceImageId` # @return [String] attr_accessor :source_image_id # URL of the source snapshot used to create this image. This can be a full or # valid partial URL. You must provide exactly one of: # - this property, or # - the sourceImage property, or # - the rawDisk.source property, or # - the sourceDisk property in order to create an image. # Corresponds to the JSON property `sourceSnapshot` # @return [String] attr_accessor :source_snapshot # Represents a customer-supplied encryption key # Corresponds to the JSON property `sourceSnapshotEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :source_snapshot_encryption_key # [Output Only] The ID value of the snapshot used to create this image. This # value may be used to determine whether the snapshot was taken from the current # or a previous instance of a given snapshot name. # Corresponds to the JSON property `sourceSnapshotId` # @return [String] attr_accessor :source_snapshot_id # The type of the image used to create this disk. The default and only value is # RAW # Corresponds to the JSON property `sourceType` # @return [String] attr_accessor :source_type # [Output Only] The status of the image. An image can be used to create other # resources, such as instances, only after the image has been successfully # created and the status is set to READY. Possible values are FAILED, PENDING, # or READY. # 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) @archive_size_bytes = args[:archive_size_bytes] if args.key?(:archive_size_bytes) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @deprecated = args[:deprecated] if args.key?(:deprecated) @description = args[:description] if args.key?(:description) @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) @family = args[:family] if args.key?(:family) @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features) @id = args[:id] if args.key?(:id) @image_encryption_key = args[:image_encryption_key] if args.key?(:image_encryption_key) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @license_codes = args[:license_codes] if args.key?(:license_codes) @licenses = args[:licenses] if args.key?(:licenses) @name = args[:name] if args.key?(:name) @raw_disk = args[:raw_disk] if args.key?(:raw_disk) @self_link = args[:self_link] if args.key?(:self_link) @source_disk = args[:source_disk] if args.key?(:source_disk) @source_disk_encryption_key = args[:source_disk_encryption_key] if args.key?(:source_disk_encryption_key) @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id) @source_image = args[:source_image] if args.key?(:source_image) @source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key) @source_image_id = args[:source_image_id] if args.key?(:source_image_id) @source_snapshot = args[:source_snapshot] if args.key?(:source_snapshot) @source_snapshot_encryption_key = args[:source_snapshot_encryption_key] if args.key?(:source_snapshot_encryption_key) @source_snapshot_id = args[:source_snapshot_id] if args.key?(:source_snapshot_id) @source_type = args[:source_type] if args.key?(:source_type) @status = args[:status] if args.key?(:status) end # The parameters of the raw disk image. class RawDisk include Google::Apis::Core::Hashable # The format used to encode and transmit the block device, which should be TAR. # This is just a container and transmission format and not a runtime format. # Provided by the client when the disk image is created. # Corresponds to the JSON property `containerType` # @return [String] attr_accessor :container_type # An optional SHA1 checksum of the disk image before unpackaging; provided by # the client when the disk image is created. # Corresponds to the JSON property `sha1Checksum` # @return [String] attr_accessor :sha1_checksum # The full Google Cloud Storage URL where the disk image is stored. You must # provide either this property or the sourceDisk property but not both. # 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) @container_type = args[:container_type] if args.key?(:container_type) @sha1_checksum = args[:sha1_checksum] if args.key?(:sha1_checksum) @source = args[:source] if args.key?(:source) end end end # Contains a list of images. class ImageList 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 Image resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::ImageList::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 # An Instance resource. (== resource_for beta.instances ==) (== resource_for v1. # instances ==) class Instance include Google::Apis::Core::Hashable # Allows this instance to send and receive packets with non-matching destination # or source IPs. This is required if you plan to use this instance to forward # routes. For more information, see Enabling IP Forwarding. # Corresponds to the JSON property `canIpForward` # @return [Boolean] attr_accessor :can_ip_forward alias_method :can_ip_forward?, :can_ip_forward # [Output Only] The CPU platform used by this instance. # Corresponds to the JSON property `cpuPlatform` # @return [String] attr_accessor :cpu_platform # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # Whether the resource should be protected against deletion. # Corresponds to the JSON property `deletionProtection` # @return [Boolean] attr_accessor :deletion_protection alias_method :deletion_protection?, :deletion_protection # 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 # Array of disks associated with this instance. Persistent disks must be created # before you can assign them. # Corresponds to the JSON property `disks` # @return [Array] attr_accessor :disks # List of the type and count of accelerator cards attached to the instance. # Corresponds to the JSON property `guestAccelerators` # @return [Array] attr_accessor :guest_accelerators # Full or partial URL of the host resource that the instance should be placed on, # in the format: zones/zone/hosts/host. # Optional, sole-tenant Host (physical machine) that the instance will be placed # on when it's created. The instance is guaranteed to be placed on the same # machine as other instances with the same sole-tenant host. # The request will be rejected if the sole-tenant host has run out of resources. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a customer-supplied encryption key # Corresponds to the JSON property `instanceEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :instance_encryption_key # [Output Only] Type of the resource. Always compute#instance for instances. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for this request, which is essentially a hash of the metadata's # contents and used for optimistic locking. The fingerprint is initially # generated by Compute Engine and changes after every request to modify or # update metadata. You must always provide an up-to-date fingerprint hash in # order to update or change metadata. # To see the latest fingerprint, make get() request to the instance. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :label_fingerprint # Labels to apply to this instance. These can be later modified by the setLabels # method. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Full or partial URL of the machine type resource to use for this instance, in # the format: zones/zone/machineTypes/machine-type. This is provided by the # client when the instance is created. For example, the following is a valid # partial url to a predefined machine type: # zones/us-central1-f/machineTypes/n1-standard-1 # To create a custom machine type, provide a URL to a machine type in the # following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, # etc), and MEMORY is the total memory for this instance. Memory must be a # multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): # zones/zone/machineTypes/custom-CPUS-MEMORY # For example: zones/us-central1-f/machineTypes/custom-4-5120 # For a full list of restrictions, read the Specifications for custom machine # types. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type # Maintenance policies applied to this instance. # Corresponds to the JSON property `maintenancePolicies` # @return [Array] attr_accessor :maintenance_policies # A metadata key/value entry. # Corresponds to the JSON property `metadata` # @return [Google::Apis::ComputeAlpha::Metadata] attr_accessor :metadata # Specifies a minimum CPU platform for the VM instance. Applicable values are # the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" # or minCpuPlatform: "Intel Sandy Bridge". # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform # The name of the resource, provided by the client when initially creating the # resource. The resource 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 network configurations for this instance. These specify how # interfaces are configured to interact with other network services, such as # connecting to the internet. Multiple interfaces are supported per instance. # Corresponds to the JSON property `networkInterfaces` # @return [Array] attr_accessor :network_interfaces # Total amount of preserved state for SUSPENDED instances. Read-only in the api. # Corresponds to the JSON property `preservedStateSizeGb` # @return [Fixnum] attr_accessor :preserved_state_size_gb # Sets the scheduling options for an Instance. # Corresponds to the JSON property `scheduling` # @return [Google::Apis::ComputeAlpha::Scheduling] attr_accessor :scheduling # [Output Only] Server-defined URL for this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # A list of service accounts, with their specified scopes, authorized for this # instance. Only one service account per VM instance is supported. # Service accounts generate access tokens that can be accessed through the # metadata server and used to authenticate applications on the instance. See # Service Accounts for more information. # Corresponds to the JSON property `serviceAccounts` # @return [Array] attr_accessor :service_accounts # A set of Shielded VM options. # Corresponds to the JSON property `shieldedVmConfig` # @return [Google::Apis::ComputeAlpha::ShieldedVmConfig] attr_accessor :shielded_vm_config # [Output Only] Whether a VM has been restricted for start because Compute # Engine has detected suspicious activity. # Corresponds to the JSON property `startRestricted` # @return [Boolean] attr_accessor :start_restricted alias_method :start_restricted?, :start_restricted # [Output Only] The status of the instance. One of the following values: # PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and # TERMINATED. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional, human-readable explanation of the status. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # A set of instance tags. # Corresponds to the JSON property `tags` # @return [Google::Apis::ComputeAlpha::Tags] attr_accessor :tags # [Output Only] URL of the zone where the instance resides. 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 `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @can_ip_forward = args[:can_ip_forward] if args.key?(:can_ip_forward) @cpu_platform = args[:cpu_platform] if args.key?(:cpu_platform) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @deletion_protection = args[:deletion_protection] if args.key?(:deletion_protection) @description = args[:description] if args.key?(:description) @disks = args[:disks] if args.key?(:disks) @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators) @host = args[:host] if args.key?(:host) @id = args[:id] if args.key?(:id) @instance_encryption_key = args[:instance_encryption_key] if args.key?(:instance_encryption_key) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @machine_type = args[:machine_type] if args.key?(:machine_type) @maintenance_policies = args[:maintenance_policies] if args.key?(:maintenance_policies) @metadata = args[:metadata] if args.key?(:metadata) @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @name = args[:name] if args.key?(:name) @network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces) @preserved_state_size_gb = args[:preserved_state_size_gb] if args.key?(:preserved_state_size_gb) @scheduling = args[:scheduling] if args.key?(:scheduling) @self_link = args[:self_link] if args.key?(:self_link) @service_accounts = args[:service_accounts] if args.key?(:service_accounts) @shielded_vm_config = args[:shielded_vm_config] if args.key?(:shielded_vm_config) @start_restricted = args[:start_restricted] if args.key?(:start_restricted) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @tags = args[:tags] if args.key?(:tags) @zone = args[:zone] if args.key?(:zone) end end # class InstanceAggregatedList 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 InstancesScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#instanceAggregatedList for # aggregated lists of Instance resources. # 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::InstanceAggregatedList::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 # InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for v1. # instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== # resource_for v1.regionInstanceGroups ==) class InstanceGroup include Google::Apis::Core::Hashable # [Output Only] The creation timestamp for this instance group 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 fingerprint of the named ports. The system uses this # fingerprint to detect conflicts when multiple users change the named ports # concurrently. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # [Output Only] A unique identifier for this instance group, generated by the # server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The resource type, which is always compute#instanceGroup for # instance groups. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the instance group. The name must be 1-63 characters long, and # comply with RFC1035. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Assigns a name to a port number. For example: `name: "http", port: 80` # This allows the system to reference ports by the assigned name instead of a # port number. Named ports can also contain multiple ports. For example: [`name: # "http", port: 80`,`name: "http", port: 8080`] # Named ports apply to all instances in this instance group. # Corresponds to the JSON property `namedPorts` # @return [Array] attr_accessor :named_ports # The URL of the network to which all instances in the instance group belong. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # The URL of the region where the instance group is located (for regional # resources). # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # [Output Only] The URL for this instance group. The server generates this URL. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] The total number of instances in the instance group. # Corresponds to the JSON property `size` # @return [Fixnum] attr_accessor :size # The URL of the subnetwork to which all instances in the instance group belong. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork # [Output Only] The URL of the zone where the instance group is located (for # zonal resources). # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @named_ports = args[:named_ports] if args.key?(:named_ports) @network = args[:network] if args.key?(:network) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @size = args[:size] if args.key?(:size) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) @zone = args[:zone] if args.key?(:zone) end end # class InstanceGroupAggregatedList 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 InstanceGroupsScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] The resource type, which is always compute# # instanceGroupAggregatedList for aggregated lists of instance groups. # 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::InstanceGroupAggregatedList::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 list of InstanceGroup resources. class InstanceGroupList 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 InstanceGroup resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] The resource type, which is always compute#instanceGroupList for # instance group lists. # 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::InstanceGroupList::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 # An Instance Group Manager resource. (== resource_for beta. # instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== # resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1. # regionInstanceGroupManagers ==) class InstanceGroupManager include Google::Apis::Core::Hashable # # Corresponds to the JSON property `activities` # @return [Google::Apis::ComputeAlpha::InstanceGroupManagerActivities] attr_accessor :activities # The autohealing policy for this managed instance group. You can specify only # one value. # Corresponds to the JSON property `autoHealingPolicies` # @return [Array] attr_accessor :auto_healing_policies # The base instance name to use for instances in this group. The value must be 1- # 58 characters long. Instances are named by appending a hyphen and a random # four-character string to the base instance name. The base instance name must # comply with RFC1035. # Corresponds to the JSON property `baseInstanceName` # @return [String] attr_accessor :base_instance_name # [Output Only] The creation timestamp for this managed instance group in # RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] The list of instance actions and the number of instances in this # managed instance group that are scheduled for each of those actions. # Corresponds to the JSON property `currentActions` # @return [Google::Apis::ComputeAlpha::InstanceGroupManagerActionsSummary] attr_accessor :current_actions # 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 # Policy valid only for regional managed instance groups. # Corresponds to the JSON property `distributionPolicy` # @return [Google::Apis::ComputeAlpha::DistributionPolicy] attr_accessor :distribution_policy # The action to perform in case of zone failure. Only one value is supported, # NO_FAILOVER. The default is NO_FAILOVER. # Corresponds to the JSON property `failoverAction` # @return [String] attr_accessor :failover_action # [Output Only] The fingerprint of the resource data. You can use this optional # field for optimistic locking when you update the resource. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # [Output Only] A unique identifier for this resource type. The server generates # this identifier. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The URL of the Instance Group resource. # Corresponds to the JSON property `instanceGroup` # @return [String] attr_accessor :instance_group # The URL of the instance template that is specified for this managed instance # group. The group uses this template to create all new instances in the managed # instance group. # Corresponds to the JSON property `instanceTemplate` # @return [String] attr_accessor :instance_template # [Output Only] The resource type, which is always compute#instanceGroupManager # for managed instance groups. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the managed instance group. The name must be 1-63 characters long, # and comply with RFC1035. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Named ports configured for the Instance Groups complementary to this Instance # Group Manager. # Corresponds to the JSON property `namedPorts` # @return [Array] attr_accessor :named_ports # [Output Only] The list of instance actions and the number of instances in this # managed instance group that are pending for each of those actions. # Corresponds to the JSON property `pendingActions` # @return [Google::Apis::ComputeAlpha::InstanceGroupManagerPendingActionsSummary] attr_accessor :pending_actions # [Output Only] The URL of the region where the managed instance group resides ( # for regional resources). # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # [Output Only] The URL for this managed instance group. The server defines this # URL. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] The service account to be used as credentials for all operations # performed by the managed instance group on instances. The service accounts # needs all permissions required to create and delete instances. By default, the # service account `projectNumber`@cloudservices.gserviceaccount.com is used. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account # Stateful configuration for this Instanced Group Manager # Corresponds to the JSON property `statefulPolicy` # @return [Google::Apis::ComputeAlpha::StatefulPolicy] attr_accessor :stateful_policy # The URLs for all TargetPool resources to which instances in the instanceGroup # field are added. The target pools automatically apply to all of the instances # in the managed instance group. # Corresponds to the JSON property `targetPools` # @return [Array] attr_accessor :target_pools # The target number of running instances for this managed instance group. # Deleting or abandoning instances reduces this number. Resizing the group # changes this number. # Corresponds to the JSON property `targetSize` # @return [Fixnum] attr_accessor :target_size # The update policy for this managed instance group. # Corresponds to the JSON property `updatePolicy` # @return [Google::Apis::ComputeAlpha::InstanceGroupManagerUpdatePolicy] attr_accessor :update_policy # Specifies the instance templates used by this managed instance group to create # instances. # Each version is defined by an instanceTemplate. Every template can appear at # most once per instance group. This field overrides the top-level # instanceTemplate field. Read more about the relationships between these fields. # Exactly one version must leave the targetSize field unset. That version will # be applied to all remaining instances. For more information, read about canary # updates. # Corresponds to the JSON property `versions` # @return [Array] attr_accessor :versions # [Output Only] The URL of the zone where the managed instance group is located ( # for zonal resources). # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @activities = args[:activities] if args.key?(:activities) @auto_healing_policies = args[:auto_healing_policies] if args.key?(:auto_healing_policies) @base_instance_name = args[:base_instance_name] if args.key?(:base_instance_name) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @current_actions = args[:current_actions] if args.key?(:current_actions) @description = args[:description] if args.key?(:description) @distribution_policy = args[:distribution_policy] if args.key?(:distribution_policy) @failover_action = args[:failover_action] if args.key?(:failover_action) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @instance_group = args[:instance_group] if args.key?(:instance_group) @instance_template = args[:instance_template] if args.key?(:instance_template) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @named_ports = args[:named_ports] if args.key?(:named_ports) @pending_actions = args[:pending_actions] if args.key?(:pending_actions) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @service_account = args[:service_account] if args.key?(:service_account) @stateful_policy = args[:stateful_policy] if args.key?(:stateful_policy) @target_pools = args[:target_pools] if args.key?(:target_pools) @target_size = args[:target_size] if args.key?(:target_size) @update_policy = args[:update_policy] if args.key?(:update_policy) @versions = args[:versions] if args.key?(:versions) @zone = args[:zone] if args.key?(:zone) end end # class InstanceGroupManagerActionsSummary include Google::Apis::Core::Hashable # [Output Only] The total number of instances in the managed instance group that # are scheduled to be abandoned. Abandoning an instance removes it from the # managed instance group without deleting it. # Corresponds to the JSON property `abandoning` # @return [Fixnum] attr_accessor :abandoning # [Output Only] The number of instances in the managed instance group that are # scheduled to be created or are currently being created. If the group fails to # create any of these instances, it tries again until it creates the instance # successfully. # If you have disabled creation retries, this field will not be populated; # instead, the creatingWithoutRetries field will be populated. # Corresponds to the JSON property `creating` # @return [Fixnum] attr_accessor :creating # [Output Only] The number of instances that the managed instance group will # attempt to create. The group attempts to create each instance only once. If # the group fails to create any of these instances, it decreases the group's # targetSize value accordingly. # Corresponds to the JSON property `creatingWithoutRetries` # @return [Fixnum] attr_accessor :creating_without_retries # [Output Only] The number of instances in the managed instance group that are # scheduled to be deleted or are currently being deleted. # Corresponds to the JSON property `deleting` # @return [Fixnum] attr_accessor :deleting # [Output Only] The number of instances in the managed instance group that are # running and have no scheduled actions. # Corresponds to the JSON property `none` # @return [Fixnum] attr_accessor :none # [Output Only] The number of instances in the managed instance group that are # scheduled to be recreated or are currently being being recreated. Recreating # an instance deletes the existing root persistent disk and creates a new disk # from the image that is defined in the instance template. # Corresponds to the JSON property `recreating` # @return [Fixnum] attr_accessor :recreating # [Output Only] The number of instances in the managed instance group that are # being reconfigured with properties that do not require a restart or a recreate # action. For example, setting or removing target pools for the instance. # Corresponds to the JSON property `refreshing` # @return [Fixnum] attr_accessor :refreshing # [Output Only] The number of instances in the managed instance group that are # scheduled to be restarted or are currently being restarted. # Corresponds to the JSON property `restarting` # @return [Fixnum] attr_accessor :restarting # [Output Only] The number of instances in the managed instance group that are # being verified. See the managedInstances[].currentAction property in the # listManagedInstances method documentation. # Corresponds to the JSON property `verifying` # @return [Fixnum] attr_accessor :verifying def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @abandoning = args[:abandoning] if args.key?(:abandoning) @creating = args[:creating] if args.key?(:creating) @creating_without_retries = args[:creating_without_retries] if args.key?(:creating_without_retries) @deleting = args[:deleting] if args.key?(:deleting) @none = args[:none] if args.key?(:none) @recreating = args[:recreating] if args.key?(:recreating) @refreshing = args[:refreshing] if args.key?(:refreshing) @restarting = args[:restarting] if args.key?(:restarting) @verifying = args[:verifying] if args.key?(:verifying) end end # class InstanceGroupManagerActivities include Google::Apis::Core::Hashable # # Corresponds to the JSON property `autohealing` # @return [String] attr_accessor :autohealing # # Corresponds to the JSON property `autohealingHealthCheckBased` # @return [String] attr_accessor :autohealing_health_check_based # # Corresponds to the JSON property `autoscalingDown` # @return [String] attr_accessor :autoscaling_down # # Corresponds to the JSON property `autoscalingUp` # @return [String] attr_accessor :autoscaling_up # # Corresponds to the JSON property `creatingInstances` # @return [String] attr_accessor :creating_instances # # Corresponds to the JSON property `deletingInstances` # @return [String] attr_accessor :deleting_instances # # Corresponds to the JSON property `recreatingInstances` # @return [String] attr_accessor :recreating_instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @autohealing = args[:autohealing] if args.key?(:autohealing) @autohealing_health_check_based = args[:autohealing_health_check_based] if args.key?(:autohealing_health_check_based) @autoscaling_down = args[:autoscaling_down] if args.key?(:autoscaling_down) @autoscaling_up = args[:autoscaling_up] if args.key?(:autoscaling_up) @creating_instances = args[:creating_instances] if args.key?(:creating_instances) @deleting_instances = args[:deleting_instances] if args.key?(:deleting_instances) @recreating_instances = args[:recreating_instances] if args.key?(:recreating_instances) end end # class InstanceGroupManagerAggregatedList 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 InstanceGroupManagersScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] The resource type, which is always compute# # instanceGroupManagerAggregatedList for an aggregated list of managed instance # groups. # 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::InstanceGroupManagerAggregatedList::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 # class InstanceGroupManagerAutoHealingPolicy include Google::Apis::Core::Hashable # The URL for the health check that signals autohealing. # Corresponds to the JSON property `healthCheck` # @return [String] attr_accessor :health_check # The number of seconds that the managed instance group waits before it applies # autohealing policies to new instances or recently recreated instances. This # initial delay allows instances to initialize and run their startup scripts # before the instance group determines that they are UNHEALTHY. This prevents # the managed instance group from recreating its instances prematurely. This # value must be from range [0, 3600]. # Corresponds to the JSON property `initialDelaySec` # @return [Fixnum] attr_accessor :initial_delay_sec # Encapsulates numeric value that can be either absolute or relative. # Corresponds to the JSON property `maxUnavailable` # @return [Google::Apis::ComputeAlpha::FixedOrPercent] attr_accessor :max_unavailable # Defines operating mode for this policy. # Corresponds to the JSON property `mode` # @return [String] attr_accessor :mode def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @health_check = args[:health_check] if args.key?(:health_check) @initial_delay_sec = args[:initial_delay_sec] if args.key?(:initial_delay_sec) @max_unavailable = args[:max_unavailable] if args.key?(:max_unavailable) @mode = args[:mode] if args.key?(:mode) end end # [Output Only] A list of managed instance groups. class InstanceGroupManagerList 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 InstanceGroupManager resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] The resource type, which is always compute# # instanceGroupManagerList for a list of managed instance groups. # 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::InstanceGroupManagerList::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 # class InstanceGroupManagerPendingActionsSummary include Google::Apis::Core::Hashable # [Output Only] The number of instances in the managed instance group that are # pending to be created. # Corresponds to the JSON property `creating` # @return [Fixnum] attr_accessor :creating # [Output Only] The number of instances in the managed instance group that are # pending to be deleted. # Corresponds to the JSON property `deleting` # @return [Fixnum] attr_accessor :deleting # [Output Only] The number of instances in the managed instance group that are # pending to be recreated. # Corresponds to the JSON property `recreating` # @return [Fixnum] attr_accessor :recreating # [Output Only] The number of instances in the managed instance group that are # pending to be restarted. # Corresponds to the JSON property `restarting` # @return [Fixnum] attr_accessor :restarting def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creating = args[:creating] if args.key?(:creating) @deleting = args[:deleting] if args.key?(:deleting) @recreating = args[:recreating] if args.key?(:recreating) @restarting = args[:restarting] if args.key?(:restarting) end end # class InstanceGroupManagerUpdatePolicy include Google::Apis::Core::Hashable # Encapsulates numeric value that can be either absolute or relative. # Corresponds to the JSON property `maxSurge` # @return [Google::Apis::ComputeAlpha::FixedOrPercent] attr_accessor :max_surge # Encapsulates numeric value that can be either absolute or relative. # Corresponds to the JSON property `maxUnavailable` # @return [Google::Apis::ComputeAlpha::FixedOrPercent] attr_accessor :max_unavailable # Minimum number of seconds to wait for after a newly created instance becomes # available. This value must be from range [0, 3600]. # Corresponds to the JSON property `minReadySec` # @return [Fixnum] attr_accessor :min_ready_sec # Minimal action to be taken on an instance. You can specify either RESTART to # restart existing instances or REPLACE to delete and create new instances from # the target template. If you specify a code>RESTART, the Updater will attempt # to perform that action only. However, if the Updater determines that the # minimal action you specify is not enough to perform the update, it might # perform a more disruptive action. # Corresponds to the JSON property `minimalAction` # @return [String] attr_accessor :minimal_action # # 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) @max_surge = args[:max_surge] if args.key?(:max_surge) @max_unavailable = args[:max_unavailable] if args.key?(:max_unavailable) @min_ready_sec = args[:min_ready_sec] if args.key?(:min_ready_sec) @minimal_action = args[:minimal_action] if args.key?(:minimal_action) @type = args[:type] if args.key?(:type) end end # class InstanceGroupManagerVersion include Google::Apis::Core::Hashable # # Corresponds to the JSON property `instanceTemplate` # @return [String] attr_accessor :instance_template # Name of the version. Unique among all versions in the scope of this managed # instance group. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Tag describing the version. Used to trigger rollout of a target version even # if instance_template remains unchanged. Deprecated in favor of 'name'. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag # Encapsulates numeric value that can be either absolute or relative. # Corresponds to the JSON property `targetSize` # @return [Google::Apis::ComputeAlpha::FixedOrPercent] attr_accessor :target_size def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance_template = args[:instance_template] if args.key?(:instance_template) @name = args[:name] if args.key?(:name) @tag = args[:tag] if args.key?(:tag) @target_size = args[:target_size] if args.key?(:target_size) end end # class InstanceGroupManagersAbandonInstancesRequest include Google::Apis::Core::Hashable # The URLs of one or more instances to abandon. This can be a full URL or a # partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # InstanceGroupManagers.applyUpdatesToInstances class InstanceGroupManagersApplyUpdatesRequest include Google::Apis::Core::Hashable # The list of URLs of one or more instances for which we want to apply updates # on this managed instance group. This can be a full URL or a partial URL, such # as zones/[ZONE]/instances/[INSTANCE_NAME]. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances # The maximal action that should be perfomed on the instances. By default # REPLACE. # Corresponds to the JSON property `maximalAction` # @return [String] attr_accessor :maximal_action # The minimal action that should be perfomed on the instances. By default NONE. # Corresponds to the JSON property `minimalAction` # @return [String] attr_accessor :minimal_action def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) @maximal_action = args[:maximal_action] if args.key?(:maximal_action) @minimal_action = args[:minimal_action] if args.key?(:minimal_action) end end # class InstanceGroupManagersDeleteInstancesRequest include Google::Apis::Core::Hashable # The URLs of one or more instances to delete. This can be a full URL or a # partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # InstanceGroupManagers.deletePerInstanceConfigs class InstanceGroupManagersDeletePerInstanceConfigsReq include Google::Apis::Core::Hashable # The list of instances for which we want to delete per-instance configs on this # managed instance group. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class InstanceGroupManagersListManagedInstancesResponse include Google::Apis::Core::Hashable # [Output Only] The list of instances in the managed instance group. # Corresponds to the JSON property `managedInstances` # @return [Array] attr_accessor :managed_instances # [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 def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @managed_instances = args[:managed_instances] if args.key?(:managed_instances) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # class InstanceGroupManagersListPerInstanceConfigsResp include Google::Apis::Core::Hashable # [Output Only] The list of PerInstanceConfig. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [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] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @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 # class InstanceGroupManagersRecreateInstancesRequest include Google::Apis::Core::Hashable # The URLs of one or more instances to recreate. This can be a full URL or a # partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class InstanceGroupManagersResizeAdvancedRequest include Google::Apis::Core::Hashable # If this flag is true, the managed instance group attempts to create all # instances initiated by this resize request only once. If there is an error # during creation, the managed instance group does not retry create this # instance, and we will decrease the targetSize of the request instead. If the # flag is false, the group attemps to recreate each instance continuously until # it succeeds. # This flag matters only in the first attempt of creation of an instance. After # an instance is successfully created while this flag is enabled, the instance # behaves the same way as all the other instances created with a regular resize # request. In particular, if a running instance dies unexpectedly at a later # time and needs to be recreated, this mode does not affect the recreation # behavior in that scenario. # This flag is applicable only to the current resize request. It does not # influence other resize requests in any way. # You can see which instances is being creating in which mode by calling the get # or listManagedInstances API. # Corresponds to the JSON property `noCreationRetries` # @return [Boolean] attr_accessor :no_creation_retries alias_method :no_creation_retries?, :no_creation_retries # The number of running instances that the managed instance group should # maintain at any given time. The group automatically adds or removes instances # to maintain the number of instances specified by this parameter. # Corresponds to the JSON property `targetSize` # @return [Fixnum] attr_accessor :target_size def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @no_creation_retries = args[:no_creation_retries] if args.key?(:no_creation_retries) @target_size = args[:target_size] if args.key?(:target_size) end end # class InstanceGroupManagersScopedList include Google::Apis::Core::Hashable # [Output Only] The list of managed instance groups that are contained in the # specified project and zone. # Corresponds to the JSON property `instanceGroupManagers` # @return [Array] attr_accessor :instance_group_managers # [Output Only] The warning that replaces the list of managed instance groups # when the list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::InstanceGroupManagersScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance_group_managers = args[:instance_group_managers] if args.key?(:instance_group_managers) @warning = args[:warning] if args.key?(:warning) end # [Output Only] The warning that replaces the list of managed instance groups # when the list is empty. 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 # class InstanceGroupManagersSetAutoHealingRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `autoHealingPolicies` # @return [Array] attr_accessor :auto_healing_policies def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_healing_policies = args[:auto_healing_policies] if args.key?(:auto_healing_policies) end end # class InstanceGroupManagersSetInstanceTemplateRequest include Google::Apis::Core::Hashable # The URL of the instance template that is specified for this managed instance # group. The group uses this template to create all new instances in the managed # instance group. # Corresponds to the JSON property `instanceTemplate` # @return [String] attr_accessor :instance_template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance_template = args[:instance_template] if args.key?(:instance_template) end end # class InstanceGroupManagersSetTargetPoolsRequest include Google::Apis::Core::Hashable # The fingerprint of the target pools information. Use this optional property to # prevent conflicts when multiple users change the target pools settings # concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. # Then, include the fingerprint in your request to ensure that you do not # overwrite changes that were applied from another concurrent request. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # The list of target pool URLs that instances in this managed instance group # belong to. The managed instance group applies these target pools to all of the # instances in the group. Existing instances and new instances in the group all # receive these target pool settings. # Corresponds to the JSON property `targetPools` # @return [Array] attr_accessor :target_pools def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @target_pools = args[:target_pools] if args.key?(:target_pools) end end # InstanceGroupManagers.updatePerInstanceConfigs class InstanceGroupManagersUpdatePerInstanceConfigsReq include Google::Apis::Core::Hashable # The list of per-instance configs to insert or patch on this managed instance # group. # Corresponds to the JSON property `perInstanceConfigs` # @return [Array] attr_accessor :per_instance_configs def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @per_instance_configs = args[:per_instance_configs] if args.key?(:per_instance_configs) end end # class InstanceGroupsAddInstancesRequest include Google::Apis::Core::Hashable # The list of instances to add to the instance group. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class InstanceGroupsListInstances 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 InstanceWithNamedPorts resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] The resource type, which is always compute# # instanceGroupsListInstances for the list of instances in the specified # instance group. # 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::InstanceGroupsListInstances::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 # class InstanceGroupsListInstancesRequest include Google::Apis::Core::Hashable # A filter for the state of the instances in the instance group. Valid options # are ALL or RUNNING. If you do not specify this parameter the list includes all # instances regardless of their state. # Corresponds to the JSON property `instanceState` # @return [String] attr_accessor :instance_state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance_state = args[:instance_state] if args.key?(:instance_state) end end # class InstanceGroupsRemoveInstancesRequest include Google::Apis::Core::Hashable # The list of instances to remove from the instance group. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class InstanceGroupsScopedList include Google::Apis::Core::Hashable # [Output Only] The list of instance groups that are contained in this scope. # Corresponds to the JSON property `instanceGroups` # @return [Array] attr_accessor :instance_groups # [Output Only] An informational warning that replaces the list of instance # groups when the list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::InstanceGroupsScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance_groups = args[:instance_groups] if args.key?(:instance_groups) @warning = args[:warning] if args.key?(:warning) end # [Output Only] An informational warning that replaces the list of instance # groups when the list is empty. 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 # class InstanceGroupsSetNamedPortsRequest include Google::Apis::Core::Hashable # The fingerprint of the named ports information for this instance group. Use # this optional property to prevent conflicts when multiple users change the # named ports settings concurrently. Obtain the fingerprint with the # instanceGroups.get method. Then, include the fingerprint in your request to # ensure that you do not overwrite changes that were applied from another # concurrent request. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # The list of named ports to set for this instance group. # Corresponds to the JSON property `namedPorts` # @return [Array] attr_accessor :named_ports def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @named_ports = args[:named_ports] if args.key?(:named_ports) end end # Contains a list of instances. class InstanceList 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 Instance resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#instanceList for lists of # Instance resources. # 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::InstanceList::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 # Contains a list of instance referrers. class InstanceListReferrers 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 Reference resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#instanceListReferrers for lists # of Instance referrers. # 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::InstanceListReferrers::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 # class InstanceMoveRequest include Google::Apis::Core::Hashable # The URL of the destination zone to move the instance. This can be a full or # partial URL. For example, the following are all valid URLs to a zone: # - https://www.googleapis.com/compute/v1/projects/project/zones/zone # - projects/project/zones/zone # - zones/zone # Corresponds to the JSON property `destinationZone` # @return [String] attr_accessor :destination_zone # The URL of the target instance to move. This can be a full or partial URL. For # example, the following are all valid URLs to an instance: # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ # instance # - projects/project/zones/zone/instances/instance # - zones/zone/instances/instance # Corresponds to the JSON property `targetInstance` # @return [String] attr_accessor :target_instance def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @destination_zone = args[:destination_zone] if args.key?(:destination_zone) @target_instance = args[:target_instance] if args.key?(:target_instance) end end # class InstanceProperties include Google::Apis::Core::Hashable # Enables instances created based on this template to send packets with source # IP addresses other than their own and receive packets with destination IP # addresses other than their own. If these instances will be used as an IP # gateway or it will be set as the next-hop in a Route resource, specify true. # If unsure, leave this set to false. See the Enable IP forwarding documentation # for more information. # Corresponds to the JSON property `canIpForward` # @return [Boolean] attr_accessor :can_ip_forward alias_method :can_ip_forward?, :can_ip_forward # An optional text description for the instances that are created from this # instance template. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # An array of disks that are associated with the instances that are created from # this template. # Corresponds to the JSON property `disks` # @return [Array] attr_accessor :disks # A list of guest accelerator cards' type and count to use for instances created # from the instance template. # Corresponds to the JSON property `guestAccelerators` # @return [Array] attr_accessor :guest_accelerators # Labels to apply to instances that are created from this template. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The machine type to use for instances that are created from this template. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type # A metadata key/value entry. # Corresponds to the JSON property `metadata` # @return [Google::Apis::ComputeAlpha::Metadata] attr_accessor :metadata # Minimum cpu/platform to be used by this instance. The instance may be # scheduled on the specified or newer cpu/platform. Applicable values are the # friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or # minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a # Minimum CPU Platform. # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform # An array of network access configurations for this interface. # Corresponds to the JSON property `networkInterfaces` # @return [Array] attr_accessor :network_interfaces # Sets the scheduling options for an Instance. # Corresponds to the JSON property `scheduling` # @return [Google::Apis::ComputeAlpha::Scheduling] attr_accessor :scheduling # A list of service accounts with specified scopes. Access tokens for these # service accounts are available to the instances that are created from this # template. Use metadata queries to obtain the access tokens for these instances. # Corresponds to the JSON property `serviceAccounts` # @return [Array] attr_accessor :service_accounts # A set of Shielded VM options. # Corresponds to the JSON property `shieldedVmConfig` # @return [Google::Apis::ComputeAlpha::ShieldedVmConfig] attr_accessor :shielded_vm_config # A set of instance tags. # Corresponds to the JSON property `tags` # @return [Google::Apis::ComputeAlpha::Tags] attr_accessor :tags def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @can_ip_forward = args[:can_ip_forward] if args.key?(:can_ip_forward) @description = args[:description] if args.key?(:description) @disks = args[:disks] if args.key?(:disks) @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators) @labels = args[:labels] if args.key?(:labels) @machine_type = args[:machine_type] if args.key?(:machine_type) @metadata = args[:metadata] if args.key?(:metadata) @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces) @scheduling = args[:scheduling] if args.key?(:scheduling) @service_accounts = args[:service_accounts] if args.key?(:service_accounts) @shielded_vm_config = args[:shielded_vm_config] if args.key?(:shielded_vm_config) @tags = args[:tags] if args.key?(:tags) end end # class InstanceReference include Google::Apis::Core::Hashable # The URL for a specific instance. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance = args[:instance] if args.key?(:instance) end end # An Instance Template resource. (== resource_for beta.instanceTemplates ==) (== # resource_for v1.instanceTemplates ==) class InstanceTemplate include Google::Apis::Core::Hashable # [Output Only] The creation timestamp for this instance template 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] A unique identifier for this instance template. The server # defines this identifier. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The resource type, which is always compute#instanceTemplate for # instance templates. # 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 # # Corresponds to the JSON property `properties` # @return [Google::Apis::ComputeAlpha::InstanceProperties] attr_accessor :properties # [Output Only] The URL for this instance template. The server defines this URL. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The source instance used to create the template. You can provide this as a # partial or full URL to the resource. For example, the following are valid # values: # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ # instance # - projects/project/zones/zone/instances/instance # Corresponds to the JSON property `sourceInstance` # @return [String] attr_accessor :source_instance # A specification of the parameters to use when creating the instance template # from a source instance. # Corresponds to the JSON property `sourceInstanceParams` # @return [Google::Apis::ComputeAlpha::SourceInstanceParams] attr_accessor :source_instance_params def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @properties = args[:properties] if args.key?(:properties) @self_link = args[:self_link] if args.key?(:self_link) @source_instance = args[:source_instance] if args.key?(:source_instance) @source_instance_params = args[:source_instance_params] if args.key?(:source_instance_params) end end # A list of instance templates. class InstanceTemplateList 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 InstanceTemplate resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] The resource type, which is always compute# # instanceTemplatesListResponse for instance template lists. # 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::InstanceTemplateList::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 # class InstanceWithNamedPorts include Google::Apis::Core::Hashable # [Output Only] The URL of the instance. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # [Output Only] The named ports that belong to this instance group. # Corresponds to the JSON property `namedPorts` # @return [Array] attr_accessor :named_ports # [Output Only] The status of the instance. # 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) @instance = args[:instance] if args.key?(:instance) @named_ports = args[:named_ports] if args.key?(:named_ports) @status = args[:status] if args.key?(:status) end end # class InstancesAddMaintenancePoliciesRequest include Google::Apis::Core::Hashable # Maintenance policies to be added to this instance. # Corresponds to the JSON property `maintenancePolicies` # @return [Array] attr_accessor :maintenance_policies def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @maintenance_policies = args[:maintenance_policies] if args.key?(:maintenance_policies) end end # class InstancesRemoveMaintenancePoliciesRequest include Google::Apis::Core::Hashable # Maintenance policies to be removed from this instance. # Corresponds to the JSON property `maintenancePolicies` # @return [Array] attr_accessor :maintenance_policies def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @maintenance_policies = args[:maintenance_policies] if args.key?(:maintenance_policies) end end # class InstancesResumeRequest include Google::Apis::Core::Hashable # Array of disks associated with this instance that are protected with a # customer-supplied encryption key. # In order to resume the instance, the disk url and its corresponding key must # be provided. # If the disk is not protected with a customer-supplied encryption key it should # not be specified. # Corresponds to the JSON property `disks` # @return [Array] attr_accessor :disks # Represents a customer-supplied encryption key # Corresponds to the JSON property `instanceEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :instance_encryption_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disks = args[:disks] if args.key?(:disks) @instance_encryption_key = args[:instance_encryption_key] if args.key?(:instance_encryption_key) end end # class InstancesScopedList include Google::Apis::Core::Hashable # [Output Only] List of instances contained in this scope. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances # [Output Only] Informational warning which replaces the list of instances when # the list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::InstancesScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) @warning = args[:warning] if args.key?(:warning) end # [Output Only] Informational warning which replaces the list of instances when # the list is empty. 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 # class InstancesSetLabelsRequest include Google::Apis::Core::Hashable # Fingerprint of the previous set of labels for this resource, used to prevent # conflicts. Provide the latest fingerprint value when making a request to add # or change labels. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :label_fingerprint # # 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) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) end end # class InstancesSetMachineResourcesRequest include Google::Apis::Core::Hashable # List of the type and count of accelerator cards attached to the instance. # Corresponds to the JSON property `guestAccelerators` # @return [Array] attr_accessor :guest_accelerators def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators) end end # class InstancesSetMachineTypeRequest include Google::Apis::Core::Hashable # Full or partial URL of the machine type resource. See Machine Types for a full # list of machine types. For example: zones/us-central1-f/machineTypes/n1- # standard-1 # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @machine_type = args[:machine_type] if args.key?(:machine_type) end end # class InstancesSetMinCpuPlatformRequest include Google::Apis::Core::Hashable # Minimum cpu/platform this instance should be started at. # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) end end # class InstancesSetServiceAccountRequest include Google::Apis::Core::Hashable # Email address of the service account. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The list of scopes to be made available for this service account. # 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) @email = args[:email] if args.key?(:email) @scopes = args[:scopes] if args.key?(:scopes) end end # class InstancesStartWithEncryptionKeyRequest include Google::Apis::Core::Hashable # Array of disks associated with this instance that are protected with a # customer-supplied encryption key. # In order to start the instance, the disk url and its corresponding key must be # provided. # If the disk is not protected with a customer-supplied encryption key it should # not be specified. # Corresponds to the JSON property `disks` # @return [Array] attr_accessor :disks # Represents a customer-supplied encryption key # Corresponds to the JSON property `instanceEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :instance_encryption_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disks = args[:disks] if args.key?(:disks) @instance_encryption_key = args[:instance_encryption_key] if args.key?(:instance_encryption_key) end end # Represents an Interconnects resource. The Interconnects resource is a # dedicated connection between Google's network and your on-premises network. # For more information, see the Dedicated overview page. (== resource_for v1. # interconnects ==) (== resource_for beta.interconnects ==) class Interconnect include Google::Apis::Core::Hashable # Administrative status of the interconnect. When this is set to true, the # Interconnect is functional and can carry traffic. When set to false, no # packets can be carried over the interconnect and no BGP routes are exchanged # over it. By default, the status is set to true. # Corresponds to the JSON property `adminEnabled` # @return [Boolean] attr_accessor :admin_enabled alias_method :admin_enabled?, :admin_enabled # [Output Only] List of CircuitInfo objects, that describe the individual # circuits in this LAG. # Corresponds to the JSON property `circuitInfos` # @return [Array] attr_accessor :circuit_infos # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # Customer name, to put in the Letter of Authorization as the party authorized # to request a crossconnect. # Corresponds to the JSON property `customerName` # @return [String] attr_accessor :customer_name # 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] List of outages expected for this Interconnect. # Corresponds to the JSON property `expectedOutages` # @return [Array] attr_accessor :expected_outages # [Output Only] IP address configured on the Google side of the Interconnect # link. This can be used only for ping tests. # Corresponds to the JSON property `googleIpAddress` # @return [String] attr_accessor :google_ip_address # [Output Only] Google reference ID; to be used when raising support tickets # with Google or otherwise to debug backend connectivity issues. # Corresponds to the JSON property `googleReferenceId` # @return [String] attr_accessor :google_reference_id # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] A list of the URLs of all InterconnectAttachments configured to # use this Interconnect. # Corresponds to the JSON property `interconnectAttachments` # @return [Array] attr_accessor :interconnect_attachments # Type of interconnect. Note that "IT_PRIVATE" has been deprecated in favor of " # DEDICATED" # Corresponds to the JSON property `interconnectType` # @return [String] attr_accessor :interconnect_type # [Output Only] Type of the resource. Always compute#interconnect for # interconnects. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for the labels being applied to this Interconnect, which is # essentially a hash of the labels set used for optimistic locking. The # fingerprint is initially generated by Compute Engine and changes after every # request to modify or update labels. You must always provide an up-to-date # fingerprint hash in order to update or change labels. # To see the latest fingerprint, make a get() request to retrieve an # Interconnect. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Type of link requested. This field indicates speed of each of the links in the # bundle, not the entire bundle. Only 10G per link is allowed for a dedicated # interconnect. Options: Ethernet_10G_LR # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type # URL of the InterconnectLocation object that represents where this connection # is to be provisioned. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # 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 # Email address to contact the customer NOC for operations and maintenance # notifications regarding this Interconnect. If specified, this will be used for # notifications in addition to all other forms described, such as Stackdriver # logs alerting and Cloud Notifications. # Corresponds to the JSON property `nocContactEmail` # @return [String] attr_accessor :noc_contact_email # [Output Only] The current status of whether or not this Interconnect is # functional. # Corresponds to the JSON property `operationalStatus` # @return [String] attr_accessor :operational_status # [Output Only] IP address configured on the customer side of the Interconnect # link. The customer should configure this IP address during turnup when # prompted by Google NOC. This can be used only for ping tests. # Corresponds to the JSON property `peerIpAddress` # @return [String] attr_accessor :peer_ip_address # [Output Only] Number of links actually provisioned in this interconnect. # Corresponds to the JSON property `provisionedLinkCount` # @return [Fixnum] attr_accessor :provisioned_link_count # Target number of physical links in the link bundle, as requested by the # customer. # Corresponds to the JSON property `requestedLinkCount` # @return [Fixnum] attr_accessor :requested_link_count # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] The current state of whether or not this Interconnect is # functional. # 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) @admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled) @circuit_infos = args[:circuit_infos] if args.key?(:circuit_infos) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @customer_name = args[:customer_name] if args.key?(:customer_name) @description = args[:description] if args.key?(:description) @expected_outages = args[:expected_outages] if args.key?(:expected_outages) @google_ip_address = args[:google_ip_address] if args.key?(:google_ip_address) @google_reference_id = args[:google_reference_id] if args.key?(:google_reference_id) @id = args[:id] if args.key?(:id) @interconnect_attachments = args[:interconnect_attachments] if args.key?(:interconnect_attachments) @interconnect_type = args[:interconnect_type] if args.key?(:interconnect_type) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @link_type = args[:link_type] if args.key?(:link_type) @location = args[:location] if args.key?(:location) @name = args[:name] if args.key?(:name) @noc_contact_email = args[:noc_contact_email] if args.key?(:noc_contact_email) @operational_status = args[:operational_status] if args.key?(:operational_status) @peer_ip_address = args[:peer_ip_address] if args.key?(:peer_ip_address) @provisioned_link_count = args[:provisioned_link_count] if args.key?(:provisioned_link_count) @requested_link_count = args[:requested_link_count] if args.key?(:requested_link_count) @self_link = args[:self_link] if args.key?(:self_link) @state = args[:state] if args.key?(:state) end end # Represents an InterconnectAttachment (VLAN attachment) resource. For more # information, see Creating VLAN Attachments. (== resource_for beta. # interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) class InterconnectAttachment include Google::Apis::Core::Hashable # Determines whether this Attachment will carry packets. Not present for # PARTNER_PROVIDER. # Corresponds to the JSON property `adminEnabled` # @return [Boolean] attr_accessor :admin_enabled alias_method :admin_enabled?, :admin_enabled # # Corresponds to the JSON property `availabilityZone` # @return [String] attr_accessor :availability_zone # # Corresponds to the JSON property `bandwidth` # @return [String] attr_accessor :bandwidth # Up to 16 candidate prefixes that can be used to restrict the allocation of # cloudRouterIpAddress and customerRouterIpAddress for this attachment. All # prefixes must be within link-local address space (169.254.0.0/16) and must be / # 29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 # from the supplied candidate prefix(es). The request will fail if all possible / # 29s are in use on Google?s edge. If not supplied, Google will randomly select # an unused /29 from all of link-local space. # Corresponds to the JSON property `candidateSubnets` # @return [Array] attr_accessor :candidate_subnets # [Output Only] IPv4 address + prefix length to be configured on Cloud Router # Interface for this interconnect attachment. # Corresponds to the JSON property `cloudRouterIpAddress` # @return [String] attr_accessor :cloud_router_ip_address # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] IPv4 address + prefix length to be configured on the customer # router subinterface for this interconnect attachment. # Corresponds to the JSON property `customerRouterIpAddress` # @return [String] attr_accessor :customer_router_ip_address # An optional description of this resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Desired availability domain for the attachment. Can only be specified when # creating PARTNER-type InterconnectAttachments. # For improved reliability, customers should configure a pair of attachments # with one per availability domain. The selected availability domain will be # provided to the Partner via the pairing key so that the provisioned circuit # will lie in the specified domain. If not specified, the value will default to # AVAILABILITY_DOMAIN_ANY. # Corresponds to the JSON property `edgeAvailabilityDomain` # @return [String] attr_accessor :edge_availability_domain # [Output Only] Google reference ID, to be used when raising support tickets # with Google or otherwise to debug backend connectivity issues. # Corresponds to the JSON property `googleReferenceId` # @return [String] attr_accessor :google_reference_id # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # URL of the underlying Interconnect object that this attachment's traffic will # traverse through. # Corresponds to the JSON property `interconnect` # @return [String] attr_accessor :interconnect # [Output Only] Type of the resource. Always compute#interconnectAttachment for # interconnect attachments. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for the labels being applied to this InterconnectAttachment, # which is essentially a hash of the labels set used for optimistic locking. The # fingerprint is initially generated by Compute Engine and changes after every # request to modify or update labels. You must always provide an up-to-date # fingerprint hash in order to update or change labels. # To see the latest fingerprint, make a get() request to retrieve an # InterconnectAttachment. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # 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 # [Output Only] The current status of whether or not this interconnect # attachment is functional. # Corresponds to the JSON property `operationalStatus` # @return [String] attr_accessor :operational_status # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present # for DEDICATED]. Opaque string identifying an PARTNER attachment. Of the form ? # cloud-region/XXXXXX?. # Corresponds to the JSON property `pairingKey` # @return [String] attr_accessor :pairing_key # [Output only for PARTNER. Input for PARTNER_PROVIDER. Not present for # DEDICATED] BGP ASN of the Partner. A layer 3 Partner should supply this if # they configured BGP on behalf of the customer. # Corresponds to the JSON property `partnerAsn` # @return [Fixnum] attr_accessor :partner_asn # Informational metadata about Partner attachments from Partners to display to # customers. These fields are propagated from PARTNER_PROVIDER attachments to # their corresponding PARTNER attachments. Only mutable for PARTNER_PROVIDER # type, output-only for PARTNER, not available for DEDICATED. # Corresponds to the JSON property `partnerMetadata` # @return [Google::Apis::ComputeAlpha::InterconnectAttachmentPartnerMetadata] attr_accessor :partner_metadata # Information for an interconnect attachment when this belongs to an # interconnect of type DEDICATED. # Corresponds to the JSON property `privateInterconnectInfo` # @return [Google::Apis::ComputeAlpha::InterconnectAttachmentPrivateInfo] attr_accessor :private_interconnect_info # [Output Only] URL of the region where the regional interconnect attachment # resides. 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 # URL of the cloud router to be used for dynamic routing. This router must be in # the same region as this InterconnectAttachment. The InterconnectAttachment # will automatically connect the Interconnect to the network & region within # which the Cloud Router is configured. # Corresponds to the JSON property `router` # @return [String] attr_accessor :router # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] The current state of whether or not this interconnect attachment # is functional. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Available only for DEDICATED and PARTNER_PROVIDER. Desired VLAN tag for this # attachment, in the range 2-4094. This field refers to 802.1q VLAN tag, also # known as IEEE 802.1Q Only specified at creation time. # Corresponds to the JSON property `vlanTag8021q` # @return [Fixnum] attr_accessor :vlan_tag8021q def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled) @availability_zone = args[:availability_zone] if args.key?(:availability_zone) @bandwidth = args[:bandwidth] if args.key?(:bandwidth) @candidate_subnets = args[:candidate_subnets] if args.key?(:candidate_subnets) @cloud_router_ip_address = args[:cloud_router_ip_address] if args.key?(:cloud_router_ip_address) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @customer_router_ip_address = args[:customer_router_ip_address] if args.key?(:customer_router_ip_address) @description = args[:description] if args.key?(:description) @edge_availability_domain = args[:edge_availability_domain] if args.key?(:edge_availability_domain) @google_reference_id = args[:google_reference_id] if args.key?(:google_reference_id) @id = args[:id] if args.key?(:id) @interconnect = args[:interconnect] if args.key?(:interconnect) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @operational_status = args[:operational_status] if args.key?(:operational_status) @pairing_key = args[:pairing_key] if args.key?(:pairing_key) @partner_asn = args[:partner_asn] if args.key?(:partner_asn) @partner_metadata = args[:partner_metadata] if args.key?(:partner_metadata) @private_interconnect_info = args[:private_interconnect_info] if args.key?(:private_interconnect_info) @region = args[:region] if args.key?(:region) @router = args[:router] if args.key?(:router) @self_link = args[:self_link] if args.key?(:self_link) @state = args[:state] if args.key?(:state) @type = args[:type] if args.key?(:type) @vlan_tag8021q = args[:vlan_tag8021q] if args.key?(:vlan_tag8021q) end end # class InterconnectAttachmentAggregatedList 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 InterconnectAttachmentsScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute# # interconnectAttachmentAggregatedList for aggregated lists of interconnect # 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::InterconnectAttachmentAggregatedList::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 # Response to the list request, and contains a list of interconnect attachments. class InterconnectAttachmentList 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 InterconnectAttachment resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#interconnectAttachmentList for # lists of interconnect 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::InterconnectAttachmentList::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 # Informational metadata about Partner attachments from Partners to display to # customers. These fields are propagated from PARTNER_PROVIDER attachments to # their corresponding PARTNER attachments. Only mutable for PARTNER_PROVIDER # type, output-only for PARTNER, not available for DEDICATED. class InterconnectAttachmentPartnerMetadata include Google::Apis::Core::Hashable # Plain text name of the Interconnect this attachment is connected to, as # displayed in the Partner?s portal. For instance ?Chicago 1?. This value may be # validated to match approved Partner values. # Corresponds to the JSON property `interconnectName` # @return [String] attr_accessor :interconnect_name # Plain text name of the Partner providing this attachment. This value may be # validated to match approved Partner values. # Corresponds to the JSON property `partnerName` # @return [String] attr_accessor :partner_name # URL of the Partner?s portal for this Attachment. Partners may customise this # to be a deep-link to the specific resource on the Partner portal. This value # may be validated to match approved Partner values. # Corresponds to the JSON property `portalUrl` # @return [String] attr_accessor :portal_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @interconnect_name = args[:interconnect_name] if args.key?(:interconnect_name) @partner_name = args[:partner_name] if args.key?(:partner_name) @portal_url = args[:portal_url] if args.key?(:portal_url) end end # Information for an interconnect attachment when this belongs to an # interconnect of type DEDICATED. class InterconnectAttachmentPrivateInfo include Google::Apis::Core::Hashable # [Output Only] 802.1q encapsulation tag to be used for traffic between Google # and the customer, going to and from this network and region. # Corresponds to the JSON property `tag8021q` # @return [Fixnum] attr_accessor :tag8021q def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @tag8021q = args[:tag8021q] if args.key?(:tag8021q) end end # class InterconnectAttachmentsScopedList include Google::Apis::Core::Hashable # List of interconnect attachments contained in this scope. # Corresponds to the JSON property `interconnectAttachments` # @return [Array] attr_accessor :interconnect_attachments # Informational warning which replaces the list of addresses when the list is # empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::InterconnectAttachmentsScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @interconnect_attachments = args[:interconnect_attachments] if args.key?(:interconnect_attachments) @warning = args[:warning] if args.key?(:warning) end # Informational warning which replaces the list of addresses when the list is # empty. 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 # Describes a single physical circuit between the Customer and Google. # CircuitInfo objects are created by Google, so all fields are output only. Next # id: 4 class InterconnectCircuitInfo include Google::Apis::Core::Hashable # Customer-side demarc ID for this circuit. # Corresponds to the JSON property `customerDemarcId` # @return [String] attr_accessor :customer_demarc_id # Google-assigned unique ID for this circuit. Assigned at circuit turn-up. # Corresponds to the JSON property `googleCircuitId` # @return [String] attr_accessor :google_circuit_id # Google-side demarc ID for this circuit. Assigned at circuit turn-up and # provided by Google to the customer in the LOA. # Corresponds to the JSON property `googleDemarcId` # @return [String] attr_accessor :google_demarc_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @customer_demarc_id = args[:customer_demarc_id] if args.key?(:customer_demarc_id) @google_circuit_id = args[:google_circuit_id] if args.key?(:google_circuit_id) @google_demarc_id = args[:google_demarc_id] if args.key?(:google_demarc_id) end end # Response to the list request, and contains a list of interconnects. class InterconnectList 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 Interconnect resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#interconnectList for lists of # interconnects. # 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::InterconnectList::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 # Represents an InterconnectLocations resource. The InterconnectLocations # resource describes the locations where you can connect to Google's networks. # For more information, see Colocation Facilities. class InterconnectLocation include Google::Apis::Core::Hashable # [Output Only] The postal address of the Point of Presence, each line in the # address is separated by a newline character. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # [Output Only] Availability zone for this location. Within a metropolitan area ( # metro), maintenance will not be simultaneously scheduled in more than one # availability zone. Example: "zone1" or "zone2". # Corresponds to the JSON property `availabilityZone` # @return [String] attr_accessor :availability_zone # [Output Only] Metropolitan area designator that indicates which city an # interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". # Corresponds to the JSON property `city` # @return [String] attr_accessor :city # [Output Only] Continent for this location. # Corresponds to the JSON property `continent` # @return [String] attr_accessor :continent # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] An optional description of the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The name of the provider for this facility (e.g., EQUINIX). # Corresponds to the JSON property `facilityProvider` # @return [String] attr_accessor :facility_provider # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn- # DC1). # Corresponds to the JSON property `facilityProviderFacilityId` # @return [String] attr_accessor :facility_provider_facility_id # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#interconnectLocation for # interconnect locations. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] The peeringdb identifier for this facility (corresponding with a # netfac type in peeringdb). # Corresponds to the JSON property `peeringdbFacilityId` # @return [String] attr_accessor :peeringdb_facility_id # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe # parameters pertaining to the relation between this InterconnectLocation and # various Google Cloud regions. # Corresponds to the JSON property `regionInfos` # @return [Array] attr_accessor :region_infos # [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) @address = args[:address] if args.key?(:address) @availability_zone = args[:availability_zone] if args.key?(:availability_zone) @city = args[:city] if args.key?(:city) @continent = args[:continent] if args.key?(:continent) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @facility_provider = args[:facility_provider] if args.key?(:facility_provider) @facility_provider_facility_id = args[:facility_provider_facility_id] if args.key?(:facility_provider_facility_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @peeringdb_facility_id = args[:peeringdb_facility_id] if args.key?(:peeringdb_facility_id) @region_infos = args[:region_infos] if args.key?(:region_infos) @self_link = args[:self_link] if args.key?(:self_link) end end # Response to the list request, and contains a list of interconnect locations. class InterconnectLocationList 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 InterconnectLocation resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#interconnectLocationList for # lists of interconnect locations. # 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::InterconnectLocationList::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 # Information about any potential InterconnectAttachments between an # Interconnect at a specific InterconnectLocation, and a specific Cloud Region. class InterconnectLocationRegionInfo include Google::Apis::Core::Hashable # Expected round-trip time in milliseconds, from this InterconnectLocation to a # VM in this region. # Corresponds to the JSON property `expectedRttMs` # @return [Fixnum] attr_accessor :expected_rtt_ms # Identifies the network presence of this location. # Corresponds to the JSON property `locationPresence` # @return [String] attr_accessor :location_presence # URL for the region of this location. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expected_rtt_ms = args[:expected_rtt_ms] if args.key?(:expected_rtt_ms) @location_presence = args[:location_presence] if args.key?(:location_presence) @region = args[:region] if args.key?(:region) end end # Description of a planned outage on this Interconnect. Next id: 9 class InterconnectOutageNotification include Google::Apis::Core::Hashable # Iff issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs # that will be affected. # Corresponds to the JSON property `affectedCircuits` # @return [Array] attr_accessor :affected_circuits # A description about the purpose of the outage. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Scheduled end time for the outage (milliseconds since Unix epoch). # Corresponds to the JSON property `endTime` # @return [Fixnum] attr_accessor :end_time # Form this outage is expected to take. Note that the "IT_" versions of this # enum have been deprecated in favor of the unprefixed values. # Corresponds to the JSON property `issueType` # @return [String] attr_accessor :issue_type # Unique identifier for this outage notification. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The party that generated this notification. Note that "NSRC_GOOGLE" has been # deprecated in favor of "GOOGLE" # Corresponds to the JSON property `source` # @return [String] attr_accessor :source # Scheduled start time for the outage (milliseconds since Unix epoch). # Corresponds to the JSON property `startTime` # @return [Fixnum] attr_accessor :start_time # State of this notification. Note that the "NS_" versions of this enum have # been deprecated in favor of the unprefixed values. # 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) @affected_circuits = args[:affected_circuits] if args.key?(:affected_circuits) @description = args[:description] if args.key?(:description) @end_time = args[:end_time] if args.key?(:end_time) @issue_type = args[:issue_type] if args.key?(:issue_type) @name = args[:name] if args.key?(:name) @source = args[:source] if args.key?(:source) @start_time = args[:start_time] if args.key?(:start_time) @state = args[:state] if args.key?(:state) end end # class InternalIpOwner include Google::Apis::Core::Hashable # IP CIDR range being owned. # Corresponds to the JSON property `ipCidrRange` # @return [String] attr_accessor :ip_cidr_range # URLs of the IP owners of the IP CIDR range. # Corresponds to the JSON property `owners` # @return [Array] attr_accessor :owners # Whether this IP CIDR range is reserved for system use. # Corresponds to the JSON property `systemOwned` # @return [Boolean] attr_accessor :system_owned alias_method :system_owned?, :system_owned def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range) @owners = args[:owners] if args.key?(:owners) @system_owned = args[:system_owned] if args.key?(:system_owned) end end # Contains a list of IP owners. class IpOwnerList 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 InternalIpOwner resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#ipOwnerList for lists of IP # owners. # 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::IpOwnerList::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 license resource. class License include Google::Apis::Core::Hashable # [Output Only] Deprecated. This field no longer reflects whether a license # charges a usage fee. # Corresponds to the JSON property `chargesUseFee` # @return [Boolean] attr_accessor :charges_use_fee alias_method :charges_use_fee?, :charges_use_fee # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of resource. Always compute#license for licenses. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] The unique code used to attach this license to images, snapshots, # and disks. # Corresponds to the JSON property `licenseCode` # @return [Fixnum] attr_accessor :license_code # [Output Only] Name of the resource. The name is 1-63 characters long and # complies with RFC1035. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # # Corresponds to the JSON property `resourceRequirements` # @return [Google::Apis::ComputeAlpha::LicenseResourceRequirements] attr_accessor :resource_requirements # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # If false, licenses will not be copied from the source resource when creating # an image from a disk, disk from snapshot, or snapshot from disk. # Corresponds to the JSON property `transferable` # @return [Boolean] attr_accessor :transferable alias_method :transferable?, :transferable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @charges_use_fee = args[:charges_use_fee] if args.key?(:charges_use_fee) @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) @license_code = args[:license_code] if args.key?(:license_code) @name = args[:name] if args.key?(:name) @resource_requirements = args[:resource_requirements] if args.key?(:resource_requirements) @self_link = args[:self_link] if args.key?(:self_link) @transferable = args[:transferable] if args.key?(:transferable) end end # class LicenseCode include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] Description of this License Code. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of resource. Always compute#licenseCode for licenses. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] URL and description aliases of Licenses with the same License # Code. # Corresponds to the JSON property `licenseAlias` # @return [Array] attr_accessor :license_alias # [Output Only] Name of the resource. The name is 1-20 characters long and must # be a valid 64 bit integer. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] Current state of this License Code. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # [Output Only] If true, the license will remain attached when creating images # or snapshots from disks. Otherwise, the license is not transferred. # Corresponds to the JSON property `transferable` # @return [Boolean] attr_accessor :transferable alias_method :transferable?, :transferable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @license_alias = args[:license_alias] if args.key?(:license_alias) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) @state = args[:state] if args.key?(:state) @transferable = args[:transferable] if args.key?(:transferable) end end # class LicenseCodeLicenseAlias include Google::Apis::Core::Hashable # [Output Only] Description of this License Code. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] URL of license corresponding to this License Code. # 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) @description = args[:description] if args.key?(:description) @self_link = args[:self_link] if args.key?(:self_link) end end # class LicenseResourceRequirements include Google::Apis::Core::Hashable # Minimum number of guest cpus required to use the Instance. Enforced at # Instance creation and Instance start. # Corresponds to the JSON property `minGuestCpuCount` # @return [Fixnum] attr_accessor :min_guest_cpu_count # Minimum memory required to use the Instance. Enforced at Instance creation and # Instance start. # Corresponds to the JSON property `minMemoryMb` # @return [Fixnum] attr_accessor :min_memory_mb def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @min_guest_cpu_count = args[:min_guest_cpu_count] if args.key?(:min_guest_cpu_count) @min_memory_mb = args[:min_memory_mb] if args.key?(:min_memory_mb) end end # class LicensesListResponse 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 License resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [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::LicensesListResponse::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) @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 # Specifies what kind of log the caller must write class LogConfig include Google::Apis::Core::Hashable # Write a Cloud Audit log # Corresponds to the JSON property `cloudAudit` # @return [Google::Apis::ComputeAlpha::LogConfigCloudAuditOptions] attr_accessor :cloud_audit # Increment a streamz counter with the specified metric and field names. # Metric names should start with a '/', generally be lowercase-only, and end in " # _count". Field names should not contain an initial slash. The actual exported # metric names will have "/iam/policy" prepended. # Field names correspond to IAM request parameters and field values are their # respective values. # At present the only supported field names are - "iam_principal", corresponding # to IAMContext.principal; - "" (empty string), resulting in one aggretated # counter with no field. # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/backend_debug_access_count `iam_principal=[value # of IAMContext.principal]` # At this time we do not support: * multiple field names (though this may be # supported in the future) * decrementing the counter * incrementing it by # anything other than 1 # Corresponds to the JSON property `counter` # @return [Google::Apis::ComputeAlpha::LogConfigCounterOptions] attr_accessor :counter # Write a Data Access (Gin) log # Corresponds to the JSON property `dataAccess` # @return [Google::Apis::ComputeAlpha::LogConfigDataAccessOptions] attr_accessor :data_access def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cloud_audit = args[:cloud_audit] if args.key?(:cloud_audit) @counter = args[:counter] if args.key?(:counter) @data_access = args[:data_access] if args.key?(:data_access) end end # Write a Cloud Audit log class LogConfigCloudAuditOptions include Google::Apis::Core::Hashable # Authorization-related information used by Cloud Audit Logging. # Corresponds to the JSON property `authorizationLoggingOptions` # @return [Google::Apis::ComputeAlpha::AuthorizationLoggingOptions] attr_accessor :authorization_logging_options # The log_name to populate in the Cloud Audit Record. # Corresponds to the JSON property `logName` # @return [String] attr_accessor :log_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @authorization_logging_options = args[:authorization_logging_options] if args.key?(:authorization_logging_options) @log_name = args[:log_name] if args.key?(:log_name) end end # Increment a streamz counter with the specified metric and field names. # Metric names should start with a '/', generally be lowercase-only, and end in " # _count". Field names should not contain an initial slash. The actual exported # metric names will have "/iam/policy" prepended. # Field names correspond to IAM request parameters and field values are their # respective values. # At present the only supported field names are - "iam_principal", corresponding # to IAMContext.principal; - "" (empty string), resulting in one aggretated # counter with no field. # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/backend_debug_access_count `iam_principal=[value # of IAMContext.principal]` # At this time we do not support: * multiple field names (though this may be # supported in the future) * decrementing the counter * incrementing it by # anything other than 1 class LogConfigCounterOptions include Google::Apis::Core::Hashable # The field value to attribute. # Corresponds to the JSON property `field` # @return [String] attr_accessor :field # The metric to update. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) @metric = args[:metric] if args.key?(:metric) end end # Write a Data Access (Gin) log class LogConfigDataAccessOptions include Google::Apis::Core::Hashable # Whether Gin logging should happen in a fail-closed manner at the caller. This # is relevant only in the LocalIAM implementation, for now. # Corresponds to the JSON property `logMode` # @return [String] attr_accessor :log_mode def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @log_mode = args[:log_mode] if args.key?(:log_mode) end end # A Machine Type resource. (== resource_for v1.machineTypes ==) (== resource_for # beta.machineTypes ==) class MachineType include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # Deprecation status for a public resource. # Corresponds to the JSON property `deprecated` # @return [Google::Apis::ComputeAlpha::DeprecationStatus] attr_accessor :deprecated # [Output Only] An optional textual description of the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The number of virtual CPUs that are available to the instance. # Corresponds to the JSON property `guestCpus` # @return [Fixnum] attr_accessor :guest_cpus # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Whether this machine type has a shared CPU. See Shared-core # machine types for more information. # Corresponds to the JSON property `isSharedCpu` # @return [Boolean] attr_accessor :is_shared_cpu alias_method :is_shared_cpu?, :is_shared_cpu # [Output Only] The type of the resource. Always compute#machineType for machine # types. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Maximum persistent disks allowed. # Corresponds to the JSON property `maximumPersistentDisks` # @return [Fixnum] attr_accessor :maximum_persistent_disks # [Output Only] Maximum total persistent disks size (GB) allowed. # Corresponds to the JSON property `maximumPersistentDisksSizeGb` # @return [Fixnum] attr_accessor :maximum_persistent_disks_size_gb # [Output Only] The amount of physical memory available to the instance, defined # in MB. # Corresponds to the JSON property `memoryMb` # @return [Fixnum] attr_accessor :memory_mb # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] The name of the zone where the machine type resides, such as us- # central1-a. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @deprecated = args[:deprecated] if args.key?(:deprecated) @description = args[:description] if args.key?(:description) @guest_cpus = args[:guest_cpus] if args.key?(:guest_cpus) @id = args[:id] if args.key?(:id) @is_shared_cpu = args[:is_shared_cpu] if args.key?(:is_shared_cpu) @kind = args[:kind] if args.key?(:kind) @maximum_persistent_disks = args[:maximum_persistent_disks] if args.key?(:maximum_persistent_disks) @maximum_persistent_disks_size_gb = args[:maximum_persistent_disks_size_gb] if args.key?(:maximum_persistent_disks_size_gb) @memory_mb = args[:memory_mb] if args.key?(:memory_mb) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) @zone = args[:zone] if args.key?(:zone) end end # class MachineTypeAggregatedList 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 MachineTypesScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#machineTypeAggregatedList for # aggregated lists of machine types. # 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::MachineTypeAggregatedList::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 # Contains a list of machine types. class MachineTypeList 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 MachineType resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#machineTypeList for lists of # machine types. # 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::MachineTypeList::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 # class MachineTypesScopedList include Google::Apis::Core::Hashable # [Output Only] List of machine types contained in this scope. # Corresponds to the JSON property `machineTypes` # @return [Array] attr_accessor :machine_types # [Output Only] An informational warning that appears when the machine types # list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::MachineTypesScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @machine_types = args[:machine_types] if args.key?(:machine_types) @warning = args[:warning] if args.key?(:warning) end # [Output Only] An informational warning that appears when the machine types # list is empty. 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 # class MaintenancePoliciesList include Google::Apis::Core::Hashable # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # [Output Only] A list of MaintenancePolicy resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource.Always compute#maintenancePoliciesList for # listsof maintenancePolicies # 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::MaintenancePoliciesList::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 # class MaintenancePoliciesScopedList include Google::Apis::Core::Hashable # List of maintenancePolicies contained in this scope. # Corresponds to the JSON property `maintenancePolicies` # @return [Array] attr_accessor :maintenance_policies # Informational warning which replaces the list of maintenancePolicies when the # list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::MaintenancePoliciesScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @maintenance_policies = args[:maintenance_policies] if args.key?(:maintenance_policies) @warning = args[:warning] if args.key?(:warning) end # Informational warning which replaces the list of maintenancePolicies when the # list is empty. 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 maintenance policy for an instance. This specifies what kind of maintenance # operations our infrastructure may perform on this instance and when. class MaintenancePolicy include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#maintenance_policies for # maintenance policies. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the resource, provided by the client when initially creating the # resource. The resource 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 # # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # [Output Only] Server-defined fully-qualified URL for this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # A Vm Maintenance Policy specifies what kind of infrastructure maintenance we # are allowed to perform on this VM and when. # Corresponds to the JSON property `vmMaintenancePolicy` # @return [Google::Apis::ComputeAlpha::VmMaintenancePolicy] attr_accessor :vm_maintenance_policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @vm_maintenance_policy = args[:vm_maintenance_policy] if args.key?(:vm_maintenance_policy) end end # Contains a list of maintenancePolicies. class MaintenancePolicyAggregatedList 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 MaintenancePolicy resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # Type of resource. # 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::MaintenancePolicyAggregatedList::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 maintenance window for VMs and disks. When set, we restrict our maintenance # operations to this window. class MaintenanceWindow include Google::Apis::Core::Hashable # Time window specified for daily maintenance operations. # Corresponds to the JSON property `dailyMaintenanceWindow` # @return [Google::Apis::ComputeAlpha::DailyMaintenanceWindow] attr_accessor :daily_maintenance_window # Time window specified for hourly maintenance operations. # Corresponds to the JSON property `hourlyMaintenanceWindow` # @return [Google::Apis::ComputeAlpha::HourlyMaintenanceWindow] attr_accessor :hourly_maintenance_window def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @daily_maintenance_window = args[:daily_maintenance_window] if args.key?(:daily_maintenance_window) @hourly_maintenance_window = args[:hourly_maintenance_window] if args.key?(:hourly_maintenance_window) end end # class ManagedInstance include Google::Apis::Core::Hashable # [Output Only] The current action that the managed instance group has scheduled # for the instance. Possible values: # - NONE The instance is running, and the managed instance group does not have # any scheduled actions for this instance. # - CREATING The managed instance group is creating this instance. If the group # fails to create this instance, it will try again until it is successful. # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create # this instance only once. If the group fails to create this instance, it does # not try again and the group's targetSize value is decreased instead. # - RECREATING The managed instance group is recreating this instance. # - DELETING The managed instance group is permanently deleting this instance. # - ABANDONING The managed instance group is abandoning this instance. The # instance will be removed from the instance group and from any target pools # that are associated with this group. # - RESTARTING The managed instance group is restarting the instance. # - REFRESHING The managed instance group is applying configuration changes to # the instance without stopping it. For example, the group can update the target # pool list for an instance without stopping that instance. # - VERIFYING The managed instance group has created the instance and it is in # the process of being verified. # Corresponds to the JSON property `currentAction` # @return [String] attr_accessor :current_action # [Output only] The unique identifier for this resource. This field is empty # when instance does not exist. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The URL of the instance. The URL can exist even if the instance # has not yet been created. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # [Output Only] The status of the instance. This field is empty when the # instance does not exist. # Corresponds to the JSON property `instanceStatus` # @return [String] attr_accessor :instance_status # [Output Only] The intended template of the instance. This field is empty when # current_action is one of ` DELETING, ABANDONING `. # Corresponds to the JSON property `instanceTemplate` # @return [String] attr_accessor :instance_template # [Output Only] Information about the last attempt to create or delete the # instance. # Corresponds to the JSON property `lastAttempt` # @return [Google::Apis::ComputeAlpha::ManagedInstanceLastAttempt] attr_accessor :last_attempt # Overrides of stateful properties for a given instance # Corresponds to the JSON property `override` # @return [Google::Apis::ComputeAlpha::ManagedInstanceOverride] attr_accessor :override # [Output Only] Standby mode of the instance. This field is non-empty iff the # instance is a standby. # Corresponds to the JSON property `standbyMode` # @return [String] attr_accessor :standby_mode # [Output Only] Tag describing the version. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag # [Output Only] Intended version of this instance. # Corresponds to the JSON property `version` # @return [Google::Apis::ComputeAlpha::ManagedInstanceVersion] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_action = args[:current_action] if args.key?(:current_action) @id = args[:id] if args.key?(:id) @instance = args[:instance] if args.key?(:instance) @instance_status = args[:instance_status] if args.key?(:instance_status) @instance_template = args[:instance_template] if args.key?(:instance_template) @last_attempt = args[:last_attempt] if args.key?(:last_attempt) @override = args[:override] if args.key?(:override) @standby_mode = args[:standby_mode] if args.key?(:standby_mode) @tag = args[:tag] if args.key?(:tag) @version = args[:version] if args.key?(:version) end end # class ManagedInstanceLastAttempt include Google::Apis::Core::Hashable # [Output Only] Encountered errors during the last attempt to create or delete # the instance. # Corresponds to the JSON property `errors` # @return [Google::Apis::ComputeAlpha::ManagedInstanceLastAttempt::Errors] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # [Output Only] Encountered errors during the last attempt to create or delete # the instance. class Errors include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end end # Overrides of stateful properties for a given instance class ManagedInstanceOverride include Google::Apis::Core::Hashable # Disk overrides defined for this instance. According to documentation the # maximum number of disks attached to an instance is 128: https://cloud.google. # com/compute/docs/disks/ However, compute API defines the limit at 140, so this # is what we check. # Corresponds to the JSON property `disks` # @return [Array] attr_accessor :disks # Metadata overrides defined for this instance. TODO(b/69785416) validate the # total length is <9 KB # Corresponds to the JSON property `metadata` # @return [Array] attr_accessor :metadata # [Output Only] Indicates where does the override come from. # Corresponds to the JSON property `origin` # @return [String] attr_accessor :origin def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disks = args[:disks] if args.key?(:disks) @metadata = args[:metadata] if args.key?(:metadata) @origin = args[:origin] if args.key?(:origin) end # class Metadatum include Google::Apis::Core::Hashable # Key for the metadata entry. Keys must conform to the following regexp: [a-zA- # Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a # URL in the metadata server. Additionally, to avoid ambiguity, keys must not # conflict with any other metadata keys for the project. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # Value for the metadata entry. These are free-form strings, and only have # meaning as interpreted by the image running in the instance. The only # restriction placed on values is that their size must be less than or equal to # 262144 bytes (256 KiB). # 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 # class ManagedInstanceOverrideDiskOverride include Google::Apis::Core::Hashable # The name of the device on the VM # Corresponds to the JSON property `deviceName` # @return [String] attr_accessor :device_name # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not # specified, the default is to attach the disk in READ_WRITE mode. # Corresponds to the JSON property `mode` # @return [String] attr_accessor :mode # The disk that is/will be mounted # 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) @device_name = args[:device_name] if args.key?(:device_name) @mode = args[:mode] if args.key?(:mode) @source = args[:source] if args.key?(:source) end end # class ManagedInstanceVersion include Google::Apis::Core::Hashable # [Output Only] The intended template of the instance. This field is empty when # current_action is one of ` DELETING, ABANDONING `. # Corresponds to the JSON property `instanceTemplate` # @return [String] attr_accessor :instance_template # [Output Only] Name of the version. # 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) @instance_template = args[:instance_template] if args.key?(:instance_template) @name = args[:name] if args.key?(:name) end end # A metadata key/value entry. class Metadata include Google::Apis::Core::Hashable # Specifies a fingerprint for this request, which is essentially a hash of the # metadata's contents and used for optimistic locking. The fingerprint is # initially generated by Compute Engine and changes after every request to # modify or update metadata. You must always provide an up-to-date fingerprint # hash in order to update or change metadata. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # Array of key/value pairs. The total size of all keys and values must be less # than 512 KB. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of the resource. Always compute#metadata for metadata. # 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) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end # class Item include Google::Apis::Core::Hashable # Key for the metadata entry. Keys must conform to the following regexp: [a-zA- # Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a # URL in the metadata server. Additionally, to avoid ambiguity, keys must not # conflict with any other metadata keys for the project. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # Value for the metadata entry. These are free-form strings, and only have # meaning as interpreted by the image running in the instance. The only # restriction placed on values is that their size must be less than or equal to # 262144 bytes (256 KiB). # 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 # The named port. For example: . class NamedPort include Google::Apis::Core::Hashable # The name for this named port. The name must be 1-63 characters long, and # comply with RFC1035. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The port number, which can be a value between 1 and 65535. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @port = args[:port] if args.key?(:port) end end # Represents a Network resource. Read Networks and Firewalls for more # information. (== resource_for v1.networks ==) (== resource_for beta.networks == # ) class Network include Google::Apis::Core::Hashable # The range of internal addresses that are legal on this network. This range is # a CIDR specification, for example: 192.168.0.0/16. Provided by the client when # the network is created. # Corresponds to the JSON property `IPv4Range` # @return [String] attr_accessor :i_pv4_range # When set to true, the network is created in "auto subnet mode". When set to # false, the network is in "custom subnet mode". # In "auto subnet mode", a newly created network is assigned the default CIDR of # 10.128.0.0/9 and it automatically creates one subnetwork per region. # Corresponds to the JSON property `autoCreateSubnetworks` # @return [Boolean] attr_accessor :auto_create_subnetworks alias_method :auto_create_subnetworks?, :auto_create_subnetworks # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] Type of VM-to-VM traffic encryption for this network. # Corresponds to the JSON property `crossVmEncryption` # @return [String] attr_accessor :cross_vm_encryption # 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 # A gateway address for default routing to other networks. This value is read # only and is selected by the Google Compute Engine, typically as the first # usable address in the IPv4Range. # Corresponds to the JSON property `gatewayIPv4` # @return [String] attr_accessor :gateway_i_pv4 # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#network for networks. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Type of LB-to-VM traffic encryption for this network. # Corresponds to the JSON property `loadBalancerVmEncryption` # @return [String] attr_accessor :load_balancer_vm_encryption # 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 # [Output Only] List of network peerings for the resource. # Corresponds to the JSON property `peerings` # @return [Array] attr_accessor :peerings # A routing configuration attached to a network resource. The message includes # the list of routers associated with the network, and a flag indicating the # type of routing behavior to enforce network-wide. # Corresponds to the JSON property `routingConfig` # @return [Google::Apis::ComputeAlpha::NetworkRoutingConfig] attr_accessor :routing_config # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this # network. # Corresponds to the JSON property `subnetworks` # @return [Array] attr_accessor :subnetworks def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @i_pv4_range = args[:i_pv4_range] if args.key?(:i_pv4_range) @auto_create_subnetworks = args[:auto_create_subnetworks] if args.key?(:auto_create_subnetworks) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @cross_vm_encryption = args[:cross_vm_encryption] if args.key?(:cross_vm_encryption) @description = args[:description] if args.key?(:description) @gateway_i_pv4 = args[:gateway_i_pv4] if args.key?(:gateway_i_pv4) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @load_balancer_vm_encryption = args[:load_balancer_vm_encryption] if args.key?(:load_balancer_vm_encryption) @name = args[:name] if args.key?(:name) @peerings = args[:peerings] if args.key?(:peerings) @routing_config = args[:routing_config] if args.key?(:routing_config) @self_link = args[:self_link] if args.key?(:self_link) @subnetworks = args[:subnetworks] if args.key?(:subnetworks) end end # The network endpoint. class NetworkEndpoint include Google::Apis::Core::Hashable # The name for a specific VM instance that the IP address belongs to. This is # required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The # instance must be in the same zone of network endpoint group. # The name must be 1-63 characters long, and comply with RFC1035. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # Optional IPv4 address of network endpoint. The IP address must belong to a VM # in GCE (either the primary IP or as part of an aliased IP range). If the IP # address is not specified, then the primary IP address for the VM instance in # the network that the network endpoint group belongs to will be used. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address # Optional port number of network endpoint. If not specified and the # NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for # the network endpoint group will be used. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance = args[:instance] if args.key?(:instance) @ip_address = args[:ip_address] if args.key?(:ip_address) @port = args[:port] if args.key?(:port) end end # Represents a collection of network endpoints. class NetworkEndpointGroup include Google::Apis::Core::Hashable # [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. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#networkEndpointGroup for # network endpoint group. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Load balancing specific fields for network endpoint group of type # LOAD_BALANCING. # Corresponds to the JSON property `loadBalancer` # @return [Google::Apis::ComputeAlpha::NetworkEndpointGroupLbNetworkEndpointGroup] attr_accessor :load_balancer # 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 # Type of network endpoints in this network endpoint group. Only supported # values for LOAD_BALANCING are GCE_VM_IP or GCE_VM_IP_PORT. # Corresponds to the JSON property `networkEndpointType` # @return [String] attr_accessor :network_endpoint_type # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output only] Number of network endpoints in the network endpoint group. # Corresponds to the JSON property `size` # @return [Fixnum] attr_accessor :size # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid # for now. # 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) @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) @load_balancer = args[:load_balancer] if args.key?(:load_balancer) @name = args[:name] if args.key?(:name) @network_endpoint_type = args[:network_endpoint_type] if args.key?(:network_endpoint_type) @self_link = args[:self_link] if args.key?(:self_link) @size = args[:size] if args.key?(:size) @type = args[:type] if args.key?(:type) end end # class NetworkEndpointGroupAggregatedList 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 NetworkEndpointGroupsScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] The resource type, which is always compute# # networkEndpointGroupAggregatedList for aggregated lists of network endpoint # groups. # 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::NetworkEndpointGroupAggregatedList::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 # Load balancing specific fields for network endpoint group of type # LOAD_BALANCING. class NetworkEndpointGroupLbNetworkEndpointGroup include Google::Apis::Core::Hashable # The default port used if the port number is not specified in the network # endpoint. If the network endpoint type is GCE_VM_IP, this field must not be # specified. # Corresponds to the JSON property `defaultPort` # @return [Fixnum] attr_accessor :default_port # The URL of the network to which all network endpoints in the NEG belong. Uses " # default" project network if unspecified. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Optional URL of the subnetwork to which all network endpoints in the NEG # belong. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork # [Output Only] The URL of the zone where the network endpoint group is located. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_port = args[:default_port] if args.key?(:default_port) @network = args[:network] if args.key?(:network) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) @zone = args[:zone] if args.key?(:zone) end end # class NetworkEndpointGroupList 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 NetworkEndpointGroup resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] The resource type, which is always compute# # networkEndpointGroupList for network endpoint group lists. # 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::NetworkEndpointGroupList::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 # class NetworkEndpointGroupsAttachEndpointsRequest include Google::Apis::Core::Hashable # The list of network endpoints to be attached. # Corresponds to the JSON property `networkEndpoints` # @return [Array] attr_accessor :network_endpoints def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints) end end # class NetworkEndpointGroupsDetachEndpointsRequest include Google::Apis::Core::Hashable # The list of network endpoints to be detached. # Corresponds to the JSON property `networkEndpoints` # @return [Array] attr_accessor :network_endpoints def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints) end end # class NetworkEndpointGroupsListEndpointsRequest include Google::Apis::Core::Hashable # Optional query parameter for showing the health status of each network # endpoint. Valid options are SKIP or SHOW. If you don't specifiy this parameter, # the health status of network endpoints will not be provided. # Corresponds to the JSON property `healthStatus` # @return [String] attr_accessor :health_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @health_status = args[:health_status] if args.key?(:health_status) end end # class NetworkEndpointGroupsListNetworkEndpoints 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 NetworkEndpointWithHealthStatus resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] The resource type, which is always compute# # networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in # the specified network endpoint group. # 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] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints::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) @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 # class NetworkEndpointGroupsScopedList include Google::Apis::Core::Hashable # [Output Only] The list of network endpoint groups that are contained in this # scope. # Corresponds to the JSON property `networkEndpointGroups` # @return [Array] attr_accessor :network_endpoint_groups # [Output Only] An informational warning that replaces the list of network # endpoint groups when the list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::NetworkEndpointGroupsScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @network_endpoint_groups = args[:network_endpoint_groups] if args.key?(:network_endpoint_groups) @warning = args[:warning] if args.key?(:warning) end # [Output Only] An informational warning that replaces the list of network # endpoint groups when the list is empty. 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 # class NetworkEndpointWithHealthStatus include Google::Apis::Core::Hashable # [Output only] The health status of network endpoint; # Corresponds to the JSON property `healths` # @return [Array] attr_accessor :healths # The network endpoint. # Corresponds to the JSON property `networkEndpoint` # @return [Google::Apis::ComputeAlpha::NetworkEndpoint] attr_accessor :network_endpoint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @healths = args[:healths] if args.key?(:healths) @network_endpoint = args[:network_endpoint] if args.key?(:network_endpoint) end end # A network interface resource attached to an instance. class NetworkInterface include Google::Apis::Core::Hashable # An array of configurations for this interface. Currently, only one access # config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, # then this instance will have no external internet access. # Corresponds to the JSON property `accessConfigs` # @return [Array] attr_accessor :access_configs # An array of alias IP ranges for this network interface. Can only be specified # for network interfaces on subnet-mode networks. # Corresponds to the JSON property `aliasIpRanges` # @return [Array] attr_accessor :alias_ip_ranges # Fingerprint hash of contents stored in this network interface. This field will # be ignored when inserting an Instance or adding a NetworkInterface. An up-to- # date fingerprint must be provided in order to update the NetworkInterface. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # [Output Only] Type of the resource. Always compute#networkInterface for # network interfaces. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] The name of the network interface, generated by the server. For # network devices, these are eth0, eth1, etc. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # URL of the network resource for this instance. When creating an instance, if # neither the network nor the subnetwork is specified, the default network # global/networks/default is used; if the network is not specified but the # subnetwork is specified, the network is inferred. # This field is optional when creating a firewall rule. If not specified when # creating a firewall rule, the default network global/networks/default is used. # If you specify this property, you can specify the network as a full or partial # URL. For example, the following are all valid URLs: # - https://www.googleapis.com/compute/v1/projects/project/global/networks/ # network # - projects/project/global/networks/network # - global/networks/default # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # An IPv4 internal network address to assign to the instance for this network # interface. If not specified by the user, an unused internal IP is assigned by # the system. # Corresponds to the JSON property `networkIP` # @return [String] attr_accessor :network_ip # The URL of the Subnetwork resource for this instance. If the network resource # is in legacy mode, do not provide this property. If the network is in auto # subnet mode, providing the subnetwork is optional. If the network is in custom # subnet mode, then this field should be specified. If you specify this property, # you can specify the subnetwork as a full or partial URL. For example, the # following are all valid URLs: # - https://www.googleapis.com/compute/v1/projects/project/regions/region/ # subnetworks/subnetwork # - regions/region/subnetworks/subnetwork # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @access_configs = args[:access_configs] if args.key?(:access_configs) @alias_ip_ranges = args[:alias_ip_ranges] if args.key?(:alias_ip_ranges) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @network_ip = args[:network_ip] if args.key?(:network_ip) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) end end # Contains a list of networks. class NetworkList 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 Network resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#networkList for lists of # networks. # 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::NetworkList::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 network peering attached to a network resource. The message includes the # peering name, peer network, peering state, and a flag indicating whether # Google Compute Engine should automatically create routes for the peering. class NetworkPeering include Google::Apis::Core::Hashable # Whether full mesh connectivity is created and managed automatically. When it # is set to true, Google Compute Engine will automatically create and manage the # routes between two networks when the state is ACTIVE. Otherwise, user needs to # create routes manually to route packets to peer network. # Corresponds to the JSON property `autoCreateRoutes` # @return [Boolean] attr_accessor :auto_create_routes alias_method :auto_create_routes?, :auto_create_routes # 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])? which means the # first character must be a lowercase letter, and all the 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 # The URL of the peer network. It can be either full URL or partial URL. The # peer network may belong to a different project. If the partial URL does not # contain project, it is assumed that the peer network is in the same project as # the current network. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # [Output Only] State for the peering. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # [Output Only] Details about the current state of the peering. # Corresponds to the JSON property `stateDetails` # @return [String] attr_accessor :state_details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_create_routes = args[:auto_create_routes] if args.key?(:auto_create_routes) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @state = args[:state] if args.key?(:state) @state_details = args[:state_details] if args.key?(:state_details) end end # A routing configuration attached to a network resource. The message includes # the list of routers associated with the network, and a flag indicating the # type of routing behavior to enforce network-wide. class NetworkRoutingConfig include Google::Apis::Core::Hashable # The network-wide routing mode to use. If set to REGIONAL, this network's cloud # routers will only advertise routes with subnetworks of this network in the # same region as the router. If set to GLOBAL, this network's cloud routers will # advertise routes with all subnetworks of this network, across regions. # Corresponds to the JSON property `routingMode` # @return [String] attr_accessor :routing_mode def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @routing_mode = args[:routing_mode] if args.key?(:routing_mode) end end # class NetworksAddPeeringRequest include Google::Apis::Core::Hashable # Whether Google Compute Engine manages the routes automatically. # Corresponds to the JSON property `autoCreateRoutes` # @return [Boolean] attr_accessor :auto_create_routes alias_method :auto_create_routes?, :auto_create_routes # Name of the peering, which should conform to RFC1035. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # URL of the peer network. It can be either full URL or partial URL. The peer # network may belong to a different project. If the partial URL does not contain # project, it is assumed that the peer network is in the same project as the # current network. # Corresponds to the JSON property `peerNetwork` # @return [String] attr_accessor :peer_network def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_create_routes = args[:auto_create_routes] if args.key?(:auto_create_routes) @name = args[:name] if args.key?(:name) @peer_network = args[:peer_network] if args.key?(:peer_network) end end # class NetworksRemovePeeringRequest include Google::Apis::Core::Hashable # Name of the peering, which should conform to RFC1035. # 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 # An Operation resource, used to manage asynchronous API requests. (== # resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) # (== resource_for v1.regionOperations ==) (== resource_for beta. # regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for # beta.zoneOperations ==) class Operation include Google::Apis::Core::Hashable # [Output Only] Reserved for future use. # Corresponds to the JSON property `clientOperationId` # @return [String] attr_accessor :client_operation_id # [Deprecated] This field is deprecated. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] A textual description of the operation, which is set when the # operation is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The time that this operation was completed. This value is in # RFC3339 text format. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # [Output Only] If errors are generated during processing of the operation, this # field will be populated. # Corresponds to the JSON property `error` # @return [Google::Apis::ComputeAlpha::Operation::Error] attr_accessor :error # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as NOT FOUND. # Corresponds to the JSON property `httpErrorMessage` # @return [String] attr_accessor :http_error_message # [Output Only] If the operation fails, this field contains the HTTP error # status code that was returned. For example, a 404 means the resource was not # found. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] attr_accessor :http_error_status_code # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The time that this operation was requested. This value is in # RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # [Output Only] Type of the resource. Always compute#operation for Operation # resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] The type of operation, such as insert, update, or delete, and so # on. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # [Output Only] An optional progress indicator that ranges from 0 to 100. There # is no requirement that this be linear or support any granularity of operations. # This should not be used to guess when the operation will be complete. This # number should monotonically increase as the operation progresses. # Corresponds to the JSON property `progress` # @return [Fixnum] attr_accessor :progress # [Output Only] The URL of the region where the operation resides. Only # available when performing regional operations. 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 # [Output Only] The time that this operation was started by the server. This # value is in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # [Output Only] The status of the operation, which can be one of the following: # PENDING, RUNNING, or DONE. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional textual description of the current status of the # operation. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # [Output Only] The unique target ID, which identifies a specific incarnation of # the target resource. # Corresponds to the JSON property `targetId` # @return [Fixnum] attr_accessor :target_id # [Output Only] The URL of the resource that the operation modifies. For # operations related to creating a snapshot, this points to the persistent disk # that the snapshot was created from. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link # [Output Only] User who requested the operation, for example: user@example.com. # Corresponds to the JSON property `user` # @return [String] attr_accessor :user # [Output Only] If warning messages are generated during processing of the # operation, this field will be populated. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings # [Output Only] The URL of the zone where the operation resides. Only available # when performing per-zone operations. 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 `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @end_time = args[:end_time] if args.key?(:end_time) @error = args[:error] if args.key?(:error) @http_error_message = args[:http_error_message] if args.key?(:http_error_message) @http_error_status_code = args[:http_error_status_code] if args.key?(:http_error_status_code) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @operation_type = args[:operation_type] if args.key?(:operation_type) @progress = args[:progress] if args.key?(:progress) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @target_id = args[:target_id] if args.key?(:target_id) @target_link = args[:target_link] if args.key?(:target_link) @user = args[:user] if args.key?(:user) @warnings = args[:warnings] if args.key?(:warnings) @zone = args[:zone] if args.key?(:zone) end # [Output Only] If errors are generated during processing of the operation, this # field will be populated. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end # 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 # class OperationAggregatedList include Google::Apis::Core::Hashable # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # [Output Only] A map of scoped operation lists. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#operationAggregatedList for # aggregated lists of operations. # 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::OperationAggregatedList::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 # Contains a list of Operation resources. class OperationList include Google::Apis::Core::Hashable # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # [Output Only] A list of Operation resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#operations for Operations # resource. # 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::OperationList::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 # class OperationsScopedList include Google::Apis::Core::Hashable # [Output Only] List of operations contained in this scope. # Corresponds to the JSON property `operations` # @return [Array] attr_accessor :operations # [Output Only] Informational warning which replaces the list of operations when # the list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::OperationsScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @operations = args[:operations] if args.key?(:operations) @warning = args[:warning] if args.key?(:warning) end # [Output Only] Informational warning which replaces the list of operations when # the list is empty. 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 matcher for the path portion of the URL. The BackendService from the longest- # matched rule will serve the URL. If no rule was matched, the default service # will be used. class PathMatcher include Google::Apis::Core::Hashable # The full or partial URL to the BackendService resource. This will be used if # none of the pathRules defined by this PathMatcher is matched by the URL's path # portion. For example, the following are all valid URLs to a BackendService # resource: # - https://www.googleapis.com/compute/v1/projects/project/global/ # backendServices/backendService # - compute/v1/projects/project/global/backendServices/backendService # - global/backendServices/backendService # Corresponds to the JSON property `defaultService` # @return [String] attr_accessor :default_service # 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 # The name to which this PathMatcher is referred by the HostRule. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The list of path rules. # Corresponds to the JSON property `pathRules` # @return [Array] attr_accessor :path_rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_service = args[:default_service] if args.key?(:default_service) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @path_rules = args[:path_rules] if args.key?(:path_rules) end end # A path-matching rule for a URL. If matched, will use the specified # BackendService to handle the traffic arriving at this URL. class PathRule include Google::Apis::Core::Hashable # The list of path patterns to match. Each must start with / and the only place # a * is allowed is at the end following a /. The string fed to the path matcher # does not include any text after the first ? or #, and those chars are not # allowed here. # Corresponds to the JSON property `paths` # @return [Array] attr_accessor :paths # The URL of the BackendService resource if this rule is matched. # 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) @paths = args[:paths] if args.key?(:paths) @service = args[:service] if args.key?(:service) end end # class PerInstanceConfig include Google::Apis::Core::Hashable # The URL of the instance. Serves as a merge key during UpdatePerInstanceConfigs # operation. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # Overrides of stateful properties for a given instance # Corresponds to the JSON property `override` # @return [Google::Apis::ComputeAlpha::ManagedInstanceOverride] attr_accessor :override def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance = args[:instance] if args.key?(:instance) @override = args[:override] if args.key?(:override) end end # Defines an Identity and Access Management (IAM) policy. It is used to specify # access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of ` # members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` "bindings": [ ` "role": "roles/owner", "members": [ "user:mike@example.com", # "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@ # appspot.gserviceaccount.com", ] `, ` "role": "roles/viewer", "members": ["user: # sean@example.com"] ` ] ` # For a description of IAM and its features, see the [IAM developer's guide]( # https://cloud.google.com/iam/docs). class Policy include Google::Apis::Core::Hashable # Specifies cloud audit logging configuration for this policy. # Corresponds to the JSON property `auditConfigs` # @return [Array] attr_accessor :audit_configs # Associates a list of `members` to a `role`. `bindings` with no members will # result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # # Corresponds to the JSON property `iamOwned` # @return [Boolean] attr_accessor :iam_owned alias_method :iam_owned?, :iam_owned # If more than one rule is specified, the rules are applied in the following # manner: - All matching LOG rules are always applied. - If any DENY/ # DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if # one or more matching rule requires logging. - Otherwise, if any ALLOW/ # ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if # one or more matching rule requires logging. - Otherwise, if no rule applies, # permission is denied. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules # Deprecated. # 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) @iam_owned = args[:iam_owned] if args.key?(:iam_owned) @rules = args[:rules] if args.key?(:rules) @version = args[:version] if args.key?(:version) end end # A Project resource. For an overview of projects, see Cloud Platform Resource # Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) class Project include Google::Apis::Core::Hashable # A metadata key/value entry. # Corresponds to the JSON property `commonInstanceMetadata` # @return [Google::Apis::ComputeAlpha::Metadata] attr_accessor :common_instance_metadata # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # This signifies the default network tier used for configuring resources of the # project and can only take the following values: PREMIUM, STANDARD. Initially # the default network tier is PREMIUM. # Corresponds to the JSON property `defaultNetworkTier` # @return [String] attr_accessor :default_network_tier # [Output Only] Default service account used by VMs running in this project. # Corresponds to the JSON property `defaultServiceAccount` # @return [String] attr_accessor :default_service_account # An optional textual description of the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Restricted features enabled for use on this project. # Corresponds to the JSON property `enabledFeatures` # @return [Array] attr_accessor :enabled_features # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. This is not the project ID, and is just a unique ID # used by Compute Engine to identify resources. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#project for projects. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The project ID. For example: my-example-project. Use the project ID to make # requests to Compute Engine. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] Quotas assigned to this project. # Corresponds to the JSON property `quotas` # @return [Array] attr_accessor :quotas # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The location in Cloud Storage and naming method of the daily usage report. # Contains bucket_name and report_name prefix. # Corresponds to the JSON property `usageExportLocation` # @return [Google::Apis::ComputeAlpha::UsageExportLocation] attr_accessor :usage_export_location # [Output Only] The role this project has in a shared VPC configuration. # Currently only HOST projects are differentiated. # Corresponds to the JSON property `xpnProjectStatus` # @return [String] attr_accessor :xpn_project_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common_instance_metadata = args[:common_instance_metadata] if args.key?(:common_instance_metadata) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @default_network_tier = args[:default_network_tier] if args.key?(:default_network_tier) @default_service_account = args[:default_service_account] if args.key?(:default_service_account) @description = args[:description] if args.key?(:description) @enabled_features = args[:enabled_features] if args.key?(:enabled_features) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @quotas = args[:quotas] if args.key?(:quotas) @self_link = args[:self_link] if args.key?(:self_link) @usage_export_location = args[:usage_export_location] if args.key?(:usage_export_location) @xpn_project_status = args[:xpn_project_status] if args.key?(:xpn_project_status) end end # class ProjectsDisableXpnResourceRequest include Google::Apis::Core::Hashable # Service resource (a.k.a service project) ID. # Corresponds to the JSON property `xpnResource` # @return [Google::Apis::ComputeAlpha::XpnResourceId] attr_accessor :xpn_resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @xpn_resource = args[:xpn_resource] if args.key?(:xpn_resource) end end # class ProjectsEnableXpnResourceRequest include Google::Apis::Core::Hashable # Service resource (a.k.a service project) ID. # Corresponds to the JSON property `xpnResource` # @return [Google::Apis::ComputeAlpha::XpnResourceId] attr_accessor :xpn_resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @xpn_resource = args[:xpn_resource] if args.key?(:xpn_resource) end end # class ProjectsGetXpnResources include Google::Apis::Core::Hashable # [Output Only] Type of resource. Always compute#projectsGetXpnResources for # lists of service resources (a.k.a service projects) # 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 # Service resources (a.k.a service projects) attached to this project as their # shared VPC host. # 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 ProjectsListXpnHostsRequest include Google::Apis::Core::Hashable # Optional organization ID managed by Cloud Resource Manager, for which to list # shared VPC host projects. If not specified, the organization will be inferred # from the project. # Corresponds to the JSON property `organization` # @return [String] attr_accessor :organization def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @organization = args[:organization] if args.key?(:organization) end end # class ProjectsSetDefaultNetworkTierRequest include Google::Apis::Core::Hashable # Default network tier to be set. # Corresponds to the JSON property `networkTier` # @return [String] attr_accessor :network_tier def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @network_tier = args[:network_tier] if args.key?(:network_tier) end end # class ProjectsSetDefaultServiceAccountRequest include Google::Apis::Core::Hashable # Email address of the service account. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) end end # A quotas entry. class Quota include Google::Apis::Core::Hashable # [Output Only] Quota limit for this metric. # Corresponds to the JSON property `limit` # @return [Float] attr_accessor :limit # [Output Only] Name of the quota metric. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric # [Output Only] Current usage of this metric. # Corresponds to the JSON property `usage` # @return [Float] attr_accessor :usage def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @limit = args[:limit] if args.key?(:limit) @metric = args[:metric] if args.key?(:metric) @usage = args[:usage] if args.key?(:usage) end end # Represents a reference to a resource. class Reference include Google::Apis::Core::Hashable # [Output Only] Type of the resource. Always compute#reference for references. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A description of the reference type with no implied semantics. Possible values # include: # - MEMBER_OF # Corresponds to the JSON property `referenceType` # @return [String] attr_accessor :reference_type # URL of the resource which refers to the target. # Corresponds to the JSON property `referrer` # @return [String] attr_accessor :referrer # URL of the resource to which this reference points. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @reference_type = args[:reference_type] if args.key?(:reference_type) @referrer = args[:referrer] if args.key?(:referrer) @target = args[:target] if args.key?(:target) end end # Region resource. (== resource_for beta.regions ==) (== resource_for v1.regions # ==) class Region include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # Deprecation status for a public resource. # Corresponds to the JSON property `deprecated` # @return [Google::Apis::ComputeAlpha::DeprecationStatus] attr_accessor :deprecated # [Output Only] Textual description of the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#region for regions. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] Quotas assigned to this region. # Corresponds to the JSON property `quotas` # @return [Array] attr_accessor :quotas # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] Status of the region, either UP or DOWN. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] A list of zones available in this region, in the form of # resource URLs. # 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) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @deprecated = args[:deprecated] if args.key?(:deprecated) @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) @quotas = args[:quotas] if args.key?(:quotas) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) @zones = args[:zones] if args.key?(:zones) end end # Contains a list of autoscalers. class RegionAutoscalerList 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 Autoscaler resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::RegionAutoscalerList::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 # class RegionDiskTypeList 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 DiskType resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#regionDiskTypeList for region # disk types. # 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::RegionDiskTypeList::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 # class RegionDisksResizeRequest include Google::Apis::Core::Hashable # The new size of the regional persistent disk, which is specified in GB. # Corresponds to the JSON property `sizeGb` # @return [Fixnum] attr_accessor :size_gb def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @size_gb = args[:size_gb] if args.key?(:size_gb) end end # Contains a list of InstanceGroup resources. class RegionInstanceGroupList 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 InstanceGroup resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The resource type. # 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::RegionInstanceGroupList::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 # RegionInstanceGroupManagers.deletePerInstanceConfigs class RegionInstanceGroupManagerDeleteInstanceConfigReq include Google::Apis::Core::Hashable # The list of instances for which we want to delete per-instance configs on this # managed instance group. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # Contains a list of managed instance groups. class RegionInstanceGroupManagerList 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 InstanceGroupManager resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] The resource type, which is always compute# # instanceGroupManagerList for a list of managed instance groups that exist in # th regional scope. # 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::RegionInstanceGroupManagerList::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 # RegionInstanceGroupManagers.updatePerInstanceConfigs class RegionInstanceGroupManagerUpdateInstanceConfigReq include Google::Apis::Core::Hashable # The list of per-instance configs to insert or patch on this managed instance # group. # Corresponds to the JSON property `perInstanceConfigs` # @return [Array] attr_accessor :per_instance_configs def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @per_instance_configs = args[:per_instance_configs] if args.key?(:per_instance_configs) end end # class RegionInstanceGroupManagersAbandonInstancesRequest include Google::Apis::Core::Hashable # The URLs of one or more instances to abandon. This can be a full URL or a # partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # InstanceGroupManagers.applyUpdatesToInstances class RegionInstanceGroupManagersApplyUpdatesRequest include Google::Apis::Core::Hashable # The list of instances for which we want to apply changes on this managed # instance group. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances # The maximal action that should be perfomed on the instances. By default # REPLACE. # Corresponds to the JSON property `maximalAction` # @return [String] attr_accessor :maximal_action # The minimal action that should be perfomed on the instances. By default NONE. # Corresponds to the JSON property `minimalAction` # @return [String] attr_accessor :minimal_action def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) @maximal_action = args[:maximal_action] if args.key?(:maximal_action) @minimal_action = args[:minimal_action] if args.key?(:minimal_action) end end # class RegionInstanceGroupManagersDeleteInstancesRequest include Google::Apis::Core::Hashable # The URLs of one or more instances to delete. This can be a full URL or a # partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class RegionInstanceGroupManagersListInstanceConfigsResp include Google::Apis::Core::Hashable # [Output Only] The list of PerInstanceConfig. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [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] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @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 # class RegionInstanceGroupManagersListInstancesResponse include Google::Apis::Core::Hashable # List of managed instances. # Corresponds to the JSON property `managedInstances` # @return [Array] attr_accessor :managed_instances # [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 def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @managed_instances = args[:managed_instances] if args.key?(:managed_instances) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # class RegionInstanceGroupManagersRecreateRequest include Google::Apis::Core::Hashable # The URLs of one or more instances to recreate. This can be a full URL or a # partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class RegionInstanceGroupManagersSetAutoHealingRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `autoHealingPolicies` # @return [Array] attr_accessor :auto_healing_policies def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_healing_policies = args[:auto_healing_policies] if args.key?(:auto_healing_policies) end end # class RegionInstanceGroupManagersSetTargetPoolsRequest include Google::Apis::Core::Hashable # Fingerprint of the target pools information, which is a hash of the contents. # This field is used for optimistic locking when you update the target pool # entries. This field is optional. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # The URL of all TargetPool resources to which instances in the instanceGroup # field are added. The target pools automatically apply to all of the instances # in the managed instance group. # Corresponds to the JSON property `targetPools` # @return [Array] attr_accessor :target_pools def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @target_pools = args[:target_pools] if args.key?(:target_pools) end end # class RegionInstanceGroupManagersSetTemplateRequest include Google::Apis::Core::Hashable # URL of the InstanceTemplate resource from which all new instances will be # created. # Corresponds to the JSON property `instanceTemplate` # @return [String] attr_accessor :instance_template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance_template = args[:instance_template] if args.key?(:instance_template) end end # class RegionInstanceGroupsListInstances 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 InstanceWithNamedPorts resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The resource type. # 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::RegionInstanceGroupsListInstances::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 # class RegionInstanceGroupsListInstancesRequest include Google::Apis::Core::Hashable # Instances in which state should be returned. Valid options are: 'ALL', ' # RUNNING'. By default, it lists all instances. # Corresponds to the JSON property `instanceState` # @return [String] attr_accessor :instance_state # Name of port user is interested in. It is optional. If it is set, only # information about this ports will be returned. If it is not set, all the named # ports will be returned. Always lists all instances. # Corresponds to the JSON property `portName` # @return [String] attr_accessor :port_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance_state = args[:instance_state] if args.key?(:instance_state) @port_name = args[:port_name] if args.key?(:port_name) end end # class RegionInstanceGroupsSetNamedPortsRequest include Google::Apis::Core::Hashable # The fingerprint of the named ports information for this instance group. Use # this optional property to prevent conflicts when multiple users change the # named ports settings concurrently. Obtain the fingerprint with the # instanceGroups.get method. Then, include the fingerprint in your request to # ensure that you do not overwrite changes that were applied from another # concurrent request. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # The list of named ports to set for this instance group. # Corresponds to the JSON property `namedPorts` # @return [Array] attr_accessor :named_ports def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @named_ports = args[:named_ports] if args.key?(:named_ports) end end # Contains a list of region resources. class RegionList 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 Region resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#regionList for lists of regions. # 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::RegionList::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 # class RegionSetLabelsRequest include Google::Apis::Core::Hashable # The fingerprint of the previous set of labels for this resource, used to # detect conflicts. The fingerprint is initially generated by Compute Engine and # changes after every request to modify or update labels. You must always # provide an up-to-date fingerprint hash in order to update or change labels. # Make a get() request to the resource to get the latest fingerprint. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :label_fingerprint # The labels to set for this resource. # 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) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) end end # Commitment for a particular resource (a Commitment is composed of one or more # of these). class ResourceCommitment include Google::Apis::Core::Hashable # The amount of the resource purchased (in a type-dependent unit, such as bytes). # For vCPUs, this can just be an integer. For memory, this must be provided in # MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every # vCPU. # Corresponds to the JSON property `amount` # @return [Fixnum] attr_accessor :amount # Type of resource for which this commitment applies. Possible values are VCPU # and MEMORY # 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) @amount = args[:amount] if args.key?(:amount) @type = args[:type] if args.key?(:type) end end # class ResourceGroupReference include Google::Apis::Core::Hashable # A URI referencing one of the instance groups listed in the backend service. # Corresponds to the JSON property `group` # @return [String] attr_accessor :group def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @group = args[:group] if args.key?(:group) end end # Represents a Route resource. A route specifies how certain packets should be # handled by the network. Routes are associated with instances by tags and the # set of routes for a particular instance is called its routing table. # For each packet leaving an instance, the system searches that instance's # routing table for a single best matching route. Routes match packets by # destination IP address, preferring smaller or more specific ranges over larger # ones. If there is a tie, the system selects the route with the smallest # priority value. If there is still a tie, it uses the layer three and four # packet headers to select just one of the remaining matching routes. The packet # is then forwarded as specified by the nextHop field of the winning route - # either to another instance destination, an instance gateway, or a Google # Compute Engine-operated gateway. # Packets that do not match any route in the sending instance's routing table # are dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==) class Route include Google::Apis::Core::Hashable # [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 # The destination range of outgoing packets that this route applies to. Only # IPv4 is supported. # Corresponds to the JSON property `destRange` # @return [String] attr_accessor :dest_range # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of this resource. Always compute#routes for Route resources. # 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 # Fully-qualified URL of the network that this route applies to. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # The URL to a gateway that should handle matching packets. You can only specify # the internet gateway using a full or partial valid URL: projects// # global/gateways/default-internet-gateway # Corresponds to the JSON property `nextHopGateway` # @return [String] attr_accessor :next_hop_gateway # The URL to an instance that should handle matching packets. You can specify # this as a full or partial URL. For example: # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ # Corresponds to the JSON property `nextHopInstance` # @return [String] attr_accessor :next_hop_instance # The network IP address of an instance that should handle matching packets. # Only IPv4 is supported. # Corresponds to the JSON property `nextHopIp` # @return [String] attr_accessor :next_hop_ip # The URL of the local network if it should handle matching packets. # Corresponds to the JSON property `nextHopNetwork` # @return [String] attr_accessor :next_hop_network # [Output Only] The network peering name that should handle matching packets, # which should conform to RFC1035. # Corresponds to the JSON property `nextHopPeering` # @return [String] attr_accessor :next_hop_peering # The URL to a VpnTunnel that should handle matching packets. # Corresponds to the JSON property `nextHopVpnTunnel` # @return [String] attr_accessor :next_hop_vpn_tunnel # The priority of this route. Priority is used to break ties in cases where # there is more than one matching route of equal prefix length. In the case of # two routes with equal prefix length, the one with the lowest-numbered priority # value wins. Default value is 1000. Valid range is 0 through 65535. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority # [Output Only] Server-defined fully-qualified URL for this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # A list of instance tags to which this route applies. # Corresponds to the JSON property `tags` # @return [Array] attr_accessor :tags # [Output Only] If potential misconfigurations are detected for this route, this # field will be populated with warning messages. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @dest_range = args[:dest_range] if args.key?(:dest_range) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @next_hop_gateway = args[:next_hop_gateway] if args.key?(:next_hop_gateway) @next_hop_instance = args[:next_hop_instance] if args.key?(:next_hop_instance) @next_hop_ip = args[:next_hop_ip] if args.key?(:next_hop_ip) @next_hop_network = args[:next_hop_network] if args.key?(:next_hop_network) @next_hop_peering = args[:next_hop_peering] if args.key?(:next_hop_peering) @next_hop_vpn_tunnel = args[:next_hop_vpn_tunnel] if args.key?(:next_hop_vpn_tunnel) @priority = args[:priority] if args.key?(:priority) @self_link = args[:self_link] if args.key?(:self_link) @tags = args[:tags] if args.key?(:tags) @warnings = args[:warnings] if args.key?(:warnings) end # 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 # Contains a list of Route resources. class RouteList 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 Route resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::RouteList::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 # Router resource. class Router include Google::Apis::Core::Hashable # BGP information specific to this router. # Corresponds to the JSON property `bgp` # @return [Google::Apis::ComputeAlpha::RouterBgp] attr_accessor :bgp # BGP information that needs to be configured into the routing stack to # establish the BGP peering. It must specify peer ASN and either interface name, # IP, or peer IP. Please refer to RFC4273. # Corresponds to the JSON property `bgpPeers` # @return [Array] attr_accessor :bgp_peers # [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. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Router interfaces. Each interface requires either one linked resource (e.g. # linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both. # Corresponds to the JSON property `interfaces` # @return [Array] attr_accessor :interfaces # [Output Only] Type of resource. Always compute#router for routers. # 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 # List of Nat services created in this router. The maximum number of Nat # services within a Router is 3 for Alpha. # Corresponds to the JSON property `nats` # @return [Array] attr_accessor :nats # URI of the network to which this router belongs. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # [Output Only] URI of the region where the router resides. 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) @bgp = args[:bgp] if args.key?(:bgp) @bgp_peers = args[:bgp_peers] if args.key?(:bgp_peers) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @interfaces = args[:interfaces] if args.key?(:interfaces) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @nats = args[:nats] if args.key?(:nats) @network = args[:network] if args.key?(:network) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) end end # Description-tagged IP ranges for the router to advertise. class RouterAdvertisedIpRange include Google::Apis::Core::Hashable # User-specified description for the IP range. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The IP range to advertise. The value must be a CIDR-formatted string. # Corresponds to the JSON property `range` # @return [String] attr_accessor :range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @range = args[:range] if args.key?(:range) end end # Description-tagged prefixes for the router to advertise. class RouterAdvertisedPrefix include Google::Apis::Core::Hashable # User-specified description for the prefix. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The prefix to advertise. The value must be a CIDR-formatted string. # Corresponds to the JSON property `prefix` # @return [String] attr_accessor :prefix def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @prefix = args[:prefix] if args.key?(:prefix) end end # Contains a list of routers. class RouterAggregatedList 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 Router resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # Type of resource. # 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::RouterAggregatedList::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 # class RouterBgp include Google::Apis::Core::Hashable # User-specified flag to indicate which mode to use for advertisement. # Corresponds to the JSON property `advertiseMode` # @return [String] attr_accessor :advertise_mode # User-specified list of prefix groups to advertise in custom mode. This field # can only be populated if advertise_mode is CUSTOM and is advertised to all # peers of the router. These groups will be advertised in addition to any # specified prefixes. Leave this field blank to advertise no custom groups. # Corresponds to the JSON property `advertisedGroups` # @return [Array] attr_accessor :advertised_groups # User-specified list of individual IP ranges to advertise in custom mode. This # field can only be populated if advertise_mode is CUSTOM and is advertised to # all peers of the router. These IP ranges will be advertised in addition to any # specified groups. Leave this field blank to advertise no custom IP ranges. # Corresponds to the JSON property `advertisedIpRanges` # @return [Array] attr_accessor :advertised_ip_ranges # User-specified list of individual prefixes to advertise in custom mode. This # field can only be populated if advertise_mode is CUSTOM and is advertised to # all peers of the router. These prefixes will be advertised in addition to any # specified groups. Leave this field blank to advertise no custom prefixes. # Corresponds to the JSON property `advertisedPrefixs` # @return [Array] attr_accessor :advertised_prefixs # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, # either 16-bit or 32-bit. The value will be fixed for this router resource. All # VPN tunnels that link to this router will have the same local ASN. # Corresponds to the JSON property `asn` # @return [Fixnum] attr_accessor :asn def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @advertise_mode = args[:advertise_mode] if args.key?(:advertise_mode) @advertised_groups = args[:advertised_groups] if args.key?(:advertised_groups) @advertised_ip_ranges = args[:advertised_ip_ranges] if args.key?(:advertised_ip_ranges) @advertised_prefixs = args[:advertised_prefixs] if args.key?(:advertised_prefixs) @asn = args[:asn] if args.key?(:asn) end end # class RouterBgpPeer include Google::Apis::Core::Hashable # User-specified flag to indicate which mode to use for advertisement. # Corresponds to the JSON property `advertiseMode` # @return [String] attr_accessor :advertise_mode # User-specified list of prefix groups to advertise in custom mode. This field # can only be populated if advertise_mode is CUSTOM and overrides the list # defined for the router (in Bgp message). These groups will be advertised in # addition to any specified prefixes. Leave this field blank to advertise no # custom groups. # Corresponds to the JSON property `advertisedGroups` # @return [Array] attr_accessor :advertised_groups # User-specified list of individual IP ranges to advertise in custom mode. This # field can only be populated if advertise_mode is CUSTOM and overrides the list # defined for the router (in Bgp message). These IP ranges will be advertised in # addition to any specified groups. Leave this field blank to advertise no # custom IP ranges. # Corresponds to the JSON property `advertisedIpRanges` # @return [Array] attr_accessor :advertised_ip_ranges # User-specified list of individual prefixes to advertise in custom mode. This # field can only be populated if advertise_mode is CUSTOM and overrides the list # defined for the router (in Bgp message). These prefixes will be advertised in # addition to any specified groups. Leave this field blank to advertise no # custom prefixes. # Corresponds to the JSON property `advertisedPrefixs` # @return [Array] attr_accessor :advertised_prefixs # The priority of routes advertised to this BGP peer. In the case where there is # more than one matching route of maximum length, the routes with lowest # priority value win. # Corresponds to the JSON property `advertisedRoutePriority` # @return [Fixnum] attr_accessor :advertised_route_priority # Name of the interface the BGP peer is associated with. # Corresponds to the JSON property `interfaceName` # @return [String] attr_accessor :interface_name # IP address of the interface inside Google Cloud Platform. Only IPv4 is # supported. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address # Name of this BGP peer. The name must be 1-63 characters long and comply with # RFC1035. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be # different for every tunnel. # Corresponds to the JSON property `peerAsn` # @return [Fixnum] attr_accessor :peer_asn # IP address of the BGP interface outside Google cloud. Only IPv4 is supported. # Corresponds to the JSON property `peerIpAddress` # @return [String] attr_accessor :peer_ip_address def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @advertise_mode = args[:advertise_mode] if args.key?(:advertise_mode) @advertised_groups = args[:advertised_groups] if args.key?(:advertised_groups) @advertised_ip_ranges = args[:advertised_ip_ranges] if args.key?(:advertised_ip_ranges) @advertised_prefixs = args[:advertised_prefixs] if args.key?(:advertised_prefixs) @advertised_route_priority = args[:advertised_route_priority] if args.key?(:advertised_route_priority) @interface_name = args[:interface_name] if args.key?(:interface_name) @ip_address = args[:ip_address] if args.key?(:ip_address) @name = args[:name] if args.key?(:name) @peer_asn = args[:peer_asn] if args.key?(:peer_asn) @peer_ip_address = args[:peer_ip_address] if args.key?(:peer_ip_address) end end # class RouterInterface include Google::Apis::Core::Hashable # IP address and range of the interface. The IP range must be in the RFC3927 # link-local IP space. The value must be a CIDR-formatted string, for example: # 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP # address of the interface. # Corresponds to the JSON property `ipRange` # @return [String] attr_accessor :ip_range # URI of the linked interconnect attachment. It must be in the same region as # the router. Each interface can have at most one linked resource and it could # either be a VPN Tunnel or an interconnect attachment. # Corresponds to the JSON property `linkedInterconnectAttachment` # @return [String] attr_accessor :linked_interconnect_attachment # URI of the linked VPN tunnel. It must be in the same region as the router. # Each interface can have at most one linked resource and it could either be a # VPN Tunnel or an interconnect attachment. # Corresponds to the JSON property `linkedVpnTunnel` # @return [String] attr_accessor :linked_vpn_tunnel # Name of this interface entry. The name must be 1-63 characters long and comply # with RFC1035. # 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) @ip_range = args[:ip_range] if args.key?(:ip_range) @linked_interconnect_attachment = args[:linked_interconnect_attachment] if args.key?(:linked_interconnect_attachment) @linked_vpn_tunnel = args[:linked_vpn_tunnel] if args.key?(:linked_vpn_tunnel) @name = args[:name] if args.key?(:name) end end # Contains a list of Router resources. class RouterList 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 Router resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#router for routers. # 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::RouterList::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 # Represents a Nat resource. It enables the VMs within the specified subnetworks # to access Internet without external IP addresses. It specifies a list of # subnetworks (and the ranges within) that want to use NAT. Customers can also # provide the external IPs that would be used for NAT. GCP would auto-allocate # ephemeral IPs if no external IPs are provided. class RouterNat include Google::Apis::Core::Hashable # [Output Only] List of IPs allocated automatically by GCP for this Nat service. # They will be raw IP strings like "179.12.26.133". They are ephemeral IPs # allocated from the IP blocks managed by the NAT manager. This list can grow # and shrink based on the number of VMs configured to use NAT. # Corresponds to the JSON property `autoAllocatedNatIps` # @return [Array] attr_accessor :auto_allocated_nat_ips # Unique name of this Nat service. The name must be 1-63 characters long and # comply with RFC1035. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should be # empty. # Corresponds to the JSON property `natIpAllocateOption` # @return [String] attr_accessor :nat_ip_allocate_option # List of URLs of the IP resources used for this Nat service. These IPs must be # valid static external IP addresses assigned to the project. max_length is # subject to change post alpha. # Corresponds to the JSON property `natIps` # @return [Array] attr_accessor :nat_ips # Specify the Nat option. If this field contains ALL_SUBNETWORKS_ALL_IP_RANGES # or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other # Router.Nat section in any Router for this network in this region. # Corresponds to the JSON property `sourceSubnetworkIpRangesToNat` # @return [String] attr_accessor :source_subnetwork_ip_ranges_to_nat # List of Subnetwork resources whose traffic should be translated by NAT Gateway. # It is used only when LIST_OF_SUBNETWORKS is selected for the # SubnetworkIpRangeToNatOption above. # Corresponds to the JSON property `subnetworks` # @return [Array] attr_accessor :subnetworks def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_allocated_nat_ips = args[:auto_allocated_nat_ips] if args.key?(:auto_allocated_nat_ips) @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) @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) end end # Defines the IP ranges that want to use NAT for a subnetwork. class RouterNatSubnetworkToNat include Google::Apis::Core::Hashable # URL for the subnetwork resource to use NAT. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # List of the secondary ranges of the Subnetwork that are allowed to use NAT. # This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the # values in source_ip_ranges_to_nat. # Corresponds to the JSON property `secondaryIpRangeNames` # @return [Array] attr_accessor :secondary_ip_range_names # Specify the options for NAT ranges in the Subnetwork. All usages of single # value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option # with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] # Default: [ALL_IP_RANGES] # Corresponds to the JSON property `sourceIpRangesToNats` # @return [Array] attr_accessor :source_ip_ranges_to_nats def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @secondary_ip_range_names = args[:secondary_ip_range_names] if args.key?(:secondary_ip_range_names) @source_ip_ranges_to_nats = args[:source_ip_ranges_to_nats] if args.key?(:source_ip_ranges_to_nats) end end # class RouterStatus include Google::Apis::Core::Hashable # Best routes for this router's network. # Corresponds to the JSON property `bestRoutes` # @return [Array] attr_accessor :best_routes # Best routes learned by this router. # Corresponds to the JSON property `bestRoutesForRouter` # @return [Array] attr_accessor :best_routes_for_router # # Corresponds to the JSON property `bgpPeerStatus` # @return [Array] attr_accessor :bgp_peer_status # # Corresponds to the JSON property `natStatus` # @return [Array] attr_accessor :nat_status # URI of the network to which this router belongs. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @best_routes = args[:best_routes] if args.key?(:best_routes) @best_routes_for_router = args[:best_routes_for_router] if args.key?(:best_routes_for_router) @bgp_peer_status = args[:bgp_peer_status] if args.key?(:bgp_peer_status) @nat_status = args[:nat_status] if args.key?(:nat_status) @network = args[:network] if args.key?(:network) end end # class RouterStatusBgpPeerStatus include Google::Apis::Core::Hashable # Routes that were advertised to the remote BGP peer # Corresponds to the JSON property `advertisedRoutes` # @return [Array] attr_accessor :advertised_routes # IP address of the local BGP interface. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address # URL of the VPN tunnel that this BGP peer controls. # Corresponds to the JSON property `linkedVpnTunnel` # @return [String] attr_accessor :linked_vpn_tunnel # Name of this BGP peer. Unique within the Routers resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Number of routes learned from the remote BGP Peer. # Corresponds to the JSON property `numLearnedRoutes` # @return [Fixnum] attr_accessor :num_learned_routes # IP address of the remote BGP interface. # Corresponds to the JSON property `peerIpAddress` # @return [String] attr_accessor :peer_ip_address # BGP state as specified in RFC1771. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Status of the BGP peer: `UP, DOWN` # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, # 59 minutes, 59 seconds # Corresponds to the JSON property `uptime` # @return [String] attr_accessor :uptime # Time this session has been up, in seconds. Format: 145 # Corresponds to the JSON property `uptimeSeconds` # @return [String] attr_accessor :uptime_seconds def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @advertised_routes = args[:advertised_routes] if args.key?(:advertised_routes) @ip_address = args[:ip_address] if args.key?(:ip_address) @linked_vpn_tunnel = args[:linked_vpn_tunnel] if args.key?(:linked_vpn_tunnel) @name = args[:name] if args.key?(:name) @num_learned_routes = args[:num_learned_routes] if args.key?(:num_learned_routes) @peer_ip_address = args[:peer_ip_address] if args.key?(:peer_ip_address) @state = args[:state] if args.key?(:state) @status = args[:status] if args.key?(:status) @uptime = args[:uptime] if args.key?(:uptime) @uptime_seconds = args[:uptime_seconds] if args.key?(:uptime_seconds) end end # Status of a NAT contained in this router. class RouterStatusNatStatus include Google::Apis::Core::Hashable # List of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"] # Corresponds to the JSON property `autoAllocatedNatIps` # @return [Array] attr_accessor :auto_allocated_nat_ips # The number of extra IPs to allocate. This will be greater than 0 only if user- # specified IPs are NOT enough to allow all configured VMs to use NAT. This # value is meaningful only when auto-allocation of NAT IPs is *not* used. # Corresponds to the JSON property `minExtraNatIpsNeeded` # @return [Fixnum] attr_accessor :min_extra_nat_ips_needed # Unique name of this NAT. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Number of VM endpoints (i.e., Nics) that can use NAT. # Corresponds to the JSON property `numVmEndpointsWithNatMappings` # @return [Fixnum] attr_accessor :num_vm_endpoints_with_nat_mappings # List of fully qualified URLs of reserved IP address resources. # Corresponds to the JSON property `userAllocatedNatIpResources` # @return [Array] attr_accessor :user_allocated_nat_ip_resources # List of IPs user-allocated for NAT. They will be raw IP strings like "179.12. # 26.133". # Corresponds to the JSON property `userAllocatedNatIps` # @return [Array] attr_accessor :user_allocated_nat_ips def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_allocated_nat_ips = args[:auto_allocated_nat_ips] if args.key?(:auto_allocated_nat_ips) @min_extra_nat_ips_needed = args[:min_extra_nat_ips_needed] if args.key?(:min_extra_nat_ips_needed) @name = args[:name] if args.key?(:name) @num_vm_endpoints_with_nat_mappings = args[:num_vm_endpoints_with_nat_mappings] if args.key?(:num_vm_endpoints_with_nat_mappings) @user_allocated_nat_ip_resources = args[:user_allocated_nat_ip_resources] if args.key?(:user_allocated_nat_ip_resources) @user_allocated_nat_ips = args[:user_allocated_nat_ips] if args.key?(:user_allocated_nat_ips) end end # class RouterStatusResponse include Google::Apis::Core::Hashable # Type of resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # # Corresponds to the JSON property `result` # @return [Google::Apis::ComputeAlpha::RouterStatus] attr_accessor :result def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @result = args[:result] if args.key?(:result) end end # class RoutersPreviewResponse include Google::Apis::Core::Hashable # Router resource. # Corresponds to the JSON property `resource` # @return [Google::Apis::ComputeAlpha::Router] attr_accessor :resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource = args[:resource] if args.key?(:resource) end end # class RoutersScopedList include Google::Apis::Core::Hashable # List of routers contained in this scope. # Corresponds to the JSON property `routers` # @return [Array] attr_accessor :routers # Informational warning which replaces the list of routers when the list is # empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::RoutersScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @routers = args[:routers] if args.key?(:routers) @warning = args[:warning] if args.key?(:warning) end # Informational warning which replaces the list of routers when the list is # empty. 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 rule to be applied in a Policy. class Rule include Google::Apis::Core::Hashable # Required # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Additional restrictions that must be met. All conditions must pass for the # rule to match. # Corresponds to the JSON property `conditions` # @return [Array] attr_accessor :conditions # Human-readable description of the rule. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/ # AUTHORITY_SELECTOR is in at least one of these entries. # Corresponds to the JSON property `ins` # @return [Array] attr_accessor :ins # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries # that match the LOG action. # Corresponds to the JSON property `logConfigs` # @return [Array] attr_accessor :log_configs # If one or more 'not_in' clauses are specified, the rule matches if the # PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. # Corresponds to the JSON property `notIns` # @return [Array] attr_accessor :not_ins # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value # of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets. # *') matches all verbs. # 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) @action = args[:action] if args.key?(:action) @conditions = args[:conditions] if args.key?(:conditions) @description = args[:description] if args.key?(:description) @ins = args[:ins] if args.key?(:ins) @log_configs = args[:log_configs] if args.key?(:log_configs) @not_ins = args[:not_ins] if args.key?(:not_ins) @permissions = args[:permissions] if args.key?(:permissions) end end # class SslHealthCheck include Google::Apis::Core::Hashable # The TCP port number for the health check request. The default value is 443. # Valid values are 1 through 65535. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port # Port name as defined in InstanceGroup#NamedPort#name. If both port and # port_name are defined, port takes precedence. # Corresponds to the JSON property `portName` # @return [String] attr_accessor :port_name # Specifies how port is selected for health checking, can be one of following # values: # USE_FIXED_PORT: The port number in # port # is used for health checking. # USE_NAMED_PORT: The # portName # is used for health checking. # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each # network endpoint is used for health checking. For other backends, the port or # named port specified in the Backend Service is used for health checking. # If not specified, SSL health check follows behavior specified in # port # and # portName # fields. # Corresponds to the JSON property `portSpecification` # @return [String] attr_accessor :port_specification # Specifies the type of proxy header to append before sending data to the # backend, either NONE or PROXY_V1. The default is NONE. # Corresponds to the JSON property `proxyHeader` # @return [String] attr_accessor :proxy_header # The application data to send once the SSL connection has been established ( # default value is empty). If both request and response are empty, the # connection establishment alone will indicate health. The request data can only # be ASCII. # Corresponds to the JSON property `request` # @return [String] attr_accessor :request # The bytes to match against the beginning of the response data. If left empty ( # the default value), any response will indicate health. The response data can # only be ASCII. # Corresponds to the JSON property `response` # @return [String] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @port = args[:port] if args.key?(:port) @port_name = args[:port_name] if args.key?(:port_name) @port_specification = args[:port_specification] if args.key?(:port_specification) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) @request = args[:request] if args.key?(:request) @response = args[:response] if args.key?(:response) end end # Sets the scheduling options for an Instance. class Scheduling include Google::Apis::Core::Hashable # Specifies whether the instance should be automatically restarted if it is # terminated by Compute Engine (not terminated by a user). You can only set the # automatic restart option for standard instances. Preemptible instances cannot # be automatically restarted. # By default, this is set to true so an instance is automatically restarted if # it is terminated by Compute Engine. # Corresponds to the JSON property `automaticRestart` # @return [Boolean] attr_accessor :automatic_restart alias_method :automatic_restart?, :automatic_restart # Defines the maintenance behavior for this instance. For standard instances, # the default behavior is MIGRATE. For preemptible instances, the default and # only possible behavior is TERMINATE. For more information, see Setting # Instance Scheduling Options. # Corresponds to the JSON property `onHostMaintenance` # @return [String] attr_accessor :on_host_maintenance # Defines whether the instance is preemptible. This can only be set during # instance creation, it cannot be set or changed after the instance has been # created. # Corresponds to the JSON property `preemptible` # @return [Boolean] attr_accessor :preemptible alias_method :preemptible?, :preemptible def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @automatic_restart = args[:automatic_restart] if args.key?(:automatic_restart) @on_host_maintenance = args[:on_host_maintenance] if args.key?(:on_host_maintenance) @preemptible = args[:preemptible] if args.key?(:preemptible) end end # A security policy is comprised of one or more rules. It can also be associated # with one or more 'targets'. class SecurityPolicy include Google::Apis::Core::Hashable # [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 # Specifies a fingerprint for this resource, which is essentially a hash of the # metadata's contents and used for optimistic locking. The fingerprint is # initially generated by Compute Engine and changes after every request to # modify or update metadata. You must always provide an up-to-date fingerprint # hash in order to update or change metadata. # To see the latest fingerprint, make get() request to the security policy. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output only] Type of the resource. Always compute#securityPolicyfor security # policies # 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 # List of rules that belong to this policy. There must always be a default rule ( # rule with priority 2147483647 and match "*"). If no rules are provided when # creating a security policy, a default rule with action "allow" will be added. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules # [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) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @rules = args[:rules] if args.key?(:rules) @self_link = args[:self_link] if args.key?(:self_link) end end # class SecurityPolicyList 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 SecurityPolicy resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#securityPolicyList for listsof # securityPolicies # 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] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::SecurityPolicyList::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) @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 # class SecurityPolicyReference include Google::Apis::Core::Hashable # # Corresponds to the JSON property `securityPolicy` # @return [String] attr_accessor :security_policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @security_policy = args[:security_policy] if args.key?(:security_policy) end end # Represents a rule that describes one or more match conditions along with the # action to be taken when traffic matches this condition (allow or deny). class SecurityPolicyRule include Google::Apis::Core::Hashable # The Action to preform when the client connection triggers the rule. Can # currently be either "allow" or "deny()" where valid values for status are 403, # 404, and 502. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # 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] Type of the resource. Always compute#securityPolicyRule for # security policy rules # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Represents a match condition that incoming traffic is evaluated against. # Exactly one field must be specified. # Corresponds to the JSON property `match` # @return [Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcher] attr_accessor :match # If set to true, the specified action is not enforced. # Corresponds to the JSON property `preview` # @return [Boolean] attr_accessor :preview alias_method :preview?, :preview # An integer indicating the priority of a rule in the list. The priority must be # a positive value between 0 and 2147483647. Rules are evaluated in the # increasing order of priority. # 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) @kind = args[:kind] if args.key?(:kind) @match = args[:match] if args.key?(:match) @preview = args[:preview] if args.key?(:preview) @priority = args[:priority] if args.key?(:priority) end end # Represents a match condition that incoming traffic is evaluated against. # Exactly one field must be specified. class SecurityPolicyRuleMatcher include Google::Apis::Core::Hashable # The configuration options available when specifying versioned_expr. This field # must be specified if versioned_expr is specified and cannot be specified if # versioned_expr is not specified. # Corresponds to the JSON property `config` # @return [Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcherConfig] attr_accessor :config # Represents an expression text. Example: # title: "User account presence" description: "Determines whether the request # has a user account" expression: "size(request.user) > 0" # Corresponds to the JSON property `expr` # @return [Google::Apis::ComputeAlpha::Expr] attr_accessor :expr # CIDR IP address range. Only IPv4 is supported. # Corresponds to the JSON property `srcIpRanges` # @return [Array] attr_accessor :src_ip_ranges # Preconfigured versioned expression. If this field is specified, config must # also be specified. Available preconfigured expressions along with their # requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range # field in config. # Corresponds to the JSON property `versionedExpr` # @return [String] attr_accessor :versioned_expr def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @config = args[:config] if args.key?(:config) @expr = args[:expr] if args.key?(:expr) @src_ip_ranges = args[:src_ip_ranges] if args.key?(:src_ip_ranges) @versioned_expr = args[:versioned_expr] if args.key?(:versioned_expr) end end # class SecurityPolicyRuleMatcherConfig include Google::Apis::Core::Hashable # CIDR IP address range. Only IPv4 is supported. # Corresponds to the JSON property `srcIpRanges` # @return [Array] attr_accessor :src_ip_ranges def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @src_ip_ranges = args[:src_ip_ranges] if args.key?(:src_ip_ranges) end end # An instance's serial console output. class SerialPortOutput include Google::Apis::Core::Hashable # [Output Only] The contents of the console output. # Corresponds to the JSON property `contents` # @return [String] attr_accessor :contents # [Output Only] Type of the resource. Always compute#serialPortOutput for serial # port output. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] The position of the next byte of content from the serial console # output. Use this value in the next request as the start parameter. # Corresponds to the JSON property `next` # @return [Fixnum] attr_accessor :next # [Output Only] Server-defined URL for this resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The starting byte position of the output that was returned. This should match # the start parameter sent with the request. If the serial console output # exceeds the size of the buffer, older output will be overwritten by newer # content and the start values will be mismatched. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contents = args[:contents] if args.key?(:contents) @kind = args[:kind] if args.key?(:kind) @next = args[:next] if args.key?(:next) @self_link = args[:self_link] if args.key?(:self_link) @start = args[:start] if args.key?(:start) end end # A service account. class ServiceAccount include Google::Apis::Core::Hashable # Email address of the service account. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The list of scopes to be made available for this service account. # 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) @email = args[:email] if args.key?(:email) @scopes = args[:scopes] if args.key?(:scopes) end end # A set of Shielded VM options. class ShieldedVmConfig include Google::Apis::Core::Hashable # Defines whether the instance should have secure boot enabled. # Corresponds to the JSON property `enableSecureBoot` # @return [Boolean] attr_accessor :enable_secure_boot alias_method :enable_secure_boot?, :enable_secure_boot # Defines whether the instance should have the TPM enabled. # Corresponds to the JSON property `enableVtpm` # @return [Boolean] attr_accessor :enable_vtpm alias_method :enable_vtpm?, :enable_vtpm def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enable_secure_boot = args[:enable_secure_boot] if args.key?(:enable_secure_boot) @enable_vtpm = args[:enable_vtpm] if args.key?(:enable_vtpm) end end # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs class SignedUrlKey include Google::Apis::Core::Hashable # Name of the key. 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 `keyName` # @return [String] attr_accessor :key_name # 128-bit key value used for signing the URL. The key value must be a valid RFC # 4648 Section 5 base64url encoded string. # Corresponds to the JSON property `keyValue` # @return [String] attr_accessor :key_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key_name = args[:key_name] if args.key?(:key_name) @key_value = args[:key_value] if args.key?(:key_value) end end # A persistent disk snapshot resource. (== resource_for beta.snapshots ==) (== # resource_for v1.snapshots ==) class Snapshot include Google::Apis::Core::Hashable # [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] Size of the snapshot, specified in GB. # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] attr_accessor :disk_size_gb # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#snapshot for Snapshot # resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for the labels being applied to this snapshot, which is # essentially a hash of the labels set used for optimistic locking. The # fingerprint is initially generated by Compute Engine and changes after every # request to modify or update labels. You must always provide an up-to-date # fingerprint hash in order to update or change labels. # To see the latest fingerprint, make a get() request to retrieve a snapshot. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :label_fingerprint # Labels to apply to this snapshot. These can be later modified by the setLabels # method. Label values may be empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Integer license codes indicating which licenses are attached to this snapshot. # Corresponds to the JSON property `licenseCodes` # @return [Array] attr_accessor :license_codes # [Output Only] A list of public visible licenses that apply to this snapshot. # This can be because the original image had licenses attached (such as a # Windows image). # Corresponds to the JSON property `licenses` # @return [Array] attr_accessor :licenses # 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 # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Represents a customer-supplied encryption key # Corresponds to the JSON property `snapshotEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :snapshot_encryption_key # [Output Only] The source disk used to create this snapshot. # Corresponds to the JSON property `sourceDisk` # @return [String] attr_accessor :source_disk # Represents a customer-supplied encryption key # Corresponds to the JSON property `sourceDiskEncryptionKey` # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :source_disk_encryption_key # [Output Only] The ID value of the disk used to create this snapshot. This # value may be used to determine whether the snapshot was taken from the current # or a previous instance of a given disk name. # Corresponds to the JSON property `sourceDiskId` # @return [String] attr_accessor :source_disk_id # [Output Only] The status of the snapshot. This can be CREATING, DELETING, # FAILED, READY, or UPLOADING. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] A size of the storage used by the snapshot. As snapshots share # storage, this number is expected to change with snapshot creation/deletion. # Corresponds to the JSON property `storageBytes` # @return [Fixnum] attr_accessor :storage_bytes # [Output Only] An indicator whether storageBytes is in a stable state or it is # being adjusted as a result of shared storage reallocation. This status can # either be UPDATING, meaning the size of the snapshot is being updated, or # UP_TO_DATE, meaning the size of the snapshot is up-to-date. # Corresponds to the JSON property `storageBytesStatus` # @return [String] attr_accessor :storage_bytes_status # GCS bucket storage location of the snapshot (regional or multi-regional). # Corresponds to the JSON property `storageLocations` # @return [Array] attr_accessor :storage_locations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @license_codes = args[:license_codes] if args.key?(:license_codes) @licenses = args[:licenses] if args.key?(:licenses) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) @snapshot_encryption_key = args[:snapshot_encryption_key] if args.key?(:snapshot_encryption_key) @source_disk = args[:source_disk] if args.key?(:source_disk) @source_disk_encryption_key = args[:source_disk_encryption_key] if args.key?(:source_disk_encryption_key) @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id) @status = args[:status] if args.key?(:status) @storage_bytes = args[:storage_bytes] if args.key?(:storage_bytes) @storage_bytes_status = args[:storage_bytes_status] if args.key?(:storage_bytes_status) @storage_locations = args[:storage_locations] if args.key?(:storage_locations) end end # Contains a list of Snapshot resources. class SnapshotList 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 Snapshot resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::SnapshotList::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 specification of the parameters to use when creating the instance template # from a source instance. class SourceInstanceParams include Google::Apis::Core::Hashable # Attached disks configuration. If not provided, defaults are applied: For boot # disk and any other R/W disks, new custom images will be created from each disk. # For read-only disks, they will be attached in read-only mode. Local SSD disks # will be created as blank volumes. # Corresponds to the JSON property `diskConfigs` # @return [Array] attr_accessor :disk_configs def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disk_configs = args[:disk_configs] if args.key?(:disk_configs) end end # An SslCertificate resource. This resource provides a mechanism to upload an # SSL key and certificate to the load balancer to serve secure connections from # the user. (== resource_for beta.sslCertificates ==) (== resource_for v1. # sslCertificates ==) class SslCertificate 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 # [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] 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` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#sslCertificate for SSL # certificates. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Configuration and status of a managed SSL certificate. # Corresponds to the JSON property `managed` # @return [Google::Apis::ComputeAlpha::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- # 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 # 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 # [Output only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Configuration and status of a self-managed SSL certificate.. # Corresponds to the JSON property `selfManaged` # @return [Google::Apis::ComputeAlpha::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 # Update properties of this object def update!(**args) @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) @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 # Contains a list of SslCertificate resources. class SslCertificateList 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 SslCertificate resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::SslCertificateList::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 # 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 SslPoliciesList 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 SslPolicy resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of the resource. Always compute#sslPoliciesList for lists # of sslPolicies. # 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::SslPoliciesList::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 # class SslPoliciesListAvailableFeaturesResponse include Google::Apis::Core::Hashable # # Corresponds to the JSON property `features` # @return [Array] attr_accessor :features def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @features = args[:features] if args.key?(:features) end end # A SSL policy specifies the server-side support for SSL features. This can be # attached to a TargetHttpsProxy or a TargetSslProxy. This affects connections # between clients and the HTTPS or SSL proxy load balancer. They do not affect # the connection between the load balancers and the backends. class SslPolicy include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # List of features enabled when the selected profile is CUSTOM. The # - method returns the set of features that can be specified in this list. This # field must be empty if the profile is not CUSTOM. # Corresponds to the JSON property `customFeatures` # @return [Array] attr_accessor :custom_features # 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 list of features enabled in the SSL policy. # Corresponds to the JSON property `enabledFeatures` # @return [Array] attr_accessor :enabled_features # Fingerprint of this resource. A hash of the contents stored in this object. # This field is used in optimistic locking. This field will be ignored when # inserting a SslPolicy. An up-to-date fingerprint must be provided in order to # update the SslPolicy. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The minimum version of SSL protocol that can be used by the clients to # establish a connection with the load balancer. This can be one of TLS_1_0, # TLS_1_1, TLS_1_2, TLS_1_3. # Corresponds to the JSON property `minTlsVersion` # @return [String] attr_accessor :min_tls_version # Name of the resource. 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 # Profile specifies the set of SSL features that can be used by the load # balancer when negotiating SSL with clients. This can be one of COMPATIBLE, # MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to # enable must be specified in the customFeatures field. # Corresponds to the JSON property `profile` # @return [String] attr_accessor :profile # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] If potential misconfigurations are detected for this SSL policy, # this field will be populated with warning messages. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @custom_features = args[:custom_features] if args.key?(:custom_features) @description = args[:description] if args.key?(:description) @enabled_features = args[:enabled_features] if args.key?(:enabled_features) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @min_tls_version = args[:min_tls_version] if args.key?(:min_tls_version) @name = args[:name] if args.key?(:name) @profile = args[:profile] if args.key?(:profile) @self_link = args[:self_link] if args.key?(:self_link) @warnings = args[:warnings] if args.key?(:warnings) end # 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 # class SslPolicyReference include Google::Apis::Core::Hashable # URL of the SSL policy resource. Set this to empty string to clear any existing # SSL policy associated with the target proxy resource. # Corresponds to the JSON property `sslPolicy` # @return [String] attr_accessor :ssl_policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ssl_policy = args[:ssl_policy] if args.key?(:ssl_policy) end end # class StatefulPolicy include Google::Apis::Core::Hashable # Configuration of all preserved resources. # Corresponds to the JSON property `preservedResources` # @return [Google::Apis::ComputeAlpha::StatefulPolicyPreservedResources] attr_accessor :preserved_resources def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @preserved_resources = args[:preserved_resources] if args.key?(:preserved_resources) end end # class StatefulPolicyPreservedDisk include Google::Apis::Core::Hashable # Device name of the disk to be preserved # Corresponds to the JSON property `deviceName` # @return [String] attr_accessor :device_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @device_name = args[:device_name] if args.key?(:device_name) end end # Configuration of all preserved resources. class StatefulPolicyPreservedResources include Google::Apis::Core::Hashable # Disks created on the instances that will be preserved on instance delete, # resize down, etc. # Corresponds to the JSON property `disks` # @return [Array] attr_accessor :disks def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @disks = args[:disks] if args.key?(:disks) end end # A Subnetwork resource. (== resource_for beta.subnetworks ==) (== resource_for # v1.subnetworks ==) class Subnetwork include Google::Apis::Core::Hashable # Whether this subnetwork can conflict with static routes. Setting this to true # allows this subnetwork's primary and secondary ranges to conflict with routes # that have already been configured on the corresponding network. Static routes # will take precedence over the subnetwork route if the route prefix length is # at least as large as the subnetwork prefix length. # Also, packets destined to IPs within subnetwork may contain private/sensitive # data and are prevented from leaving the virtual network. Setting this field to # true will disable this feature. # The default value is false and applies to all existing subnetworks and # automatically created subnetworks. # This field cannot be set to true at resource creation time. # Corresponds to the JSON property `allowSubnetCidrRoutesOverlap` # @return [Boolean] attr_accessor :allow_subnet_cidr_routes_overlap alias_method :allow_subnet_cidr_routes_overlap?, :allow_subnet_cidr_routes_overlap # [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. This field can be set only at resource creation time. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Whether to enable flow logging for this subnetwork. # Corresponds to the JSON property `enableFlowLogs` # @return [Boolean] attr_accessor :enable_flow_logs alias_method :enable_flow_logs?, :enable_flow_logs # Whether the VMs in this subnet can directly access Google services via # internal IPv6 addresses. This field can be both set at resource creation time # and updated using patch. # Corresponds to the JSON property `enablePrivateV6Access` # @return [Boolean] attr_accessor :enable_private_v6_access alias_method :enable_private_v6_access?, :enable_private_v6_access # Fingerprint of this resource. A hash of the contents stored in this object. # This field is used in optimistic locking. This field will be ignored when # inserting a Subnetwork. An up-to-date fingerprint must be provided in order to # update the Subnetwork. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # [Output Only] The gateway address for default routes to reach destination # addresses outside this subnetwork. # Corresponds to the JSON property `gatewayAddress` # @return [String] attr_accessor :gateway_address # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The range of internal addresses that are owned by this subnetwork. Provide # this property when you create the subnetwork. For example, 10.0.0.0/8 or 192. # 168.0.0/16. Ranges must be unique and non-overlapping within a network. Only # IPv4 is supported. This field can be set only at resource creation time. # Corresponds to the JSON property `ipCidrRange` # @return [String] attr_accessor :ip_cidr_range # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork # resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the resource, provided by the client when initially creating the # resource. 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 # The URL of the network to which this subnetwork belongs, provided by the # client when initially creating the subnetwork. Only networks that are in the # distributed mode can have subnetworks. This field can be set only at resource # creation time. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Whether the VMs in this subnet can access Google services without assigned # external IP addresses. This field can be both set at resource creation time # and updated using setPrivateIpGoogleAccess. # Corresponds to the JSON property `privateIpGoogleAccess` # @return [Boolean] attr_accessor :private_ip_google_access alias_method :private_ip_google_access?, :private_ip_google_access # URL of the region where the Subnetwork resides. This field can be set only at # resource creation time. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # An array of configurations for secondary IP ranges for VM instances contained # in this subnetwork. The primary IP of such VM must belong to the primary # ipCidrRange of the subnetwork. The alias IPs may belong to either primary or # secondary ranges. # Corresponds to the JSON property `secondaryIpRanges` # @return [Array] attr_accessor :secondary_ip_ranges # [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) @allow_subnet_cidr_routes_overlap = args[:allow_subnet_cidr_routes_overlap] if args.key?(:allow_subnet_cidr_routes_overlap) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @enable_flow_logs = args[:enable_flow_logs] if args.key?(:enable_flow_logs) @enable_private_v6_access = args[:enable_private_v6_access] if args.key?(:enable_private_v6_access) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @gateway_address = args[:gateway_address] if args.key?(:gateway_address) @id = args[:id] if args.key?(:id) @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @private_ip_google_access = args[:private_ip_google_access] if args.key?(:private_ip_google_access) @region = args[:region] if args.key?(:region) @secondary_ip_ranges = args[:secondary_ip_ranges] if args.key?(:secondary_ip_ranges) @self_link = args[:self_link] if args.key?(:self_link) end end # class SubnetworkAggregatedList 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 SubnetworksScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#subnetworkAggregatedList for # aggregated lists of subnetworks. # 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::SubnetworkAggregatedList::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 # Contains a list of Subnetwork resources. class SubnetworkList 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 Subnetwork resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#subnetworkList for lists of # subnetworks. # 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::SubnetworkList::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 # Represents a secondary IP range of a subnetwork. class SubnetworkSecondaryRange include Google::Apis::Core::Hashable # The range of IP addresses belonging to this subnetwork secondary range. # Provide this property when you create the subnetwork. Ranges must be unique # and non-overlapping with all primary and secondary IP ranges within a network. # Only IPv4 is supported. # Corresponds to the JSON property `ipCidrRange` # @return [String] attr_accessor :ip_cidr_range # The name associated with this subnetwork secondary range, used when adding an # alias IP range to a VM instance. The name must be 1-63 characters long, and # comply with RFC1035. The name must be unique within the subnetwork. # Corresponds to the JSON property `rangeName` # @return [String] attr_accessor :range_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range) @range_name = args[:range_name] if args.key?(:range_name) end end # class SubnetworksExpandIpCidrRangeRequest include Google::Apis::Core::Hashable # The IP (in CIDR format or netmask) of internal addresses that are legal on # this Subnetwork. This range should be disjoint from other subnetworks within # this network. This range can only be larger than (i.e. a superset of) the # range previously defined before the update. # Corresponds to the JSON property `ipCidrRange` # @return [String] attr_accessor :ip_cidr_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range) end end # class SubnetworksScopedList include Google::Apis::Core::Hashable # List of subnetworks contained in this scope. # Corresponds to the JSON property `subnetworks` # @return [Array] attr_accessor :subnetworks # An informational warning that appears when the list of addresses is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::SubnetworksScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @subnetworks = args[:subnetworks] if args.key?(:subnetworks) @warning = args[:warning] if args.key?(:warning) end # An informational warning that appears when the list of addresses is empty. 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 # class SubnetworksSetPrivateIpGoogleAccessRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `privateIpGoogleAccess` # @return [Boolean] attr_accessor :private_ip_google_access alias_method :private_ip_google_access?, :private_ip_google_access def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @private_ip_google_access = args[:private_ip_google_access] if args.key?(:private_ip_google_access) end end # class TcpHealthCheck include Google::Apis::Core::Hashable # The TCP port number for the health check request. The default value is 80. # Valid values are 1 through 65535. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port # Port name as defined in InstanceGroup#NamedPort#name. If both port and # port_name are defined, port takes precedence. # Corresponds to the JSON property `portName` # @return [String] attr_accessor :port_name # Specifies how port is selected for health checking, can be one of following # values: # USE_FIXED_PORT: The port number in # port # is used for health checking. # USE_NAMED_PORT: The # portName # is used for health checking. # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each # network endpoint is used for health checking. For other backends, the port or # named port specified in the Backend Service is used for health checking. # If not specified, TCP health check follows behavior specified in # port # and # portName # fields. # Corresponds to the JSON property `portSpecification` # @return [String] attr_accessor :port_specification # Specifies the type of proxy header to append before sending data to the # backend, either NONE or PROXY_V1. The default is NONE. # Corresponds to the JSON property `proxyHeader` # @return [String] attr_accessor :proxy_header # The application data to send once the TCP connection has been established ( # default value is empty). If both request and response are empty, the # connection establishment alone will indicate health. The request data can only # be ASCII. # Corresponds to the JSON property `request` # @return [String] attr_accessor :request # The bytes to match against the beginning of the response data. If left empty ( # the default value), any response will indicate health. The response data can # only be ASCII. # Corresponds to the JSON property `response` # @return [String] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @port = args[:port] if args.key?(:port) @port_name = args[:port_name] if args.key?(:port_name) @port_specification = args[:port_specification] if args.key?(:port_specification) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) @request = args[:request] if args.key?(:request) @response = args[:response] if args.key?(:response) end end # A set of instance tags. class Tags include Google::Apis::Core::Hashable # Specifies a fingerprint for this request, which is essentially a hash of the # metadata's contents and used for optimistic locking. The fingerprint is # initially generated by Compute Engine and changes after every request to # modify or update metadata. You must always provide an up-to-date fingerprint # hash in order to update or change metadata. # To see the latest fingerprint, make get() request to the instance. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # An array of tags. Each tag must be 1-63 characters long, and comply with # RFC1035. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @items = args[:items] if args.key?(:items) end end # A TargetHttpProxy resource. This resource defines an HTTP proxy. (== # resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies = # =) class TargetHttpProxy include Google::Apis::Core::Hashable # [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. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP # proxies. # 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 # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # URL to the UrlMap resource that defines the mapping from URL to the # BackendService. # Corresponds to the JSON property `urlMap` # @return [String] attr_accessor :url_map def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @self_link = args[:self_link] if args.key?(:self_link) @url_map = args[:url_map] if args.key?(:url_map) end end # A list of TargetHttpProxy resources. class TargetHttpProxyList 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 TargetHttpProxy resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP # proxies. # 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::TargetHttpProxyList::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 # class TargetHttpsProxiesSetQuicOverrideRequest include Google::Apis::Core::Hashable # QUIC policy for the TargetHttpsProxy resource. # Corresponds to the JSON property `quicOverride` # @return [String] attr_accessor :quic_override def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @quic_override = args[:quic_override] if args.key?(:quic_override) end end # class TargetHttpsProxiesSetSslCertificatesRequest include Google::Apis::Core::Hashable # New set of SslCertificate resources to associate with this TargetHttpsProxy # resource. Currently exactly one SslCertificate resource must be specified. # Corresponds to the JSON property `sslCertificates` # @return [Array] attr_accessor :ssl_certificates def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates) end end # A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== # resource_for beta.targetHttpsProxies ==) (== resource_for v1. # targetHttpsProxies ==) class TargetHttpsProxy include Google::Apis::Core::Hashable # URL to ClientSslPolicy resource which controls the set of allowed SSL versions # and ciphers. # Corresponds to the JSON property `clientSslPolicy` # @return [String] attr_accessor :client_ssl_policy # [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. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of resource. Always compute#targetHttpsProxy for target # HTTPS proxies. # 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 # Specifies the QUIC override policy for this TargetHttpsProxy resource. This # determines whether the load balancer will attempt to negotiate QUIC with # clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to # always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when # set to DISABLE. If NONE is specified, uses the QUIC policy with no user # overrides, which is equivalent to DISABLE. Not specifying this field is # equivalent to specifying NONE. # Corresponds to the JSON property `quicOverride` # @return [String] attr_accessor :quic_override # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # URLs to SslCertificate resources that are used to authenticate connections # between users and the load balancer. Currently, exactly one SSL certificate # must be specified. # Corresponds to the JSON property `sslCertificates` # @return [Array] attr_accessor :ssl_certificates # URL of SslPolicy resource that will be associated with the TargetHttpsProxy # resource. If not set, the TargetHttpsProxy resource will not have any SSL # policy configured. # Corresponds to the JSON property `sslPolicy` # @return [String] attr_accessor :ssl_policy # A fully-qualified or valid partial URL to the UrlMap resource that defines the # mapping from URL to the BackendService. For example, the following are all # valid URLs for specifying a URL map: # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map # - projects/project/global/urlMaps/url-map # - global/urlMaps/url-map # Corresponds to the JSON property `urlMap` # @return [String] attr_accessor :url_map def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_ssl_policy = args[:client_ssl_policy] if args.key?(:client_ssl_policy) @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) @quic_override = args[:quic_override] if args.key?(:quic_override) @self_link = args[:self_link] if args.key?(:self_link) @ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates) @ssl_policy = args[:ssl_policy] if args.key?(:ssl_policy) @url_map = args[:url_map] if args.key?(:url_map) end end # Contains a list of TargetHttpsProxy resources. class TargetHttpsProxyList 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 TargetHttpsProxy resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. Always compute#targetHttpsProxyList for lists of target # HTTPS proxies. # 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::TargetHttpsProxyList::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 TargetInstance resource. This resource defines an endpoint instance that # terminates traffic of certain protocols. (== resource_for beta.targetInstances # ==) (== resource_for v1.targetInstances ==) class TargetInstance include Google::Apis::Core::Hashable # [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. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # A URL to the virtual machine instance that handles traffic for this target # instance. When creating a target instance, you can provide the fully-qualified # URL or a valid partial URL to the desired virtual machine. For example, the # following are all valid URLs: # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ # instance # - projects/project/zones/zone/instances/instance # - zones/zone/instances/instance # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # [Output Only] The type of the resource. Always compute#targetInstance for # target instances. # 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 # NAT option controlling how IPs are NAT'ed to the instance. Currently only # NO_NAT (default value) is supported. # Corresponds to the JSON property `natPolicy` # @return [String] attr_accessor :nat_policy # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] URL of the zone where the target instance resides. 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 `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @instance = args[:instance] if args.key?(:instance) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @nat_policy = args[:nat_policy] if args.key?(:nat_policy) @self_link = args[:self_link] if args.key?(:self_link) @zone = args[:zone] if args.key?(:zone) end end # class TargetInstanceAggregatedList 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 TargetInstance resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # Type of resource. # 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::TargetInstanceAggregatedList::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 # Contains a list of TargetInstance resources. class TargetInstanceList 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 TargetInstance resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::TargetInstanceList::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 # class TargetInstancesScopedList include Google::Apis::Core::Hashable # List of target instances contained in this scope. # Corresponds to the JSON property `targetInstances` # @return [Array] attr_accessor :target_instances # Informational warning which replaces the list of addresses when the list is # empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::TargetInstancesScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @target_instances = args[:target_instances] if args.key?(:target_instances) @warning = args[:warning] if args.key?(:warning) end # Informational warning which replaces the list of addresses when the list is # empty. 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 TargetPool resource. This resource defines a pool of instances, an # associated HttpHealthCheck resource, and the fallback target pool. (== # resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) class TargetPool include Google::Apis::Core::Hashable # This field is applicable only when the containing target pool is serving a # forwarding rule as the primary pool, and its failoverRatio field is properly # set to a value between [0, 1]. # backupPool and failoverRatio together define the fallback behavior of the # primary target pool: if the ratio of the healthy instances in the primary pool # is at or below failoverRatio, traffic arriving at the load-balanced IP will be # directed to the backup pool. # In case where failoverRatio and backupPool are not set, or all the instances # in the backup pool are unhealthy, the traffic will be directed back to the # primary pool in the "force" mode, where traffic will be spread to the healthy # instances with the best effort, or to all instances when no instance is # healthy. # Corresponds to the JSON property `backupPool` # @return [String] attr_accessor :backup_pool # [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 # This field is applicable only when the containing target pool is serving a # forwarding rule as the primary pool (i.e., not as a backup pool to some other # target pool). The value of the field must be in [0, 1]. # If set, backupPool must also be set. They together define the fallback # behavior of the primary target pool: if the ratio of the healthy instances in # the primary pool is at or below this number, traffic arriving at the load- # balanced IP will be directed to the backup pool. # In case where failoverRatio is not set or all the instances in the backup pool # are unhealthy, the traffic will be directed back to the primary pool in the " # force" mode, where traffic will be spread to the healthy instances with the # best effort, or to all instances when no instance is healthy. # Corresponds to the JSON property `failoverRatio` # @return [Float] attr_accessor :failover_ratio # The URL of the HttpHealthCheck resource. A member instance in this pool is # considered healthy if and only if the health checks pass. An empty list means # all member instances will be considered healthy at all times. Only # HttpHealthChecks are supported. Only one health check may be specified. # Corresponds to the JSON property `healthChecks` # @return [Array] attr_accessor :health_checks # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # A list of resource URLs to the virtual machine instances serving this pool. # They must live in zones contained in the same region as this pool. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances # [Output Only] Type of the resource. Always compute#targetPool for target pools. # 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 # [Output Only] URL of the region where the target pool resides. # 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 # Sesssion affinity option, must be one of the following values: # NONE: Connections from the same client IP may go to any instance in the pool. # CLIENT_IP: Connections from the same client IP will go to the same instance in # the pool while that instance remains healthy. # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol # will go to the same instance in the pool while that instance remains healthy. # Corresponds to the JSON property `sessionAffinity` # @return [String] attr_accessor :session_affinity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @backup_pool = args[:backup_pool] if args.key?(:backup_pool) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @failover_ratio = args[:failover_ratio] if args.key?(:failover_ratio) @health_checks = args[:health_checks] if args.key?(:health_checks) @id = args[:id] if args.key?(:id) @instances = args[:instances] if args.key?(:instances) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @session_affinity = args[:session_affinity] if args.key?(:session_affinity) end end # class TargetPoolAggregatedList 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 TargetPool resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for # aggregated lists of target pools. # 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::TargetPoolAggregatedList::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 # class TargetPoolInstanceHealth include Google::Apis::Core::Hashable # # Corresponds to the JSON property `healthStatus` # @return [Array] attr_accessor :health_status # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when # checking the health of an instance. # 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) @health_status = args[:health_status] if args.key?(:health_status) @kind = args[:kind] if args.key?(:kind) end end # Contains a list of TargetPool resources. class TargetPoolList 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 TargetPool resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#targetPoolList for lists of # target pools. # 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::TargetPoolList::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 # class TargetPoolsAddHealthCheckRequest include Google::Apis::Core::Hashable # The HttpHealthCheck to add to the target pool. # Corresponds to the JSON property `healthChecks` # @return [Array] attr_accessor :health_checks def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @health_checks = args[:health_checks] if args.key?(:health_checks) end end # class TargetPoolsAddInstanceRequest include Google::Apis::Core::Hashable # A full or partial URL to an instance to add to this target pool. This can be a # full or partial URL. For example, the following are valid URLs: # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/ # instances/instance-name # - projects/project-id/zones/zone/instances/instance-name # - zones/zone/instances/instance-name # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class TargetPoolsRemoveHealthCheckRequest include Google::Apis::Core::Hashable # Health check URL to be removed. This can be a full or valid partial URL. For # example, the following are valid URLs: # - https://www.googleapis.com/compute/beta/projects/project/global/ # httpHealthChecks/health-check # - projects/project/global/httpHealthChecks/health-check # - global/httpHealthChecks/health-check # Corresponds to the JSON property `healthChecks` # @return [Array] attr_accessor :health_checks def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @health_checks = args[:health_checks] if args.key?(:health_checks) end end # class TargetPoolsRemoveInstanceRequest include Google::Apis::Core::Hashable # URLs of the instances to be removed from target pool. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instances = args[:instances] if args.key?(:instances) end end # class TargetPoolsScopedList include Google::Apis::Core::Hashable # List of target pools contained in this scope. # Corresponds to the JSON property `targetPools` # @return [Array] attr_accessor :target_pools # Informational warning which replaces the list of addresses when the list is # empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::TargetPoolsScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @target_pools = args[:target_pools] if args.key?(:target_pools) @warning = args[:warning] if args.key?(:warning) end # Informational warning which replaces the list of addresses when the list is # empty. 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 # class TargetReference include Google::Apis::Core::Hashable # # Corresponds to the JSON property `target` # @return [String] attr_accessor :target def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @target = args[:target] if args.key?(:target) end end # class TargetSslProxiesSetBackendServiceRequest include Google::Apis::Core::Hashable # The URL of the new BackendService resource for the targetSslProxy. # 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) @service = args[:service] if args.key?(:service) end end # class TargetSslProxiesSetProxyHeaderRequest include Google::Apis::Core::Hashable # The new type of proxy header to append before sending data to the backend. # NONE or PROXY_V1 are allowed. # Corresponds to the JSON property `proxyHeader` # @return [String] attr_accessor :proxy_header def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) end end # class TargetSslProxiesSetSslCertificatesRequest include Google::Apis::Core::Hashable # New set of URLs to SslCertificate resources to associate with this # TargetSslProxy. Currently exactly one ssl certificate must be specified. # Corresponds to the JSON property `sslCertificates` # @return [Array] attr_accessor :ssl_certificates def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates) end end # A TargetSslProxy resource. This resource defines an SSL proxy. (== # resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) class TargetSslProxy include Google::Apis::Core::Hashable # URL to ClientSslPolicy resource which controls the set of allowed SSL versions # and ciphers. # Corresponds to the JSON property `clientSslPolicy` # @return [String] attr_accessor :client_ssl_policy # [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. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#targetSslProxy for target # SSL proxies. # 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 # Specifies the type of proxy header to append before sending data to the # backend, either NONE or PROXY_V1. The default is NONE. # Corresponds to the JSON property `proxyHeader` # @return [String] attr_accessor :proxy_header # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # URL to the BackendService resource. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service # URLs to SslCertificate resources that are used to authenticate connections to # Backends. Currently exactly one SSL certificate must be specified. # Corresponds to the JSON property `sslCertificates` # @return [Array] attr_accessor :ssl_certificates # URL of SslPolicy resource that will be associated with the TargetSslProxy # resource. If not set, the TargetSslProxy resource will not have any SSL policy # configured. # Corresponds to the JSON property `sslPolicy` # @return [String] attr_accessor :ssl_policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_ssl_policy = args[:client_ssl_policy] if args.key?(:client_ssl_policy) @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) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) @self_link = args[:self_link] if args.key?(:self_link) @service = args[:service] if args.key?(:service) @ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates) @ssl_policy = args[:ssl_policy] if args.key?(:ssl_policy) end end # Contains a list of TargetSslProxy resources. class TargetSslProxyList 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 TargetSslProxy resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::TargetSslProxyList::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 # class TargetTcpProxiesSetBackendServiceRequest include Google::Apis::Core::Hashable # The URL of the new BackendService resource for the targetTcpProxy. # 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) @service = args[:service] if args.key?(:service) end end # class TargetTcpProxiesSetProxyHeaderRequest include Google::Apis::Core::Hashable # The new type of proxy header to append before sending data to the backend. # NONE or PROXY_V1 are allowed. # Corresponds to the JSON property `proxyHeader` # @return [String] attr_accessor :proxy_header def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) end end # A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for # beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) class TargetTcpProxy include Google::Apis::Core::Hashable # [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. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#targetTcpProxy for target # TCP proxies. # 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 # Specifies the type of proxy header to append before sending data to the # backend, either NONE or PROXY_V1. The default is NONE. # Corresponds to the JSON property `proxyHeader` # @return [String] attr_accessor :proxy_header # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # URL to the BackendService resource. # 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) @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) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) @self_link = args[:self_link] if args.key?(:self_link) @service = args[:service] if args.key?(:service) end end # Contains a list of TargetTcpProxy resources. class TargetTcpProxyList 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 TargetTcpProxy resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::TargetTcpProxyList::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 # Represents a Target VPN gateway resource. (== resource_for beta. # targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) class TargetVpnGateway include Google::Apis::Core::Hashable # [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] A list of URLs to the ForwardingRule resources. ForwardingRules # are created using compute.forwardingRules.insert and associated to a VPN # gateway. # Corresponds to the JSON property `forwardingRules` # @return [Array] attr_accessor :forwarding_rules # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN # gateways. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for the labels being applied to this TargetVpnGateway, which is # essentially a hash of the labels set used for optimistic locking. The # fingerprint is initially generated by Compute Engine and changes after every # request to modify or update labels. You must always provide an up-to-date # fingerprint hash in order to update or change labels. # To see the latest fingerprint, make a get() request to retrieve an # TargetVpnGateway. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # 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 # URL of the network to which this VPN gateway is attached. Provided by the # client when the VPN gateway is created. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # [Output Only] URL of the region where the target VPN gateway resides. 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 # [Output Only] The status of the VPN gateway. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created # using compute.vpntunnels.insert method and associated to a VPN gateway. # Corresponds to the JSON property `tunnels` # @return [Array] attr_accessor :tunnels def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @forwarding_rules = args[:forwarding_rules] if args.key?(:forwarding_rules) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) @tunnels = args[:tunnels] if args.key?(:tunnels) end end # class TargetVpnGatewayAggregatedList 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 TargetVpnGateway resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN # gateways. # 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::TargetVpnGatewayAggregatedList::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 # Contains a list of TargetVpnGateway resources. class TargetVpnGatewayList 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 TargetVpnGateway resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN # gateways. # 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::TargetVpnGatewayList::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 # class TargetVpnGatewaysScopedList include Google::Apis::Core::Hashable # [Output Only] List of target vpn gateways contained in this scope. # Corresponds to the JSON property `targetVpnGateways` # @return [Array] attr_accessor :target_vpn_gateways # [Output Only] Informational warning which replaces the list of addresses when # the list is empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::TargetVpnGatewaysScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @target_vpn_gateways = args[:target_vpn_gateways] if args.key?(:target_vpn_gateways) @warning = args[:warning] if args.key?(:warning) end # [Output Only] Informational warning which replaces the list of addresses when # the list is empty. 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 # class TestFailure include Google::Apis::Core::Hashable # # Corresponds to the JSON property `actualService` # @return [String] attr_accessor :actual_service # # Corresponds to the JSON property `expectedService` # @return [String] attr_accessor :expected_service # # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # # Corresponds to the JSON property `path` # @return [String] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @actual_service = args[:actual_service] if args.key?(:actual_service) @expected_service = args[:expected_service] if args.key?(:expected_service) @host = args[:host] if args.key?(:host) @path = args[:path] if args.key?(:path) end end # class TestPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the 'resource'. Permissions with wildcards # (such as '*' or 'storage.*') are not 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 # class TestPermissionsResponse 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 # class UdpHealthCheck include Google::Apis::Core::Hashable # The UDP port number for the health check request. Valid values are 1 through # 65535. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port # Port name as defined in InstanceGroup#NamedPort#name. If both port and # port_name are defined, port takes precedence. # Corresponds to the JSON property `portName` # @return [String] attr_accessor :port_name # Raw data of request to send in payload of UDP packet. It is an error if this # is empty. The request data can only be ASCII. # Corresponds to the JSON property `request` # @return [String] attr_accessor :request # The bytes to match against the beginning of the response data. It is an error # if this is empty. The response data can only be ASCII. # Corresponds to the JSON property `response` # @return [String] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @port = args[:port] if args.key?(:port) @port_name = args[:port_name] if args.key?(:port_name) @request = args[:request] if args.key?(:request) @response = args[:response] if args.key?(:response) end end # A UrlMap resource. This resource defines the mapping from URL to the # BackendService resource, based on the "longest-match" of the URL's host and # path. class UrlMap include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # The URL of the BackendService resource if none of the hostRules match. # Corresponds to the JSON property `defaultService` # @return [String] attr_accessor :default_service # 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 # Fingerprint of this resource. A hash of the contents stored in this object. # This field is used in optimistic locking. This field will be ignored when # inserting a UrlMap. An up-to-date fingerprint must be provided in order to # update the UrlMap. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint # The list of HostRules to use against the URL. # Corresponds to the JSON property `hostRules` # @return [Array] attr_accessor :host_rules # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#urlMaps for url maps. # 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 # The list of named PathMatchers to use against the URL. # Corresponds to the JSON property `pathMatchers` # @return [Array] attr_accessor :path_matchers # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # The list of expected URL mapping tests. Request to update this UrlMap will # succeed only if all of the test cases pass. You can specify a maximum of 100 # tests per UrlMap. # Corresponds to the JSON property `tests` # @return [Array] attr_accessor :tests def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @default_service = args[:default_service] if args.key?(:default_service) @description = args[:description] if args.key?(:description) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @host_rules = args[:host_rules] if args.key?(:host_rules) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @path_matchers = args[:path_matchers] if args.key?(:path_matchers) @self_link = args[:self_link] if args.key?(:self_link) @tests = args[:tests] if args.key?(:tests) end end # Contains a list of UrlMap resources. class UrlMapList 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 UrlMap resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::UrlMapList::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 # class UrlMapReference include Google::Apis::Core::Hashable # # Corresponds to the JSON property `urlMap` # @return [String] attr_accessor :url_map def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @url_map = args[:url_map] if args.key?(:url_map) end end # Message for the expected URL mappings. class UrlMapTest include Google::Apis::Core::Hashable # Description of this test case. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Host portion of the URL. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # Path portion of the URL. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # Expected BackendService resource the given URL should be mapped to. # 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) @description = args[:description] if args.key?(:description) @host = args[:host] if args.key?(:host) @path = args[:path] if args.key?(:path) @service = args[:service] if args.key?(:service) end end # Message representing the validation result for a UrlMap. class UrlMapValidationResult include Google::Apis::Core::Hashable # # Corresponds to the JSON property `loadErrors` # @return [Array] attr_accessor :load_errors # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' # indicates the reasons. # Corresponds to the JSON property `loadSucceeded` # @return [Boolean] attr_accessor :load_succeeded alias_method :load_succeeded?, :load_succeeded # # Corresponds to the JSON property `testFailures` # @return [Array] attr_accessor :test_failures # If successfully loaded, this field indicates whether the test passed. If false, # 'testFailures's indicate the reason of failure. # Corresponds to the JSON property `testPassed` # @return [Boolean] attr_accessor :test_passed alias_method :test_passed?, :test_passed def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @load_errors = args[:load_errors] if args.key?(:load_errors) @load_succeeded = args[:load_succeeded] if args.key?(:load_succeeded) @test_failures = args[:test_failures] if args.key?(:test_failures) @test_passed = args[:test_passed] if args.key?(:test_passed) end end # class UrlMapsValidateRequest include Google::Apis::Core::Hashable # A UrlMap resource. This resource defines the mapping from URL to the # BackendService resource, based on the "longest-match" of the URL's host and # path. # Corresponds to the JSON property `resource` # @return [Google::Apis::ComputeAlpha::UrlMap] attr_accessor :resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource = args[:resource] if args.key?(:resource) end end # class UrlMapsValidateResponse include Google::Apis::Core::Hashable # Message representing the validation result for a UrlMap. # Corresponds to the JSON property `result` # @return [Google::Apis::ComputeAlpha::UrlMapValidationResult] 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 # Subnetwork which the current user has compute.subnetworks.use permission on. class UsableSubnetwork include Google::Apis::Core::Hashable # The range of internal addresses that are owned by this subnetwork. # Corresponds to the JSON property `ipCidrRange` # @return [String] attr_accessor :ip_cidr_range # Network URL. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Subnetwork URL. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range) @network = args[:network] if args.key?(:network) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) end end # class UsableSubnetworksAggregatedList include Google::Apis::Core::Hashable # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # [Output] A list of usable subnetwork URLs. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList # for aggregated lists of usable subnetworks. # 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::UsableSubnetworksAggregatedList::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 # The location in Cloud Storage and naming method of the daily usage report. # Contains bucket_name and report_name prefix. class UsageExportLocation include Google::Apis::Core::Hashable # The name of an existing bucket in Cloud Storage where the usage report object # is stored. The Google Service Account is granted write access to this bucket. # This can either be the bucket name by itself, such as example-bucket, or the # bucket name with gs:// or https://storage.googleapis.com/ in front of it, such # as gs://example-bucket. # Corresponds to the JSON property `bucketName` # @return [String] attr_accessor :bucket_name # An optional prefix for the name of the usage report object stored in # bucketName. If not supplied, defaults to usage. The report is stored as a CSV # file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of # the usage according to Pacific Time. If you supply a prefix, it should conform # to Cloud Storage object naming conventions. # Corresponds to the JSON property `reportNamePrefix` # @return [String] attr_accessor :report_name_prefix def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_name = args[:bucket_name] if args.key?(:bucket_name) @report_name_prefix = args[:report_name_prefix] if args.key?(:report_name_prefix) end end # A Vm Maintenance Policy specifies what kind of infrastructure maintenance we # are allowed to perform on this VM and when. class VmMaintenancePolicy include Google::Apis::Core::Hashable # A maintenance window for VMs and disks. When set, we restrict our maintenance # operations to this window. # Corresponds to the JSON property `maintenanceWindow` # @return [Google::Apis::ComputeAlpha::MaintenanceWindow] attr_accessor :maintenance_window def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @maintenance_window = args[:maintenance_window] if args.key?(:maintenance_window) end end # VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1. # vpnTunnels ==) class VpnTunnel include Google::Apis::Core::Hashable # [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] Detailed status message for the VPN tunnel. # Corresponds to the JSON property `detailedStatus` # @return [String] attr_accessor :detailed_status # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # IKE protocol version to use when establishing the VPN tunnel with peer VPN # gateway. Acceptable IKE versions are 1 or 2. Default version is 2. # Corresponds to the JSON property `ikeVersion` # @return [Fixnum] attr_accessor :ike_version # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A fingerprint for the labels being applied to this VpnTunnel, which is # essentially a hash of the labels set used for optimistic locking. The # fingerprint is initially generated by Compute Engine and changes after every # request to modify or update labels. You must always provide an up-to-date # fingerprint hash in order to update or change labels. # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Local traffic selector to use when establishing the VPN tunnel with peer VPN # gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/ # 16. The ranges should be disjoint. Only IPv4 is supported. # Corresponds to the JSON property `localTrafficSelector` # @return [Array] attr_accessor :local_traffic_selector # 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 # IP address of the peer VPN gateway. Only IPv4 is supported. # Corresponds to the JSON property `peerIp` # @return [String] attr_accessor :peer_ip # [Output Only] URL of the region where the VPN tunnel resides. 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 # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN # gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/ # 16. The ranges should be disjoint. Only IPv4 is supported. # Corresponds to the JSON property `remoteTrafficSelector` # @return [Array] attr_accessor :remote_traffic_selector # URL of router resource to be used for dynamic routing. # Corresponds to the JSON property `router` # @return [String] attr_accessor :router # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Shared secret used to set the secure session between the Cloud VPN gateway and # the peer VPN gateway. # Corresponds to the JSON property `sharedSecret` # @return [String] attr_accessor :shared_secret # Hash of the shared secret. # Corresponds to the JSON property `sharedSecretHash` # @return [String] attr_accessor :shared_secret_hash # [Output Only] The status of the VPN tunnel. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # URL of the Target VPN gateway with which this VPN tunnel is associated. # Provided by the client when the VPN tunnel is created. # Corresponds to the JSON property `targetVpnGateway` # @return [String] attr_accessor :target_vpn_gateway def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @detailed_status = args[:detailed_status] if args.key?(:detailed_status) @id = args[:id] if args.key?(:id) @ike_version = args[:ike_version] if args.key?(:ike_version) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @local_traffic_selector = args[:local_traffic_selector] if args.key?(:local_traffic_selector) @name = args[:name] if args.key?(:name) @peer_ip = args[:peer_ip] if args.key?(:peer_ip) @region = args[:region] if args.key?(:region) @remote_traffic_selector = args[:remote_traffic_selector] if args.key?(:remote_traffic_selector) @router = args[:router] if args.key?(:router) @self_link = args[:self_link] if args.key?(:self_link) @shared_secret = args[:shared_secret] if args.key?(:shared_secret) @shared_secret_hash = args[:shared_secret_hash] if args.key?(:shared_secret_hash) @status = args[:status] if args.key?(:status) @target_vpn_gateway = args[:target_vpn_gateway] if args.key?(:target_vpn_gateway) end end # class VpnTunnelAggregatedList 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 VpnTunnelsScopedList resources. # Corresponds to the JSON property `items` # @return [Hash] attr_accessor :items # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. # 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::VpnTunnelAggregatedList::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 # Contains a list of VpnTunnel resources. class VpnTunnelList 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 VpnTunnel resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. # 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::VpnTunnelList::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 # class VpnTunnelsScopedList include Google::Apis::Core::Hashable # List of vpn tunnels contained in this scope. # Corresponds to the JSON property `vpnTunnels` # @return [Array] attr_accessor :vpn_tunnels # Informational warning which replaces the list of addresses when the list is # empty. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::VpnTunnelsScopedList::Warning] attr_accessor :warning def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @vpn_tunnels = args[:vpn_tunnels] if args.key?(:vpn_tunnels) @warning = args[:warning] if args.key?(:warning) end # Informational warning which replaces the list of addresses when the list is # empty. 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 # class XpnHostList 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 # [Output Only] A list of shared VPC host project URLs. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#xpnHostList for lists of shared # VPC hosts. # 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::XpnHostList::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 # Service resource (a.k.a service project) ID. class XpnResourceId include Google::Apis::Core::Hashable # The ID of the service resource. In the case of projects, this field matches # the project ID (e.g., my-project), not the project number (e.g., 12345678). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of the service resource. # 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) @id = args[:id] if args.key?(:id) @type = args[:type] if args.key?(:type) end end # A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones ==) class Zone include Google::Apis::Core::Hashable # [Output Only] Available cpu/platform selections for the zone. # Corresponds to the JSON property `availableCpuPlatforms` # @return [Array] attr_accessor :available_cpu_platforms # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # Deprecation status for a public resource. # Corresponds to the JSON property `deprecated` # @return [Google::Apis::ComputeAlpha::DeprecationStatus] attr_accessor :deprecated # [Output Only] Textual description of the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always compute#zone for zones. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] Full URL reference to the region which hosts the zone. # 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 # [Output Only] Status of the zone, either UP or DOWN. # 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) @available_cpu_platforms = args[:available_cpu_platforms] if args.key?(:available_cpu_platforms) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @deprecated = args[:deprecated] if args.key?(:deprecated) @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) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) end end # Contains a list of zone resources. class ZoneList 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 Zone resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of resource. # 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::ZoneList::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 # class ZoneSetLabelsRequest include Google::Apis::Core::Hashable # The fingerprint of the previous set of labels for this resource, used to # detect conflicts. The fingerprint is initially generated by Compute Engine and # changes after every request to modify or update labels. You must always # provide an up-to-date fingerprint hash in order to update or change labels. # Make a get() request to the resource to get the latest fingerprint. # Corresponds to the JSON property `labelFingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :label_fingerprint # The labels to set for this resource. # 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) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) end end end end end google-api-client-0.19.8/generated/google/apis/compute_alpha/service.rb0000644000004100000410000646374013252673043026145 0ustar www-datawww-data# 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 ComputeAlpha # Compute Engine API # # Creates and runs virtual machines on Google Cloud Platform. # # @example # require 'google/apis/compute_alpha' # # Compute = Google::Apis::ComputeAlpha # Alias the module # service = Compute::ComputeService.new # # @see https://developers.google.com/compute/docs/reference/latest/ class ComputeService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'compute/alpha/projects/') @batch_path = 'batch/compute/alpha' end # Retrieves an aggregated list of accelerator types. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_accelerator_type_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/acceleratorTypes', options) command.response_representation = Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList command.params['project'] = project unless project.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['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 accelerator type. Get a list of available accelerator # types by making a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] accelerator_type # Name of the accelerator type to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::AcceleratorType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::AcceleratorType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_accelerator_type(project, zone, accelerator_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/acceleratorTypes/{acceleratorType}', options) command.response_representation = Google::Apis::ComputeAlpha::AcceleratorType::Representation command.response_class = Google::Apis::ComputeAlpha::AcceleratorType command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['acceleratorType'] = accelerator_type unless accelerator_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 # Retrieves a list of accelerator types available to the specified project. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::AcceleratorTypeList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::AcceleratorTypeList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_accelerator_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/acceleratorTypes', options) command.response_representation = Google::Apis::ComputeAlpha::AcceleratorTypeList::Representation command.response_class = Google::Apis::ComputeAlpha::AcceleratorTypeList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 aggregated list of addresses. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::AddressAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::AddressAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_address_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/addresses', options) command.response_representation = Google::Apis::ComputeAlpha::AddressAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::AddressAggregatedList command.params['project'] = project unless project.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['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 address resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] address # Name of the address 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_address(project, region, address, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/addresses/{address}', 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['address'] = address unless address.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 address resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] address # Name of the address resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Address] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Address] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_address(project, region, address, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/addresses/{address}', options) command.response_representation = Google::Apis::ComputeAlpha::Address::Representation command.response_class = Google::Apis::ComputeAlpha::Address command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['address'] = address unless address.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 address resource in the specified project using the data included # in the request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [Google::Apis::ComputeAlpha::Address] address_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_address(project, region, address_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/addresses', options) command.request_representation = Google::Apis::ComputeAlpha::Address::Representation command.request_object = address_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 # Retrieves a list of addresses contained within the specified region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::AddressList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::AddressList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_addresses(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/addresses', options) command.response_representation = Google::Apis::ComputeAlpha::AddressList::Representation command.response_class = Google::Apis::ComputeAlpha::AddressList 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['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 labels on an Address. To learn more about labels, read the Labeling # Resources documentation. # @param [String] project # Project ID for this request. # @param [String] region # The region for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::RegionSetLabelsRequest] region_set_labels_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_address_labels(project, region, resource, region_set_labels_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/addresses/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::RegionSetLabelsRequest::Representation command.request_object = region_set_labels_request_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.params['resource'] = resource unless resource.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_address_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}/addresses/{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 # Retrieves an aggregated list of autoscalers. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::AutoscalerAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::AutoscalerAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_autoscaler_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/autoscalers', options) command.response_representation = Google::Apis::ComputeAlpha::AutoscalerAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::AutoscalerAggregatedList command.params['project'] = project unless project.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['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 autoscaler. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [String] autoscaler # Name of the autoscaler 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_autoscaler(project, zone, autoscaler, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/zones/{zone}/autoscalers/{autoscaler}', 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['zone'] = zone unless zone.nil? command.params['autoscaler'] = autoscaler unless autoscaler.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 autoscaler resource. Get a list of available autoscalers # by making a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [String] autoscaler # Name of the autoscaler to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Autoscaler] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Autoscaler] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_autoscaler(project, zone, autoscaler, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/autoscalers/{autoscaler}', options) command.response_representation = Google::Apis::ComputeAlpha::Autoscaler::Representation command.response_class = Google::Apis::ComputeAlpha::Autoscaler command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['autoscaler'] = autoscaler unless autoscaler.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 autoscaler in the specified project using the data included in the # request. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [Google::Apis::ComputeAlpha::Autoscaler] autoscaler_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_autoscaler(project, zone, autoscaler_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/autoscalers', options) command.request_representation = Google::Apis::ComputeAlpha::Autoscaler::Representation command.request_object = autoscaler_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['zone'] = zone unless zone.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 # Retrieves a list of autoscalers contained within the specified zone. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::AutoscalerList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::AutoscalerList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_autoscalers(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/autoscalers', options) command.response_representation = Google::Apis::ComputeAlpha::AutoscalerList::Representation command.response_class = Google::Apis::ComputeAlpha::AutoscalerList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 autoscaler in the specified project using the data included in the # request. This method supports PATCH semantics and uses the JSON merge patch # format and processing rules. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [Google::Apis::ComputeAlpha::Autoscaler] autoscaler_object # @param [String] autoscaler # Name of the autoscaler to patch. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_autoscaler(project, zone, autoscaler_object = nil, autoscaler: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/zones/{zone}/autoscalers', options) command.request_representation = Google::Apis::ComputeAlpha::Autoscaler::Representation command.request_object = autoscaler_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['zone'] = zone unless zone.nil? command.query['autoscaler'] = autoscaler unless autoscaler.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_autoscaler_iam_permissions(project, zone, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/autoscalers/{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['zone'] = zone unless zone.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 # Updates an autoscaler in the specified project using the data included in the # request. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [Google::Apis::ComputeAlpha::Autoscaler] autoscaler_object # @param [String] autoscaler # Name of the autoscaler to update. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_autoscaler(project, zone, autoscaler_object = nil, autoscaler: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/zones/{zone}/autoscalers', options) command.request_representation = Google::Apis::ComputeAlpha::Autoscaler::Representation command.request_object = autoscaler_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['zone'] = zone unless zone.nil? command.query['autoscaler'] = autoscaler unless autoscaler.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 # Adds the given Signed URL Key to the backend bucket. # @param [String] project # Project ID for this request. # @param [String] backend_bucket # Name of the BackendBucket resource to which the Signed URL Key should be added. # The name should conform to RFC1035. # @param [Google::Apis::ComputeAlpha::SignedUrlKey] signed_url_key_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 add_backend_bucket_signed_url_key(project, backend_bucket, signed_url_key_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey', options) command.request_representation = Google::Apis::ComputeAlpha::SignedUrlKey::Representation command.request_object = signed_url_key_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['backendBucket'] = backend_bucket unless backend_bucket.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 # Deletes the specified BackendBucket resource. # @param [String] project # Project ID for this request. # @param [String] backend_bucket # Name of the BackendBucket 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_backend_bucket(project, backend_bucket, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/backendBuckets/{backendBucket}', 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['backendBucket'] = backend_bucket unless backend_bucket.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 # Deletes the given Signed URL Key from the backend bucket. # @param [String] project # Project ID for this request. # @param [String] backend_bucket # Name of the BackendBucket resource to which the Signed URL Key should be added. # The name should conform to RFC1035. # @param [String] key_name # The name of the Signed URL Key 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_backend_bucket_signed_url_key(project, backend_bucket, key_name, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey', 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['backendBucket'] = backend_bucket unless backend_bucket.nil? command.query['keyName'] = key_name unless key_name.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 BackendBucket resource. Get a list of available backend # buckets by making a list() request. # @param [String] project # Project ID for this request. # @param [String] backend_bucket # Name of the BackendBucket resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::BackendBucket] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::BackendBucket] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_backend_bucket(project, backend_bucket, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/backendBuckets/{backendBucket}', options) command.response_representation = Google::Apis::ComputeAlpha::BackendBucket::Representation command.response_class = Google::Apis::ComputeAlpha::BackendBucket command.params['project'] = project unless project.nil? command.params['backendBucket'] = backend_bucket unless backend_bucket.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] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_backend_bucket_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/backendBuckets/{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['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 # Creates a BackendBucket resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::BackendBucket] backend_bucket_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_backend_bucket(project, backend_bucket_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendBuckets', options) command.request_representation = Google::Apis::ComputeAlpha::BackendBucket::Representation command.request_object = backend_bucket_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of BackendBucket resources available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::BackendBucketList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::BackendBucketList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_backend_buckets(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/backendBuckets', options) command.response_representation = Google::Apis::ComputeAlpha::BackendBucketList::Representation command.response_class = Google::Apis::ComputeAlpha::BackendBucketList command.params['project'] = project unless project.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['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 specified BackendBucket resource with the data included in the # request. This method supports PATCH semantics and uses the JSON merge patch # format and processing rules. # @param [String] project # Project ID for this request. # @param [String] backend_bucket # Name of the BackendBucket resource to patch. # @param [Google::Apis::ComputeAlpha::BackendBucket] backend_bucket_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_backend_bucket(project, backend_bucket, backend_bucket_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/backendBuckets/{backendBucket}', options) command.request_representation = Google::Apis::ComputeAlpha::BackendBucket::Representation command.request_object = backend_bucket_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['backendBucket'] = backend_bucket unless backend_bucket.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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @param [String] project # Project ID for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_backend_bucket_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendBuckets/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_backend_bucket_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendBuckets/{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['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 # Updates the specified BackendBucket resource with the data included in the # request. # @param [String] project # Project ID for this request. # @param [String] backend_bucket # Name of the BackendBucket resource to update. # @param [Google::Apis::ComputeAlpha::BackendBucket] backend_bucket_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_backend_bucket(project, backend_bucket, backend_bucket_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/backendBuckets/{backendBucket}', options) command.request_representation = Google::Apis::ComputeAlpha::BackendBucket::Representation command.request_object = backend_bucket_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['backendBucket'] = backend_bucket unless backend_bucket.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 # Adds the given Signed URL Key to the specified backend service. # @param [String] project # Project ID for this request. # @param [String] backend_service # Name of the BackendService resource to which the Signed URL Key should be # added. The name should conform to RFC1035. # @param [Google::Apis::ComputeAlpha::SignedUrlKey] signed_url_key_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 add_backend_service_signed_url_key(project, backend_service, signed_url_key_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendServices/{backendService}/addSignedUrlKey', options) command.request_representation = Google::Apis::ComputeAlpha::SignedUrlKey::Representation command.request_object = signed_url_key_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['backendService'] = backend_service unless backend_service.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 # Retrieves the list of all BackendService resources, regional and global, # available to the specified project. # @param [String] project # Name of the project scoping this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::BackendServiceAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::BackendServiceAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_backend_service_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/backendServices', options) command.response_representation = Google::Apis::ComputeAlpha::BackendServiceAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::BackendServiceAggregatedList command.params['project'] = project unless project.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['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 BackendService resource. # @param [String] project # Project ID for this request. # @param [String] backend_service # Name of the BackendService 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_backend_service(project, backend_service, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/backendServices/{backendService}', 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['backendService'] = backend_service unless backend_service.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 # Deletes the given Signed URL Key from the specified backend service. # @param [String] project # Project ID for this request. # @param [String] backend_service # Name of the BackendService resource to which the Signed URL Key should be # added. The name should conform to RFC1035. # @param [String] key_name # The name of the Signed URL Key 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_backend_service_signed_url_key(project, backend_service, key_name, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendServices/{backendService}/deleteSignedUrlKey', 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['backendService'] = backend_service unless backend_service.nil? command.query['keyName'] = key_name unless key_name.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 BackendService resource. Get a list of available backend # services by making a list() request. # @param [String] project # Project ID for this request. # @param [String] backend_service # Name of the BackendService resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::BackendService] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::BackendService] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_backend_service(project, backend_service, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/backendServices/{backendService}', options) command.response_representation = Google::Apis::ComputeAlpha::BackendService::Representation command.response_class = Google::Apis::ComputeAlpha::BackendService command.params['project'] = project unless project.nil? command.params['backendService'] = backend_service unless backend_service.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 most recent health check results for this BackendService. # @param [String] project # @param [String] backend_service # Name of the BackendService resource to which the queried instance belongs. # @param [Google::Apis::ComputeAlpha::ResourceGroupReference] resource_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::BackendServiceGroupHealth] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::BackendServiceGroupHealth] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_backend_service_health(project, backend_service, resource_group_reference_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendServices/{backendService}/getHealth', options) command.request_representation = Google::Apis::ComputeAlpha::ResourceGroupReference::Representation command.request_object = resource_group_reference_object command.response_representation = Google::Apis::ComputeAlpha::BackendServiceGroupHealth::Representation command.response_class = Google::Apis::ComputeAlpha::BackendServiceGroupHealth command.params['project'] = project unless project.nil? command.params['backendService'] = backend_service unless backend_service.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 BackendService resource in the specified project using the data # included in the request. There are several restrictions and guidelines to keep # in mind when creating a backend service. Read Restrictions and Guidelines for # more information. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::BackendService] backend_service_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_backend_service(project, backend_service_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendServices', options) command.request_representation = Google::Apis::ComputeAlpha::BackendService::Representation command.request_object = backend_service_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of BackendService resources available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::BackendServiceList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::BackendServiceList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_backend_services(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/backendServices', options) command.response_representation = Google::Apis::ComputeAlpha::BackendServiceList::Representation command.response_class = Google::Apis::ComputeAlpha::BackendServiceList command.params['project'] = project unless project.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['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 # Patches the specified BackendService resource with the data included in the # request. There are several restrictions and guidelines to keep in mind when # updating a backend service. Read Restrictions and Guidelines for more # information. This method supports PATCH semantics and uses the JSON merge # patch format and processing rules. # @param [String] project # Project ID for this request. # @param [String] backend_service # Name of the BackendService resource to patch. # @param [Google::Apis::ComputeAlpha::BackendService] backend_service_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_backend_service(project, backend_service, backend_service_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/backendServices/{backendService}', options) command.request_representation = Google::Apis::ComputeAlpha::BackendService::Representation command.request_object = backend_service_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['backendService'] = backend_service unless backend_service.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 # Sets the security policy for the specified backend service. # @param [String] project # Project ID for this request. # @param [String] backend_service # Name of the BackendService resource to which the security policy should be set. # The name should conform to RFC1035. # @param [Google::Apis::ComputeAlpha::SecurityPolicyReference] security_policy_reference_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_backend_service_security_policy(project, backend_service, security_policy_reference_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendServices/{backendService}/setSecurityPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::SecurityPolicyReference::Representation command.request_object = security_policy_reference_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['backendService'] = backend_service unless backend_service.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_backend_service_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/backendServices/{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['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 # Updates the specified BackendService resource with the data included in the # request. There are several restrictions and guidelines to keep in mind when # updating a backend service. Read Restrictions and Guidelines for more # information. # @param [String] project # Project ID for this request. # @param [String] backend_service # Name of the BackendService resource to update. # @param [Google::Apis::ComputeAlpha::BackendService] backend_service_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_backend_service(project, backend_service, backend_service_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/backendServices/{backendService}', options) command.request_representation = Google::Apis::ComputeAlpha::BackendService::Representation command.request_object = backend_service_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['backendService'] = backend_service unless backend_service.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_client_ssl_policy_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/clientSslPolicies/{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['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 # Retrieves an aggregated list of disk types. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::DiskTypeAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::DiskTypeAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_disk_type_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/diskTypes', options) command.response_representation = Google::Apis::ComputeAlpha::DiskTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::DiskTypeAggregatedList command.params['project'] = project unless project.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['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 disk type. Get a list of available disk types by making # a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] disk_type # Name of the disk type to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::DiskType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::DiskType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_disk_type(project, zone, disk_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/diskTypes/{diskType}', options) command.response_representation = Google::Apis::ComputeAlpha::DiskType::Representation command.response_class = Google::Apis::ComputeAlpha::DiskType command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['diskType'] = disk_type unless disk_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 # Retrieves a list of disk types available to the specified project. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::DiskTypeList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::DiskTypeList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_disk_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/diskTypes', options) command.response_representation = Google::Apis::ComputeAlpha::DiskTypeList::Representation command.response_class = Google::Apis::ComputeAlpha::DiskTypeList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 aggregated list of persistent disks. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::DiskAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::DiskAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_disk_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/disks', options) command.response_representation = Google::Apis::ComputeAlpha::DiskAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::DiskAggregatedList command.params['project'] = project unless project.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['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 snapshot of a specified persistent disk. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] disk # Name of the persistent disk to snapshot. # @param [Google::Apis::ComputeAlpha::Snapshot] snapshot_object # @param [Boolean] guest_flush # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 create_disk_snapshot(project, zone, disk, snapshot_object = nil, guest_flush: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/disks/{disk}/createSnapshot', options) command.request_representation = Google::Apis::ComputeAlpha::Snapshot::Representation command.request_object = snapshot_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['zone'] = zone unless zone.nil? command.params['disk'] = disk unless disk.nil? command.query['guestFlush'] = guest_flush unless guest_flush.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 # Deletes the specified persistent disk. Deleting a disk removes its data # permanently and is irreversible. However, deleting a disk does not delete any # snapshots previously made from the disk. You must separately delete snapshots. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] disk # Name of the persistent disk 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_disk(project, zone, disk, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/zones/{zone}/disks/{disk}', 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['zone'] = zone unless zone.nil? command.params['disk'] = disk unless disk.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 a specified persistent disk. Get a list of available persistent disks # by making a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] disk # Name of the persistent disk to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Disk] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Disk] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_disk(project, zone, disk, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/disks/{disk}', options) command.response_representation = Google::Apis::ComputeAlpha::Disk::Representation command.response_class = Google::Apis::ComputeAlpha::Disk command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['disk'] = disk unless disk.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] zone # The name of the zone for this request. # @param [String] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_disk_iam_policy(project, zone, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/disks/{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['zone'] = zone unless zone.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 # Creates a persistent disk in the specified project using the data in the # request. You can create a disk with a sourceImage, a sourceSnapshot, or create # an empty 500 GB data disk by omitting all properties. You can also create a # disk that is larger than the default size by specifying the sizeGb property. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [Google::Apis::ComputeAlpha::Disk] disk_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] source_image # Optional. Source image to restore onto a disk. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_disk(project, zone, disk_object = nil, request_id: nil, source_image: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/disks', options) command.request_representation = Google::Apis::ComputeAlpha::Disk::Representation command.request_object = disk_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['zone'] = zone unless zone.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['sourceImage'] = source_image unless source_image.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 persistent disks contained within the specified zone. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::DiskList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::DiskList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_disks(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/disks', options) command.response_representation = Google::Apis::ComputeAlpha::DiskList::Representation command.response_class = Google::Apis::ComputeAlpha::DiskList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 # Resizes the specified persistent disk. You can only increase the size of the # disk. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] disk # The name of the persistent disk. # @param [Google::Apis::ComputeAlpha::DisksResizeRequest] disks_resize_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 resize_disk(project, zone, disk, disks_resize_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/disks/{disk}/resize', options) command.request_representation = Google::Apis::ComputeAlpha::DisksResizeRequest::Representation command.request_object = disks_resize_request_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['zone'] = zone unless zone.nil? command.params['disk'] = disk unless disk.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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_disk_iam_policy(project, zone, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/disks/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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['zone'] = zone unless zone.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 # Sets the labels on a disk. To learn more about labels, read the Labeling # Resources documentation. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::ZoneSetLabelsRequest] zone_set_labels_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_disk_labels(project, zone, resource, zone_set_labels_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/disks/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::ZoneSetLabelsRequest::Representation command.request_object = zone_set_labels_request_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['zone'] = zone unless zone.nil? command.params['resource'] = resource unless resource.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_disk_iam_permissions(project, zone, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/disks/{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['zone'] = zone unless zone.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 firewall. # @param [String] project # Project ID for this request. # @param [String] firewall # Name of the firewall rule 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_firewall(project, firewall, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/firewalls/{firewall}', 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['firewall'] = firewall unless firewall.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 firewall. # @param [String] project # Project ID for this request. # @param [String] firewall # Name of the firewall rule to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Firewall] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Firewall] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_firewall(project, firewall, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/firewalls/{firewall}', options) command.response_representation = Google::Apis::ComputeAlpha::Firewall::Representation command.response_class = Google::Apis::ComputeAlpha::Firewall command.params['project'] = project unless project.nil? command.params['firewall'] = firewall unless firewall.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 firewall rule in the specified project using the data included in # the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::Firewall] firewall_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_firewall(project, firewall_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/firewalls', options) command.request_representation = Google::Apis::ComputeAlpha::Firewall::Representation command.request_object = firewall_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of firewall rules available to the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::FirewallList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::FirewallList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_firewalls(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/firewalls', options) command.response_representation = Google::Apis::ComputeAlpha::FirewallList::Representation command.response_class = Google::Apis::ComputeAlpha::FirewallList command.params['project'] = project unless project.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['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 specified firewall rule with the data included in the request. # This method supports PATCH semantics and uses the JSON merge patch format and # processing rules. # @param [String] project # Project ID for this request. # @param [String] firewall # Name of the firewall rule to patch. # @param [Google::Apis::ComputeAlpha::Firewall] firewall_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_firewall(project, firewall, firewall_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/firewalls/{firewall}', options) command.request_representation = Google::Apis::ComputeAlpha::Firewall::Representation command.request_object = firewall_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['firewall'] = firewall unless firewall.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_firewall_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/firewalls/{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['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 # Updates the specified firewall rule with the data included in the request. The # PUT method can only update the following fields of firewall rule: allowed, # description, sourceRanges, sourceTags, targetTags. # @param [String] project # Project ID for this request. # @param [String] firewall # Name of the firewall rule to update. # @param [Google::Apis::ComputeAlpha::Firewall] firewall_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_firewall(project, firewall, firewall_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/firewalls/{firewall}', options) command.request_representation = Google::Apis::ComputeAlpha::Firewall::Representation command.request_object = firewall_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['firewall'] = firewall unless firewall.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 # Retrieves an aggregated list of forwarding rules. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_forwarding_rule_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/forwardingRules', options) command.response_representation = Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList command.params['project'] = project unless project.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['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 ForwardingRule resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] forwarding_rule # Name of the ForwardingRule 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_forwarding_rule(project, region, forwarding_rule, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/forwardingRules/{forwardingRule}', 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['forwardingRule'] = forwarding_rule unless forwarding_rule.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 ForwardingRule resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] forwarding_rule # Name of the ForwardingRule resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::ForwardingRule] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::ForwardingRule] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_forwarding_rule(project, region, forwarding_rule, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/forwardingRules/{forwardingRule}', options) command.response_representation = Google::Apis::ComputeAlpha::ForwardingRule::Representation command.response_class = Google::Apis::ComputeAlpha::ForwardingRule command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['forwardingRule'] = forwarding_rule unless forwarding_rule.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 ForwardingRule resource in the specified project and region using # the data included in the request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [Google::Apis::ComputeAlpha::ForwardingRule] forwarding_rule_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_forwarding_rule(project, region, forwarding_rule_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/forwardingRules', options) command.request_representation = Google::Apis::ComputeAlpha::ForwardingRule::Representation command.request_object = forwarding_rule_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 # Retrieves a list of ForwardingRule resources available to the specified # project and region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::ForwardingRuleList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::ForwardingRuleList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_forwarding_rules(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/forwardingRules', options) command.response_representation = Google::Apis::ComputeAlpha::ForwardingRuleList::Representation command.response_class = Google::Apis::ComputeAlpha::ForwardingRuleList 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['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 specified forwarding rule with the data included in the request. # This method supports PATCH semantics and uses the JSON merge patch format and # processing rules. Currently, you can only patch the network_tier field. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] forwarding_rule # Name of the ForwardingRule resource to patch. # @param [Google::Apis::ComputeAlpha::ForwardingRule] forwarding_rule_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_forwarding_rule(project, region, forwarding_rule, forwarding_rule_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/regions/{region}/forwardingRules/{forwardingRule}', options) command.request_representation = Google::Apis::ComputeAlpha::ForwardingRule::Representation command.request_object = forwarding_rule_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.params['forwardingRule'] = forwarding_rule unless forwarding_rule.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 # Sets the labels on the specified resource. To learn more about labels, read # the Labeling Resources documentation. # @param [String] project # Project ID for this request. # @param [String] region # The region for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::RegionSetLabelsRequest] region_set_labels_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_forwarding_rule_labels(project, region, resource, region_set_labels_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/forwardingRules/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::RegionSetLabelsRequest::Representation command.request_object = region_set_labels_request_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.params['resource'] = resource unless resource.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 # Changes target URL for forwarding rule. The new target should be of the same # type as the old target. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] forwarding_rule # Name of the ForwardingRule resource in which target is to be set. # @param [Google::Apis::ComputeAlpha::TargetReference] target_reference_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_forwarding_rule_target(project, region, forwarding_rule, target_reference_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget', options) command.request_representation = Google::Apis::ComputeAlpha::TargetReference::Representation command.request_object = target_reference_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.params['forwardingRule'] = forwarding_rule unless forwarding_rule.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_forwarding_rule_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}/forwardingRules/{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 address resource. # @param [String] project # Project ID for this request. # @param [String] address # Name of the address 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_global_address(project, address, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/addresses/{address}', 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['address'] = address unless address.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 address resource. Get a list of available addresses by # making a list() request. # @param [String] project # Project ID for this request. # @param [String] address # Name of the address resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Address] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Address] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_global_address(project, address, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/addresses/{address}', options) command.response_representation = Google::Apis::ComputeAlpha::Address::Representation command.response_class = Google::Apis::ComputeAlpha::Address command.params['project'] = project unless project.nil? command.params['address'] = address unless address.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 address resource in the specified project using the data included # in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::Address] address_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_global_address(project, address_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/addresses', options) command.request_representation = Google::Apis::ComputeAlpha::Address::Representation command.request_object = address_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves a list of global addresses. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::AddressList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::AddressList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_global_addresses(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/addresses', options) command.response_representation = Google::Apis::ComputeAlpha::AddressList::Representation command.response_class = Google::Apis::ComputeAlpha::AddressList command.params['project'] = project unless project.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['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 labels on a GlobalAddress. To learn more about labels, read the # Labeling Resources documentation. # @param [String] project # Project ID for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::GlobalSetLabelsRequest] global_set_labels_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_global_address_labels(project, resource, global_set_labels_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/addresses/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::GlobalSetLabelsRequest::Representation command.request_object = global_set_labels_request_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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_global_address_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/addresses/{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['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 GlobalForwardingRule resource. # @param [String] project # Project ID for this request. # @param [String] forwarding_rule # Name of the ForwardingRule 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_global_forwarding_rule(project, forwarding_rule, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/forwardingRules/{forwardingRule}', 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['forwardingRule'] = forwarding_rule unless forwarding_rule.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 GlobalForwardingRule resource. Get a list of available # forwarding rules by making a list() request. # @param [String] project # Project ID for this request. # @param [String] forwarding_rule # Name of the ForwardingRule resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::ForwardingRule] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::ForwardingRule] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_global_forwarding_rule(project, forwarding_rule, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/forwardingRules/{forwardingRule}', options) command.response_representation = Google::Apis::ComputeAlpha::ForwardingRule::Representation command.response_class = Google::Apis::ComputeAlpha::ForwardingRule command.params['project'] = project unless project.nil? command.params['forwardingRule'] = forwarding_rule unless forwarding_rule.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 GlobalForwardingRule resource in the specified project using the # data included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::ForwardingRule] forwarding_rule_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_global_forwarding_rule(project, forwarding_rule_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/forwardingRules', options) command.request_representation = Google::Apis::ComputeAlpha::ForwardingRule::Representation command.request_object = forwarding_rule_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves a list of GlobalForwardingRule resources available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::ForwardingRuleList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::ForwardingRuleList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_global_forwarding_rules(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/forwardingRules', options) command.response_representation = Google::Apis::ComputeAlpha::ForwardingRuleList::Representation command.response_class = Google::Apis::ComputeAlpha::ForwardingRuleList command.params['project'] = project unless project.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['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 specified forwarding rule with the data included in the request. # This method supports PATCH semantics and uses the JSON merge patch format and # processing rules. Currently, you can only patch the network_tier field. # @param [String] project # Project ID for this request. # @param [String] forwarding_rule # Name of the ForwardingRule resource to patch. # @param [Google::Apis::ComputeAlpha::ForwardingRule] forwarding_rule_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_global_forwarding_rule(project, forwarding_rule, forwarding_rule_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/forwardingRules/{forwardingRule}', options) command.request_representation = Google::Apis::ComputeAlpha::ForwardingRule::Representation command.request_object = forwarding_rule_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['forwardingRule'] = forwarding_rule unless forwarding_rule.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 # Sets the labels on the specified resource. To learn more about labels, read # the Labeling Resources documentation. # @param [String] project # Project ID for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::GlobalSetLabelsRequest] global_set_labels_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_global_forwarding_rule_labels(project, resource, global_set_labels_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/forwardingRules/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::GlobalSetLabelsRequest::Representation command.request_object = global_set_labels_request_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['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 # Changes target URL for the GlobalForwardingRule resource. The new target # should be of the same type as the old target. # @param [String] project # Project ID for this request. # @param [String] forwarding_rule # Name of the ForwardingRule resource in which target is to be set. # @param [Google::Apis::ComputeAlpha::TargetReference] target_reference_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_global_forwarding_rule_target(project, forwarding_rule, target_reference_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/forwardingRules/{forwardingRule}/setTarget', options) command.request_representation = Google::Apis::ComputeAlpha::TargetReference::Representation command.request_object = target_reference_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['forwardingRule'] = forwarding_rule unless forwarding_rule.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_global_forwarding_rule_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/forwardingRules/{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['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 # Retrieves an aggregated list of all operations. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::OperationAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::OperationAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_global_operation_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/operations', options) command.response_representation = Google::Apis::ComputeAlpha::OperationAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::OperationAggregatedList command.params['project'] = project unless project.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['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 Operations resource. # @param [String] project # Project ID for this request. # @param [String] operation # Name of the Operations resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_global_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/operations/{operation}', options) command.params['project'] = project unless project.nil? command.params['operation'] = operation unless operation.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 the specified Operations resource. Get a list of operations by # making a list() request. # @param [String] project # Project ID for this request. # @param [String] operation # Name of the Operations resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 get_global_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations/{operation}', 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['operation'] = operation unless operation.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 Operation resources contained within the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::OperationList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::OperationList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_global_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations', options) command.response_representation = Google::Apis::ComputeAlpha::OperationList::Representation command.response_class = Google::Apis::ComputeAlpha::OperationList command.params['project'] = project unless project.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['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 HealthCheck resource. # @param [String] project # Project ID for this request. # @param [String] health_check # Name of the HealthCheck 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_health_check(project, health_check, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/healthChecks/{healthCheck}', 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['healthCheck'] = health_check unless health_check.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 HealthCheck resource. Get a list of available health # checks by making a list() request. # @param [String] project # Project ID for this request. # @param [String] health_check # Name of the HealthCheck resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HealthCheck] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HealthCheck] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_health_check(project, health_check, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/healthChecks/{healthCheck}', options) command.response_representation = Google::Apis::ComputeAlpha::HealthCheck::Representation command.response_class = Google::Apis::ComputeAlpha::HealthCheck command.params['project'] = project unless project.nil? command.params['healthCheck'] = health_check unless health_check.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 HealthCheck resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::HealthCheck] health_check_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_health_check(project, health_check_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/healthChecks', options) command.request_representation = Google::Apis::ComputeAlpha::HealthCheck::Representation command.request_object = health_check_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of HealthCheck resources available to the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HealthCheckList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HealthCheckList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_health_checks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/healthChecks', options) command.response_representation = Google::Apis::ComputeAlpha::HealthCheckList::Representation command.response_class = Google::Apis::ComputeAlpha::HealthCheckList command.params['project'] = project unless project.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['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 a HealthCheck resource in the specified project using the data # included in the request. This method supports PATCH semantics and uses the # JSON merge patch format and processing rules. # @param [String] project # Project ID for this request. # @param [String] health_check # Name of the HealthCheck resource to patch. # @param [Google::Apis::ComputeAlpha::HealthCheck] health_check_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_health_check(project, health_check, health_check_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/healthChecks/{healthCheck}', options) command.request_representation = Google::Apis::ComputeAlpha::HealthCheck::Representation command.request_object = health_check_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['healthCheck'] = health_check unless health_check.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_health_check_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/healthChecks/{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['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 # Updates a HealthCheck resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [String] health_check # Name of the HealthCheck resource to update. # @param [Google::Apis::ComputeAlpha::HealthCheck] health_check_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_health_check(project, health_check, health_check_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/healthChecks/{healthCheck}', options) command.request_representation = Google::Apis::ComputeAlpha::HealthCheck::Representation command.request_object = health_check_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['healthCheck'] = health_check unless health_check.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 # Retrieves an aggregated list of host types. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HostTypeAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HostTypeAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_host_type_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/hostTypes', options) command.response_representation = Google::Apis::ComputeAlpha::HostTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::HostTypeAggregatedList command.params['project'] = project unless project.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['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 host type. Get a list of available host types by making # a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] host_type # Name of the host type to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HostType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HostType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_host_type(project, zone, host_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/hostTypes/{hostType}', options) command.response_representation = Google::Apis::ComputeAlpha::HostType::Representation command.response_class = Google::Apis::ComputeAlpha::HostType command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['hostType'] = host_type unless host_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 # Retrieves a list of host types available to the specified project. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HostTypeList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HostTypeList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_host_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/hostTypes', options) command.response_representation = Google::Apis::ComputeAlpha::HostTypeList::Representation command.response_class = Google::Apis::ComputeAlpha::HostTypeList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 aggregated list of hosts. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HostAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HostAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_host_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/hosts', options) command.response_representation = Google::Apis::ComputeAlpha::HostAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::HostAggregatedList command.params['project'] = project unless project.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['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 Host resource. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] host # Name of the Host 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_host(project, zone, host, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/zones/{zone}/hosts/{host}', 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['zone'] = zone unless zone.nil? command.params['host'] = host unless host.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 host. Get a list of available hosts by making a list() # request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] host # Name of the host to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Host] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Host] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_host(project, zone, host, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/hosts/{host}', options) command.response_representation = Google::Apis::ComputeAlpha::Host::Representation command.response_class = Google::Apis::ComputeAlpha::Host command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['host'] = host unless host.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] zone # The name of the zone for this request. # @param [String] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_host_iam_policy(project, zone, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/hosts/{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['zone'] = zone unless zone.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 # Creates a host resource in the specified project using the data included in # the request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [Google::Apis::ComputeAlpha::Host] host_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_host(project, zone, host_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/hosts', options) command.request_representation = Google::Apis::ComputeAlpha::Host::Representation command.request_object = host_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['zone'] = zone unless zone.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 # Retrieves a list of hosts available to the specified project. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HostList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HostList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_hosts(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/hosts', options) command.response_representation = Google::Apis::ComputeAlpha::HostList::Representation command.response_class = Google::Apis::ComputeAlpha::HostList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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] zone # The name of the zone for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_host_iam_policy(project, zone, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/hosts/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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['zone'] = zone unless zone.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] zone # The name of the zone for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_host_iam_permissions(project, zone, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/hosts/{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['zone'] = zone unless zone.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 HttpHealthCheck resource. # @param [String] project # Project ID for this request. # @param [String] http_health_check # Name of the HttpHealthCheck 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_http_health_check(project, http_health_check, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/httpHealthChecks/{httpHealthCheck}', 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['httpHealthCheck'] = http_health_check unless http_health_check.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 HttpHealthCheck resource. Get a list of available HTTP # health checks by making a list() request. # @param [String] project # Project ID for this request. # @param [String] http_health_check # Name of the HttpHealthCheck resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HttpHealthCheck] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HttpHealthCheck] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_http_health_check(project, http_health_check, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/httpHealthChecks/{httpHealthCheck}', options) command.response_representation = Google::Apis::ComputeAlpha::HttpHealthCheck::Representation command.response_class = Google::Apis::ComputeAlpha::HttpHealthCheck command.params['project'] = project unless project.nil? command.params['httpHealthCheck'] = http_health_check unless http_health_check.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 HttpHealthCheck resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::HttpHealthCheck] http_health_check_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_http_health_check(project, http_health_check_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/httpHealthChecks', options) command.request_representation = Google::Apis::ComputeAlpha::HttpHealthCheck::Representation command.request_object = http_health_check_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of HttpHealthCheck resources available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HttpHealthCheckList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HttpHealthCheckList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_http_health_checks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/httpHealthChecks', options) command.response_representation = Google::Apis::ComputeAlpha::HttpHealthCheckList::Representation command.response_class = Google::Apis::ComputeAlpha::HttpHealthCheckList command.params['project'] = project unless project.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['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 a HttpHealthCheck resource in the specified project using the data # included in the request. This method supports PATCH semantics and uses the # JSON merge patch format and processing rules. # @param [String] project # Project ID for this request. # @param [String] http_health_check # Name of the HttpHealthCheck resource to patch. # @param [Google::Apis::ComputeAlpha::HttpHealthCheck] http_health_check_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_http_health_check(project, http_health_check, http_health_check_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/httpHealthChecks/{httpHealthCheck}', options) command.request_representation = Google::Apis::ComputeAlpha::HttpHealthCheck::Representation command.request_object = http_health_check_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['httpHealthCheck'] = http_health_check unless http_health_check.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_http_health_check_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/httpHealthChecks/{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['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 # Updates a HttpHealthCheck resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [String] http_health_check # Name of the HttpHealthCheck resource to update. # @param [Google::Apis::ComputeAlpha::HttpHealthCheck] http_health_check_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_http_health_check(project, http_health_check, http_health_check_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/httpHealthChecks/{httpHealthCheck}', options) command.request_representation = Google::Apis::ComputeAlpha::HttpHealthCheck::Representation command.request_object = http_health_check_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['httpHealthCheck'] = http_health_check unless http_health_check.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 # Deletes the specified HttpsHealthCheck resource. # @param [String] project # Project ID for this request. # @param [String] https_health_check # Name of the HttpsHealthCheck 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_https_health_check(project, https_health_check, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/httpsHealthChecks/{httpsHealthCheck}', 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['httpsHealthCheck'] = https_health_check unless https_health_check.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 HttpsHealthCheck resource. Get a list of available HTTPS # health checks by making a list() request. # @param [String] project # Project ID for this request. # @param [String] https_health_check # Name of the HttpsHealthCheck resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HttpsHealthCheck] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HttpsHealthCheck] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_https_health_check(project, https_health_check, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/httpsHealthChecks/{httpsHealthCheck}', options) command.response_representation = Google::Apis::ComputeAlpha::HttpsHealthCheck::Representation command.response_class = Google::Apis::ComputeAlpha::HttpsHealthCheck command.params['project'] = project unless project.nil? command.params['httpsHealthCheck'] = https_health_check unless https_health_check.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 HttpsHealthCheck resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::HttpsHealthCheck] https_health_check_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_https_health_check(project, https_health_check_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/httpsHealthChecks', options) command.request_representation = Google::Apis::ComputeAlpha::HttpsHealthCheck::Representation command.request_object = https_health_check_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of HttpsHealthCheck resources available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::HttpsHealthCheckList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::HttpsHealthCheckList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_https_health_checks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/httpsHealthChecks', options) command.response_representation = Google::Apis::ComputeAlpha::HttpsHealthCheckList::Representation command.response_class = Google::Apis::ComputeAlpha::HttpsHealthCheckList command.params['project'] = project unless project.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['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 a HttpsHealthCheck resource in the specified project using the data # included in the request. This method supports PATCH semantics and uses the # JSON merge patch format and processing rules. # @param [String] project # Project ID for this request. # @param [String] https_health_check # Name of the HttpsHealthCheck resource to patch. # @param [Google::Apis::ComputeAlpha::HttpsHealthCheck] https_health_check_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_https_health_check(project, https_health_check, https_health_check_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/httpsHealthChecks/{httpsHealthCheck}', options) command.request_representation = Google::Apis::ComputeAlpha::HttpsHealthCheck::Representation command.request_object = https_health_check_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['httpsHealthCheck'] = https_health_check unless https_health_check.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_https_health_check_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/httpsHealthChecks/{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['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 # Updates a HttpsHealthCheck resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [String] https_health_check # Name of the HttpsHealthCheck resource to update. # @param [Google::Apis::ComputeAlpha::HttpsHealthCheck] https_health_check_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_https_health_check(project, https_health_check, https_health_check_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/httpsHealthChecks/{httpsHealthCheck}', options) command.request_representation = Google::Apis::ComputeAlpha::HttpsHealthCheck::Representation command.request_object = https_health_check_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['httpsHealthCheck'] = https_health_check unless https_health_check.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 # Deletes the specified image. # @param [String] project # Project ID for this request. # @param [String] image # Name of the image 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_image(project, image, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/images/{image}', 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['image'] = image unless image.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 # Sets the deprecation status of an image. # If an empty request body is given, clears the deprecation status instead. # @param [String] project # Project ID for this request. # @param [String] image # Image name. # @param [Google::Apis::ComputeAlpha::DeprecationStatus] deprecation_status_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 deprecate_image(project, image, deprecation_status_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/images/{image}/deprecate', options) command.request_representation = Google::Apis::ComputeAlpha::DeprecationStatus::Representation command.request_object = deprecation_status_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['image'] = image unless image.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 image. Get a list of available images by making a list() # request. # @param [String] project # Project ID for this request. # @param [String] image # Name of the image resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Image] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Image] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_image(project, image, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/images/{image}', options) command.response_representation = Google::Apis::ComputeAlpha::Image::Representation command.response_class = Google::Apis::ComputeAlpha::Image command.params['project'] = project unless project.nil? command.params['image'] = image unless image.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 latest image that is part of an image family and is not deprecated. # @param [String] project # Project ID for this request. # @param [String] family # Name of the image family to search for. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Image] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Image] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_image_from_family(project, family, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/images/family/{family}', options) command.response_representation = Google::Apis::ComputeAlpha::Image::Representation command.response_class = Google::Apis::ComputeAlpha::Image command.params['project'] = project unless project.nil? command.params['family'] = family unless family.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] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_image_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/images/{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['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 # Creates an image in the specified project using the data included in the # request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::Image] image_object # @param [Boolean] force_create # Force image creation if true. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_image(project, image_object = nil, force_create: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/images', options) command.request_representation = Google::Apis::ComputeAlpha::Image::Representation command.request_object = image_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.nil? command.query['forceCreate'] = force_create unless force_create.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 # Retrieves the list of custom images available to the specified project. Custom # images are images you create that belong to your project. This method does not # get any images that belong to other projects, including publicly-available # images, like Debian 8. If you want to get a list of publicly-available images, # use this method to make a request to the respective image project, such as # debian-cloud or windows-cloud. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::ImageList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::ImageList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/images', options) command.response_representation = Google::Apis::ComputeAlpha::ImageList::Representation command.response_class = Google::Apis::ComputeAlpha::ImageList command.params['project'] = project unless project.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['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] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_image_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/images/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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['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 # Sets the labels on an image. To learn more about labels, read the Labeling # Resources documentation. # @param [String] project # Project ID for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::GlobalSetLabelsRequest] global_set_labels_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_image_labels(project, resource, global_set_labels_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/images/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::GlobalSetLabelsRequest::Representation command.request_object = global_set_labels_request_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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_image_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/images/{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['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 # Schedules a group action to remove the specified instances from the managed # instance group. Abandoning an instance does not delete the instance, but it # does remove the instance from any target pools that are applied by the managed # instance group. This method reduces the targetSize of the managed instance # group by the number of instances that you abandon. This operation is marked as # DONE when the action is scheduled even if the instances have not yet been # removed from the group. You must separately verify the status of the # abandoning action with the listmanagedinstances method. # If the group is part of a backend service that has enabled connection draining, # it can take up to 60 seconds after the connection draining duration has # elapsed before the VM instance is removed or deleted. # You can specify a maximum of 1000 instances with this method per request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the managed instance group. # @param [Google::Apis::ComputeAlpha::InstanceGroupManagersAbandonInstancesRequest] instance_group_managers_abandon_instances_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 abandon_instance_group_manager_instances(project, zone, instance_group_manager, instance_group_managers_abandon_instances_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersAbandonInstancesRequest::Representation command.request_object = instance_group_managers_abandon_instances_request_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Retrieves the list of managed instance groups and groups them by zone. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_instance_group_manager_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/instanceGroupManagers', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList command.params['project'] = project unless project.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['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 # Apply changes to selected instances on the managed instance group. This method # can be used to apply new overrides and/or new versions. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. Should # conform to RFC1035. # @param [String] instance_group_manager # The name of the managed instance group, should conform to RFC1035. # @param [Google::Apis::ComputeAlpha::InstanceGroupManagersApplyUpdatesRequest] instance_group_managers_apply_updates_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 apply_instance_group_manager_updates_to_instances(project, zone, instance_group_manager, instance_group_managers_apply_updates_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersApplyUpdatesRequest::Representation command.request_object = instance_group_managers_apply_updates_request_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 managed instance group and all of the instances in that # group. Note that the instance group must not belong to a backend service. Read # Deleting an instance group for more information. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the managed instance group 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_group_manager(project, zone, instance_group_manager, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}', 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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Schedules a group action to delete the specified instances in the managed # instance group. The instances are also removed from any target pools of which # they were a member. This method reduces the targetSize of the managed instance # group by the number of instances that you delete. This operation is marked as # DONE when the action is scheduled even if the instances are still being # deleted. You must separately verify the status of the deleting action with the # listmanagedinstances method. # If the group is part of a backend service that has enabled connection draining, # it can take up to 60 seconds after the connection draining duration has # elapsed before the VM instance is removed or deleted. # You can specify a maximum of 1000 instances with this method per request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the managed instance group. # @param [Google::Apis::ComputeAlpha::InstanceGroupManagersDeleteInstancesRequest] instance_group_managers_delete_instances_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_group_manager_instances(project, zone, instance_group_manager, instance_group_managers_delete_instances_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersDeleteInstancesRequest::Representation command.request_object = instance_group_managers_delete_instances_request_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Delete selected per-instance configs for the managed instance group. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. It should # conform to RFC1035. # @param [String] instance_group_manager # The name of the managed instance group. It should conform to RFC1035. # @param [Google::Apis::ComputeAlpha::InstanceGroupManagersDeletePerInstanceConfigsReq] instance_group_managers_delete_per_instance_configs_req_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_group_manager_per_instance_configs(project, zone, instance_group_manager, instance_group_managers_delete_per_instance_configs_req_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersDeletePerInstanceConfigsReq::Representation command.request_object = instance_group_managers_delete_per_instance_configs_req_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 details about the specified managed instance group. Get a # list of available managed instance groups by making a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the managed instance 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroupManager] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroupManager] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_group_manager(project, zone, instance_group_manager, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupManager::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupManager command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 managed instance group using the information that you specify in the # request. After the group is created, it schedules an action to create # instances in the group using the specified instance template. This operation # is marked as DONE when the group is created even if the instances in the group # have not yet been created. You must separately verify the status of the # individual instances with the listmanagedinstances method. # A managed instance group can have up to 1000 VM instances per group. Please # contact Cloud Support if you need an increase in this limit. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where you want to create the managed instance group. # @param [Google::Apis::ComputeAlpha::InstanceGroupManager] instance_group_manager_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_group_manager(project, zone, instance_group_manager_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManager::Representation command.request_object = instance_group_manager_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['zone'] = zone unless zone.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 # Retrieves a list of managed instance groups that are contained within the # specified project and zone. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroupManagerList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroupManagerList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_group_managers(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instanceGroupManagers', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupManagerList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupManagerList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 of the instances in the managed instance group. Each instance in the # list has a currentAction, which indicates the action that the managed instance # group is performing on the instance. For example, if the group is still # creating an instance, the currentAction is CREATING. If a previous action # failed, the list displays the errors for that failed action. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the managed instance group. # @param [String] filter # @param [Fixnum] max_results # @param [String] order_by # @param [String] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroupManagersListManagedInstancesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroupManagersListManagedInstancesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_group_manager_managed_instances(project, zone, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersListManagedInstancesResponse::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupManagersListManagedInstancesResponse command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['order_by'] = order_by unless order_by.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 # Lists all of the per-instance configs defined for the managed instance group. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. It should # conform to RFC1035. # @param [String] instance_group_manager # The name of the managed instance group. It should conform to RFC1035. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_group_manager_per_instance_configs(project, zone, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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['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 a managed instance group using the information that you specify in the # request. This operation is marked as DONE when the group is patched even if # the instances in the group are still in the process of being patched. You must # separately verify the status of the individual instances with the # listManagedInstances method. This method supports PATCH semantics and uses the # JSON merge patch format and processing rules. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where you want to create the managed instance group. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Google::Apis::ComputeAlpha::InstanceGroupManager] instance_group_manager_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_instance_group_manager(project, zone, instance_group_manager, instance_group_manager_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManager::Representation command.request_object = instance_group_manager_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Schedules a group action to recreate the specified instances in the managed # instance group. The instances are deleted and recreated using the current # instance template for the managed instance group. This operation is marked as # DONE when the action is scheduled even if the instances have not yet been # recreated. You must separately verify the status of the recreating action with # the listmanagedinstances method. # If the group is part of a backend service that has enabled connection draining, # it can take up to 60 seconds after the connection draining duration has # elapsed before the VM instance is removed or deleted. # You can specify a maximum of 1000 instances with this method per request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the managed instance group. # @param [Google::Apis::ComputeAlpha::InstanceGroupManagersRecreateInstancesRequest] instance_group_managers_recreate_instances_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 recreate_instance_group_manager_instances(project, zone, instance_group_manager, instance_group_managers_recreate_instances_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersRecreateInstancesRequest::Representation command.request_object = instance_group_managers_recreate_instances_request_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Resizes the managed instance group. If you increase the size, the group # creates new instances using the current instance template. If you decrease the # size, the group deletes instances. The resize operation is marked DONE when # the resize actions are scheduled even if the group has not yet added or # deleted any instances. You must separately verify the status of the creating # or deleting actions with the listmanagedinstances method. # If the group is part of a backend service that has enabled connection draining, # it can take up to 60 seconds after the connection draining duration has # elapsed before the VM instance is removed or deleted. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the managed instance group. # @param [Fixnum] size # The number of running instances that the managed instance group should # maintain at any given time. The group automatically adds or removes instances # to maintain the number of instances specified by this parameter. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 resize_instance_group_manager(project, zone, instance_group_manager, size, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize', 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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['size'] = size unless size.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 # Resizes the managed instance group with advanced configuration options like # disabling creation retries. This is an extended version of the resize method. # If you increase the size of the instance group, the group creates new # instances using the current instance template. If you decrease the size, the # group deletes instances. The resize operation is marked DONE when the resize # actions are scheduled even if the group has not yet added or deleted any # instances. You must separately verify the status of the creating, # creatingWithoutRetries, or deleting actions with the get or # listmanagedinstances method. # If the group is part of a backend service that has enabled connection draining, # it can take up to 60 seconds after the connection draining duration has # elapsed before the VM instance is removed or deleted. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the managed instance group. # @param [Google::Apis::ComputeAlpha::InstanceGroupManagersResizeAdvancedRequest] instance_group_managers_resize_advanced_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 resize_instance_group_manager_advanced(project, zone, instance_group_manager, instance_group_managers_resize_advanced_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersResizeAdvancedRequest::Representation command.request_object = instance_group_managers_resize_advanced_request_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Modifies the autohealing policies. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Google::Apis::ComputeAlpha::InstanceGroupManagersSetAutoHealingRequest] instance_group_managers_set_auto_healing_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_group_manager_auto_healing_policies(project, zone, instance_group_manager, instance_group_managers_set_auto_healing_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersSetAutoHealingRequest::Representation command.request_object = instance_group_managers_set_auto_healing_request_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Specifies the instance template to use when creating new instances in this # group. The templates for existing instances in the group do not change unless # you recreate them. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the managed instance group. # @param [Google::Apis::ComputeAlpha::InstanceGroupManagersSetInstanceTemplateRequest] instance_group_managers_set_instance_template_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_group_manager_instance_template(project, zone, instance_group_manager, instance_group_managers_set_instance_template_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersSetInstanceTemplateRequest::Representation command.request_object = instance_group_managers_set_instance_template_request_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Modifies the target pools to which all instances in this managed instance # group are assigned. The target pools automatically apply to all of the # instances in the managed instance group. This operation is marked DONE when # you make the request even if the instances have not yet been added to their # target pools. The change might take some time to apply to all of the instances # in the group depending on the size of the group. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager # The name of the managed instance group. # @param [Google::Apis::ComputeAlpha::InstanceGroupManagersSetTargetPoolsRequest] instance_group_managers_set_target_pools_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_group_manager_target_pools(project, zone, instance_group_manager, instance_group_managers_set_target_pools_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersSetTargetPoolsRequest::Representation command.request_object = instance_group_managers_set_target_pools_request_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_group_manager_iam_permissions(project, zone, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{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['zone'] = zone unless zone.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 # Updates a managed instance group using the information that you specify in the # request. This operation is marked as DONE when the group is updated even if # the instances in the group have not yet been updated. You must separately # verify the status of the individual instances with the listManagedInstances # method. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where you want to create the managed instance group. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Google::Apis::ComputeAlpha::InstanceGroupManager] instance_group_manager_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_instance_group_manager(project, zone, instance_group_manager, instance_group_manager_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManager::Representation command.request_object = instance_group_manager_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Insert or patch (for the ones that already exist) per-instance configs for the # managed instance group. perInstanceConfig.instance serves as a key used to # distinguish whether to perform insert or patch. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. It should # conform to RFC1035. # @param [String] instance_group_manager # The name of the managed instance group. It should conform to RFC1035. # @param [Google::Apis::ComputeAlpha::InstanceGroupManagersUpdatePerInstanceConfigsReq] instance_group_managers_update_per_instance_configs_req_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_instance_group_manager_per_instance_configs(project, zone, instance_group_manager, instance_group_managers_update_per_instance_configs_req_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersUpdatePerInstanceConfigsReq::Representation command.request_object = instance_group_managers_update_per_instance_configs_req_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['zone'] = zone unless zone.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Adds a list of instances to the specified instance group. All of the instances # in the instance group must be in the same network/subnetwork. Read Adding # instances for more information. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group # The name of the instance group where you are adding instances. # @param [Google::Apis::ComputeAlpha::InstanceGroupsAddInstancesRequest] instance_groups_add_instances_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 add_instance_group_instances(project, zone, instance_group, instance_groups_add_instances_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupsAddInstancesRequest::Representation command.request_object = instance_groups_add_instances_request_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['zone'] = zone unless zone.nil? command.params['instanceGroup'] = instance_group unless instance_group.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 # Retrieves the list of instance groups and sorts them by zone. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroupAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroupAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_instance_group_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/instanceGroups', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupAggregatedList command.params['project'] = project unless project.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['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 instance group. The instances in the group are not # deleted. Note that instance group must not belong to a backend service. Read # Deleting an instance group for more information. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group # The name of the instance group 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_group(project, zone, instance_group, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/zones/{zone}/instanceGroups/{instanceGroup}', 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['zone'] = zone unless zone.nil? command.params['instanceGroup'] = instance_group unless instance_group.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 instance group. Get a list of available instance groups # by making a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group # The name of the instance 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_group(project, zone, instance_group, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instanceGroups/{instanceGroup}', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroup::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroup command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroup'] = instance_group unless instance_group.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 instance group in the specified project using the parameters that # are included in the request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where you want to create the instance group. # @param [Google::Apis::ComputeAlpha::InstanceGroup] instance_group_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_group(project, zone, instance_group_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroups', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroup::Representation command.request_object = instance_group_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['zone'] = zone unless zone.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 # Retrieves the list of instance groups that are located in the specified # project and zone. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroupList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroupList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_groups(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instanceGroups', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 instances in the specified instance group. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group # The name of the instance group from which you want to generate a list of # included instances. # @param [Google::Apis::ComputeAlpha::InstanceGroupsListInstancesRequest] instance_groups_list_instances_request_object # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroupsListInstances] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroupsListInstances] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_group_instances(project, zone, instance_group, instance_groups_list_instances_request_object = nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupsListInstancesRequest::Representation command.request_object = instance_groups_list_instances_request_object command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupsListInstances::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupsListInstances command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instanceGroup'] = instance_group unless instance_group.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['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 # Removes one or more instances from the specified instance group, but does not # delete those instances. # If the group is part of a backend service that has enabled connection draining, # it can take up to 60 seconds after the connection draining duration before # the VM instance is removed or deleted. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group # The name of the instance group where the specified instances will be removed. # @param [Google::Apis::ComputeAlpha::InstanceGroupsRemoveInstancesRequest] instance_groups_remove_instances_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 remove_instance_group_instances(project, zone, instance_group, instance_groups_remove_instances_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupsRemoveInstancesRequest::Representation command.request_object = instance_groups_remove_instances_request_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['zone'] = zone unless zone.nil? command.params['instanceGroup'] = instance_group unless instance_group.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 # Sets the named ports for the specified instance group. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group # The name of the instance group where the named ports are updated. # @param [Google::Apis::ComputeAlpha::InstanceGroupsSetNamedPortsRequest] instance_groups_set_named_ports_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_group_named_ports(project, zone, instance_group, instance_groups_set_named_ports_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupsSetNamedPortsRequest::Representation command.request_object = instance_groups_set_named_ports_request_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['zone'] = zone unless zone.nil? command.params['instanceGroup'] = instance_group unless instance_group.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_group_iam_permissions(project, zone, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroups/{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['zone'] = zone unless zone.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 instance template. Deleting an instance template is # permanent and cannot be undone. It's not possible to delete templates which # are in use by an instance group. # @param [String] project # Project ID for this request. # @param [String] instance_template # The name of the instance template 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_template(project, instance_template, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/instanceTemplates/{instanceTemplate}', 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['instanceTemplate'] = instance_template unless instance_template.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 instance template. Get a list of available instance # templates by making a list() request. # @param [String] project # Project ID for this request. # @param [String] instance_template # The name of the instance template. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_template(project, instance_template, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/instanceTemplates/{instanceTemplate}', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceTemplate::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceTemplate command.params['project'] = project unless project.nil? command.params['instanceTemplate'] = instance_template unless instance_template.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 instance template in the specified project using the data that is # included in the request. If you are creating a new template to update an # existing instance group, your new instance template must use the same network # or, if applicable, the same subnetwork as the original template. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::InstanceTemplate] instance_template_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_template(project, instance_template_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/instanceTemplates', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceTemplate::Representation command.request_object = instance_template_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves a list of instance templates that are contained within the specified # project and zone. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceTemplateList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceTemplateList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_templates(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/instanceTemplates', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceTemplateList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceTemplateList command.params['project'] = project unless project.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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_template_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/instanceTemplates/{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['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 # Adds an access config to an instance's network interface. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # The instance name for this request. # @param [String] network_interface # The name of the network interface to add to this instance. # @param [Google::Apis::ComputeAlpha::AccessConfig] access_config_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 add_instance_access_config(project, zone, instance, network_interface, access_config_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/addAccessConfig', options) command.request_representation = Google::Apis::ComputeAlpha::AccessConfig::Representation command.request_object = access_config_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['networkInterface'] = network_interface unless network_interface.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 # Adds existing maintenance policies to an instance. You can only add one policy # right now which will be applied to this instance for scheduling live # migrations. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # The instance name for this request. # @param [Google::Apis::ComputeAlpha::InstancesAddMaintenancePoliciesRequest] instances_add_maintenance_policies_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 add_instance_maintenance_policies(project, zone, instance, instances_add_maintenance_policies_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/addMaintenancePolicies', options) command.request_representation = Google::Apis::ComputeAlpha::InstancesAddMaintenancePoliciesRequest::Representation command.request_object = instances_add_maintenance_policies_request_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Retrieves aggregated list of instances. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_instance_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/instances', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceAggregatedList command.params['project'] = project unless project.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['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 # Attaches an existing Disk resource to an instance. You must first create the # disk before you can attach it. It is not possible to create and attach a disk # at the same time. For more information, read Adding a persistent disk to your # instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # The instance name for this request. # @param [Google::Apis::ComputeAlpha::AttachedDisk] attached_disk_object # @param [Boolean] force_attach # Whether to force attach the disk even if it's currently attached to another # instance. This is only available for regional disks. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 attach_instance_disk(project, zone, instance, attached_disk_object = nil, force_attach: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/attachDisk', options) command.request_representation = Google::Apis::ComputeAlpha::AttachedDisk::Representation command.request_object = attached_disk_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['forceAttach'] = force_attach unless force_attach.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 # Deletes the specified Instance resource. For more information, see Stopping or # Deleting an Instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance(project, zone, instance, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/zones/{zone}/instances/{instance}', 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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Deletes an access config from an instance's network interface. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # The instance name for this request. # @param [String] access_config # The name of the access config to delete. # @param [String] network_interface # The name of the network interface. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_access_config(project, zone, instance, access_config, network_interface, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/deleteAccessConfig', 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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['accessConfig'] = access_config unless access_config.nil? command.query['networkInterface'] = network_interface unless network_interface.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 # Detaches a disk from an instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Instance name. # @param [String] device_name # Disk device name to detach. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 detach_instance_disk(project, zone, instance, device_name, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/detachDisk', 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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['deviceName'] = device_name unless device_name.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 Instance resource. Get a list of available instances by # making a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Instance] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Instance] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance(project, zone, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instances/{instance}', options) command.response_representation = Google::Apis::ComputeAlpha::Instance::Representation command.response_class = Google::Apis::ComputeAlpha::Instance command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 guest attributes entry. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this request. # @param [String] variable_key # Specifies the key for the guest attributes entry. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::GuestAttributes] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::GuestAttributes] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_guest_attributes(project, zone, instance, variable_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instances/{instance}/getGuestAttributes', options) command.response_representation = Google::Apis::ComputeAlpha::GuestAttributes::Representation command.response_class = Google::Apis::ComputeAlpha::GuestAttributes command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['variableKey'] = variable_key unless variable_key.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] zone # The name of the zone for this request. # @param [String] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_iam_policy(project, zone, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instances/{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['zone'] = zone unless zone.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 the specified instance's serial port output. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this request. # @param [Fixnum] port # Specifies which COM or serial port to retrieve data from. # @param [Fixnum] start # Returns output starting from a specific byte position. Use this to page # through output when the output is too large to return in a single request. For # the initial request, leave this field unspecified. For subsequent calls, this # field should be set to the next value returned in the previous call. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SerialPortOutput] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SerialPortOutput] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_serial_port_output(project, zone, instance, port: nil, start: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instances/{instance}/serialPort', options) command.response_representation = Google::Apis::ComputeAlpha::SerialPortOutput::Representation command.response_class = Google::Apis::ComputeAlpha::SerialPortOutput command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['port'] = port unless port.nil? command.query['start'] = start unless start.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 instance resource in the specified project using the data included # in the request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [Google::Apis::ComputeAlpha::Instance] instance_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] source_instance_template # Specifies instance template to create the instance. # This field is optional. It can be a full or partial URL. For example, the # following are all valid URLs to an instance template: # - https://www.googleapis.com/compute/v1/projects/project/global/global/ # instanceTemplates/instanceTemplate # - projects/project/global/global/instanceTemplates/instanceTemplate # - global/instancesTemplates/instanceTemplate # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance(project, zone, instance_object = nil, request_id: nil, source_instance_template: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances', options) command.request_representation = Google::Apis::ComputeAlpha::Instance::Representation command.request_object = instance_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['zone'] = zone unless zone.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['sourceInstanceTemplate'] = source_instance_template unless source_instance_template.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 the list of instances contained within the specified zone. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instances(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instances', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 the list of referrers to instances contained within the specified # zone. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the target instance scoping this request, or '-' if the request should # span over all instances in the container. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceListReferrers] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceListReferrers] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_referrers(project, zone, instance, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instances/{instance}/referrers', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceListReferrers::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceListReferrers command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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['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 # Removes maintenance policies from an instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # The instance name for this request. # @param [Google::Apis::ComputeAlpha::InstancesRemoveMaintenancePoliciesRequest] instances_remove_maintenance_policies_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 remove_instance_maintenance_policies(project, zone, instance, instances_remove_maintenance_policies_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/removeMaintenancePolicies', options) command.request_representation = Google::Apis::ComputeAlpha::InstancesRemoveMaintenancePoliciesRequest::Representation command.request_object = instances_remove_maintenance_policies_request_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Performs a reset on the instance. For more information, see Resetting an # instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this request. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_instance(project, zone, instance, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/reset', 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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Resumes an instance that was suspended using the instances().suspend method. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance resource to resume. # @param [Google::Apis::ComputeAlpha::InstancesResumeRequest] instances_resume_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 resume_instance(project, zone, instance, instances_resume_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/resume', options) command.request_representation = Google::Apis::ComputeAlpha::InstancesResumeRequest::Representation command.request_object = instances_resume_request_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Sets deletion protection on the instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] resource # Name of the resource for this request. # @param [Boolean] deletion_protection # Whether the resource should be protected against deletion. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_deletion_protection(project, zone, resource, deletion_protection: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{resource}/setDeletionProtection', 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['zone'] = zone unless zone.nil? command.params['resource'] = resource unless resource.nil? command.query['deletionProtection'] = deletion_protection unless deletion_protection.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 # Sets the auto-delete flag for a disk attached to an instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # The instance name. # @param [Boolean] auto_delete # Whether to auto-delete the disk when the instance is deleted. # @param [String] device_name # The device name of the disk to modify. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_disk_auto_delete(project, zone, instance, auto_delete, device_name, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete', 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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['autoDelete'] = auto_delete unless auto_delete.nil? command.query['deviceName'] = device_name unless device_name.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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_iam_policy(project, zone, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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['zone'] = zone unless zone.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 # Sets labels on an instance. To learn more about labels, read the Labeling # Resources documentation. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this request. # @param [Google::Apis::ComputeAlpha::InstancesSetLabelsRequest] instances_set_labels_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_labels(project, zone, instance, instances_set_labels_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::InstancesSetLabelsRequest::Representation command.request_object = instances_set_labels_request_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Changes the number and/or type of accelerator for a stopped instance to the # values specified in the request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this request. # @param [Google::Apis::ComputeAlpha::InstancesSetMachineResourcesRequest] instances_set_machine_resources_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_machine_resources(project, zone, instance, instances_set_machine_resources_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/setMachineResources', options) command.request_representation = Google::Apis::ComputeAlpha::InstancesSetMachineResourcesRequest::Representation command.request_object = instances_set_machine_resources_request_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Changes the machine type for a stopped instance to the machine type specified # in the request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this request. # @param [Google::Apis::ComputeAlpha::InstancesSetMachineTypeRequest] instances_set_machine_type_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_machine_type(project, zone, instance, instances_set_machine_type_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/setMachineType', options) command.request_representation = Google::Apis::ComputeAlpha::InstancesSetMachineTypeRequest::Representation command.request_object = instances_set_machine_type_request_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Sets metadata for the specified instance to the data included in the request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this request. # @param [Google::Apis::ComputeAlpha::Metadata] metadata_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_metadata(project, zone, instance, metadata_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/setMetadata', options) command.request_representation = Google::Apis::ComputeAlpha::Metadata::Representation command.request_object = metadata_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Changes the minimum CPU platform that this instance should use. This method # can only be called on a stopped instance. For more information, read # Specifying a Minimum CPU Platform. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this request. # @param [Google::Apis::ComputeAlpha::InstancesSetMinCpuPlatformRequest] instances_set_min_cpu_platform_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_min_cpu_platform(project, zone, instance, instances_set_min_cpu_platform_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform', options) command.request_representation = Google::Apis::ComputeAlpha::InstancesSetMinCpuPlatformRequest::Representation command.request_object = instances_set_min_cpu_platform_request_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Sets an instance's scheduling options. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Instance name. # @param [Google::Apis::ComputeAlpha::Scheduling] scheduling_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_scheduling(project, zone, instance, scheduling_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/setScheduling', options) command.request_representation = Google::Apis::ComputeAlpha::Scheduling::Representation command.request_object = scheduling_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Sets the service account on the instance. For more information, read Changing # the service account and access scopes for an instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance resource to start. # @param [Google::Apis::ComputeAlpha::InstancesSetServiceAccountRequest] instances_set_service_account_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_service_account(project, zone, instance, instances_set_service_account_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/setServiceAccount', options) command.request_representation = Google::Apis::ComputeAlpha::InstancesSetServiceAccountRequest::Representation command.request_object = instances_set_service_account_request_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Sets tags for the specified instance to the data included in the request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this request. # @param [Google::Apis::ComputeAlpha::Tags] tags_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_instance_tags(project, zone, instance, tags_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/setTags', options) command.request_representation = Google::Apis::ComputeAlpha::Tags::Representation command.request_object = tags_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Simulates a maintenance event on the instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 simulate_instance_maintenance_event(project, zone, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent', 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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Starts an instance that was stopped using the using the instances().stop # method. For more information, see Restart an instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance resource to start. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 start_instance(project, zone, instance, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/start', 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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Starts an instance that was stopped using the using the instances().stop # method. For more information, see Restart an instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance resource to start. # @param [Google::Apis::ComputeAlpha::InstancesStartWithEncryptionKeyRequest] instances_start_with_encryption_key_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 start_instance_with_encryption_key(project, zone, instance, instances_start_with_encryption_key_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey', options) command.request_representation = Google::Apis::ComputeAlpha::InstancesStartWithEncryptionKeyRequest::Representation command.request_object = instances_start_with_encryption_key_request_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Stops a running instance, shutting it down cleanly, and allows you to restart # the instance at a later time. Stopped instances do not incur VM usage charges # while they are stopped. However, resources that the VM is using, such as # persistent disks and static IP addresses, will continue to be charged until # they are deleted. For more information, see Stopping an instance. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance resource to stop. # @param [Boolean] discard_local_ssd # If true, discard the contents of any attached localSSD partitions. Default # value is false (== preserve localSSD data). # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 stop_instance(project, zone, instance, discard_local_ssd: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/stop', 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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['discardLocalSsd'] = discard_local_ssd unless discard_local_ssd.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 # This method suspends a running instance, saving its state to persistent # storage, and allows you to resume the instance at a later time. Suspended # instances incur reduced per-minute, virtual machine usage charges while they # are suspended. Any resources the virtual machine is using, such as persistent # disks and static IP addresses, will continue to be charged until they are # deleted. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance resource to suspend. # @param [Boolean] discard_local_ssd # If true, discard the contents of any attached localSSD partitions. Default # value is false (== preserve localSSD data). # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 suspend_instance(project, zone, instance, discard_local_ssd: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/suspend', 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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['discardLocalSsd'] = discard_local_ssd unless discard_local_ssd.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_instance_iam_permissions(project, zone, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{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['zone'] = zone unless zone.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 # Updates the specified access config from an instance's network interface with # the data included in the request. This method supports PATCH semantics and # uses the JSON merge patch format and processing rules. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # The instance name for this request. # @param [String] network_interface # The name of the network interface where the access config is attached. # @param [Google::Apis::ComputeAlpha::AccessConfig] access_config_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_instance_access_config(project, zone, instance, network_interface, access_config_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/updateAccessConfig', options) command.request_representation = Google::Apis::ComputeAlpha::AccessConfig::Representation command.request_object = access_config_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['networkInterface'] = network_interface unless network_interface.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 # Updates an instance's network interface. This method follows PATCH semantics. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # The instance name for this request. # @param [String] network_interface # The name of the network interface to update. # @param [Google::Apis::ComputeAlpha::NetworkInterface] network_interface_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_instance_network_interface(project, zone, instance, network_interface, network_interface_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/zones/{zone}/instances/{instance}/updateNetworkInterface', options) command.request_representation = Google::Apis::ComputeAlpha::NetworkInterface::Representation command.request_object = network_interface_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.nil? command.query['networkInterface'] = network_interface unless network_interface.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 # Updates the Shielded VM config for an instance. This method supports PATCH # semantics and uses the JSON merge patch format and processing rules. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] instance # Name of the instance scoping this request. # @param [Google::Apis::ComputeAlpha::ShieldedVmConfig] shielded_vm_config_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_instance_shielded_vm_config(project, zone, instance, shielded_vm_config_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/zones/{zone}/instances/{instance}/updateShieldedVmConfig', options) command.request_representation = Google::Apis::ComputeAlpha::ShieldedVmConfig::Representation command.request_object = shielded_vm_config_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['zone'] = zone unless zone.nil? command.params['instance'] = instance unless instance.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 # Retrieves an aggregated list of interconnect attachments. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_interconnect_attachment_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/interconnectAttachments', options) command.response_representation = Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList command.params['project'] = project unless project.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['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 interconnect attachment. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] interconnect_attachment # Name of the interconnect attachment 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect_attachment(project, region, interconnect_attachment, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}', 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['interconnectAttachment'] = interconnect_attachment unless interconnect_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 interconnect attachment. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] interconnect_attachment # Name of the interconnect attachment to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InterconnectAttachment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InterconnectAttachment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_interconnect_attachment(project, region, interconnect_attachment, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}', options) command.response_representation = Google::Apis::ComputeAlpha::InterconnectAttachment::Representation command.response_class = Google::Apis::ComputeAlpha::InterconnectAttachment command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['interconnectAttachment'] = interconnect_attachment unless interconnect_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 of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect_attachment_iam_policy(project, region, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/interconnectAttachments/{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['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 InterconnectAttachment in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [Google::Apis::ComputeAlpha::InterconnectAttachment] interconnect_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect_attachment(project, region, interconnect_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}/interconnectAttachments', options) command.request_representation = Google::Apis::ComputeAlpha::InterconnectAttachment::Representation command.request_object = interconnect_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 # Retrieves the list of interconnect attachments contained within the specified # region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InterconnectAttachmentList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InterconnectAttachmentList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_interconnect_attachments(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/interconnectAttachments', options) command.response_representation = Google::Apis::ComputeAlpha::InterconnectAttachmentList::Representation command.response_class = Google::Apis::ComputeAlpha::InterconnectAttachmentList 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['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 specified interconnect attachment with the data included in the # request. This method supports PATCH semantics and uses the JSON merge patch # format and processing rules. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] interconnect_attachment # Name of the interconnect attachment to patch. # @param [Google::Apis::ComputeAlpha::InterconnectAttachment] interconnect_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_interconnect_attachment(project, region, interconnect_attachment, interconnect_attachment_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}', options) command.request_representation = Google::Apis::ComputeAlpha::InterconnectAttachment::Representation command.request_object = interconnect_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.params['interconnectAttachment'] = interconnect_attachment unless interconnect_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 # 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 of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect_attachment_iam_policy(project, region, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/interconnectAttachments/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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 # Sets the labels on an InterconnectAttachment. To learn more about labels, read # the Labeling Resources documentation. # @param [String] project # Project ID for this request. # @param [String] region # The region for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::RegionSetLabelsRequest] region_set_labels_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_interconnect_attachment_labels(project, region, resource, region_set_labels_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/interconnectAttachments/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::RegionSetLabelsRequest::Representation command.request_object = region_set_labels_request_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.params['resource'] = resource unless resource.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect_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}/interconnectAttachments/{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 # Returns the details for the specified interconnect location. Get a list of # available interconnect locations by making a list() request. # @param [String] project # Project ID for this request. # @param [String] interconnect_location # Name of the interconnect location to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InterconnectLocation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InterconnectLocation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_interconnect_location(project, interconnect_location, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/interconnectLocations/{interconnectLocation}', options) command.response_representation = Google::Apis::ComputeAlpha::InterconnectLocation::Representation command.response_class = Google::Apis::ComputeAlpha::InterconnectLocation command.params['project'] = project unless project.nil? command.params['interconnectLocation'] = interconnect_location unless interconnect_location.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 the list of interconnect locations available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InterconnectLocationList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InterconnectLocationList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_interconnect_locations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/interconnectLocations', options) command.response_representation = Google::Apis::ComputeAlpha::InterconnectLocationList::Representation command.response_class = Google::Apis::ComputeAlpha::InterconnectLocationList command.params['project'] = project unless project.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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect_location_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/interconnectLocations/{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['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 interconnect. # @param [String] project # Project ID for this request. # @param [String] interconnect # Name of the interconnect 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect(project, interconnect, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/interconnects/{interconnect}', 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['interconnect'] = interconnect unless interconnect.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 interconnect. Get a list of available interconnects by # making a list() request. # @param [String] project # Project ID for this request. # @param [String] interconnect # Name of the interconnect to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Interconnect] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Interconnect] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_interconnect(project, interconnect, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/interconnects/{interconnect}', options) command.response_representation = Google::Apis::ComputeAlpha::Interconnect::Representation command.response_class = Google::Apis::ComputeAlpha::Interconnect command.params['project'] = project unless project.nil? command.params['interconnect'] = interconnect unless interconnect.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] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/interconnects/{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['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 # Creates a Interconnect in the specified project using the data included in the # request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::Interconnect] interconnect_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect(project, interconnect_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/interconnects', options) command.request_representation = Google::Apis::ComputeAlpha::Interconnect::Representation command.request_object = interconnect_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of interconnect available to the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InterconnectList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InterconnectList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_interconnects(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/interconnects', options) command.response_representation = Google::Apis::ComputeAlpha::InterconnectList::Representation command.response_class = Google::Apis::ComputeAlpha::InterconnectList command.params['project'] = project unless project.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['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 specified interconnect with the data included in the request. This # method supports PATCH semantics and uses the JSON merge patch format and # processing rules. # @param [String] project # Project ID for this request. # @param [String] interconnect # Name of the interconnect to update. # @param [Google::Apis::ComputeAlpha::Interconnect] interconnect_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_interconnect(project, interconnect, interconnect_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/interconnects/{interconnect}', options) command.request_representation = Google::Apis::ComputeAlpha::Interconnect::Representation command.request_object = interconnect_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['interconnect'] = interconnect unless interconnect.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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @param [String] project # Project ID for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/interconnects/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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['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 # Sets the labels on an Interconnect. To learn more about labels, read the # Labeling Resources documentation. # @param [String] project # Project ID for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::GlobalSetLabelsRequest] global_set_labels_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_interconnect_labels(project, resource, global_set_labels_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/interconnects/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::GlobalSetLabelsRequest::Representation command.request_object = global_set_labels_request_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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_interconnect_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/interconnects/{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['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 # Return a specified license code. License codes are mirrored across all # projects that have permissions to read the License Code. # @param [String] project # Project ID for this request. # @param [String] license_code # Number corresponding to the License code resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::LicenseCode] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::LicenseCode] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_license_code(project, license_code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/licenseCodes/{licenseCode}', options) command.response_representation = Google::Apis::ComputeAlpha::LicenseCode::Representation command.response_class = Google::Apis::ComputeAlpha::LicenseCode command.params['project'] = project unless project.nil? command.params['licenseCode'] = license_code unless license_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 # 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] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_license_code_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/licenseCodes/{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['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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @param [String] project # Project ID for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_license_code_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/licenseCodes/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_license_code_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/licenseCodes/{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['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 license. # @param [String] project # Project ID for this request. # @param [String] license # Name of the license 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_license(project, license, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/licenses/{license}', 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['license'] = license unless license.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 License resource. # @param [String] project # Project ID for this request. # @param [String] license # Name of the License resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::License] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::License] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_license(project, license, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/licenses/{license}', options) command.response_representation = Google::Apis::ComputeAlpha::License::Representation command.response_class = Google::Apis::ComputeAlpha::License command.params['project'] = project unless project.nil? command.params['license'] = license unless license.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] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_license_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/licenses/{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['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 # Create a License resource in the specified project. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::License] license_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_license(project, license_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/licenses', options) command.request_representation = Google::Apis::ComputeAlpha::License::Representation command.request_object = license_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of licenses available in the specified project. This method # does not get any licenses that belong to other projects, including licenses # attached to publicly-available images, like Debian 8. If you want to get a # list of publicly-available licenses, use this method to make a request to the # respective image project, such as debian-cloud or windows-cloud. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::LicensesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::LicensesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_licenses(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/licenses', options) command.response_representation = Google::Apis::ComputeAlpha::LicensesListResponse::Representation command.response_class = Google::Apis::ComputeAlpha::LicensesListResponse command.params['project'] = project unless project.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['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] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_license_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/licenses/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_license_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/licenses/{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['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 # Retrieves an aggregated list of machine types. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::MachineTypeAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::MachineTypeAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_machine_type_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/machineTypes', options) command.response_representation = Google::Apis::ComputeAlpha::MachineTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::MachineTypeAggregatedList command.params['project'] = project unless project.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['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 machine type. Get a list of available machine types by # making a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] machine_type # Name of the machine type to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::MachineType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::MachineType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_machine_type(project, zone, machine_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/machineTypes/{machineType}', options) command.response_representation = Google::Apis::ComputeAlpha::MachineType::Representation command.response_class = Google::Apis::ComputeAlpha::MachineType command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['machineType'] = machine_type unless machine_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 # Retrieves a list of machine types available to the specified project. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::MachineTypeList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::MachineTypeList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_machine_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/machineTypes', options) command.response_representation = Google::Apis::ComputeAlpha::MachineTypeList::Representation command.response_class = Google::Apis::ComputeAlpha::MachineTypeList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 aggregated list of maintenance policies. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::MaintenancePolicyAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::MaintenancePolicyAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_maintenance_policy_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/maintenancePolicies', options) command.response_representation = Google::Apis::ComputeAlpha::MaintenancePolicyAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::MaintenancePolicyAggregatedList command.params['project'] = project unless project.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['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 maintenance policy. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] maintenance_policy # Name of the maintenance policy 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_maintenance_policy(project, region, maintenance_policy, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/maintenancePolicies/{maintenancePolicy}', 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['maintenancePolicy'] = maintenance_policy unless maintenance_policy.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 # Retrieves all information of the specified maintenance policy. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] maintenance_policy # Name of the maintenance policy to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::MaintenancePolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::MaintenancePolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_maintenance_policy(project, region, maintenance_policy, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/maintenancePolicies/{maintenancePolicy}', options) command.response_representation = Google::Apis::ComputeAlpha::MaintenancePolicy::Representation command.response_class = Google::Apis::ComputeAlpha::MaintenancePolicy command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['maintenancePolicy'] = maintenance_policy unless maintenance_policy.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 of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_maintenance_policy_iam_policy(project, region, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/maintenancePolicies/{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['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 maintenance policy. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [Google::Apis::ComputeAlpha::MaintenancePolicy] maintenance_policy_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_maintenance_policy(project, region, maintenance_policy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/maintenancePolicies', options) command.request_representation = Google::Apis::ComputeAlpha::MaintenancePolicy::Representation command.request_object = maintenance_policy_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 # List all the maintenance policies that have been configured for the specified # project in specified region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::MaintenancePoliciesList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::MaintenancePoliciesList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_maintenance_policies(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/maintenancePolicies', options) command.response_representation = Google::Apis::ComputeAlpha::MaintenancePoliciesList::Representation command.response_class = Google::Apis::ComputeAlpha::MaintenancePoliciesList 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['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 of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_maintenance_policy_iam_policy(project, region, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/maintenancePolicies/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_maintenance_policy_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}/maintenancePolicies/{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 # Retrieves the list of network endpoint groups and sorts them by zone. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_network_endpoint_group_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/networkEndpointGroups', options) command.response_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList command.params['project'] = project unless project.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['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 # Attach a list of network endpoints to the specified network endpoint group. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the network endpoint group is located. It should # comply with RFC1035. # @param [String] network_endpoint_group # The name of the network endpoint group where you are attaching network # endpoints to. It should comply with RFC1035. # @param [Google::Apis::ComputeAlpha::NetworkEndpointGroupsAttachEndpointsRequest] network_endpoint_groups_attach_endpoints_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 attach_network_endpoint_group_network_endpoints(project, zone, network_endpoint_group, network_endpoint_groups_attach_endpoints_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints', options) command.request_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupsAttachEndpointsRequest::Representation command.request_object = network_endpoint_groups_attach_endpoints_request_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['zone'] = zone unless zone.nil? command.params['networkEndpointGroup'] = network_endpoint_group unless network_endpoint_group.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 # Deletes the specified network endpoint group. The network endpoints in the NEG # and the VM instances they belong to are not terminated when the NEG is deleted. # Note that the NEG cannot be deleted if there are backend services referencing # it. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the network endpoint group is located. It should # comply with RFC1035. # @param [String] network_endpoint_group # The name of the network endpoint group to delete. It should comply with # RFC1035. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_network_endpoint_group(project, zone, network_endpoint_group, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}', 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['zone'] = zone unless zone.nil? command.params['networkEndpointGroup'] = network_endpoint_group unless network_endpoint_group.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 # Detach a list of network endpoints from the specified network endpoint group. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the network endpoint group is located. It should # comply with RFC1035. # @param [String] network_endpoint_group # The name of the network endpoint group where you are removing network # endpoints. It should comply with RFC1035. # @param [Google::Apis::ComputeAlpha::NetworkEndpointGroupsDetachEndpointsRequest] network_endpoint_groups_detach_endpoints_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 detach_network_endpoint_group_network_endpoints(project, zone, network_endpoint_group, network_endpoint_groups_detach_endpoints_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints', options) command.request_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupsDetachEndpointsRequest::Representation command.request_object = network_endpoint_groups_detach_endpoints_request_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['zone'] = zone unless zone.nil? command.params['networkEndpointGroup'] = network_endpoint_group unless network_endpoint_group.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 network endpoint group. Get a list of available network # endpoint groups by making a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the network endpoint group is located. It should # comply with RFC1035. # @param [String] network_endpoint_group # The name of the network endpoint group. It should comply with RFC1035. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::NetworkEndpointGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::NetworkEndpointGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_network_endpoint_group(project, zone, network_endpoint_group, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}', options) command.response_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroup::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkEndpointGroup command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['networkEndpointGroup'] = network_endpoint_group unless network_endpoint_group.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 network endpoint group in the specified project using the parameters # that are included in the request. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where you want to create the network endpoint group. It # should comply with RFC1035. # @param [Google::Apis::ComputeAlpha::NetworkEndpointGroup] network_endpoint_group_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_network_endpoint_group(project, zone, network_endpoint_group_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/networkEndpointGroups', options) command.request_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroup::Representation command.request_object = network_endpoint_group_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['zone'] = zone unless zone.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 # Retrieves the list of network endpoint groups that are located in the # specified project and zone. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the network endpoint group is located. It should # comply with RFC1035. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::NetworkEndpointGroupList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::NetworkEndpointGroupList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_network_endpoint_groups(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/networkEndpointGroups', options) command.response_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupList::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkEndpointGroupList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 the network endpoints in the specified network endpoint group. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone where the network endpoint group is located. It should # comply with RFC1035. # @param [String] network_endpoint_group # The name of the network endpoint group from which you want to generate a list # of included network endpoints. It should comply with RFC1035. # @param [Google::Apis::ComputeAlpha::NetworkEndpointGroupsListEndpointsRequest] network_endpoint_groups_list_endpoints_request_object # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_network_endpoint_group_network_endpoints(project, zone, network_endpoint_group, network_endpoint_groups_list_endpoints_request_object = nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints', options) command.request_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupsListEndpointsRequest::Representation command.request_object = network_endpoint_groups_list_endpoints_request_object command.response_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['networkEndpointGroup'] = network_endpoint_group unless network_endpoint_group.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['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] zone # The name of the zone for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_network_endpoint_group_iam_permissions(project, zone, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/networkEndpointGroups/{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['zone'] = zone unless zone.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 # Adds a peering to the specified network. # @param [String] project # Project ID for this request. # @param [String] network # Name of the network resource to add peering to. # @param [Google::Apis::ComputeAlpha::NetworksAddPeeringRequest] networks_add_peering_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 add_network_peering(project, network, networks_add_peering_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/networks/{network}/addPeering', options) command.request_representation = Google::Apis::ComputeAlpha::NetworksAddPeeringRequest::Representation command.request_object = networks_add_peering_request_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['network'] = network unless network.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 # Deletes the specified network. # @param [String] project # Project ID for this request. # @param [String] network # Name of the network 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_network(project, network, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/networks/{network}', 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['network'] = network unless network.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 network. Get a list of available networks by making a # list() request. # @param [String] project # Project ID for this request. # @param [String] network # Name of the network to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Network] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Network] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_network(project, network, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/networks/{network}', options) command.response_representation = Google::Apis::ComputeAlpha::Network::Representation command.response_class = Google::Apis::ComputeAlpha::Network command.params['project'] = project unless project.nil? command.params['network'] = network unless network.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 network in the specified project using the data included in the # request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::Network] network_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_network(project, network_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/networks', options) command.request_representation = Google::Apis::ComputeAlpha::Network::Representation command.request_object = network_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of networks available to the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::NetworkList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::NetworkList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_networks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/networks', options) command.response_representation = Google::Apis::ComputeAlpha::NetworkList::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkList command.params['project'] = project unless project.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['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 the internal IP owners in the specified network. # @param [String] project # Project ID for this request. # @param [String] network # Name of the network to return. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @param [String] ip_cidr_range # (Optional) IP CIDR range filter, example: "10.128.10.0/30". # @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] owner_projects # (Optional) Project IDs filter, example: "project-1,project-2". # @param [String] owner_types # (Optional) Owner types filter, example: "instance,forwardingRule". # @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 [String] subnet_name # (Optional) Subnetwork name filter. # @param [String] subnet_region # (Optional) Subnetwork region filter. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::IpOwnerList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::IpOwnerList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_network_ip_owners(project, network, filter: nil, ip_cidr_range: nil, max_results: nil, order_by: nil, owner_projects: nil, owner_types: nil, page_token: nil, subnet_name: nil, subnet_region: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/networks/{network}/listIpOwners', options) command.response_representation = Google::Apis::ComputeAlpha::IpOwnerList::Representation command.response_class = Google::Apis::ComputeAlpha::IpOwnerList command.params['project'] = project unless project.nil? command.params['network'] = network unless network.nil? command.query['filter'] = filter unless filter.nil? command.query['ipCidrRange'] = ip_cidr_range unless ip_cidr_range.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['ownerProjects'] = owner_projects unless owner_projects.nil? command.query['ownerTypes'] = owner_types unless owner_types.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['subnetName'] = subnet_name unless subnet_name.nil? command.query['subnetRegion'] = subnet_region unless subnet_region.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 # Patches the specified network with the data included in the request. Only the # following fields can be modified: routingConfig.routingMode. # @param [String] project # Project ID for this request. # @param [String] network # Name of the network to update. # @param [Google::Apis::ComputeAlpha::Network] network_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_network(project, network, network_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/networks/{network}', options) command.request_representation = Google::Apis::ComputeAlpha::Network::Representation command.request_object = network_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['network'] = network unless network.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 # Removes a peering from the specified network. # @param [String] project # Project ID for this request. # @param [String] network # Name of the network resource to remove peering from. # @param [Google::Apis::ComputeAlpha::NetworksRemovePeeringRequest] networks_remove_peering_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 remove_network_peering(project, network, networks_remove_peering_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/networks/{network}/removePeering', options) command.request_representation = Google::Apis::ComputeAlpha::NetworksRemovePeeringRequest::Representation command.request_object = networks_remove_peering_request_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['network'] = network unless network.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 # Switches the network mode from auto subnet mode to custom subnet mode. # @param [String] project # Project ID for this request. # @param [String] network # Name of the network to be updated. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 switch_network_to_custom_mode(project, network, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/networks/{network}/switchToCustomMode', 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['network'] = network unless network.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_network_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/networks/{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['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 # 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] zone # The name of the zone for this request. # @param [String] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_node_group_iam_policy(project, zone, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/nodeGroups/{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['zone'] = zone unless zone.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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @param [String] project # Project ID for this request. # @param [String] zone # The name of the zone for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_node_group_iam_policy(project, zone, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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['zone'] = zone unless zone.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] zone # The name of the zone for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_node_group_iam_permissions(project, zone, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/nodeGroups/{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['zone'] = zone unless zone.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 # 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 of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_node_template_iam_policy(project, region, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/nodeTemplates/{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['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 of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_node_template_iam_policy(project, region, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_node_template_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}/nodeTemplates/{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 # Disable this project as a shared VPC host project. # @param [String] project # Project ID for this request. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 disable_project_xpn_host(project, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/disableXpnHost', options) command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Disable a serivce resource (a.k.a service project) associated with this host # project. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::ProjectsDisableXpnResourceRequest] projects_disable_xpn_resource_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 disable_project_xpn_resource(project, projects_disable_xpn_resource_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/disableXpnResource', options) command.request_representation = Google::Apis::ComputeAlpha::ProjectsDisableXpnResourceRequest::Representation command.request_object = projects_disable_xpn_resource_request_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Enable this project as a shared VPC host project. # @param [String] project # Project ID for this request. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 enable_project_xpn_host(project, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/enableXpnHost', options) command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Enable service resource (a.k.a service project) for a host project, so that # subnets in the host project can be used by instances in the service project. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::ProjectsEnableXpnResourceRequest] projects_enable_xpn_resource_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 enable_project_xpn_resource(project, projects_enable_xpn_resource_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/enableXpnResource', options) command.request_representation = Google::Apis::ComputeAlpha::ProjectsEnableXpnResourceRequest::Representation command.request_object = projects_enable_xpn_resource_request_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 Project resource. # @param [String] project # Project ID for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Project] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Project] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(project, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}', options) command.response_representation = Google::Apis::ComputeAlpha::Project::Representation command.response_class = Google::Apis::ComputeAlpha::Project command.params['project'] = project unless project.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 # Get the shared VPC host project that this project links to. May be empty if no # link exists. # @param [String] project # Project ID for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Project] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Project] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_xpn_host(project, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/getXpnHost', options) command.response_representation = Google::Apis::ComputeAlpha::Project::Representation command.response_class = Google::Apis::ComputeAlpha::Project command.params['project'] = project unless project.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 # Get service resources (a.k.a service project) associated with this host # project. # @param [String] project # Project ID for this request. # @param [String] filter # @param [Fixnum] max_results # @param [String] order_by # @param [String] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::ProjectsGetXpnResources] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::ProjectsGetXpnResources] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_xpn_resources(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/getXpnResources', options) command.response_representation = Google::Apis::ComputeAlpha::ProjectsGetXpnResources::Representation command.response_class = Google::Apis::ComputeAlpha::ProjectsGetXpnResources command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['order_by'] = order_by unless order_by.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 # List all shared VPC host projects visible to the user in an organization. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::ProjectsListXpnHostsRequest] projects_list_xpn_hosts_request_object # @param [String] filter # @param [Fixnum] max_results # @param [String] order_by # @param [String] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::XpnHostList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::XpnHostList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_xpn_hosts(project, projects_list_xpn_hosts_request_object = nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/listXpnHosts', options) command.request_representation = Google::Apis::ComputeAlpha::ProjectsListXpnHostsRequest::Representation command.request_object = projects_list_xpn_hosts_request_object command.response_representation = Google::Apis::ComputeAlpha::XpnHostList::Representation command.response_class = Google::Apis::ComputeAlpha::XpnHostList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['order_by'] = order_by unless order_by.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 # Moves a persistent disk from one zone to another. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::DiskMoveRequest] disk_move_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 move_project_disk(project, disk_move_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/moveDisk', options) command.request_representation = Google::Apis::ComputeAlpha::DiskMoveRequest::Representation command.request_object = disk_move_request_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Moves an instance and its attached persistent disks from one zone to another. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::InstanceMoveRequest] instance_move_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 move_project_instance(project, instance_move_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/moveInstance', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceMoveRequest::Representation command.request_object = instance_move_request_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Sets metadata common to all instances within the specified project using the # data included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::Metadata] metadata_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_project_common_instance_metadata(project, metadata_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/setCommonInstanceMetadata', options) command.request_representation = Google::Apis::ComputeAlpha::Metadata::Representation command.request_object = metadata_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Sets the default network tier of the project. The default network tier is used # when an address/forwardingRule/instance is created without specifying the # network tier field. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::ProjectsSetDefaultNetworkTierRequest] projects_set_default_network_tier_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_project_default_network_tier(project, projects_set_default_network_tier_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/setDefaultNetworkTier', options) command.request_representation = Google::Apis::ComputeAlpha::ProjectsSetDefaultNetworkTierRequest::Representation command.request_object = projects_set_default_network_tier_request_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Sets the default service account of the project. The default service account # is used when a VM instance is created with the service account email address # set to "default". # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::ProjectsSetDefaultServiceAccountRequest] projects_set_default_service_account_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_project_default_service_account(project, projects_set_default_service_account_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/setDefaultServiceAccount', options) command.request_representation = Google::Apis::ComputeAlpha::ProjectsSetDefaultServiceAccountRequest::Representation command.request_object = projects_set_default_service_account_request_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Enables the usage export feature and sets the usage export bucket where # reports are stored. If you provide an empty request body using this method, # the usage export feature will be disabled. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::UsageExportLocation] usage_export_location_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_project_usage_export_bucket(project, usage_export_location_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/setUsageExportBucket', options) command.request_representation = Google::Apis::ComputeAlpha::UsageExportLocation::Representation command.request_object = usage_export_location_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Deletes the specified autoscaler. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] autoscaler # Name of the autoscaler 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_autoscaler(project, region, autoscaler, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/autoscalers/{autoscaler}', 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['autoscaler'] = autoscaler unless autoscaler.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 autoscaler. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] autoscaler # Name of the autoscaler to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Autoscaler] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Autoscaler] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_autoscaler(project, region, autoscaler, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/autoscalers/{autoscaler}', options) command.response_representation = Google::Apis::ComputeAlpha::Autoscaler::Representation command.response_class = Google::Apis::ComputeAlpha::Autoscaler command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['autoscaler'] = autoscaler unless autoscaler.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 autoscaler in the specified project using the data included in the # request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [Google::Apis::ComputeAlpha::Autoscaler] autoscaler_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_autoscaler(project, region, autoscaler_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/autoscalers', options) command.request_representation = Google::Apis::ComputeAlpha::Autoscaler::Representation command.request_object = autoscaler_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 # Retrieves a list of autoscalers contained within the specified region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RegionAutoscalerList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RegionAutoscalerList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_autoscalers(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/autoscalers', options) command.response_representation = Google::Apis::ComputeAlpha::RegionAutoscalerList::Representation command.response_class = Google::Apis::ComputeAlpha::RegionAutoscalerList 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['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 autoscaler in the specified project using the data included in the # request. This method supports PATCH semantics and uses the JSON merge patch # format and processing rules. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [Google::Apis::ComputeAlpha::Autoscaler] autoscaler_object # @param [String] autoscaler # Name of the autoscaler to patch. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_region_autoscaler(project, region, autoscaler_object = nil, autoscaler: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/regions/{region}/autoscalers', options) command.request_representation = Google::Apis::ComputeAlpha::Autoscaler::Representation command.request_object = autoscaler_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['autoscaler'] = autoscaler unless autoscaler.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_autoscaler_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}/autoscalers/{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 # Updates an autoscaler in the specified project using the data included in the # request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [Google::Apis::ComputeAlpha::Autoscaler] autoscaler_object # @param [String] autoscaler # Name of the autoscaler to update. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_region_autoscaler(project, region, autoscaler_object = nil, autoscaler: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/regions/{region}/autoscalers', options) command.request_representation = Google::Apis::ComputeAlpha::Autoscaler::Representation command.request_object = autoscaler_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['autoscaler'] = autoscaler unless autoscaler.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 # Deletes the specified regional BackendService resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] backend_service # Name of the BackendService 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_backend_service(project, region, backend_service, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/backendServices/{backendService}', 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['backendService'] = backend_service unless backend_service.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 regional BackendService resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] backend_service # Name of the BackendService resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::BackendService] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::BackendService] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_backend_service(project, region, backend_service, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/backendServices/{backendService}', options) command.response_representation = Google::Apis::ComputeAlpha::BackendService::Representation command.response_class = Google::Apis::ComputeAlpha::BackendService command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['backendService'] = backend_service unless backend_service.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 most recent health check results for this regional BackendService. # @param [String] project # @param [String] region # Name of the region scoping this request. # @param [String] backend_service # Name of the BackendService resource for which to get health. # @param [Google::Apis::ComputeAlpha::ResourceGroupReference] resource_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::BackendServiceGroupHealth] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::BackendServiceGroupHealth] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_backend_service_health(project, region, backend_service, resource_group_reference_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/backendServices/{backendService}/getHealth', options) command.request_representation = Google::Apis::ComputeAlpha::ResourceGroupReference::Representation command.request_object = resource_group_reference_object command.response_representation = Google::Apis::ComputeAlpha::BackendServiceGroupHealth::Representation command.response_class = Google::Apis::ComputeAlpha::BackendServiceGroupHealth command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['backendService'] = backend_service unless backend_service.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 regional BackendService resource in the specified project using the # data included in the request. There are several restrictions and guidelines to # keep in mind when creating a regional backend service. Read Restrictions and # Guidelines for more information. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [Google::Apis::ComputeAlpha::BackendService] backend_service_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_backend_service(project, region, backend_service_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/backendServices', options) command.request_representation = Google::Apis::ComputeAlpha::BackendService::Representation command.request_object = backend_service_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 # Retrieves the list of regional BackendService resources available to the # specified project in the given region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::BackendServiceList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::BackendServiceList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_backend_services(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/backendServices', options) command.response_representation = Google::Apis::ComputeAlpha::BackendServiceList::Representation command.response_class = Google::Apis::ComputeAlpha::BackendServiceList 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['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 specified regional BackendService resource with the data included # in the request. There are several restrictions and guidelines to keep in mind # when updating a backend service. Read Restrictions and Guidelines for more # information. This method supports PATCH semantics and uses the JSON merge # patch format and processing rules. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] backend_service # Name of the BackendService resource to patch. # @param [Google::Apis::ComputeAlpha::BackendService] backend_service_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_region_backend_service(project, region, backend_service, backend_service_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/regions/{region}/backendServices/{backendService}', options) command.request_representation = Google::Apis::ComputeAlpha::BackendService::Representation command.request_object = backend_service_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.params['backendService'] = backend_service unless backend_service.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_backend_service_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}/backendServices/{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 # Updates the specified regional BackendService resource with the data included # in the request. There are several restrictions and guidelines to keep in mind # when updating a backend service. Read Restrictions and Guidelines for more # information. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] backend_service # Name of the BackendService resource to update. # @param [Google::Apis::ComputeAlpha::BackendService] backend_service_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_region_backend_service(project, region, backend_service, backend_service_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/regions/{region}/backendServices/{backendService}', options) command.request_representation = Google::Apis::ComputeAlpha::BackendService::Representation command.request_object = backend_service_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.params['backendService'] = backend_service unless backend_service.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 # Retrieves an aggregated list of commitments. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::CommitmentAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::CommitmentAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_region_commitment_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/commitments', options) command.response_representation = Google::Apis::ComputeAlpha::CommitmentAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::CommitmentAggregatedList command.params['project'] = project unless project.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['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 commitment resource. Get a list of available commitments # by making a list() request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] commitment # Name of the commitment to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Commitment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Commitment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_commitment(project, region, commitment, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/commitments/{commitment}', options) command.response_representation = Google::Apis::ComputeAlpha::Commitment::Representation command.response_class = Google::Apis::ComputeAlpha::Commitment command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['commitment'] = commitment unless commitment.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 commitment in the specified project using the data included in the # request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [Google::Apis::ComputeAlpha::Commitment] commitment_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_commitment(project, region, commitment_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/commitments', options) command.request_representation = Google::Apis::ComputeAlpha::Commitment::Representation command.request_object = commitment_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 # Retrieves a list of commitments contained within the specified region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::CommitmentList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::CommitmentList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_commitments(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/commitments', options) command.response_representation = Google::Apis::ComputeAlpha::CommitmentList::Representation command.response_class = Google::Apis::ComputeAlpha::CommitmentList 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['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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_commitment_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}/commitments/{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 # Returns the specified regional disk type. Get a list of available disk types # by making a list() request. # @param [String] project # Project ID for this request. # @param [String] region # The name of the region for this request. # @param [String] disk_type # Name of the disk type to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::DiskType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::DiskType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_disk_type(project, region, disk_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/diskTypes/{diskType}', options) command.response_representation = Google::Apis::ComputeAlpha::DiskType::Representation command.response_class = Google::Apis::ComputeAlpha::DiskType command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['diskType'] = disk_type unless disk_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 # Retrieves a list of regional disk types available to the specified project. # @param [String] project # Project ID for this request. # @param [String] region # The name of the region for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RegionDiskTypeList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RegionDiskTypeList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_disk_types(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/diskTypes', options) command.response_representation = Google::Apis::ComputeAlpha::RegionDiskTypeList::Representation command.response_class = Google::Apis::ComputeAlpha::RegionDiskTypeList 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['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 snapshot of this regional disk. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] disk # Name of the regional persistent disk to snapshot. # @param [Google::Apis::ComputeAlpha::Snapshot] snapshot_object # @param [Boolean] guest_flush # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 create_region_disk_snapshot(project, region, disk, snapshot_object = nil, guest_flush: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/disks/{disk}/createSnapshot', options) command.request_representation = Google::Apis::ComputeAlpha::Snapshot::Representation command.request_object = snapshot_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.params['disk'] = disk unless disk.nil? command.query['guestFlush'] = guest_flush unless guest_flush.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 # Deletes the specified regional persistent disk. Deleting a regional disk # removes all the replicas of its data permanently and is irreversible. However, # deleting a disk does not delete any snapshots previously made from the disk. # You must separately delete snapshots. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] disk # Name of the regional persistent disk 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_disk(project, region, disk, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/disks/{disk}', 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['disk'] = disk unless disk.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 a specified regional persistent disk. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] disk # Name of the regional persistent disk to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Disk] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Disk] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_disk(project, region, disk, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/disks/{disk}', options) command.response_representation = Google::Apis::ComputeAlpha::Disk::Representation command.response_class = Google::Apis::ComputeAlpha::Disk command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['disk'] = disk unless disk.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 persistent regional disk in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [Google::Apis::ComputeAlpha::Disk] disk_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] source_image # Optional. Source image to restore onto a disk. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_disk(project, region, disk_object = nil, request_id: nil, source_image: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/disks', options) command.request_representation = Google::Apis::ComputeAlpha::Disk::Representation command.request_object = disk_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['sourceImage'] = source_image unless source_image.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 the list of persistent disks contained within the specified region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::DiskList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::DiskList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_disks(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/disks', options) command.response_representation = Google::Apis::ComputeAlpha::DiskList::Representation command.response_class = Google::Apis::ComputeAlpha::DiskList 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['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 # Resizes the specified regional persistent disk. # @param [String] project # The project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] disk # Name of the regional persistent disk. # @param [Google::Apis::ComputeAlpha::RegionDisksResizeRequest] region_disks_resize_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 resize_region_disk(project, region, disk, region_disks_resize_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/disks/{disk}/resize', options) command.request_representation = Google::Apis::ComputeAlpha::RegionDisksResizeRequest::Representation command.request_object = region_disks_resize_request_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.params['disk'] = disk unless disk.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 # Sets the labels on the target regional disk. # @param [String] project # Project ID for this request. # @param [String] region # The region for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::RegionSetLabelsRequest] region_set_labels_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_region_disk_labels(project, region, resource, region_set_labels_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/disks/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::RegionSetLabelsRequest::Representation command.request_object = region_set_labels_request_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.params['resource'] = resource unless resource.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_disk_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}/disks/{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 # Schedules a group action to remove the specified instances from the managed # instance group. Abandoning an instance does not delete the instance, but it # does remove the instance from any target pools that are applied by the managed # instance group. This method reduces the targetSize of the managed instance # group by the number of instances that you abandon. This operation is marked as # DONE when the action is scheduled even if the instances have not yet been # removed from the group. You must separately verify the status of the # abandoning action with the listmanagedinstances method. # If the group is part of a backend service that has enabled connection draining, # it can take up to 60 seconds after the connection draining duration has # elapsed before the VM instance is removed or deleted. # You can specify a maximum of 1000 instances with this method per request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # Name of the managed instance group. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersAbandonInstancesRequest] region_instance_group_managers_abandon_instances_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 abandon_region_instance_group_manager_instances(project, region, instance_group_manager, region_instance_group_managers_abandon_instances_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersAbandonInstancesRequest::Representation command.request_object = region_instance_group_managers_abandon_instances_request_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Apply updates to selected instances the managed instance group. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request, should conform to RFC1035. # @param [String] instance_group_manager # The name of the managed instance group, should conform to RFC1035. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersApplyUpdatesRequest] region_instance_group_managers_apply_updates_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 apply_region_instance_group_manager_updates_to_instances(project, region, instance_group_manager, region_instance_group_managers_apply_updates_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersApplyUpdatesRequest::Representation command.request_object = region_instance_group_managers_apply_updates_request_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 managed instance group and all of the instances in that # group. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # Name of the managed instance group 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_instance_group_manager(project, region, instance_group_manager, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}', 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['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Schedules a group action to delete the specified instances in the managed # instance group. The instances are also removed from any target pools of which # they were a member. This method reduces the targetSize of the managed instance # group by the number of instances that you delete. This operation is marked as # DONE when the action is scheduled even if the instances are still being # deleted. You must separately verify the status of the deleting action with the # listmanagedinstances method. # If the group is part of a backend service that has enabled connection draining, # it can take up to 60 seconds after the connection draining duration has # elapsed before the VM instance is removed or deleted. # You can specify a maximum of 1000 instances with this method per request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # Name of the managed instance group. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersDeleteInstancesRequest] region_instance_group_managers_delete_instances_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_instance_group_manager_instances(project, region, instance_group_manager, region_instance_group_managers_delete_instances_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersDeleteInstancesRequest::Representation command.request_object = region_instance_group_managers_delete_instances_request_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Delete selected per-instance configs for the managed instance group. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request, should conform to RFC1035. # @param [String] instance_group_manager # The name of the managed instance group. It should conform to RFC1035. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupManagerDeleteInstanceConfigReq] region_instance_group_manager_delete_instance_config_req_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_instance_group_manager_per_instance_configs(project, region, instance_group_manager, region_instance_group_manager_delete_instance_config_req_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagerDeleteInstanceConfigReq::Representation command.request_object = region_instance_group_manager_delete_instance_config_req_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 details about the specified managed instance group. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # Name of the managed instance group to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroupManager] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroupManager] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_instance_group_manager(project, region, instance_group_manager, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupManager::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupManager command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 managed instance group using the information that you specify in the # request. After the group is created, it schedules an action to create # instances in the group using the specified instance template. This operation # is marked as DONE when the group is created even if the instances in the group # have not yet been created. You must separately verify the status of the # individual instances with the listmanagedinstances method. # A regional managed instance group can contain up to 2000 instances. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [Google::Apis::ComputeAlpha::InstanceGroupManager] instance_group_manager_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_instance_group_manager(project, region, instance_group_manager_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManager::Representation command.request_object = instance_group_manager_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 # Retrieves the list of managed instance groups that are contained within the # specified region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RegionInstanceGroupManagerList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RegionInstanceGroupManagerList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_instance_group_managers(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/instanceGroupManagers', options) command.response_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagerList::Representation command.response_class = Google::Apis::ComputeAlpha::RegionInstanceGroupManagerList 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['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 instances in the managed instance group and instances that are # scheduled to be created. The list includes any current actions that the group # has scheduled for its instances. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # The name of the managed instance group. # @param [String] filter # @param [Fixnum] max_results # @param [String] order_by # @param [String] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstancesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstancesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_instance_group_manager_managed_instances(project, region, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances', options) command.response_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstancesResponse::Representation command.response_class = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstancesResponse command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['order_by'] = order_by unless order_by.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 # Lists all of the per-instance configs defined for the managed instance group. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request, should conform to RFC1035. # @param [String] instance_group_manager # The name of the managed instance group. It should conform to RFC1035. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_instance_group_manager_per_instance_configs(project, region, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs', options) command.response_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp::Representation command.response_class = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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['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 a managed instance group using the information that you specify in the # request. This operation is marked as DONE when the group is patched even if # the instances in the group are still in the process of being patched. You must # separately verify the status of the individual instances with the # listmanagedinstances method. This method supports PATCH semantics and uses the # JSON merge patch format and processing rules. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Google::Apis::ComputeAlpha::InstanceGroupManager] instance_group_manager_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_region_instance_group_manager(project, region, instance_group_manager, instance_group_manager_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManager::Representation command.request_object = instance_group_manager_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Schedules a group action to recreate the specified instances in the managed # instance group. The instances are deleted and recreated using the current # instance template for the managed instance group. This operation is marked as # DONE when the action is scheduled even if the instances have not yet been # recreated. You must separately verify the status of the recreating action with # the listmanagedinstances method. # If the group is part of a backend service that has enabled connection draining, # it can take up to 60 seconds after the connection draining duration has # elapsed before the VM instance is removed or deleted. # You can specify a maximum of 1000 instances with this method per request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # Name of the managed instance group. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersRecreateRequest] region_instance_group_managers_recreate_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 recreate_region_instance_group_manager_instances(project, region, instance_group_manager, region_instance_group_managers_recreate_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersRecreateRequest::Representation command.request_object = region_instance_group_managers_recreate_request_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Changes the intended size for the managed instance group. If you increase the # size, the group schedules actions to create new instances using the current # instance template. If you decrease the size, the group schedules delete # actions on one or more instances. The resize operation is marked DONE when the # resize actions are scheduled even if the group has not yet added or deleted # any instances. You must separately verify the status of the creating or # deleting actions with the listmanagedinstances method. # If the group is part of a backend service that has enabled connection draining, # it can take up to 60 seconds after the connection draining duration has # elapsed before the VM instance is removed or deleted. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # Name of the managed instance group. # @param [Fixnum] size # Number of instances that should exist in this instance group manager. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 resize_region_instance_group_manager(project, region, instance_group_manager, size, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize', 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['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['size'] = size unless size.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 # Modifies the autohealing policy for the instances in this managed instance # group. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # Name of the managed instance group. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersSetAutoHealingRequest] region_instance_group_managers_set_auto_healing_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_region_instance_group_manager_auto_healing_policies(project, region, instance_group_manager, region_instance_group_managers_set_auto_healing_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersSetAutoHealingRequest::Representation command.request_object = region_instance_group_managers_set_auto_healing_request_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Sets the instance template to use when creating new instances or recreating # instances in this group. Existing instances are not affected. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # The name of the managed instance group. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersSetTemplateRequest] region_instance_group_managers_set_template_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_region_instance_group_manager_instance_template(project, region, instance_group_manager, region_instance_group_managers_set_template_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersSetTemplateRequest::Representation command.request_object = region_instance_group_managers_set_template_request_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Modifies the target pools to which all new instances in this group are # assigned. Existing instances in the group are not affected. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # Name of the managed instance group. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupManagersSetTargetPoolsRequest] region_instance_group_managers_set_target_pools_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_region_instance_group_manager_target_pools(project, region, instance_group_manager, region_instance_group_managers_set_target_pools_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersSetTargetPoolsRequest::Representation command.request_object = region_instance_group_managers_set_target_pools_request_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_instance_group_manager_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}/instanceGroupManagers/{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 # Updates a managed instance group using the information that you specify in the # request. This operation is marked as DONE when the group is updated even if # the instances in the group have not yet been updated. You must separately # verify the status of the individual instances with the listmanagedinstances # method. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group_manager # The name of the instance group manager. # @param [Google::Apis::ComputeAlpha::InstanceGroupManager] instance_group_manager_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_region_instance_group_manager(project, region, instance_group_manager, instance_group_manager_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupManager::Representation command.request_object = instance_group_manager_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 # Insert or patch (for the ones that already exist) per-instance configs for the # managed instance group. perInstanceConfig.instance serves as a key used to # distinguish whether to perform insert or patch. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request, should conform to RFC1035. # @param [String] instance_group_manager # The name of the managed instance group. It should conform to RFC1035. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupManagerUpdateInstanceConfigReq] region_instance_group_manager_update_instance_config_req_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_region_instance_group_manager_per_instance_configs(project, region, instance_group_manager, region_instance_group_manager_update_instance_config_req_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagerUpdateInstanceConfigReq::Representation command.request_object = region_instance_group_manager_update_instance_config_req_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.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.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 instance group resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group # Name of the instance group resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::InstanceGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::InstanceGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_instance_group(project, region, instance_group, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/instanceGroups/{instanceGroup}', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroup::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroup command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['instanceGroup'] = instance_group unless instance_group.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 the list of instance group resources contained within the specified # region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RegionInstanceGroupList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RegionInstanceGroupList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_instance_groups(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/instanceGroups', options) command.response_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupList::Representation command.response_class = Google::Apis::ComputeAlpha::RegionInstanceGroupList 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['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 instances in the specified instance group and displays information # about the named ports. Depending on the specified options, this method can # list all instances or only the instances that are running. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group # Name of the regional instance group for which we want to list the instances. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstancesRequest] region_instance_groups_list_instances_request_object # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstances] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstances] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_instance_group_instances(project, region, instance_group, region_instance_groups_list_instances_request_object = nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstancesRequest::Representation command.request_object = region_instance_groups_list_instances_request_object command.response_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstances::Representation command.response_class = Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstances command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['instanceGroup'] = instance_group unless instance_group.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['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 named ports for the specified regional instance group. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] instance_group # The name of the regional instance group where the named ports are updated. # @param [Google::Apis::ComputeAlpha::RegionInstanceGroupsSetNamedPortsRequest] region_instance_groups_set_named_ports_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_region_instance_group_named_ports(project, region, instance_group, region_instance_groups_set_named_ports_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupsSetNamedPortsRequest::Representation command.request_object = region_instance_groups_set_named_ports_request_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.params['instanceGroup'] = instance_group unless instance_group.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_instance_group_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}/instanceGroups/{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 region-specific Operations resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] operation # Name of the Operations resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_region_operation(project, region, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/operations/{operation}', options) command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['operation'] = operation unless operation.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 the specified region-specific Operations resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] operation # Name of the Operations resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 get_region_operation(project, region, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/operations/{operation}', 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['operation'] = operation unless operation.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 Operation resources contained within the specified region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::OperationList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::OperationList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region_operations(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/operations', options) command.response_representation = Google::Apis::ComputeAlpha::OperationList::Representation command.response_class = Google::Apis::ComputeAlpha::OperationList 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['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 Region resource. Get a list of available regions by # making a list() request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Region] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Region] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_region(project, region, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}', options) command.response_representation = Google::Apis::ComputeAlpha::Region::Representation command.response_class = Google::Apis::ComputeAlpha::Region command.params['project'] = project unless project.nil? command.params['region'] = region unless region.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 the list of region resources available to the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RegionList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RegionList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_regions(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions', options) command.response_representation = Google::Apis::ComputeAlpha::RegionList::Representation command.response_class = Google::Apis::ComputeAlpha::RegionList command.params['project'] = project unless project.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['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 aggregated list of routers. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RouterAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RouterAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_router_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/routers', options) command.response_representation = Google::Apis::ComputeAlpha::RouterAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::RouterAggregatedList command.params['project'] = project unless project.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['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 Router resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] router # Name of the Router 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_router(project, region, router, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/routers/{router}', 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['router'] = router unless router.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 Router resource. Get a list of available routers by # making a list() request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] router # Name of the Router resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Router] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Router] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_router(project, region, router, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/routers/{router}', options) command.response_representation = Google::Apis::ComputeAlpha::Router::Representation command.response_class = Google::Apis::ComputeAlpha::Router command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['router'] = router unless router.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 runtime information of the specified router. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] router # Name of the Router resource to query. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RouterStatusResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RouterStatusResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_router_router_status(project, region, router, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/routers/{router}/getRouterStatus', options) command.response_representation = Google::Apis::ComputeAlpha::RouterStatusResponse::Representation command.response_class = Google::Apis::ComputeAlpha::RouterStatusResponse command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['router'] = router unless router.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 Router resource in the specified project and region using the data # included in the request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [Google::Apis::ComputeAlpha::Router] router_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_router(project, region, router_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/routers', options) command.request_representation = Google::Apis::ComputeAlpha::Router::Representation command.request_object = router_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 # Retrieves a list of Router resources available to the specified project. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RouterList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RouterList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_routers(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/routers', options) command.response_representation = Google::Apis::ComputeAlpha::RouterList::Representation command.response_class = Google::Apis::ComputeAlpha::RouterList 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['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 # Patches the specified Router resource with the data included in the request. # This method supports PATCH semantics and uses JSON merge patch format and # processing rules. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] router # Name of the Router resource to patch. # @param [Google::Apis::ComputeAlpha::Router] router_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_router(project, region, router, router_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/regions/{region}/routers/{router}', options) command.request_representation = Google::Apis::ComputeAlpha::Router::Representation command.request_object = router_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.params['router'] = router unless router.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 # Preview fields auto-generated during router create and update operations. # Calling this method does NOT create or update the router. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] router # Name of the Router resource to query. # @param [Google::Apis::ComputeAlpha::Router] router_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RoutersPreviewResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RoutersPreviewResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def preview_router(project, region, router, router_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/routers/{router}/preview', options) command.request_representation = Google::Apis::ComputeAlpha::Router::Representation command.request_object = router_object command.response_representation = Google::Apis::ComputeAlpha::RoutersPreviewResponse::Representation command.response_class = Google::Apis::ComputeAlpha::RoutersPreviewResponse command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['router'] = router unless router.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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_router_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}/routers/{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 # Updates the specified Router resource with the data included in the request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] router # Name of the Router resource to update. # @param [Google::Apis::ComputeAlpha::Router] router_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_router(project, region, router, router_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/regions/{region}/routers/{router}', options) command.request_representation = Google::Apis::ComputeAlpha::Router::Representation command.request_object = router_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.params['router'] = router unless router.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 # Deletes the specified Route resource. # @param [String] project # Project ID for this request. # @param [String] route # Name of the Route 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_route(project, route, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/routes/{route}', 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['route'] = route unless route.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 Route resource. Get a list of available routes by making # a list() request. # @param [String] project # Project ID for this request. # @param [String] route # Name of the Route resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Route] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Route] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_route(project, route, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/routes/{route}', options) command.response_representation = Google::Apis::ComputeAlpha::Route::Representation command.response_class = Google::Apis::ComputeAlpha::Route command.params['project'] = project unless project.nil? command.params['route'] = route unless route.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 Route resource in the specified project using the data included in # the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::Route] route_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_route(project, route_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/routes', options) command.request_representation = Google::Apis::ComputeAlpha::Route::Representation command.request_object = route_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of Route resources available to the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::RouteList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::RouteList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_routes(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/routes', options) command.response_representation = Google::Apis::ComputeAlpha::RouteList::Representation command.response_class = Google::Apis::ComputeAlpha::RouteList command.params['project'] = project unless project.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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_route_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/routes/{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['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 # Inserts a rule into a security policy. # @param [String] project # Project ID for this request. # @param [String] security_policy # Name of the security policy to update. # @param [Google::Apis::ComputeAlpha::SecurityPolicyRule] security_policy_rule_object # @param [Boolean] validate_only # If true, the request will not be committed. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 add_security_policy_rule(project, security_policy, security_policy_rule_object = nil, validate_only: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/securityPolicies/{securityPolicy}/addRule', options) command.request_representation = Google::Apis::ComputeAlpha::SecurityPolicyRule::Representation command.request_object = security_policy_rule_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['securityPolicy'] = security_policy unless security_policy.nil? command.query['validateOnly'] = validate_only unless validate_only.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 policy. # @param [String] project # Project ID for this request. # @param [String] security_policy # Name of the security policy 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_security_policy(project, security_policy, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/securityPolicies/{securityPolicy}', 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['securityPolicy'] = security_policy unless security_policy.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 # List all of the ordered rules present in a single specified policy. # @param [String] project # Project ID for this request. # @param [String] security_policy # Name of the security policy to get. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SecurityPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SecurityPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_security_policy(project, security_policy, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/securityPolicies/{securityPolicy}', options) command.response_representation = Google::Apis::ComputeAlpha::SecurityPolicy::Representation command.response_class = Google::Apis::ComputeAlpha::SecurityPolicy command.params['project'] = project unless project.nil? command.params['securityPolicy'] = security_policy unless security_policy.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 rule at the specified priority. # @param [String] project # Project ID for this request. # @param [String] security_policy # Name of the security policy to which the queried rule belongs. # @param [Fixnum] priority # The priority of the rule to get from the security policy. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SecurityPolicyRule] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SecurityPolicyRule] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_security_policy_rule(project, security_policy, priority: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/securityPolicies/{securityPolicy}/getRule', options) command.response_representation = Google::Apis::ComputeAlpha::SecurityPolicyRule::Representation command.response_class = Google::Apis::ComputeAlpha::SecurityPolicyRule command.params['project'] = project unless project.nil? command.params['securityPolicy'] = security_policy unless security_policy.nil? command.query['priority'] = priority unless priority.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 policy in the specified project using the data included in the # request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::SecurityPolicy] security_policy_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_security_policy(project, security_policy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/securityPolicies', options) command.request_representation = Google::Apis::ComputeAlpha::SecurityPolicy::Representation command.request_object = security_policy_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # List all the policies that have been configured for the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SecurityPolicyList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SecurityPolicyList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_security_policies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/securityPolicies', options) command.response_representation = Google::Apis::ComputeAlpha::SecurityPolicyList::Representation command.response_class = Google::Apis::ComputeAlpha::SecurityPolicyList command.params['project'] = project unless project.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['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 # Patches the specified policy with the data included in the request. # @param [String] project # Project ID for this request. # @param [String] security_policy # Name of the security policy to update. # @param [Google::Apis::ComputeAlpha::SecurityPolicy] security_policy_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_security_policy(project, security_policy, security_policy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/securityPolicies/{securityPolicy}', options) command.request_representation = Google::Apis::ComputeAlpha::SecurityPolicy::Representation command.request_object = security_policy_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['securityPolicy'] = security_policy unless security_policy.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 # Patches a rule at the specified priority. # @param [String] project # Project ID for this request. # @param [String] security_policy # Name of the security policy to update. # @param [Google::Apis::ComputeAlpha::SecurityPolicyRule] security_policy_rule_object # @param [Fixnum] priority # The priority of the rule to patch. # @param [Boolean] validate_only # If true, the request will not be committed. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_security_policy_rule(project, security_policy, security_policy_rule_object = nil, priority: nil, validate_only: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/securityPolicies/{securityPolicy}/patchRule', options) command.request_representation = Google::Apis::ComputeAlpha::SecurityPolicyRule::Representation command.request_object = security_policy_rule_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['securityPolicy'] = security_policy unless security_policy.nil? command.query['priority'] = priority unless priority.nil? command.query['validateOnly'] = validate_only unless validate_only.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 a rule at the specified priority. # @param [String] project # Project ID for this request. # @param [String] security_policy # Name of the security policy to update. # @param [Fixnum] priority # The priority of the rule to remove from the security policy. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 remove_security_policy_rule(project, security_policy, priority: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/securityPolicies/{securityPolicy}/removeRule', 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['securityPolicy'] = security_policy unless security_policy.nil? command.query['priority'] = priority unless priority.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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_security_policy_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/securityPolicies/{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['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 # snapshots, the data will be moved to the next corresponding snapshot. # For more information, see Deleting snaphots. # @param [String] project # Project ID for this request. # @param [String] snapshot # Name of the Snapshot 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_snapshot(project, snapshot, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/snapshots/{snapshot}', 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['snapshot'] = snapshot unless snapshot.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 Snapshot resource. Get a list of available snapshots by # making a list() request. # @param [String] project # Project ID for this request. # @param [String] snapshot # Name of the Snapshot resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Snapshot] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Snapshot] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_snapshot(project, snapshot, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/snapshots/{snapshot}', options) command.response_representation = Google::Apis::ComputeAlpha::Snapshot::Representation command.response_class = Google::Apis::ComputeAlpha::Snapshot command.params['project'] = project unless project.nil? command.params['snapshot'] = snapshot unless snapshot.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] resource # Name of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_snapshot_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/snapshots/{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['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 # Retrieves the list of Snapshot resources contained within the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SnapshotList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SnapshotList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_snapshots(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/snapshots', options) command.response_representation = Google::Apis::ComputeAlpha::SnapshotList::Representation command.response_class = Google::Apis::ComputeAlpha::SnapshotList command.params['project'] = project unless project.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['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] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_snapshot_iam_policy(project, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/snapshots/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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['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 # Sets the labels on a snapshot. To learn more about labels, read the Labeling # Resources documentation. # @param [String] project # Project ID for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::GlobalSetLabelsRequest] global_set_labels_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_snapshot_labels(project, resource, global_set_labels_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/snapshots/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::GlobalSetLabelsRequest::Representation command.request_object = global_set_labels_request_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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_snapshot_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/snapshots/{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['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 SslCertificate resource. # @param [String] project # Project ID for this request. # @param [String] ssl_certificate # Name of the SslCertificate 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_ssl_certificate(project, ssl_certificate, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/sslCertificates/{sslCertificate}', 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['sslCertificate'] = ssl_certificate unless ssl_certificate.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 SslCertificate resource. Get a list of available SSL # certificates by making a list() request. # @param [String] project # Project ID for this request. # @param [String] ssl_certificate # Name of the SslCertificate resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SslCertificate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SslCertificate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ssl_certificate(project, ssl_certificate, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/sslCertificates/{sslCertificate}', options) command.response_representation = Google::Apis::ComputeAlpha::SslCertificate::Representation command.response_class = Google::Apis::ComputeAlpha::SslCertificate command.params['project'] = project unless project.nil? command.params['sslCertificate'] = ssl_certificate unless ssl_certificate.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 SslCertificate resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::SslCertificate] ssl_certificate_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_ssl_certificate(project, ssl_certificate_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/sslCertificates', options) command.request_representation = Google::Apis::ComputeAlpha::SslCertificate::Representation command.request_object = ssl_certificate_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of SslCertificate resources available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SslCertificateList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SslCertificateList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ssl_certificates(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/sslCertificates', options) command.response_representation = Google::Apis::ComputeAlpha::SslCertificateList::Representation command.response_class = Google::Apis::ComputeAlpha::SslCertificateList command.params['project'] = project unless project.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['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] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_ssl_certificate_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/sslCertificates/{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['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 SSL policy. The SSL policy resource can be deleted only # if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. # @param [String] project # Project ID for this request. # @param [String] ssl_policy # Name of the SSL policy to delete. The name must be 1-63 characters long, and # comply with RFC1035. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_ssl_policy(project, ssl_policy, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/sslPolicies/{sslPolicy}', 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['sslPolicy'] = ssl_policy unless ssl_policy.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 # List all of the ordered rules present in a single specified policy. # @param [String] project # Project ID for this request. # @param [String] ssl_policy # Name of the SSL policy to update. The name must be 1-63 characters long, and # comply with RFC1035. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SslPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SslPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ssl_policy(project, ssl_policy, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/sslPolicies/{sslPolicy}', options) command.response_representation = Google::Apis::ComputeAlpha::SslPolicy::Representation command.response_class = Google::Apis::ComputeAlpha::SslPolicy command.params['project'] = project unless project.nil? command.params['sslPolicy'] = ssl_policy unless ssl_policy.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 SSL policy resource. Get a list of available SSL # policies by making a list() request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::SslPolicy] ssl_policy_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_ssl_policy(project, ssl_policy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/sslPolicies', options) command.request_representation = Google::Apis::ComputeAlpha::SslPolicy::Representation command.request_object = ssl_policy_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # List all the SSL policies that have been configured for the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SslPoliciesList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SslPoliciesList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ssl_policies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/sslPolicies', options) command.response_representation = Google::Apis::ComputeAlpha::SslPoliciesList::Representation command.response_class = Google::Apis::ComputeAlpha::SslPoliciesList command.params['project'] = project unless project.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['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 features that can be specified in the SSL policy when using custom # profile. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SslPoliciesListAvailableFeaturesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SslPoliciesListAvailableFeaturesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ssl_policy_available_features(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/sslPolicies/listAvailableFeatures', options) command.response_representation = Google::Apis::ComputeAlpha::SslPoliciesListAvailableFeaturesResponse::Representation command.response_class = Google::Apis::ComputeAlpha::SslPoliciesListAvailableFeaturesResponse command.params['project'] = project unless project.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['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 # Patches the specified SSL policy with the data included in the request. # @param [String] project # Project ID for this request. # @param [String] ssl_policy # Name of the SSL policy to update. The name must be 1-63 characters long, and # comply with RFC1035. # @param [Google::Apis::ComputeAlpha::SslPolicy] ssl_policy_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_ssl_policy(project, ssl_policy, ssl_policy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/sslPolicies/{sslPolicy}', options) command.request_representation = Google::Apis::ComputeAlpha::SslPolicy::Representation command.request_object = ssl_policy_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['sslPolicy'] = ssl_policy unless ssl_policy.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_ssl_policy_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/sslPolicies/{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['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 # Retrieves an aggregated list of subnetworks. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SubnetworkAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SubnetworkAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_subnetwork_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/subnetworks', options) command.response_representation = Google::Apis::ComputeAlpha::SubnetworkAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::SubnetworkAggregatedList command.params['project'] = project unless project.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['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 subnetwork. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] subnetwork # Name of the Subnetwork 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_subnetwork(project, region, subnetwork, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/subnetworks/{subnetwork}', 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['subnetwork'] = subnetwork unless subnetwork.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 # Expands the IP CIDR range of the subnetwork to a specified value. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] subnetwork # Name of the Subnetwork resource to update. # @param [Google::Apis::ComputeAlpha::SubnetworksExpandIpCidrRangeRequest] subnetworks_expand_ip_cidr_range_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 expand_subnetwork_ip_cidr_range(project, region, subnetwork, subnetworks_expand_ip_cidr_range_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange', options) command.request_representation = Google::Apis::ComputeAlpha::SubnetworksExpandIpCidrRangeRequest::Representation command.request_object = subnetworks_expand_ip_cidr_range_request_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.params['subnetwork'] = subnetwork unless subnetwork.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 subnetwork. Get a list of available subnetworks list() # request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] subnetwork # Name of the Subnetwork resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Subnetwork] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Subnetwork] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subnetwork(project, region, subnetwork, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/subnetworks/{subnetwork}', options) command.response_representation = Google::Apis::ComputeAlpha::Subnetwork::Representation command.response_class = Google::Apis::ComputeAlpha::Subnetwork command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['subnetwork'] = subnetwork unless subnetwork.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 of the resource for this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_subnetwork_iam_policy(project, region, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/subnetworks/{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['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 subnetwork in the specified project using the data included in the # request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [Google::Apis::ComputeAlpha::Subnetwork] subnetwork_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_subnetwork(project, region, subnetwork_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/subnetworks', options) command.request_representation = Google::Apis::ComputeAlpha::Subnetwork::Representation command.request_object = subnetwork_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 # Retrieves a list of subnetworks available to the specified project. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::SubnetworkList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::SubnetworkList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subnetworks(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/subnetworks', options) command.response_representation = Google::Apis::ComputeAlpha::SubnetworkList::Representation command.response_class = Google::Apis::ComputeAlpha::SubnetworkList 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['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 aggregated list of usable subnetworks. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::UsableSubnetworksAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::UsableSubnetworksAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subnetwork_usable(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/subnetworks/listUsable', options) command.response_representation = Google::Apis::ComputeAlpha::UsableSubnetworksAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::UsableSubnetworksAggregatedList command.params['project'] = project unless project.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['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 # Patches the specified subnetwork with the data included in the request. Only # the following fields within the subnetwork resource can be specified in the # request: secondary_ip_range and allow_subnet_cidr_routes_overlap. It is also # mandatory to specify the current fingeprint of the subnetwork resource being # patched. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] subnetwork # Name of the Subnetwork resource to patch. # @param [Google::Apis::ComputeAlpha::Subnetwork] subnetwork_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_subnetwork(project, region, subnetwork, subnetwork_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/regions/{region}/subnetworks/{subnetwork}', options) command.request_representation = Google::Apis::ComputeAlpha::Subnetwork::Representation command.request_object = subnetwork_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.params['subnetwork'] = subnetwork unless subnetwork.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 # 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 of the resource for this request. # @param [Google::Apis::ComputeAlpha::Policy] policy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_subnetwork_iam_policy(project, region, resource, policy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/subnetworks/{resource}/setIamPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::Policy::Representation command.request_object = policy_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 # Set whether VMs in this subnet can access Google services without assigning # external IP addresses through Private Google Access. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] subnetwork # Name of the Subnetwork resource. # @param [Google::Apis::ComputeAlpha::SubnetworksSetPrivateIpGoogleAccessRequest] subnetworks_set_private_ip_google_access_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_subnetwork_private_ip_google_access(project, region, subnetwork, subnetworks_set_private_ip_google_access_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess', options) command.request_representation = Google::Apis::ComputeAlpha::SubnetworksSetPrivateIpGoogleAccessRequest::Representation command.request_object = subnetworks_set_private_ip_google_access_request_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.params['subnetwork'] = subnetwork unless subnetwork.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_subnetwork_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}/subnetworks/{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 TargetHttpProxy resource. # @param [String] project # Project ID for this request. # @param [String] target_http_proxy # Name of the TargetHttpProxy 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_http_proxy(project, target_http_proxy, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/targetHttpProxies/{targetHttpProxy}', 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['targetHttpProxy'] = target_http_proxy unless target_http_proxy.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 TargetHttpProxy resource. Get a list of available target # HTTP proxies by making a list() request. # @param [String] project # Project ID for this request. # @param [String] target_http_proxy # Name of the TargetHttpProxy resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetHttpProxy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetHttpProxy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_http_proxy(project, target_http_proxy, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetHttpProxies/{targetHttpProxy}', options) command.response_representation = Google::Apis::ComputeAlpha::TargetHttpProxy::Representation command.response_class = Google::Apis::ComputeAlpha::TargetHttpProxy command.params['project'] = project unless project.nil? command.params['targetHttpProxy'] = target_http_proxy unless target_http_proxy.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 TargetHttpProxy resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::TargetHttpProxy] target_http_proxy_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_http_proxy(project, target_http_proxy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetHttpProxies', options) command.request_representation = Google::Apis::ComputeAlpha::TargetHttpProxy::Representation command.request_object = target_http_proxy_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of TargetHttpProxy resources available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetHttpProxyList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetHttpProxyList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_http_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetHttpProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetHttpProxyList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetHttpProxyList command.params['project'] = project unless project.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['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 # Changes the URL map for TargetHttpProxy. # @param [String] project # Project ID for this request. # @param [String] target_http_proxy # Name of the TargetHttpProxy to set a URL map for. # @param [Google::Apis::ComputeAlpha::UrlMapReference] url_map_reference_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_http_proxy_url_map(project, target_http_proxy, url_map_reference_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap', options) command.request_representation = Google::Apis::ComputeAlpha::UrlMapReference::Representation command.request_object = url_map_reference_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['targetHttpProxy'] = target_http_proxy unless target_http_proxy.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_http_proxy_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetHttpProxies/{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['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 TargetHttpsProxy resource. # @param [String] project # Project ID for this request. # @param [String] target_https_proxy # Name of the TargetHttpsProxy 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_https_proxy(project, target_https_proxy, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/targetHttpsProxies/{targetHttpsProxy}', 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['targetHttpsProxy'] = target_https_proxy unless target_https_proxy.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 TargetHttpsProxy resource. Get a list of available # target HTTPS proxies by making a list() request. # @param [String] project # Project ID for this request. # @param [String] target_https_proxy # Name of the TargetHttpsProxy resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetHttpsProxy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetHttpsProxy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_https_proxy(project, target_https_proxy, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetHttpsProxies/{targetHttpsProxy}', options) command.response_representation = Google::Apis::ComputeAlpha::TargetHttpsProxy::Representation command.response_class = Google::Apis::ComputeAlpha::TargetHttpsProxy command.params['project'] = project unless project.nil? command.params['targetHttpsProxy'] = target_https_proxy unless target_https_proxy.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 TargetHttpsProxy resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::TargetHttpsProxy] target_https_proxy_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_https_proxy(project, target_https_proxy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetHttpsProxies', options) command.request_representation = Google::Apis::ComputeAlpha::TargetHttpsProxy::Representation command.request_object = target_https_proxy_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of TargetHttpsProxy resources available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetHttpsProxyList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetHttpsProxyList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_https_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetHttpsProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetHttpsProxyList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetHttpsProxyList command.params['project'] = project unless project.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['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 QUIC override policy for TargetHttpsProxy. # @param [String] project # Project ID for this request. # @param [String] target_https_proxy # Name of the TargetHttpsProxy resource to set the QUIC override policy for. The # name should conform to RFC1035. # @param [Google::Apis::ComputeAlpha::TargetHttpsProxiesSetQuicOverrideRequest] target_https_proxies_set_quic_override_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_https_proxy_quic_override(project, target_https_proxy, target_https_proxies_set_quic_override_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride', options) command.request_representation = Google::Apis::ComputeAlpha::TargetHttpsProxiesSetQuicOverrideRequest::Representation command.request_object = target_https_proxies_set_quic_override_request_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['targetHttpsProxy'] = target_https_proxy unless target_https_proxy.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 # Replaces SslCertificates for TargetHttpsProxy. # @param [String] project # Project ID for this request. # @param [String] target_https_proxy # Name of the TargetHttpsProxy resource to set an SslCertificates resource for. # @param [Google::Apis::ComputeAlpha::TargetHttpsProxiesSetSslCertificatesRequest] target_https_proxies_set_ssl_certificates_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_https_proxy_ssl_certificates(project, target_https_proxy, target_https_proxies_set_ssl_certificates_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates', options) command.request_representation = Google::Apis::ComputeAlpha::TargetHttpsProxiesSetSslCertificatesRequest::Representation command.request_object = target_https_proxies_set_ssl_certificates_request_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['targetHttpsProxy'] = target_https_proxy unless target_https_proxy.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 # Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server- # side support for SSL features. This affects connections between clients and # the HTTPS proxy load balancer. They do not affect the connection between the # load balancer and the backends. # @param [String] project # Project ID for this request. # @param [String] target_https_proxy # Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name # must be 1-63 characters long, and comply with RFC1035. # @param [Google::Apis::ComputeAlpha::SslPolicyReference] ssl_policy_reference_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_https_proxy_ssl_policy(project, target_https_proxy, ssl_policy_reference_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::SslPolicyReference::Representation command.request_object = ssl_policy_reference_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['targetHttpsProxy'] = target_https_proxy unless target_https_proxy.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 # Changes the URL map for TargetHttpsProxy. # @param [String] project # Project ID for this request. # @param [String] target_https_proxy # Name of the TargetHttpsProxy resource whose URL map is to be set. # @param [Google::Apis::ComputeAlpha::UrlMapReference] url_map_reference_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_https_proxy_url_map(project, target_https_proxy, url_map_reference_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap', options) command.request_representation = Google::Apis::ComputeAlpha::UrlMapReference::Representation command.request_object = url_map_reference_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['targetHttpsProxy'] = target_https_proxy unless target_https_proxy.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_https_proxy_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetHttpsProxies/{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['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 # Retrieves an aggregated list of target instances. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetInstanceAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetInstanceAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_target_instance_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetInstances', options) command.response_representation = Google::Apis::ComputeAlpha::TargetInstanceAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetInstanceAggregatedList command.params['project'] = project unless project.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['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 TargetInstance resource. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] target_instance # Name of the TargetInstance 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_instance(project, zone, target_instance, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/zones/{zone}/targetInstances/{targetInstance}', 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['zone'] = zone unless zone.nil? command.params['targetInstance'] = target_instance unless target_instance.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 TargetInstance resource. Get a list of available target # instances by making a list() request. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] target_instance # Name of the TargetInstance resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetInstance] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetInstance] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_instance(project, zone, target_instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/targetInstances/{targetInstance}', options) command.response_representation = Google::Apis::ComputeAlpha::TargetInstance::Representation command.response_class = Google::Apis::ComputeAlpha::TargetInstance command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['targetInstance'] = target_instance unless target_instance.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 TargetInstance resource in the specified project and zone using the # data included in the request. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [Google::Apis::ComputeAlpha::TargetInstance] target_instance_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_instance(project, zone, target_instance_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/targetInstances', options) command.request_representation = Google::Apis::ComputeAlpha::TargetInstance::Representation command.request_object = target_instance_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['zone'] = zone unless zone.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 # Retrieves a list of TargetInstance resources available to the specified # project and zone. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetInstanceList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetInstanceList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_instances(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/targetInstances', options) command.response_representation = Google::Apis::ComputeAlpha::TargetInstanceList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetInstanceList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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] zone # The name of the zone for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_instance_iam_permissions(project, zone, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/targetInstances/{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['zone'] = zone unless zone.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 # Adds health check URLs to a target pool. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] target_pool # Name of the target pool to add a health check to. # @param [Google::Apis::ComputeAlpha::TargetPoolsAddHealthCheckRequest] target_pools_add_health_check_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 add_target_pool_health_check(project, region, target_pool, target_pools_add_health_check_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck', options) command.request_representation = Google::Apis::ComputeAlpha::TargetPoolsAddHealthCheckRequest::Representation command.request_object = target_pools_add_health_check_request_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.params['targetPool'] = target_pool unless target_pool.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 # Adds an instance to a target pool. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] target_pool # Name of the TargetPool resource to add instances to. # @param [Google::Apis::ComputeAlpha::TargetPoolsAddInstanceRequest] target_pools_add_instance_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 add_target_pool_instance(project, region, target_pool, target_pools_add_instance_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/targetPools/{targetPool}/addInstance', options) command.request_representation = Google::Apis::ComputeAlpha::TargetPoolsAddInstanceRequest::Representation command.request_object = target_pools_add_instance_request_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.params['targetPool'] = target_pool unless target_pool.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 # Retrieves an aggregated list of target pools. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetPoolAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetPoolAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_target_pool_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetPools', options) command.response_representation = Google::Apis::ComputeAlpha::TargetPoolAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetPoolAggregatedList command.params['project'] = project unless project.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['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 target pool. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] target_pool # Name of the TargetPool 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_pool(project, region, target_pool, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/targetPools/{targetPool}', 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['targetPool'] = target_pool unless target_pool.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 target pool. Get a list of available target pools by # making a list() request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] target_pool # Name of the TargetPool resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetPool] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetPool] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_pool(project, region, target_pool, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/targetPools/{targetPool}', options) command.response_representation = Google::Apis::ComputeAlpha::TargetPool::Representation command.response_class = Google::Apis::ComputeAlpha::TargetPool command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['targetPool'] = target_pool unless target_pool.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 most recent health check results for each IP for the instance that is # referenced by the given target pool. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] target_pool # Name of the TargetPool resource to which the queried instance belongs. # @param [Google::Apis::ComputeAlpha::InstanceReference] instance_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetPoolInstanceHealth] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetPoolInstanceHealth] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_pool_health(project, region, target_pool, instance_reference_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/targetPools/{targetPool}/getHealth', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceReference::Representation command.request_object = instance_reference_object command.response_representation = Google::Apis::ComputeAlpha::TargetPoolInstanceHealth::Representation command.response_class = Google::Apis::ComputeAlpha::TargetPoolInstanceHealth command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['targetPool'] = target_pool unless target_pool.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 target pool in the specified project and region using the data # included in the request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [Google::Apis::ComputeAlpha::TargetPool] target_pool_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_pool(project, region, target_pool_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/targetPools', options) command.request_representation = Google::Apis::ComputeAlpha::TargetPool::Representation command.request_object = target_pool_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 # Retrieves a list of target pools available to the specified project and region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetPoolList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetPoolList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_pools(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/targetPools', options) command.response_representation = Google::Apis::ComputeAlpha::TargetPoolList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetPoolList 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['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 # Removes health check URL from a target pool. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] target_pool # Name of the target pool to remove health checks from. # @param [Google::Apis::ComputeAlpha::TargetPoolsRemoveHealthCheckRequest] target_pools_remove_health_check_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 remove_target_pool_health_check(project, region, target_pool, target_pools_remove_health_check_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck', options) command.request_representation = Google::Apis::ComputeAlpha::TargetPoolsRemoveHealthCheckRequest::Representation command.request_object = target_pools_remove_health_check_request_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.params['targetPool'] = target_pool unless target_pool.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 # Removes instance URL from a target pool. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] target_pool # Name of the TargetPool resource to remove instances from. # @param [Google::Apis::ComputeAlpha::TargetPoolsRemoveInstanceRequest] target_pools_remove_instance_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 remove_target_pool_instance(project, region, target_pool, target_pools_remove_instance_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/targetPools/{targetPool}/removeInstance', options) command.request_representation = Google::Apis::ComputeAlpha::TargetPoolsRemoveInstanceRequest::Representation command.request_object = target_pools_remove_instance_request_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.params['targetPool'] = target_pool unless target_pool.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 # Changes a backup target pool's configurations. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] target_pool # Name of the TargetPool resource to set a backup pool for. # @param [Google::Apis::ComputeAlpha::TargetReference] target_reference_object # @param [Float] failover_ratio # New failoverRatio value for the target pool. # @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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_pool_backup(project, region, target_pool, target_reference_object = nil, failover_ratio: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/targetPools/{targetPool}/setBackup', options) command.request_representation = Google::Apis::ComputeAlpha::TargetReference::Representation command.request_object = target_reference_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.params['targetPool'] = target_pool unless target_pool.nil? command.query['failoverRatio'] = failover_ratio unless failover_ratio.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_pool_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}/targetPools/{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 TargetSslProxy resource. # @param [String] project # Project ID for this request. # @param [String] target_ssl_proxy # Name of the TargetSslProxy 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_ssl_proxy(project, target_ssl_proxy, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/targetSslProxies/{targetSslProxy}', 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['targetSslProxy'] = target_ssl_proxy unless target_ssl_proxy.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 TargetSslProxy resource. Get a list of available target # SSL proxies by making a list() request. # @param [String] project # Project ID for this request. # @param [String] target_ssl_proxy # Name of the TargetSslProxy resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetSslProxy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetSslProxy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_ssl_proxy(project, target_ssl_proxy, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetSslProxies/{targetSslProxy}', options) command.response_representation = Google::Apis::ComputeAlpha::TargetSslProxy::Representation command.response_class = Google::Apis::ComputeAlpha::TargetSslProxy command.params['project'] = project unless project.nil? command.params['targetSslProxy'] = target_ssl_proxy unless target_ssl_proxy.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 TargetSslProxy resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::TargetSslProxy] target_ssl_proxy_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_ssl_proxy(project, target_ssl_proxy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetSslProxies', options) command.request_representation = Google::Apis::ComputeAlpha::TargetSslProxy::Representation command.request_object = target_ssl_proxy_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of TargetSslProxy resources available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetSslProxyList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetSslProxyList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_ssl_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetSslProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetSslProxyList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetSslProxyList command.params['project'] = project unless project.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['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 # Changes the BackendService for TargetSslProxy. # @param [String] project # Project ID for this request. # @param [String] target_ssl_proxy # Name of the TargetSslProxy resource whose BackendService resource is to be set. # @param [Google::Apis::ComputeAlpha::TargetSslProxiesSetBackendServiceRequest] target_ssl_proxies_set_backend_service_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_ssl_proxy_backend_service(project, target_ssl_proxy, target_ssl_proxies_set_backend_service_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetSslProxies/{targetSslProxy}/setBackendService', options) command.request_representation = Google::Apis::ComputeAlpha::TargetSslProxiesSetBackendServiceRequest::Representation command.request_object = target_ssl_proxies_set_backend_service_request_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['targetSslProxy'] = target_ssl_proxy unless target_ssl_proxy.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 # Changes the ProxyHeaderType for TargetSslProxy. # @param [String] project # Project ID for this request. # @param [String] target_ssl_proxy # Name of the TargetSslProxy resource whose ProxyHeader is to be set. # @param [Google::Apis::ComputeAlpha::TargetSslProxiesSetProxyHeaderRequest] target_ssl_proxies_set_proxy_header_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_ssl_proxy_proxy_header(project, target_ssl_proxy, target_ssl_proxies_set_proxy_header_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader', options) command.request_representation = Google::Apis::ComputeAlpha::TargetSslProxiesSetProxyHeaderRequest::Representation command.request_object = target_ssl_proxies_set_proxy_header_request_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['targetSslProxy'] = target_ssl_proxy unless target_ssl_proxy.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 # Changes SslCertificates for TargetSslProxy. # @param [String] project # Project ID for this request. # @param [String] target_ssl_proxy # Name of the TargetSslProxy resource whose SslCertificate resource is to be set. # @param [Google::Apis::ComputeAlpha::TargetSslProxiesSetSslCertificatesRequest] target_ssl_proxies_set_ssl_certificates_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_ssl_proxy_ssl_certificates(project, target_ssl_proxy, target_ssl_proxies_set_ssl_certificates_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates', options) command.request_representation = Google::Apis::ComputeAlpha::TargetSslProxiesSetSslCertificatesRequest::Representation command.request_object = target_ssl_proxies_set_ssl_certificates_request_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['targetSslProxy'] = target_ssl_proxy unless target_ssl_proxy.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 # Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server- # side support for SSL features. This affects connections between clients and # the SSL proxy load balancer. They do not affect the connection between the # load balancer and the backends. # @param [String] project # Project ID for this request. # @param [String] target_ssl_proxy # Name of the TargetSslProxy resource whose SSL policy is to be set. The name # must be 1-63 characters long, and comply with RFC1035. # @param [Google::Apis::ComputeAlpha::SslPolicyReference] ssl_policy_reference_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_ssl_proxy_ssl_policy(project, target_ssl_proxy, ssl_policy_reference_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy', options) command.request_representation = Google::Apis::ComputeAlpha::SslPolicyReference::Representation command.request_object = ssl_policy_reference_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['targetSslProxy'] = target_ssl_proxy unless target_ssl_proxy.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_ssl_proxy_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetSslProxies/{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['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 TargetTcpProxy resource. # @param [String] project # Project ID for this request. # @param [String] target_tcp_proxy # Name of the TargetTcpProxy 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_tcp_proxy(project, target_tcp_proxy, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/targetTcpProxies/{targetTcpProxy}', 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['targetTcpProxy'] = target_tcp_proxy unless target_tcp_proxy.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 TargetTcpProxy resource. Get a list of available target # TCP proxies by making a list() request. # @param [String] project # Project ID for this request. # @param [String] target_tcp_proxy # Name of the TargetTcpProxy resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetTcpProxy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetTcpProxy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_tcp_proxy(project, target_tcp_proxy, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetTcpProxies/{targetTcpProxy}', options) command.response_representation = Google::Apis::ComputeAlpha::TargetTcpProxy::Representation command.response_class = Google::Apis::ComputeAlpha::TargetTcpProxy command.params['project'] = project unless project.nil? command.params['targetTcpProxy'] = target_tcp_proxy unless target_tcp_proxy.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 TargetTcpProxy resource in the specified project using the data # included in the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::TargetTcpProxy] target_tcp_proxy_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_tcp_proxy(project, target_tcp_proxy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetTcpProxies', options) command.request_representation = Google::Apis::ComputeAlpha::TargetTcpProxy::Representation command.request_object = target_tcp_proxy_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Retrieves the list of TargetTcpProxy resources available to the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetTcpProxyList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetTcpProxyList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_tcp_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetTcpProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetTcpProxyList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetTcpProxyList command.params['project'] = project unless project.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['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 # Changes the BackendService for TargetTcpProxy. # @param [String] project # Project ID for this request. # @param [String] target_tcp_proxy # Name of the TargetTcpProxy resource whose BackendService resource is to be set. # @param [Google::Apis::ComputeAlpha::TargetTcpProxiesSetBackendServiceRequest] target_tcp_proxies_set_backend_service_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_tcp_proxy_backend_service(project, target_tcp_proxy, target_tcp_proxies_set_backend_service_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService', options) command.request_representation = Google::Apis::ComputeAlpha::TargetTcpProxiesSetBackendServiceRequest::Representation command.request_object = target_tcp_proxies_set_backend_service_request_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['targetTcpProxy'] = target_tcp_proxy unless target_tcp_proxy.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 # Changes the ProxyHeaderType for TargetTcpProxy. # @param [String] project # Project ID for this request. # @param [String] target_tcp_proxy # Name of the TargetTcpProxy resource whose ProxyHeader is to be set. # @param [Google::Apis::ComputeAlpha::TargetTcpProxiesSetProxyHeaderRequest] target_tcp_proxies_set_proxy_header_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_tcp_proxy_proxy_header(project, target_tcp_proxy, target_tcp_proxies_set_proxy_header_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader', options) command.request_representation = Google::Apis::ComputeAlpha::TargetTcpProxiesSetProxyHeaderRequest::Representation command.request_object = target_tcp_proxies_set_proxy_header_request_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['targetTcpProxy'] = target_tcp_proxy unless target_tcp_proxy.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_tcp_proxy_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/targetTcpProxies/{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['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 # Retrieves an aggregated list of target VPN gateways. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_target_vpn_gateway_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetVpnGateways', options) command.response_representation = Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList command.params['project'] = project unless project.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['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 target VPN gateway. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] target_vpn_gateway # Name of the target VPN gateway 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_vpn_gateway(project, region, target_vpn_gateway, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}', 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['targetVpnGateway'] = target_vpn_gateway unless target_vpn_gateway.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 target VPN gateway. Get a list of available target VPN # gateways by making a list() request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] target_vpn_gateway # Name of the target VPN gateway to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetVpnGateway] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetVpnGateway] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_vpn_gateway(project, region, target_vpn_gateway, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}', options) command.response_representation = Google::Apis::ComputeAlpha::TargetVpnGateway::Representation command.response_class = Google::Apis::ComputeAlpha::TargetVpnGateway command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['targetVpnGateway'] = target_vpn_gateway unless target_vpn_gateway.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 target VPN gateway in the specified project and region using the # data included in the request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [Google::Apis::ComputeAlpha::TargetVpnGateway] target_vpn_gateway_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_vpn_gateway(project, region, target_vpn_gateway_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/targetVpnGateways', options) command.request_representation = Google::Apis::ComputeAlpha::TargetVpnGateway::Representation command.request_object = target_vpn_gateway_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 # Retrieves a list of target VPN gateways available to the specified project and # region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::TargetVpnGatewayList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::TargetVpnGatewayList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_target_vpn_gateways(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/targetVpnGateways', options) command.response_representation = Google::Apis::ComputeAlpha::TargetVpnGatewayList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetVpnGatewayList 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['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 labels on a TargetVpnGateway. To learn more about labels, read the # Labeling Resources documentation. # @param [String] project # Project ID for this request. # @param [String] region # The region for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::RegionSetLabelsRequest] region_set_labels_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_target_vpn_gateway_labels(project, region, resource, region_set_labels_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/targetVpnGateways/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::RegionSetLabelsRequest::Representation command.request_object = region_set_labels_request_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.params['resource'] = resource unless resource.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_target_vpn_gateway_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}/targetVpnGateways/{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 UrlMap resource. # @param [String] project # Project ID for this request. # @param [String] url_map # Name of the UrlMap 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_url_map(project, url_map, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/urlMaps/{urlMap}', 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['urlMap'] = url_map unless url_map.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 UrlMap resource. Get a list of available URL maps by # making a list() request. # @param [String] project # Project ID for this request. # @param [String] url_map # Name of the UrlMap resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::UrlMap] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::UrlMap] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_url_map(project, url_map, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/urlMaps/{urlMap}', options) command.response_representation = Google::Apis::ComputeAlpha::UrlMap::Representation command.response_class = Google::Apis::ComputeAlpha::UrlMap command.params['project'] = project unless project.nil? command.params['urlMap'] = url_map unless url_map.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 UrlMap resource in the specified project using the data included in # the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::UrlMap] url_map_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_url_map(project, url_map_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/urlMaps', options) command.request_representation = Google::Apis::ComputeAlpha::UrlMap::Representation command.request_object = url_map_object command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation command.response_class = Google::Apis::ComputeAlpha::Operation command.params['project'] = project unless project.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 # Initiates a cache invalidation operation, invalidating the specified path, # scoped to the specified UrlMap. # @param [String] project # Project ID for this request. # @param [String] url_map # Name of the UrlMap scoping this request. # @param [Google::Apis::ComputeAlpha::CacheInvalidationRule] cache_invalidation_rule_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 invalidate_url_map_cache(project, url_map, cache_invalidation_rule_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/urlMaps/{urlMap}/invalidateCache', options) command.request_representation = Google::Apis::ComputeAlpha::CacheInvalidationRule::Representation command.request_object = cache_invalidation_rule_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['urlMap'] = url_map unless url_map.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 # Retrieves the list of UrlMap resources available to the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::UrlMapList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::UrlMapList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_url_maps(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/urlMaps', options) command.response_representation = Google::Apis::ComputeAlpha::UrlMapList::Representation command.response_class = Google::Apis::ComputeAlpha::UrlMapList command.params['project'] = project unless project.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['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 # Patches the specified UrlMap resource with the data included in the request. # This method supports PATCH semantics and uses the JSON merge patch format and # processing rules. # @param [String] project # Project ID for this request. # @param [String] url_map # Name of the UrlMap resource to patch. # @param [Google::Apis::ComputeAlpha::UrlMap] url_map_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 patch_url_map(project, url_map, url_map_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/urlMaps/{urlMap}', options) command.request_representation = Google::Apis::ComputeAlpha::UrlMap::Representation command.request_object = url_map_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['urlMap'] = url_map unless url_map.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 permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. # @param [String] resource # Name 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_url_map_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/urlMaps/{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['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 # Updates the specified UrlMap resource with the data included in the request. # @param [String] project # Project ID for this request. # @param [String] url_map # Name of the UrlMap resource to update. # @param [Google::Apis::ComputeAlpha::UrlMap] url_map_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_url_map(project, url_map, url_map_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/urlMaps/{urlMap}', options) command.request_representation = Google::Apis::ComputeAlpha::UrlMap::Representation command.request_object = url_map_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['urlMap'] = url_map unless url_map.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 # Runs static validation for the UrlMap. In particular, the tests of the # provided UrlMap will be run. Calling this method does NOT create the UrlMap. # @param [String] project # Project ID for this request. # @param [String] url_map # Name of the UrlMap resource to be validated as. # @param [Google::Apis::ComputeAlpha::UrlMapsValidateRequest] url_maps_validate_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::UrlMapsValidateResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::UrlMapsValidateResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_url_map(project, url_map, url_maps_validate_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/urlMaps/{urlMap}/validate', options) command.request_representation = Google::Apis::ComputeAlpha::UrlMapsValidateRequest::Representation command.request_object = url_maps_validate_request_object command.response_representation = Google::Apis::ComputeAlpha::UrlMapsValidateResponse::Representation command.response_class = Google::Apis::ComputeAlpha::UrlMapsValidateResponse command.params['project'] = project unless project.nil? command.params['urlMap'] = url_map unless url_map.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 aggregated list of VPN tunnels. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::VpnTunnelAggregatedList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::VpnTunnelAggregatedList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def aggregated_vpn_tunnel_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/vpnTunnels', options) command.response_representation = Google::Apis::ComputeAlpha::VpnTunnelAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::VpnTunnelAggregatedList command.params['project'] = project unless project.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['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 VpnTunnel resource. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] vpn_tunnel # Name of the VpnTunnel 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_vpn_tunnel(project, region, vpn_tunnel, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/regions/{region}/vpnTunnels/{vpnTunnel}', 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['vpnTunnel'] = vpn_tunnel unless vpn_tunnel.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 VpnTunnel resource. Get a list of available VPN tunnels # by making a list() request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] vpn_tunnel # Name of the VpnTunnel resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::VpnTunnel] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::VpnTunnel] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_vpn_tunnel(project, region, vpn_tunnel, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/vpnTunnels/{vpnTunnel}', options) command.response_representation = Google::Apis::ComputeAlpha::VpnTunnel::Representation command.response_class = Google::Apis::ComputeAlpha::VpnTunnel command.params['project'] = project unless project.nil? command.params['region'] = region unless region.nil? command.params['vpnTunnel'] = vpn_tunnel unless vpn_tunnel.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 VpnTunnel resource in the specified project and region using the # data included in the request. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [Google::Apis::ComputeAlpha::VpnTunnel] vpn_tunnel_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_vpn_tunnel(project, region, vpn_tunnel_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/vpnTunnels', options) command.request_representation = Google::Apis::ComputeAlpha::VpnTunnel::Representation command.request_object = vpn_tunnel_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 # Retrieves a list of VpnTunnel resources contained in the specified project and # region. # @param [String] project # Project ID for this request. # @param [String] region # Name of the region for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::VpnTunnelList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::VpnTunnelList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_vpn_tunnels(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/vpnTunnels', options) command.response_representation = Google::Apis::ComputeAlpha::VpnTunnelList::Representation command.response_class = Google::Apis::ComputeAlpha::VpnTunnelList 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['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 labels on a VpnTunnel. To learn more about labels, read the Labeling # Resources documentation. # @param [String] project # Project ID for this request. # @param [String] region # The region for this request. # @param [String] resource # Name of the resource for this request. # @param [Google::Apis::ComputeAlpha::RegionSetLabelsRequest] region_set_labels_request_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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 set_vpn_tunnel_labels(project, region, resource, region_set_labels_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/vpnTunnels/{resource}/setLabels', options) command.request_representation = Google::Apis::ComputeAlpha::RegionSetLabelsRequest::Representation command.request_object = region_set_labels_request_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.params['resource'] = resource unless resource.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 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 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_vpn_tunnel_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}/vpnTunnels/{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 zone-specific Operations resource. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [String] operation # Name of the Operations resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_zone_operation(project, zone, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/zones/{zone}/operations/{operation}', options) command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['operation'] = operation unless operation.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 the specified zone-specific Operations resource. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [String] operation # Name of the Operations resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 get_zone_operation(project, zone, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/operations/{operation}', 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['zone'] = zone unless zone.nil? command.params['operation'] = operation unless operation.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 Operation resources contained within the specified zone. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::OperationList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::OperationList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zone_operations(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/operations', options) command.response_representation = Google::Apis::ComputeAlpha::OperationList::Representation command.response_class = Google::Apis::ComputeAlpha::OperationList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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['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 Zone resource. Get a list of available zones by making a # list() request. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::Zone] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::Zone] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zone(project, zone, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}', options) command.response_representation = Google::Apis::ComputeAlpha::Zone::Representation command.response_class = Google::Apis::ComputeAlpha::Zone command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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 the list of Zone resources available to the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter `expression` for filtering listed resources. Your `expression` # must be in the format: field_name comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use name ne example-instance. # You can filter on nested fields. For example, you could filter on instances # that have set the scheduling.automaticRestart field to true. Use filtering on # nested fields to take advantage of labels to organize and search for results # based on label values. # To filter on multiple expressions, provide each separate expression within # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- # central1-f). Multiple expressions are treated as AND expressions, meaning that # resources must match all expressions to pass the filters. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ComputeAlpha::ZoneList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ComputeAlpha::ZoneList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zones(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones', options) command.response_representation = Google::Apis::ComputeAlpha::ZoneList::Representation command.response_class = Google::Apis::ComputeAlpha::ZoneList command.params['project'] = project unless project.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['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 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 end end google-api-client-0.19.8/generated/google/apis/replicapoolupdater_v1beta1/0000755000004100000410000000000013252673044026535 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/replicapoolupdater_v1beta1/representations.rb0000644000004100000410000002654613252673044032324 0ustar www-datawww-data# 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 ReplicapoolupdaterV1beta1 class InstanceUpdate class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error 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 InstanceUpdateList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Operation class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport 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 OperationList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RollingUpdate class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class RollingUpdateList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceUpdate # @private class Representation < Google::Apis::Core::JsonRepresentation property :error, as: 'error', class: Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdate::Error, decorator: Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdate::Error::Representation property :instance, as: 'instance' property :status, as: 'status' end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdate::Error::Error, decorator: Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdate::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end end class InstanceUpdateList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdate, decorator: Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdate::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_operation_id, as: 'clientOperationId' property :creation_timestamp, as: 'creationTimestamp' property :end_time, as: 'endTime' property :error, as: 'error', class: Google::Apis::ReplicapoolupdaterV1beta1::Operation::Error, decorator: Google::Apis::ReplicapoolupdaterV1beta1::Operation::Error::Representation property :http_error_message, as: 'httpErrorMessage' property :http_error_status_code, as: 'httpErrorStatusCode' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' property :kind, as: 'kind' property :name, as: 'name' property :operation_type, as: 'operationType' property :progress, as: 'progress' property :region, as: 'region' property :self_link, as: 'selfLink' property :start_time, as: 'startTime' property :status, as: 'status' property :status_message, as: 'statusMessage' property :target_id, :numeric_string => true, as: 'targetId' property :target_link, as: 'targetLink' property :user, as: 'user' collection :warnings, as: 'warnings', class: Google::Apis::ReplicapoolupdaterV1beta1::Operation::Warning, decorator: Google::Apis::ReplicapoolupdaterV1beta1::Operation::Warning::Representation property :zone, as: 'zone' end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::ReplicapoolupdaterV1beta1::Operation::Error::Error, decorator: Google::Apis::ReplicapoolupdaterV1beta1::Operation::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ReplicapoolupdaterV1beta1::Operation::Warning::Datum, decorator: Google::Apis::ReplicapoolupdaterV1beta1::Operation::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 OperationList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ReplicapoolupdaterV1beta1::Operation, decorator: Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end class RollingUpdate # @private class Representation < Google::Apis::Core::JsonRepresentation property :action_type, as: 'actionType' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :error, as: 'error', class: Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Error, decorator: Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Error::Representation property :id, as: 'id' property :instance_group, as: 'instanceGroup' property :instance_group_manager, as: 'instanceGroupManager' property :instance_template, as: 'instanceTemplate' property :kind, as: 'kind' property :old_instance_template, as: 'oldInstanceTemplate' property :policy, as: 'policy', class: Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Policy, decorator: Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Policy::Representation property :progress, as: 'progress' property :self_link, as: 'selfLink' property :status, as: 'status' property :status_message, as: 'statusMessage' property :user, as: 'user' end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Error::Error, decorator: Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_pause_after_instances, as: 'autoPauseAfterInstances' property :instance_startup_timeout_sec, as: 'instanceStartupTimeoutSec' property :max_num_concurrent_instances, as: 'maxNumConcurrentInstances' property :max_num_failed_instances, as: 'maxNumFailedInstances' property :min_instance_update_time_sec, as: 'minInstanceUpdateTimeSec' end end end class RollingUpdateList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate, decorator: Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end end end end google-api-client-0.19.8/generated/google/apis/replicapoolupdater_v1beta1/classes.rb0000644000004100000410000007134413252673044030530 0ustar www-datawww-data# 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 ReplicapoolupdaterV1beta1 # Update of a single instance. class InstanceUpdate include Google::Apis::Core::Hashable # Errors that occurred during the instance update. # Corresponds to the JSON property `error` # @return [Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdate::Error] attr_accessor :error # Fully-qualified URL of the instance being updated. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # Status of the instance update. Possible values are: # - "PENDING": The instance update is pending execution. # - "ROLLING_FORWARD": The instance update is going forward. # - "ROLLING_BACK": The instance update is being rolled back. # - "PAUSED": The instance update is temporarily paused (inactive). # - "ROLLED_OUT": The instance update is finished, the instance is running the # new template. # - "ROLLED_BACK": The instance update is finished, the instance has been # reverted to the previous template. # - "CANCELLED": The instance update is paused and no longer can be resumed, # undefined in which template the instance is running. # 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) @error = args[:error] if args.key?(:error) @instance = args[:instance] if args.key?(:instance) @status = args[:status] if args.key?(:status) end # Errors that occurred during the instance update. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end end # Response returned by ListInstanceUpdates method. class InstanceUpdateList include Google::Apis::Core::Hashable # Collection of requested instance updates. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of the resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # [Output Only] The fully qualified 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) @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) end end # An operation resource, used to manage asynchronous API requests. class Operation include Google::Apis::Core::Hashable # # Corresponds to the JSON property `clientOperationId` # @return [String] attr_accessor :client_operation_id # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # [Output Only] If errors occurred during processing of this operation, this # field will be populated. # Corresponds to the JSON property `error` # @return [Google::Apis::ReplicapoolupdaterV1beta1::Operation::Error] attr_accessor :error # # Corresponds to the JSON property `httpErrorMessage` # @return [String] attr_accessor :http_error_message # # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] attr_accessor :http_error_status_code # [Output Only] Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The time that this operation was requested. This is in RFC 3339 # format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # [Output Only] Type of the resource. Always replicapoolupdater#operation for # Operation resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # # Corresponds to the JSON property `progress` # @return [Fixnum] attr_accessor :progress # [Output Only] URL of the region where the operation resides. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # [Output Only] The fully qualified URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] The time that this operation was started by the server. This is # in RFC 3339 format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # [Output Only] Status of the operation. Can be one of the following: "PENDING", # "RUNNING", or "DONE". # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional textual description of the current status of the # operation. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # [Output Only] Unique target id which identifies a particular incarnation of # the target. # Corresponds to the JSON property `targetId` # @return [Fixnum] attr_accessor :target_id # [Output Only] URL of the resource the operation is mutating. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link # # Corresponds to the JSON property `user` # @return [String] attr_accessor :user # # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings # [Output Only] URL of the zone where the operation resides. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @end_time = args[:end_time] if args.key?(:end_time) @error = args[:error] if args.key?(:error) @http_error_message = args[:http_error_message] if args.key?(:http_error_message) @http_error_status_code = args[:http_error_status_code] if args.key?(:http_error_status_code) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @operation_type = args[:operation_type] if args.key?(:operation_type) @progress = args[:progress] if args.key?(:progress) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @target_id = args[:target_id] if args.key?(:target_id) @target_link = args[:target_link] if args.key?(:target_link) @user = args[:user] if args.key?(:user) @warnings = args[:warnings] if args.key?(:warnings) @zone = args[:zone] if args.key?(:zone) end # [Output Only] If errors occurred during processing of this operation, this # field will be populated. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end # class Warning include Google::Apis::Core::Hashable # [Output only] The warning type identifier for this warning. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output only] Metadata for this warning in key:value format. # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data # [Output only] Optional human-readable details for this warning. # 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] Metadata key for this warning. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # [Output Only] Metadata value for this warning. # 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 # Contains a list of Operation resources. class OperationList 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 # [Output Only] The Operation resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always replicapoolupdater#operationList for # OperationList resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] A token used to continue a truncate. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # [Output Only] The fully qualified 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) @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) end end # The following represents a resource describing a single update (rollout) of a # group of instances to the given template. class RollingUpdate include Google::Apis::Core::Hashable # Specifies the action to take for each instance within the instance group. This # can be RECREATE which will recreate each instance and is only available for # managed instance groups. It can also be REBOOT which performs a soft reboot # for each instance and is only available for regular (non-managed) instance # groups. # Corresponds to the JSON property `actionType` # @return [String] attr_accessor :action_type # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] Errors that occurred during the rolling update. # Corresponds to the JSON property `error` # @return [Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Error] attr_accessor :error # [Output Only] Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Fully-qualified URL of an instance group being updated. Exactly one of # instanceGroupManager and instanceGroup must be set. # Corresponds to the JSON property `instanceGroup` # @return [String] attr_accessor :instance_group # Fully-qualified URL of an instance group manager being updated. Exactly one of # instanceGroupManager and instanceGroup must be set. # Corresponds to the JSON property `instanceGroupManager` # @return [String] attr_accessor :instance_group_manager # Fully-qualified URL of an instance template to apply. # Corresponds to the JSON property `instanceTemplate` # @return [String] attr_accessor :instance_template # [Output Only] Type of the resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Fully-qualified URL of the instance template encountered while starting the # update. # Corresponds to the JSON property `oldInstanceTemplate` # @return [String] attr_accessor :old_instance_template # Parameters of the update process. # Corresponds to the JSON property `policy` # @return [Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Policy] attr_accessor :policy # [Output Only] An optional progress indicator that ranges from 0 to 100. There # is no requirement that this be linear or support any granularity of operations. # This should not be used to guess at when the update will be complete. This # number should be monotonically increasing as the update progresses. # Corresponds to the JSON property `progress` # @return [Fixnum] attr_accessor :progress # [Output Only] The fully qualified URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # [Output Only] Status of the update. Possible values are: # - "ROLLING_FORWARD": The update is going forward. # - "ROLLING_BACK": The update is being rolled back. # - "PAUSED": The update is temporarily paused (inactive). # - "ROLLED_OUT": The update is finished, all instances have been updated # successfully. # - "ROLLED_BACK": The update is finished, all instances have been reverted to # the previous template. # - "CANCELLED": The update is paused and no longer can be resumed, undefined # how many instances are running in which template. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional textual description of the current status of the # update. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # [Output Only] User who requested the update, for example: user@example.com. # Corresponds to the JSON property `user` # @return [String] attr_accessor :user def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action_type = args[:action_type] if args.key?(:action_type) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @error = args[:error] if args.key?(:error) @id = args[:id] if args.key?(:id) @instance_group = args[:instance_group] if args.key?(:instance_group) @instance_group_manager = args[:instance_group_manager] if args.key?(:instance_group_manager) @instance_template = args[:instance_template] if args.key?(:instance_template) @kind = args[:kind] if args.key?(:kind) @old_instance_template = args[:old_instance_template] if args.key?(:old_instance_template) @policy = args[:policy] if args.key?(:policy) @progress = args[:progress] if args.key?(:progress) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @user = args[:user] if args.key?(:user) end # [Output Only] Errors that occurred during the rolling update. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end # Parameters of the update process. class Policy include Google::Apis::Core::Hashable # Number of instances to update before the updater pauses the rolling update. # Corresponds to the JSON property `autoPauseAfterInstances` # @return [Fixnum] attr_accessor :auto_pause_after_instances # The maximum amount of time that the updater waits for a HEALTHY state after # all of the update steps are complete. If the HEALTHY state is not received # before the deadline, the instance update is considered a failure. # Corresponds to the JSON property `instanceStartupTimeoutSec` # @return [Fixnum] attr_accessor :instance_startup_timeout_sec # The maximum number of instances that can be updated simultaneously. An # instance update is considered complete only after the instance is restarted # and initialized. # Corresponds to the JSON property `maxNumConcurrentInstances` # @return [Fixnum] attr_accessor :max_num_concurrent_instances # The maximum number of instance updates that can fail before the group update # is considered a failure. An instance update is considered failed if any of its # update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed # with permanent failure, or if the instance is in an UNHEALTHY state after it # finishes all of the update actions. # Corresponds to the JSON property `maxNumFailedInstances` # @return [Fixnum] attr_accessor :max_num_failed_instances # The minimum amount of time that the updater spends to update each instance. # Update time is the time it takes to complete all update actions (e.g. Stop # call on Instance resource in Rolling Reboot), reboot, and initialize. If the # instance update finishes early, the updater pauses for the remainder of the # time before it starts the next instance update. # Corresponds to the JSON property `minInstanceUpdateTimeSec` # @return [Fixnum] attr_accessor :min_instance_update_time_sec def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_pause_after_instances = args[:auto_pause_after_instances] if args.key?(:auto_pause_after_instances) @instance_startup_timeout_sec = args[:instance_startup_timeout_sec] if args.key?(:instance_startup_timeout_sec) @max_num_concurrent_instances = args[:max_num_concurrent_instances] if args.key?(:max_num_concurrent_instances) @max_num_failed_instances = args[:max_num_failed_instances] if args.key?(:max_num_failed_instances) @min_instance_update_time_sec = args[:min_instance_update_time_sec] if args.key?(:min_instance_update_time_sec) end end end # Response returned by List method. class RollingUpdateList include Google::Apis::Core::Hashable # Collection of requested updates. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of the resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A token used to continue a truncated list request. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # [Output Only] The fully qualified 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) @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) end end end end end google-api-client-0.19.8/generated/google/apis/replicapoolupdater_v1beta1/service.rb0000644000004100000410000007303213252673044030527 0ustar www-datawww-data# 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 ReplicapoolupdaterV1beta1 # Google Compute Engine Instance Group Updater API # # [Deprecated. Please use compute.instanceGroupManagers.update method. # replicapoolupdater API will be disabled after December 30th, 2016] Updates # groups of Compute Engine instances. # # @example # require 'google/apis/replicapoolupdater_v1beta1' # # Replicapoolupdater = Google::Apis::ReplicapoolupdaterV1beta1 # Alias the module # service = Replicapoolupdater::ReplicapoolupdaterService.new # # @see https://cloud.google.com/compute/docs/instance-groups/manager/#applying_rolling_updates_using_the_updater_service class ReplicapoolupdaterService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'replicapoolupdater/v1beta1/projects/') @batch_path = 'batch/replicapoolupdater/v1beta1' end # Cancels an update. The update must be PAUSED before it can be cancelled. This # has no effect if the update is already CANCELLED. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the update's target resides. # @param [String] rolling_update # The name of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolupdaterV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolupdaterV1beta1::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 cancel_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}/cancel', options) command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['rollingUpdate'] = rolling_update unless rolling_update.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 an update. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the update's target resides. # @param [String] rolling_update # The name of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}', options) command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Representation command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['rollingUpdate'] = rolling_update unless rolling_update.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 # Inserts and starts a new update. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the update's target resides. # @param [Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate] rolling_update_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolupdaterV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolupdaterV1beta1::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_rolling_update(project, zone, rolling_update_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/rollingUpdates', options) command.request_representation = Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Representation command.request_object = rolling_update_object command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.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 recent updates for a given managed instance group, in reverse # chronological order and paginated format. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the update's target resides. # @param [String] filter # Optional. Filter expression for filtering listed resources. # @param [Fixnum] max_results # Optional. Maximum count of results to be returned. Maximum value is 500 and # default value is 500. # @param [String] page_token # Optional. Tag returned by a previous list request truncated by maxResults. # Used to continue 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdateList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdateList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_rolling_updates(project, zone, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/rollingUpdates', options) command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdateList::Representation command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdateList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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 # Lists the current status for each instance within a given update. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the update's target resides. # @param [String] rolling_update # The name of the update. # @param [String] filter # Optional. Filter expression for filtering listed resources. # @param [Fixnum] max_results # Optional. Maximum count of results to be returned. Maximum value is 500 and # default value is 500. # @param [String] page_token # Optional. Tag returned by a previous list request truncated by maxResults. # Used to continue 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdateList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdateList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_instance_updates(project, zone, rolling_update, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}/instanceUpdates', options) command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdateList::Representation command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::InstanceUpdateList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['rollingUpdate'] = rolling_update unless rolling_update.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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 # Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect # if invoked when the state of the update is PAUSED. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the update's target resides. # @param [String] rolling_update # The name of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolupdaterV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolupdaterV1beta1::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 pause_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}/pause', options) command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['rollingUpdate'] = rolling_update unless rolling_update.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 # Continues an update in PAUSED state. Has no effect if invoked when the state # of the update is ROLLED_OUT. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the update's target resides. # @param [String] rolling_update # The name of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolupdaterV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolupdaterV1beta1::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 resume_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}/resume', options) command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['rollingUpdate'] = rolling_update unless rolling_update.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 # Rolls back the update in state from ROLLING_FORWARD or PAUSED. Has no effect # if invoked when the state of the update is ROLLED_BACK. # @param [String] project # The Google Developers Console project name. # @param [String] zone # The name of the zone in which the update's target resides. # @param [String] rolling_update # The name of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolupdaterV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolupdaterV1beta1::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 rollback_rolling_update(project, zone, rolling_update, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/rollingUpdates/{rollingUpdate}/rollback', options) command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['rollingUpdate'] = rolling_update unless rolling_update.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 the specified zone-specific operation resource. # @param [String] project # Name of the project scoping this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] operation # Name of the operation resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolupdaterV1beta1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolupdaterV1beta1::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_zone_operation(project, zone, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/operations/{operation}', options) command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::Operation::Representation command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::Operation command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['operation'] = operation unless operation.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 the list of Operation resources contained within the specified zone. # @param [String] project # Name of the project scoping this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] filter # Optional. Filter expression for filtering listed resources. # @param [Fixnum] max_results # Optional. Maximum count of results to be returned. Maximum value is 500 and # default value is 500. # @param [String] page_token # Optional. Tag returned by a previous list request truncated by maxResults. # Used to continue 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ReplicapoolupdaterV1beta1::OperationList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ReplicapoolupdaterV1beta1::OperationList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_zone_operations(project, zone, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/operations', options) command.response_representation = Google::Apis::ReplicapoolupdaterV1beta1::OperationList::Representation command.response_class = Google::Apis::ReplicapoolupdaterV1beta1::OperationList command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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 protected 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 end end google-api-client-0.19.8/generated/google/apis/licensing_v1/0000755000004100000410000000000013252673044023675 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/licensing_v1/representations.rb0000644000004100000410000000473213252673044027455 0ustar www-datawww-data# 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 LicensingV1 class LicenseAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LicenseAssignmentInsert class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LicenseAssignmentList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LicenseAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :etags, as: 'etags' property :kind, as: 'kind' property :product_id, as: 'productId' property :product_name, as: 'productName' property :self_link, as: 'selfLink' property :sku_id, as: 'skuId' property :sku_name, as: 'skuName' property :user_id, as: 'userId' end end class LicenseAssignmentInsert # @private class Representation < Google::Apis::Core::JsonRepresentation property :user_id, as: 'userId' end end class LicenseAssignmentList # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::LicensingV1::LicenseAssignment, decorator: Google::Apis::LicensingV1::LicenseAssignment::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end end end end google-api-client-0.19.8/generated/google/apis/licensing_v1/classes.rb0000644000004100000410000001130413252673044025656 0ustar www-datawww-data# 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 LicensingV1 # Template for LiscenseAssignment Resource class LicenseAssignment include Google::Apis::Core::Hashable # ETag of the resource. # Corresponds to the JSON property `etags` # @return [String] attr_accessor :etags # Identifies the resource as a LicenseAssignment. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Id of the product. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Display Name of the product. # Corresponds to the JSON property `productName` # @return [String] attr_accessor :product_name # Link to this page. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Id of the sku of the product. # Corresponds to the JSON property `skuId` # @return [String] attr_accessor :sku_id # Display Name of the sku of the product. # Corresponds to the JSON property `skuName` # @return [String] attr_accessor :sku_name # Email id of the user. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etags = args[:etags] if args.key?(:etags) @kind = args[:kind] if args.key?(:kind) @product_id = args[:product_id] if args.key?(:product_id) @product_name = args[:product_name] if args.key?(:product_name) @self_link = args[:self_link] if args.key?(:self_link) @sku_id = args[:sku_id] if args.key?(:sku_id) @sku_name = args[:sku_name] if args.key?(:sku_name) @user_id = args[:user_id] if args.key?(:user_id) end end # Template for LicenseAssignment Insert request class LicenseAssignmentInsert include Google::Apis::Core::Hashable # Email id of the user # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @user_id = args[:user_id] if args.key?(:user_id) end end # LicesnseAssignment List for a given product/sku for a customer. class LicenseAssignmentList include Google::Apis::Core::Hashable # ETag of the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The LicenseAssignments in this page of results. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies the resource as a collection of LicenseAssignments. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The continuation token, used to page through large result sets. Provide this # value in a subsequent request to return 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) @etag = args[:etag] if args.key?(:etag) @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) end end end end end google-api-client-0.19.8/generated/google/apis/licensing_v1/service.rb0000644000004100000410000005040213252673044025663 0ustar www-datawww-data# 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 LicensingV1 # Enterprise License Manager API # # Views and manages licenses for your domain. # # @example # require 'google/apis/licensing_v1' # # Licensing = Google::Apis::LicensingV1 # Alias the module # service = Licensing::LicensingService.new # # @see https://developers.google.com/google-apps/licensing/ class LicensingService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'apps/licensing/v1/product/') @batch_path = 'batch/licensing/v1' end # Revoke License. # @param [String] product_id # Name for product # @param [String] sku_id # Name for sku # @param [String] user_id # email id or unique Id of the user # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{productId}/sku/{skuId}/user/{userId}', options) command.params['productId'] = product_id unless product_id.nil? command.params['skuId'] = sku_id unless sku_id.nil? command.params['userId'] = user_id unless user_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 # Get license assignment of a particular product and sku for a user # @param [String] product_id # Name for product # @param [String] sku_id # Name for sku # @param [String] user_id # email id or unique Id of the user # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LicensingV1::LicenseAssignment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{productId}/sku/{skuId}/user/{userId}', options) command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation command.response_class = Google::Apis::LicensingV1::LicenseAssignment command.params['productId'] = product_id unless product_id.nil? command.params['skuId'] = sku_id unless sku_id.nil? command.params['userId'] = user_id unless user_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 # Assign License. # @param [String] product_id # Name for product # @param [String] sku_id # Name for sku # @param [Google::Apis::LicensingV1::LicenseAssignmentInsert] license_assignment_insert_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LicensingV1::LicenseAssignment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_license_assignment(product_id, sku_id, license_assignment_insert_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{productId}/sku/{skuId}/user', options) command.request_representation = Google::Apis::LicensingV1::LicenseAssignmentInsert::Representation command.request_object = license_assignment_insert_object command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation command.response_class = Google::Apis::LicensingV1::LicenseAssignment command.params['productId'] = product_id unless product_id.nil? command.params['skuId'] = sku_id unless sku_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 # List license assignments for given product of the customer. # @param [String] product_id # Name for product # @param [String] customer_id # CustomerId represents the customer for whom licenseassignments are queried # @param [Fixnum] max_results # Maximum number of campaigns to return at one time. Must be positive. Optional. # Default value is 100. # @param [String] page_token # Token to fetch the next page.Optional. By default server will return first # page # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::LicensingV1::LicenseAssignmentList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LicensingV1::LicenseAssignmentList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_license_assignments_for_product(product_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{productId}/users', options) command.response_representation = Google::Apis::LicensingV1::LicenseAssignmentList::Representation command.response_class = Google::Apis::LicensingV1::LicenseAssignmentList command.params['productId'] = product_id unless product_id.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['maxResults'] = max_results unless max_results.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 # List license assignments for given product and sku of the customer. # @param [String] product_id # Name for product # @param [String] sku_id # Name for sku # @param [String] customer_id # CustomerId represents the customer for whom licenseassignments are queried # @param [Fixnum] max_results # Maximum number of campaigns to return at one time. Must be positive. Optional. # Default value is 100. # @param [String] page_token # Token to fetch the next page.Optional. By default server will return first # page # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::LicensingV1::LicenseAssignmentList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LicensingV1::LicenseAssignmentList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_license_assignments_for_product_and_sku(product_id, sku_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{productId}/sku/{skuId}/users', options) command.response_representation = Google::Apis::LicensingV1::LicenseAssignmentList::Representation command.response_class = Google::Apis::LicensingV1::LicenseAssignmentList command.params['productId'] = product_id unless product_id.nil? command.params['skuId'] = sku_id unless sku_id.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['maxResults'] = max_results unless max_results.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 # Assign License. This method supports patch semantics. # @param [String] product_id # Name for product # @param [String] sku_id # Name for sku for which license would be revoked # @param [String] user_id # email id or unique Id of the user # @param [Google::Apis::LicensingV1::LicenseAssignment] license_assignment_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LicensingV1::LicenseAssignment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{productId}/sku/{skuId}/user/{userId}', options) command.request_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation command.request_object = license_assignment_object command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation command.response_class = Google::Apis::LicensingV1::LicenseAssignment command.params['productId'] = product_id unless product_id.nil? command.params['skuId'] = sku_id unless sku_id.nil? command.params['userId'] = user_id unless user_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 # Assign License. # @param [String] product_id # Name for product # @param [String] sku_id # Name for sku for which license would be revoked # @param [String] user_id # email id or unique Id of the user # @param [Google::Apis::LicensingV1::LicenseAssignment] license_assignment_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LicensingV1::LicenseAssignment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{productId}/sku/{skuId}/user/{userId}', options) command.request_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation command.request_object = license_assignment_object command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation command.response_class = Google::Apis::LicensingV1::LicenseAssignment command.params['productId'] = product_id unless product_id.nil? command.params['skuId'] = sku_id unless sku_id.nil? command.params['userId'] = user_id unless user_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 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 end end google-api-client-0.19.8/generated/google/apis/firebasedynamiclinks_v1.rb0000644000004100000410000000224313252673043026435 0ustar www-datawww-data# 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/firebasedynamiclinks_v1/service.rb' require 'google/apis/firebasedynamiclinks_v1/classes.rb' require 'google/apis/firebasedynamiclinks_v1/representations.rb' module Google module Apis # Firebase Dynamic Links API # # Programmatically creates and manages Firebase Dynamic Links. # # @see https://firebase.google.com/docs/dynamic-links/ module FirebasedynamiclinksV1 VERSION = 'V1' REVISION = '20180102' # View and administer all your Firebase data and settings AUTH_FIREBASE = 'https://www.googleapis.com/auth/firebase' end end end google-api-client-0.19.8/generated/google/apis/dlp_v2beta2/0000755000004100000410000000000013252673043023417 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/dlp_v2beta2/representations.rb0000644000004100000410000042524413252673043027204 0ustar www-datawww-data# 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 DlpV2beta2 class GooglePrivacyDlpV2beta1AuxiliaryTable class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1BigQueryOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1BigQueryTable class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1CategoricalStatsConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1CategoricalStatsResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1CloudStorageOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1CloudStoragePath class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1CustomInfoType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1DatastoreOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1Dictionary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1EntityId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1FieldId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1FileSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1InfoType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1InfoTypeLimit class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1InfoTypeStatistics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1InspectConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1InspectOperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1InspectOperationResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1KAnonymityConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1KAnonymityHistogramBucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1KAnonymityResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1KMapEstimationConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1KMapEstimationResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1KindExpression class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1LDiversityConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1LDiversityEquivalenceClass class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1LDiversityHistogramBucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1LDiversityResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1NumericalStatsConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1NumericalStatsResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1OutputStorageConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1PartitionId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1PrivacyMetric class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1Projection class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1PropertyReference class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1QuasiIdField class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1RiskAnalysisOperationResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1StorageConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1SurrogateType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1TaggedField class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1Value class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1ValueFrequency class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1WordList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Action class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2AuxiliaryTable class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2BigQueryOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2BigQueryTable class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Bucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2BucketingConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CancelDlpJobRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CategoricalStatsConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CategoricalStatsResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CharacterMaskConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CharsToIgnore class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CloudStorageKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CloudStorageOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Color class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Condition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Conditions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ContentItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CreateInspectTemplateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CreateJobTriggerRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CryptoHashConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CryptoKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2CustomInfoType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2DatastoreKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2DatastoreOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2DeidentifyConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2DeidentifyContentRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2DeidentifyContentResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2DeidentifyTemplate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2DetectionRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Dictionary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2DlpJob class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2EntityId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Expressions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2FieldId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2FieldTransformation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2FileSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Finding class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2FindingLimits class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2FixedSizeBucketingConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2HotwordRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ImageLocation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ImageRedactionConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InfoType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InfoTypeDescription class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InfoTypeLimit class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InfoTypeStatistics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InfoTypeTransformation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InfoTypeTransformations class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InspectConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InspectContentRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InspectContentResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InspectDataSourceDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InspectDataSourceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InspectJobConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InspectResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2InspectTemplate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2JobTrigger class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2KAnonymityConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2KAnonymityHistogramBucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2KAnonymityResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2KMapEstimationConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2KMapEstimationResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Key class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2KindExpression class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2KmsWrappedCryptoKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2LDiversityConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2LDiversityEquivalenceClass class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2LDiversityHistogramBucket class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2LDiversityResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2LikelihoodAdjustment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ListDlpJobsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ListInfoTypesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ListInspectTemplatesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ListJobTriggersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Location class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2NumericalStatsConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2NumericalStatsResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2OutputStorageConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2PartitionId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2PathElement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2PrimitiveTransformation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2PrivacyMetric class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Proximity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2PublishToPubSub class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2QuasiIdField class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Range class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2RecordCondition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2RecordKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2RecordSuppression class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2RecordTransformations class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2RedactConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2RedactImageRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2RedactImageResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Regex class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ReidentifyContentRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ReidentifyContentResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ReplaceValueConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2RequestedOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Result class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2RiskAnalysisJobConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Row class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2SaveFindings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Schedule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2StorageConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2SummaryResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2SurrogateType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Table class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2TableLocation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2TaggedField class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2TimePartConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2TimespanConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2TransformationOverview class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2TransformationSummary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2TransientCryptoKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Trigger class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2UnwrappedCryptoKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2UpdateJobTriggerRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2Value class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2ValueFrequency class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta2WordList 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 GoogleTypeDate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleTypeTimeOfDay class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GooglePrivacyDlpV2beta1AuxiliaryTable # @private class Representation < Google::Apis::Core::JsonRepresentation collection :quasi_ids, as: 'quasiIds', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1QuasiIdField, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1QuasiIdField::Representation property :relative_frequency, as: 'relativeFrequency', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId::Representation property :table, as: 'table', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable::Representation end end class GooglePrivacyDlpV2beta1BigQueryOptions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :identifying_fields, as: 'identifyingFields', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId::Representation property :table_reference, as: 'tableReference', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable::Representation end end class GooglePrivacyDlpV2beta1BigQueryTable # @private class Representation < Google::Apis::Core::JsonRepresentation property :dataset_id, as: 'datasetId' property :project_id, as: 'projectId' property :table_id, as: 'tableId' end end class GooglePrivacyDlpV2beta1CategoricalStatsConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId::Representation end end class GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_size, :numeric_string => true, as: 'bucketSize' collection :bucket_values, as: 'bucketValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1ValueFrequency, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1ValueFrequency::Representation property :value_frequency_lower_bound, :numeric_string => true, as: 'valueFrequencyLowerBound' property :value_frequency_upper_bound, :numeric_string => true, as: 'valueFrequencyUpperBound' end end class GooglePrivacyDlpV2beta1CategoricalStatsResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :value_frequency_histogram_buckets, as: 'valueFrequencyHistogramBuckets', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket::Representation end end class GooglePrivacyDlpV2beta1CloudStorageOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :file_set, as: 'fileSet', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FileSet, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FileSet::Representation end end class GooglePrivacyDlpV2beta1CloudStoragePath # @private class Representation < Google::Apis::Core::JsonRepresentation property :path, as: 'path' end end class GooglePrivacyDlpV2beta1CustomInfoType # @private class Representation < Google::Apis::Core::JsonRepresentation property :dictionary, as: 'dictionary', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Dictionary, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Dictionary::Representation property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType::Representation property :surrogate_type, as: 'surrogateType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1SurrogateType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1SurrogateType::Representation end end class GooglePrivacyDlpV2beta1DatastoreOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KindExpression, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KindExpression::Representation property :partition_id, as: 'partitionId', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1PartitionId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1PartitionId::Representation collection :projection, as: 'projection', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Projection, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Projection::Representation end end class GooglePrivacyDlpV2beta1Dictionary # @private class Representation < Google::Apis::Core::JsonRepresentation property :word_list, as: 'wordList', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1WordList, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1WordList::Representation end end class GooglePrivacyDlpV2beta1EntityId # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId::Representation end end class GooglePrivacyDlpV2beta1FieldId # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_name, as: 'columnName' end end class GooglePrivacyDlpV2beta1FileSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class GooglePrivacyDlpV2beta1InfoType # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class GooglePrivacyDlpV2beta1InfoTypeLimit # @private class Representation < Google::Apis::Core::JsonRepresentation property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType::Representation property :max_findings, as: 'maxFindings' end end class GooglePrivacyDlpV2beta1InfoTypeStatistics # @private class Representation < Google::Apis::Core::JsonRepresentation property :count, :numeric_string => true, as: 'count' property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType::Representation end end class GooglePrivacyDlpV2beta1InspectConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :custom_info_types, as: 'customInfoTypes', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CustomInfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CustomInfoType::Representation property :exclude_types, as: 'excludeTypes' property :include_quote, as: 'includeQuote' collection :info_type_limits, as: 'infoTypeLimits', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoTypeLimit, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoTypeLimit::Representation collection :info_types, as: 'infoTypes', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType::Representation property :max_findings, as: 'maxFindings' property :min_likelihood, as: 'minLikelihood' end end class GooglePrivacyDlpV2beta1InspectOperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' collection :info_type_stats, as: 'infoTypeStats', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoTypeStatistics, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoTypeStatistics::Representation property :processed_bytes, :numeric_string => true, as: 'processedBytes' property :request_inspect_config, as: 'requestInspectConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InspectConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InspectConfig::Representation property :request_output_config, as: 'requestOutputConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1OutputStorageConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1OutputStorageConfig::Representation property :request_storage_config, as: 'requestStorageConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1StorageConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1StorageConfig::Representation property :total_estimated_bytes, :numeric_string => true, as: 'totalEstimatedBytes' end end class GooglePrivacyDlpV2beta1InspectOperationResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class GooglePrivacyDlpV2beta1KAnonymityConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :entity_id, as: 'entityId', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1EntityId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1EntityId::Representation collection :quasi_ids, as: 'quasiIds', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId::Representation end end class GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass # @private class Representation < Google::Apis::Core::JsonRepresentation property :equivalence_class_size, :numeric_string => true, as: 'equivalenceClassSize' collection :quasi_ids_values, as: 'quasiIdsValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value::Representation end end class GooglePrivacyDlpV2beta1KAnonymityHistogramBucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_size, :numeric_string => true, as: 'bucketSize' collection :bucket_values, as: 'bucketValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass::Representation property :equivalence_class_size_lower_bound, :numeric_string => true, as: 'equivalenceClassSizeLowerBound' property :equivalence_class_size_upper_bound, :numeric_string => true, as: 'equivalenceClassSizeUpperBound' end end class GooglePrivacyDlpV2beta1KAnonymityResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :equivalence_class_histogram_buckets, as: 'equivalenceClassHistogramBuckets', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KAnonymityHistogramBucket, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KAnonymityHistogramBucket::Representation end end class GooglePrivacyDlpV2beta1KMapEstimationConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :auxiliary_tables, as: 'auxiliaryTables', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1AuxiliaryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1AuxiliaryTable::Representation collection :quasi_ids, as: 'quasiIds', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1TaggedField, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1TaggedField::Representation property :region_code, as: 'regionCode' end end class GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_size, :numeric_string => true, as: 'bucketSize' collection :bucket_values, as: 'bucketValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues::Representation property :max_anonymity, :numeric_string => true, as: 'maxAnonymity' property :min_anonymity, :numeric_string => true, as: 'minAnonymity' end end class GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues # @private class Representation < Google::Apis::Core::JsonRepresentation property :estimated_anonymity, :numeric_string => true, as: 'estimatedAnonymity' collection :quasi_ids_values, as: 'quasiIdsValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value::Representation end end class GooglePrivacyDlpV2beta1KMapEstimationResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :k_map_estimation_histogram, as: 'kMapEstimationHistogram', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket::Representation end end class GooglePrivacyDlpV2beta1KindExpression # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class GooglePrivacyDlpV2beta1LDiversityConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :quasi_ids, as: 'quasiIds', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId::Representation property :sensitive_attribute, as: 'sensitiveAttribute', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId::Representation end end class GooglePrivacyDlpV2beta1LDiversityEquivalenceClass # @private class Representation < Google::Apis::Core::JsonRepresentation property :equivalence_class_size, :numeric_string => true, as: 'equivalenceClassSize' property :num_distinct_sensitive_values, :numeric_string => true, as: 'numDistinctSensitiveValues' collection :quasi_ids_values, as: 'quasiIdsValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value::Representation collection :top_sensitive_values, as: 'topSensitiveValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1ValueFrequency, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1ValueFrequency::Representation end end class GooglePrivacyDlpV2beta1LDiversityHistogramBucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_size, :numeric_string => true, as: 'bucketSize' collection :bucket_values, as: 'bucketValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1LDiversityEquivalenceClass, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1LDiversityEquivalenceClass::Representation property :sensitive_value_frequency_lower_bound, :numeric_string => true, as: 'sensitiveValueFrequencyLowerBound' property :sensitive_value_frequency_upper_bound, :numeric_string => true, as: 'sensitiveValueFrequencyUpperBound' end end class GooglePrivacyDlpV2beta1LDiversityResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :sensitive_value_frequency_histogram_buckets, as: 'sensitiveValueFrequencyHistogramBuckets', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1LDiversityHistogramBucket, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1LDiversityHistogramBucket::Representation end end class GooglePrivacyDlpV2beta1NumericalStatsConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId::Representation end end class GooglePrivacyDlpV2beta1NumericalStatsResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_value, as: 'maxValue', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value::Representation property :min_value, as: 'minValue', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value::Representation collection :quantile_values, as: 'quantileValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value::Representation end end class GooglePrivacyDlpV2beta1OutputStorageConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :storage_path, as: 'storagePath', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CloudStoragePath, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CloudStoragePath::Representation property :table, as: 'table', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable::Representation end end class GooglePrivacyDlpV2beta1PartitionId # @private class Representation < Google::Apis::Core::JsonRepresentation property :namespace_id, as: 'namespaceId' property :project_id, as: 'projectId' end end class GooglePrivacyDlpV2beta1PrivacyMetric # @private class Representation < Google::Apis::Core::JsonRepresentation property :categorical_stats_config, as: 'categoricalStatsConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CategoricalStatsConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CategoricalStatsConfig::Representation property :k_anonymity_config, as: 'kAnonymityConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KAnonymityConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KAnonymityConfig::Representation property :k_map_estimation_config, as: 'kMapEstimationConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KMapEstimationConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KMapEstimationConfig::Representation property :l_diversity_config, as: 'lDiversityConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1LDiversityConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1LDiversityConfig::Representation property :numerical_stats_config, as: 'numericalStatsConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1NumericalStatsConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1NumericalStatsConfig::Representation end end class GooglePrivacyDlpV2beta1Projection # @private class Representation < Google::Apis::Core::JsonRepresentation property :property, as: 'property', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1PropertyReference, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1PropertyReference::Representation end end class GooglePrivacyDlpV2beta1PropertyReference # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class GooglePrivacyDlpV2beta1QuasiIdField # @private class Representation < Google::Apis::Core::JsonRepresentation property :custom_tag, as: 'customTag' property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId::Representation end end class GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :requested_privacy_metric, as: 'requestedPrivacyMetric', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1PrivacyMetric, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1PrivacyMetric::Representation property :requested_source_table, as: 'requestedSourceTable', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable::Representation end end class GooglePrivacyDlpV2beta1RiskAnalysisOperationResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :categorical_stats_result, as: 'categoricalStatsResult', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CategoricalStatsResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CategoricalStatsResult::Representation property :k_anonymity_result, as: 'kAnonymityResult', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KAnonymityResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KAnonymityResult::Representation property :k_map_estimation_result, as: 'kMapEstimationResult', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KMapEstimationResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KMapEstimationResult::Representation property :l_diversity_result, as: 'lDiversityResult', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1LDiversityResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1LDiversityResult::Representation property :numerical_stats_result, as: 'numericalStatsResult', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1NumericalStatsResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1NumericalStatsResult::Representation end end class GooglePrivacyDlpV2beta1StorageConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :big_query_options, as: 'bigQueryOptions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryOptions, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryOptions::Representation property :cloud_storage_options, as: 'cloudStorageOptions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CloudStorageOptions, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CloudStorageOptions::Representation property :datastore_options, as: 'datastoreOptions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1DatastoreOptions, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1DatastoreOptions::Representation end end class GooglePrivacyDlpV2beta1SurrogateType # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GooglePrivacyDlpV2beta1TaggedField # @private class Representation < Google::Apis::Core::JsonRepresentation property :custom_tag, as: 'customTag' property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId::Representation property :inferred, as: 'inferred', class: Google::Apis::DlpV2beta2::GoogleProtobufEmpty, decorator: Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType::Representation end end class GooglePrivacyDlpV2beta1Value # @private class Representation < Google::Apis::Core::JsonRepresentation property :boolean_value, as: 'booleanValue' property :date_value, as: 'dateValue', class: Google::Apis::DlpV2beta2::GoogleTypeDate, decorator: Google::Apis::DlpV2beta2::GoogleTypeDate::Representation property :float_value, as: 'floatValue' property :integer_value, :numeric_string => true, as: 'integerValue' property :string_value, as: 'stringValue' property :time_value, as: 'timeValue', class: Google::Apis::DlpV2beta2::GoogleTypeTimeOfDay, decorator: Google::Apis::DlpV2beta2::GoogleTypeTimeOfDay::Representation property :timestamp_value, as: 'timestampValue' end end class GooglePrivacyDlpV2beta1ValueFrequency # @private class Representation < Google::Apis::Core::JsonRepresentation property :count, :numeric_string => true, as: 'count' property :value, as: 'value', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value::Representation end end class GooglePrivacyDlpV2beta1WordList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :words, as: 'words' end end class GooglePrivacyDlpV2beta2Action # @private class Representation < Google::Apis::Core::JsonRepresentation property :pub_sub, as: 'pubSub', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PublishToPubSub, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PublishToPubSub::Representation property :save_findings, as: 'saveFindings', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2SaveFindings, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2SaveFindings::Representation end end class GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :categorical_stats_result, as: 'categoricalStatsResult', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CategoricalStatsResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CategoricalStatsResult::Representation property :k_anonymity_result, as: 'kAnonymityResult', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KAnonymityResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KAnonymityResult::Representation property :k_map_estimation_result, as: 'kMapEstimationResult', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KMapEstimationResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KMapEstimationResult::Representation property :l_diversity_result, as: 'lDiversityResult', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LDiversityResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LDiversityResult::Representation property :numerical_stats_result, as: 'numericalStatsResult', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2NumericalStatsResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2NumericalStatsResult::Representation property :requested_privacy_metric, as: 'requestedPrivacyMetric', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrivacyMetric, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrivacyMetric::Representation property :requested_source_table, as: 'requestedSourceTable', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable::Representation end end class GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :job_config, as: 'jobConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RiskAnalysisJobConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RiskAnalysisJobConfig::Representation property :job_id, as: 'jobId' end end class GooglePrivacyDlpV2beta2AuxiliaryTable # @private class Representation < Google::Apis::Core::JsonRepresentation collection :quasi_ids, as: 'quasiIds', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2QuasiIdField, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2QuasiIdField::Representation property :relative_frequency, as: 'relativeFrequency', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation property :table, as: 'table', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable::Representation end end class GooglePrivacyDlpV2beta2BigQueryOptions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :identifying_fields, as: 'identifyingFields', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation property :table_reference, as: 'tableReference', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable::Representation end end class GooglePrivacyDlpV2beta2BigQueryTable # @private class Representation < Google::Apis::Core::JsonRepresentation property :dataset_id, as: 'datasetId' property :project_id, as: 'projectId' property :table_id, as: 'tableId' end end class GooglePrivacyDlpV2beta2Bucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :max, as: 'max', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation property :min, as: 'min', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation property :replacement_value, as: 'replacementValue', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation end end class GooglePrivacyDlpV2beta2BucketingConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :buckets, as: 'buckets', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Bucket, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Bucket::Representation end end class GooglePrivacyDlpV2beta2CancelDlpJobRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GooglePrivacyDlpV2beta2CategoricalStatsConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation end end class GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_size, :numeric_string => true, as: 'bucketSize' collection :bucket_values, as: 'bucketValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ValueFrequency, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ValueFrequency::Representation property :value_frequency_lower_bound, :numeric_string => true, as: 'valueFrequencyLowerBound' property :value_frequency_upper_bound, :numeric_string => true, as: 'valueFrequencyUpperBound' end end class GooglePrivacyDlpV2beta2CategoricalStatsResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :value_frequency_histogram_buckets, as: 'valueFrequencyHistogramBuckets', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket::Representation end end class GooglePrivacyDlpV2beta2CharacterMaskConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :characters_to_ignore, as: 'charactersToIgnore', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CharsToIgnore, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CharsToIgnore::Representation property :masking_character, as: 'maskingCharacter' property :number_to_mask, as: 'numberToMask' property :reverse_order, as: 'reverseOrder' end end class GooglePrivacyDlpV2beta2CharsToIgnore # @private class Representation < Google::Apis::Core::JsonRepresentation property :characters_to_skip, as: 'charactersToSkip' property :common_characters_to_ignore, as: 'commonCharactersToIgnore' end end class GooglePrivacyDlpV2beta2CloudStorageKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :file_path, as: 'filePath' property :start_offset, :numeric_string => true, as: 'startOffset' end end class GooglePrivacyDlpV2beta2CloudStorageOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :bytes_limit_per_file, :numeric_string => true, as: 'bytesLimitPerFile' property :file_set, as: 'fileSet', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FileSet, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FileSet::Representation end end class GooglePrivacyDlpV2beta2Color # @private class Representation < Google::Apis::Core::JsonRepresentation property :blue, as: 'blue' property :green, as: 'green' property :red, as: 'red' end end class GooglePrivacyDlpV2beta2Condition # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation property :operator, as: 'operator' property :value, as: 'value', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation end end class GooglePrivacyDlpV2beta2Conditions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :conditions, as: 'conditions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Condition, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Condition::Representation end end class GooglePrivacyDlpV2beta2ContentItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, :base64 => true, as: 'data' property :table, as: 'table', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Table, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Table::Representation property :type, as: 'type' property :value, as: 'value' end end class GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :deidentify_template, as: 'deidentifyTemplate', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation property :template_id, as: 'templateId' end end class GooglePrivacyDlpV2beta2CreateInspectTemplateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :inspect_template, as: 'inspectTemplate', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation property :template_id, as: 'templateId' end end class GooglePrivacyDlpV2beta2CreateJobTriggerRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :job_trigger, as: 'jobTrigger', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger::Representation property :trigger_id, as: 'triggerId' end end class GooglePrivacyDlpV2beta2CryptoHashConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :crypto_key, as: 'cryptoKey', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoKey, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoKey::Representation end end class GooglePrivacyDlpV2beta2CryptoKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :kms_wrapped, as: 'kmsWrapped', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KmsWrappedCryptoKey, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KmsWrappedCryptoKey::Representation property :transient, as: 'transient', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransientCryptoKey, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransientCryptoKey::Representation property :unwrapped, as: 'unwrapped', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UnwrappedCryptoKey, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UnwrappedCryptoKey::Representation end end class GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :common_alphabet, as: 'commonAlphabet' property :context, as: 'context', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation property :crypto_key, as: 'cryptoKey', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoKey, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoKey::Representation property :custom_alphabet, as: 'customAlphabet' property :radix, as: 'radix' property :surrogate_info_type, as: 'surrogateInfoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType::Representation end end class GooglePrivacyDlpV2beta2CustomInfoType # @private class Representation < Google::Apis::Core::JsonRepresentation collection :detection_rules, as: 'detectionRules', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DetectionRule, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DetectionRule::Representation property :dictionary, as: 'dictionary', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Dictionary, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Dictionary::Representation property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType::Representation property :likelihood, as: 'likelihood' property :regex, as: 'regex', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Regex, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Regex::Representation property :surrogate_type, as: 'surrogateType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2SurrogateType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2SurrogateType::Representation end end class GooglePrivacyDlpV2beta2DatastoreKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :entity_key, as: 'entityKey', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Key, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Key::Representation end end class GooglePrivacyDlpV2beta2DatastoreOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KindExpression, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KindExpression::Representation property :partition_id, as: 'partitionId', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PartitionId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PartitionId::Representation end end class GooglePrivacyDlpV2beta2DeidentifyConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :info_type_transformations, as: 'infoTypeTransformations', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeTransformations, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeTransformations::Representation property :record_transformations, as: 'recordTransformations', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordTransformations, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordTransformations::Representation end end class GooglePrivacyDlpV2beta2DeidentifyContentRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :deidentify_config, as: 'deidentifyConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyConfig::Representation property :deidentify_template_name, as: 'deidentifyTemplateName' property :inspect_config, as: 'inspectConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig::Representation property :inspect_template_name, as: 'inspectTemplateName' property :item, as: 'item', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem::Representation end end class GooglePrivacyDlpV2beta2DeidentifyContentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :item, as: 'item', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem::Representation property :overview, as: 'overview', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransformationOverview, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransformationOverview::Representation end end class GooglePrivacyDlpV2beta2DeidentifyTemplate # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :deidentify_config, as: 'deidentifyConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyConfig::Representation property :description, as: 'description' property :display_name, as: 'displayName' property :name, as: 'name' property :update_time, as: 'updateTime' end end class GooglePrivacyDlpV2beta2DetectionRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :hotword_rule, as: 'hotwordRule', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2HotwordRule, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2HotwordRule::Representation end end class GooglePrivacyDlpV2beta2Dictionary # @private class Representation < Google::Apis::Core::JsonRepresentation property :word_list, as: 'wordList', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2WordList, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2WordList::Representation end end class GooglePrivacyDlpV2beta2DlpJob # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :end_time, as: 'endTime' collection :error_results, as: 'errorResults', class: Google::Apis::DlpV2beta2::GoogleRpcStatus, decorator: Google::Apis::DlpV2beta2::GoogleRpcStatus::Representation property :inspect_details, as: 'inspectDetails', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectDataSourceDetails, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectDataSourceDetails::Representation property :job_trigger_name, as: 'jobTriggerName' property :name, as: 'name' property :risk_details, as: 'riskDetails', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails::Representation property :start_time, as: 'startTime' property :state, as: 'state' property :type, as: 'type' end end class GooglePrivacyDlpV2beta2EntityId # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation end end class GooglePrivacyDlpV2beta2Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :details, as: 'details', class: Google::Apis::DlpV2beta2::GoogleRpcStatus, decorator: Google::Apis::DlpV2beta2::GoogleRpcStatus::Representation collection :timestamps, as: 'timestamps' end end class GooglePrivacyDlpV2beta2Expressions # @private class Representation < Google::Apis::Core::JsonRepresentation property :conditions, as: 'conditions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Conditions, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Conditions::Representation property :logical_operator, as: 'logicalOperator' end end class GooglePrivacyDlpV2beta2FieldId # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class GooglePrivacyDlpV2beta2FieldTransformation # @private class Representation < Google::Apis::Core::JsonRepresentation property :condition, as: 'condition', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordCondition, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordCondition::Representation collection :fields, as: 'fields', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation property :info_type_transformations, as: 'infoTypeTransformations', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeTransformations, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeTransformations::Representation property :primitive_transformation, as: 'primitiveTransformation', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrimitiveTransformation, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrimitiveTransformation::Representation end end class GooglePrivacyDlpV2beta2FileSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :url, as: 'url' end end class GooglePrivacyDlpV2beta2Finding # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType::Representation property :likelihood, as: 'likelihood' property :location, as: 'location', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Location, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Location::Representation property :quote, as: 'quote' end end class GooglePrivacyDlpV2beta2FindingLimits # @private class Representation < Google::Apis::Core::JsonRepresentation collection :max_findings_per_info_type, as: 'maxFindingsPerInfoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeLimit, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeLimit::Representation property :max_findings_per_item, as: 'maxFindingsPerItem' property :max_findings_per_request, as: 'maxFindingsPerRequest' end end class GooglePrivacyDlpV2beta2FixedSizeBucketingConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_size, as: 'bucketSize' property :lower_bound, as: 'lowerBound', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation property :upper_bound, as: 'upperBound', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation end end class GooglePrivacyDlpV2beta2HotwordRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :hotword_regex, as: 'hotwordRegex', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Regex, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Regex::Representation property :likelihood_adjustment, as: 'likelihoodAdjustment', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LikelihoodAdjustment, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LikelihoodAdjustment::Representation property :proximity, as: 'proximity', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Proximity, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Proximity::Representation end end class GooglePrivacyDlpV2beta2ImageLocation # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :left, as: 'left' property :top, as: 'top' property :width, as: 'width' end end class GooglePrivacyDlpV2beta2ImageRedactionConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType::Representation property :redact_all_text, as: 'redactAllText' property :redaction_color, as: 'redactionColor', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Color, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Color::Representation end end class GooglePrivacyDlpV2beta2InfoType # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class GooglePrivacyDlpV2beta2InfoTypeDescription # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :name, as: 'name' collection :supported_by, as: 'supportedBy' end end class GooglePrivacyDlpV2beta2InfoTypeLimit # @private class Representation < Google::Apis::Core::JsonRepresentation property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType::Representation property :max_findings, as: 'maxFindings' end end class GooglePrivacyDlpV2beta2InfoTypeStatistics # @private class Representation < Google::Apis::Core::JsonRepresentation property :count, :numeric_string => true, as: 'count' property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType::Representation end end class GooglePrivacyDlpV2beta2InfoTypeTransformation # @private class Representation < Google::Apis::Core::JsonRepresentation collection :info_types, as: 'infoTypes', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType::Representation property :primitive_transformation, as: 'primitiveTransformation', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrimitiveTransformation, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrimitiveTransformation::Representation end end class GooglePrivacyDlpV2beta2InfoTypeTransformations # @private class Representation < Google::Apis::Core::JsonRepresentation collection :transformations, as: 'transformations', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeTransformation, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeTransformation::Representation end end class GooglePrivacyDlpV2beta2InspectConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :custom_info_types, as: 'customInfoTypes', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CustomInfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CustomInfoType::Representation property :exclude_info_types, as: 'excludeInfoTypes' property :include_quote, as: 'includeQuote' collection :info_types, as: 'infoTypes', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType::Representation property :limits, as: 'limits', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FindingLimits, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FindingLimits::Representation property :min_likelihood, as: 'minLikelihood' end end class GooglePrivacyDlpV2beta2InspectContentRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :inspect_config, as: 'inspectConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig::Representation property :inspect_template_name, as: 'inspectTemplateName' property :item, as: 'item', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem::Representation end end class GooglePrivacyDlpV2beta2InspectContentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :result, as: 'result', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectResult::Representation end end class GooglePrivacyDlpV2beta2InspectDataSourceDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :requested_options, as: 'requestedOptions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RequestedOptions, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RequestedOptions::Representation property :result, as: 'result', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Result, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Result::Representation end end class GooglePrivacyDlpV2beta2InspectDataSourceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :job_config, as: 'jobConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectJobConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectJobConfig::Representation property :job_id, as: 'jobId' end end class GooglePrivacyDlpV2beta2InspectJobConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :actions, as: 'actions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Action, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Action::Representation property :inspect_config, as: 'inspectConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig::Representation property :inspect_template_name, as: 'inspectTemplateName' property :output_config, as: 'outputConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2OutputStorageConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2OutputStorageConfig::Representation property :storage_config, as: 'storageConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2StorageConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2StorageConfig::Representation end end class GooglePrivacyDlpV2beta2InspectResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :findings, as: 'findings', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Finding, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Finding::Representation property :findings_truncated, as: 'findingsTruncated' end end class GooglePrivacyDlpV2beta2InspectTemplate # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :description, as: 'description' property :display_name, as: 'displayName' property :inspect_config, as: 'inspectConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig::Representation property :name, as: 'name' property :update_time, as: 'updateTime' end end class GooglePrivacyDlpV2beta2JobTrigger # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :description, as: 'description' property :display_name, as: 'displayName' collection :errors, as: 'errors', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Error, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Error::Representation property :inspect_job, as: 'inspectJob', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectJobConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectJobConfig::Representation property :last_run_time, as: 'lastRunTime' property :name, as: 'name' property :status, as: 'status' collection :triggers, as: 'triggers', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Trigger, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Trigger::Representation property :update_time, as: 'updateTime' end end class GooglePrivacyDlpV2beta2KAnonymityConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :entity_id, as: 'entityId', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2EntityId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2EntityId::Representation collection :quasi_ids, as: 'quasiIds', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation end end class GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass # @private class Representation < Google::Apis::Core::JsonRepresentation property :equivalence_class_size, :numeric_string => true, as: 'equivalenceClassSize' collection :quasi_ids_values, as: 'quasiIdsValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation end end class GooglePrivacyDlpV2beta2KAnonymityHistogramBucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_size, :numeric_string => true, as: 'bucketSize' collection :bucket_values, as: 'bucketValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass::Representation property :equivalence_class_size_lower_bound, :numeric_string => true, as: 'equivalenceClassSizeLowerBound' property :equivalence_class_size_upper_bound, :numeric_string => true, as: 'equivalenceClassSizeUpperBound' end end class GooglePrivacyDlpV2beta2KAnonymityResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :equivalence_class_histogram_buckets, as: 'equivalenceClassHistogramBuckets', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KAnonymityHistogramBucket, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KAnonymityHistogramBucket::Representation end end class GooglePrivacyDlpV2beta2KMapEstimationConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :auxiliary_tables, as: 'auxiliaryTables', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2AuxiliaryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2AuxiliaryTable::Representation collection :quasi_ids, as: 'quasiIds', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TaggedField, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TaggedField::Representation property :region_code, as: 'regionCode' end end class GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_size, :numeric_string => true, as: 'bucketSize' collection :bucket_values, as: 'bucketValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues::Representation property :max_anonymity, :numeric_string => true, as: 'maxAnonymity' property :min_anonymity, :numeric_string => true, as: 'minAnonymity' end end class GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues # @private class Representation < Google::Apis::Core::JsonRepresentation property :estimated_anonymity, :numeric_string => true, as: 'estimatedAnonymity' collection :quasi_ids_values, as: 'quasiIdsValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation end end class GooglePrivacyDlpV2beta2KMapEstimationResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :k_map_estimation_histogram, as: 'kMapEstimationHistogram', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket::Representation end end class GooglePrivacyDlpV2beta2Key # @private class Representation < Google::Apis::Core::JsonRepresentation property :partition_id, as: 'partitionId', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PartitionId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PartitionId::Representation collection :path, as: 'path', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PathElement, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PathElement::Representation end end class GooglePrivacyDlpV2beta2KindExpression # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class GooglePrivacyDlpV2beta2KmsWrappedCryptoKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :crypto_key_name, as: 'cryptoKeyName' property :wrapped_key, :base64 => true, as: 'wrappedKey' end end class GooglePrivacyDlpV2beta2LDiversityConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :quasi_ids, as: 'quasiIds', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation property :sensitive_attribute, as: 'sensitiveAttribute', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation end end class GooglePrivacyDlpV2beta2LDiversityEquivalenceClass # @private class Representation < Google::Apis::Core::JsonRepresentation property :equivalence_class_size, :numeric_string => true, as: 'equivalenceClassSize' property :num_distinct_sensitive_values, :numeric_string => true, as: 'numDistinctSensitiveValues' collection :quasi_ids_values, as: 'quasiIdsValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation collection :top_sensitive_values, as: 'topSensitiveValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ValueFrequency, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ValueFrequency::Representation end end class GooglePrivacyDlpV2beta2LDiversityHistogramBucket # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_size, :numeric_string => true, as: 'bucketSize' collection :bucket_values, as: 'bucketValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LDiversityEquivalenceClass, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LDiversityEquivalenceClass::Representation property :sensitive_value_frequency_lower_bound, :numeric_string => true, as: 'sensitiveValueFrequencyLowerBound' property :sensitive_value_frequency_upper_bound, :numeric_string => true, as: 'sensitiveValueFrequencyUpperBound' end end class GooglePrivacyDlpV2beta2LDiversityResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :sensitive_value_frequency_histogram_buckets, as: 'sensitiveValueFrequencyHistogramBuckets', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LDiversityHistogramBucket, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LDiversityHistogramBucket::Representation end end class GooglePrivacyDlpV2beta2LikelihoodAdjustment # @private class Representation < Google::Apis::Core::JsonRepresentation property :fixed_likelihood, as: 'fixedLikelihood' property :relative_likelihood, as: 'relativeLikelihood' end end class GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :deidentify_templates, as: 'deidentifyTemplates', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation property :next_page_token, as: 'nextPageToken' end end class GooglePrivacyDlpV2beta2ListDlpJobsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :jobs, as: 'jobs', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob::Representation property :next_page_token, as: 'nextPageToken' end end class GooglePrivacyDlpV2beta2ListInfoTypesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :info_types, as: 'infoTypes', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeDescription, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeDescription::Representation end end class GooglePrivacyDlpV2beta2ListInspectTemplatesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :inspect_templates, as: 'inspectTemplates', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation property :next_page_token, as: 'nextPageToken' end end class GooglePrivacyDlpV2beta2ListJobTriggersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :job_triggers, as: 'jobTriggers', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger::Representation property :next_page_token, as: 'nextPageToken' end end class GooglePrivacyDlpV2beta2Location # @private class Representation < Google::Apis::Core::JsonRepresentation property :byte_range, as: 'byteRange', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Range, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Range::Representation property :codepoint_range, as: 'codepointRange', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Range, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Range::Representation property :field_id, as: 'fieldId', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation collection :image_boxes, as: 'imageBoxes', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ImageLocation, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ImageLocation::Representation property :record_key, as: 'recordKey', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordKey, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordKey::Representation property :table_location, as: 'tableLocation', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TableLocation, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TableLocation::Representation end end class GooglePrivacyDlpV2beta2NumericalStatsConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation end end class GooglePrivacyDlpV2beta2NumericalStatsResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_value, as: 'maxValue', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation property :min_value, as: 'minValue', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation collection :quantile_values, as: 'quantileValues', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation end end class GooglePrivacyDlpV2beta2OutputStorageConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :table, as: 'table', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable::Representation end end class GooglePrivacyDlpV2beta2PartitionId # @private class Representation < Google::Apis::Core::JsonRepresentation property :namespace_id, as: 'namespaceId' property :project_id, as: 'projectId' end end class GooglePrivacyDlpV2beta2PathElement # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class GooglePrivacyDlpV2beta2PrimitiveTransformation # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucketing_config, as: 'bucketingConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BucketingConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BucketingConfig::Representation property :character_mask_config, as: 'characterMaskConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CharacterMaskConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CharacterMaskConfig::Representation property :crypto_hash_config, as: 'cryptoHashConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoHashConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoHashConfig::Representation property :crypto_replace_ffx_fpe_config, as: 'cryptoReplaceFfxFpeConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig::Representation property :fixed_size_bucketing_config, as: 'fixedSizeBucketingConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FixedSizeBucketingConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FixedSizeBucketingConfig::Representation property :redact_config, as: 'redactConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactConfig::Representation property :replace_config, as: 'replaceConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReplaceValueConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReplaceValueConfig::Representation property :replace_with_info_type_config, as: 'replaceWithInfoTypeConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig::Representation property :time_part_config, as: 'timePartConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TimePartConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TimePartConfig::Representation end end class GooglePrivacyDlpV2beta2PrivacyMetric # @private class Representation < Google::Apis::Core::JsonRepresentation property :categorical_stats_config, as: 'categoricalStatsConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CategoricalStatsConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CategoricalStatsConfig::Representation property :k_anonymity_config, as: 'kAnonymityConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KAnonymityConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KAnonymityConfig::Representation property :k_map_estimation_config, as: 'kMapEstimationConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KMapEstimationConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KMapEstimationConfig::Representation property :l_diversity_config, as: 'lDiversityConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LDiversityConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LDiversityConfig::Representation property :numerical_stats_config, as: 'numericalStatsConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2NumericalStatsConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2NumericalStatsConfig::Representation end end class GooglePrivacyDlpV2beta2Proximity # @private class Representation < Google::Apis::Core::JsonRepresentation property :window_after, as: 'windowAfter' property :window_before, as: 'windowBefore' end end class GooglePrivacyDlpV2beta2PublishToPubSub # @private class Representation < Google::Apis::Core::JsonRepresentation property :topic, as: 'topic' end end class GooglePrivacyDlpV2beta2QuasiIdField # @private class Representation < Google::Apis::Core::JsonRepresentation property :custom_tag, as: 'customTag' property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation end end class GooglePrivacyDlpV2beta2Range # @private class Representation < Google::Apis::Core::JsonRepresentation property :end, :numeric_string => true, as: 'end' property :start, :numeric_string => true, as: 'start' end end class GooglePrivacyDlpV2beta2RecordCondition # @private class Representation < Google::Apis::Core::JsonRepresentation property :expressions, as: 'expressions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Expressions, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Expressions::Representation end end class GooglePrivacyDlpV2beta2RecordKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :cloud_storage_key, as: 'cloudStorageKey', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CloudStorageKey, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CloudStorageKey::Representation property :datastore_key, as: 'datastoreKey', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DatastoreKey, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DatastoreKey::Representation end end class GooglePrivacyDlpV2beta2RecordSuppression # @private class Representation < Google::Apis::Core::JsonRepresentation property :condition, as: 'condition', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordCondition, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordCondition::Representation end end class GooglePrivacyDlpV2beta2RecordTransformations # @private class Representation < Google::Apis::Core::JsonRepresentation collection :field_transformations, as: 'fieldTransformations', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldTransformation, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldTransformation::Representation collection :record_suppressions, as: 'recordSuppressions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordSuppression, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordSuppression::Representation end end class GooglePrivacyDlpV2beta2RedactConfig # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GooglePrivacyDlpV2beta2RedactImageRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :image_data, :base64 => true, as: 'imageData' collection :image_redaction_configs, as: 'imageRedactionConfigs', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ImageRedactionConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ImageRedactionConfig::Representation property :image_type, as: 'imageType' property :inspect_config, as: 'inspectConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig::Representation end end class GooglePrivacyDlpV2beta2RedactImageResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :extracted_text, as: 'extractedText' property :redacted_image, :base64 => true, as: 'redactedImage' end end class GooglePrivacyDlpV2beta2Regex # @private class Representation < Google::Apis::Core::JsonRepresentation property :pattern, as: 'pattern' end end class GooglePrivacyDlpV2beta2ReidentifyContentRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :inspect_config, as: 'inspectConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig::Representation property :inspect_template_name, as: 'inspectTemplateName' property :item, as: 'item', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem::Representation property :reidentify_config, as: 'reidentifyConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyConfig::Representation property :reidentify_template_name, as: 'reidentifyTemplateName' end end class GooglePrivacyDlpV2beta2ReidentifyContentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :item, as: 'item', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem::Representation property :overview, as: 'overview', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransformationOverview, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransformationOverview::Representation end end class GooglePrivacyDlpV2beta2ReplaceValueConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :new_value, as: 'newValue', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation end end class GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GooglePrivacyDlpV2beta2RequestedOptions # @private class Representation < Google::Apis::Core::JsonRepresentation property :job_config, as: 'jobConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectJobConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectJobConfig::Representation property :snapshot_inspect_template, as: 'snapshotInspectTemplate', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation end end class GooglePrivacyDlpV2beta2Result # @private class Representation < Google::Apis::Core::JsonRepresentation collection :info_type_stats, as: 'infoTypeStats', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeStatistics, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeStatistics::Representation property :processed_bytes, :numeric_string => true, as: 'processedBytes' property :total_estimated_bytes, :numeric_string => true, as: 'totalEstimatedBytes' end end class GooglePrivacyDlpV2beta2RiskAnalysisJobConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :actions, as: 'actions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Action, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Action::Representation property :privacy_metric, as: 'privacyMetric', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrivacyMetric, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrivacyMetric::Representation property :source_table, as: 'sourceTable', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable::Representation end end class GooglePrivacyDlpV2beta2Row # @private class Representation < Google::Apis::Core::JsonRepresentation collection :values, as: 'values', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation end end class GooglePrivacyDlpV2beta2SaveFindings # @private class Representation < Google::Apis::Core::JsonRepresentation property :output_config, as: 'outputConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2OutputStorageConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2OutputStorageConfig::Representation end end class GooglePrivacyDlpV2beta2Schedule # @private class Representation < Google::Apis::Core::JsonRepresentation property :reccurrence_period_duration, as: 'reccurrencePeriodDuration' end end class GooglePrivacyDlpV2beta2StorageConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :big_query_options, as: 'bigQueryOptions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryOptions, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryOptions::Representation property :cloud_storage_options, as: 'cloudStorageOptions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CloudStorageOptions, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CloudStorageOptions::Representation property :datastore_options, as: 'datastoreOptions', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DatastoreOptions, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DatastoreOptions::Representation property :timespan_config, as: 'timespanConfig', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TimespanConfig, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TimespanConfig::Representation end end class GooglePrivacyDlpV2beta2SummaryResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :count, :numeric_string => true, as: 'count' property :details, as: 'details' end end class GooglePrivacyDlpV2beta2SurrogateType # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GooglePrivacyDlpV2beta2Table # @private class Representation < Google::Apis::Core::JsonRepresentation collection :headers, as: 'headers', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation collection :rows, as: 'rows', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Row, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Row::Representation end end class GooglePrivacyDlpV2beta2TableLocation # @private class Representation < Google::Apis::Core::JsonRepresentation property :row_index, :numeric_string => true, as: 'rowIndex' end end class GooglePrivacyDlpV2beta2TaggedField # @private class Representation < Google::Apis::Core::JsonRepresentation property :custom_tag, as: 'customTag' property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation property :inferred, as: 'inferred', class: Google::Apis::DlpV2beta2::GoogleProtobufEmpty, decorator: Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType::Representation end end class GooglePrivacyDlpV2beta2TimePartConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :part_to_extract, as: 'partToExtract' end end class GooglePrivacyDlpV2beta2TimespanConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :enable_auto_population_of_timespan_config, as: 'enableAutoPopulationOfTimespanConfig' property :end_time, as: 'endTime' property :start_time, as: 'startTime' end end class GooglePrivacyDlpV2beta2TransformationOverview # @private class Representation < Google::Apis::Core::JsonRepresentation collection :transformation_summaries, as: 'transformationSummaries', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransformationSummary, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransformationSummary::Representation property :transformed_bytes, :numeric_string => true, as: 'transformedBytes' end end class GooglePrivacyDlpV2beta2TransformationSummary # @private class Representation < Google::Apis::Core::JsonRepresentation property :field, as: 'field', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId::Representation collection :field_transformations, as: 'fieldTransformations', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldTransformation, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldTransformation::Representation property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType::Representation property :record_suppress, as: 'recordSuppress', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordSuppression, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordSuppression::Representation collection :results, as: 'results', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2SummaryResult, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2SummaryResult::Representation property :transformation, as: 'transformation', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrimitiveTransformation, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrimitiveTransformation::Representation property :transformed_bytes, :numeric_string => true, as: 'transformedBytes' end end class GooglePrivacyDlpV2beta2TransientCryptoKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end class GooglePrivacyDlpV2beta2Trigger # @private class Representation < Google::Apis::Core::JsonRepresentation property :schedule, as: 'schedule', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Schedule, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Schedule::Representation end end class GooglePrivacyDlpV2beta2UnwrappedCryptoKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, :base64 => true, as: 'key' end end class GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :deidentify_template, as: 'deidentifyTemplate', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation property :update_mask, as: 'updateMask' end end class GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :inspect_template, as: 'inspectTemplate', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation property :update_mask, as: 'updateMask' end end class GooglePrivacyDlpV2beta2UpdateJobTriggerRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :job_trigger, as: 'jobTrigger', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger::Representation property :update_mask, as: 'updateMask' end end class GooglePrivacyDlpV2beta2Value # @private class Representation < Google::Apis::Core::JsonRepresentation property :boolean_value, as: 'booleanValue' property :date_value, as: 'dateValue', class: Google::Apis::DlpV2beta2::GoogleTypeDate, decorator: Google::Apis::DlpV2beta2::GoogleTypeDate::Representation property :float_value, as: 'floatValue' property :integer_value, :numeric_string => true, as: 'integerValue' property :string_value, as: 'stringValue' property :time_value, as: 'timeValue', class: Google::Apis::DlpV2beta2::GoogleTypeTimeOfDay, decorator: Google::Apis::DlpV2beta2::GoogleTypeTimeOfDay::Representation property :timestamp_value, as: 'timestampValue' end end class GooglePrivacyDlpV2beta2ValueFrequency # @private class Representation < Google::Apis::Core::JsonRepresentation property :count, :numeric_string => true, as: 'count' property :value, as: 'value', class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value, decorator: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value::Representation end end class GooglePrivacyDlpV2beta2WordList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :words, as: 'words' 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 GoogleTypeDate # @private class Representation < Google::Apis::Core::JsonRepresentation property :day, as: 'day' property :month, as: 'month' property :year, as: 'year' end end class GoogleTypeTimeOfDay # @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 end end end google-api-client-0.19.8/generated/google/apis/dlp_v2beta2/classes.rb0000644000004100000410000100071013252673043025400 0ustar www-datawww-data# 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 DlpV2beta2 # An auxiliary table contains statistical information on the relative # frequency of different quasi-identifiers values. It has one or several # quasi-identifiers columns, and one column that indicates the relative # frequency of each quasi-identifier tuple. # If a tuple is present in the data but not in the auxiliary table, the # corresponding relative frequency is assumed to be zero (and thus, the # tuple is highly reidentifiable). class GooglePrivacyDlpV2beta1AuxiliaryTable include Google::Apis::Core::Hashable # Quasi-identifier columns. [required] # Corresponds to the JSON property `quasiIds` # @return [Array] attr_accessor :quasi_ids # General identifier of a data field in a storage service. # Corresponds to the JSON property `relativeFrequency` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId] attr_accessor :relative_frequency # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. # Corresponds to the JSON property `table` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable] attr_accessor :table def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @quasi_ids = args[:quasi_ids] if args.key?(:quasi_ids) @relative_frequency = args[:relative_frequency] if args.key?(:relative_frequency) @table = args[:table] if args.key?(:table) end end # Options defining BigQuery table and row identifiers. class GooglePrivacyDlpV2beta1BigQueryOptions include Google::Apis::Core::Hashable # References to fields uniquely identifying rows within the table. # Nested fields in the format, like `person.birthdate.year`, are allowed. # Corresponds to the JSON property `identifyingFields` # @return [Array] attr_accessor :identifying_fields # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. # Corresponds to the JSON property `tableReference` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable] attr_accessor :table_reference def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @identifying_fields = args[:identifying_fields] if args.key?(:identifying_fields) @table_reference = args[:table_reference] if args.key?(:table_reference) end end # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. class GooglePrivacyDlpV2beta1BigQueryTable include Google::Apis::Core::Hashable # Dataset ID of the table. # Corresponds to the JSON property `datasetId` # @return [String] attr_accessor :dataset_id # The Google Cloud Platform project ID of the project containing the table. # If omitted, project ID is inferred from the API call. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # Name of the table. # Corresponds to the JSON property `tableId` # @return [String] attr_accessor :table_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dataset_id = args[:dataset_id] if args.key?(:dataset_id) @project_id = args[:project_id] if args.key?(:project_id) @table_id = args[:table_id] if args.key?(:table_id) end end # Compute numerical stats over an individual column, including # number of distinct values and value count distribution. class GooglePrivacyDlpV2beta1CategoricalStatsConfig include Google::Apis::Core::Hashable # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId] attr_accessor :field def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) end end # Histogram bucket of value frequencies in the column. class GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket include Google::Apis::Core::Hashable # Total number of records in this bucket. # Corresponds to the JSON property `bucketSize` # @return [Fixnum] attr_accessor :bucket_size # Sample of value frequencies in this bucket. The total number of # values returned per bucket is capped at 20. # Corresponds to the JSON property `bucketValues` # @return [Array] attr_accessor :bucket_values # Lower bound on the value frequency of the values in this bucket. # Corresponds to the JSON property `valueFrequencyLowerBound` # @return [Fixnum] attr_accessor :value_frequency_lower_bound # Upper bound on the value frequency of the values in this bucket. # Corresponds to the JSON property `valueFrequencyUpperBound` # @return [Fixnum] attr_accessor :value_frequency_upper_bound def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_size = args[:bucket_size] if args.key?(:bucket_size) @bucket_values = args[:bucket_values] if args.key?(:bucket_values) @value_frequency_lower_bound = args[:value_frequency_lower_bound] if args.key?(:value_frequency_lower_bound) @value_frequency_upper_bound = args[:value_frequency_upper_bound] if args.key?(:value_frequency_upper_bound) end end # Result of the categorical stats computation. class GooglePrivacyDlpV2beta1CategoricalStatsResult include Google::Apis::Core::Hashable # Histogram of value frequencies in the column. # Corresponds to the JSON property `valueFrequencyHistogramBuckets` # @return [Array] attr_accessor :value_frequency_histogram_buckets def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @value_frequency_histogram_buckets = args[:value_frequency_histogram_buckets] if args.key?(:value_frequency_histogram_buckets) end end # Options defining a file or a set of files (path ending with *) within # a Google Cloud Storage bucket. class GooglePrivacyDlpV2beta1CloudStorageOptions include Google::Apis::Core::Hashable # Set of files to scan. # Corresponds to the JSON property `fileSet` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FileSet] attr_accessor :file_set def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file_set = args[:file_set] if args.key?(:file_set) end end # A location in Cloud Storage. class GooglePrivacyDlpV2beta1CloudStoragePath include Google::Apis::Core::Hashable # The url, in the format of `gs://bucket/`. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @path = args[:path] if args.key?(:path) end end # Custom information type provided by the user. Used to find domain-specific # sensitive information configurable to the data in question. class GooglePrivacyDlpV2beta1CustomInfoType include Google::Apis::Core::Hashable # Custom information type based on a dictionary of words or phrases. This can # be used to match sensitive information specific to the data, such as a list # of employee IDs or job titles. # Dictionary words are case-insensitive and all characters other than letters # and digits in the unicode [Basic Multilingual # Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29# # Basic_Multilingual_Plane) # will be replaced with whitespace when scanning for matches, so the # dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", # "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters # surrounding any match must be of a different type than the adjacent # characters within the word, so letters must be next to non-letters and # digits next to non-digits. For example, the dictionary word "jen" will # match the first three letters of the text "jen123" but will return no # matches for "jennifer". # Dictionary words containing a large number of characters that are not # letters or digits may result in unexpected findings because such characters # are treated as whitespace. # Corresponds to the JSON property `dictionary` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Dictionary] attr_accessor :dictionary # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType] attr_accessor :info_type # Message for detecting output from deidentification transformations # such as # [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/ # deidentify#CryptoReplaceFfxFpeConfig). # These types of transformations are # those that perform pseudonymization, thereby producing a "surrogate" as # output. This should be used in conjunction with a field on the # transformation such as `surrogate_info_type`. This custom info type does # not support the use of `detection_rules`. # Corresponds to the JSON property `surrogateType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1SurrogateType] attr_accessor :surrogate_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dictionary = args[:dictionary] if args.key?(:dictionary) @info_type = args[:info_type] if args.key?(:info_type) @surrogate_type = args[:surrogate_type] if args.key?(:surrogate_type) end end # Options defining a data set within Google Cloud Datastore. class GooglePrivacyDlpV2beta1DatastoreOptions include Google::Apis::Core::Hashable # A representation of a Datastore kind. # Corresponds to the JSON property `kind` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KindExpression] attr_accessor :kind # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always # by project and namespace, however the namespace ID may be empty. # A partition ID contains several dimensions: # project ID and namespace ID. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1PartitionId] attr_accessor :partition_id # Properties to scan. If none are specified, all properties will be scanned # by default. # Corresponds to the JSON property `projection` # @return [Array] attr_accessor :projection def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @partition_id = args[:partition_id] if args.key?(:partition_id) @projection = args[:projection] if args.key?(:projection) end end # Custom information type based on a dictionary of words or phrases. This can # be used to match sensitive information specific to the data, such as a list # of employee IDs or job titles. # Dictionary words are case-insensitive and all characters other than letters # and digits in the unicode [Basic Multilingual # Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29# # Basic_Multilingual_Plane) # will be replaced with whitespace when scanning for matches, so the # dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", # "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters # surrounding any match must be of a different type than the adjacent # characters within the word, so letters must be next to non-letters and # digits next to non-digits. For example, the dictionary word "jen" will # match the first three letters of the text "jen123" but will return no # matches for "jennifer". # Dictionary words containing a large number of characters that are not # letters or digits may result in unexpected findings because such characters # are treated as whitespace. class GooglePrivacyDlpV2beta1Dictionary include Google::Apis::Core::Hashable # Message defining a list of words or phrases to search for in the data. # Corresponds to the JSON property `wordList` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1WordList] attr_accessor :word_list def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @word_list = args[:word_list] if args.key?(:word_list) end end # An entity in a dataset is a field or set of fields that correspond to a # single person. For example, in medical records the `EntityId` might be # a patient identifier, or for financial records it might be an account # identifier. This message is used when generalizations or analysis must be # consistent across multiple rows pertaining to the same entity. class GooglePrivacyDlpV2beta1EntityId include Google::Apis::Core::Hashable # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId] attr_accessor :field def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) end end # General identifier of a data field in a storage service. class GooglePrivacyDlpV2beta1FieldId include Google::Apis::Core::Hashable # Name describing the field. # Corresponds to the JSON property `columnName` # @return [String] attr_accessor :column_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_name = args[:column_name] if args.key?(:column_name) end end # Set of files to scan. class GooglePrivacyDlpV2beta1FileSet include Google::Apis::Core::Hashable # The url, in the format `gs:///`. Trailing wildcard in the # path is allowed. # 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 # Type of information detected by the API. class GooglePrivacyDlpV2beta1InfoType include Google::Apis::Core::Hashable # Name of the information type. # 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 # Max findings configuration per info type, per content item or long running # operation. class GooglePrivacyDlpV2beta1InfoTypeLimit include Google::Apis::Core::Hashable # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType] attr_accessor :info_type # Max findings limit for the given infoType. # Corresponds to the JSON property `maxFindings` # @return [Fixnum] attr_accessor :max_findings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @info_type = args[:info_type] if args.key?(:info_type) @max_findings = args[:max_findings] if args.key?(:max_findings) end end # Statistics regarding a specific InfoType. class GooglePrivacyDlpV2beta1InfoTypeStatistics include Google::Apis::Core::Hashable # Number of findings for this info type. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType] attr_accessor :info_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @count = args[:count] if args.key?(:count) @info_type = args[:info_type] if args.key?(:info_type) end end # Configuration description of the scanning process. # When used with redactContent only info_types and min_likelihood are currently # used. class GooglePrivacyDlpV2beta1InspectConfig include Google::Apis::Core::Hashable # Custom info types provided by the user. # Corresponds to the JSON property `customInfoTypes` # @return [Array] attr_accessor :custom_info_types # When true, excludes type information of the findings. # Corresponds to the JSON property `excludeTypes` # @return [Boolean] attr_accessor :exclude_types alias_method :exclude_types?, :exclude_types # When true, a contextual quote from the data that triggered a finding is # included in the response; see Finding.quote. # Corresponds to the JSON property `includeQuote` # @return [Boolean] attr_accessor :include_quote alias_method :include_quote?, :include_quote # Configuration of findings limit given for specified info types. # Corresponds to the JSON property `infoTypeLimits` # @return [Array] attr_accessor :info_type_limits # Restricts what info_types to look for. The values must correspond to # InfoType values returned by ListInfoTypes or found in documentation. # Empty info_types runs all enabled detectors. # Corresponds to the JSON property `infoTypes` # @return [Array] attr_accessor :info_types # Limits the number of findings per content item or long running operation. # Corresponds to the JSON property `maxFindings` # @return [Fixnum] attr_accessor :max_findings # Only returns findings equal or above this threshold. # Corresponds to the JSON property `minLikelihood` # @return [String] attr_accessor :min_likelihood def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_info_types = args[:custom_info_types] if args.key?(:custom_info_types) @exclude_types = args[:exclude_types] if args.key?(:exclude_types) @include_quote = args[:include_quote] if args.key?(:include_quote) @info_type_limits = args[:info_type_limits] if args.key?(:info_type_limits) @info_types = args[:info_types] if args.key?(:info_types) @max_findings = args[:max_findings] if args.key?(:max_findings) @min_likelihood = args[:min_likelihood] if args.key?(:min_likelihood) end end # Metadata returned within GetOperation for an inspect request. class GooglePrivacyDlpV2beta1InspectOperationMetadata include Google::Apis::Core::Hashable # The time which this request was started. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # # Corresponds to the JSON property `infoTypeStats` # @return [Array] attr_accessor :info_type_stats # Total size in bytes that were processed. # Corresponds to the JSON property `processedBytes` # @return [Fixnum] attr_accessor :processed_bytes # Configuration description of the scanning process. # When used with redactContent only info_types and min_likelihood are currently # used. # Corresponds to the JSON property `requestInspectConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InspectConfig] attr_accessor :request_inspect_config # Cloud repository for storing output. # Corresponds to the JSON property `requestOutputConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1OutputStorageConfig] attr_accessor :request_output_config # Shared message indicating Cloud storage type. # Corresponds to the JSON property `requestStorageConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1StorageConfig] attr_accessor :request_storage_config # Estimate of the number of bytes to process. # Corresponds to the JSON property `totalEstimatedBytes` # @return [Fixnum] attr_accessor :total_estimated_bytes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @info_type_stats = args[:info_type_stats] if args.key?(:info_type_stats) @processed_bytes = args[:processed_bytes] if args.key?(:processed_bytes) @request_inspect_config = args[:request_inspect_config] if args.key?(:request_inspect_config) @request_output_config = args[:request_output_config] if args.key?(:request_output_config) @request_storage_config = args[:request_storage_config] if args.key?(:request_storage_config) @total_estimated_bytes = args[:total_estimated_bytes] if args.key?(:total_estimated_bytes) end end # The operational data. class GooglePrivacyDlpV2beta1InspectOperationResult include Google::Apis::Core::Hashable # 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 have the format of `inspect/results/`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) @name = args[:name] if args.key?(:name) end end # k-anonymity metric, used for analysis of reidentification risk. class GooglePrivacyDlpV2beta1KAnonymityConfig include Google::Apis::Core::Hashable # An entity in a dataset is a field or set of fields that correspond to a # single person. For example, in medical records the `EntityId` might be # a patient identifier, or for financial records it might be an account # identifier. This message is used when generalizations or analysis must be # consistent across multiple rows pertaining to the same entity. # Corresponds to the JSON property `entityId` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1EntityId] attr_accessor :entity_id # Set of fields to compute k-anonymity over. When multiple fields are # specified, they are considered a single composite key. Structs and # repeated data types are not supported; however, nested fields are # supported so long as they are not structs themselves or nested within # a repeated field. # Corresponds to the JSON property `quasiIds` # @return [Array] attr_accessor :quasi_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_id = args[:entity_id] if args.key?(:entity_id) @quasi_ids = args[:quasi_ids] if args.key?(:quasi_ids) end end # The set of columns' values that share the same k-anonymity value. class GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass include Google::Apis::Core::Hashable # Size of the equivalence class, for example number of rows with the # above set of values. # Corresponds to the JSON property `equivalenceClassSize` # @return [Fixnum] attr_accessor :equivalence_class_size # Set of values defining the equivalence class. One value per # quasi-identifier column in the original KAnonymity metric message. # The order is always the same as the original request. # Corresponds to the JSON property `quasiIdsValues` # @return [Array] attr_accessor :quasi_ids_values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @equivalence_class_size = args[:equivalence_class_size] if args.key?(:equivalence_class_size) @quasi_ids_values = args[:quasi_ids_values] if args.key?(:quasi_ids_values) end end # Histogram bucket of equivalence class sizes in the table. class GooglePrivacyDlpV2beta1KAnonymityHistogramBucket include Google::Apis::Core::Hashable # Total number of records in this bucket. # Corresponds to the JSON property `bucketSize` # @return [Fixnum] attr_accessor :bucket_size # Sample of equivalence classes in this bucket. The total number of # classes returned per bucket is capped at 20. # Corresponds to the JSON property `bucketValues` # @return [Array] attr_accessor :bucket_values # Lower bound on the size of the equivalence classes in this bucket. # Corresponds to the JSON property `equivalenceClassSizeLowerBound` # @return [Fixnum] attr_accessor :equivalence_class_size_lower_bound # Upper bound on the size of the equivalence classes in this bucket. # Corresponds to the JSON property `equivalenceClassSizeUpperBound` # @return [Fixnum] attr_accessor :equivalence_class_size_upper_bound def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_size = args[:bucket_size] if args.key?(:bucket_size) @bucket_values = args[:bucket_values] if args.key?(:bucket_values) @equivalence_class_size_lower_bound = args[:equivalence_class_size_lower_bound] if args.key?(:equivalence_class_size_lower_bound) @equivalence_class_size_upper_bound = args[:equivalence_class_size_upper_bound] if args.key?(:equivalence_class_size_upper_bound) end end # Result of the k-anonymity computation. class GooglePrivacyDlpV2beta1KAnonymityResult include Google::Apis::Core::Hashable # Histogram of k-anonymity equivalence classes. # Corresponds to the JSON property `equivalenceClassHistogramBuckets` # @return [Array] attr_accessor :equivalence_class_histogram_buckets def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @equivalence_class_histogram_buckets = args[:equivalence_class_histogram_buckets] if args.key?(:equivalence_class_histogram_buckets) end end # Reidentifiability metric. This corresponds to a risk model similar to what # is called "journalist risk" in the literature, except the attack dataset is # statistically modeled instead of being perfectly known. This can be done # using publicly available data (like the US Census), or using a custom # statistical model (indicated as one or several BigQuery tables), or by # extrapolating from the distribution of values in the input dataset. class GooglePrivacyDlpV2beta1KMapEstimationConfig include Google::Apis::Core::Hashable # Several auxiliary tables can be used in the analysis. Each custom_tag # used to tag a quasi-identifiers column must appear in exactly one column # of one auxiliary table. # Corresponds to the JSON property `auxiliaryTables` # @return [Array] attr_accessor :auxiliary_tables # Fields considered to be quasi-identifiers. No two columns can have the # same tag. [required] # Corresponds to the JSON property `quasiIds` # @return [Array] attr_accessor :quasi_ids # ISO 3166-1 alpha-2 region code to use in the statistical modeling. # Required if no column is tagged with a region-specific InfoType (like # US_ZIP_5) or a region code. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auxiliary_tables = args[:auxiliary_tables] if args.key?(:auxiliary_tables) @quasi_ids = args[:quasi_ids] if args.key?(:quasi_ids) @region_code = args[:region_code] if args.key?(:region_code) end end # A KMapEstimationHistogramBucket message with the following values: # min_anonymity: 3 # max_anonymity: 5 # frequency: 42 # means that there are 42 records whose quasi-identifier values correspond # to 3, 4 or 5 people in the overlying population. An important particular # case is when min_anonymity = max_anonymity = 1: the frequency field then # corresponds to the number of uniquely identifiable records. class GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket include Google::Apis::Core::Hashable # Number of records within these anonymity bounds. # Corresponds to the JSON property `bucketSize` # @return [Fixnum] attr_accessor :bucket_size # Sample of quasi-identifier tuple values in this bucket. The total # number of classes returned per bucket is capped at 20. # Corresponds to the JSON property `bucketValues` # @return [Array] attr_accessor :bucket_values # Always greater than or equal to min_anonymity. # Corresponds to the JSON property `maxAnonymity` # @return [Fixnum] attr_accessor :max_anonymity # Always positive. # Corresponds to the JSON property `minAnonymity` # @return [Fixnum] attr_accessor :min_anonymity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_size = args[:bucket_size] if args.key?(:bucket_size) @bucket_values = args[:bucket_values] if args.key?(:bucket_values) @max_anonymity = args[:max_anonymity] if args.key?(:max_anonymity) @min_anonymity = args[:min_anonymity] if args.key?(:min_anonymity) end end # A tuple of values for the quasi-identifier columns. class GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues include Google::Apis::Core::Hashable # The estimated anonymity for these quasi-identifier values. # Corresponds to the JSON property `estimatedAnonymity` # @return [Fixnum] attr_accessor :estimated_anonymity # The quasi-identifier values. # Corresponds to the JSON property `quasiIdsValues` # @return [Array] attr_accessor :quasi_ids_values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @estimated_anonymity = args[:estimated_anonymity] if args.key?(:estimated_anonymity) @quasi_ids_values = args[:quasi_ids_values] if args.key?(:quasi_ids_values) end end # Result of the reidentifiability analysis. Note that these results are an # estimation, not exact values. class GooglePrivacyDlpV2beta1KMapEstimationResult include Google::Apis::Core::Hashable # The intervals [min_anonymity, max_anonymity] do not overlap. If a value # doesn't correspond to any such interval, the associated frequency is # zero. For example, the following records: # `min_anonymity: 1, max_anonymity: 1, frequency: 17` # `min_anonymity: 2, max_anonymity: 3, frequency: 42` # `min_anonymity: 5, max_anonymity: 10, frequency: 99` # mean that there are no record with an estimated anonymity of 4, 5, or # larger than 10. # Corresponds to the JSON property `kMapEstimationHistogram` # @return [Array] attr_accessor :k_map_estimation_histogram def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @k_map_estimation_histogram = args[:k_map_estimation_histogram] if args.key?(:k_map_estimation_histogram) end end # A representation of a Datastore kind. class GooglePrivacyDlpV2beta1KindExpression include Google::Apis::Core::Hashable # The name of the kind. # 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 # l-diversity metric, used for analysis of reidentification risk. class GooglePrivacyDlpV2beta1LDiversityConfig include Google::Apis::Core::Hashable # Set of quasi-identifiers indicating how equivalence classes are # defined for the l-diversity computation. When multiple fields are # specified, they are considered a single composite key. # Corresponds to the JSON property `quasiIds` # @return [Array] attr_accessor :quasi_ids # General identifier of a data field in a storage service. # Corresponds to the JSON property `sensitiveAttribute` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId] attr_accessor :sensitive_attribute def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @quasi_ids = args[:quasi_ids] if args.key?(:quasi_ids) @sensitive_attribute = args[:sensitive_attribute] if args.key?(:sensitive_attribute) end end # The set of columns' values that share the same l-diversity value. class GooglePrivacyDlpV2beta1LDiversityEquivalenceClass include Google::Apis::Core::Hashable # Size of the k-anonymity equivalence class. # Corresponds to the JSON property `equivalenceClassSize` # @return [Fixnum] attr_accessor :equivalence_class_size # Number of distinct sensitive values in this equivalence class. # Corresponds to the JSON property `numDistinctSensitiveValues` # @return [Fixnum] attr_accessor :num_distinct_sensitive_values # Quasi-identifier values defining the k-anonymity equivalence # class. The order is always the same as the original request. # Corresponds to the JSON property `quasiIdsValues` # @return [Array] attr_accessor :quasi_ids_values # Estimated frequencies of top sensitive values. # Corresponds to the JSON property `topSensitiveValues` # @return [Array] attr_accessor :top_sensitive_values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @equivalence_class_size = args[:equivalence_class_size] if args.key?(:equivalence_class_size) @num_distinct_sensitive_values = args[:num_distinct_sensitive_values] if args.key?(:num_distinct_sensitive_values) @quasi_ids_values = args[:quasi_ids_values] if args.key?(:quasi_ids_values) @top_sensitive_values = args[:top_sensitive_values] if args.key?(:top_sensitive_values) end end # Histogram bucket of sensitive value frequencies in the table. class GooglePrivacyDlpV2beta1LDiversityHistogramBucket include Google::Apis::Core::Hashable # Total number of records in this bucket. # Corresponds to the JSON property `bucketSize` # @return [Fixnum] attr_accessor :bucket_size # Sample of equivalence classes in this bucket. The total number of # classes returned per bucket is capped at 20. # Corresponds to the JSON property `bucketValues` # @return [Array] attr_accessor :bucket_values # Lower bound on the sensitive value frequencies of the equivalence # classes in this bucket. # Corresponds to the JSON property `sensitiveValueFrequencyLowerBound` # @return [Fixnum] attr_accessor :sensitive_value_frequency_lower_bound # Upper bound on the sensitive value frequencies of the equivalence # classes in this bucket. # Corresponds to the JSON property `sensitiveValueFrequencyUpperBound` # @return [Fixnum] attr_accessor :sensitive_value_frequency_upper_bound def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_size = args[:bucket_size] if args.key?(:bucket_size) @bucket_values = args[:bucket_values] if args.key?(:bucket_values) @sensitive_value_frequency_lower_bound = args[:sensitive_value_frequency_lower_bound] if args.key?(:sensitive_value_frequency_lower_bound) @sensitive_value_frequency_upper_bound = args[:sensitive_value_frequency_upper_bound] if args.key?(:sensitive_value_frequency_upper_bound) end end # Result of the l-diversity computation. class GooglePrivacyDlpV2beta1LDiversityResult include Google::Apis::Core::Hashable # Histogram of l-diversity equivalence class sensitive value frequencies. # Corresponds to the JSON property `sensitiveValueFrequencyHistogramBuckets` # @return [Array] attr_accessor :sensitive_value_frequency_histogram_buckets def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @sensitive_value_frequency_histogram_buckets = args[:sensitive_value_frequency_histogram_buckets] if args.key?(:sensitive_value_frequency_histogram_buckets) end end # Compute numerical stats over an individual column, including # min, max, and quantiles. class GooglePrivacyDlpV2beta1NumericalStatsConfig include Google::Apis::Core::Hashable # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId] attr_accessor :field def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) end end # Result of the numerical stats computation. class GooglePrivacyDlpV2beta1NumericalStatsResult include Google::Apis::Core::Hashable # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `maxValue` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value] attr_accessor :max_value # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `minValue` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value] attr_accessor :min_value # List of 99 values that partition the set of field values into 100 equal # sized buckets. # Corresponds to the JSON property `quantileValues` # @return [Array] attr_accessor :quantile_values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_value = args[:max_value] if args.key?(:max_value) @min_value = args[:min_value] if args.key?(:min_value) @quantile_values = args[:quantile_values] if args.key?(:quantile_values) end end # Cloud repository for storing output. class GooglePrivacyDlpV2beta1OutputStorageConfig include Google::Apis::Core::Hashable # A location in Cloud Storage. # Corresponds to the JSON property `storagePath` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CloudStoragePath] attr_accessor :storage_path # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. # Corresponds to the JSON property `table` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable] attr_accessor :table def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @storage_path = args[:storage_path] if args.key?(:storage_path) @table = args[:table] if args.key?(:table) end end # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always # by project and namespace, however the namespace ID may be empty. # A partition ID contains several dimensions: # project ID and namespace ID. class GooglePrivacyDlpV2beta1PartitionId include Google::Apis::Core::Hashable # If not empty, the ID of the namespace to which the entities belong. # Corresponds to the JSON property `namespaceId` # @return [String] attr_accessor :namespace_id # The ID of the project to which the entities belong. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @namespace_id = args[:namespace_id] if args.key?(:namespace_id) @project_id = args[:project_id] if args.key?(:project_id) end end # Privacy metric to compute for reidentification risk analysis. class GooglePrivacyDlpV2beta1PrivacyMetric include Google::Apis::Core::Hashable # Compute numerical stats over an individual column, including # number of distinct values and value count distribution. # Corresponds to the JSON property `categoricalStatsConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CategoricalStatsConfig] attr_accessor :categorical_stats_config # k-anonymity metric, used for analysis of reidentification risk. # Corresponds to the JSON property `kAnonymityConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KAnonymityConfig] attr_accessor :k_anonymity_config # Reidentifiability metric. This corresponds to a risk model similar to what # is called "journalist risk" in the literature, except the attack dataset is # statistically modeled instead of being perfectly known. This can be done # using publicly available data (like the US Census), or using a custom # statistical model (indicated as one or several BigQuery tables), or by # extrapolating from the distribution of values in the input dataset. # Corresponds to the JSON property `kMapEstimationConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KMapEstimationConfig] attr_accessor :k_map_estimation_config # l-diversity metric, used for analysis of reidentification risk. # Corresponds to the JSON property `lDiversityConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1LDiversityConfig] attr_accessor :l_diversity_config # Compute numerical stats over an individual column, including # min, max, and quantiles. # Corresponds to the JSON property `numericalStatsConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1NumericalStatsConfig] attr_accessor :numerical_stats_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @categorical_stats_config = args[:categorical_stats_config] if args.key?(:categorical_stats_config) @k_anonymity_config = args[:k_anonymity_config] if args.key?(:k_anonymity_config) @k_map_estimation_config = args[:k_map_estimation_config] if args.key?(:k_map_estimation_config) @l_diversity_config = args[:l_diversity_config] if args.key?(:l_diversity_config) @numerical_stats_config = args[:numerical_stats_config] if args.key?(:numerical_stats_config) end end # A representation of a Datastore property in a projection. class GooglePrivacyDlpV2beta1Projection include Google::Apis::Core::Hashable # A reference to a property relative to the Datastore kind expressions. # Corresponds to the JSON property `property` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1PropertyReference] 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 reference to a property relative to the Datastore kind expressions. class GooglePrivacyDlpV2beta1PropertyReference include Google::Apis::Core::Hashable # The name of the property. # If name includes "."s, it may be interpreted as a property name path. # 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 # A quasi-identifier column has a custom_tag, used to know which column # in the data corresponds to which column in the statistical model. class GooglePrivacyDlpV2beta1QuasiIdField include Google::Apis::Core::Hashable # # Corresponds to the JSON property `customTag` # @return [String] attr_accessor :custom_tag # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId] attr_accessor :field def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_tag = args[:custom_tag] if args.key?(:custom_tag) @field = args[:field] if args.key?(:field) end end # Metadata returned within the # [`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis. # operations/get) # for risk analysis. class GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata include Google::Apis::Core::Hashable # The time which this request was started. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Privacy metric to compute for reidentification risk analysis. # Corresponds to the JSON property `requestedPrivacyMetric` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1PrivacyMetric] attr_accessor :requested_privacy_metric # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. # Corresponds to the JSON property `requestedSourceTable` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryTable] attr_accessor :requested_source_table def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @requested_privacy_metric = args[:requested_privacy_metric] if args.key?(:requested_privacy_metric) @requested_source_table = args[:requested_source_table] if args.key?(:requested_source_table) end end # Result of a risk analysis # [`Operation`](/dlp/docs/reference/rest/v2beta1/inspect.operations) # request. class GooglePrivacyDlpV2beta1RiskAnalysisOperationResult include Google::Apis::Core::Hashable # Result of the categorical stats computation. # Corresponds to the JSON property `categoricalStatsResult` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CategoricalStatsResult] attr_accessor :categorical_stats_result # Result of the k-anonymity computation. # Corresponds to the JSON property `kAnonymityResult` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KAnonymityResult] attr_accessor :k_anonymity_result # Result of the reidentifiability analysis. Note that these results are an # estimation, not exact values. # Corresponds to the JSON property `kMapEstimationResult` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1KMapEstimationResult] attr_accessor :k_map_estimation_result # Result of the l-diversity computation. # Corresponds to the JSON property `lDiversityResult` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1LDiversityResult] attr_accessor :l_diversity_result # Result of the numerical stats computation. # Corresponds to the JSON property `numericalStatsResult` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1NumericalStatsResult] attr_accessor :numerical_stats_result def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @categorical_stats_result = args[:categorical_stats_result] if args.key?(:categorical_stats_result) @k_anonymity_result = args[:k_anonymity_result] if args.key?(:k_anonymity_result) @k_map_estimation_result = args[:k_map_estimation_result] if args.key?(:k_map_estimation_result) @l_diversity_result = args[:l_diversity_result] if args.key?(:l_diversity_result) @numerical_stats_result = args[:numerical_stats_result] if args.key?(:numerical_stats_result) end end # Shared message indicating Cloud storage type. class GooglePrivacyDlpV2beta1StorageConfig include Google::Apis::Core::Hashable # Options defining BigQuery table and row identifiers. # Corresponds to the JSON property `bigQueryOptions` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1BigQueryOptions] attr_accessor :big_query_options # Options defining a file or a set of files (path ending with *) within # a Google Cloud Storage bucket. # Corresponds to the JSON property `cloudStorageOptions` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1CloudStorageOptions] attr_accessor :cloud_storage_options # Options defining a data set within Google Cloud Datastore. # Corresponds to the JSON property `datastoreOptions` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1DatastoreOptions] attr_accessor :datastore_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @big_query_options = args[:big_query_options] if args.key?(:big_query_options) @cloud_storage_options = args[:cloud_storage_options] if args.key?(:cloud_storage_options) @datastore_options = args[:datastore_options] if args.key?(:datastore_options) end end # Message for detecting output from deidentification transformations # such as # [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/ # deidentify#CryptoReplaceFfxFpeConfig). # These types of transformations are # those that perform pseudonymization, thereby producing a "surrogate" as # output. This should be used in conjunction with a field on the # transformation such as `surrogate_info_type`. This custom info type does # not support the use of `detection_rules`. class GooglePrivacyDlpV2beta1SurrogateType include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # A column with a semantic tag attached. class GooglePrivacyDlpV2beta1TaggedField include Google::Apis::Core::Hashable # A column can be tagged with a custom tag. In this case, the user must # indicate an auxiliary table that contains statistical information on # the possible values of this column (below). # Corresponds to the JSON property `customTag` # @return [String] attr_accessor :custom_tag # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1FieldId] attr_accessor :field # 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 ````. # Corresponds to the JSON property `inferred` # @return [Google::Apis::DlpV2beta2::GoogleProtobufEmpty] attr_accessor :inferred # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1InfoType] attr_accessor :info_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_tag = args[:custom_tag] if args.key?(:custom_tag) @field = args[:field] if args.key?(:field) @inferred = args[:inferred] if args.key?(:inferred) @info_type = args[:info_type] if args.key?(:info_type) end end # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. class GooglePrivacyDlpV2beta1Value include Google::Apis::Core::Hashable # # Corresponds to the JSON property `booleanValue` # @return [Boolean] attr_accessor :boolean_value alias_method :boolean_value?, :boolean_value # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary date. Related types are google.type.TimeOfDay # and `google.protobuf.Timestamp`. # Corresponds to the JSON property `dateValue` # @return [Google::Apis::DlpV2beta2::GoogleTypeDate] attr_accessor :date_value # # Corresponds to the JSON property `floatValue` # @return [Float] attr_accessor :float_value # # Corresponds to the JSON property `integerValue` # @return [Fixnum] attr_accessor :integer_value # # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value # 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 `timeValue` # @return [Google::Apis::DlpV2beta2::GoogleTypeTimeOfDay] attr_accessor :time_value # # Corresponds to the JSON property `timestampValue` # @return [String] attr_accessor :timestamp_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @boolean_value = args[:boolean_value] if args.key?(:boolean_value) @date_value = args[:date_value] if args.key?(:date_value) @float_value = args[:float_value] if args.key?(:float_value) @integer_value = args[:integer_value] if args.key?(:integer_value) @string_value = args[:string_value] if args.key?(:string_value) @time_value = args[:time_value] if args.key?(:time_value) @timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value) end end # A value of a field, including its frequency. class GooglePrivacyDlpV2beta1ValueFrequency include Google::Apis::Core::Hashable # How many times the value is contained in the field. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `value` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta1Value] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @count = args[:count] if args.key?(:count) @value = args[:value] if args.key?(:value) end end # Message defining a list of words or phrases to search for in the data. class GooglePrivacyDlpV2beta1WordList include Google::Apis::Core::Hashable # Words or phrases defining the dictionary. The dictionary must contain # at least one phrase and every phrase must contain at least 2 characters # that are letters or digits. [required] # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @words = args[:words] if args.key?(:words) end end # A task to execute on the completion of a job. class GooglePrivacyDlpV2beta2Action include Google::Apis::Core::Hashable # Publish the results of a DlpJob to a pub sub channel. # Compatible with: Inpect, Risk # Corresponds to the JSON property `pubSub` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PublishToPubSub] attr_accessor :pub_sub # If set, the detailed findings will be persisted to the specified # OutputStorageConfig. Compatible with: Inspect # Corresponds to the JSON property `saveFindings` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2SaveFindings] attr_accessor :save_findings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @pub_sub = args[:pub_sub] if args.key?(:pub_sub) @save_findings = args[:save_findings] if args.key?(:save_findings) end end # Result of a risk analysis operation request. class GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails include Google::Apis::Core::Hashable # Result of the categorical stats computation. # Corresponds to the JSON property `categoricalStatsResult` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CategoricalStatsResult] attr_accessor :categorical_stats_result # Result of the k-anonymity computation. # Corresponds to the JSON property `kAnonymityResult` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KAnonymityResult] attr_accessor :k_anonymity_result # Result of the reidentifiability analysis. Note that these results are an # estimation, not exact values. # Corresponds to the JSON property `kMapEstimationResult` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KMapEstimationResult] attr_accessor :k_map_estimation_result # Result of the l-diversity computation. # Corresponds to the JSON property `lDiversityResult` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LDiversityResult] attr_accessor :l_diversity_result # Result of the numerical stats computation. # Corresponds to the JSON property `numericalStatsResult` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2NumericalStatsResult] attr_accessor :numerical_stats_result # Privacy metric to compute for reidentification risk analysis. # Corresponds to the JSON property `requestedPrivacyMetric` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrivacyMetric] attr_accessor :requested_privacy_metric # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. # Corresponds to the JSON property `requestedSourceTable` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable] attr_accessor :requested_source_table def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @categorical_stats_result = args[:categorical_stats_result] if args.key?(:categorical_stats_result) @k_anonymity_result = args[:k_anonymity_result] if args.key?(:k_anonymity_result) @k_map_estimation_result = args[:k_map_estimation_result] if args.key?(:k_map_estimation_result) @l_diversity_result = args[:l_diversity_result] if args.key?(:l_diversity_result) @numerical_stats_result = args[:numerical_stats_result] if args.key?(:numerical_stats_result) @requested_privacy_metric = args[:requested_privacy_metric] if args.key?(:requested_privacy_metric) @requested_source_table = args[:requested_source_table] if args.key?(:requested_source_table) end end # Request for creating a risk analysis DlpJob. class GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest include Google::Apis::Core::Hashable # Configuration for a risk analysis job. # Corresponds to the JSON property `jobConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RiskAnalysisJobConfig] attr_accessor :job_config # Optional job ID to use for the created job. If not provided, a job ID will # automatically be generated. Must be unique within the project. The job ID # can contain uppercase and lowercase letters, numbers, and hyphens; that is, # it must match the regular expression: `[a-zA-Z\\d-]+`. The maximum length # is 100 characters. Can be empty to allow the system to generate one. # Corresponds to the JSON property `jobId` # @return [String] attr_accessor :job_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @job_config = args[:job_config] if args.key?(:job_config) @job_id = args[:job_id] if args.key?(:job_id) end end # An auxiliary table contains statistical information on the relative # frequency of different quasi-identifiers values. It has one or several # quasi-identifiers columns, and one column that indicates the relative # frequency of each quasi-identifier tuple. # If a tuple is present in the data but not in the auxiliary table, the # corresponding relative frequency is assumed to be zero (and thus, the # tuple is highly reidentifiable). class GooglePrivacyDlpV2beta2AuxiliaryTable include Google::Apis::Core::Hashable # Quasi-identifier columns. [required] # Corresponds to the JSON property `quasiIds` # @return [Array] attr_accessor :quasi_ids # General identifier of a data field in a storage service. # Corresponds to the JSON property `relativeFrequency` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :relative_frequency # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. # Corresponds to the JSON property `table` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable] attr_accessor :table def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @quasi_ids = args[:quasi_ids] if args.key?(:quasi_ids) @relative_frequency = args[:relative_frequency] if args.key?(:relative_frequency) @table = args[:table] if args.key?(:table) end end # Options defining BigQuery table and row identifiers. class GooglePrivacyDlpV2beta2BigQueryOptions include Google::Apis::Core::Hashable # References to fields uniquely identifying rows within the table. # Nested fields in the format, like `person.birthdate.year`, are allowed. # Corresponds to the JSON property `identifyingFields` # @return [Array] attr_accessor :identifying_fields # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. # Corresponds to the JSON property `tableReference` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable] attr_accessor :table_reference def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @identifying_fields = args[:identifying_fields] if args.key?(:identifying_fields) @table_reference = args[:table_reference] if args.key?(:table_reference) end end # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. class GooglePrivacyDlpV2beta2BigQueryTable include Google::Apis::Core::Hashable # Dataset ID of the table. # Corresponds to the JSON property `datasetId` # @return [String] attr_accessor :dataset_id # The Google Cloud Platform project ID of the project containing the table. # If omitted, project ID is inferred from the API call. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # Name of the table. # Corresponds to the JSON property `tableId` # @return [String] attr_accessor :table_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dataset_id = args[:dataset_id] if args.key?(:dataset_id) @project_id = args[:project_id] if args.key?(:project_id) @table_id = args[:table_id] if args.key?(:table_id) end end # Bucket is represented as a range, along with replacement values. class GooglePrivacyDlpV2beta2Bucket include Google::Apis::Core::Hashable # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `max` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value] attr_accessor :max # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `min` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value] attr_accessor :min # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `replacementValue` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value] attr_accessor :replacement_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max = args[:max] if args.key?(:max) @min = args[:min] if args.key?(:min) @replacement_value = args[:replacement_value] if args.key?(:replacement_value) end end # Generalization function that buckets values based on ranges. The ranges and # replacement values are dynamically provided by the user for custom behavior, # such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH # This can be used on # data of type: number, long, string, timestamp. # If the bound `Value` type differs from the type of data being transformed, we # will first attempt converting the type of the data to be transformed to match # the type of the bound before comparing. class GooglePrivacyDlpV2beta2BucketingConfig include Google::Apis::Core::Hashable # Set of buckets. Ranges must be non-overlapping. # Corresponds to the JSON property `buckets` # @return [Array] attr_accessor :buckets def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @buckets = args[:buckets] if args.key?(:buckets) end end # The request message for canceling a DLP job. class GooglePrivacyDlpV2beta2CancelDlpJobRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Compute numerical stats over an individual column, including # number of distinct values and value count distribution. class GooglePrivacyDlpV2beta2CategoricalStatsConfig include Google::Apis::Core::Hashable # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :field def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) end end # class GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket include Google::Apis::Core::Hashable # Total number of values in this bucket. # Corresponds to the JSON property `bucketSize` # @return [Fixnum] attr_accessor :bucket_size # Sample of value frequencies in this bucket. The total number of # values returned per bucket is capped at 20. # Corresponds to the JSON property `bucketValues` # @return [Array] attr_accessor :bucket_values # Lower bound on the value frequency of the values in this bucket. # Corresponds to the JSON property `valueFrequencyLowerBound` # @return [Fixnum] attr_accessor :value_frequency_lower_bound # Upper bound on the value frequency of the values in this bucket. # Corresponds to the JSON property `valueFrequencyUpperBound` # @return [Fixnum] attr_accessor :value_frequency_upper_bound def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_size = args[:bucket_size] if args.key?(:bucket_size) @bucket_values = args[:bucket_values] if args.key?(:bucket_values) @value_frequency_lower_bound = args[:value_frequency_lower_bound] if args.key?(:value_frequency_lower_bound) @value_frequency_upper_bound = args[:value_frequency_upper_bound] if args.key?(:value_frequency_upper_bound) end end # Result of the categorical stats computation. class GooglePrivacyDlpV2beta2CategoricalStatsResult include Google::Apis::Core::Hashable # Histogram of value frequencies in the column. # Corresponds to the JSON property `valueFrequencyHistogramBuckets` # @return [Array] attr_accessor :value_frequency_histogram_buckets def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @value_frequency_histogram_buckets = args[:value_frequency_histogram_buckets] if args.key?(:value_frequency_histogram_buckets) end end # Partially mask a string by replacing a given number of characters with a # fixed character. Masking can start from the beginning or end of the string. # This can be used on data of any type (numbers, longs, and so on) and when # de-identifying structured data we'll attempt to preserve the original data's # type. (This allows you to take a long like 123 and modify it to a string like # **3. class GooglePrivacyDlpV2beta2CharacterMaskConfig include Google::Apis::Core::Hashable # When masking a string, items in this list will be skipped when replacing. # For example, if your string is 555-555-5555 and you ask us to skip `-` and # mask 5 chars with * we would produce ***-*55-5555. # Corresponds to the JSON property `charactersToIgnore` # @return [Array] attr_accessor :characters_to_ignore # Character to mask the sensitive values—for example, "*" for an # alphabetic string such as name, or "0" for a numeric string such as ZIP # code or credit card number. String must have length 1. If not supplied, we # will default to "*" for strings, 0 for digits. # Corresponds to the JSON property `maskingCharacter` # @return [String] attr_accessor :masking_character # Number of characters to mask. If not set, all matching chars will be # masked. Skipped characters do not count towards this tally. # Corresponds to the JSON property `numberToMask` # @return [Fixnum] attr_accessor :number_to_mask # Mask characters in reverse order. For example, if `masking_character` is # '0', number_to_mask is 14, and `reverse_order` is false, then # 1234-5678-9012-3456 -> 00000000000000-3456 # If `masking_character` is '*', `number_to_mask` is 3, and `reverse_order` # is true, then 12345 -> 12*** # Corresponds to the JSON property `reverseOrder` # @return [Boolean] attr_accessor :reverse_order alias_method :reverse_order?, :reverse_order def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @characters_to_ignore = args[:characters_to_ignore] if args.key?(:characters_to_ignore) @masking_character = args[:masking_character] if args.key?(:masking_character) @number_to_mask = args[:number_to_mask] if args.key?(:number_to_mask) @reverse_order = args[:reverse_order] if args.key?(:reverse_order) end end # Characters to skip when doing deidentification of a value. These will be left # alone and skipped. class GooglePrivacyDlpV2beta2CharsToIgnore include Google::Apis::Core::Hashable # # Corresponds to the JSON property `charactersToSkip` # @return [String] attr_accessor :characters_to_skip # # Corresponds to the JSON property `commonCharactersToIgnore` # @return [String] attr_accessor :common_characters_to_ignore def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @characters_to_skip = args[:characters_to_skip] if args.key?(:characters_to_skip) @common_characters_to_ignore = args[:common_characters_to_ignore] if args.key?(:common_characters_to_ignore) end end # Record key for a finding in a Cloud Storage file. class GooglePrivacyDlpV2beta2CloudStorageKey include Google::Apis::Core::Hashable # Path to the file. # Corresponds to the JSON property `filePath` # @return [String] attr_accessor :file_path # Byte offset of the referenced data in the file. # Corresponds to the JSON property `startOffset` # @return [Fixnum] attr_accessor :start_offset def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file_path = args[:file_path] if args.key?(:file_path) @start_offset = args[:start_offset] if args.key?(:start_offset) end end # Options defining a file or a set of files (path ending with *) within # a Google Cloud Storage bucket. class GooglePrivacyDlpV2beta2CloudStorageOptions include Google::Apis::Core::Hashable # Max number of bytes to scan from a file. If a scanned file's size is bigger # than this value then the rest of the bytes are omitted. # Corresponds to the JSON property `bytesLimitPerFile` # @return [Fixnum] attr_accessor :bytes_limit_per_file # Set of files to scan. # Corresponds to the JSON property `fileSet` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FileSet] attr_accessor :file_set def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bytes_limit_per_file = args[:bytes_limit_per_file] if args.key?(:bytes_limit_per_file) @file_set = args[:file_set] if args.key?(:file_set) end end # Represents a color in the RGB color space. class GooglePrivacyDlpV2beta2Color include Google::Apis::Core::Hashable # The amount of blue in the color as a value in the interval [0, 1]. # Corresponds to the JSON property `blue` # @return [Float] attr_accessor :blue # The amount of green in the color as a value in the interval [0, 1]. # Corresponds to the JSON property `green` # @return [Float] attr_accessor :green # The amount of red in the color as a value in the interval [0, 1]. # Corresponds to the JSON property `red` # @return [Float] attr_accessor :red def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @blue = args[:blue] if args.key?(:blue) @green = args[:green] if args.key?(:green) @red = args[:red] if args.key?(:red) end end # The field type of `value` and `field` do not need to match to be # considered equal, but not all comparisons are possible. # A `value` of type: # - `string` can be compared against all other types # - `boolean` can only be compared against other booleans # - `integer` can be compared against doubles or a string if the string value # can be parsed as an integer. # - `double` can be compared against integers or a string if the string can # be parsed as a double. # - `Timestamp` can be compared against strings in RFC 3339 date string # format. # - `TimeOfDay` can be compared against timestamps and strings in the format # of 'HH:mm:ss'. # If we fail to compare do to type mismatch, a warning will be given and # the condition will evaluate to false. class GooglePrivacyDlpV2beta2Condition include Google::Apis::Core::Hashable # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :field # Operator used to compare the field or infoType to the value. [required] # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `value` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) @operator = args[:operator] if args.key?(:operator) @value = args[:value] if args.key?(:value) end end # A collection of conditions. class GooglePrivacyDlpV2beta2Conditions include Google::Apis::Core::Hashable # # Corresponds to the JSON property `conditions` # @return [Array] attr_accessor :conditions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @conditions = args[:conditions] if args.key?(:conditions) end end # Container structure for the content to inspect. class GooglePrivacyDlpV2beta2ContentItem include Google::Apis::Core::Hashable # Content data to inspect or redact. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data # Structured content to inspect. Up to 50,000 `Value`s per request allowed. # Corresponds to the JSON property `table` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Table] attr_accessor :table # Type of the content, as defined in Content-Type HTTP header. # Supported types are: all "text" types, octet streams, PNG images, # JPEG images. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # String data to inspect or redact. # 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) @data = args[:data] if args.key?(:data) @table = args[:table] if args.key?(:table) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end # Request message for CreateDeidentifyTemplate. class GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest include Google::Apis::Core::Hashable # The DeidentifyTemplates contains instructions on how to deidentify content. # Corresponds to the JSON property `deidentifyTemplate` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] attr_accessor :deidentify_template # The template id can contain uppercase and lowercase letters, # numbers, and hyphens; that is, it must match the regular # expression: `[a-zA-Z\\d-]+`. The maximum length is 100 # characters. Can be empty to allow the system to generate one. # Corresponds to the JSON property `templateId` # @return [String] attr_accessor :template_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deidentify_template = args[:deidentify_template] if args.key?(:deidentify_template) @template_id = args[:template_id] if args.key?(:template_id) end end # Request message for CreateInspectTemplate. class GooglePrivacyDlpV2beta2CreateInspectTemplateRequest include Google::Apis::Core::Hashable # The inspectTemplate contains a configuration (set of types of sensitive data # to be detected) to be used anywhere you otherwise would normally specify # InspectConfig. # Corresponds to the JSON property `inspectTemplate` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] attr_accessor :inspect_template # The template id can contain uppercase and lowercase letters, # numbers, and hyphens; that is, it must match the regular # expression: `[a-zA-Z\\d-]+`. The maximum length is 100 # characters. Can be empty to allow the system to generate one. # Corresponds to the JSON property `templateId` # @return [String] attr_accessor :template_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @inspect_template = args[:inspect_template] if args.key?(:inspect_template) @template_id = args[:template_id] if args.key?(:template_id) end end # Request message for CreateJobTrigger. class GooglePrivacyDlpV2beta2CreateJobTriggerRequest include Google::Apis::Core::Hashable # Contains a configuration to make dlp api calls on a repeating basis. # Corresponds to the JSON property `jobTrigger` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger] attr_accessor :job_trigger # The trigger id can contain uppercase and lowercase letters, # numbers, and hyphens; that is, it must match the regular # expression: `[a-zA-Z\\d-]+`. The maximum length is 100 # characters. Can be empty to allow the system to generate one. # Corresponds to the JSON property `triggerId` # @return [String] attr_accessor :trigger_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @job_trigger = args[:job_trigger] if args.key?(:job_trigger) @trigger_id = args[:trigger_id] if args.key?(:trigger_id) end end # Pseudonymization method that generates surrogates via cryptographic hashing. # Uses SHA-256. # The key size must be either 32 or 64 bytes. # Outputs a 32 byte digest as an uppercase hex string # (for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE). # Currently, only string and integer values can be hashed. class GooglePrivacyDlpV2beta2CryptoHashConfig include Google::Apis::Core::Hashable # This is a data encryption key (DEK) (as opposed to # a key encryption key (KEK) stored by KMS). # When using KMS to wrap/unwrap DEKs, be sure to set an appropriate # IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot # unwrap the data crypto key. # Corresponds to the JSON property `cryptoKey` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoKey] attr_accessor :crypto_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @crypto_key = args[:crypto_key] if args.key?(:crypto_key) end end # This is a data encryption key (DEK) (as opposed to # a key encryption key (KEK) stored by KMS). # When using KMS to wrap/unwrap DEKs, be sure to set an appropriate # IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot # unwrap the data crypto key. class GooglePrivacyDlpV2beta2CryptoKey include Google::Apis::Core::Hashable # Include to use an existing data crypto key wrapped by KMS. # Authorization requires the following IAM permissions when sending a request # to perform a crypto transformation using a kms-wrapped crypto key: # dlp.kms.encrypt # Corresponds to the JSON property `kmsWrapped` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KmsWrappedCryptoKey] attr_accessor :kms_wrapped # Use this to have a random data crypto key generated. # It will be discarded after the request finishes. # Corresponds to the JSON property `transient` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransientCryptoKey] attr_accessor :transient # Using raw keys is prone to security risks due to accidentally # leaking the key. Choose another type of key if possible. # Corresponds to the JSON property `unwrapped` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UnwrappedCryptoKey] attr_accessor :unwrapped def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kms_wrapped = args[:kms_wrapped] if args.key?(:kms_wrapped) @transient = args[:transient] if args.key?(:transient) @unwrapped = args[:unwrapped] if args.key?(:unwrapped) end end # Replaces an identifier with a surrogate using FPE with the FFX # mode of operation; however when used in the `ReidentifyContent` API method, # it serves the opposite function by reversing the surrogate back into # the original identifier. # The identifier must be encoded as ASCII. # For a given crypto key and context, the same identifier will be # replaced with the same surrogate. # Identifiers must be at least two characters long. # In the case that the identifier is the empty string, it will be skipped. class GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig include Google::Apis::Core::Hashable # # Corresponds to the JSON property `commonAlphabet` # @return [String] attr_accessor :common_alphabet # General identifier of a data field in a storage service. # Corresponds to the JSON property `context` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :context # This is a data encryption key (DEK) (as opposed to # a key encryption key (KEK) stored by KMS). # When using KMS to wrap/unwrap DEKs, be sure to set an appropriate # IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot # unwrap the data crypto key. # Corresponds to the JSON property `cryptoKey` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoKey] attr_accessor :crypto_key # This is supported by mapping these to the alphanumeric characters # that the FFX mode natively supports. This happens before/after # encryption/decryption. # Each character listed must appear only once. # Number of characters must be in the range [2, 62]. # This must be encoded as ASCII. # The order of characters does not matter. # Corresponds to the JSON property `customAlphabet` # @return [String] attr_accessor :custom_alphabet # The native way to select the alphabet. Must be in the range [2, 62]. # Corresponds to the JSON property `radix` # @return [Fixnum] attr_accessor :radix # Type of information detected by the API. # Corresponds to the JSON property `surrogateInfoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType] attr_accessor :surrogate_info_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common_alphabet = args[:common_alphabet] if args.key?(:common_alphabet) @context = args[:context] if args.key?(:context) @crypto_key = args[:crypto_key] if args.key?(:crypto_key) @custom_alphabet = args[:custom_alphabet] if args.key?(:custom_alphabet) @radix = args[:radix] if args.key?(:radix) @surrogate_info_type = args[:surrogate_info_type] if args.key?(:surrogate_info_type) end end # Custom information type provided by the user. Used to find domain-specific # sensitive information configurable to the data in question. class GooglePrivacyDlpV2beta2CustomInfoType include Google::Apis::Core::Hashable # Set of detection rules to apply to all findings of this custom info type. # Rules are applied in order that they are specified. Not supported for the # `surrogate_type` custom info type. # Corresponds to the JSON property `detectionRules` # @return [Array] attr_accessor :detection_rules # Custom information type based on a dictionary of words or phrases. This can # be used to match sensitive information specific to the data, such as a list # of employee IDs or job titles. # Dictionary words are case-insensitive and all characters other than letters # and digits in the unicode [Basic Multilingual # Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29# # Basic_Multilingual_Plane) # will be replaced with whitespace when scanning for matches, so the # dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", # "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters # surrounding any match must be of a different type than the adjacent # characters within the word, so letters must be next to non-letters and # digits next to non-digits. For example, the dictionary word "jen" will # match the first three letters of the text "jen123" but will return no # matches for "jennifer". # Dictionary words containing a large number of characters that are not # letters or digits may result in unexpected findings because such characters # are treated as whitespace. # Corresponds to the JSON property `dictionary` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Dictionary] attr_accessor :dictionary # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType] attr_accessor :info_type # Likelihood to return for this custom info type. This base value can be # altered by a detection rule if the finding meets the criteria specified by # the rule. Defaults to `VERY_LIKELY` if not specified. # Corresponds to the JSON property `likelihood` # @return [String] attr_accessor :likelihood # Message defining a custom regular expression. # Corresponds to the JSON property `regex` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Regex] attr_accessor :regex # Message for detecting output from deidentification transformations # such as # [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/ # deidentify#CryptoReplaceFfxFpeConfig). # These types of transformations are # those that perform pseudonymization, thereby producing a "surrogate" as # output. This should be used in conjunction with a field on the # transformation such as `surrogate_info_type`. This custom info type does # not support the use of `detection_rules`. # Corresponds to the JSON property `surrogateType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2SurrogateType] attr_accessor :surrogate_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @detection_rules = args[:detection_rules] if args.key?(:detection_rules) @dictionary = args[:dictionary] if args.key?(:dictionary) @info_type = args[:info_type] if args.key?(:info_type) @likelihood = args[:likelihood] if args.key?(:likelihood) @regex = args[:regex] if args.key?(:regex) @surrogate_type = args[:surrogate_type] if args.key?(:surrogate_type) end end # Record key for a finding in Cloud Datastore. class GooglePrivacyDlpV2beta2DatastoreKey include Google::Apis::Core::Hashable # A unique identifier for a Datastore entity. # If a key's partition ID or any of its path kinds or names are # reserved/read-only, the key is reserved/read-only. # A reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `entityKey` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Key] attr_accessor :entity_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_key = args[:entity_key] if args.key?(:entity_key) end end # Options defining a data set within Google Cloud Datastore. class GooglePrivacyDlpV2beta2DatastoreOptions include Google::Apis::Core::Hashable # A representation of a Datastore kind. # Corresponds to the JSON property `kind` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KindExpression] attr_accessor :kind # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always # by project and namespace, however the namespace ID may be empty. # A partition ID contains several dimensions: # project ID and namespace ID. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PartitionId] attr_accessor :partition_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @partition_id = args[:partition_id] if args.key?(:partition_id) end end # The configuration that controls how the data will change. class GooglePrivacyDlpV2beta2DeidentifyConfig include Google::Apis::Core::Hashable # A type of transformation that will scan unstructured text and # apply various `PrimitiveTransformation`s to each finding, where the # transformation is applied to only values that were identified as a specific # info_type. # Corresponds to the JSON property `infoTypeTransformations` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeTransformations] attr_accessor :info_type_transformations # A type of transformation that is applied over structured data such as a # table. # Corresponds to the JSON property `recordTransformations` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordTransformations] attr_accessor :record_transformations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @info_type_transformations = args[:info_type_transformations] if args.key?(:info_type_transformations) @record_transformations = args[:record_transformations] if args.key?(:record_transformations) end end # Request to de-identify a list of items. class GooglePrivacyDlpV2beta2DeidentifyContentRequest include Google::Apis::Core::Hashable # The configuration that controls how the data will change. # Corresponds to the JSON property `deidentifyConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyConfig] attr_accessor :deidentify_config # Optional template to use. Any configuration directly specified in # deidentify_config will override those set in the template. Singular fields # that are set in this request will replace their corresponding fields in the # template. Repeated fields are appended. Singular sub-messages and groups # are recursively merged. # Corresponds to the JSON property `deidentifyTemplateName` # @return [String] attr_accessor :deidentify_template_name # Configuration description of the scanning process. # When used with redactContent only info_types and min_likelihood are currently # used. # Corresponds to the JSON property `inspectConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig] attr_accessor :inspect_config # Optional template to use. Any configuration directly specified in # inspect_config will override those set in the template. Singular fields # that are set in this request will replace their corresponding fields in the # template. Repeated fields are appended. Singular sub-messages and groups # are recursively merged. # Corresponds to the JSON property `inspectTemplateName` # @return [String] attr_accessor :inspect_template_name # Container structure for the content to inspect. # Corresponds to the JSON property `item` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem] attr_accessor :item def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deidentify_config = args[:deidentify_config] if args.key?(:deidentify_config) @deidentify_template_name = args[:deidentify_template_name] if args.key?(:deidentify_template_name) @inspect_config = args[:inspect_config] if args.key?(:inspect_config) @inspect_template_name = args[:inspect_template_name] if args.key?(:inspect_template_name) @item = args[:item] if args.key?(:item) end end # Results of de-identifying a ContentItem. class GooglePrivacyDlpV2beta2DeidentifyContentResponse include Google::Apis::Core::Hashable # Container structure for the content to inspect. # Corresponds to the JSON property `item` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem] attr_accessor :item # Overview of the modifications that occurred. # Corresponds to the JSON property `overview` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransformationOverview] attr_accessor :overview def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @item = args[:item] if args.key?(:item) @overview = args[:overview] if args.key?(:overview) end end # The DeidentifyTemplates contains instructions on how to deidentify content. class GooglePrivacyDlpV2beta2DeidentifyTemplate include Google::Apis::Core::Hashable # The creation timestamp of a inspectTemplate, output only field. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The configuration that controls how the data will change. # Corresponds to the JSON property `deidentifyConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyConfig] attr_accessor :deidentify_config # Short description (max 256 chars). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Display name (max 256 chars). # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The template name. Output only. # The template will have one of the following formats: # `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR # `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The last update timestamp of a inspectTemplate, output only field. # 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) @deidentify_config = args[:deidentify_config] if args.key?(:deidentify_config) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @name = args[:name] if args.key?(:name) @update_time = args[:update_time] if args.key?(:update_time) end end # Rule for modifying a custom info type to alter behavior under certain # circumstances, depending on the specific details of the rule. Not supported # for the `surrogate_type` custom info type. class GooglePrivacyDlpV2beta2DetectionRule include Google::Apis::Core::Hashable # Detection rule that adjusts the likelihood of findings within a certain # proximity of hotwords. # Corresponds to the JSON property `hotwordRule` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2HotwordRule] attr_accessor :hotword_rule def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @hotword_rule = args[:hotword_rule] if args.key?(:hotword_rule) end end # Custom information type based on a dictionary of words or phrases. This can # be used to match sensitive information specific to the data, such as a list # of employee IDs or job titles. # Dictionary words are case-insensitive and all characters other than letters # and digits in the unicode [Basic Multilingual # Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29# # Basic_Multilingual_Plane) # will be replaced with whitespace when scanning for matches, so the # dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", # "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters # surrounding any match must be of a different type than the adjacent # characters within the word, so letters must be next to non-letters and # digits next to non-digits. For example, the dictionary word "jen" will # match the first three letters of the text "jen123" but will return no # matches for "jennifer". # Dictionary words containing a large number of characters that are not # letters or digits may result in unexpected findings because such characters # are treated as whitespace. class GooglePrivacyDlpV2beta2Dictionary include Google::Apis::Core::Hashable # Message defining a list of words or phrases to search for in the data. # Corresponds to the JSON property `wordList` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2WordList] attr_accessor :word_list def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @word_list = args[:word_list] if args.key?(:word_list) end end # Combines all of the information about a DLP job. class GooglePrivacyDlpV2beta2DlpJob include Google::Apis::Core::Hashable # Time when the job was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Time when the job finished. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # A stream of errors encountered running the job. # Corresponds to the JSON property `errorResults` # @return [Array] attr_accessor :error_results # The results of an inspect DataSource job. # Corresponds to the JSON property `inspectDetails` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectDataSourceDetails] attr_accessor :inspect_details # If created by a job trigger, the resource name of the trigger that # instantiated the job. # Corresponds to the JSON property `jobTriggerName` # @return [String] attr_accessor :job_trigger_name # The server-assigned name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Result of a risk analysis operation request. # Corresponds to the JSON property `riskDetails` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails] attr_accessor :risk_details # Time when the job started. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # State of a job. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # The type of job. # 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) @end_time = args[:end_time] if args.key?(:end_time) @error_results = args[:error_results] if args.key?(:error_results) @inspect_details = args[:inspect_details] if args.key?(:inspect_details) @job_trigger_name = args[:job_trigger_name] if args.key?(:job_trigger_name) @name = args[:name] if args.key?(:name) @risk_details = args[:risk_details] if args.key?(:risk_details) @start_time = args[:start_time] if args.key?(:start_time) @state = args[:state] if args.key?(:state) @type = args[:type] if args.key?(:type) end end # An entity in a dataset is a field or set of fields that correspond to a # single person. For example, in medical records the `EntityId` might be # a patient identifier, or for financial records it might be an account # identifier. This message is used when generalizations or analysis must be # consistent across multiple rows pertaining to the same entity. class GooglePrivacyDlpV2beta2EntityId include Google::Apis::Core::Hashable # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :field def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) end end # The results of an unsuccessful activation of the JobTrigger. class GooglePrivacyDlpV2beta2Error 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `details` # @return [Google::Apis::DlpV2beta2::GoogleRpcStatus] attr_accessor :details # The times the error occurred. # Corresponds to the JSON property `timestamps` # @return [Array] attr_accessor :timestamps def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @details = args[:details] if args.key?(:details) @timestamps = args[:timestamps] if args.key?(:timestamps) end end # An expression, consisting or an operator and conditions. class GooglePrivacyDlpV2beta2Expressions include Google::Apis::Core::Hashable # A collection of conditions. # Corresponds to the JSON property `conditions` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Conditions] attr_accessor :conditions # The operator to apply to the result of conditions. Default and currently # only supported value is `AND`. # Corresponds to the JSON property `logicalOperator` # @return [String] attr_accessor :logical_operator def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @conditions = args[:conditions] if args.key?(:conditions) @logical_operator = args[:logical_operator] if args.key?(:logical_operator) end end # General identifier of a data field in a storage service. class GooglePrivacyDlpV2beta2FieldId include Google::Apis::Core::Hashable # Name describing the field. # 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 # The transformation to apply to the field. class GooglePrivacyDlpV2beta2FieldTransformation include Google::Apis::Core::Hashable # A condition for determining whether a transformation should be applied to # a field. # Corresponds to the JSON property `condition` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordCondition] attr_accessor :condition # Input field(s) to apply the transformation to. [required] # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields # A type of transformation that will scan unstructured text and # apply various `PrimitiveTransformation`s to each finding, where the # transformation is applied to only values that were identified as a specific # info_type. # Corresponds to the JSON property `infoTypeTransformations` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoTypeTransformations] attr_accessor :info_type_transformations # A rule for transforming a value. # Corresponds to the JSON property `primitiveTransformation` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrimitiveTransformation] attr_accessor :primitive_transformation def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @condition = args[:condition] if args.key?(:condition) @fields = args[:fields] if args.key?(:fields) @info_type_transformations = args[:info_type_transformations] if args.key?(:info_type_transformations) @primitive_transformation = args[:primitive_transformation] if args.key?(:primitive_transformation) end end # Set of files to scan. class GooglePrivacyDlpV2beta2FileSet include Google::Apis::Core::Hashable # The url, in the format `gs:///`. Trailing wildcard in the # path is allowed. # 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 # Represents a piece of potentially sensitive content. class GooglePrivacyDlpV2beta2Finding include Google::Apis::Core::Hashable # Timestamp when finding was detected. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType] attr_accessor :info_type # Estimate of how likely it is that the `info_type` is correct. # Corresponds to the JSON property `likelihood` # @return [String] attr_accessor :likelihood # Specifies the location of the finding. # Corresponds to the JSON property `location` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Location] attr_accessor :location # The content that was found. Even if the content is not textual, it # may be converted to a textual representation here. # Provided if requested by the `InspectConfig` and the finding is # less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes # in length, the quote may be omitted. # Corresponds to the JSON property `quote` # @return [String] attr_accessor :quote def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @info_type = args[:info_type] if args.key?(:info_type) @likelihood = args[:likelihood] if args.key?(:likelihood) @location = args[:location] if args.key?(:location) @quote = args[:quote] if args.key?(:quote) end end # class GooglePrivacyDlpV2beta2FindingLimits include Google::Apis::Core::Hashable # Configuration of findings limit given for specified infoTypes. # Corresponds to the JSON property `maxFindingsPerInfoType` # @return [Array] attr_accessor :max_findings_per_info_type # Max number of findings that will be returned for each item scanned. # Corresponds to the JSON property `maxFindingsPerItem` # @return [Fixnum] attr_accessor :max_findings_per_item # Max total number of findings that will be returned per request/job. # Corresponds to the JSON property `maxFindingsPerRequest` # @return [Fixnum] attr_accessor :max_findings_per_request def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_findings_per_info_type = args[:max_findings_per_info_type] if args.key?(:max_findings_per_info_type) @max_findings_per_item = args[:max_findings_per_item] if args.key?(:max_findings_per_item) @max_findings_per_request = args[:max_findings_per_request] if args.key?(:max_findings_per_request) end end # Buckets values based on fixed size ranges. The # Bucketing transformation can provide all of this functionality, # but requires more configuration. This message is provided as a convenience to # the user for simple bucketing strategies. # The transformed value will be a hyphenated string of # -, i.e if lower_bound = 10 and upper_bound = 20 # all values that are within this bucket will be replaced with "10-20". # This can be used on data of type: double, long. # If the bound Value type differs from the type of data # being transformed, we will first attempt converting the type of the data to # be transformed to match the type of the bound before comparing. class GooglePrivacyDlpV2beta2FixedSizeBucketingConfig include Google::Apis::Core::Hashable # Size of each bucket (except for minimum and maximum buckets). So if # `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the # following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, # 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required]. # Corresponds to the JSON property `bucketSize` # @return [Float] attr_accessor :bucket_size # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `lowerBound` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value] attr_accessor :lower_bound # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `upperBound` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value] attr_accessor :upper_bound def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_size = args[:bucket_size] if args.key?(:bucket_size) @lower_bound = args[:lower_bound] if args.key?(:lower_bound) @upper_bound = args[:upper_bound] if args.key?(:upper_bound) end end # Detection rule that adjusts the likelihood of findings within a certain # proximity of hotwords. class GooglePrivacyDlpV2beta2HotwordRule include Google::Apis::Core::Hashable # Message defining a custom regular expression. # Corresponds to the JSON property `hotwordRegex` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Regex] attr_accessor :hotword_regex # Message for specifying an adjustment to the likelihood of a finding as # part of a detection rule. # Corresponds to the JSON property `likelihoodAdjustment` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LikelihoodAdjustment] attr_accessor :likelihood_adjustment # Message for specifying a window around a finding to apply a detection # rule. # Corresponds to the JSON property `proximity` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Proximity] attr_accessor :proximity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @hotword_regex = args[:hotword_regex] if args.key?(:hotword_regex) @likelihood_adjustment = args[:likelihood_adjustment] if args.key?(:likelihood_adjustment) @proximity = args[:proximity] if args.key?(:proximity) end end # Bounding box encompassing detected text within an image. class GooglePrivacyDlpV2beta2ImageLocation include Google::Apis::Core::Hashable # Height of the bounding box in pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Left coordinate of the bounding box. (0,0) is upper left. # Corresponds to the JSON property `left` # @return [Fixnum] attr_accessor :left # Top coordinate of the bounding box. (0,0) is upper left. # Corresponds to the JSON property `top` # @return [Fixnum] attr_accessor :top # Width of the bounding box in pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @left = args[:left] if args.key?(:left) @top = args[:top] if args.key?(:top) @width = args[:width] if args.key?(:width) end end # Configuration for determining how redaction of images should occur. class GooglePrivacyDlpV2beta2ImageRedactionConfig include Google::Apis::Core::Hashable # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType] attr_accessor :info_type # If true, all text found in the image, regardless whether it matches an # info_type, is redacted. # Corresponds to the JSON property `redactAllText` # @return [Boolean] attr_accessor :redact_all_text alias_method :redact_all_text?, :redact_all_text # Represents a color in the RGB color space. # Corresponds to the JSON property `redactionColor` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Color] attr_accessor :redaction_color def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @info_type = args[:info_type] if args.key?(:info_type) @redact_all_text = args[:redact_all_text] if args.key?(:redact_all_text) @redaction_color = args[:redaction_color] if args.key?(:redaction_color) end end # Type of information detected by the API. class GooglePrivacyDlpV2beta2InfoType include Google::Apis::Core::Hashable # Name of the information type. # 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 # InfoType description. class GooglePrivacyDlpV2beta2InfoTypeDescription include Google::Apis::Core::Hashable # Human readable form of the infoType name. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Internal name of the infoType. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Which parts of the API supports this InfoType. # Corresponds to the JSON property `supportedBy` # @return [Array] attr_accessor :supported_by def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @name = args[:name] if args.key?(:name) @supported_by = args[:supported_by] if args.key?(:supported_by) end end # Max findings configuration per infoType, per content item or long # running DlpJob. class GooglePrivacyDlpV2beta2InfoTypeLimit include Google::Apis::Core::Hashable # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType] attr_accessor :info_type # Max findings limit for the given infoType. # Corresponds to the JSON property `maxFindings` # @return [Fixnum] attr_accessor :max_findings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @info_type = args[:info_type] if args.key?(:info_type) @max_findings = args[:max_findings] if args.key?(:max_findings) end end # Statistics regarding a specific InfoType. class GooglePrivacyDlpV2beta2InfoTypeStatistics include Google::Apis::Core::Hashable # Number of findings for this infoType. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType] attr_accessor :info_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @count = args[:count] if args.key?(:count) @info_type = args[:info_type] if args.key?(:info_type) end end # A transformation to apply to text that is identified as a specific # info_type. class GooglePrivacyDlpV2beta2InfoTypeTransformation include Google::Apis::Core::Hashable # InfoTypes to apply the transformation to. Empty list will match all # available infoTypes for this transformation. # Corresponds to the JSON property `infoTypes` # @return [Array] attr_accessor :info_types # A rule for transforming a value. # Corresponds to the JSON property `primitiveTransformation` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrimitiveTransformation] attr_accessor :primitive_transformation def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @info_types = args[:info_types] if args.key?(:info_types) @primitive_transformation = args[:primitive_transformation] if args.key?(:primitive_transformation) end end # A type of transformation that will scan unstructured text and # apply various `PrimitiveTransformation`s to each finding, where the # transformation is applied to only values that were identified as a specific # info_type. class GooglePrivacyDlpV2beta2InfoTypeTransformations include Google::Apis::Core::Hashable # Transformation for each infoType. Cannot specify more than one # for a given infoType. [required] # Corresponds to the JSON property `transformations` # @return [Array] attr_accessor :transformations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @transformations = args[:transformations] if args.key?(:transformations) end end # Configuration description of the scanning process. # When used with redactContent only info_types and min_likelihood are currently # used. class GooglePrivacyDlpV2beta2InspectConfig include Google::Apis::Core::Hashable # Custom infoTypes provided by the user. # Corresponds to the JSON property `customInfoTypes` # @return [Array] attr_accessor :custom_info_types # When true, excludes type information of the findings. # Corresponds to the JSON property `excludeInfoTypes` # @return [Boolean] attr_accessor :exclude_info_types alias_method :exclude_info_types?, :exclude_info_types # When true, a contextual quote from the data that triggered a finding is # included in the response; see Finding.quote. # Corresponds to the JSON property `includeQuote` # @return [Boolean] attr_accessor :include_quote alias_method :include_quote?, :include_quote # Restricts what info_types to look for. The values must correspond to # InfoType values returned by ListInfoTypes or found in documentation. # Empty info_types runs all enabled detectors. # Corresponds to the JSON property `infoTypes` # @return [Array] attr_accessor :info_types # # Corresponds to the JSON property `limits` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FindingLimits] attr_accessor :limits # Only returns findings equal or above this threshold. The default is # POSSIBLE. # Corresponds to the JSON property `minLikelihood` # @return [String] attr_accessor :min_likelihood def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_info_types = args[:custom_info_types] if args.key?(:custom_info_types) @exclude_info_types = args[:exclude_info_types] if args.key?(:exclude_info_types) @include_quote = args[:include_quote] if args.key?(:include_quote) @info_types = args[:info_types] if args.key?(:info_types) @limits = args[:limits] if args.key?(:limits) @min_likelihood = args[:min_likelihood] if args.key?(:min_likelihood) end end # Request to search for potentially sensitive info in a ContentItem. class GooglePrivacyDlpV2beta2InspectContentRequest include Google::Apis::Core::Hashable # Configuration description of the scanning process. # When used with redactContent only info_types and min_likelihood are currently # used. # Corresponds to the JSON property `inspectConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig] attr_accessor :inspect_config # Optional template to use. Any configuration directly specified in # inspect_config will override those set in the template. Singular fields # that are set in this request will replace their corresponding fields in the # template. Repeated fields are appended. Singular sub-messages and groups # are recursively merged. # Corresponds to the JSON property `inspectTemplateName` # @return [String] attr_accessor :inspect_template_name # Container structure for the content to inspect. # Corresponds to the JSON property `item` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem] attr_accessor :item def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @inspect_config = args[:inspect_config] if args.key?(:inspect_config) @inspect_template_name = args[:inspect_template_name] if args.key?(:inspect_template_name) @item = args[:item] if args.key?(:item) end end # Results of inspecting an item. class GooglePrivacyDlpV2beta2InspectContentResponse include Google::Apis::Core::Hashable # All the findings for a single scanned item. # Corresponds to the JSON property `result` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectResult] 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 # The results of an inspect DataSource job. class GooglePrivacyDlpV2beta2InspectDataSourceDetails include Google::Apis::Core::Hashable # The configuration used for this job. # Corresponds to the JSON property `requestedOptions` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RequestedOptions] attr_accessor :requested_options # A summary of the outcome of this inspect job. # Corresponds to the JSON property `result` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Result] attr_accessor :result def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @requested_options = args[:requested_options] if args.key?(:requested_options) @result = args[:result] if args.key?(:result) end end # Request for scheduling a scan of a data subset from a Google Platform data # repository. class GooglePrivacyDlpV2beta2InspectDataSourceRequest include Google::Apis::Core::Hashable # A configuration for the job. # Corresponds to the JSON property `jobConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectJobConfig] attr_accessor :job_config # Optional job ID to use for the created job. If not provided, a job ID will # automatically be generated. Must be unique within the project. The job ID # can contain uppercase and lowercase letters, numbers, and hyphens; that is, # it must match the regular expression: `[a-zA-Z\\d-]+`. The maximum length # is 100 characters. Can be empty to allow the system to generate one. # Corresponds to the JSON property `jobId` # @return [String] attr_accessor :job_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @job_config = args[:job_config] if args.key?(:job_config) @job_id = args[:job_id] if args.key?(:job_id) end end # class GooglePrivacyDlpV2beta2InspectJobConfig include Google::Apis::Core::Hashable # Actions to execute at the completion of the job. Are executed in the order # provided. # Corresponds to the JSON property `actions` # @return [Array] attr_accessor :actions # Configuration description of the scanning process. # When used with redactContent only info_types and min_likelihood are currently # used. # Corresponds to the JSON property `inspectConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig] attr_accessor :inspect_config # If provided, will be used as the default for all values in InspectConfig. # `inspect_config` will be merged into the values persisted as part of the # template. # Corresponds to the JSON property `inspectTemplateName` # @return [String] attr_accessor :inspect_template_name # Cloud repository for storing output. # Corresponds to the JSON property `outputConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2OutputStorageConfig] attr_accessor :output_config # Shared message indicating Cloud storage type. # Corresponds to the JSON property `storageConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2StorageConfig] attr_accessor :storage_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @actions = args[:actions] if args.key?(:actions) @inspect_config = args[:inspect_config] if args.key?(:inspect_config) @inspect_template_name = args[:inspect_template_name] if args.key?(:inspect_template_name) @output_config = args[:output_config] if args.key?(:output_config) @storage_config = args[:storage_config] if args.key?(:storage_config) end end # All the findings for a single scanned item. class GooglePrivacyDlpV2beta2InspectResult include Google::Apis::Core::Hashable # List of findings for an item. # Corresponds to the JSON property `findings` # @return [Array] attr_accessor :findings # If true, then this item might have more findings than were returned, # and the findings returned are an arbitrary subset of all findings. # The findings list might be truncated because the input items were too # large, or because the server reached the maximum amount of resources # allowed for a single API call. For best results, divide the input into # smaller batches. # Corresponds to the JSON property `findingsTruncated` # @return [Boolean] attr_accessor :findings_truncated alias_method :findings_truncated?, :findings_truncated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @findings = args[:findings] if args.key?(:findings) @findings_truncated = args[:findings_truncated] if args.key?(:findings_truncated) end end # The inspectTemplate contains a configuration (set of types of sensitive data # to be detected) to be used anywhere you otherwise would normally specify # InspectConfig. class GooglePrivacyDlpV2beta2InspectTemplate include Google::Apis::Core::Hashable # The creation timestamp of a inspectTemplate, output only field. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Short description (max 256 chars). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Display name (max 256 chars). # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Configuration description of the scanning process. # When used with redactContent only info_types and min_likelihood are currently # used. # Corresponds to the JSON property `inspectConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig] attr_accessor :inspect_config # The template name. Output only. # The template will have one of the following formats: # `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR # `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The last update timestamp of a inspectTemplate, output only field. # 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) @inspect_config = args[:inspect_config] if args.key?(:inspect_config) @name = args[:name] if args.key?(:name) @update_time = args[:update_time] if args.key?(:update_time) end end # Contains a configuration to make dlp api calls on a repeating basis. class GooglePrivacyDlpV2beta2JobTrigger include Google::Apis::Core::Hashable # The creation timestamp of a triggeredJob, output only field. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # User provided description (max 256 chars) # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Display name (max 100 chars) # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # A stream of errors encountered when the trigger was activated. Repeated # errors may result in the JobTrigger automaticaly being paused. # Will return the last 100 errors. Whenever the JobTrigger is modified # this list will be cleared. Output only field. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # # Corresponds to the JSON property `inspectJob` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectJobConfig] attr_accessor :inspect_job # The timestamp of the last time this trigger executed. # Corresponds to the JSON property `lastRunTime` # @return [String] attr_accessor :last_run_time # Unique resource name for the triggeredJob, assigned by the service when the # triggeredJob is created, for example # `projects/dlp-test-project/triggeredJobs/53234423`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A status for this trigger. [required] # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # A list of triggers which will be OR'ed together. Only one in the list # needs to trigger for a job to be started. The list may contain only # a single Schedule trigger and must have at least one object. # Corresponds to the JSON property `triggers` # @return [Array] attr_accessor :triggers # The last update timestamp of a triggeredJob, output only field. # 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) @errors = args[:errors] if args.key?(:errors) @inspect_job = args[:inspect_job] if args.key?(:inspect_job) @last_run_time = args[:last_run_time] if args.key?(:last_run_time) @name = args[:name] if args.key?(:name) @status = args[:status] if args.key?(:status) @triggers = args[:triggers] if args.key?(:triggers) @update_time = args[:update_time] if args.key?(:update_time) end end # k-anonymity metric, used for analysis of reidentification risk. class GooglePrivacyDlpV2beta2KAnonymityConfig include Google::Apis::Core::Hashable # An entity in a dataset is a field or set of fields that correspond to a # single person. For example, in medical records the `EntityId` might be # a patient identifier, or for financial records it might be an account # identifier. This message is used when generalizations or analysis must be # consistent across multiple rows pertaining to the same entity. # Corresponds to the JSON property `entityId` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2EntityId] attr_accessor :entity_id # Set of fields to compute k-anonymity over. When multiple fields are # specified, they are considered a single composite key. Structs and # repeated data types are not supported; however, nested fields are # supported so long as they are not structs themselves or nested within # a repeated field. # Corresponds to the JSON property `quasiIds` # @return [Array] attr_accessor :quasi_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_id = args[:entity_id] if args.key?(:entity_id) @quasi_ids = args[:quasi_ids] if args.key?(:quasi_ids) end end # The set of columns' values that share the same ldiversity value class GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass include Google::Apis::Core::Hashable # Size of the equivalence class, for example number of rows with the # above set of values. # Corresponds to the JSON property `equivalenceClassSize` # @return [Fixnum] attr_accessor :equivalence_class_size # Set of values defining the equivalence class. One value per # quasi-identifier column in the original KAnonymity metric message. # The order is always the same as the original request. # Corresponds to the JSON property `quasiIdsValues` # @return [Array] attr_accessor :quasi_ids_values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @equivalence_class_size = args[:equivalence_class_size] if args.key?(:equivalence_class_size) @quasi_ids_values = args[:quasi_ids_values] if args.key?(:quasi_ids_values) end end # class GooglePrivacyDlpV2beta2KAnonymityHistogramBucket include Google::Apis::Core::Hashable # Total number of equivalence classes in this bucket. # Corresponds to the JSON property `bucketSize` # @return [Fixnum] attr_accessor :bucket_size # Sample of equivalence classes in this bucket. The total number of # classes returned per bucket is capped at 20. # Corresponds to the JSON property `bucketValues` # @return [Array] attr_accessor :bucket_values # Lower bound on the size of the equivalence classes in this bucket. # Corresponds to the JSON property `equivalenceClassSizeLowerBound` # @return [Fixnum] attr_accessor :equivalence_class_size_lower_bound # Upper bound on the size of the equivalence classes in this bucket. # Corresponds to the JSON property `equivalenceClassSizeUpperBound` # @return [Fixnum] attr_accessor :equivalence_class_size_upper_bound def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_size = args[:bucket_size] if args.key?(:bucket_size) @bucket_values = args[:bucket_values] if args.key?(:bucket_values) @equivalence_class_size_lower_bound = args[:equivalence_class_size_lower_bound] if args.key?(:equivalence_class_size_lower_bound) @equivalence_class_size_upper_bound = args[:equivalence_class_size_upper_bound] if args.key?(:equivalence_class_size_upper_bound) end end # Result of the k-anonymity computation. class GooglePrivacyDlpV2beta2KAnonymityResult include Google::Apis::Core::Hashable # Histogram of k-anonymity equivalence classes. # Corresponds to the JSON property `equivalenceClassHistogramBuckets` # @return [Array] attr_accessor :equivalence_class_histogram_buckets def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @equivalence_class_histogram_buckets = args[:equivalence_class_histogram_buckets] if args.key?(:equivalence_class_histogram_buckets) end end # Reidentifiability metric. This corresponds to a risk model similar to what # is called "journalist risk" in the literature, except the attack dataset is # statistically modeled instead of being perfectly known. This can be done # using publicly available data (like the US Census), or using a custom # statistical model (indicated as one or several BigQuery tables), or by # extrapolating from the distribution of values in the input dataset. class GooglePrivacyDlpV2beta2KMapEstimationConfig include Google::Apis::Core::Hashable # Several auxiliary tables can be used in the analysis. Each custom_tag # used to tag a quasi-identifiers column must appear in exactly one column # of one auxiliary table. # Corresponds to the JSON property `auxiliaryTables` # @return [Array] attr_accessor :auxiliary_tables # Fields considered to be quasi-identifiers. No two columns can have the # same tag. [required] # Corresponds to the JSON property `quasiIds` # @return [Array] attr_accessor :quasi_ids # ISO 3166-1 alpha-2 region code to use in the statistical modeling. # Required if no column is tagged with a region-specific InfoType (like # US_ZIP_5) or a region code. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auxiliary_tables = args[:auxiliary_tables] if args.key?(:auxiliary_tables) @quasi_ids = args[:quasi_ids] if args.key?(:quasi_ids) @region_code = args[:region_code] if args.key?(:region_code) end end # A KMapEstimationHistogramBucket message with the following values: # min_anonymity: 3 # max_anonymity: 5 # frequency: 42 # means that there are 42 records whose quasi-identifier values correspond # to 3, 4 or 5 people in the overlying population. An important particular # case is when min_anonymity = max_anonymity = 1: the frequency field then # corresponds to the number of uniquely identifiable records. class GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket include Google::Apis::Core::Hashable # Number of records within these anonymity bounds. # Corresponds to the JSON property `bucketSize` # @return [Fixnum] attr_accessor :bucket_size # Sample of quasi-identifier tuple values in this bucket. The total # number of classes returned per bucket is capped at 20. # Corresponds to the JSON property `bucketValues` # @return [Array] attr_accessor :bucket_values # Always greater than or equal to min_anonymity. # Corresponds to the JSON property `maxAnonymity` # @return [Fixnum] attr_accessor :max_anonymity # Always positive. # Corresponds to the JSON property `minAnonymity` # @return [Fixnum] attr_accessor :min_anonymity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_size = args[:bucket_size] if args.key?(:bucket_size) @bucket_values = args[:bucket_values] if args.key?(:bucket_values) @max_anonymity = args[:max_anonymity] if args.key?(:max_anonymity) @min_anonymity = args[:min_anonymity] if args.key?(:min_anonymity) end end # A tuple of values for the quasi-identifier columns. class GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues include Google::Apis::Core::Hashable # The estimated anonymity for these quasi-identifier values. # Corresponds to the JSON property `estimatedAnonymity` # @return [Fixnum] attr_accessor :estimated_anonymity # The quasi-identifier values. # Corresponds to the JSON property `quasiIdsValues` # @return [Array] attr_accessor :quasi_ids_values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @estimated_anonymity = args[:estimated_anonymity] if args.key?(:estimated_anonymity) @quasi_ids_values = args[:quasi_ids_values] if args.key?(:quasi_ids_values) end end # Result of the reidentifiability analysis. Note that these results are an # estimation, not exact values. class GooglePrivacyDlpV2beta2KMapEstimationResult include Google::Apis::Core::Hashable # The intervals [min_anonymity, max_anonymity] do not overlap. If a value # doesn't correspond to any such interval, the associated frequency is # zero. For example, the following records: # `min_anonymity: 1, max_anonymity: 1, frequency: 17` # `min_anonymity: 2, max_anonymity: 3, frequency: 42` # `min_anonymity: 5, max_anonymity: 10, frequency: 99` # mean that there are no record with an estimated anonymity of 4, 5, or # larger than 10. # Corresponds to the JSON property `kMapEstimationHistogram` # @return [Array] attr_accessor :k_map_estimation_histogram def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @k_map_estimation_histogram = args[:k_map_estimation_histogram] if args.key?(:k_map_estimation_histogram) end end # A unique identifier for a Datastore entity. # If a key's partition ID or any of its path kinds or names are # reserved/read-only, the key is reserved/read-only. # A reserved/read-only key is forbidden in certain documented contexts. class GooglePrivacyDlpV2beta2Key include Google::Apis::Core::Hashable # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always # by project and namespace, however the namespace ID may be empty. # A partition ID contains several dimensions: # project ID and namespace ID. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PartitionId] attr_accessor :partition_id # The entity path. # An entity path consists of one or more elements composed of a kind and a # string or numerical identifier, which identify entities. The first # element identifies a _root entity_, the second element identifies # a _child_ of the root entity, the third element identifies a child of the # second entity, and so forth. The entities identified by all prefixes of # the path are called the element's _ancestors_. # A path can never be empty, and a path can have at most 100 elements. # Corresponds to the JSON property `path` # @return [Array] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @partition_id = args[:partition_id] if args.key?(:partition_id) @path = args[:path] if args.key?(:path) end end # A representation of a Datastore kind. class GooglePrivacyDlpV2beta2KindExpression include Google::Apis::Core::Hashable # The name of the kind. # 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 # Include to use an existing data crypto key wrapped by KMS. # Authorization requires the following IAM permissions when sending a request # to perform a crypto transformation using a kms-wrapped crypto key: # dlp.kms.encrypt class GooglePrivacyDlpV2beta2KmsWrappedCryptoKey include Google::Apis::Core::Hashable # The resource name of the KMS CryptoKey to use for unwrapping. [required] # Corresponds to the JSON property `cryptoKeyName` # @return [String] attr_accessor :crypto_key_name # The wrapped data crypto key. [required] # Corresponds to the JSON property `wrappedKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :wrapped_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @crypto_key_name = args[:crypto_key_name] if args.key?(:crypto_key_name) @wrapped_key = args[:wrapped_key] if args.key?(:wrapped_key) end end # l-diversity metric, used for analysis of reidentification risk. class GooglePrivacyDlpV2beta2LDiversityConfig include Google::Apis::Core::Hashable # Set of quasi-identifiers indicating how equivalence classes are # defined for the l-diversity computation. When multiple fields are # specified, they are considered a single composite key. # Corresponds to the JSON property `quasiIds` # @return [Array] attr_accessor :quasi_ids # General identifier of a data field in a storage service. # Corresponds to the JSON property `sensitiveAttribute` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :sensitive_attribute def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @quasi_ids = args[:quasi_ids] if args.key?(:quasi_ids) @sensitive_attribute = args[:sensitive_attribute] if args.key?(:sensitive_attribute) end end # The set of columns' values that share the same ldiversity value. class GooglePrivacyDlpV2beta2LDiversityEquivalenceClass include Google::Apis::Core::Hashable # Size of the k-anonymity equivalence class. # Corresponds to the JSON property `equivalenceClassSize` # @return [Fixnum] attr_accessor :equivalence_class_size # Number of distinct sensitive values in this equivalence class. # Corresponds to the JSON property `numDistinctSensitiveValues` # @return [Fixnum] attr_accessor :num_distinct_sensitive_values # Quasi-identifier values defining the k-anonymity equivalence # class. The order is always the same as the original request. # Corresponds to the JSON property `quasiIdsValues` # @return [Array] attr_accessor :quasi_ids_values # Estimated frequencies of top sensitive values. # Corresponds to the JSON property `topSensitiveValues` # @return [Array] attr_accessor :top_sensitive_values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @equivalence_class_size = args[:equivalence_class_size] if args.key?(:equivalence_class_size) @num_distinct_sensitive_values = args[:num_distinct_sensitive_values] if args.key?(:num_distinct_sensitive_values) @quasi_ids_values = args[:quasi_ids_values] if args.key?(:quasi_ids_values) @top_sensitive_values = args[:top_sensitive_values] if args.key?(:top_sensitive_values) end end # class GooglePrivacyDlpV2beta2LDiversityHistogramBucket include Google::Apis::Core::Hashable # Total number of equivalence classes in this bucket. # Corresponds to the JSON property `bucketSize` # @return [Fixnum] attr_accessor :bucket_size # Sample of equivalence classes in this bucket. The total number of # classes returned per bucket is capped at 20. # Corresponds to the JSON property `bucketValues` # @return [Array] attr_accessor :bucket_values # Lower bound on the sensitive value frequencies of the equivalence # classes in this bucket. # Corresponds to the JSON property `sensitiveValueFrequencyLowerBound` # @return [Fixnum] attr_accessor :sensitive_value_frequency_lower_bound # Upper bound on the sensitive value frequencies of the equivalence # classes in this bucket. # Corresponds to the JSON property `sensitiveValueFrequencyUpperBound` # @return [Fixnum] attr_accessor :sensitive_value_frequency_upper_bound def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_size = args[:bucket_size] if args.key?(:bucket_size) @bucket_values = args[:bucket_values] if args.key?(:bucket_values) @sensitive_value_frequency_lower_bound = args[:sensitive_value_frequency_lower_bound] if args.key?(:sensitive_value_frequency_lower_bound) @sensitive_value_frequency_upper_bound = args[:sensitive_value_frequency_upper_bound] if args.key?(:sensitive_value_frequency_upper_bound) end end # Result of the l-diversity computation. class GooglePrivacyDlpV2beta2LDiversityResult include Google::Apis::Core::Hashable # Histogram of l-diversity equivalence class sensitive value frequencies. # Corresponds to the JSON property `sensitiveValueFrequencyHistogramBuckets` # @return [Array] attr_accessor :sensitive_value_frequency_histogram_buckets def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @sensitive_value_frequency_histogram_buckets = args[:sensitive_value_frequency_histogram_buckets] if args.key?(:sensitive_value_frequency_histogram_buckets) end end # Message for specifying an adjustment to the likelihood of a finding as # part of a detection rule. class GooglePrivacyDlpV2beta2LikelihoodAdjustment include Google::Apis::Core::Hashable # Set the likelihood of a finding to a fixed value. # Corresponds to the JSON property `fixedLikelihood` # @return [String] attr_accessor :fixed_likelihood # Increase or decrease the likelihood by the specified number of # levels. For example, if a finding would be `POSSIBLE` without the # detection rule and `relative_likelihood` is 1, then it is upgraded to # `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. # Likelihood may never drop below `VERY_UNLIKELY` or exceed # `VERY_LIKELY`, so applying an adjustment of 1 followed by an # adjustment of -1 when base likelihood is `VERY_LIKELY` will result in # a final likelihood of `LIKELY`. # Corresponds to the JSON property `relativeLikelihood` # @return [Fixnum] attr_accessor :relative_likelihood def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fixed_likelihood = args[:fixed_likelihood] if args.key?(:fixed_likelihood) @relative_likelihood = args[:relative_likelihood] if args.key?(:relative_likelihood) end end # Response message for ListDeidentifyTemplates. class GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse include Google::Apis::Core::Hashable # List of deidentify templates, up to page_size in # ListDeidentifyTemplatesRequest. # Corresponds to the JSON property `deidentifyTemplates` # @return [Array] attr_accessor :deidentify_templates # If the next page is available then the next page token to be used # in following ListDeidentifyTemplates request. # 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) @deidentify_templates = args[:deidentify_templates] if args.key?(:deidentify_templates) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for listing DLP jobs. class GooglePrivacyDlpV2beta2ListDlpJobsResponse include Google::Apis::Core::Hashable # A list of DlpJobs that matches the specified filter in the request. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs # The standard List next-page token. # 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) @jobs = args[:jobs] if args.key?(:jobs) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response to the ListInfoTypes request. class GooglePrivacyDlpV2beta2ListInfoTypesResponse include Google::Apis::Core::Hashable # Set of sensitive infoTypes. # Corresponds to the JSON property `infoTypes` # @return [Array] attr_accessor :info_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @info_types = args[:info_types] if args.key?(:info_types) end end # Response message for ListInspectTemplates. class GooglePrivacyDlpV2beta2ListInspectTemplatesResponse include Google::Apis::Core::Hashable # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. # Corresponds to the JSON property `inspectTemplates` # @return [Array] attr_accessor :inspect_templates # If the next page is available then the next page token to be used # in following ListInspectTemplates request. # 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) @inspect_templates = args[:inspect_templates] if args.key?(:inspect_templates) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for ListJobTriggers. class GooglePrivacyDlpV2beta2ListJobTriggersResponse include Google::Apis::Core::Hashable # List of triggeredJobs, up to page_size in ListJobTriggersRequest. # Corresponds to the JSON property `jobTriggers` # @return [Array] attr_accessor :job_triggers # If the next page is available then the next page token to be used # in following ListJobTriggers request. # 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) @job_triggers = args[:job_triggers] if args.key?(:job_triggers) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Specifies the location of the finding. class GooglePrivacyDlpV2beta2Location include Google::Apis::Core::Hashable # Generic half-open interval [start, end) # Corresponds to the JSON property `byteRange` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Range] attr_accessor :byte_range # Generic half-open interval [start, end) # Corresponds to the JSON property `codepointRange` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Range] attr_accessor :codepoint_range # General identifier of a data field in a storage service. # Corresponds to the JSON property `fieldId` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :field_id # The area within the image that contained the finding. # Provided when the content is an image. # Corresponds to the JSON property `imageBoxes` # @return [Array] attr_accessor :image_boxes # Message for a unique key indicating a record that contains a finding. # Corresponds to the JSON property `recordKey` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordKey] attr_accessor :record_key # Location of a finding within a table. # Corresponds to the JSON property `tableLocation` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TableLocation] attr_accessor :table_location def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @byte_range = args[:byte_range] if args.key?(:byte_range) @codepoint_range = args[:codepoint_range] if args.key?(:codepoint_range) @field_id = args[:field_id] if args.key?(:field_id) @image_boxes = args[:image_boxes] if args.key?(:image_boxes) @record_key = args[:record_key] if args.key?(:record_key) @table_location = args[:table_location] if args.key?(:table_location) end end # Compute numerical stats over an individual column, including # min, max, and quantiles. class GooglePrivacyDlpV2beta2NumericalStatsConfig include Google::Apis::Core::Hashable # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :field def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) end end # Result of the numerical stats computation. class GooglePrivacyDlpV2beta2NumericalStatsResult include Google::Apis::Core::Hashable # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `maxValue` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value] attr_accessor :max_value # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `minValue` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value] attr_accessor :min_value # List of 99 values that partition the set of field values into 100 equal # sized buckets. # Corresponds to the JSON property `quantileValues` # @return [Array] attr_accessor :quantile_values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_value = args[:max_value] if args.key?(:max_value) @min_value = args[:min_value] if args.key?(:min_value) @quantile_values = args[:quantile_values] if args.key?(:quantile_values) end end # Cloud repository for storing output. class GooglePrivacyDlpV2beta2OutputStorageConfig include Google::Apis::Core::Hashable # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. # Corresponds to the JSON property `table` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable] attr_accessor :table def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @table = args[:table] if args.key?(:table) end end # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always # by project and namespace, however the namespace ID may be empty. # A partition ID contains several dimensions: # project ID and namespace ID. class GooglePrivacyDlpV2beta2PartitionId include Google::Apis::Core::Hashable # If not empty, the ID of the namespace to which the entities belong. # Corresponds to the JSON property `namespaceId` # @return [String] attr_accessor :namespace_id # The ID of the project to which the entities belong. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @namespace_id = args[:namespace_id] if args.key?(:namespace_id) @project_id = args[:project_id] if args.key?(:project_id) end end # A (kind, ID/name) pair used to construct a key path. # If either name or ID is set, the element is complete. # If neither is set, the element is incomplete. class GooglePrivacyDlpV2beta2PathElement include Google::Apis::Core::Hashable # The auto-allocated ID of the entity. # Never equal to zero. Values less than zero are discouraged and may not # be supported in the future. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The kind of the entity. # A kind matching regex `__.*__` is reserved/read-only. # A kind must not contain more than 1500 bytes when UTF-8 encoded. # Cannot be `""`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the entity. # A name matching regex `__.*__` is reserved/read-only. # A name must not be more than 1500 bytes when UTF-8 encoded. # Cannot be `""`. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # A rule for transforming a value. class GooglePrivacyDlpV2beta2PrimitiveTransformation include Google::Apis::Core::Hashable # Generalization function that buckets values based on ranges. The ranges and # replacement values are dynamically provided by the user for custom behavior, # such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH # This can be used on # data of type: number, long, string, timestamp. # If the bound `Value` type differs from the type of data being transformed, we # will first attempt converting the type of the data to be transformed to match # the type of the bound before comparing. # Corresponds to the JSON property `bucketingConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BucketingConfig] attr_accessor :bucketing_config # Partially mask a string by replacing a given number of characters with a # fixed character. Masking can start from the beginning or end of the string. # This can be used on data of any type (numbers, longs, and so on) and when # de-identifying structured data we'll attempt to preserve the original data's # type. (This allows you to take a long like 123 and modify it to a string like # **3. # Corresponds to the JSON property `characterMaskConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CharacterMaskConfig] attr_accessor :character_mask_config # Pseudonymization method that generates surrogates via cryptographic hashing. # Uses SHA-256. # The key size must be either 32 or 64 bytes. # Outputs a 32 byte digest as an uppercase hex string # (for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE). # Currently, only string and integer values can be hashed. # Corresponds to the JSON property `cryptoHashConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoHashConfig] attr_accessor :crypto_hash_config # Replaces an identifier with a surrogate using FPE with the FFX # mode of operation; however when used in the `ReidentifyContent` API method, # it serves the opposite function by reversing the surrogate back into # the original identifier. # The identifier must be encoded as ASCII. # For a given crypto key and context, the same identifier will be # replaced with the same surrogate. # Identifiers must be at least two characters long. # In the case that the identifier is the empty string, it will be skipped. # Corresponds to the JSON property `cryptoReplaceFfxFpeConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig] attr_accessor :crypto_replace_ffx_fpe_config # Buckets values based on fixed size ranges. The # Bucketing transformation can provide all of this functionality, # but requires more configuration. This message is provided as a convenience to # the user for simple bucketing strategies. # The transformed value will be a hyphenated string of # -, i.e if lower_bound = 10 and upper_bound = 20 # all values that are within this bucket will be replaced with "10-20". # This can be used on data of type: double, long. # If the bound Value type differs from the type of data # being transformed, we will first attempt converting the type of the data to # be transformed to match the type of the bound before comparing. # Corresponds to the JSON property `fixedSizeBucketingConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FixedSizeBucketingConfig] attr_accessor :fixed_size_bucketing_config # Redact a given value. For example, if used with an `InfoTypeTransformation` # transforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the # output would be 'My phone number is '. # Corresponds to the JSON property `redactConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactConfig] attr_accessor :redact_config # Replace each input value with a given `Value`. # Corresponds to the JSON property `replaceConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReplaceValueConfig] attr_accessor :replace_config # Replace each matching finding with the name of the info_type. # Corresponds to the JSON property `replaceWithInfoTypeConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig] attr_accessor :replace_with_info_type_config # For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a # portion of the value. # Corresponds to the JSON property `timePartConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TimePartConfig] attr_accessor :time_part_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucketing_config = args[:bucketing_config] if args.key?(:bucketing_config) @character_mask_config = args[:character_mask_config] if args.key?(:character_mask_config) @crypto_hash_config = args[:crypto_hash_config] if args.key?(:crypto_hash_config) @crypto_replace_ffx_fpe_config = args[:crypto_replace_ffx_fpe_config] if args.key?(:crypto_replace_ffx_fpe_config) @fixed_size_bucketing_config = args[:fixed_size_bucketing_config] if args.key?(:fixed_size_bucketing_config) @redact_config = args[:redact_config] if args.key?(:redact_config) @replace_config = args[:replace_config] if args.key?(:replace_config) @replace_with_info_type_config = args[:replace_with_info_type_config] if args.key?(:replace_with_info_type_config) @time_part_config = args[:time_part_config] if args.key?(:time_part_config) end end # Privacy metric to compute for reidentification risk analysis. class GooglePrivacyDlpV2beta2PrivacyMetric include Google::Apis::Core::Hashable # Compute numerical stats over an individual column, including # number of distinct values and value count distribution. # Corresponds to the JSON property `categoricalStatsConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CategoricalStatsConfig] attr_accessor :categorical_stats_config # k-anonymity metric, used for analysis of reidentification risk. # Corresponds to the JSON property `kAnonymityConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KAnonymityConfig] attr_accessor :k_anonymity_config # Reidentifiability metric. This corresponds to a risk model similar to what # is called "journalist risk" in the literature, except the attack dataset is # statistically modeled instead of being perfectly known. This can be done # using publicly available data (like the US Census), or using a custom # statistical model (indicated as one or several BigQuery tables), or by # extrapolating from the distribution of values in the input dataset. # Corresponds to the JSON property `kMapEstimationConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KMapEstimationConfig] attr_accessor :k_map_estimation_config # l-diversity metric, used for analysis of reidentification risk. # Corresponds to the JSON property `lDiversityConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2LDiversityConfig] attr_accessor :l_diversity_config # Compute numerical stats over an individual column, including # min, max, and quantiles. # Corresponds to the JSON property `numericalStatsConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2NumericalStatsConfig] attr_accessor :numerical_stats_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @categorical_stats_config = args[:categorical_stats_config] if args.key?(:categorical_stats_config) @k_anonymity_config = args[:k_anonymity_config] if args.key?(:k_anonymity_config) @k_map_estimation_config = args[:k_map_estimation_config] if args.key?(:k_map_estimation_config) @l_diversity_config = args[:l_diversity_config] if args.key?(:l_diversity_config) @numerical_stats_config = args[:numerical_stats_config] if args.key?(:numerical_stats_config) end end # Message for specifying a window around a finding to apply a detection # rule. class GooglePrivacyDlpV2beta2Proximity include Google::Apis::Core::Hashable # Number of characters after the finding to consider. # Corresponds to the JSON property `windowAfter` # @return [Fixnum] attr_accessor :window_after # Number of characters before the finding to consider. # Corresponds to the JSON property `windowBefore` # @return [Fixnum] attr_accessor :window_before def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @window_after = args[:window_after] if args.key?(:window_after) @window_before = args[:window_before] if args.key?(:window_before) end end # Publish the results of a DlpJob to a pub sub channel. # Compatible with: Inpect, Risk class GooglePrivacyDlpV2beta2PublishToPubSub include Google::Apis::Core::Hashable # Cloud Pub/Sub topic to send notifications to. The topic must have given # publishing access rights to the DLP API service account executing # the long running DlpJob sending the notifications. # Format is projects/`project`/topics/`topic`. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @topic = args[:topic] if args.key?(:topic) end end # A quasi-identifier column has a custom_tag, used to know which column # in the data corresponds to which column in the statistical model. class GooglePrivacyDlpV2beta2QuasiIdField include Google::Apis::Core::Hashable # # Corresponds to the JSON property `customTag` # @return [String] attr_accessor :custom_tag # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :field def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_tag = args[:custom_tag] if args.key?(:custom_tag) @field = args[:field] if args.key?(:field) end end # Generic half-open interval [start, end) class GooglePrivacyDlpV2beta2Range include Google::Apis::Core::Hashable # Index of the last character of the range (exclusive). # Corresponds to the JSON property `end` # @return [Fixnum] attr_accessor :end # Index of the first character of the range (inclusive). # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end = args[:end] if args.key?(:end) @start = args[:start] if args.key?(:start) end end # A condition for determining whether a transformation should be applied to # a field. class GooglePrivacyDlpV2beta2RecordCondition include Google::Apis::Core::Hashable # An expression, consisting or an operator and conditions. # Corresponds to the JSON property `expressions` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Expressions] attr_accessor :expressions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expressions = args[:expressions] if args.key?(:expressions) end end # Message for a unique key indicating a record that contains a finding. class GooglePrivacyDlpV2beta2RecordKey include Google::Apis::Core::Hashable # Record key for a finding in a Cloud Storage file. # Corresponds to the JSON property `cloudStorageKey` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CloudStorageKey] attr_accessor :cloud_storage_key # Record key for a finding in Cloud Datastore. # Corresponds to the JSON property `datastoreKey` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DatastoreKey] attr_accessor :datastore_key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cloud_storage_key = args[:cloud_storage_key] if args.key?(:cloud_storage_key) @datastore_key = args[:datastore_key] if args.key?(:datastore_key) end end # Configuration to suppress records whose suppression conditions evaluate to # true. class GooglePrivacyDlpV2beta2RecordSuppression include Google::Apis::Core::Hashable # A condition for determining whether a transformation should be applied to # a field. # Corresponds to the JSON property `condition` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordCondition] attr_accessor :condition def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @condition = args[:condition] if args.key?(:condition) end end # A type of transformation that is applied over structured data such as a # table. class GooglePrivacyDlpV2beta2RecordTransformations include Google::Apis::Core::Hashable # Transform the record by applying various field transformations. # Corresponds to the JSON property `fieldTransformations` # @return [Array] attr_accessor :field_transformations # Configuration defining which records get suppressed entirely. Records that # match any suppression rule are omitted from the output [optional]. # Corresponds to the JSON property `recordSuppressions` # @return [Array] attr_accessor :record_suppressions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field_transformations = args[:field_transformations] if args.key?(:field_transformations) @record_suppressions = args[:record_suppressions] if args.key?(:record_suppressions) end end # Redact a given value. For example, if used with an `InfoTypeTransformation` # transforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the # output would be 'My phone number is '. class GooglePrivacyDlpV2beta2RedactConfig include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Request to search for potentially sensitive info in a list of items # and replace it with a default or provided content. class GooglePrivacyDlpV2beta2RedactImageRequest include Google::Apis::Core::Hashable # The bytes of the image to redact. # Corresponds to the JSON property `imageData` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :image_data # The configuration for specifying what content to redact from images. # Corresponds to the JSON property `imageRedactionConfigs` # @return [Array] attr_accessor :image_redaction_configs # Type of the content, as defined in Content-Type HTTP header. # Supported types are: PNG, JPEG, SVG, & BMP. # Corresponds to the JSON property `imageType` # @return [String] attr_accessor :image_type # Configuration description of the scanning process. # When used with redactContent only info_types and min_likelihood are currently # used. # Corresponds to the JSON property `inspectConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig] attr_accessor :inspect_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @image_data = args[:image_data] if args.key?(:image_data) @image_redaction_configs = args[:image_redaction_configs] if args.key?(:image_redaction_configs) @image_type = args[:image_type] if args.key?(:image_type) @inspect_config = args[:inspect_config] if args.key?(:inspect_config) end end # Results of redacting an image. class GooglePrivacyDlpV2beta2RedactImageResponse include Google::Apis::Core::Hashable # If an image was being inspected and the InspectConfig's include_quote was # set to true, then this field will include all text, if any, that was found # in the image. # Corresponds to the JSON property `extractedText` # @return [String] attr_accessor :extracted_text # The redacted image. The type will be the same as the original image. # Corresponds to the JSON property `redactedImage` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :redacted_image def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @extracted_text = args[:extracted_text] if args.key?(:extracted_text) @redacted_image = args[:redacted_image] if args.key?(:redacted_image) end end # Message defining a custom regular expression. class GooglePrivacyDlpV2beta2Regex include Google::Apis::Core::Hashable # Pattern defining the regular expression. # Corresponds to the JSON property `pattern` # @return [String] attr_accessor :pattern def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @pattern = args[:pattern] if args.key?(:pattern) end end # Request to re-identify an item. class GooglePrivacyDlpV2beta2ReidentifyContentRequest include Google::Apis::Core::Hashable # Configuration description of the scanning process. # When used with redactContent only info_types and min_likelihood are currently # used. # Corresponds to the JSON property `inspectConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectConfig] attr_accessor :inspect_config # Optional template to use. Any configuration directly specified in # `inspect_config` will override those set in the template. Singular fields # that are set in this request will replace their corresponding fields in the # template. Repeated fields are appended. Singular sub-messages and groups # are recursively merged. # Corresponds to the JSON property `inspectTemplateName` # @return [String] attr_accessor :inspect_template_name # Container structure for the content to inspect. # Corresponds to the JSON property `item` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem] attr_accessor :item # The configuration that controls how the data will change. # Corresponds to the JSON property `reidentifyConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyConfig] attr_accessor :reidentify_config # Optional template to use. References an instance of `DeidentifyTemplate`. # Any configuration directly specified in `reidentify_config` or # `inspect_config` will override those set in the template. Singular fields # that are set in this request will replace their corresponding fields in the # template. Repeated fields are appended. Singular sub-messages and groups # are recursively merged. # Corresponds to the JSON property `reidentifyTemplateName` # @return [String] attr_accessor :reidentify_template_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @inspect_config = args[:inspect_config] if args.key?(:inspect_config) @inspect_template_name = args[:inspect_template_name] if args.key?(:inspect_template_name) @item = args[:item] if args.key?(:item) @reidentify_config = args[:reidentify_config] if args.key?(:reidentify_config) @reidentify_template_name = args[:reidentify_template_name] if args.key?(:reidentify_template_name) end end # Results of re-identifying a item. class GooglePrivacyDlpV2beta2ReidentifyContentResponse include Google::Apis::Core::Hashable # Container structure for the content to inspect. # Corresponds to the JSON property `item` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ContentItem] attr_accessor :item # Overview of the modifications that occurred. # Corresponds to the JSON property `overview` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransformationOverview] attr_accessor :overview def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @item = args[:item] if args.key?(:item) @overview = args[:overview] if args.key?(:overview) end end # Replace each input value with a given `Value`. class GooglePrivacyDlpV2beta2ReplaceValueConfig include Google::Apis::Core::Hashable # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `newValue` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value] attr_accessor :new_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @new_value = args[:new_value] if args.key?(:new_value) end end # Replace each matching finding with the name of the info_type. class GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # class GooglePrivacyDlpV2beta2RequestedOptions include Google::Apis::Core::Hashable # # Corresponds to the JSON property `jobConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectJobConfig] attr_accessor :job_config # The inspectTemplate contains a configuration (set of types of sensitive data # to be detected) to be used anywhere you otherwise would normally specify # InspectConfig. # Corresponds to the JSON property `snapshotInspectTemplate` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] attr_accessor :snapshot_inspect_template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @job_config = args[:job_config] if args.key?(:job_config) @snapshot_inspect_template = args[:snapshot_inspect_template] if args.key?(:snapshot_inspect_template) end end # class GooglePrivacyDlpV2beta2Result include Google::Apis::Core::Hashable # Statistics of how many instances of each info type were found during # inspect job. # Corresponds to the JSON property `infoTypeStats` # @return [Array] attr_accessor :info_type_stats # Total size in bytes that were processed. # Corresponds to the JSON property `processedBytes` # @return [Fixnum] attr_accessor :processed_bytes # Estimate of the number of bytes to process. # Corresponds to the JSON property `totalEstimatedBytes` # @return [Fixnum] attr_accessor :total_estimated_bytes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @info_type_stats = args[:info_type_stats] if args.key?(:info_type_stats) @processed_bytes = args[:processed_bytes] if args.key?(:processed_bytes) @total_estimated_bytes = args[:total_estimated_bytes] if args.key?(:total_estimated_bytes) end end # Configuration for a risk analysis job. class GooglePrivacyDlpV2beta2RiskAnalysisJobConfig include Google::Apis::Core::Hashable # Actions to execute at the completion of the job. Are executed in the order # provided. # Corresponds to the JSON property `actions` # @return [Array] attr_accessor :actions # Privacy metric to compute for reidentification risk analysis. # Corresponds to the JSON property `privacyMetric` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrivacyMetric] attr_accessor :privacy_metric # Message defining the location of a BigQuery table. A table is uniquely # identified by its project_id, dataset_id, and table_name. Within a query # a table is often referenced with a string in the format of: # `:.` or # `..`. # Corresponds to the JSON property `sourceTable` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryTable] attr_accessor :source_table def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @actions = args[:actions] if args.key?(:actions) @privacy_metric = args[:privacy_metric] if args.key?(:privacy_metric) @source_table = args[:source_table] if args.key?(:source_table) end end # class GooglePrivacyDlpV2beta2Row include Google::Apis::Core::Hashable # # 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) @values = args[:values] if args.key?(:values) end end # If set, the detailed findings will be persisted to the specified # OutputStorageConfig. Compatible with: Inspect class GooglePrivacyDlpV2beta2SaveFindings include Google::Apis::Core::Hashable # Cloud repository for storing output. # Corresponds to the JSON property `outputConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2OutputStorageConfig] attr_accessor :output_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @output_config = args[:output_config] if args.key?(:output_config) end end # Schedule for triggeredJobs. class GooglePrivacyDlpV2beta2Schedule include Google::Apis::Core::Hashable # With this option a job is started a regular periodic basis. For # example: every 10 minutes. # A scheduled start time will be skipped if the previous # execution has not ended when its scheduled time occurs. # This value must be set to a time duration greater than or equal # to 60 minutes and can be no longer than 60 days. # Corresponds to the JSON property `reccurrencePeriodDuration` # @return [String] attr_accessor :reccurrence_period_duration def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @reccurrence_period_duration = args[:reccurrence_period_duration] if args.key?(:reccurrence_period_duration) end end # Shared message indicating Cloud storage type. class GooglePrivacyDlpV2beta2StorageConfig include Google::Apis::Core::Hashable # Options defining BigQuery table and row identifiers. # Corresponds to the JSON property `bigQueryOptions` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2BigQueryOptions] attr_accessor :big_query_options # Options defining a file or a set of files (path ending with *) within # a Google Cloud Storage bucket. # Corresponds to the JSON property `cloudStorageOptions` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CloudStorageOptions] attr_accessor :cloud_storage_options # Options defining a data set within Google Cloud Datastore. # Corresponds to the JSON property `datastoreOptions` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DatastoreOptions] attr_accessor :datastore_options # Configuration of the timespan of the items to include in scanning. # Currently only supported when inspecting Google Cloud Storage and BigQuery. # Corresponds to the JSON property `timespanConfig` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TimespanConfig] attr_accessor :timespan_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @big_query_options = args[:big_query_options] if args.key?(:big_query_options) @cloud_storage_options = args[:cloud_storage_options] if args.key?(:cloud_storage_options) @datastore_options = args[:datastore_options] if args.key?(:datastore_options) @timespan_config = args[:timespan_config] if args.key?(:timespan_config) end end # A collection that informs the user the number of times a particular # `TransformationResultCode` and error details occurred. class GooglePrivacyDlpV2beta2SummaryResult include Google::Apis::Core::Hashable # # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # A place for warnings or errors to show up if a transformation didn't # work as expected. # Corresponds to the JSON property `details` # @return [String] attr_accessor :details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @code = args[:code] if args.key?(:code) @count = args[:count] if args.key?(:count) @details = args[:details] if args.key?(:details) end end # Message for detecting output from deidentification transformations # such as # [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/ # deidentify#CryptoReplaceFfxFpeConfig). # These types of transformations are # those that perform pseudonymization, thereby producing a "surrogate" as # output. This should be used in conjunction with a field on the # transformation such as `surrogate_info_type`. This custom info type does # not support the use of `detection_rules`. class GooglePrivacyDlpV2beta2SurrogateType include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Structured content to inspect. Up to 50,000 `Value`s per request allowed. class GooglePrivacyDlpV2beta2Table include Google::Apis::Core::Hashable # # Corresponds to the JSON property `headers` # @return [Array] attr_accessor :headers # # Corresponds to the JSON property `rows` # @return [Array] attr_accessor :rows def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @headers = args[:headers] if args.key?(:headers) @rows = args[:rows] if args.key?(:rows) end end # Location of a finding within a table. class GooglePrivacyDlpV2beta2TableLocation include Google::Apis::Core::Hashable # The zero-based index of the row where the finding is located. # Corresponds to the JSON property `rowIndex` # @return [Fixnum] attr_accessor :row_index def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @row_index = args[:row_index] if args.key?(:row_index) end end # A column with a semantic tag attached. class GooglePrivacyDlpV2beta2TaggedField include Google::Apis::Core::Hashable # A column can be tagged with a custom tag. In this case, the user must # indicate an auxiliary table that contains statistical information on # the possible values of this column (below). # Corresponds to the JSON property `customTag` # @return [String] attr_accessor :custom_tag # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :field # 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 ````. # Corresponds to the JSON property `inferred` # @return [Google::Apis::DlpV2beta2::GoogleProtobufEmpty] attr_accessor :inferred # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType] attr_accessor :info_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_tag = args[:custom_tag] if args.key?(:custom_tag) @field = args[:field] if args.key?(:field) @inferred = args[:inferred] if args.key?(:inferred) @info_type = args[:info_type] if args.key?(:info_type) end end # For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a # portion of the value. class GooglePrivacyDlpV2beta2TimePartConfig include Google::Apis::Core::Hashable # # Corresponds to the JSON property `partToExtract` # @return [String] attr_accessor :part_to_extract def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @part_to_extract = args[:part_to_extract] if args.key?(:part_to_extract) end end # Configuration of the timespan of the items to include in scanning. # Currently only supported when inspecting Google Cloud Storage and BigQuery. class GooglePrivacyDlpV2beta2TimespanConfig include Google::Apis::Core::Hashable # When the job is started by a JobTrigger we will automatically figure out # a valid start_time to avoid scanning files that have not been modified # since the last time the JobTrigger executed. This will be based on the # time of the execution of the last run of the JobTrigger. # Corresponds to the JSON property `enableAutoPopulationOfTimespanConfig` # @return [Boolean] attr_accessor :enable_auto_population_of_timespan_config alias_method :enable_auto_population_of_timespan_config?, :enable_auto_population_of_timespan_config # Exclude files newer than this value. # If set to zero, no upper time limit is applied. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Exclude files older than this value. # 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) @enable_auto_population_of_timespan_config = args[:enable_auto_population_of_timespan_config] if args.key?(:enable_auto_population_of_timespan_config) @end_time = args[:end_time] if args.key?(:end_time) @start_time = args[:start_time] if args.key?(:start_time) end end # Overview of the modifications that occurred. class GooglePrivacyDlpV2beta2TransformationOverview include Google::Apis::Core::Hashable # Transformations applied to the dataset. # Corresponds to the JSON property `transformationSummaries` # @return [Array] attr_accessor :transformation_summaries # Total size in bytes that were transformed in some way. # Corresponds to the JSON property `transformedBytes` # @return [Fixnum] attr_accessor :transformed_bytes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @transformation_summaries = args[:transformation_summaries] if args.key?(:transformation_summaries) @transformed_bytes = args[:transformed_bytes] if args.key?(:transformed_bytes) end end # Summary of a single tranformation. # Only one of 'transformation', 'field_transformation', or 'record_suppress' # will be set. class GooglePrivacyDlpV2beta2TransformationSummary include Google::Apis::Core::Hashable # General identifier of a data field in a storage service. # Corresponds to the JSON property `field` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2FieldId] attr_accessor :field # The field transformation that was applied. # If multiple field transformations are requested for a single field, # this list will contain all of them; otherwise, only one is supplied. # Corresponds to the JSON property `fieldTransformations` # @return [Array] attr_accessor :field_transformations # Type of information detected by the API. # Corresponds to the JSON property `infoType` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InfoType] attr_accessor :info_type # Configuration to suppress records whose suppression conditions evaluate to # true. # Corresponds to the JSON property `recordSuppress` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RecordSuppression] attr_accessor :record_suppress # # Corresponds to the JSON property `results` # @return [Array] attr_accessor :results # A rule for transforming a value. # Corresponds to the JSON property `transformation` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2PrimitiveTransformation] attr_accessor :transformation # Total size in bytes that were transformed in some way. # Corresponds to the JSON property `transformedBytes` # @return [Fixnum] attr_accessor :transformed_bytes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field = args[:field] if args.key?(:field) @field_transformations = args[:field_transformations] if args.key?(:field_transformations) @info_type = args[:info_type] if args.key?(:info_type) @record_suppress = args[:record_suppress] if args.key?(:record_suppress) @results = args[:results] if args.key?(:results) @transformation = args[:transformation] if args.key?(:transformation) @transformed_bytes = args[:transformed_bytes] if args.key?(:transformed_bytes) end end # Use this to have a random data crypto key generated. # It will be discarded after the request finishes. class GooglePrivacyDlpV2beta2TransientCryptoKey include Google::Apis::Core::Hashable # Name of the key. [required] # This is an arbitrary string used to differentiate different keys. # A unique key is generated per name: two separate `TransientCryptoKey` # protos share the same generated key if their names are the same. # When the data crypto key is generated, this name is not used in any way # (repeating the api call will result in a different key being generated). # 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 # What event needs to occur for a new job to be started. class GooglePrivacyDlpV2beta2Trigger include Google::Apis::Core::Hashable # Schedule for triggeredJobs. # Corresponds to the JSON property `schedule` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Schedule] attr_accessor :schedule def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @schedule = args[:schedule] if args.key?(:schedule) end end # Using raw keys is prone to security risks due to accidentally # leaking the key. Choose another type of key if possible. class GooglePrivacyDlpV2beta2UnwrappedCryptoKey include Google::Apis::Core::Hashable # The AES 128/192/256 bit key. [required] # Corresponds to the JSON property `key` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key = args[:key] if args.key?(:key) end end # Request message for UpdateDeidentifyTemplate. class GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest include Google::Apis::Core::Hashable # The DeidentifyTemplates contains instructions on how to deidentify content. # Corresponds to the JSON property `deidentifyTemplate` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] attr_accessor :deidentify_template # Mask to control which fields get updated. # 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) @deidentify_template = args[:deidentify_template] if args.key?(:deidentify_template) @update_mask = args[:update_mask] if args.key?(:update_mask) end end # Request message for UpdateInspectTemplate. class GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest include Google::Apis::Core::Hashable # The inspectTemplate contains a configuration (set of types of sensitive data # to be detected) to be used anywhere you otherwise would normally specify # InspectConfig. # Corresponds to the JSON property `inspectTemplate` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] attr_accessor :inspect_template # Mask to control which fields get updated. # 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) @inspect_template = args[:inspect_template] if args.key?(:inspect_template) @update_mask = args[:update_mask] if args.key?(:update_mask) end end # Request message for UpdateJobTrigger. class GooglePrivacyDlpV2beta2UpdateJobTriggerRequest include Google::Apis::Core::Hashable # Contains a configuration to make dlp api calls on a repeating basis. # Corresponds to the JSON property `jobTrigger` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger] attr_accessor :job_trigger # Mask to control which fields get updated. # 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) @job_trigger = args[:job_trigger] if args.key?(:job_trigger) @update_mask = args[:update_mask] if args.key?(:update_mask) end end # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. class GooglePrivacyDlpV2beta2Value include Google::Apis::Core::Hashable # # Corresponds to the JSON property `booleanValue` # @return [Boolean] attr_accessor :boolean_value alias_method :boolean_value?, :boolean_value # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary date. Related types are google.type.TimeOfDay # and `google.protobuf.Timestamp`. # Corresponds to the JSON property `dateValue` # @return [Google::Apis::DlpV2beta2::GoogleTypeDate] attr_accessor :date_value # # Corresponds to the JSON property `floatValue` # @return [Float] attr_accessor :float_value # # Corresponds to the JSON property `integerValue` # @return [Fixnum] attr_accessor :integer_value # # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value # 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 `timeValue` # @return [Google::Apis::DlpV2beta2::GoogleTypeTimeOfDay] attr_accessor :time_value # # Corresponds to the JSON property `timestampValue` # @return [String] attr_accessor :timestamp_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @boolean_value = args[:boolean_value] if args.key?(:boolean_value) @date_value = args[:date_value] if args.key?(:date_value) @float_value = args[:float_value] if args.key?(:float_value) @integer_value = args[:integer_value] if args.key?(:integer_value) @string_value = args[:string_value] if args.key?(:string_value) @time_value = args[:time_value] if args.key?(:time_value) @timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value) end end # A value of a field, including its frequency. class GooglePrivacyDlpV2beta2ValueFrequency include Google::Apis::Core::Hashable # How many times the value is contained in the field. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # Set of primitive values supported by the system. # Note that for the purposes of inspection or transformation, the number # of bytes considered to comprise a 'Value' is based on its representation # as a UTF-8 encoded string. For example, if 'integer_value' is set to # 123456789, the number of bytes would be counted as 9, even though an # int64 only holds up to 8 bytes of data. # Corresponds to the JSON property `value` # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2Value] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @count = args[:count] if args.key?(:count) @value = args[:value] if args.key?(:value) end end # Message defining a list of words or phrases to search for in the data. class GooglePrivacyDlpV2beta2WordList include Google::Apis::Core::Hashable # Words or phrases defining the dictionary. The dictionary must contain # at least one phrase and every phrase must contain at least 2 characters # that are letters or digits. [required] # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @words = args[:words] if args.key?(:words) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class 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 whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary date. Related types are google.type.TimeOfDay # and `google.protobuf.Timestamp`. class GoogleTypeDate 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/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. # 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 # 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 GoogleTypeTimeOfDay 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 end end end google-api-client-0.19.8/generated/google/apis/dlp_v2beta2/service.rb0000644000004100000410000025332213252673043025413 0ustar www-datawww-data# 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 DlpV2beta2 # DLP API # # The Google Data Loss Prevention API provides methods for detection of privacy- # sensitive fragments in text, images, and Google Cloud Platform storage # repositories. # # @example # require 'google/apis/dlp_v2beta2' # # Dlp = Google::Apis::DlpV2beta2 # Alias the module # service = Dlp::DLPService.new # # @see https://cloud.google.com/dlp/docs/ class DLPService < 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://dlp.googleapis.com/', '') @batch_path = 'batch' end # Returns sensitive information types DLP supports. # @param [String] filter # Optional filter to only return infoTypes supported by certain parts of the # API. Defaults to supported_by=INSPECT. # @param [String] language_code # Optional BCP-47 language code for localized infoType friendly # names. If omitted, or if localized strings are not available, # en-US strings 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::DlpV2beta2::GooglePrivacyDlpV2beta2ListInfoTypesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInfoTypesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_info_types(filter: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/infoTypes', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInfoTypesResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInfoTypesResponse command.query['filter'] = filter unless filter.nil? command.query['languageCode'] = language_code unless language_code.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 Deidentify template for re-using frequently used configuration # for Deidentifying content, images, and storage. # @param [String] parent # The parent resource name, for example projects/my-project-id or # organizations/my-org-id. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest] google_privacy_dlp_v2beta2_create_deidentify_template_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::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deidentify_template(parent, google_privacy_dlp_v2beta2_create_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/deidentifyTemplates', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest::Representation command.request_object = google_privacy_dlp_v2beta2_create_deidentify_template_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate 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 inspect templates. # @param [String] name # Resource name of the organization and deidentify template to be deleted, # for example `organizations/433245324/deidentifyTemplates/432452342` or # projects/project-id/deidentifyTemplates/432452342. # @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::DlpV2beta2::GoogleProtobufEmpty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::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_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::DlpV2beta2::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 an inspect template. # @param [String] name # Resource name of the organization and deidentify template to be read, for # example `organizations/433245324/deidentifyTemplates/432452342` or # projects/project-id/deidentifyTemplates/432452342. # @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::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate 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 inspect templates. # @param [String] parent # The parent resource name, for example projects/my-project-id or # organizations/my-org-id. # @param [Fixnum] page_size # Optional size of the page, can be limited by server. If zero server returns # a page of max size 100. # @param [String] page_token # Optional page token to continue retrieval. Comes from previous call # to `ListDeidentifyTemplates`. # @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::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deidentify_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+parent}/deidentifyTemplates', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse 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 # Updates the inspect template. # @param [String] name # Resource name of organization and deidentify template to be updated, for # example `organizations/433245324/deidentifyTemplates/432452342` or # projects/project-id/deidentifyTemplates/432452342. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest] google_privacy_dlp_v2beta2_update_deidentify_template_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::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_organization_deidentify_template(name, google_privacy_dlp_v2beta2_update_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta2/{+name}', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest::Representation command.request_object = google_privacy_dlp_v2beta2_update_deidentify_template_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate 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 inspect template for re-using frequently used configuration # for inspecting content, images, and storage. # @param [String] parent # The parent resource name, for example projects/my-project-id or # organizations/my-org-id. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateInspectTemplateRequest] google_privacy_dlp_v2beta2_create_inspect_template_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::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inspect_template(parent, google_privacy_dlp_v2beta2_create_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/inspectTemplates', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateInspectTemplateRequest::Representation command.request_object = google_privacy_dlp_v2beta2_create_inspect_template_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate 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 inspect templates. # @param [String] name # Resource name of the organization and inspectTemplate to be deleted, for # example `organizations/433245324/inspectTemplates/432452342` or # projects/project-id/inspectTemplates/432452342. # @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::DlpV2beta2::GoogleProtobufEmpty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::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_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::DlpV2beta2::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 an inspect template. # @param [String] name # Resource name of the organization and inspectTemplate to be read, for # example `organizations/433245324/inspectTemplates/432452342` or # projects/project-id/inspectTemplates/432452342. # @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::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate 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 inspect templates. # @param [String] parent # The parent resource name, for example projects/my-project-id or # organizations/my-org-id. # @param [Fixnum] page_size # Optional size of the page, can be limited by server. If zero server returns # a page of max size 100. # @param [String] page_token # Optional page token to continue retrieval. Comes from previous call # to `ListInspectTemplates`. # @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::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inspect_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+parent}/inspectTemplates', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse 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 # Updates the inspect template. # @param [String] name # Resource name of organization and inspectTemplate to be updated, for # example `organizations/433245324/inspectTemplates/432452342` or # projects/project-id/inspectTemplates/432452342. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest] google_privacy_dlp_v2beta2_update_inspect_template_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::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_organization_inspect_template(name, google_privacy_dlp_v2beta2_update_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta2/{+name}', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest::Representation command.request_object = google_privacy_dlp_v2beta2_update_inspect_template_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate 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 # De-identifies potentially sensitive info from a ContentItem. # This method has limits on input size and output size. # [How-to guide](/dlp/docs/deidentify-sensitive-data) # @param [String] parent # The parent resource name, for example projects/my-project-id. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentRequest] google_privacy_dlp_v2beta2_deidentify_content_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::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def deidentify_project_content(parent, google_privacy_dlp_v2beta2_deidentify_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/content:deidentify', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentRequest::Representation command.request_object = google_privacy_dlp_v2beta2_deidentify_content_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentResponse 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 # Finds potentially sensitive info in content. # This method has limits on input size, processing time, and output size. # [How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for # images](/dlp/docs/inspecting-images) # @param [String] parent # The parent resource name, for example projects/my-project-id. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentRequest] google_privacy_dlp_v2beta2_inspect_content_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::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def inspect_project_content(parent, google_privacy_dlp_v2beta2_inspect_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/content:inspect', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentRequest::Representation command.request_object = google_privacy_dlp_v2beta2_inspect_content_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentResponse 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 # Re-identify content that has been de-identified. # @param [String] parent # The parent resource name. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentRequest] google_privacy_dlp_v2beta2_reidentify_content_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::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def reidentify_project_content(parent, google_privacy_dlp_v2beta2_reidentify_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/content:reidentify', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentRequest::Representation command.request_object = google_privacy_dlp_v2beta2_reidentify_content_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentResponse 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 # Schedules a job to compute risk analysis metrics over content in a Google # Cloud Platform repository. [How-to guide](/dlp/docs/compute-risk-analysis) # @param [String] parent # The parent resource name, for example projects/my-project-id. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest] google_privacy_dlp_v2beta2_analyze_data_source_risk_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::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_data_source(parent, google_privacy_dlp_v2beta2_analyze_data_source_risk_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/dataSource:analyze', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest::Representation command.request_object = google_privacy_dlp_v2beta2_analyze_data_source_risk_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob 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 # Schedules a job scanning content in a Google Cloud Platform data # repository. [How-to guide](/dlp/docs/inspecting-storage) # @param [String] parent # The parent resource name, for example projects/my-project-id. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectDataSourceRequest] google_privacy_dlp_v2beta2_inspect_data_source_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::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def inspect_project_data_source(parent, google_privacy_dlp_v2beta2_inspect_data_source_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/dataSource:inspect', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectDataSourceRequest::Representation command.request_object = google_privacy_dlp_v2beta2_inspect_data_source_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob 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 an Deidentify template for re-using frequently used configuration # for Deidentifying content, images, and storage. # @param [String] parent # The parent resource name, for example projects/my-project-id or # organizations/my-org-id. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest] google_privacy_dlp_v2beta2_create_deidentify_template_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::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deidentify_template(parent, google_privacy_dlp_v2beta2_create_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/deidentifyTemplates', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest::Representation command.request_object = google_privacy_dlp_v2beta2_create_deidentify_template_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate 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 inspect templates. # @param [String] name # Resource name of the organization and deidentify template to be deleted, # for example `organizations/433245324/deidentifyTemplates/432452342` or # projects/project-id/deidentifyTemplates/432452342. # @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::DlpV2beta2::GoogleProtobufEmpty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::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_project_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::DlpV2beta2::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 an inspect template. # @param [String] name # Resource name of the organization and deidentify template to be read, for # example `organizations/433245324/deidentifyTemplates/432452342` or # projects/project-id/deidentifyTemplates/432452342. # @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::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate 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 inspect templates. # @param [String] parent # The parent resource name, for example projects/my-project-id or # organizations/my-org-id. # @param [Fixnum] page_size # Optional size of the page, can be limited by server. If zero server returns # a page of max size 100. # @param [String] page_token # Optional page token to continue retrieval. Comes from previous call # to `ListDeidentifyTemplates`. # @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::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deidentify_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+parent}/deidentifyTemplates', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse 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 # Updates the inspect template. # @param [String] name # Resource name of organization and deidentify template to be updated, for # example `organizations/433245324/deidentifyTemplates/432452342` or # projects/project-id/deidentifyTemplates/432452342. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest] google_privacy_dlp_v2beta2_update_deidentify_template_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::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_deidentify_template(name, google_privacy_dlp_v2beta2_update_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta2/{+name}', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest::Representation command.request_object = google_privacy_dlp_v2beta2_update_deidentify_template_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate 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 # Starts asynchronous cancellation on a long-running DlpJob. The server # makes a best effort to cancel the DlpJob, but success is not # guaranteed. # @param [String] name # The name of the DlpJob resource to be cancelled. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CancelDlpJobRequest] google_privacy_dlp_v2beta2_cancel_dlp_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::DlpV2beta2::GoogleProtobufEmpty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::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 cancel_project_dlp_job(name, google_privacy_dlp_v2beta2_cancel_dlp_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+name}:cancel', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CancelDlpJobRequest::Representation command.request_object = google_privacy_dlp_v2beta2_cancel_dlp_job_request_object command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::DlpV2beta2::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 # Deletes a long-running DlpJob. This method indicates that the client is # no longer interested in the DlpJob result. The job will be cancelled if # possible. # @param [String] name # The name of the DlpJob resource 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::DlpV2beta2::GoogleProtobufEmpty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::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_project_dlp_job(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::DlpV2beta2::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 latest state of a long-running DlpJob. # @param [String] name # The name of the DlpJob 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::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dlp_job(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob 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 DlpJobs that match the specified filter in the request. # @param [String] parent # The parent resource name, for example projects/my-project-id. # @param [String] filter # Optional. Allows filtering. # 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 ` `. # * Supported fields/values for inspect jobs: # - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED # - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY # - `trigger_name` - The resource name of the trigger that created job. # * Supported fields for risk analysis jobs: # - `state` - RUNNING|CANCELED|FINISHED|FAILED # * The operator must be `=` or `!=`. # Examples: # * inspected_storage = cloud_storage AND state = done # * inspected_storage = cloud_storage OR inspected_storage = bigquery # * inspected_storage = cloud_storage AND (state = done OR state = canceled) # The length of this field should be no more than 500 characters. # @param [Fixnum] page_size # The standard list page size. # @param [String] page_token # The standard list page token. # @param [String] type # The type of job. Defaults to `DlpJobType.INSPECT` # @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::DlpV2beta2::GooglePrivacyDlpV2beta2ListDlpJobsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDlpJobsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dlp_jobs(parent, filter: nil, page_size: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+parent}/dlpJobs', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDlpJobsResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDlpJobsResponse 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['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 # Redacts potentially sensitive info from an image. # This method has limits on input size, processing time, and output size. # [How-to guide](/dlp/docs/redacting-sensitive-data-images) # @param [String] parent # The parent resource name, for example projects/my-project-id. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageRequest] google_privacy_dlp_v2beta2_redact_image_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::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def redact_project_image(parent, google_privacy_dlp_v2beta2_redact_image_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/image:redact', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageRequest::Representation command.request_object = google_privacy_dlp_v2beta2_redact_image_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageResponse 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 an inspect template for re-using frequently used configuration # for inspecting content, images, and storage. # @param [String] parent # The parent resource name, for example projects/my-project-id or # organizations/my-org-id. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateInspectTemplateRequest] google_privacy_dlp_v2beta2_create_inspect_template_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::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inspect_template(parent, google_privacy_dlp_v2beta2_create_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/inspectTemplates', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateInspectTemplateRequest::Representation command.request_object = google_privacy_dlp_v2beta2_create_inspect_template_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate 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 inspect templates. # @param [String] name # Resource name of the organization and inspectTemplate to be deleted, for # example `organizations/433245324/inspectTemplates/432452342` or # projects/project-id/inspectTemplates/432452342. # @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::DlpV2beta2::GoogleProtobufEmpty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::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_project_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::DlpV2beta2::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 an inspect template. # @param [String] name # Resource name of the organization and inspectTemplate to be read, for # example `organizations/433245324/inspectTemplates/432452342` or # projects/project-id/inspectTemplates/432452342. # @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::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate 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 inspect templates. # @param [String] parent # The parent resource name, for example projects/my-project-id or # organizations/my-org-id. # @param [Fixnum] page_size # Optional size of the page, can be limited by server. If zero server returns # a page of max size 100. # @param [String] page_token # Optional page token to continue retrieval. Comes from previous call # to `ListInspectTemplates`. # @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::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inspect_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+parent}/inspectTemplates', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse 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 # Updates the inspect template. # @param [String] name # Resource name of organization and inspectTemplate to be updated, for # example `organizations/433245324/inspectTemplates/432452342` or # projects/project-id/inspectTemplates/432452342. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest] google_privacy_dlp_v2beta2_update_inspect_template_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::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inspect_template(name, google_privacy_dlp_v2beta2_update_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta2/{+name}', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest::Representation command.request_object = google_privacy_dlp_v2beta2_update_inspect_template_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate 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 job to run DLP actions such as scanning storage for sensitive # information on a set schedule. # @param [String] parent # The parent resource name, for example projects/my-project-id. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateJobTriggerRequest] google_privacy_dlp_v2beta2_create_job_trigger_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::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job_trigger(parent, google_privacy_dlp_v2beta2_create_job_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta2/{+parent}/jobTriggers', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateJobTriggerRequest::Representation command.request_object = google_privacy_dlp_v2beta2_create_job_trigger_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger 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 job trigger. # @param [String] name # Resource name of the project and the triggeredJob, for example # `projects/dlp-test-project/jobTriggers/53234423`. # @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::DlpV2beta2::GoogleProtobufEmpty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::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_project_job_trigger(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::DlpV2beta2::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 a job trigger. # @param [String] name # Resource name of the project and the triggeredJob, for example # `projects/dlp-test-project/jobTriggers/53234423`. # @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::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job_trigger(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger 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 job triggers. # @param [String] parent # The parent resource name, for example projects/my-project-id. # @param [String] order_by # Optional comma separated list of triggeredJob fields to order by, # followed by 'asc/desc' postfix, i.e. # `"create_time asc,name desc,schedule_mode asc"`. This list is # case-insensitive. # Example: `"name asc,schedule_mode desc, status desc"` # Supported filters keys and values are: # - `create_time`: corresponds to time the triggeredJob was created. # - `update_time`: corresponds to time the triggeredJob was last updated. # - `name`: corresponds to JobTrigger's display name. # - `status`: corresponds to the triggeredJob status. # @param [Fixnum] page_size # Optional size of the page, can be limited by a server. # @param [String] page_token # Optional page token to continue retrieval. Comes from previous call # to ListJobTriggers. `order_by` and `filter` should not change for # subsequent calls, but can be omitted if token is specified. # @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::DlpV2beta2::GooglePrivacyDlpV2beta2ListJobTriggersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListJobTriggersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job_triggers(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+parent}/jobTriggers', options) command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListJobTriggersResponse::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListJobTriggersResponse command.params['parent'] = parent unless parent.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 a job trigger. # @param [String] name # Resource name of the project and the triggeredJob, for example # `projects/dlp-test-project/jobTriggers/53234423`. # @param [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateJobTriggerRequest] google_privacy_dlp_v2beta2_update_job_trigger_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::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job_trigger(name, google_privacy_dlp_v2beta2_update_job_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta2/{+name}', options) command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateJobTriggerRequest::Representation command.request_object = google_privacy_dlp_v2beta2_update_job_trigger_request_object command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger::Representation command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger 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 google-api-client-0.19.8/generated/google/apis/clouddebugger_v2.rb0000644000004100000410000000244613252673043025070 0ustar www-datawww-data# 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/clouddebugger_v2/service.rb' require 'google/apis/clouddebugger_v2/classes.rb' require 'google/apis/clouddebugger_v2/representations.rb' module Google module Apis # Stackdriver Debugger API # # Examines the call stack and variables of a running application without # stopping or slowing it down. # # @see http://cloud.google.com/debugger module ClouddebuggerV2 VERSION = 'V2' REVISION = '20180112' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # Use Stackdriver Debugger AUTH_CLOUD_DEBUGGER = 'https://www.googleapis.com/auth/cloud_debugger' end end end google-api-client-0.19.8/generated/google/apis/pagespeedonline_v1/0000755000004100000410000000000013252673044025064 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/pagespeedonline_v1/representations.rb0000644000004100000410000002701113252673044030637 0ustar www-datawww-data# 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 PagespeedonlineV1 class Result class Representation < Google::Apis::Core::JsonRepresentation; end class FormattedResults class Representation < Google::Apis::Core::JsonRepresentation; end class RuleResult class Representation < Google::Apis::Core::JsonRepresentation; end class UrlBlock class Representation < Google::Apis::Core::JsonRepresentation; end class Header class Representation < Google::Apis::Core::JsonRepresentation; end class Arg class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Url class Representation < Google::Apis::Core::JsonRepresentation; end class Detail class Representation < Google::Apis::Core::JsonRepresentation; end class Arg class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Result class Representation < Google::Apis::Core::JsonRepresentation; end class Arg 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 include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class PageStats class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Screenshot class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Version class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Result # @private class Representation < Google::Apis::Core::JsonRepresentation property :captcha_result, as: 'captchaResult' property :formatted_results, as: 'formattedResults', class: Google::Apis::PagespeedonlineV1::Result::FormattedResults, decorator: Google::Apis::PagespeedonlineV1::Result::FormattedResults::Representation property :id, as: 'id' collection :invalid_rules, as: 'invalidRules' property :kind, as: 'kind' property :page_stats, as: 'pageStats', class: Google::Apis::PagespeedonlineV1::Result::PageStats, decorator: Google::Apis::PagespeedonlineV1::Result::PageStats::Representation property :response_code, as: 'responseCode' property :score, as: 'score' property :screenshot, as: 'screenshot', class: Google::Apis::PagespeedonlineV1::Result::Screenshot, decorator: Google::Apis::PagespeedonlineV1::Result::Screenshot::Representation property :title, as: 'title' property :version, as: 'version', class: Google::Apis::PagespeedonlineV1::Result::Version, decorator: Google::Apis::PagespeedonlineV1::Result::Version::Representation end class FormattedResults # @private class Representation < Google::Apis::Core::JsonRepresentation property :locale, as: 'locale' hash :rule_results, as: 'ruleResults', class: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult, decorator: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::Representation end class RuleResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :localized_rule_name, as: 'localizedRuleName' property :rule_impact, as: 'ruleImpact' collection :url_blocks, as: 'urlBlocks', class: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock, decorator: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Representation end class UrlBlock # @private class Representation < Google::Apis::Core::JsonRepresentation property :header, as: 'header', class: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Header, decorator: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Header::Representation collection :urls, as: 'urls', class: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url, decorator: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url::Representation end class Header # @private class Representation < Google::Apis::Core::JsonRepresentation collection :args, as: 'args', class: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Header::Arg, decorator: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Header::Arg::Representation property :format, as: 'format' end class Arg # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' property :value, as: 'value' end end end class Url # @private class Representation < Google::Apis::Core::JsonRepresentation collection :details, as: 'details', class: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url::Detail, decorator: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url::Detail::Representation property :result, as: 'result', class: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url::Result, decorator: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url::Result::Representation end class Detail # @private class Representation < Google::Apis::Core::JsonRepresentation collection :args, as: 'args', class: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url::Detail::Arg, decorator: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url::Detail::Arg::Representation property :format, as: 'format' end class Arg # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' property :value, as: 'value' end end end class Result # @private class Representation < Google::Apis::Core::JsonRepresentation collection :args, as: 'args', class: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url::Result::Arg, decorator: Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url::Result::Arg::Representation property :format, as: 'format' end class Arg # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' property :value, as: 'value' end end end end end end end class PageStats # @private class Representation < Google::Apis::Core::JsonRepresentation property :css_response_bytes, :numeric_string => true, as: 'cssResponseBytes' property :flash_response_bytes, :numeric_string => true, as: 'flashResponseBytes' property :html_response_bytes, :numeric_string => true, as: 'htmlResponseBytes' property :image_response_bytes, :numeric_string => true, as: 'imageResponseBytes' property :javascript_response_bytes, :numeric_string => true, as: 'javascriptResponseBytes' property :number_css_resources, as: 'numberCssResources' property :number_hosts, as: 'numberHosts' property :number_js_resources, as: 'numberJsResources' property :number_resources, as: 'numberResources' property :number_static_resources, as: 'numberStaticResources' property :other_response_bytes, :numeric_string => true, as: 'otherResponseBytes' property :text_response_bytes, :numeric_string => true, as: 'textResponseBytes' property :total_request_bytes, :numeric_string => true, as: 'totalRequestBytes' end end class Screenshot # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, :base64 => true, as: 'data' property :height, as: 'height' property :mime_type, as: 'mime_type' property :width, as: 'width' end end class Version # @private class Representation < Google::Apis::Core::JsonRepresentation property :major, as: 'major' property :minor, as: 'minor' end end end end end end google-api-client-0.19.8/generated/google/apis/pagespeedonline_v1/classes.rb0000644000004100000410000005540413252673044027056 0ustar www-datawww-data# 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 PagespeedonlineV1 # class Result include Google::Apis::Core::Hashable # The captcha verify result # Corresponds to the JSON property `captchaResult` # @return [String] attr_accessor :captcha_result # Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed # rule instantiated and run by the server. # Corresponds to the JSON property `formattedResults` # @return [Google::Apis::PagespeedonlineV1::Result::FormattedResults] attr_accessor :formatted_results # Canonicalized and final URL for the document, after following page redirects ( # if any). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # List of rules that were specified in the request, but which the server did not # know how to instantiate. # Corresponds to the JSON property `invalidRules` # @return [Array] attr_accessor :invalid_rules # Kind of result. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Summary statistics for the page, such as number of JavaScript bytes, number of # HTML bytes, etc. # Corresponds to the JSON property `pageStats` # @return [Google::Apis::PagespeedonlineV1::Result::PageStats] attr_accessor :page_stats # Response code for the document. 200 indicates a normal page load. 4xx/5xx # indicates an error. # Corresponds to the JSON property `responseCode` # @return [Fixnum] attr_accessor :response_code # The PageSpeed Score (0-100), which indicates how much faster a page could be. # A high score indicates little room for improvement, while a lower score # indicates more room for improvement. # Corresponds to the JSON property `score` # @return [Fixnum] attr_accessor :score # Base64-encoded screenshot of the page that was analyzed. # Corresponds to the JSON property `screenshot` # @return [Google::Apis::PagespeedonlineV1::Result::Screenshot] attr_accessor :screenshot # Title of the page, as displayed in the browser's title bar. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The version of PageSpeed used to generate these results. # Corresponds to the JSON property `version` # @return [Google::Apis::PagespeedonlineV1::Result::Version] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @captcha_result = args[:captcha_result] if args.key?(:captcha_result) @formatted_results = args[:formatted_results] if args.key?(:formatted_results) @id = args[:id] if args.key?(:id) @invalid_rules = args[:invalid_rules] if args.key?(:invalid_rules) @kind = args[:kind] if args.key?(:kind) @page_stats = args[:page_stats] if args.key?(:page_stats) @response_code = args[:response_code] if args.key?(:response_code) @score = args[:score] if args.key?(:score) @screenshot = args[:screenshot] if args.key?(:screenshot) @title = args[:title] if args.key?(:title) @version = args[:version] if args.key?(:version) end # Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed # rule instantiated and run by the server. class FormattedResults include Google::Apis::Core::Hashable # The locale of the formattedResults, e.g. "en_US". # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # Dictionary of formatted rule results, with one entry for each PageSpeed rule # instantiated and run by the server. # Corresponds to the JSON property `ruleResults` # @return [Hash] attr_accessor :rule_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @locale = args[:locale] if args.key?(:locale) @rule_results = args[:rule_results] if args.key?(:rule_results) end # The enum-like identifier for this rule. For instance "EnableKeepAlive" or " # AvoidCssImport". Not localized. class RuleResult include Google::Apis::Core::Hashable # Localized name of the rule, intended for presentation to a user. # Corresponds to the JSON property `localizedRuleName` # @return [String] attr_accessor :localized_rule_name # The impact (unbounded floating point value) that implementing the suggestions # for this rule would have on making the page faster. Impact is comparable # between rules to determine which rule's suggestions would have a higher or # lower impact on making a page faster. For instance, if enabling compression # would save 1MB, while optimizing images would save 500kB, the enable # compression rule would have 2x the impact of the image optimization rule, all # other things being equal. # Corresponds to the JSON property `ruleImpact` # @return [Float] attr_accessor :rule_impact # List of blocks of URLs. Each block may contain a heading and a list of URLs. # Each URL may optionally include additional details. # Corresponds to the JSON property `urlBlocks` # @return [Array] attr_accessor :url_blocks def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @localized_rule_name = args[:localized_rule_name] if args.key?(:localized_rule_name) @rule_impact = args[:rule_impact] if args.key?(:rule_impact) @url_blocks = args[:url_blocks] if args.key?(:url_blocks) end # class UrlBlock include Google::Apis::Core::Hashable # Heading to be displayed with the list of URLs. # Corresponds to the JSON property `header` # @return [Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Header] attr_accessor :header # List of entries that provide information about URLs in the url block. Optional. # Corresponds to the JSON property `urls` # @return [Array] attr_accessor :urls def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @header = args[:header] if args.key?(:header) @urls = args[:urls] if args.key?(:urls) end # Heading to be displayed with the list of URLs. class Header include Google::Apis::Core::Hashable # List of arguments for the format string. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args # A localized format string with $N placeholders, where N is the 1-indexed # argument number, e.g. 'Minifying the following $1 resources would save a total # of $2 bytes'. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @args = args[:args] if args.key?(:args) @format = args[:format] if args.key?(:format) end # class Arg include Google::Apis::Core::Hashable # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Argument value, as a localized string. # 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) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end end # class Url include Google::Apis::Core::Hashable # List of entries that provide additional details about a single URL. Optional. # Corresponds to the JSON property `details` # @return [Array] attr_accessor :details # A format string that gives information about the URL, and a list of arguments # for that format string. # Corresponds to the JSON property `result` # @return [Google::Apis::PagespeedonlineV1::Result::FormattedResults::RuleResult::UrlBlock::Url::Result] attr_accessor :result def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @details = args[:details] if args.key?(:details) @result = args[:result] if args.key?(:result) end # class Detail include Google::Apis::Core::Hashable # List of arguments for the format string. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args # A localized format string with $N placeholders, where N is the 1-indexed # argument number, e.g. 'Unnecessary metadata for this resource adds an # additional $1 bytes to its download size'. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @args = args[:args] if args.key?(:args) @format = args[:format] if args.key?(:format) end # class Arg include Google::Apis::Core::Hashable # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Argument value, as a localized string. # 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) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end end # A format string that gives information about the URL, and a list of arguments # for that format string. class Result include Google::Apis::Core::Hashable # List of arguments for the format string. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args # A localized format string with $N placeholders, where N is the 1-indexed # argument number, e.g. 'Minifying the resource at URL $1 can save $2 bytes'. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @args = args[:args] if args.key?(:args) @format = args[:format] if args.key?(:format) end # class Arg include Google::Apis::Core::Hashable # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Argument value, as a localized string. # 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) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end end end end end end # Summary statistics for the page, such as number of JavaScript bytes, number of # HTML bytes, etc. class PageStats include Google::Apis::Core::Hashable # Number of uncompressed response bytes for CSS resources on the page. # Corresponds to the JSON property `cssResponseBytes` # @return [Fixnum] attr_accessor :css_response_bytes # Number of response bytes for flash resources on the page. # Corresponds to the JSON property `flashResponseBytes` # @return [Fixnum] attr_accessor :flash_response_bytes # Number of uncompressed response bytes for the main HTML document and all # iframes on the page. # Corresponds to the JSON property `htmlResponseBytes` # @return [Fixnum] attr_accessor :html_response_bytes # Number of response bytes for image resources on the page. # Corresponds to the JSON property `imageResponseBytes` # @return [Fixnum] attr_accessor :image_response_bytes # Number of uncompressed response bytes for JS resources on the page. # Corresponds to the JSON property `javascriptResponseBytes` # @return [Fixnum] attr_accessor :javascript_response_bytes # Number of CSS resources referenced by the page. # Corresponds to the JSON property `numberCssResources` # @return [Fixnum] attr_accessor :number_css_resources # Number of unique hosts referenced by the page. # Corresponds to the JSON property `numberHosts` # @return [Fixnum] attr_accessor :number_hosts # Number of JavaScript resources referenced by the page. # Corresponds to the JSON property `numberJsResources` # @return [Fixnum] attr_accessor :number_js_resources # Number of HTTP resources loaded by the page. # Corresponds to the JSON property `numberResources` # @return [Fixnum] attr_accessor :number_resources # Number of static (i.e. cacheable) resources on the page. # Corresponds to the JSON property `numberStaticResources` # @return [Fixnum] attr_accessor :number_static_resources # Number of response bytes for other resources on the page. # Corresponds to the JSON property `otherResponseBytes` # @return [Fixnum] attr_accessor :other_response_bytes # Number of uncompressed response bytes for text resources not covered by other # statistics (i.e non-HTML, non-script, non-CSS resources) on the page. # Corresponds to the JSON property `textResponseBytes` # @return [Fixnum] attr_accessor :text_response_bytes # Total size of all request bytes sent by the page. # Corresponds to the JSON property `totalRequestBytes` # @return [Fixnum] attr_accessor :total_request_bytes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @css_response_bytes = args[:css_response_bytes] if args.key?(:css_response_bytes) @flash_response_bytes = args[:flash_response_bytes] if args.key?(:flash_response_bytes) @html_response_bytes = args[:html_response_bytes] if args.key?(:html_response_bytes) @image_response_bytes = args[:image_response_bytes] if args.key?(:image_response_bytes) @javascript_response_bytes = args[:javascript_response_bytes] if args.key?(:javascript_response_bytes) @number_css_resources = args[:number_css_resources] if args.key?(:number_css_resources) @number_hosts = args[:number_hosts] if args.key?(:number_hosts) @number_js_resources = args[:number_js_resources] if args.key?(:number_js_resources) @number_resources = args[:number_resources] if args.key?(:number_resources) @number_static_resources = args[:number_static_resources] if args.key?(:number_static_resources) @other_response_bytes = args[:other_response_bytes] if args.key?(:other_response_bytes) @text_response_bytes = args[:text_response_bytes] if args.key?(:text_response_bytes) @total_request_bytes = args[:total_request_bytes] if args.key?(:total_request_bytes) end end # Base64-encoded screenshot of the page that was analyzed. class Screenshot include Google::Apis::Core::Hashable # Image data base64 encoded. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data # Height of screenshot in pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Mime type of image data. E.g. "image/jpeg". # Corresponds to the JSON property `mime_type` # @return [String] attr_accessor :mime_type # Width of screenshot in pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data = args[:data] if args.key?(:data) @height = args[:height] if args.key?(:height) @mime_type = args[:mime_type] if args.key?(:mime_type) @width = args[:width] if args.key?(:width) end end # The version of PageSpeed used to generate these results. class Version include Google::Apis::Core::Hashable # The major version number of PageSpeed used to generate these results. # Corresponds to the JSON property `major` # @return [Fixnum] attr_accessor :major # The minor version number of PageSpeed used to generate these results. # Corresponds to the JSON property `minor` # @return [Fixnum] attr_accessor :minor def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @major = args[:major] if args.key?(:major) @minor = args[:minor] if args.key?(:minor) end end end end end end google-api-client-0.19.8/generated/google/apis/pagespeedonline_v1/service.rb0000644000004100000410000001312113252673044027047 0ustar www-datawww-data# 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 PagespeedonlineV1 # PageSpeed Insights API # # Analyzes the performance of a web page and provides tailored suggestions to # make that page faster. # # @example # require 'google/apis/pagespeedonline_v1' # # Pagespeedonline = Google::Apis::PagespeedonlineV1 # Alias the module # service = Pagespeedonline::PagespeedonlineService.new # # @see https://developers.google.com/speed/docs/insights/v1/getting_started class PagespeedonlineService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'pagespeedonline/v1/') @batch_path = 'batch/pagespeedonline/v1' end # Runs PageSpeed analysis on the page at the specified URL, and returns a # PageSpeed score, a list of suggestions to make that page faster, and other # information. # @param [String] url # The URL to fetch and analyze # @param [Boolean] filter_third_party_resources # Indicates if third party resources should be filtered out before PageSpeed # analysis. # @param [String] locale # The locale used to localize formatted results # @param [Array, String] rule # A PageSpeed rule to run; if none are given, all rules are run # @param [Boolean] screenshot # Indicates if binary data containing a screenshot should be included # @param [String] strategy # The analysis strategy to use # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::PagespeedonlineV1::Result] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PagespeedonlineV1::Result] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def runpagespeed_pagespeedapi(url, filter_third_party_resources: nil, locale: nil, rule: nil, screenshot: nil, strategy: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'runPagespeed', options) command.response_representation = Google::Apis::PagespeedonlineV1::Result::Representation command.response_class = Google::Apis::PagespeedonlineV1::Result command.query['filter_third_party_resources'] = filter_third_party_resources unless filter_third_party_resources.nil? command.query['locale'] = locale unless locale.nil? command.query['rule'] = rule unless rule.nil? command.query['screenshot'] = screenshot unless screenshot.nil? command.query['strategy'] = strategy unless strategy.nil? command.query['url'] = url unless url.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 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 end end google-api-client-0.19.8/generated/google/apis/pubsub_v1beta1a/0000755000004100000410000000000013252673044024300 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/pubsub_v1beta1a/representations.rb0000644000004100000410000002421413252673044030055 0ustar www-datawww-data# 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 PubsubV1beta1a class AcknowledgeRequest 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 Label class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListSubscriptionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTopicsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ModifyAckDeadlineRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ModifyPushConfigRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PublishBatchRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PublishBatchResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PublishRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PubsubEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PubsubMessage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PullBatchRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PullBatchResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PullRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PullResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PushConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Subscription class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Topic class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AcknowledgeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ack_id, as: 'ackId' property :subscription, as: 'subscription' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Label # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :num_value, :numeric_string => true, as: 'numValue' property :str_value, as: 'strValue' end end class ListSubscriptionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :subscription, as: 'subscription', class: Google::Apis::PubsubV1beta1a::Subscription, decorator: Google::Apis::PubsubV1beta1a::Subscription::Representation end end class ListTopicsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :topic, as: 'topic', class: Google::Apis::PubsubV1beta1a::Topic, decorator: Google::Apis::PubsubV1beta1a::Topic::Representation end end class ModifyAckDeadlineRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :ack_deadline_seconds, as: 'ackDeadlineSeconds' property :ack_id, as: 'ackId' collection :ack_ids, as: 'ackIds' property :subscription, as: 'subscription' end end class ModifyPushConfigRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :push_config, as: 'pushConfig', class: Google::Apis::PubsubV1beta1a::PushConfig, decorator: Google::Apis::PubsubV1beta1a::PushConfig::Representation property :subscription, as: 'subscription' end end class PublishBatchRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :messages, as: 'messages', class: Google::Apis::PubsubV1beta1a::PubsubMessage, decorator: Google::Apis::PubsubV1beta1a::PubsubMessage::Representation property :topic, as: 'topic' end end class PublishBatchResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :message_ids, as: 'messageIds' end end class PublishRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :message, as: 'message', class: Google::Apis::PubsubV1beta1a::PubsubMessage, decorator: Google::Apis::PubsubV1beta1a::PubsubMessage::Representation property :topic, as: 'topic' end end class PubsubEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :deleted, as: 'deleted' property :message, as: 'message', class: Google::Apis::PubsubV1beta1a::PubsubMessage, decorator: Google::Apis::PubsubV1beta1a::PubsubMessage::Representation property :subscription, as: 'subscription' property :truncated, as: 'truncated' end end class PubsubMessage # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, :base64 => true, as: 'data' collection :label, as: 'label', class: Google::Apis::PubsubV1beta1a::Label, decorator: Google::Apis::PubsubV1beta1a::Label::Representation property :message_id, as: 'messageId' property :publish_time, :numeric_string => true, as: 'publishTime' end end class PullBatchRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :max_events, as: 'maxEvents' property :return_immediately, as: 'returnImmediately' property :subscription, as: 'subscription' end end class PullBatchResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :pull_responses, as: 'pullResponses', class: Google::Apis::PubsubV1beta1a::PullResponse, decorator: Google::Apis::PubsubV1beta1a::PullResponse::Representation end end class PullRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :return_immediately, as: 'returnImmediately' property :subscription, as: 'subscription' end end class PullResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :ack_id, as: 'ackId' property :pubsub_event, as: 'pubsubEvent', class: Google::Apis::PubsubV1beta1a::PubsubEvent, decorator: Google::Apis::PubsubV1beta1a::PubsubEvent::Representation end end class PushConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :push_endpoint, as: 'pushEndpoint' end end class Subscription # @private class Representation < Google::Apis::Core::JsonRepresentation property :ack_deadline_seconds, as: 'ackDeadlineSeconds' property :name, as: 'name' property :push_config, as: 'pushConfig', class: Google::Apis::PubsubV1beta1a::PushConfig, decorator: Google::Apis::PubsubV1beta1a::PushConfig::Representation property :topic, as: 'topic' end end class Topic # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' end end end end end google-api-client-0.19.8/generated/google/apis/pubsub_v1beta1a/classes.rb0000644000004100000410000005425213252673044026272 0ustar www-datawww-data# 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 PubsubV1beta1a # Request for the Acknowledge method. class AcknowledgeRequest include Google::Apis::Core::Hashable # The acknowledgment ID for the message being acknowledged. This was # returned by the Pub/Sub system in the Pull response. # Corresponds to the JSON property `ackId` # @return [Array] attr_accessor :ack_id # The subscription whose message is being acknowledged. # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ack_id = args[:ack_id] if args.key?(:ack_id) @subscription = args[:subscription] if args.key?(:subscription) end end # An empty message that you can re-use to avoid defining duplicated empty # messages in your project. A typical example is to use it as argument or the # return value of a service API. For instance: # service Foo ` # rpc Bar (proto2.Empty) returns (proto2.Empty) ` `; # `; # BEGIN GOOGLE-INTERNAL # The difference between this one and net/rpc/empty-message.proto is that # 1) The generated message here is in proto2 C++ API. # 2) The proto2.Empty has minimum dependencies # (no message_set or net/rpc dependencies) # END GOOGLE-INTERNAL class Empty include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # A key-value pair applied to a given object. class Label include Google::Apis::Core::Hashable # The key of a label is a syntactically valid URL (as per RFC 1738) with # the "scheme" and initial slashes omitted and with the additional # restrictions noted below. Each key should be globally unique. The # "host" portion is called the "namespace" and is not necessarily # resolvable to a network endpoint. Instead, the namespace indicates what # system or entity defines the semantics of the label. Namespaces do not # restrict the set of objects to which a label may be associated. # Keys are defined by the following grammar: # key = hostname "/" kpath # kpath = ksegment *[ "/" ksegment ] # ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] # where "hostname" and "alphadigit" are defined as in RFC 1738. # Example key: # spanner.google.com/universe # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # An integer value. # Corresponds to the JSON property `numValue` # @return [Fixnum] attr_accessor :num_value # A string value. # Corresponds to the JSON property `strValue` # @return [String] attr_accessor :str_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key = args[:key] if args.key?(:key) @num_value = args[:num_value] if args.key?(:num_value) @str_value = args[:str_value] if args.key?(:str_value) end end # Response for the ListSubscriptions method. class ListSubscriptionsResponse include Google::Apis::Core::Hashable # If not empty, indicates that there are more subscriptions that match the # request and this value should be passed to the next # ListSubscriptionsRequest to continue. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The subscriptions that match the request. # Corresponds to the JSON property `subscription` # @return [Array] attr_accessor :subscription 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) @subscription = args[:subscription] if args.key?(:subscription) end end # Response for the ListTopics method. class ListTopicsResponse include Google::Apis::Core::Hashable # If not empty, indicates that there are more topics that match the request, # and this value should be passed to the next ListTopicsRequest # to continue. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The resulting topics. # Corresponds to the JSON property `topic` # @return [Array] attr_accessor :topic 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) @topic = args[:topic] if args.key?(:topic) end end # Request for the ModifyAckDeadline method. class ModifyAckDeadlineRequest include Google::Apis::Core::Hashable # The new ack deadline with respect to the time this request was sent to the # Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack # deadline will expire 10 seconds after the ModifyAckDeadline call was made. # Specifying zero may immediately make the message available for another pull # request. # Corresponds to the JSON property `ackDeadlineSeconds` # @return [Fixnum] attr_accessor :ack_deadline_seconds # The acknowledgment ID. Either this or ack_ids must be populated, # not both. # Corresponds to the JSON property `ackId` # @return [String] attr_accessor :ack_id # List of acknowledgment IDs. Either this field or ack_id # should be populated, not both. # Corresponds to the JSON property `ackIds` # @return [Array] attr_accessor :ack_ids # Next Index: 5 # The name of the subscription from which messages are being pulled. # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds) @ack_id = args[:ack_id] if args.key?(:ack_id) @ack_ids = args[:ack_ids] if args.key?(:ack_ids) @subscription = args[:subscription] if args.key?(:subscription) end end # Request for the ModifyPushConfig method. class ModifyPushConfigRequest include Google::Apis::Core::Hashable # Configuration for a push delivery endpoint. # Corresponds to the JSON property `pushConfig` # @return [Google::Apis::PubsubV1beta1a::PushConfig] attr_accessor :push_config # The name of the subscription. # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @push_config = args[:push_config] if args.key?(:push_config) @subscription = args[:subscription] if args.key?(:subscription) end end # Request for the PublishBatch method. class PublishBatchRequest include Google::Apis::Core::Hashable # The messages to publish. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages # The messages in the request will be published on this topic. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @messages = args[:messages] if args.key?(:messages) @topic = args[:topic] if args.key?(:topic) end end # Response for the PublishBatch method. class PublishBatchResponse include Google::Apis::Core::Hashable # The server-assigned ID of each published message, in the same order as # the messages in the request. IDs are guaranteed to be unique within # the topic. # Corresponds to the JSON property `messageIds` # @return [Array] attr_accessor :message_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @message_ids = args[:message_ids] if args.key?(:message_ids) end end # Request for the Publish method. class PublishRequest include Google::Apis::Core::Hashable # A message data and its labels. # Corresponds to the JSON property `message` # @return [Google::Apis::PubsubV1beta1a::PubsubMessage] attr_accessor :message # The message in the request will be published on this topic. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @message = args[:message] if args.key?(:message) @topic = args[:topic] if args.key?(:topic) end end # An event indicating a received message or truncation event. class PubsubEvent include Google::Apis::Core::Hashable # Indicates that this subscription has been deleted. (Note that pull # subscribers will always receive NOT_FOUND in response in their pull # request on the subscription, rather than seeing this boolean.) # Corresponds to the JSON property `deleted` # @return [Boolean] attr_accessor :deleted alias_method :deleted?, :deleted # A message data and its labels. # Corresponds to the JSON property `message` # @return [Google::Apis::PubsubV1beta1a::PubsubMessage] attr_accessor :message # The subscription that received the event. # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription # Indicates that this subscription has been truncated. # Corresponds to the JSON property `truncated` # @return [Boolean] attr_accessor :truncated alias_method :truncated?, :truncated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deleted = args[:deleted] if args.key?(:deleted) @message = args[:message] if args.key?(:message) @subscription = args[:subscription] if args.key?(:subscription) @truncated = args[:truncated] if args.key?(:truncated) end end # A message data and its labels. class PubsubMessage include Google::Apis::Core::Hashable # The message payload. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data # Optional list of labels for this message. Keys in this collection must # be unique. # Corresponds to the JSON property `label` # @return [Array] attr_accessor :label # ID of this message assigned by the server at publication time. Guaranteed # to be unique within the topic. This value may be read by a subscriber # that receives a PubsubMessage via a Pull call or a push delivery. It must # not be populated by a publisher in a Publish call. # Corresponds to the JSON property `messageId` # @return [String] attr_accessor :message_id # The time at which the message was published. # The time is milliseconds since the UNIX epoch. # Corresponds to the JSON property `publishTime` # @return [Fixnum] attr_accessor :publish_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data = args[:data] if args.key?(:data) @label = args[:label] if args.key?(:label) @message_id = args[:message_id] if args.key?(:message_id) @publish_time = args[:publish_time] if args.key?(:publish_time) end end # Request for the PullBatch method. class PullBatchRequest include Google::Apis::Core::Hashable # The maximum number of PubsubEvents returned for this request. The Pub/Sub # system may return fewer than the number of events specified. # Corresponds to the JSON property `maxEvents` # @return [Fixnum] attr_accessor :max_events # If this is specified as true the system will respond immediately even if # it is not able to return a message in the Pull response. Otherwise the # system is allowed to wait until at least one message is available rather # than returning no messages. The client may cancel the request if it does # not wish to wait any longer for the response. # Corresponds to the JSON property `returnImmediately` # @return [Boolean] attr_accessor :return_immediately alias_method :return_immediately?, :return_immediately # The subscription from which messages should be pulled. # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @max_events = args[:max_events] if args.key?(:max_events) @return_immediately = args[:return_immediately] if args.key?(:return_immediately) @subscription = args[:subscription] if args.key?(:subscription) end end # Response for the PullBatch method. class PullBatchResponse include Google::Apis::Core::Hashable # Received Pub/Sub messages or status events. The Pub/Sub system will return # zero messages if there are no more messages available in the backlog. The # Pub/Sub system may return fewer than the max_events requested even if # there are more messages available in the backlog. # Corresponds to the JSON property `pullResponses` # @return [Array] attr_accessor :pull_responses def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @pull_responses = args[:pull_responses] if args.key?(:pull_responses) end end # Request for the Pull method. class PullRequest include Google::Apis::Core::Hashable # If this is specified as true the system will respond immediately even if # it is not able to return a message in the Pull response. Otherwise the # system is allowed to wait until at least one message is available rather # than returning FAILED_PRECONDITION. The client may cancel the request if # it does not wish to wait any longer for the response. # Corresponds to the JSON property `returnImmediately` # @return [Boolean] attr_accessor :return_immediately alias_method :return_immediately?, :return_immediately # The subscription from which a message should be pulled. # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @return_immediately = args[:return_immediately] if args.key?(:return_immediately) @subscription = args[:subscription] if args.key?(:subscription) end end # Either a PubsubMessage or a truncation event. One of these two # must be populated. class PullResponse include Google::Apis::Core::Hashable # This ID must be used to acknowledge the received event or message. # Corresponds to the JSON property `ackId` # @return [String] attr_accessor :ack_id # An event indicating a received message or truncation event. # Corresponds to the JSON property `pubsubEvent` # @return [Google::Apis::PubsubV1beta1a::PubsubEvent] attr_accessor :pubsub_event def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ack_id = args[:ack_id] if args.key?(:ack_id) @pubsub_event = args[:pubsub_event] if args.key?(:pubsub_event) end end # Configuration for a push delivery endpoint. class PushConfig include Google::Apis::Core::Hashable # A URL locating the endpoint to which messages should be pushed. # For example, a Webhook endpoint might use "https://example.com/push". # Corresponds to the JSON property `pushEndpoint` # @return [String] attr_accessor :push_endpoint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @push_endpoint = args[:push_endpoint] if args.key?(:push_endpoint) end end # A subscription resource. class Subscription include Google::Apis::Core::Hashable # For either push or pull delivery, the value is the maximum time after a # subscriber receives a message before the subscriber should acknowledge or # Nack the message. If the Ack deadline for a message passes without an # Ack or a Nack, the Pub/Sub system will eventually redeliver the message. # If a subscriber acknowledges after the deadline, the Pub/Sub system may # accept the Ack, but it is possible that the message has been already # delivered again. Multiple Acks to the message are allowed and will # succeed. # For push delivery, this value is used to set the request timeout for # the call to the push endpoint. # For pull delivery, this value is used as the initial value for the Ack # deadline. It may be overridden for each message using its corresponding # ack_id with ModifyAckDeadline. # While a message is outstanding (i.e. it has been delivered to a pull # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub # system will not deliver that message to another pull subscriber # (on a best-effort basis). # Corresponds to the JSON property `ackDeadlineSeconds` # @return [Fixnum] attr_accessor :ack_deadline_seconds # Name of the subscription. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Configuration for a push delivery endpoint. # Corresponds to the JSON property `pushConfig` # @return [Google::Apis::PubsubV1beta1a::PushConfig] attr_accessor :push_config # The name of the topic from which this subscription is receiving messages. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds) @name = args[:name] if args.key?(:name) @push_config = args[:push_config] if args.key?(:push_config) @topic = args[:topic] if args.key?(:topic) end end # A topic resource. class Topic include Google::Apis::Core::Hashable # Name of the topic. # 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 end end end google-api-client-0.19.8/generated/google/apis/pubsub_v1beta1a/service.rb0000644000004100000410000010070113252673044026264 0ustar www-datawww-data# 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 PubsubV1beta1a # Google Cloud Pub/Sub API # # Provides reliable, many-to-many, asynchronous messaging between applications. # # @example # require 'google/apis/pubsub_v1beta1a' # # Pubsub = Google::Apis::PubsubV1beta1a # Alias the module # service = Pubsub::PubsubService.new # # @see https://cloud.google.com/pubsub/docs class PubsubService < 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://pubsub.googleapis.com/', '') @batch_path = 'batch' end # Acknowledges a particular received message: the Pub/Sub system can remove # the given message from the subscription. Acknowledging a message whose # Ack deadline has expired may succeed, but the message could have been # already redelivered. Acknowledging a message more than once will not # result in an error. This is only used for messages received via pull. # @param [Google::Apis::PubsubV1beta1a::AcknowledgeRequest] acknowledge_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::PubsubV1beta1a::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::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 acknowledge_subscription(acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1a/subscriptions/acknowledge', options) command.request_representation = Google::Apis::PubsubV1beta1a::AcknowledgeRequest::Representation command.request_object = acknowledge_request_object command.response_representation = Google::Apis::PubsubV1beta1a::Empty::Representation command.response_class = Google::Apis::PubsubV1beta1a::Empty 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 on a given topic for a given subscriber. # If the subscription already exists, returns ALREADY_EXISTS. # If the corresponding topic doesn't exist, returns NOT_FOUND. # If the name is not provided in the request, the server will assign a random # name for this subscription on the same project as the topic. # @param [Google::Apis::PubsubV1beta1a::Subscription] 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::PubsubV1beta1a::Subscription] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::Subscription] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subscription(subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1a/subscriptions', options) command.request_representation = Google::Apis::PubsubV1beta1a::Subscription::Representation command.request_object = subscription_object command.response_representation = Google::Apis::PubsubV1beta1a::Subscription::Representation command.response_class = Google::Apis::PubsubV1beta1a::Subscription 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 subscription. All pending messages in the subscription # are immediately dropped. Calls to Pull after deletion will return # NOT_FOUND. # @param [String] subscription # The subscription 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::PubsubV1beta1a::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::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_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1a/subscriptions/{+subscription}', options) command.response_representation = Google::Apis::PubsubV1beta1a::Empty::Representation command.response_class = Google::Apis::PubsubV1beta1a::Empty command.params['subscription'] = subscription unless subscription.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 configuration details of a subscription. # @param [String] subscription # The name of the subscription to get. # @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::PubsubV1beta1a::Subscription] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::Subscription] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1a/subscriptions/{+subscription}', options) command.response_representation = Google::Apis::PubsubV1beta1a::Subscription::Representation command.response_class = Google::Apis::PubsubV1beta1a::Subscription command.params['subscription'] = subscription unless subscription.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 matching subscriptions. # @param [Fixnum] max_results # Maximum number of subscriptions to return. # @param [String] page_token # The value obtained in the last ListSubscriptionsResponse # for continuation. # @param [String] query # A valid label query expression. # @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::PubsubV1beta1a::ListSubscriptionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::ListSubscriptionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subscriptions(max_results: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1a/subscriptions', options) command.response_representation = Google::Apis::PubsubV1beta1a::ListSubscriptionsResponse::Representation command.response_class = Google::Apis::PubsubV1beta1a::ListSubscriptionsResponse command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.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 # Modifies the Ack deadline for a message received from a pull request. # @param [Google::Apis::PubsubV1beta1a::ModifyAckDeadlineRequest] modify_ack_deadline_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::PubsubV1beta1a::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::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 modify_subscription_ack_deadline(modify_ack_deadline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1a/subscriptions/modifyAckDeadline', options) command.request_representation = Google::Apis::PubsubV1beta1a::ModifyAckDeadlineRequest::Representation command.request_object = modify_ack_deadline_request_object command.response_representation = Google::Apis::PubsubV1beta1a::Empty::Representation command.response_class = Google::Apis::PubsubV1beta1a::Empty command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Modifies the PushConfig for a specified subscription. # This method can be used to suspend the flow of messages to an endpoint # by clearing the PushConfig field in the request. Messages # will be accumulated for delivery even if no push configuration is # defined or while the configuration is modified. # @param [Google::Apis::PubsubV1beta1a::ModifyPushConfigRequest] modify_push_config_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::PubsubV1beta1a::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::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 modify_subscription_push_config(modify_push_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1a/subscriptions/modifyPushConfig', options) command.request_representation = Google::Apis::PubsubV1beta1a::ModifyPushConfigRequest::Representation command.request_object = modify_push_config_request_object command.response_representation = Google::Apis::PubsubV1beta1a::Empty::Representation command.response_class = Google::Apis::PubsubV1beta1a::Empty command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Pulls a single message from the server. # If return_immediately is true, and no messages are available in the # subscription, this method returns FAILED_PRECONDITION. The system is free # to return an UNAVAILABLE error if no messages are available in a # reasonable amount of time (to reduce system load). # @param [Google::Apis::PubsubV1beta1a::PullRequest] pull_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::PubsubV1beta1a::PullResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::PullResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def pull_subscription(pull_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1a/subscriptions/pull', options) command.request_representation = Google::Apis::PubsubV1beta1a::PullRequest::Representation command.request_object = pull_request_object command.response_representation = Google::Apis::PubsubV1beta1a::PullResponse::Representation command.response_class = Google::Apis::PubsubV1beta1a::PullResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Pulls messages from the server. Returns an empty list if there are no # messages available in the backlog. The system is free to return UNAVAILABLE # if there are too many pull requests outstanding for the given subscription. # @param [Google::Apis::PubsubV1beta1a::PullBatchRequest] pull_batch_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::PubsubV1beta1a::PullBatchResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::PullBatchResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def pull_subscription_batch(pull_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1a/subscriptions/pullBatch', options) command.request_representation = Google::Apis::PubsubV1beta1a::PullBatchRequest::Representation command.request_object = pull_batch_request_object command.response_representation = Google::Apis::PubsubV1beta1a::PullBatchResponse::Representation command.response_class = Google::Apis::PubsubV1beta1a::PullBatchResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Creates the given topic with the given name. # @param [Google::Apis::PubsubV1beta1a::Topic] topic_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::PubsubV1beta1a::Topic] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::Topic] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_topic(topic_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1a/topics', options) command.request_representation = Google::Apis::PubsubV1beta1a::Topic::Representation command.request_object = topic_object command.response_representation = Google::Apis::PubsubV1beta1a::Topic::Representation command.response_class = Google::Apis::PubsubV1beta1a::Topic 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 topic with the given name. Returns NOT_FOUND if the topic does # not exist. After a topic is deleted, a new topic may be created with the # same name. # @param [String] topic # Name of the topic 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::PubsubV1beta1a::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::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_topic(topic, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1a/topics/{+topic}', options) command.response_representation = Google::Apis::PubsubV1beta1a::Empty::Representation command.response_class = Google::Apis::PubsubV1beta1a::Empty command.params['topic'] = topic unless topic.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 configuration of a topic. Since the topic only has the name # attribute, this method is only useful to check the existence of a topic. # If other attributes are added in the future, they will be returned here. # @param [String] topic # The name of the topic to get. # @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::PubsubV1beta1a::Topic] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::Topic] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_topic(topic, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1a/topics/{+topic}', options) command.response_representation = Google::Apis::PubsubV1beta1a::Topic::Representation command.response_class = Google::Apis::PubsubV1beta1a::Topic command.params['topic'] = topic unless topic.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 matching topics. # @param [Fixnum] max_results # Maximum number of topics to return. # @param [String] page_token # The value obtained in the last ListTopicsResponse # for continuation. # @param [String] query # A valid label query expression. # @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::PubsubV1beta1a::ListTopicsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::ListTopicsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_topics(max_results: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1a/topics', options) command.response_representation = Google::Apis::PubsubV1beta1a::ListTopicsResponse::Representation command.response_class = Google::Apis::PubsubV1beta1a::ListTopicsResponse command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.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 # Adds a message to the topic. Returns NOT_FOUND if the topic does not # exist. # @param [Google::Apis::PubsubV1beta1a::PublishRequest] publish_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::PubsubV1beta1a::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::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 publish_topic(publish_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1a/topics/publish', options) command.request_representation = Google::Apis::PubsubV1beta1a::PublishRequest::Representation command.request_object = publish_request_object command.response_representation = Google::Apis::PubsubV1beta1a::Empty::Representation command.response_class = Google::Apis::PubsubV1beta1a::Empty command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Adds one or more messages to the topic. Returns NOT_FOUND if the topic does # not exist. # @param [Google::Apis::PubsubV1beta1a::PublishBatchRequest] publish_batch_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::PubsubV1beta1a::PublishBatchResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PubsubV1beta1a::PublishBatchResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_topic_batch(publish_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1a/topics/publishBatch', options) command.request_representation = Google::Apis::PubsubV1beta1a::PublishBatchRequest::Representation command.request_object = publish_batch_request_object command.response_representation = Google::Apis::PubsubV1beta1a::PublishBatchResponse::Representation command.response_class = Google::Apis::PubsubV1beta1a::PublishBatchResponse 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 google-api-client-0.19.8/generated/google/apis/games_v1/0000755000004100000410000000000013252673043023015 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/games_v1/representations.rb0000644000004100000410000021314013252673043026570 0ustar www-datawww-data# 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 GamesV1 class AchievementDefinition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAchievementDefinitionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AchievementIncrementResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AchievementRevealResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AchievementSetStepsAtLeastResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AchievementUnlockResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AchievementUpdateMultipleRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AchievementUpdateMultipleResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateAchievementRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateAchievementResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AggregateStats class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnonymousPlayer class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Application class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApplicationCategory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ApplicationVerifyResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Category class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListCategoryResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventBatchRecordFailure class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventChild class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventDefinition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListEventDefinitionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventPeriodRange class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventPeriodUpdate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventRecordFailure class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventRecordRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateEventRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateEventResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GamesAchievementIncrement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GamesAchievementSetStepsAtLeast class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImageAsset class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Instance class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceAndroidDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceIosDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InstanceWebDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Leaderboard class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LeaderboardEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLeaderboardResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LeaderboardScoreRank class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LeaderboardScores class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetagameConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NetworkDiagnostics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ParticipantResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PeerChannelDiagnostics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PeerSessionDiagnostics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Played class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Player class Representation < Google::Apis::Core::JsonRepresentation; end class Name class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class PlayerAchievement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPlayerAchievementResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlayerEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPlayerEventResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlayerExperienceInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlayerLeaderboardScore class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPlayerLeaderboardScoreResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlayerLevel class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPlayerResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlayerScore class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPlayerScoreResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlayerScoreResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlayerScoreSubmissionList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProfileSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PushToken class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PushTokenId class Representation < Google::Apis::Core::JsonRepresentation; end class Ios class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Quest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuestContribution class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuestCriterion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListQuestResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuestMilestone class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CheckRevisionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Room class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoomAutoMatchStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoomAutoMatchingCriteria class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoomClientAddress class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateRoomRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class JoinRoomRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoomLeaveDiagnostics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LeaveRoomRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoomList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoomModification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoomP2PStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoomP2PStatuses class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoomParticipant class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RoomStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ScoreSubmission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Snapshot class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SnapshotImage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListSnapshotResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedAutoMatchingCriteria class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedMatch class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateTurnBasedMatchRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedMatchData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedMatchDataRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedMatchList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedMatchModification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedMatchParticipant class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedMatchRematch class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedMatchResults class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedMatchSync class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnBasedMatchTurn class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AchievementDefinition # @private class Representation < Google::Apis::Core::JsonRepresentation property :achievement_type, as: 'achievementType' property :description, as: 'description' property :experience_points, :numeric_string => true, as: 'experiencePoints' property :formatted_total_steps, as: 'formattedTotalSteps' property :id, as: 'id' property :initial_state, as: 'initialState' property :is_revealed_icon_url_default, as: 'isRevealedIconUrlDefault' property :is_unlocked_icon_url_default, as: 'isUnlockedIconUrlDefault' property :kind, as: 'kind' property :name, as: 'name' property :revealed_icon_url, as: 'revealedIconUrl' property :total_steps, as: 'totalSteps' property :unlocked_icon_url, as: 'unlockedIconUrl' end end class ListAchievementDefinitionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::AchievementDefinition, decorator: Google::Apis::GamesV1::AchievementDefinition::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class AchievementIncrementResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_steps, as: 'currentSteps' property :kind, as: 'kind' property :newly_unlocked, as: 'newlyUnlocked' end end class AchievementRevealResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_state, as: 'currentState' property :kind, as: 'kind' end end class AchievementSetStepsAtLeastResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_steps, as: 'currentSteps' property :kind, as: 'kind' property :newly_unlocked, as: 'newlyUnlocked' end end class AchievementUnlockResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :newly_unlocked, as: 'newlyUnlocked' end end class AchievementUpdateMultipleRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :updates, as: 'updates', class: Google::Apis::GamesV1::UpdateAchievementRequest, decorator: Google::Apis::GamesV1::UpdateAchievementRequest::Representation end end class AchievementUpdateMultipleResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :updated_achievements, as: 'updatedAchievements', class: Google::Apis::GamesV1::UpdateAchievementResponse, decorator: Google::Apis::GamesV1::UpdateAchievementResponse::Representation end end class UpdateAchievementRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :achievement_id, as: 'achievementId' property :increment_payload, as: 'incrementPayload', class: Google::Apis::GamesV1::GamesAchievementIncrement, decorator: Google::Apis::GamesV1::GamesAchievementIncrement::Representation property :kind, as: 'kind' property :set_steps_at_least_payload, as: 'setStepsAtLeastPayload', class: Google::Apis::GamesV1::GamesAchievementSetStepsAtLeast, decorator: Google::Apis::GamesV1::GamesAchievementSetStepsAtLeast::Representation property :update_type, as: 'updateType' end end class UpdateAchievementResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :achievement_id, as: 'achievementId' property :current_state, as: 'currentState' property :current_steps, as: 'currentSteps' property :kind, as: 'kind' property :newly_unlocked, as: 'newlyUnlocked' property :update_occurred, as: 'updateOccurred' end end class AggregateStats # @private class Representation < Google::Apis::Core::JsonRepresentation property :count, :numeric_string => true, as: 'count' property :kind, as: 'kind' property :max, :numeric_string => true, as: 'max' property :min, :numeric_string => true, as: 'min' property :sum, :numeric_string => true, as: 'sum' end end class AnonymousPlayer # @private class Representation < Google::Apis::Core::JsonRepresentation property :avatar_image_url, as: 'avatarImageUrl' property :display_name, as: 'displayName' property :kind, as: 'kind' end end class Application # @private class Representation < Google::Apis::Core::JsonRepresentation property :achievement_count, as: 'achievement_count' collection :assets, as: 'assets', class: Google::Apis::GamesV1::ImageAsset, decorator: Google::Apis::GamesV1::ImageAsset::Representation property :author, as: 'author' property :category, as: 'category', class: Google::Apis::GamesV1::ApplicationCategory, decorator: Google::Apis::GamesV1::ApplicationCategory::Representation property :description, as: 'description' collection :enabled_features, as: 'enabledFeatures' property :id, as: 'id' collection :instances, as: 'instances', class: Google::Apis::GamesV1::Instance, decorator: Google::Apis::GamesV1::Instance::Representation property :kind, as: 'kind' property :last_updated_timestamp, :numeric_string => true, as: 'lastUpdatedTimestamp' property :leaderboard_count, as: 'leaderboard_count' property :name, as: 'name' property :theme_color, as: 'themeColor' end end class ApplicationCategory # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :primary, as: 'primary' property :secondary, as: 'secondary' end end class ApplicationVerifyResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :alternate_player_id, as: 'alternate_player_id' property :kind, as: 'kind' property :player_id, as: 'player_id' end end class Category # @private class Representation < Google::Apis::Core::JsonRepresentation property :category, as: 'category' property :experience_points, :numeric_string => true, as: 'experiencePoints' property :kind, as: 'kind' end end class ListCategoryResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::Category, decorator: Google::Apis::GamesV1::Category::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class EventBatchRecordFailure # @private class Representation < Google::Apis::Core::JsonRepresentation property :failure_cause, as: 'failureCause' property :kind, as: 'kind' property :range, as: 'range', class: Google::Apis::GamesV1::EventPeriodRange, decorator: Google::Apis::GamesV1::EventPeriodRange::Representation end end class EventChild # @private class Representation < Google::Apis::Core::JsonRepresentation property :child_id, as: 'childId' property :kind, as: 'kind' end end class EventDefinition # @private class Representation < Google::Apis::Core::JsonRepresentation collection :child_events, as: 'childEvents', class: Google::Apis::GamesV1::EventChild, decorator: Google::Apis::GamesV1::EventChild::Representation property :description, as: 'description' property :display_name, as: 'displayName' property :id, as: 'id' property :image_url, as: 'imageUrl' property :is_default_image_url, as: 'isDefaultImageUrl' property :kind, as: 'kind' property :visibility, as: 'visibility' end end class ListEventDefinitionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::EventDefinition, decorator: Google::Apis::GamesV1::EventDefinition::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class EventPeriodRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :period_end_millis, :numeric_string => true, as: 'periodEndMillis' property :period_start_millis, :numeric_string => true, as: 'periodStartMillis' end end class EventPeriodUpdate # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :time_period, as: 'timePeriod', class: Google::Apis::GamesV1::EventPeriodRange, decorator: Google::Apis::GamesV1::EventPeriodRange::Representation collection :updates, as: 'updates', class: Google::Apis::GamesV1::UpdateEventRequest, decorator: Google::Apis::GamesV1::UpdateEventRequest::Representation end end class EventRecordFailure # @private class Representation < Google::Apis::Core::JsonRepresentation property :event_id, as: 'eventId' property :failure_cause, as: 'failureCause' property :kind, as: 'kind' end end class EventRecordRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_time_millis, :numeric_string => true, as: 'currentTimeMillis' property :kind, as: 'kind' property :request_id, :numeric_string => true, as: 'requestId' collection :time_periods, as: 'timePeriods', class: Google::Apis::GamesV1::EventPeriodUpdate, decorator: Google::Apis::GamesV1::EventPeriodUpdate::Representation end end class UpdateEventRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :definition_id, as: 'definitionId' property :kind, as: 'kind' property :update_count, :numeric_string => true, as: 'updateCount' end end class UpdateEventResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :batch_failures, as: 'batchFailures', class: Google::Apis::GamesV1::EventBatchRecordFailure, decorator: Google::Apis::GamesV1::EventBatchRecordFailure::Representation collection :event_failures, as: 'eventFailures', class: Google::Apis::GamesV1::EventRecordFailure, decorator: Google::Apis::GamesV1::EventRecordFailure::Representation property :kind, as: 'kind' collection :player_events, as: 'playerEvents', class: Google::Apis::GamesV1::PlayerEvent, decorator: Google::Apis::GamesV1::PlayerEvent::Representation end end class GamesAchievementIncrement # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :request_id, :numeric_string => true, as: 'requestId' property :steps, as: 'steps' end end class GamesAchievementSetStepsAtLeast # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :steps, as: 'steps' end end class ImageAsset # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :kind, as: 'kind' property :name, as: 'name' property :url, as: 'url' property :width, as: 'width' end end class Instance # @private class Representation < Google::Apis::Core::JsonRepresentation property :acquisition_uri, as: 'acquisitionUri' property :android_instance, as: 'androidInstance', class: Google::Apis::GamesV1::InstanceAndroidDetails, decorator: Google::Apis::GamesV1::InstanceAndroidDetails::Representation property :ios_instance, as: 'iosInstance', class: Google::Apis::GamesV1::InstanceIosDetails, decorator: Google::Apis::GamesV1::InstanceIosDetails::Representation property :kind, as: 'kind' property :name, as: 'name' property :platform_type, as: 'platformType' property :realtime_play, as: 'realtimePlay' property :turn_based_play, as: 'turnBasedPlay' property :web_instance, as: 'webInstance', class: Google::Apis::GamesV1::InstanceWebDetails, decorator: Google::Apis::GamesV1::InstanceWebDetails::Representation end end class InstanceAndroidDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :enable_piracy_check, as: 'enablePiracyCheck' property :kind, as: 'kind' property :package_name, as: 'packageName' property :preferred, as: 'preferred' end end class InstanceIosDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :bundle_identifier, as: 'bundleIdentifier' property :itunes_app_id, as: 'itunesAppId' property :kind, as: 'kind' property :preferred_for_ipad, as: 'preferredForIpad' property :preferred_for_iphone, as: 'preferredForIphone' property :support_ipad, as: 'supportIpad' property :support_iphone, as: 'supportIphone' end end class InstanceWebDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :launch_url, as: 'launchUrl' property :preferred, as: 'preferred' end end class Leaderboard # @private class Representation < Google::Apis::Core::JsonRepresentation property :icon_url, as: 'iconUrl' property :id, as: 'id' property :is_icon_url_default, as: 'isIconUrlDefault' property :kind, as: 'kind' property :name, as: 'name' property :order, as: 'order' end end class LeaderboardEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :formatted_score, as: 'formattedScore' property :formatted_score_rank, as: 'formattedScoreRank' property :kind, as: 'kind' property :player, as: 'player', class: Google::Apis::GamesV1::Player, decorator: Google::Apis::GamesV1::Player::Representation property :score_rank, :numeric_string => true, as: 'scoreRank' property :score_tag, as: 'scoreTag' property :score_value, :numeric_string => true, as: 'scoreValue' property :time_span, as: 'timeSpan' property :write_timestamp_millis, :numeric_string => true, as: 'writeTimestampMillis' end end class ListLeaderboardResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::Leaderboard, decorator: Google::Apis::GamesV1::Leaderboard::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class LeaderboardScoreRank # @private class Representation < Google::Apis::Core::JsonRepresentation property :formatted_num_scores, as: 'formattedNumScores' property :formatted_rank, as: 'formattedRank' property :kind, as: 'kind' property :num_scores, :numeric_string => true, as: 'numScores' property :rank, :numeric_string => true, as: 'rank' end end class LeaderboardScores # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::LeaderboardEntry, decorator: Google::Apis::GamesV1::LeaderboardEntry::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :num_scores, :numeric_string => true, as: 'numScores' property :player_score, as: 'playerScore', class: Google::Apis::GamesV1::LeaderboardEntry, decorator: Google::Apis::GamesV1::LeaderboardEntry::Representation property :prev_page_token, as: 'prevPageToken' end end class MetagameConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_version, as: 'currentVersion' property :kind, as: 'kind' collection :player_levels, as: 'playerLevels', class: Google::Apis::GamesV1::PlayerLevel, decorator: Google::Apis::GamesV1::PlayerLevel::Representation end end class NetworkDiagnostics # @private class Representation < Google::Apis::Core::JsonRepresentation property :android_network_subtype, as: 'androidNetworkSubtype' property :android_network_type, as: 'androidNetworkType' property :ios_network_type, as: 'iosNetworkType' property :kind, as: 'kind' property :network_operator_code, as: 'networkOperatorCode' property :network_operator_name, as: 'networkOperatorName' property :registration_latency_millis, as: 'registrationLatencyMillis' end end class ParticipantResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :participant_id, as: 'participantId' property :placing, as: 'placing' property :result, as: 'result' end end class PeerChannelDiagnostics # @private class Representation < Google::Apis::Core::JsonRepresentation property :bytes_received, as: 'bytesReceived', class: Google::Apis::GamesV1::AggregateStats, decorator: Google::Apis::GamesV1::AggregateStats::Representation property :bytes_sent, as: 'bytesSent', class: Google::Apis::GamesV1::AggregateStats, decorator: Google::Apis::GamesV1::AggregateStats::Representation property :kind, as: 'kind' property :num_messages_lost, as: 'numMessagesLost' property :num_messages_received, as: 'numMessagesReceived' property :num_messages_sent, as: 'numMessagesSent' property :num_send_failures, as: 'numSendFailures' property :roundtrip_latency_millis, as: 'roundtripLatencyMillis', class: Google::Apis::GamesV1::AggregateStats, decorator: Google::Apis::GamesV1::AggregateStats::Representation end end class PeerSessionDiagnostics # @private class Representation < Google::Apis::Core::JsonRepresentation property :connected_timestamp_millis, :numeric_string => true, as: 'connectedTimestampMillis' property :kind, as: 'kind' property :participant_id, as: 'participantId' property :reliable_channel, as: 'reliableChannel', class: Google::Apis::GamesV1::PeerChannelDiagnostics, decorator: Google::Apis::GamesV1::PeerChannelDiagnostics::Representation property :unreliable_channel, as: 'unreliableChannel', class: Google::Apis::GamesV1::PeerChannelDiagnostics, decorator: Google::Apis::GamesV1::PeerChannelDiagnostics::Representation end end class Played # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_matched, as: 'autoMatched' property :kind, as: 'kind' property :time_millis, :numeric_string => true, as: 'timeMillis' end end class Player # @private class Representation < Google::Apis::Core::JsonRepresentation property :avatar_image_url, as: 'avatarImageUrl' property :banner_url_landscape, as: 'bannerUrlLandscape' property :banner_url_portrait, as: 'bannerUrlPortrait' property :display_name, as: 'displayName' property :experience_info, as: 'experienceInfo', class: Google::Apis::GamesV1::PlayerExperienceInfo, decorator: Google::Apis::GamesV1::PlayerExperienceInfo::Representation property :kind, as: 'kind' property :last_played_with, as: 'lastPlayedWith', class: Google::Apis::GamesV1::Played, decorator: Google::Apis::GamesV1::Played::Representation property :name, as: 'name', class: Google::Apis::GamesV1::Player::Name, decorator: Google::Apis::GamesV1::Player::Name::Representation property :original_player_id, as: 'originalPlayerId' property :player_id, as: 'playerId' property :profile_settings, as: 'profileSettings', class: Google::Apis::GamesV1::ProfileSettings, decorator: Google::Apis::GamesV1::ProfileSettings::Representation property :title, as: 'title' end class Name # @private class Representation < Google::Apis::Core::JsonRepresentation property :family_name, as: 'familyName' property :given_name, as: 'givenName' end end end class PlayerAchievement # @private class Representation < Google::Apis::Core::JsonRepresentation property :achievement_state, as: 'achievementState' property :current_steps, as: 'currentSteps' property :experience_points, :numeric_string => true, as: 'experiencePoints' property :formatted_current_steps_string, as: 'formattedCurrentStepsString' property :id, as: 'id' property :kind, as: 'kind' property :last_updated_timestamp, :numeric_string => true, as: 'lastUpdatedTimestamp' end end class ListPlayerAchievementResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::PlayerAchievement, decorator: Google::Apis::GamesV1::PlayerAchievement::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class PlayerEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :definition_id, as: 'definitionId' property :formatted_num_events, as: 'formattedNumEvents' property :kind, as: 'kind' property :num_events, :numeric_string => true, as: 'numEvents' property :player_id, as: 'playerId' end end class ListPlayerEventResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::PlayerEvent, decorator: Google::Apis::GamesV1::PlayerEvent::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class PlayerExperienceInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_experience_points, :numeric_string => true, as: 'currentExperiencePoints' property :current_level, as: 'currentLevel', class: Google::Apis::GamesV1::PlayerLevel, decorator: Google::Apis::GamesV1::PlayerLevel::Representation property :kind, as: 'kind' property :last_level_up_timestamp_millis, :numeric_string => true, as: 'lastLevelUpTimestampMillis' property :next_level, as: 'nextLevel', class: Google::Apis::GamesV1::PlayerLevel, decorator: Google::Apis::GamesV1::PlayerLevel::Representation end end class PlayerLeaderboardScore # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :leaderboard_id, as: 'leaderboard_id' property :public_rank, as: 'publicRank', class: Google::Apis::GamesV1::LeaderboardScoreRank, decorator: Google::Apis::GamesV1::LeaderboardScoreRank::Representation property :score_string, as: 'scoreString' property :score_tag, as: 'scoreTag' property :score_value, :numeric_string => true, as: 'scoreValue' property :social_rank, as: 'socialRank', class: Google::Apis::GamesV1::LeaderboardScoreRank, decorator: Google::Apis::GamesV1::LeaderboardScoreRank::Representation property :time_span, as: 'timeSpan' property :write_timestamp, :numeric_string => true, as: 'writeTimestamp' end end class ListPlayerLeaderboardScoreResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::PlayerLeaderboardScore, decorator: Google::Apis::GamesV1::PlayerLeaderboardScore::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :player, as: 'player', class: Google::Apis::GamesV1::Player, decorator: Google::Apis::GamesV1::Player::Representation end end class PlayerLevel # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :level, as: 'level' property :max_experience_points, :numeric_string => true, as: 'maxExperiencePoints' property :min_experience_points, :numeric_string => true, as: 'minExperiencePoints' end end class ListPlayerResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::Player, decorator: Google::Apis::GamesV1::Player::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class PlayerScore # @private class Representation < Google::Apis::Core::JsonRepresentation property :formatted_score, as: 'formattedScore' property :kind, as: 'kind' property :score, :numeric_string => true, as: 'score' property :score_tag, as: 'scoreTag' property :time_span, as: 'timeSpan' end end class ListPlayerScoreResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :submitted_scores, as: 'submittedScores', class: Google::Apis::GamesV1::PlayerScoreResponse, decorator: Google::Apis::GamesV1::PlayerScoreResponse::Representation end end class PlayerScoreResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :beaten_score_time_spans, as: 'beatenScoreTimeSpans' property :formatted_score, as: 'formattedScore' property :kind, as: 'kind' property :leaderboard_id, as: 'leaderboardId' property :score_tag, as: 'scoreTag' collection :unbeaten_scores, as: 'unbeatenScores', class: Google::Apis::GamesV1::PlayerScore, decorator: Google::Apis::GamesV1::PlayerScore::Representation end end class PlayerScoreSubmissionList # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :scores, as: 'scores', class: Google::Apis::GamesV1::ScoreSubmission, decorator: Google::Apis::GamesV1::ScoreSubmission::Representation end end class ProfileSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :profile_visible, as: 'profileVisible' end end class PushToken # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_revision, as: 'clientRevision' property :id, as: 'id', class: Google::Apis::GamesV1::PushTokenId, decorator: Google::Apis::GamesV1::PushTokenId::Representation property :kind, as: 'kind' property :language, as: 'language' end end class PushTokenId # @private class Representation < Google::Apis::Core::JsonRepresentation property :ios, as: 'ios', class: Google::Apis::GamesV1::PushTokenId::Ios, decorator: Google::Apis::GamesV1::PushTokenId::Ios::Representation property :kind, as: 'kind' end class Ios # @private class Representation < Google::Apis::Core::JsonRepresentation property :apns_device_token, :base64 => true, as: 'apns_device_token' property :apns_environment, as: 'apns_environment' end end end class Quest # @private class Representation < Google::Apis::Core::JsonRepresentation property :accepted_timestamp_millis, :numeric_string => true, as: 'acceptedTimestampMillis' property :application_id, as: 'applicationId' property :banner_url, as: 'bannerUrl' property :description, as: 'description' property :end_timestamp_millis, :numeric_string => true, as: 'endTimestampMillis' property :icon_url, as: 'iconUrl' property :id, as: 'id' property :is_default_banner_url, as: 'isDefaultBannerUrl' property :is_default_icon_url, as: 'isDefaultIconUrl' property :kind, as: 'kind' property :last_updated_timestamp_millis, :numeric_string => true, as: 'lastUpdatedTimestampMillis' collection :milestones, as: 'milestones', class: Google::Apis::GamesV1::QuestMilestone, decorator: Google::Apis::GamesV1::QuestMilestone::Representation property :name, as: 'name' property :notify_timestamp_millis, :numeric_string => true, as: 'notifyTimestampMillis' property :start_timestamp_millis, :numeric_string => true, as: 'startTimestampMillis' property :state, as: 'state' end end class QuestContribution # @private class Representation < Google::Apis::Core::JsonRepresentation property :formatted_value, as: 'formattedValue' property :kind, as: 'kind' property :value, :numeric_string => true, as: 'value' end end class QuestCriterion # @private class Representation < Google::Apis::Core::JsonRepresentation property :completion_contribution, as: 'completionContribution', class: Google::Apis::GamesV1::QuestContribution, decorator: Google::Apis::GamesV1::QuestContribution::Representation property :current_contribution, as: 'currentContribution', class: Google::Apis::GamesV1::QuestContribution, decorator: Google::Apis::GamesV1::QuestContribution::Representation property :event_id, as: 'eventId' property :initial_player_progress, as: 'initialPlayerProgress', class: Google::Apis::GamesV1::QuestContribution, decorator: Google::Apis::GamesV1::QuestContribution::Representation property :kind, as: 'kind' end end class ListQuestResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::Quest, decorator: Google::Apis::GamesV1::Quest::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class QuestMilestone # @private class Representation < Google::Apis::Core::JsonRepresentation property :completion_reward_data, :base64 => true, as: 'completionRewardData' collection :criteria, as: 'criteria', class: Google::Apis::GamesV1::QuestCriterion, decorator: Google::Apis::GamesV1::QuestCriterion::Representation property :id, as: 'id' property :kind, as: 'kind' property :state, as: 'state' end end class CheckRevisionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_version, as: 'apiVersion' property :kind, as: 'kind' property :revision_status, as: 'revisionStatus' end end class Room # @private class Representation < Google::Apis::Core::JsonRepresentation property :application_id, as: 'applicationId' property :auto_matching_criteria, as: 'autoMatchingCriteria', class: Google::Apis::GamesV1::RoomAutoMatchingCriteria, decorator: Google::Apis::GamesV1::RoomAutoMatchingCriteria::Representation property :auto_matching_status, as: 'autoMatchingStatus', class: Google::Apis::GamesV1::RoomAutoMatchStatus, decorator: Google::Apis::GamesV1::RoomAutoMatchStatus::Representation property :creation_details, as: 'creationDetails', class: Google::Apis::GamesV1::RoomModification, decorator: Google::Apis::GamesV1::RoomModification::Representation property :description, as: 'description' property :inviter_id, as: 'inviterId' property :kind, as: 'kind' property :last_update_details, as: 'lastUpdateDetails', class: Google::Apis::GamesV1::RoomModification, decorator: Google::Apis::GamesV1::RoomModification::Representation collection :participants, as: 'participants', class: Google::Apis::GamesV1::RoomParticipant, decorator: Google::Apis::GamesV1::RoomParticipant::Representation property :room_id, as: 'roomId' property :room_status_version, as: 'roomStatusVersion' property :status, as: 'status' property :variant, as: 'variant' end end class RoomAutoMatchStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :wait_estimate_seconds, as: 'waitEstimateSeconds' end end class RoomAutoMatchingCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation property :exclusive_bitmask, :numeric_string => true, as: 'exclusiveBitmask' property :kind, as: 'kind' property :max_auto_matching_players, as: 'maxAutoMatchingPlayers' property :min_auto_matching_players, as: 'minAutoMatchingPlayers' end end class RoomClientAddress # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :xmpp_address, as: 'xmppAddress' end end class CreateRoomRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_matching_criteria, as: 'autoMatchingCriteria', class: Google::Apis::GamesV1::RoomAutoMatchingCriteria, decorator: Google::Apis::GamesV1::RoomAutoMatchingCriteria::Representation collection :capabilities, as: 'capabilities' property :client_address, as: 'clientAddress', class: Google::Apis::GamesV1::RoomClientAddress, decorator: Google::Apis::GamesV1::RoomClientAddress::Representation collection :invited_player_ids, as: 'invitedPlayerIds' property :kind, as: 'kind' property :network_diagnostics, as: 'networkDiagnostics', class: Google::Apis::GamesV1::NetworkDiagnostics, decorator: Google::Apis::GamesV1::NetworkDiagnostics::Representation property :request_id, :numeric_string => true, as: 'requestId' property :variant, as: 'variant' end end class JoinRoomRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :capabilities, as: 'capabilities' property :client_address, as: 'clientAddress', class: Google::Apis::GamesV1::RoomClientAddress, decorator: Google::Apis::GamesV1::RoomClientAddress::Representation property :kind, as: 'kind' property :network_diagnostics, as: 'networkDiagnostics', class: Google::Apis::GamesV1::NetworkDiagnostics, decorator: Google::Apis::GamesV1::NetworkDiagnostics::Representation end end class RoomLeaveDiagnostics # @private class Representation < Google::Apis::Core::JsonRepresentation property :android_network_subtype, as: 'androidNetworkSubtype' property :android_network_type, as: 'androidNetworkType' property :ios_network_type, as: 'iosNetworkType' property :kind, as: 'kind' property :network_operator_code, as: 'networkOperatorCode' property :network_operator_name, as: 'networkOperatorName' collection :peer_session, as: 'peerSession', class: Google::Apis::GamesV1::PeerSessionDiagnostics, decorator: Google::Apis::GamesV1::PeerSessionDiagnostics::Representation property :sockets_used, as: 'socketsUsed' end end class LeaveRoomRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :leave_diagnostics, as: 'leaveDiagnostics', class: Google::Apis::GamesV1::RoomLeaveDiagnostics, decorator: Google::Apis::GamesV1::RoomLeaveDiagnostics::Representation property :reason, as: 'reason' end end class RoomList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::Room, decorator: Google::Apis::GamesV1::Room::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class RoomModification # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :modified_timestamp_millis, :numeric_string => true, as: 'modifiedTimestampMillis' property :participant_id, as: 'participantId' end end class RoomP2PStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :connection_setup_latency_millis, as: 'connectionSetupLatencyMillis' property :error, as: 'error' property :error_reason, as: 'error_reason' property :kind, as: 'kind' property :participant_id, as: 'participantId' property :status, as: 'status' property :unreliable_roundtrip_latency_millis, as: 'unreliableRoundtripLatencyMillis' end end class RoomP2PStatuses # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :updates, as: 'updates', class: Google::Apis::GamesV1::RoomP2PStatus, decorator: Google::Apis::GamesV1::RoomP2PStatus::Representation end end class RoomParticipant # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_matched, as: 'autoMatched' property :auto_matched_player, as: 'autoMatchedPlayer', class: Google::Apis::GamesV1::AnonymousPlayer, decorator: Google::Apis::GamesV1::AnonymousPlayer::Representation collection :capabilities, as: 'capabilities' property :client_address, as: 'clientAddress', class: Google::Apis::GamesV1::RoomClientAddress, decorator: Google::Apis::GamesV1::RoomClientAddress::Representation property :connected, as: 'connected' property :id, as: 'id' property :kind, as: 'kind' property :leave_reason, as: 'leaveReason' property :player, as: 'player', class: Google::Apis::GamesV1::Player, decorator: Google::Apis::GamesV1::Player::Representation property :status, as: 'status' end end class RoomStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_matching_status, as: 'autoMatchingStatus', class: Google::Apis::GamesV1::RoomAutoMatchStatus, decorator: Google::Apis::GamesV1::RoomAutoMatchStatus::Representation property :kind, as: 'kind' collection :participants, as: 'participants', class: Google::Apis::GamesV1::RoomParticipant, decorator: Google::Apis::GamesV1::RoomParticipant::Representation property :room_id, as: 'roomId' property :status, as: 'status' property :status_version, as: 'statusVersion' end end class ScoreSubmission # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :leaderboard_id, as: 'leaderboardId' property :score, :numeric_string => true, as: 'score' property :score_tag, as: 'scoreTag' property :signature, as: 'signature' end end class Snapshot # @private class Representation < Google::Apis::Core::JsonRepresentation property :cover_image, as: 'coverImage', class: Google::Apis::GamesV1::SnapshotImage, decorator: Google::Apis::GamesV1::SnapshotImage::Representation property :description, as: 'description' property :drive_id, as: 'driveId' property :duration_millis, :numeric_string => true, as: 'durationMillis' property :id, as: 'id' property :kind, as: 'kind' property :last_modified_millis, :numeric_string => true, as: 'lastModifiedMillis' property :progress_value, :numeric_string => true, as: 'progressValue' property :title, as: 'title' property :type, as: 'type' property :unique_name, as: 'uniqueName' end end class SnapshotImage # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :kind, as: 'kind' property :mime_type, as: 'mime_type' property :url, as: 'url' property :width, as: 'width' end end class ListSnapshotResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::Snapshot, decorator: Google::Apis::GamesV1::Snapshot::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class TurnBasedAutoMatchingCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation property :exclusive_bitmask, :numeric_string => true, as: 'exclusiveBitmask' property :kind, as: 'kind' property :max_auto_matching_players, as: 'maxAutoMatchingPlayers' property :min_auto_matching_players, as: 'minAutoMatchingPlayers' end end class TurnBasedMatch # @private class Representation < Google::Apis::Core::JsonRepresentation property :application_id, as: 'applicationId' property :auto_matching_criteria, as: 'autoMatchingCriteria', class: Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria, decorator: Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria::Representation property :creation_details, as: 'creationDetails', class: Google::Apis::GamesV1::TurnBasedMatchModification, decorator: Google::Apis::GamesV1::TurnBasedMatchModification::Representation property :data, as: 'data', class: Google::Apis::GamesV1::TurnBasedMatchData, decorator: Google::Apis::GamesV1::TurnBasedMatchData::Representation property :description, as: 'description' property :inviter_id, as: 'inviterId' property :kind, as: 'kind' property :last_update_details, as: 'lastUpdateDetails', class: Google::Apis::GamesV1::TurnBasedMatchModification, decorator: Google::Apis::GamesV1::TurnBasedMatchModification::Representation property :match_id, as: 'matchId' property :match_number, as: 'matchNumber' property :match_version, as: 'matchVersion' collection :participants, as: 'participants', class: Google::Apis::GamesV1::TurnBasedMatchParticipant, decorator: Google::Apis::GamesV1::TurnBasedMatchParticipant::Representation property :pending_participant_id, as: 'pendingParticipantId' property :previous_match_data, as: 'previousMatchData', class: Google::Apis::GamesV1::TurnBasedMatchData, decorator: Google::Apis::GamesV1::TurnBasedMatchData::Representation property :rematch_id, as: 'rematchId' collection :results, as: 'results', class: Google::Apis::GamesV1::ParticipantResult, decorator: Google::Apis::GamesV1::ParticipantResult::Representation property :status, as: 'status' property :user_match_status, as: 'userMatchStatus' property :variant, as: 'variant' property :with_participant_id, as: 'withParticipantId' end end class CreateTurnBasedMatchRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_matching_criteria, as: 'autoMatchingCriteria', class: Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria, decorator: Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria::Representation collection :invited_player_ids, as: 'invitedPlayerIds' property :kind, as: 'kind' property :request_id, :numeric_string => true, as: 'requestId' property :variant, as: 'variant' end end class TurnBasedMatchData # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, :base64 => true, as: 'data' property :data_available, as: 'dataAvailable' property :kind, as: 'kind' end end class TurnBasedMatchDataRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, :base64 => true, as: 'data' property :kind, as: 'kind' end end class TurnBasedMatchList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::TurnBasedMatch, decorator: Google::Apis::GamesV1::TurnBasedMatch::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class TurnBasedMatchModification # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :modified_timestamp_millis, :numeric_string => true, as: 'modifiedTimestampMillis' property :participant_id, as: 'participantId' end end class TurnBasedMatchParticipant # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_matched, as: 'autoMatched' property :auto_matched_player, as: 'autoMatchedPlayer', class: Google::Apis::GamesV1::AnonymousPlayer, decorator: Google::Apis::GamesV1::AnonymousPlayer::Representation property :id, as: 'id' property :kind, as: 'kind' property :player, as: 'player', class: Google::Apis::GamesV1::Player, decorator: Google::Apis::GamesV1::Player::Representation property :status, as: 'status' end end class TurnBasedMatchRematch # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :previous_match, as: 'previousMatch', class: Google::Apis::GamesV1::TurnBasedMatch, decorator: Google::Apis::GamesV1::TurnBasedMatch::Representation property :rematch, as: 'rematch', class: Google::Apis::GamesV1::TurnBasedMatch, decorator: Google::Apis::GamesV1::TurnBasedMatch::Representation end end class TurnBasedMatchResults # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, as: 'data', class: Google::Apis::GamesV1::TurnBasedMatchDataRequest, decorator: Google::Apis::GamesV1::TurnBasedMatchDataRequest::Representation property :kind, as: 'kind' property :match_version, as: 'matchVersion' collection :results, as: 'results', class: Google::Apis::GamesV1::ParticipantResult, decorator: Google::Apis::GamesV1::ParticipantResult::Representation end end class TurnBasedMatchSync # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesV1::TurnBasedMatch, decorator: Google::Apis::GamesV1::TurnBasedMatch::Representation property :kind, as: 'kind' property :more_available, as: 'moreAvailable' property :next_page_token, as: 'nextPageToken' end end class TurnBasedMatchTurn # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, as: 'data', class: Google::Apis::GamesV1::TurnBasedMatchDataRequest, decorator: Google::Apis::GamesV1::TurnBasedMatchDataRequest::Representation property :kind, as: 'kind' property :match_version, as: 'matchVersion' property :pending_participant_id, as: 'pendingParticipantId' collection :results, as: 'results', class: Google::Apis::GamesV1::ParticipantResult, decorator: Google::Apis::GamesV1::ParticipantResult::Representation end end end end end google-api-client-0.19.8/generated/google/apis/games_v1/classes.rb0000644000004100000410000056017713252673043025017 0ustar www-datawww-data# 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 GamesV1 # This is a JSON template for an achievement definition object. class AchievementDefinition include Google::Apis::Core::Hashable # The type of the achievement. # Possible values are: # - "STANDARD" - Achievement is either locked or unlocked. # - "INCREMENTAL" - Achievement is incremental. # Corresponds to the JSON property `achievementType` # @return [String] attr_accessor :achievement_type # The description of the achievement. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Experience points which will be earned when unlocking this achievement. # Corresponds to the JSON property `experiencePoints` # @return [Fixnum] attr_accessor :experience_points # The total steps for an incremental achievement as a string. # Corresponds to the JSON property `formattedTotalSteps` # @return [String] attr_accessor :formatted_total_steps # The ID of the achievement. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The initial state of the achievement. # Possible values are: # - "HIDDEN" - Achievement is hidden. # - "REVEALED" - Achievement is revealed. # - "UNLOCKED" - Achievement is unlocked. # Corresponds to the JSON property `initialState` # @return [String] attr_accessor :initial_state # Indicates whether the revealed icon image being returned is a default image, # or is provided by the game. # Corresponds to the JSON property `isRevealedIconUrlDefault` # @return [Boolean] attr_accessor :is_revealed_icon_url_default alias_method :is_revealed_icon_url_default?, :is_revealed_icon_url_default # Indicates whether the unlocked icon image being returned is a default image, # or is game-provided. # Corresponds to the JSON property `isUnlockedIconUrlDefault` # @return [Boolean] attr_accessor :is_unlocked_icon_url_default alias_method :is_unlocked_icon_url_default?, :is_unlocked_icon_url_default # Uniquely identifies the type of this resource. Value is always the fixed # string games#achievementDefinition. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the achievement. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The image URL for the revealed achievement icon. # Corresponds to the JSON property `revealedIconUrl` # @return [String] attr_accessor :revealed_icon_url # The total steps for an incremental achievement. # Corresponds to the JSON property `totalSteps` # @return [Fixnum] attr_accessor :total_steps # The image URL for the unlocked achievement icon. # Corresponds to the JSON property `unlockedIconUrl` # @return [String] attr_accessor :unlocked_icon_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @achievement_type = args[:achievement_type] if args.key?(:achievement_type) @description = args[:description] if args.key?(:description) @experience_points = args[:experience_points] if args.key?(:experience_points) @formatted_total_steps = args[:formatted_total_steps] if args.key?(:formatted_total_steps) @id = args[:id] if args.key?(:id) @initial_state = args[:initial_state] if args.key?(:initial_state) @is_revealed_icon_url_default = args[:is_revealed_icon_url_default] if args.key?(:is_revealed_icon_url_default) @is_unlocked_icon_url_default = args[:is_unlocked_icon_url_default] if args.key?(:is_unlocked_icon_url_default) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @revealed_icon_url = args[:revealed_icon_url] if args.key?(:revealed_icon_url) @total_steps = args[:total_steps] if args.key?(:total_steps) @unlocked_icon_url = args[:unlocked_icon_url] if args.key?(:unlocked_icon_url) end end # This is a JSON template for a list of achievement definition objects. class ListAchievementDefinitionsResponse include Google::Apis::Core::Hashable # The achievement definitions. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#achievementDefinitionsListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token corresponding to 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) @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) end end # This is a JSON template for an achievement increment response class AchievementIncrementResponse include Google::Apis::Core::Hashable # The current steps recorded for this incremental achievement. # Corresponds to the JSON property `currentSteps` # @return [Fixnum] attr_accessor :current_steps # Uniquely identifies the type of this resource. Value is always the fixed # string games#achievementIncrementResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Whether the current steps for the achievement has reached the number of steps # required to unlock. # Corresponds to the JSON property `newlyUnlocked` # @return [Boolean] attr_accessor :newly_unlocked alias_method :newly_unlocked?, :newly_unlocked def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_steps = args[:current_steps] if args.key?(:current_steps) @kind = args[:kind] if args.key?(:kind) @newly_unlocked = args[:newly_unlocked] if args.key?(:newly_unlocked) end end # This is a JSON template for an achievement reveal response class AchievementRevealResponse include Google::Apis::Core::Hashable # The current state of the achievement for which a reveal was attempted. This # might be UNLOCKED if the achievement was already unlocked. # Possible values are: # - "REVEALED" - Achievement is revealed. # - "UNLOCKED" - Achievement is unlocked. # Corresponds to the JSON property `currentState` # @return [String] attr_accessor :current_state # Uniquely identifies the type of this resource. Value is always the fixed # string games#achievementRevealResponse. # 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) @current_state = args[:current_state] if args.key?(:current_state) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for an achievement set steps at least response. class AchievementSetStepsAtLeastResponse include Google::Apis::Core::Hashable # The current steps recorded for this incremental achievement. # Corresponds to the JSON property `currentSteps` # @return [Fixnum] attr_accessor :current_steps # Uniquely identifies the type of this resource. Value is always the fixed # string games#achievementSetStepsAtLeastResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Whether the the current steps for the achievement has reached the number of # steps required to unlock. # Corresponds to the JSON property `newlyUnlocked` # @return [Boolean] attr_accessor :newly_unlocked alias_method :newly_unlocked?, :newly_unlocked def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_steps = args[:current_steps] if args.key?(:current_steps) @kind = args[:kind] if args.key?(:kind) @newly_unlocked = args[:newly_unlocked] if args.key?(:newly_unlocked) end end # This is a JSON template for an achievement unlock response class AchievementUnlockResponse include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#achievementUnlockResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Whether this achievement was newly unlocked (that is, whether the unlock # request for the achievement was the first for the player). # Corresponds to the JSON property `newlyUnlocked` # @return [Boolean] attr_accessor :newly_unlocked alias_method :newly_unlocked?, :newly_unlocked def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @newly_unlocked = args[:newly_unlocked] if args.key?(:newly_unlocked) end end # This is a JSON template for a list of achievement update requests. class AchievementUpdateMultipleRequest include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#achievementUpdateMultipleRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The individual achievement update requests. # Corresponds to the JSON property `updates` # @return [Array] attr_accessor :updates def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @updates = args[:updates] if args.key?(:updates) end end # This is a JSON template for an achievement unlock response. class AchievementUpdateMultipleResponse include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#achievementUpdateListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The updated state of the achievements. # Corresponds to the JSON property `updatedAchievements` # @return [Array] attr_accessor :updated_achievements def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @updated_achievements = args[:updated_achievements] if args.key?(:updated_achievements) end end # This is a JSON template for a request to update an achievement. class UpdateAchievementRequest include Google::Apis::Core::Hashable # The achievement this update is being applied to. # Corresponds to the JSON property `achievementId` # @return [String] attr_accessor :achievement_id # This is a JSON template for the payload to request to increment an achievement. # Corresponds to the JSON property `incrementPayload` # @return [Google::Apis::GamesV1::GamesAchievementIncrement] attr_accessor :increment_payload # Uniquely identifies the type of this resource. Value is always the fixed # string games#achievementUpdateRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for the payload to request to increment an achievement. # Corresponds to the JSON property `setStepsAtLeastPayload` # @return [Google::Apis::GamesV1::GamesAchievementSetStepsAtLeast] attr_accessor :set_steps_at_least_payload # The type of update being applied. # Possible values are: # - "REVEAL" - Achievement is revealed. # - "UNLOCK" - Achievement is unlocked. # - "INCREMENT" - Achievement is incremented. # - "SET_STEPS_AT_LEAST" - Achievement progress is set to at least the passed # value. # Corresponds to the JSON property `updateType` # @return [String] attr_accessor :update_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @achievement_id = args[:achievement_id] if args.key?(:achievement_id) @increment_payload = args[:increment_payload] if args.key?(:increment_payload) @kind = args[:kind] if args.key?(:kind) @set_steps_at_least_payload = args[:set_steps_at_least_payload] if args.key?(:set_steps_at_least_payload) @update_type = args[:update_type] if args.key?(:update_type) end end # This is a JSON template for an achievement update response. class UpdateAchievementResponse include Google::Apis::Core::Hashable # The achievement this update is was applied to. # Corresponds to the JSON property `achievementId` # @return [String] attr_accessor :achievement_id # The current state of the achievement. # Possible values are: # - "HIDDEN" - Achievement is hidden. # - "REVEALED" - Achievement is revealed. # - "UNLOCKED" - Achievement is unlocked. # Corresponds to the JSON property `currentState` # @return [String] attr_accessor :current_state # The current steps recorded for this achievement if it is incremental. # Corresponds to the JSON property `currentSteps` # @return [Fixnum] attr_accessor :current_steps # Uniquely identifies the type of this resource. Value is always the fixed # string games#achievementUpdateResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Whether this achievement was newly unlocked (that is, whether the unlock # request for the achievement was the first for the player). # Corresponds to the JSON property `newlyUnlocked` # @return [Boolean] attr_accessor :newly_unlocked alias_method :newly_unlocked?, :newly_unlocked # Whether the requested updates actually affected the achievement. # Corresponds to the JSON property `updateOccurred` # @return [Boolean] attr_accessor :update_occurred alias_method :update_occurred?, :update_occurred def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @achievement_id = args[:achievement_id] if args.key?(:achievement_id) @current_state = args[:current_state] if args.key?(:current_state) @current_steps = args[:current_steps] if args.key?(:current_steps) @kind = args[:kind] if args.key?(:kind) @newly_unlocked = args[:newly_unlocked] if args.key?(:newly_unlocked) @update_occurred = args[:update_occurred] if args.key?(:update_occurred) end end # This is a JSON template for aggregate stats. class AggregateStats include Google::Apis::Core::Hashable # The number of messages sent between a pair of peers. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # Uniquely identifies the type of this resource. Value is always the fixed # string games#aggregateStats. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The maximum amount. # Corresponds to the JSON property `max` # @return [Fixnum] attr_accessor :max # The minimum amount. # Corresponds to the JSON property `min` # @return [Fixnum] attr_accessor :min # The total number of bytes sent for messages between a pair of peers. # Corresponds to the JSON property `sum` # @return [Fixnum] attr_accessor :sum def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @count = args[:count] if args.key?(:count) @kind = args[:kind] if args.key?(:kind) @max = args[:max] if args.key?(:max) @min = args[:min] if args.key?(:min) @sum = args[:sum] if args.key?(:sum) end end # This is a JSON template for an anonymous player class AnonymousPlayer include Google::Apis::Core::Hashable # The base URL for the image to display for the anonymous player. # Corresponds to the JSON property `avatarImageUrl` # @return [String] attr_accessor :avatar_image_url # The name to display for the anonymous player. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Uniquely identifies the type of this resource. Value is always the fixed # string games#anonymousPlayer. # 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) @avatar_image_url = args[:avatar_image_url] if args.key?(:avatar_image_url) @display_name = args[:display_name] if args.key?(:display_name) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for the Application resource. class Application include Google::Apis::Core::Hashable # The number of achievements visible to the currently authenticated player. # Corresponds to the JSON property `achievement_count` # @return [Fixnum] attr_accessor :achievement_count # The assets of the application. # Corresponds to the JSON property `assets` # @return [Array] attr_accessor :assets # The author of the application. # Corresponds to the JSON property `author` # @return [String] attr_accessor :author # This is a JSON template for an application category object. # Corresponds to the JSON property `category` # @return [Google::Apis::GamesV1::ApplicationCategory] attr_accessor :category # The description of the application. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # A list of features that have been enabled for the application. # Possible values are: # - "SNAPSHOTS" - Snapshots has been enabled # Corresponds to the JSON property `enabledFeatures` # @return [Array] attr_accessor :enabled_features # The ID of the application. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The instances of the application. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances # Uniquely identifies the type of this resource. Value is always the fixed # string games#application. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The last updated timestamp of the application. # Corresponds to the JSON property `lastUpdatedTimestamp` # @return [Fixnum] attr_accessor :last_updated_timestamp # The number of leaderboards visible to the currently authenticated player. # Corresponds to the JSON property `leaderboard_count` # @return [Fixnum] attr_accessor :leaderboard_count # The name of the application. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A hint to the client UI for what color to use as an app-themed color. The # color is given as an RGB triplet (e.g. "E0E0E0"). # Corresponds to the JSON property `themeColor` # @return [String] attr_accessor :theme_color def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @achievement_count = args[:achievement_count] if args.key?(:achievement_count) @assets = args[:assets] if args.key?(:assets) @author = args[:author] if args.key?(:author) @category = args[:category] if args.key?(:category) @description = args[:description] if args.key?(:description) @enabled_features = args[:enabled_features] if args.key?(:enabled_features) @id = args[:id] if args.key?(:id) @instances = args[:instances] if args.key?(:instances) @kind = args[:kind] if args.key?(:kind) @last_updated_timestamp = args[:last_updated_timestamp] if args.key?(:last_updated_timestamp) @leaderboard_count = args[:leaderboard_count] if args.key?(:leaderboard_count) @name = args[:name] if args.key?(:name) @theme_color = args[:theme_color] if args.key?(:theme_color) end end # This is a JSON template for an application category object. class ApplicationCategory include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#applicationCategory. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The primary category. # Corresponds to the JSON property `primary` # @return [String] attr_accessor :primary # The secondary category. # Corresponds to the JSON property `secondary` # @return [String] attr_accessor :secondary def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @primary = args[:primary] if args.key?(:primary) @secondary = args[:secondary] if args.key?(:secondary) end end # This is a JSON template for a third party application verification response # resource. class ApplicationVerifyResponse include Google::Apis::Core::Hashable # An alternate ID that was once used for the player that was issued the auth # token used in this request. (This field is not normally populated.) # Corresponds to the JSON property `alternate_player_id` # @return [String] attr_accessor :alternate_player_id # Uniquely identifies the type of this resource. Value is always the fixed # string games#applicationVerifyResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The ID of the player that was issued the auth token used in this request. # Corresponds to the JSON property `player_id` # @return [String] attr_accessor :player_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alternate_player_id = args[:alternate_player_id] if args.key?(:alternate_player_id) @kind = args[:kind] if args.key?(:kind) @player_id = args[:player_id] if args.key?(:player_id) end end # This is a JSON template for data related to individual game categories. class Category include Google::Apis::Core::Hashable # The category name. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category # Experience points earned in this category. # Corresponds to the JSON property `experiencePoints` # @return [Fixnum] attr_accessor :experience_points # Uniquely identifies the type of this resource. Value is always the fixed # string games#category. # 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) @category = args[:category] if args.key?(:category) @experience_points = args[:experience_points] if args.key?(:experience_points) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for a list of category data objects. class ListCategoryResponse include Google::Apis::Core::Hashable # The list of categories with usage data. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#categoryListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token corresponding to 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) @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) end end # This is a JSON template for a batch update failure resource. class EventBatchRecordFailure include Google::Apis::Core::Hashable # The cause for the update failure. # Possible values are: # - "TOO_LARGE": A batch request was issued with more events than are allowed in # a single batch. # - "TIME_PERIOD_EXPIRED": A batch was sent with data too far in the past to # record. # - "TIME_PERIOD_SHORT": A batch was sent with a time range that was too short. # - "TIME_PERIOD_LONG": A batch was sent with a time range that was too long. # - "ALREADY_UPDATED": An attempt was made to record a batch of data which was # already seen. # - "RECORD_RATE_HIGH": An attempt was made to record data faster than the # server will apply updates. # Corresponds to the JSON property `failureCause` # @return [String] attr_accessor :failure_cause # Uniquely identifies the type of this resource. Value is always the fixed # string games#eventBatchRecordFailure. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for an event period time range. # Corresponds to the JSON property `range` # @return [Google::Apis::GamesV1::EventPeriodRange] attr_accessor :range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @failure_cause = args[:failure_cause] if args.key?(:failure_cause) @kind = args[:kind] if args.key?(:kind) @range = args[:range] if args.key?(:range) end end # This is a JSON template for an event child relationship resource. class EventChild include Google::Apis::Core::Hashable # The ID of the child event. # Corresponds to the JSON property `childId` # @return [String] attr_accessor :child_id # Uniquely identifies the type of this resource. Value is always the fixed # string games#eventChild. # 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) @child_id = args[:child_id] if args.key?(:child_id) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for an event definition resource. class EventDefinition include Google::Apis::Core::Hashable # A list of events that are a child of this event. # Corresponds to the JSON property `childEvents` # @return [Array] attr_accessor :child_events # Description of what this event represents. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The name to display for the event. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The ID of the event. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The base URL for the image that represents the event. # Corresponds to the JSON property `imageUrl` # @return [String] attr_accessor :image_url # Indicates whether the icon image being returned is a default image, or is game- # provided. # Corresponds to the JSON property `isDefaultImageUrl` # @return [Boolean] attr_accessor :is_default_image_url alias_method :is_default_image_url?, :is_default_image_url # Uniquely identifies the type of this resource. Value is always the fixed # string games#eventDefinition. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The visibility of event being tracked in this definition. # Possible values are: # - "REVEALED": This event should be visible to all users. # - "HIDDEN": This event should only be shown to users that have recorded this # event at least once. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @child_events = args[:child_events] if args.key?(:child_events) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @image_url = args[:image_url] if args.key?(:image_url) @is_default_image_url = args[:is_default_image_url] if args.key?(:is_default_image_url) @kind = args[:kind] if args.key?(:kind) @visibility = args[:visibility] if args.key?(:visibility) end end # This is a JSON template for a ListDefinitions response. class ListEventDefinitionResponse include Google::Apis::Core::Hashable # The event definitions. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#eventDefinitionListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The pagination token for 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) @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) end end # This is a JSON template for an event period time range. class EventPeriodRange include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#eventPeriodRange. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch). # Corresponds to the JSON property `periodEndMillis` # @return [Fixnum] attr_accessor :period_end_millis # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch) # . # Corresponds to the JSON property `periodStartMillis` # @return [Fixnum] attr_accessor :period_start_millis def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @period_end_millis = args[:period_end_millis] if args.key?(:period_end_millis) @period_start_millis = args[:period_start_millis] if args.key?(:period_start_millis) end end # This is a JSON template for an event period update resource. class EventPeriodUpdate include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#eventPeriodUpdate. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for an event period time range. # Corresponds to the JSON property `timePeriod` # @return [Google::Apis::GamesV1::EventPeriodRange] attr_accessor :time_period # The updates being made for this time period. # Corresponds to the JSON property `updates` # @return [Array] attr_accessor :updates def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @time_period = args[:time_period] if args.key?(:time_period) @updates = args[:updates] if args.key?(:updates) end end # This is a JSON template for an event update failure resource. class EventRecordFailure include Google::Apis::Core::Hashable # The ID of the event that was not updated. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # The cause for the update failure. # Possible values are: # - "NOT_FOUND" - An attempt was made to set an event that was not defined. # - "INVALID_UPDATE_VALUE" - An attempt was made to increment an event by a non- # positive value. # Corresponds to the JSON property `failureCause` # @return [String] attr_accessor :failure_cause # Uniquely identifies the type of this resource. Value is always the fixed # string games#eventRecordFailure. # 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) @event_id = args[:event_id] if args.key?(:event_id) @failure_cause = args[:failure_cause] if args.key?(:failure_cause) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for an event period update resource. class EventRecordRequest include Google::Apis::Core::Hashable # The current time when this update was sent, in milliseconds, since 1970 UTC ( # Unix Epoch). # Corresponds to the JSON property `currentTimeMillis` # @return [Fixnum] attr_accessor :current_time_millis # Uniquely identifies the type of this resource. Value is always the fixed # string games#eventRecordRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The request ID used to identify this attempt to record events. # Corresponds to the JSON property `requestId` # @return [Fixnum] attr_accessor :request_id # A list of the time period updates being made in this request. # Corresponds to the JSON property `timePeriods` # @return [Array] attr_accessor :time_periods def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_time_millis = args[:current_time_millis] if args.key?(:current_time_millis) @kind = args[:kind] if args.key?(:kind) @request_id = args[:request_id] if args.key?(:request_id) @time_periods = args[:time_periods] if args.key?(:time_periods) end end # This is a JSON template for an event period update resource. class UpdateEventRequest include Google::Apis::Core::Hashable # The ID of the event being modified in this update. # Corresponds to the JSON property `definitionId` # @return [String] attr_accessor :definition_id # Uniquely identifies the type of this resource. Value is always the fixed # string games#eventUpdateRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The number of times this event occurred in this time period. # Corresponds to the JSON property `updateCount` # @return [Fixnum] attr_accessor :update_count def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @definition_id = args[:definition_id] if args.key?(:definition_id) @kind = args[:kind] if args.key?(:kind) @update_count = args[:update_count] if args.key?(:update_count) end end # This is a JSON template for an event period update resource. class UpdateEventResponse include Google::Apis::Core::Hashable # Any batch-wide failures which occurred applying updates. # Corresponds to the JSON property `batchFailures` # @return [Array] attr_accessor :batch_failures # Any failures updating a particular event. # Corresponds to the JSON property `eventFailures` # @return [Array] attr_accessor :event_failures # Uniquely identifies the type of this resource. Value is always the fixed # string games#eventUpdateResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The current status of any updated events # Corresponds to the JSON property `playerEvents` # @return [Array] attr_accessor :player_events def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_failures = args[:batch_failures] if args.key?(:batch_failures) @event_failures = args[:event_failures] if args.key?(:event_failures) @kind = args[:kind] if args.key?(:kind) @player_events = args[:player_events] if args.key?(:player_events) end end # This is a JSON template for the payload to request to increment an achievement. class GamesAchievementIncrement include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#GamesAchievementIncrement. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The requestId associated with an increment to an achievement. # Corresponds to the JSON property `requestId` # @return [Fixnum] attr_accessor :request_id # The number of steps to be incremented. # Corresponds to the JSON property `steps` # @return [Fixnum] attr_accessor :steps def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @request_id = args[:request_id] if args.key?(:request_id) @steps = args[:steps] if args.key?(:steps) end end # This is a JSON template for the payload to request to increment an achievement. class GamesAchievementSetStepsAtLeast include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#GamesAchievementSetStepsAtLeast. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The minimum number of steps for the achievement to be set to. # Corresponds to the JSON property `steps` # @return [Fixnum] attr_accessor :steps def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @steps = args[:steps] if args.key?(:steps) end end # This is a JSON template for an image asset object. class ImageAsset include Google::Apis::Core::Hashable # The height of the asset. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Uniquely identifies the type of this resource. Value is always the fixed # string games#imageAsset. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the asset. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The URL of the asset. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width of the asset. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end # This is a JSON template for the Instance resource. class Instance include Google::Apis::Core::Hashable # URI which shows where a user can acquire this instance. # Corresponds to the JSON property `acquisitionUri` # @return [String] attr_accessor :acquisition_uri # This is a JSON template for the Android instance details resource. # Corresponds to the JSON property `androidInstance` # @return [Google::Apis::GamesV1::InstanceAndroidDetails] attr_accessor :android_instance # This is a JSON template for the iOS details resource. # Corresponds to the JSON property `iosInstance` # @return [Google::Apis::GamesV1::InstanceIosDetails] attr_accessor :ios_instance # Uniquely identifies the type of this resource. Value is always the fixed # string games#instance. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Localized display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The platform type. # Possible values are: # - "ANDROID" - Instance is for Android. # - "IOS" - Instance is for iOS # - "WEB_APP" - Instance is for Web App. # Corresponds to the JSON property `platformType` # @return [String] attr_accessor :platform_type # Flag to show if this game instance supports realtime play. # Corresponds to the JSON property `realtimePlay` # @return [Boolean] attr_accessor :realtime_play alias_method :realtime_play?, :realtime_play # Flag to show if this game instance supports turn based play. # Corresponds to the JSON property `turnBasedPlay` # @return [Boolean] attr_accessor :turn_based_play alias_method :turn_based_play?, :turn_based_play # This is a JSON template for the Web details resource. # Corresponds to the JSON property `webInstance` # @return [Google::Apis::GamesV1::InstanceWebDetails] attr_accessor :web_instance def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @acquisition_uri = args[:acquisition_uri] if args.key?(:acquisition_uri) @android_instance = args[:android_instance] if args.key?(:android_instance) @ios_instance = args[:ios_instance] if args.key?(:ios_instance) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @platform_type = args[:platform_type] if args.key?(:platform_type) @realtime_play = args[:realtime_play] if args.key?(:realtime_play) @turn_based_play = args[:turn_based_play] if args.key?(:turn_based_play) @web_instance = args[:web_instance] if args.key?(:web_instance) end end # This is a JSON template for the Android instance details resource. class InstanceAndroidDetails include Google::Apis::Core::Hashable # Flag indicating whether the anti-piracy check is enabled. # Corresponds to the JSON property `enablePiracyCheck` # @return [Boolean] attr_accessor :enable_piracy_check alias_method :enable_piracy_check?, :enable_piracy_check # Uniquely identifies the type of this resource. Value is always the fixed # string games#instanceAndroidDetails. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Android package name which maps to Google Play URL. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name # Indicates that this instance is the default for new installations. # Corresponds to the JSON property `preferred` # @return [Boolean] attr_accessor :preferred alias_method :preferred?, :preferred def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enable_piracy_check = args[:enable_piracy_check] if args.key?(:enable_piracy_check) @kind = args[:kind] if args.key?(:kind) @package_name = args[:package_name] if args.key?(:package_name) @preferred = args[:preferred] if args.key?(:preferred) end end # This is a JSON template for the iOS details resource. class InstanceIosDetails include Google::Apis::Core::Hashable # Bundle identifier. # Corresponds to the JSON property `bundleIdentifier` # @return [String] attr_accessor :bundle_identifier # iTunes App ID. # Corresponds to the JSON property `itunesAppId` # @return [String] attr_accessor :itunes_app_id # Uniquely identifies the type of this resource. Value is always the fixed # string games#instanceIosDetails. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Indicates that this instance is the default for new installations on iPad # devices. # Corresponds to the JSON property `preferredForIpad` # @return [Boolean] attr_accessor :preferred_for_ipad alias_method :preferred_for_ipad?, :preferred_for_ipad # Indicates that this instance is the default for new installations on iPhone # devices. # Corresponds to the JSON property `preferredForIphone` # @return [Boolean] attr_accessor :preferred_for_iphone alias_method :preferred_for_iphone?, :preferred_for_iphone # Flag to indicate if this instance supports iPad. # Corresponds to the JSON property `supportIpad` # @return [Boolean] attr_accessor :support_ipad alias_method :support_ipad?, :support_ipad # Flag to indicate if this instance supports iPhone. # Corresponds to the JSON property `supportIphone` # @return [Boolean] attr_accessor :support_iphone alias_method :support_iphone?, :support_iphone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bundle_identifier = args[:bundle_identifier] if args.key?(:bundle_identifier) @itunes_app_id = args[:itunes_app_id] if args.key?(:itunes_app_id) @kind = args[:kind] if args.key?(:kind) @preferred_for_ipad = args[:preferred_for_ipad] if args.key?(:preferred_for_ipad) @preferred_for_iphone = args[:preferred_for_iphone] if args.key?(:preferred_for_iphone) @support_ipad = args[:support_ipad] if args.key?(:support_ipad) @support_iphone = args[:support_iphone] if args.key?(:support_iphone) end end # This is a JSON template for the Web details resource. class InstanceWebDetails include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#instanceWebDetails. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Launch URL for the game. # Corresponds to the JSON property `launchUrl` # @return [String] attr_accessor :launch_url # Indicates that this instance is the default for new installations. # Corresponds to the JSON property `preferred` # @return [Boolean] attr_accessor :preferred alias_method :preferred?, :preferred def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @launch_url = args[:launch_url] if args.key?(:launch_url) @preferred = args[:preferred] if args.key?(:preferred) end end # This is a JSON template for the Leaderboard resource. class Leaderboard include Google::Apis::Core::Hashable # The icon for the leaderboard. # Corresponds to the JSON property `iconUrl` # @return [String] attr_accessor :icon_url # The leaderboard ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Indicates whether the icon image being returned is a default image, or is game- # provided. # Corresponds to the JSON property `isIconUrlDefault` # @return [Boolean] attr_accessor :is_icon_url_default alias_method :is_icon_url_default?, :is_icon_url_default # Uniquely identifies the type of this resource. Value is always the fixed # string games#leaderboard. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the leaderboard. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # How scores are ordered. # Possible values are: # - "LARGER_IS_BETTER" - Larger values are better; scores are sorted in # descending order. # - "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in # ascending order. # Corresponds to the JSON property `order` # @return [String] attr_accessor :order def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @icon_url = args[:icon_url] if args.key?(:icon_url) @id = args[:id] if args.key?(:id) @is_icon_url_default = args[:is_icon_url_default] if args.key?(:is_icon_url_default) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @order = args[:order] if args.key?(:order) end end # This is a JSON template for the Leaderboard Entry resource. class LeaderboardEntry include Google::Apis::Core::Hashable # The localized string for the numerical value of this score. # Corresponds to the JSON property `formattedScore` # @return [String] attr_accessor :formatted_score # The localized string for the rank of this score for this leaderboard. # Corresponds to the JSON property `formattedScoreRank` # @return [String] attr_accessor :formatted_score_rank # Uniquely identifies the type of this resource. Value is always the fixed # string games#leaderboardEntry. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for a Player resource. # Corresponds to the JSON property `player` # @return [Google::Apis::GamesV1::Player] attr_accessor :player # The rank of this score for this leaderboard. # Corresponds to the JSON property `scoreRank` # @return [Fixnum] attr_accessor :score_rank # Additional information about the score. Values must contain no more than 64 # URI-safe characters as defined by section 2.3 of RFC 3986. # Corresponds to the JSON property `scoreTag` # @return [String] attr_accessor :score_tag # The numerical value of this score. # Corresponds to the JSON property `scoreValue` # @return [Fixnum] attr_accessor :score_value # The time span of this high score. # Possible values are: # - "ALL_TIME" - The score is an all-time high score. # - "WEEKLY" - The score is a weekly high score. # - "DAILY" - The score is a daily high score. # Corresponds to the JSON property `timeSpan` # @return [String] attr_accessor :time_span # The timestamp at which this score was recorded, in milliseconds since the # epoch in UTC. # Corresponds to the JSON property `writeTimestampMillis` # @return [Fixnum] attr_accessor :write_timestamp_millis def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @formatted_score = args[:formatted_score] if args.key?(:formatted_score) @formatted_score_rank = args[:formatted_score_rank] if args.key?(:formatted_score_rank) @kind = args[:kind] if args.key?(:kind) @player = args[:player] if args.key?(:player) @score_rank = args[:score_rank] if args.key?(:score_rank) @score_tag = args[:score_tag] if args.key?(:score_tag) @score_value = args[:score_value] if args.key?(:score_value) @time_span = args[:time_span] if args.key?(:time_span) @write_timestamp_millis = args[:write_timestamp_millis] if args.key?(:write_timestamp_millis) end end # This is a JSON template for a list of leaderboard objects. class ListLeaderboardResponse include Google::Apis::Core::Hashable # The leaderboards. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#leaderboardListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token corresponding to 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) @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) end end # This is a JSON template for a score rank in a leaderboard. class LeaderboardScoreRank include Google::Apis::Core::Hashable # The number of scores in the leaderboard as a string. # Corresponds to the JSON property `formattedNumScores` # @return [String] attr_accessor :formatted_num_scores # The rank in the leaderboard as a string. # Corresponds to the JSON property `formattedRank` # @return [String] attr_accessor :formatted_rank # Uniquely identifies the type of this resource. Value is always the fixed # string games#leaderboardScoreRank. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The number of scores in the leaderboard. # Corresponds to the JSON property `numScores` # @return [Fixnum] attr_accessor :num_scores # The rank in the leaderboard. # Corresponds to the JSON property `rank` # @return [Fixnum] attr_accessor :rank def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @formatted_num_scores = args[:formatted_num_scores] if args.key?(:formatted_num_scores) @formatted_rank = args[:formatted_rank] if args.key?(:formatted_rank) @kind = args[:kind] if args.key?(:kind) @num_scores = args[:num_scores] if args.key?(:num_scores) @rank = args[:rank] if args.key?(:rank) end end # This is a JSON template for a ListScores response. class LeaderboardScores include Google::Apis::Core::Hashable # The scores in the leaderboard. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#leaderboardScores. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The pagination token for the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The total number of scores in the leaderboard. # Corresponds to the JSON property `numScores` # @return [Fixnum] attr_accessor :num_scores # This is a JSON template for the Leaderboard Entry resource. # Corresponds to the JSON property `playerScore` # @return [Google::Apis::GamesV1::LeaderboardEntry] attr_accessor :player_score # The pagination token for the previous page of results. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @num_scores = args[:num_scores] if args.key?(:num_scores) @player_score = args[:player_score] if args.key?(:player_score) @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token) end end # This is a JSON template for the metagame config resource class MetagameConfig include Google::Apis::Core::Hashable # Current version of the metagame configuration data. When this data is updated, # the version number will be increased by one. # Corresponds to the JSON property `currentVersion` # @return [Fixnum] attr_accessor :current_version # Uniquely identifies the type of this resource. Value is always the fixed # string games#metagameConfig. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The list of player levels. # Corresponds to the JSON property `playerLevels` # @return [Array] attr_accessor :player_levels def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_version = args[:current_version] if args.key?(:current_version) @kind = args[:kind] if args.key?(:kind) @player_levels = args[:player_levels] if args.key?(:player_levels) end end # This is a JSON template for network diagnostics reported for a client. class NetworkDiagnostics include Google::Apis::Core::Hashable # The Android network subtype. # Corresponds to the JSON property `androidNetworkSubtype` # @return [Fixnum] attr_accessor :android_network_subtype # The Android network type. # Corresponds to the JSON property `androidNetworkType` # @return [Fixnum] attr_accessor :android_network_type # iOS network type as defined in Reachability.h. # Corresponds to the JSON property `iosNetworkType` # @return [Fixnum] attr_accessor :ios_network_type # Uniquely identifies the type of this resource. Value is always the fixed # string games#networkDiagnostics. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The MCC+MNC code for the client's network connection. On Android: http:// # developer.android.com/reference/android/telephony/TelephonyManager.html# # getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/ # documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html # Corresponds to the JSON property `networkOperatorCode` # @return [String] attr_accessor :network_operator_code # The name of the carrier of the client's network connection. On Android: http:// # developer.android.com/reference/android/telephony/TelephonyManager.html# # getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/ # documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#/ # /apple_ref/occ/instp/CTCarrier/carrierName # Corresponds to the JSON property `networkOperatorName` # @return [String] attr_accessor :network_operator_name # The amount of time in milliseconds it took for the client to establish a # connection with the XMPP server. # Corresponds to the JSON property `registrationLatencyMillis` # @return [Fixnum] attr_accessor :registration_latency_millis def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @android_network_subtype = args[:android_network_subtype] if args.key?(:android_network_subtype) @android_network_type = args[:android_network_type] if args.key?(:android_network_type) @ios_network_type = args[:ios_network_type] if args.key?(:ios_network_type) @kind = args[:kind] if args.key?(:kind) @network_operator_code = args[:network_operator_code] if args.key?(:network_operator_code) @network_operator_name = args[:network_operator_name] if args.key?(:network_operator_name) @registration_latency_millis = args[:registration_latency_millis] if args.key?(:registration_latency_millis) end end # This is a JSON template for a result for a match participant. class ParticipantResult include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#participantResult. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The ID of the participant. # Corresponds to the JSON property `participantId` # @return [String] attr_accessor :participant_id # The placement or ranking of the participant in the match results; a number # from one to the number of participants in the match. Multiple participants may # have the same placing value in case of a type. # Corresponds to the JSON property `placing` # @return [Fixnum] attr_accessor :placing # The result of the participant for this match. # Possible values are: # - "MATCH_RESULT_WIN" - The participant won the match. # - "MATCH_RESULT_LOSS" - The participant lost the match. # - "MATCH_RESULT_TIE" - The participant tied the match. # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or # loses this kind of game.) # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the # match. # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for # this participant. # Corresponds to the JSON property `result` # @return [String] attr_accessor :result def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @participant_id = args[:participant_id] if args.key?(:participant_id) @placing = args[:placing] if args.key?(:placing) @result = args[:result] if args.key?(:result) end end # This is a JSON template for peer channel diagnostics. class PeerChannelDiagnostics include Google::Apis::Core::Hashable # This is a JSON template for aggregate stats. # Corresponds to the JSON property `bytesReceived` # @return [Google::Apis::GamesV1::AggregateStats] attr_accessor :bytes_received # This is a JSON template for aggregate stats. # Corresponds to the JSON property `bytesSent` # @return [Google::Apis::GamesV1::AggregateStats] attr_accessor :bytes_sent # Uniquely identifies the type of this resource. Value is always the fixed # string games#peerChannelDiagnostics. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Number of messages lost. # Corresponds to the JSON property `numMessagesLost` # @return [Fixnum] attr_accessor :num_messages_lost # Number of messages received. # Corresponds to the JSON property `numMessagesReceived` # @return [Fixnum] attr_accessor :num_messages_received # Number of messages sent. # Corresponds to the JSON property `numMessagesSent` # @return [Fixnum] attr_accessor :num_messages_sent # Number of send failures. # Corresponds to the JSON property `numSendFailures` # @return [Fixnum] attr_accessor :num_send_failures # This is a JSON template for aggregate stats. # Corresponds to the JSON property `roundtripLatencyMillis` # @return [Google::Apis::GamesV1::AggregateStats] attr_accessor :roundtrip_latency_millis def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bytes_received = args[:bytes_received] if args.key?(:bytes_received) @bytes_sent = args[:bytes_sent] if args.key?(:bytes_sent) @kind = args[:kind] if args.key?(:kind) @num_messages_lost = args[:num_messages_lost] if args.key?(:num_messages_lost) @num_messages_received = args[:num_messages_received] if args.key?(:num_messages_received) @num_messages_sent = args[:num_messages_sent] if args.key?(:num_messages_sent) @num_send_failures = args[:num_send_failures] if args.key?(:num_send_failures) @roundtrip_latency_millis = args[:roundtrip_latency_millis] if args.key?(:roundtrip_latency_millis) end end # This is a JSON template for peer session diagnostics. class PeerSessionDiagnostics include Google::Apis::Core::Hashable # Connected time in milliseconds. # Corresponds to the JSON property `connectedTimestampMillis` # @return [Fixnum] attr_accessor :connected_timestamp_millis # Uniquely identifies the type of this resource. Value is always the fixed # string games#peerSessionDiagnostics. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The participant ID of the peer. # Corresponds to the JSON property `participantId` # @return [String] attr_accessor :participant_id # This is a JSON template for peer channel diagnostics. # Corresponds to the JSON property `reliableChannel` # @return [Google::Apis::GamesV1::PeerChannelDiagnostics] attr_accessor :reliable_channel # This is a JSON template for peer channel diagnostics. # Corresponds to the JSON property `unreliableChannel` # @return [Google::Apis::GamesV1::PeerChannelDiagnostics] attr_accessor :unreliable_channel def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @connected_timestamp_millis = args[:connected_timestamp_millis] if args.key?(:connected_timestamp_millis) @kind = args[:kind] if args.key?(:kind) @participant_id = args[:participant_id] if args.key?(:participant_id) @reliable_channel = args[:reliable_channel] if args.key?(:reliable_channel) @unreliable_channel = args[:unreliable_channel] if args.key?(:unreliable_channel) end end # This is a JSON template for metadata about a player playing a game with the # currently authenticated user. class Played include Google::Apis::Core::Hashable # True if the player was auto-matched with the currently authenticated user. # Corresponds to the JSON property `autoMatched` # @return [Boolean] attr_accessor :auto_matched alias_method :auto_matched?, :auto_matched # Uniquely identifies the type of this resource. Value is always the fixed # string games#played. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The last time the player played the game in milliseconds since the epoch in # UTC. # Corresponds to the JSON property `timeMillis` # @return [Fixnum] attr_accessor :time_millis def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_matched = args[:auto_matched] if args.key?(:auto_matched) @kind = args[:kind] if args.key?(:kind) @time_millis = args[:time_millis] if args.key?(:time_millis) end end # This is a JSON template for a Player resource. class Player include Google::Apis::Core::Hashable # The base URL for the image that represents the player. # Corresponds to the JSON property `avatarImageUrl` # @return [String] attr_accessor :avatar_image_url # The url to the landscape mode player banner image. # Corresponds to the JSON property `bannerUrlLandscape` # @return [String] attr_accessor :banner_url_landscape # The url to the portrait mode player banner image. # Corresponds to the JSON property `bannerUrlPortrait` # @return [String] attr_accessor :banner_url_portrait # The name to display for the player. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # This is a JSON template for 1P/3P metadata about the player's experience. # Corresponds to the JSON property `experienceInfo` # @return [Google::Apis::GamesV1::PlayerExperienceInfo] attr_accessor :experience_info # Uniquely identifies the type of this resource. Value is always the fixed # string games#player. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for metadata about a player playing a game with the # currently authenticated user. # Corresponds to the JSON property `lastPlayedWith` # @return [Google::Apis::GamesV1::Played] attr_accessor :last_played_with # An object representation of the individual components of the player's name. # For some players, these fields may not be present. # Corresponds to the JSON property `name` # @return [Google::Apis::GamesV1::Player::Name] attr_accessor :name # The player ID that was used for this player the first time they signed into # the game in question. This is only populated for calls to player.get for the # requesting player, only if the player ID has subsequently changed, and only to # clients that support remapping player IDs. # Corresponds to the JSON property `originalPlayerId` # @return [String] attr_accessor :original_player_id # The ID of the player. # Corresponds to the JSON property `playerId` # @return [String] attr_accessor :player_id # This is a JSON template for profile settings # Corresponds to the JSON property `profileSettings` # @return [Google::Apis::GamesV1::ProfileSettings] attr_accessor :profile_settings # The player's title rewarded for their game activities. # 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) @avatar_image_url = args[:avatar_image_url] if args.key?(:avatar_image_url) @banner_url_landscape = args[:banner_url_landscape] if args.key?(:banner_url_landscape) @banner_url_portrait = args[:banner_url_portrait] if args.key?(:banner_url_portrait) @display_name = args[:display_name] if args.key?(:display_name) @experience_info = args[:experience_info] if args.key?(:experience_info) @kind = args[:kind] if args.key?(:kind) @last_played_with = args[:last_played_with] if args.key?(:last_played_with) @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) @profile_settings = args[:profile_settings] if args.key?(:profile_settings) @title = args[:title] if args.key?(:title) end # An object representation of the individual components of the player's name. # For some players, these fields may not be present. class Name include Google::Apis::Core::Hashable # The family name of this player. In some places, this is known as the last name. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name # The given name of this player. In some places, this is known as the first name. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @family_name = args[:family_name] if args.key?(:family_name) @given_name = args[:given_name] if args.key?(:given_name) end end end # This is a JSON template for an achievement object. class PlayerAchievement include Google::Apis::Core::Hashable # The state of the achievement. # Possible values are: # - "HIDDEN" - Achievement is hidden. # - "REVEALED" - Achievement is revealed. # - "UNLOCKED" - Achievement is unlocked. # Corresponds to the JSON property `achievementState` # @return [String] attr_accessor :achievement_state # The current steps for an incremental achievement. # Corresponds to the JSON property `currentSteps` # @return [Fixnum] attr_accessor :current_steps # Experience points earned for the achievement. This field is absent for # achievements that have not yet been unlocked and 0 for achievements that have # been unlocked by testers but that are unpublished. # Corresponds to the JSON property `experiencePoints` # @return [Fixnum] attr_accessor :experience_points # The current steps for an incremental achievement as a string. # Corresponds to the JSON property `formattedCurrentStepsString` # @return [String] attr_accessor :formatted_current_steps_string # The ID of the achievement. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerAchievement. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The timestamp of the last modification to this achievement's state. # Corresponds to the JSON property `lastUpdatedTimestamp` # @return [Fixnum] attr_accessor :last_updated_timestamp def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @achievement_state = args[:achievement_state] if args.key?(:achievement_state) @current_steps = args[:current_steps] if args.key?(:current_steps) @experience_points = args[:experience_points] if args.key?(:experience_points) @formatted_current_steps_string = args[:formatted_current_steps_string] if args.key?(:formatted_current_steps_string) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_updated_timestamp = args[:last_updated_timestamp] if args.key?(:last_updated_timestamp) end end # This is a JSON template for a list of achievement objects. class ListPlayerAchievementResponse include Google::Apis::Core::Hashable # The achievements. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerAchievementListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token corresponding to 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) @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) end end # This is a JSON template for an event status resource. class PlayerEvent include Google::Apis::Core::Hashable # The ID of the event definition. # Corresponds to the JSON property `definitionId` # @return [String] attr_accessor :definition_id # The current number of times this event has occurred, as a string. The # formatting of this string depends on the configuration of your event in the # Play Games Developer Console. # Corresponds to the JSON property `formattedNumEvents` # @return [String] attr_accessor :formatted_num_events # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerEvent. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The current number of times this event has occurred. # Corresponds to the JSON property `numEvents` # @return [Fixnum] attr_accessor :num_events # The ID of the player. # Corresponds to the JSON property `playerId` # @return [String] attr_accessor :player_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @definition_id = args[:definition_id] if args.key?(:definition_id) @formatted_num_events = args[:formatted_num_events] if args.key?(:formatted_num_events) @kind = args[:kind] if args.key?(:kind) @num_events = args[:num_events] if args.key?(:num_events) @player_id = args[:player_id] if args.key?(:player_id) end end # This is a JSON template for a ListByPlayer response. class ListPlayerEventResponse include Google::Apis::Core::Hashable # The player events. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerEventListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The pagination token for 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) @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) end end # This is a JSON template for 1P/3P metadata about the player's experience. class PlayerExperienceInfo include Google::Apis::Core::Hashable # The current number of experience points for the player. # Corresponds to the JSON property `currentExperiencePoints` # @return [Fixnum] attr_accessor :current_experience_points # This is a JSON template for 1P/3P metadata about a user's level. # Corresponds to the JSON property `currentLevel` # @return [Google::Apis::GamesV1::PlayerLevel] attr_accessor :current_level # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerExperienceInfo. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The timestamp when the player was leveled up, in millis since Unix epoch UTC. # Corresponds to the JSON property `lastLevelUpTimestampMillis` # @return [Fixnum] attr_accessor :last_level_up_timestamp_millis # This is a JSON template for 1P/3P metadata about a user's level. # Corresponds to the JSON property `nextLevel` # @return [Google::Apis::GamesV1::PlayerLevel] attr_accessor :next_level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_experience_points = args[:current_experience_points] if args.key?(:current_experience_points) @current_level = args[:current_level] if args.key?(:current_level) @kind = args[:kind] if args.key?(:kind) @last_level_up_timestamp_millis = args[:last_level_up_timestamp_millis] if args.key?(:last_level_up_timestamp_millis) @next_level = args[:next_level] if args.key?(:next_level) end end # This is a JSON template for a player leaderboard score object. class PlayerLeaderboardScore include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerLeaderboardScore. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The ID of the leaderboard this score is in. # Corresponds to the JSON property `leaderboard_id` # @return [String] attr_accessor :leaderboard_id # This is a JSON template for a score rank in a leaderboard. # Corresponds to the JSON property `publicRank` # @return [Google::Apis::GamesV1::LeaderboardScoreRank] attr_accessor :public_rank # The formatted value of this score. # Corresponds to the JSON property `scoreString` # @return [String] attr_accessor :score_string # Additional information about the score. Values must contain no more than 64 # URI-safe characters as defined by section 2.3 of RFC 3986. # Corresponds to the JSON property `scoreTag` # @return [String] attr_accessor :score_tag # The numerical value of this score. # Corresponds to the JSON property `scoreValue` # @return [Fixnum] attr_accessor :score_value # This is a JSON template for a score rank in a leaderboard. # Corresponds to the JSON property `socialRank` # @return [Google::Apis::GamesV1::LeaderboardScoreRank] attr_accessor :social_rank # The time span of this score. # Possible values are: # - "ALL_TIME" - The score is an all-time score. # - "WEEKLY" - The score is a weekly score. # - "DAILY" - The score is a daily score. # Corresponds to the JSON property `timeSpan` # @return [String] attr_accessor :time_span # The timestamp at which this score was recorded, in milliseconds since the # epoch in UTC. # Corresponds to the JSON property `writeTimestamp` # @return [Fixnum] attr_accessor :write_timestamp def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @leaderboard_id = args[:leaderboard_id] if args.key?(:leaderboard_id) @public_rank = args[:public_rank] if args.key?(:public_rank) @score_string = args[:score_string] if args.key?(:score_string) @score_tag = args[:score_tag] if args.key?(:score_tag) @score_value = args[:score_value] if args.key?(:score_value) @social_rank = args[:social_rank] if args.key?(:social_rank) @time_span = args[:time_span] if args.key?(:time_span) @write_timestamp = args[:write_timestamp] if args.key?(:write_timestamp) end end # This is a JSON template for a list of player leaderboard scores. class ListPlayerLeaderboardScoreResponse include Google::Apis::Core::Hashable # The leaderboard scores. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerLeaderboardScoreListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The pagination token for the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # This is a JSON template for a Player resource. # Corresponds to the JSON property `player` # @return [Google::Apis::GamesV1::Player] attr_accessor :player def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @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) @player = args[:player] if args.key?(:player) end end # This is a JSON template for 1P/3P metadata about a user's level. class PlayerLevel include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerLevel. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The level for the user. # Corresponds to the JSON property `level` # @return [Fixnum] attr_accessor :level # The maximum experience points for this level. # Corresponds to the JSON property `maxExperiencePoints` # @return [Fixnum] attr_accessor :max_experience_points # The minimum experience points for this level. # Corresponds to the JSON property `minExperiencePoints` # @return [Fixnum] attr_accessor :min_experience_points def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @level = args[:level] if args.key?(:level) @max_experience_points = args[:max_experience_points] if args.key?(:max_experience_points) @min_experience_points = args[:min_experience_points] if args.key?(:min_experience_points) end end # This is a JSON template for a third party player list response. class ListPlayerResponse include Google::Apis::Core::Hashable # The players. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token corresponding to 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) @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) end end # This is a JSON template for a player score. class PlayerScore include Google::Apis::Core::Hashable # The formatted score for this player score. # Corresponds to the JSON property `formattedScore` # @return [String] attr_accessor :formatted_score # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerScore. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The numerical value for this player score. # Corresponds to the JSON property `score` # @return [Fixnum] attr_accessor :score # Additional information about this score. Values will contain no more than 64 # URI-safe characters as defined by section 2.3 of RFC 3986. # Corresponds to the JSON property `scoreTag` # @return [String] attr_accessor :score_tag # The time span for this player score. # Possible values are: # - "ALL_TIME" - The score is an all-time score. # - "WEEKLY" - The score is a weekly score. # - "DAILY" - The score is a daily score. # Corresponds to the JSON property `timeSpan` # @return [String] attr_accessor :time_span def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @formatted_score = args[:formatted_score] if args.key?(:formatted_score) @kind = args[:kind] if args.key?(:kind) @score = args[:score] if args.key?(:score) @score_tag = args[:score_tag] if args.key?(:score_tag) @time_span = args[:time_span] if args.key?(:time_span) end end # This is a JSON template for a list of score submission statuses. class ListPlayerScoreResponse include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerScoreListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The score submissions statuses. # Corresponds to the JSON property `submittedScores` # @return [Array] attr_accessor :submitted_scores def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @submitted_scores = args[:submitted_scores] if args.key?(:submitted_scores) end end # This is a JSON template for a list of leaderboard entry resources. class PlayerScoreResponse include Google::Apis::Core::Hashable # The time spans where the submitted score is better than the existing score for # that time span. # Possible values are: # - "ALL_TIME" - The score is an all-time score. # - "WEEKLY" - The score is a weekly score. # - "DAILY" - The score is a daily score. # Corresponds to the JSON property `beatenScoreTimeSpans` # @return [Array] attr_accessor :beaten_score_time_spans # The formatted value of the submitted score. # Corresponds to the JSON property `formattedScore` # @return [String] attr_accessor :formatted_score # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerScoreResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The leaderboard ID that this score was submitted to. # Corresponds to the JSON property `leaderboardId` # @return [String] attr_accessor :leaderboard_id # Additional information about this score. Values will contain no more than 64 # URI-safe characters as defined by section 2.3 of RFC 3986. # Corresponds to the JSON property `scoreTag` # @return [String] attr_accessor :score_tag # The scores in time spans that have not been beaten. As an example, the # submitted score may be better than the player's DAILY score, but not better # than the player's scores for the WEEKLY or ALL_TIME time spans. # Corresponds to the JSON property `unbeatenScores` # @return [Array] attr_accessor :unbeaten_scores def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @beaten_score_time_spans = args[:beaten_score_time_spans] if args.key?(:beaten_score_time_spans) @formatted_score = args[:formatted_score] if args.key?(:formatted_score) @kind = args[:kind] if args.key?(:kind) @leaderboard_id = args[:leaderboard_id] if args.key?(:leaderboard_id) @score_tag = args[:score_tag] if args.key?(:score_tag) @unbeaten_scores = args[:unbeaten_scores] if args.key?(:unbeaten_scores) end end # This is a JSON template for a list of score submission requests class PlayerScoreSubmissionList include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#playerScoreSubmissionList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The score submissions. # Corresponds to the JSON property `scores` # @return [Array] attr_accessor :scores def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @scores = args[:scores] if args.key?(:scores) end end # This is a JSON template for profile settings class ProfileSettings include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#profileSettings. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The player's current profile visibility. This field is visible to both 1P and # 3P APIs. # Corresponds to the JSON property `profileVisible` # @return [Boolean] attr_accessor :profile_visible alias_method :profile_visible?, :profile_visible def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @profile_visible = args[:profile_visible] if args.key?(:profile_visible) end end # This is a JSON template for a push token resource. class PushToken include Google::Apis::Core::Hashable # The revision of the client SDK used by your application, in the same format # that's used by revisions.check. Used to send backward compatible messages. # Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: # # - IOS - Push token is for iOS # Corresponds to the JSON property `clientRevision` # @return [String] attr_accessor :client_revision # This is a JSON template for a push token ID resource. # Corresponds to the JSON property `id` # @return [Google::Apis::GamesV1::PushTokenId] attr_accessor :id # Uniquely identifies the type of this resource. Value is always the fixed # string games#pushToken. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The preferred language for notifications that are sent using this token. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_revision = args[:client_revision] if args.key?(:client_revision) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @language = args[:language] if args.key?(:language) end end # This is a JSON template for a push token ID resource. class PushTokenId include Google::Apis::Core::Hashable # A push token ID for iOS devices. # Corresponds to the JSON property `ios` # @return [Google::Apis::GamesV1::PushTokenId::Ios] attr_accessor :ios # Uniquely identifies the type of this resource. Value is always the fixed # string games#pushTokenId. # 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) @ios = args[:ios] if args.key?(:ios) @kind = args[:kind] if args.key?(:kind) end # A push token ID for iOS devices. class Ios include Google::Apis::Core::Hashable # Device token supplied by an iOS system call to register for remote # notifications. Encode this field as web-safe base64. # Corresponds to the JSON property `apns_device_token` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :apns_device_token # Indicates whether this token should be used for the production or sandbox APNS # server. # Corresponds to the JSON property `apns_environment` # @return [String] attr_accessor :apns_environment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @apns_device_token = args[:apns_device_token] if args.key?(:apns_device_token) @apns_environment = args[:apns_environment] if args.key?(:apns_environment) end end end # This is a JSON template for a Quest resource. class Quest include Google::Apis::Core::Hashable # The timestamp at which the user accepted the quest in milliseconds since the # epoch in UTC. Only present if the player has accepted the quest. # Corresponds to the JSON property `acceptedTimestampMillis` # @return [Fixnum] attr_accessor :accepted_timestamp_millis # The ID of the application this quest is part of. # Corresponds to the JSON property `applicationId` # @return [String] attr_accessor :application_id # The banner image URL for the quest. # Corresponds to the JSON property `bannerUrl` # @return [String] attr_accessor :banner_url # The description of the quest. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The timestamp at which the quest ceases to be active in milliseconds since the # epoch in UTC. # Corresponds to the JSON property `endTimestampMillis` # @return [Fixnum] attr_accessor :end_timestamp_millis # The icon image URL for the quest. # Corresponds to the JSON property `iconUrl` # @return [String] attr_accessor :icon_url # The ID of the quest. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Indicates whether the banner image being returned is a default image, or is # game-provided. # Corresponds to the JSON property `isDefaultBannerUrl` # @return [Boolean] attr_accessor :is_default_banner_url alias_method :is_default_banner_url?, :is_default_banner_url # Indicates whether the icon image being returned is a default image, or is game- # provided. # Corresponds to the JSON property `isDefaultIconUrl` # @return [Boolean] attr_accessor :is_default_icon_url alias_method :is_default_icon_url?, :is_default_icon_url # Uniquely identifies the type of this resource. Value is always the fixed # string games#quest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The timestamp at which the quest was last updated by the user in milliseconds # since the epoch in UTC. Only present if the player has accepted the quest. # Corresponds to the JSON property `lastUpdatedTimestampMillis` # @return [Fixnum] attr_accessor :last_updated_timestamp_millis # The quest milestones. # Corresponds to the JSON property `milestones` # @return [Array] attr_accessor :milestones # The name of the quest. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The timestamp at which the user should be notified that the quest will end # soon in milliseconds since the epoch in UTC. # Corresponds to the JSON property `notifyTimestampMillis` # @return [Fixnum] attr_accessor :notify_timestamp_millis # The timestamp at which the quest becomes active in milliseconds since the # epoch in UTC. # Corresponds to the JSON property `startTimestampMillis` # @return [Fixnum] attr_accessor :start_timestamp_millis # The state of the quest. # Possible values are: # - "UPCOMING": The quest is upcoming. The user can see the quest, but cannot # accept it until it is open. # - "OPEN": The quest is currently open and may be accepted at this time. # - "ACCEPTED": The user is currently participating in this quest. # - "COMPLETED": The user has completed the quest. # - "FAILED": The quest was attempted but was not completed before the deadline # expired. # - "EXPIRED": The quest has expired and was not accepted. # - "DELETED": The quest should be deleted from the local database. # 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) @accepted_timestamp_millis = args[:accepted_timestamp_millis] if args.key?(:accepted_timestamp_millis) @application_id = args[:application_id] if args.key?(:application_id) @banner_url = args[:banner_url] if args.key?(:banner_url) @description = args[:description] if args.key?(:description) @end_timestamp_millis = args[:end_timestamp_millis] if args.key?(:end_timestamp_millis) @icon_url = args[:icon_url] if args.key?(:icon_url) @id = args[:id] if args.key?(:id) @is_default_banner_url = args[:is_default_banner_url] if args.key?(:is_default_banner_url) @is_default_icon_url = args[:is_default_icon_url] if args.key?(:is_default_icon_url) @kind = args[:kind] if args.key?(:kind) @last_updated_timestamp_millis = args[:last_updated_timestamp_millis] if args.key?(:last_updated_timestamp_millis) @milestones = args[:milestones] if args.key?(:milestones) @name = args[:name] if args.key?(:name) @notify_timestamp_millis = args[:notify_timestamp_millis] if args.key?(:notify_timestamp_millis) @start_timestamp_millis = args[:start_timestamp_millis] if args.key?(:start_timestamp_millis) @state = args[:state] if args.key?(:state) end end # This is a JSON template for a Quest Criterion Contribution resource. class QuestContribution include Google::Apis::Core::Hashable # The formatted value of the contribution as a string. Format depends on the # configuration for the associated event definition in the Play Games Developer # Console. # Corresponds to the JSON property `formattedValue` # @return [String] attr_accessor :formatted_value # Uniquely identifies the type of this resource. Value is always the fixed # string games#questContribution. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The value of the contribution. # Corresponds to the JSON property `value` # @return [Fixnum] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @formatted_value = args[:formatted_value] if args.key?(:formatted_value) @kind = args[:kind] if args.key?(:kind) @value = args[:value] if args.key?(:value) end end # This is a JSON template for a Quest Criterion resource. class QuestCriterion include Google::Apis::Core::Hashable # This is a JSON template for a Quest Criterion Contribution resource. # Corresponds to the JSON property `completionContribution` # @return [Google::Apis::GamesV1::QuestContribution] attr_accessor :completion_contribution # This is a JSON template for a Quest Criterion Contribution resource. # Corresponds to the JSON property `currentContribution` # @return [Google::Apis::GamesV1::QuestContribution] attr_accessor :current_contribution # The ID of the event the criterion corresponds to. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # This is a JSON template for a Quest Criterion Contribution resource. # Corresponds to the JSON property `initialPlayerProgress` # @return [Google::Apis::GamesV1::QuestContribution] attr_accessor :initial_player_progress # Uniquely identifies the type of this resource. Value is always the fixed # string games#questCriterion. # 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) @completion_contribution = args[:completion_contribution] if args.key?(:completion_contribution) @current_contribution = args[:current_contribution] if args.key?(:current_contribution) @event_id = args[:event_id] if args.key?(:event_id) @initial_player_progress = args[:initial_player_progress] if args.key?(:initial_player_progress) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for a list of quest objects. class ListQuestResponse include Google::Apis::Core::Hashable # The quests. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#questListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token corresponding to 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) @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) end end # This is a JSON template for a Quest Milestone resource. class QuestMilestone include Google::Apis::Core::Hashable # The completion reward data of the milestone, represented as a Base64-encoded # string. This is a developer-specified binary blob with size between 0 and 2 KB # before encoding. # Corresponds to the JSON property `completionRewardData` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :completion_reward_data # The criteria of the milestone. # Corresponds to the JSON property `criteria` # @return [Array] attr_accessor :criteria # The milestone ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Uniquely identifies the type of this resource. Value is always the fixed # string games#questMilestone. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The current state of the milestone. # Possible values are: # - "COMPLETED_NOT_CLAIMED" - The milestone is complete, but has not yet been # claimed. # - "CLAIMED" - The milestone is complete and has been claimed. # - "NOT_COMPLETED" - The milestone has not yet been completed. # - "NOT_STARTED" - The milestone is for a quest that has not yet been accepted. # 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) @completion_reward_data = args[:completion_reward_data] if args.key?(:completion_reward_data) @criteria = args[:criteria] if args.key?(:criteria) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @state = args[:state] if args.key?(:state) end end # This is a JSON template for the result of checking a revision. class CheckRevisionResponse include Google::Apis::Core::Hashable # The version of the API this client revision should use when calling API # methods. # Corresponds to the JSON property `apiVersion` # @return [String] attr_accessor :api_version # Uniquely identifies the type of this resource. Value is always the fixed # string games#revisionCheckResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The result of the revision check. # Possible values are: # - "OK" - The revision being used is current. # - "DEPRECATED" - There is currently a newer version available, but the # revision being used still works. # - "INVALID" - The revision being used is not supported in any released version. # Corresponds to the JSON property `revisionStatus` # @return [String] attr_accessor :revision_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @api_version = args[:api_version] if args.key?(:api_version) @kind = args[:kind] if args.key?(:kind) @revision_status = args[:revision_status] if args.key?(:revision_status) end end # This is a JSON template for a room resource object. class Room include Google::Apis::Core::Hashable # The ID of the application being played. # Corresponds to the JSON property `applicationId` # @return [String] attr_accessor :application_id # This is a JSON template for a room auto-match criteria object. # Corresponds to the JSON property `autoMatchingCriteria` # @return [Google::Apis::GamesV1::RoomAutoMatchingCriteria] attr_accessor :auto_matching_criteria # This is a JSON template for status of room automatching that is in progress. # Corresponds to the JSON property `autoMatchingStatus` # @return [Google::Apis::GamesV1::RoomAutoMatchStatus] attr_accessor :auto_matching_status # This is a JSON template for room modification metadata. # Corresponds to the JSON property `creationDetails` # @return [Google::Apis::GamesV1::RoomModification] attr_accessor :creation_details # This short description is generated by our servers and worded relative to the # player requesting the room. It is intended to be displayed when the room is # shown in a list (that is, an invitation to a room.) # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The ID of the participant that invited the user to the room. Not set if the # user was not invited to the room. # Corresponds to the JSON property `inviterId` # @return [String] attr_accessor :inviter_id # Uniquely identifies the type of this resource. Value is always the fixed # string games#room. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for room modification metadata. # Corresponds to the JSON property `lastUpdateDetails` # @return [Google::Apis::GamesV1::RoomModification] attr_accessor :last_update_details # The participants involved in the room, along with their statuses. Includes # participants who have left or declined invitations. # Corresponds to the JSON property `participants` # @return [Array] attr_accessor :participants # Globally unique ID for a room. # Corresponds to the JSON property `roomId` # @return [String] attr_accessor :room_id # The version of the room status: an increasing counter, used by the client to # ignore out-of-order updates to room status. # Corresponds to the JSON property `roomStatusVersion` # @return [Fixnum] attr_accessor :room_status_version # The status of the room. # Possible values are: # - "ROOM_INVITING" - One or more players have been invited and not responded. # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. # - "ROOM_CONNECTING" - Players have joined and are connecting to each other ( # either before or after auto-matching). # - "ROOM_ACTIVE" - All players have joined and connected to each other. # - "ROOM_DELETED" - The room should no longer be shown on the client. Returned # in sync calls when a player joins a room (as a tombstone), or for rooms where # all joined participants have left. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The variant / mode of the application being played; can be any integer value, # or left blank. # Corresponds to the JSON property `variant` # @return [Fixnum] attr_accessor :variant def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @application_id = args[:application_id] if args.key?(:application_id) @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria) @auto_matching_status = args[:auto_matching_status] if args.key?(:auto_matching_status) @creation_details = args[:creation_details] if args.key?(:creation_details) @description = args[:description] if args.key?(:description) @inviter_id = args[:inviter_id] if args.key?(:inviter_id) @kind = args[:kind] if args.key?(:kind) @last_update_details = args[:last_update_details] if args.key?(:last_update_details) @participants = args[:participants] if args.key?(:participants) @room_id = args[:room_id] if args.key?(:room_id) @room_status_version = args[:room_status_version] if args.key?(:room_status_version) @status = args[:status] if args.key?(:status) @variant = args[:variant] if args.key?(:variant) end end # This is a JSON template for status of room automatching that is in progress. class RoomAutoMatchStatus include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomAutoMatchStatus. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # An estimate for the amount of time (in seconds) that auto-matching is expected # to take to complete. # Corresponds to the JSON property `waitEstimateSeconds` # @return [Fixnum] attr_accessor :wait_estimate_seconds def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @wait_estimate_seconds = args[:wait_estimate_seconds] if args.key?(:wait_estimate_seconds) end end # This is a JSON template for a room auto-match criteria object. class RoomAutoMatchingCriteria include Google::Apis::Core::Hashable # A bitmask indicating when auto-matches are valid. When ANDed with other # exclusive bitmasks, the result must be zero. Can be used to support exclusive # roles within a game. # Corresponds to the JSON property `exclusiveBitmask` # @return [Fixnum] attr_accessor :exclusive_bitmask # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomAutoMatchingCriteria. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The maximum number of players that should be added to the room by auto- # matching. # Corresponds to the JSON property `maxAutoMatchingPlayers` # @return [Fixnum] attr_accessor :max_auto_matching_players # The minimum number of players that should be added to the room by auto- # matching. # Corresponds to the JSON property `minAutoMatchingPlayers` # @return [Fixnum] attr_accessor :min_auto_matching_players def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @exclusive_bitmask = args[:exclusive_bitmask] if args.key?(:exclusive_bitmask) @kind = args[:kind] if args.key?(:kind) @max_auto_matching_players = args[:max_auto_matching_players] if args.key?(:max_auto_matching_players) @min_auto_matching_players = args[:min_auto_matching_players] if args.key?(:min_auto_matching_players) end end # This is a JSON template for the client address when setting up a room. class RoomClientAddress include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomClientAddress. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The XMPP address of the client on the Google Games XMPP network. # Corresponds to the JSON property `xmppAddress` # @return [String] attr_accessor :xmpp_address def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @xmpp_address = args[:xmpp_address] if args.key?(:xmpp_address) end end # This is a JSON template for a room creation request. class CreateRoomRequest include Google::Apis::Core::Hashable # This is a JSON template for a room auto-match criteria object. # Corresponds to the JSON property `autoMatchingCriteria` # @return [Google::Apis::GamesV1::RoomAutoMatchingCriteria] attr_accessor :auto_matching_criteria # The capabilities that this client supports for realtime communication. # Corresponds to the JSON property `capabilities` # @return [Array] attr_accessor :capabilities # This is a JSON template for the client address when setting up a room. # Corresponds to the JSON property `clientAddress` # @return [Google::Apis::GamesV1::RoomClientAddress] attr_accessor :client_address # The player IDs to invite to the room. # Corresponds to the JSON property `invitedPlayerIds` # @return [Array] attr_accessor :invited_player_ids # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomCreateRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for network diagnostics reported for a client. # Corresponds to the JSON property `networkDiagnostics` # @return [Google::Apis::GamesV1::NetworkDiagnostics] attr_accessor :network_diagnostics # A randomly generated numeric ID. This number is used at the server to ensure # that the request is handled correctly across retries. # Corresponds to the JSON property `requestId` # @return [Fixnum] attr_accessor :request_id # The variant / mode of the application to be played. This can be any integer # value, or left blank. You should use a small number of variants to keep the # auto-matching pool as large as possible. # Corresponds to the JSON property `variant` # @return [Fixnum] attr_accessor :variant def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria) @capabilities = args[:capabilities] if args.key?(:capabilities) @client_address = args[:client_address] if args.key?(:client_address) @invited_player_ids = args[:invited_player_ids] if args.key?(:invited_player_ids) @kind = args[:kind] if args.key?(:kind) @network_diagnostics = args[:network_diagnostics] if args.key?(:network_diagnostics) @request_id = args[:request_id] if args.key?(:request_id) @variant = args[:variant] if args.key?(:variant) end end # This is a JSON template for a join room request. class JoinRoomRequest include Google::Apis::Core::Hashable # The capabilities that this client supports for realtime communication. # Corresponds to the JSON property `capabilities` # @return [Array] attr_accessor :capabilities # This is a JSON template for the client address when setting up a room. # Corresponds to the JSON property `clientAddress` # @return [Google::Apis::GamesV1::RoomClientAddress] attr_accessor :client_address # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomJoinRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for network diagnostics reported for a client. # Corresponds to the JSON property `networkDiagnostics` # @return [Google::Apis::GamesV1::NetworkDiagnostics] attr_accessor :network_diagnostics def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @capabilities = args[:capabilities] if args.key?(:capabilities) @client_address = args[:client_address] if args.key?(:client_address) @kind = args[:kind] if args.key?(:kind) @network_diagnostics = args[:network_diagnostics] if args.key?(:network_diagnostics) end end # This is a JSON template for room leave diagnostics. class RoomLeaveDiagnostics include Google::Apis::Core::Hashable # Android network subtype. http://developer.android.com/reference/android/net/ # NetworkInfo.html#getSubtype() # Corresponds to the JSON property `androidNetworkSubtype` # @return [Fixnum] attr_accessor :android_network_subtype # Android network type. http://developer.android.com/reference/android/net/ # NetworkInfo.html#getType() # Corresponds to the JSON property `androidNetworkType` # @return [Fixnum] attr_accessor :android_network_type # iOS network type as defined in Reachability.h. # Corresponds to the JSON property `iosNetworkType` # @return [Fixnum] attr_accessor :ios_network_type # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomLeaveDiagnostics. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The MCC+MNC code for the client's network connection. On Android: http:// # developer.android.com/reference/android/telephony/TelephonyManager.html# # getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/ # documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html # Corresponds to the JSON property `networkOperatorCode` # @return [String] attr_accessor :network_operator_code # The name of the carrier of the client's network connection. On Android: http:// # developer.android.com/reference/android/telephony/TelephonyManager.html# # getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/ # documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#/ # /apple_ref/occ/instp/CTCarrier/carrierName # Corresponds to the JSON property `networkOperatorName` # @return [String] attr_accessor :network_operator_name # Diagnostics about all peer sessions. # Corresponds to the JSON property `peerSession` # @return [Array] attr_accessor :peer_session # Whether or not sockets were used. # Corresponds to the JSON property `socketsUsed` # @return [Boolean] attr_accessor :sockets_used alias_method :sockets_used?, :sockets_used def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @android_network_subtype = args[:android_network_subtype] if args.key?(:android_network_subtype) @android_network_type = args[:android_network_type] if args.key?(:android_network_type) @ios_network_type = args[:ios_network_type] if args.key?(:ios_network_type) @kind = args[:kind] if args.key?(:kind) @network_operator_code = args[:network_operator_code] if args.key?(:network_operator_code) @network_operator_name = args[:network_operator_name] if args.key?(:network_operator_name) @peer_session = args[:peer_session] if args.key?(:peer_session) @sockets_used = args[:sockets_used] if args.key?(:sockets_used) end end # This is a JSON template for a leave room request. class LeaveRoomRequest include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomLeaveRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for room leave diagnostics. # Corresponds to the JSON property `leaveDiagnostics` # @return [Google::Apis::GamesV1::RoomLeaveDiagnostics] attr_accessor :leave_diagnostics # Reason for leaving the match. # Possible values are: # - "PLAYER_LEFT" - The player chose to leave the room.. # - "GAME_LEFT" - The game chose to remove the player from the room. # - "REALTIME_ABANDONED" - The player switched to another application and # abandoned the room. # - "REALTIME_PEER_CONNECTION_FAILURE" - The client was unable to establish a # connection to other peer(s). # - "REALTIME_SERVER_CONNECTION_FAILURE" - The client was unable to communicate # with the server. # - "REALTIME_SERVER_ERROR" - The client received an error response when it # tried to communicate with the server. # - "REALTIME_TIMEOUT" - The client timed out while waiting for a room. # - "REALTIME_CLIENT_DISCONNECTING" - The client disconnects without first # calling Leave. # - "REALTIME_SIGN_OUT" - The user signed out of G+ while in the room. # - "REALTIME_GAME_CRASHED" - The game crashed. # - "REALTIME_ROOM_SERVICE_CRASHED" - RoomAndroidService crashed. # - "REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION" - Another client is trying to # enter a room. # - "REALTIME_SAME_CLIENT_ROOM_OPERATION" - The same client is trying to enter a # new room. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @leave_diagnostics = args[:leave_diagnostics] if args.key?(:leave_diagnostics) @reason = args[:reason] if args.key?(:reason) end end # This is a JSON template for a list of rooms. class RoomList include Google::Apis::Core::Hashable # The rooms. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The pagination token for 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) @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) end end # This is a JSON template for room modification metadata. class RoomModification include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomModification. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The timestamp at which they modified the room, in milliseconds since the epoch # in UTC. # Corresponds to the JSON property `modifiedTimestampMillis` # @return [Fixnum] attr_accessor :modified_timestamp_millis # The ID of the participant that modified the room. # Corresponds to the JSON property `participantId` # @return [String] attr_accessor :participant_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @modified_timestamp_millis = args[:modified_timestamp_millis] if args.key?(:modified_timestamp_millis) @participant_id = args[:participant_id] if args.key?(:participant_id) end end # This is a JSON template for an update on the status of a peer in a room. class RoomP2PStatus include Google::Apis::Core::Hashable # The amount of time in milliseconds it took to establish connections with this # peer. # Corresponds to the JSON property `connectionSetupLatencyMillis` # @return [Fixnum] attr_accessor :connection_setup_latency_millis # The error code in event of a failure. # Possible values are: # - "P2P_FAILED" - The client failed to establish a P2P connection with the peer. # # - "PRESENCE_FAILED" - The client failed to register to receive P2P connections. # # - "RELAY_SERVER_FAILED" - The client received an error when trying to use the # relay server to establish a P2P connection with the peer. # Corresponds to the JSON property `error` # @return [String] attr_accessor :error # More detailed diagnostic message returned in event of a failure. # Corresponds to the JSON property `error_reason` # @return [String] attr_accessor :error_reason # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomP2PStatus. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The ID of the participant. # Corresponds to the JSON property `participantId` # @return [String] attr_accessor :participant_id # The status of the peer in the room. # Possible values are: # - "CONNECTION_ESTABLISHED" - The client established a P2P connection with the # peer. # - "CONNECTION_FAILED" - The client failed to establish directed presence with # the peer. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The amount of time in milliseconds it took to send packets back and forth on # the unreliable channel with this peer. # Corresponds to the JSON property `unreliableRoundtripLatencyMillis` # @return [Fixnum] attr_accessor :unreliable_roundtrip_latency_millis def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @connection_setup_latency_millis = args[:connection_setup_latency_millis] if args.key?(:connection_setup_latency_millis) @error = args[:error] if args.key?(:error) @error_reason = args[:error_reason] if args.key?(:error_reason) @kind = args[:kind] if args.key?(:kind) @participant_id = args[:participant_id] if args.key?(:participant_id) @status = args[:status] if args.key?(:status) @unreliable_roundtrip_latency_millis = args[:unreliable_roundtrip_latency_millis] if args.key?(:unreliable_roundtrip_latency_millis) end end # This is a JSON template for an update on the status of peers in a room. class RoomP2PStatuses include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomP2PStatuses. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The updates for the peers. # Corresponds to the JSON property `updates` # @return [Array] attr_accessor :updates def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @updates = args[:updates] if args.key?(:updates) end end # This is a JSON template for a participant in a room. class RoomParticipant include Google::Apis::Core::Hashable # True if this participant was auto-matched with the requesting player. # Corresponds to the JSON property `autoMatched` # @return [Boolean] attr_accessor :auto_matched alias_method :auto_matched?, :auto_matched # This is a JSON template for an anonymous player # Corresponds to the JSON property `autoMatchedPlayer` # @return [Google::Apis::GamesV1::AnonymousPlayer] attr_accessor :auto_matched_player # The capabilities which can be used when communicating with this participant. # Corresponds to the JSON property `capabilities` # @return [Array] attr_accessor :capabilities # This is a JSON template for the client address when setting up a room. # Corresponds to the JSON property `clientAddress` # @return [Google::Apis::GamesV1::RoomClientAddress] attr_accessor :client_address # True if this participant is in the fully connected set of peers in the room. # Corresponds to the JSON property `connected` # @return [Boolean] attr_accessor :connected alias_method :connected?, :connected # An identifier for the participant in the scope of the room. Cannot be used to # identify a player across rooms or in other contexts. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomParticipant. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The reason the participant left the room; populated if the participant status # is PARTICIPANT_LEFT. # Possible values are: # - "PLAYER_LEFT" - The player explicitly chose to leave the room. # - "GAME_LEFT" - The game chose to remove the player from the room. # - "ABANDONED" - The player switched to another application and abandoned the # room. # - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a # connection to other peer(s) in the room. # - "SERVER_ERROR" - The client received an error response when it tried to # communicate with the server. # - "TIMEOUT" - The client timed out while waiting for players to join and # connect. # - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly. # Corresponds to the JSON property `leaveReason` # @return [String] attr_accessor :leave_reason # This is a JSON template for a Player resource. # Corresponds to the JSON property `player` # @return [Google::Apis::GamesV1::Player] attr_accessor :player # The status of the participant with respect to the room. # Possible values are: # - "PARTICIPANT_INVITED" - The participant has been invited to join the room, # but has not yet responded. # - "PARTICIPANT_JOINED" - The participant has joined the room (either after # creating it or accepting an invitation.) # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the # room. # - "PARTICIPANT_LEFT" - The participant joined the room and then left it. # 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) @auto_matched = args[:auto_matched] if args.key?(:auto_matched) @auto_matched_player = args[:auto_matched_player] if args.key?(:auto_matched_player) @capabilities = args[:capabilities] if args.key?(:capabilities) @client_address = args[:client_address] if args.key?(:client_address) @connected = args[:connected] if args.key?(:connected) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @leave_reason = args[:leave_reason] if args.key?(:leave_reason) @player = args[:player] if args.key?(:player) @status = args[:status] if args.key?(:status) end end # This is a JSON template for the status of a room that the player has joined. class RoomStatus include Google::Apis::Core::Hashable # This is a JSON template for status of room automatching that is in progress. # Corresponds to the JSON property `autoMatchingStatus` # @return [Google::Apis::GamesV1::RoomAutoMatchStatus] attr_accessor :auto_matching_status # Uniquely identifies the type of this resource. Value is always the fixed # string games#roomStatus. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The participants involved in the room, along with their statuses. Includes # participants who have left or declined invitations. # Corresponds to the JSON property `participants` # @return [Array] attr_accessor :participants # Globally unique ID for a room. # Corresponds to the JSON property `roomId` # @return [String] attr_accessor :room_id # The status of the room. # Possible values are: # - "ROOM_INVITING" - One or more players have been invited and not responded. # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. # - "ROOM_CONNECTING" - Players have joined are connecting to each other (either # before or after auto-matching). # - "ROOM_ACTIVE" - All players have joined and connected to each other. # - "ROOM_DELETED" - All joined players have left. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The version of the status for the room: an increasing counter, used by the # client to ignore out-of-order updates to room status. # Corresponds to the JSON property `statusVersion` # @return [Fixnum] attr_accessor :status_version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_matching_status = args[:auto_matching_status] if args.key?(:auto_matching_status) @kind = args[:kind] if args.key?(:kind) @participants = args[:participants] if args.key?(:participants) @room_id = args[:room_id] if args.key?(:room_id) @status = args[:status] if args.key?(:status) @status_version = args[:status_version] if args.key?(:status_version) end end # This is a JSON template for a request to submit a score to leaderboards. class ScoreSubmission include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#scoreSubmission. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The leaderboard this score is being submitted to. # Corresponds to the JSON property `leaderboardId` # @return [String] attr_accessor :leaderboard_id # The new score being submitted. # Corresponds to the JSON property `score` # @return [Fixnum] attr_accessor :score # Additional information about this score. Values will contain no more than 64 # URI-safe characters as defined by section 2.3 of RFC 3986. # Corresponds to the JSON property `scoreTag` # @return [String] attr_accessor :score_tag # Signature Values will contain URI-safe characters as defined by section 2.3 of # RFC 3986. # Corresponds to the JSON property `signature` # @return [String] attr_accessor :signature def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @leaderboard_id = args[:leaderboard_id] if args.key?(:leaderboard_id) @score = args[:score] if args.key?(:score) @score_tag = args[:score_tag] if args.key?(:score_tag) @signature = args[:signature] if args.key?(:signature) end end # This is a JSON template for an snapshot object. class Snapshot include Google::Apis::Core::Hashable # This is a JSON template for an image of a snapshot. # Corresponds to the JSON property `coverImage` # @return [Google::Apis::GamesV1::SnapshotImage] attr_accessor :cover_image # The description of this snapshot. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The ID of the file underlying this snapshot in the Drive API. Only present if # the snapshot is a view on a Drive file and the file is owned by the caller. # Corresponds to the JSON property `driveId` # @return [String] attr_accessor :drive_id # The duration associated with this snapshot, in millis. # Corresponds to the JSON property `durationMillis` # @return [Fixnum] attr_accessor :duration_millis # The ID of the snapshot. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Uniquely identifies the type of this resource. Value is always the fixed # string games#snapshot. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The timestamp (in millis since Unix epoch) of the last modification to this # snapshot. # Corresponds to the JSON property `lastModifiedMillis` # @return [Fixnum] attr_accessor :last_modified_millis # The progress value (64-bit integer set by developer) associated with this # snapshot. # Corresponds to the JSON property `progressValue` # @return [Fixnum] attr_accessor :progress_value # The title of this snapshot. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The type of this snapshot. # Possible values are: # - "SAVE_GAME" - A snapshot representing a save game. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The unique name provided when the snapshot was created. # Corresponds to the JSON property `uniqueName` # @return [String] attr_accessor :unique_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cover_image = args[:cover_image] if args.key?(:cover_image) @description = args[:description] if args.key?(:description) @drive_id = args[:drive_id] if args.key?(:drive_id) @duration_millis = args[:duration_millis] if args.key?(:duration_millis) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_modified_millis = args[:last_modified_millis] if args.key?(:last_modified_millis) @progress_value = args[:progress_value] if args.key?(:progress_value) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) @unique_name = args[:unique_name] if args.key?(:unique_name) end end # This is a JSON template for an image of a snapshot. class SnapshotImage include Google::Apis::Core::Hashable # The height of the image. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # Uniquely identifies the type of this resource. Value is always the fixed # string games#snapshotImage. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The MIME type of the image. # Corresponds to the JSON property `mime_type` # @return [String] attr_accessor :mime_type # The URL of the image. This URL may be invalidated at any time and should not # be cached. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # The width of the image. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @kind = args[:kind] if args.key?(:kind) @mime_type = args[:mime_type] if args.key?(:mime_type) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end # This is a JSON template for a list of snapshot objects. class ListSnapshotResponse include Google::Apis::Core::Hashable # The snapshots. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#snapshotListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token corresponding to the next page of results. If there are no more results, # the token is omitted. # 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) @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) end end # This is a JSON template for an turn-based auto-match criteria object. class TurnBasedAutoMatchingCriteria include Google::Apis::Core::Hashable # A bitmask indicating when auto-matches are valid. When ANDed with other # exclusive bitmasks, the result must be zero. Can be used to support exclusive # roles within a game. # Corresponds to the JSON property `exclusiveBitmask` # @return [Fixnum] attr_accessor :exclusive_bitmask # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedAutoMatchingCriteria. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The maximum number of players that should be added to the match by auto- # matching. # Corresponds to the JSON property `maxAutoMatchingPlayers` # @return [Fixnum] attr_accessor :max_auto_matching_players # The minimum number of players that should be added to the match by auto- # matching. # Corresponds to the JSON property `minAutoMatchingPlayers` # @return [Fixnum] attr_accessor :min_auto_matching_players def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @exclusive_bitmask = args[:exclusive_bitmask] if args.key?(:exclusive_bitmask) @kind = args[:kind] if args.key?(:kind) @max_auto_matching_players = args[:max_auto_matching_players] if args.key?(:max_auto_matching_players) @min_auto_matching_players = args[:min_auto_matching_players] if args.key?(:min_auto_matching_players) end end # This is a JSON template for a turn-based match resource object. class TurnBasedMatch include Google::Apis::Core::Hashable # The ID of the application being played. # Corresponds to the JSON property `applicationId` # @return [String] attr_accessor :application_id # This is a JSON template for an turn-based auto-match criteria object. # Corresponds to the JSON property `autoMatchingCriteria` # @return [Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria] attr_accessor :auto_matching_criteria # This is a JSON template for turn-based match modification metadata. # Corresponds to the JSON property `creationDetails` # @return [Google::Apis::GamesV1::TurnBasedMatchModification] attr_accessor :creation_details # This is a JSON template for a turn-based match data object. # Corresponds to the JSON property `data` # @return [Google::Apis::GamesV1::TurnBasedMatchData] attr_accessor :data # This short description is generated by our servers based on turn state and is # localized and worded relative to the player requesting the match. It is # intended to be displayed when the match is shown in a list. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The ID of the participant that invited the user to the match. Not set if the # user was not invited to the match. # Corresponds to the JSON property `inviterId` # @return [String] attr_accessor :inviter_id # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatch. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for turn-based match modification metadata. # Corresponds to the JSON property `lastUpdateDetails` # @return [Google::Apis::GamesV1::TurnBasedMatchModification] attr_accessor :last_update_details # Globally unique ID for a turn-based match. # Corresponds to the JSON property `matchId` # @return [String] attr_accessor :match_id # The number of the match in a chain of rematches. Will be set to 1 for the # first match and incremented by 1 for each rematch. # Corresponds to the JSON property `matchNumber` # @return [Fixnum] attr_accessor :match_number # The version of this match: an increasing counter, used to avoid out-of-date # updates to the match. # Corresponds to the JSON property `matchVersion` # @return [Fixnum] attr_accessor :match_version # The participants involved in the match, along with their statuses. Includes # participants who have left or declined invitations. # Corresponds to the JSON property `participants` # @return [Array] attr_accessor :participants # The ID of the participant that is taking a turn. # Corresponds to the JSON property `pendingParticipantId` # @return [String] attr_accessor :pending_participant_id # This is a JSON template for a turn-based match data object. # Corresponds to the JSON property `previousMatchData` # @return [Google::Apis::GamesV1::TurnBasedMatchData] attr_accessor :previous_match_data # The ID of a rematch of this match. Only set for completed matches that have # been rematched. # Corresponds to the JSON property `rematchId` # @return [String] attr_accessor :rematch_id # The results reported for this match. # Corresponds to the JSON property `results` # @return [Array] attr_accessor :results # The status of the match. # Possible values are: # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; # the match cannot be established until they are filled. # - "MATCH_ACTIVE" - The match has started. # - "MATCH_COMPLETE" - The match has finished. # - "MATCH_CANCELED" - The match was canceled. # - "MATCH_EXPIRED" - The match expired due to inactivity. # - "MATCH_DELETED" - The match should no longer be shown on the client. # Returned only for tombstones for matches when sync is called. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The status of the current user in the match. Derived from the match type, # match status, the user's participant status, and the pending participant for # the match. # Possible values are: # - "USER_INVITED" - The user has been invited to join the match and has not # responded yet. # - "USER_AWAITING_TURN" - The user is waiting for their turn. # - "USER_TURN" - The user has an action to take in the match. # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or # expired.) # Corresponds to the JSON property `userMatchStatus` # @return [String] attr_accessor :user_match_status # The variant / mode of the application being played; can be any integer value, # or left blank. # Corresponds to the JSON property `variant` # @return [Fixnum] attr_accessor :variant # The ID of another participant in the match that can be used when describing # the participants the user is playing with. # Corresponds to the JSON property `withParticipantId` # @return [String] attr_accessor :with_participant_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @application_id = args[:application_id] if args.key?(:application_id) @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria) @creation_details = args[:creation_details] if args.key?(:creation_details) @data = args[:data] if args.key?(:data) @description = args[:description] if args.key?(:description) @inviter_id = args[:inviter_id] if args.key?(:inviter_id) @kind = args[:kind] if args.key?(:kind) @last_update_details = args[:last_update_details] if args.key?(:last_update_details) @match_id = args[:match_id] if args.key?(:match_id) @match_number = args[:match_number] if args.key?(:match_number) @match_version = args[:match_version] if args.key?(:match_version) @participants = args[:participants] if args.key?(:participants) @pending_participant_id = args[:pending_participant_id] if args.key?(:pending_participant_id) @previous_match_data = args[:previous_match_data] if args.key?(:previous_match_data) @rematch_id = args[:rematch_id] if args.key?(:rematch_id) @results = args[:results] if args.key?(:results) @status = args[:status] if args.key?(:status) @user_match_status = args[:user_match_status] if args.key?(:user_match_status) @variant = args[:variant] if args.key?(:variant) @with_participant_id = args[:with_participant_id] if args.key?(:with_participant_id) end end # This is a JSON template for a turn-based match creation request. class CreateTurnBasedMatchRequest include Google::Apis::Core::Hashable # This is a JSON template for an turn-based auto-match criteria object. # Corresponds to the JSON property `autoMatchingCriteria` # @return [Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria] attr_accessor :auto_matching_criteria # The player ids to invite to the match. # Corresponds to the JSON property `invitedPlayerIds` # @return [Array] attr_accessor :invited_player_ids # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatchCreateRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A randomly generated numeric ID. This number is used at the server to ensure # that the request is handled correctly across retries. # Corresponds to the JSON property `requestId` # @return [Fixnum] attr_accessor :request_id # The variant / mode of the application to be played. This can be any integer # value, or left blank. You should use a small number of variants to keep the # auto-matching pool as large as possible. # Corresponds to the JSON property `variant` # @return [Fixnum] attr_accessor :variant def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria) @invited_player_ids = args[:invited_player_ids] if args.key?(:invited_player_ids) @kind = args[:kind] if args.key?(:kind) @request_id = args[:request_id] if args.key?(:request_id) @variant = args[:variant] if args.key?(:variant) end end # This is a JSON template for a turn-based match data object. class TurnBasedMatchData include Google::Apis::Core::Hashable # The byte representation of the data (limited to 128 kB), as a Base64-encoded # string with the URL_SAFE encoding option. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data # True if this match has data available but it wasn't returned in a list # response; fetching the match individually will retrieve this data. # Corresponds to the JSON property `dataAvailable` # @return [Boolean] attr_accessor :data_available alias_method :data_available?, :data_available # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatchData. # 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) @data = args[:data] if args.key?(:data) @data_available = args[:data_available] if args.key?(:data_available) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for sending a turn-based match data object. class TurnBasedMatchDataRequest include Google::Apis::Core::Hashable # The byte representation of the data (limited to 128 kB), as a Base64-encoded # string with the URL_SAFE encoding option. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatchDataRequest. # 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) @data = args[:data] if args.key?(:data) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for a list of turn-based matches. class TurnBasedMatchList include Google::Apis::Core::Hashable # The matches. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatchList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The pagination token for 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) @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) end end # This is a JSON template for turn-based match modification metadata. class TurnBasedMatchModification include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatchModification. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The timestamp at which they modified the match, in milliseconds since the # epoch in UTC. # Corresponds to the JSON property `modifiedTimestampMillis` # @return [Fixnum] attr_accessor :modified_timestamp_millis # The ID of the participant that modified the match. # Corresponds to the JSON property `participantId` # @return [String] attr_accessor :participant_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @modified_timestamp_millis = args[:modified_timestamp_millis] if args.key?(:modified_timestamp_millis) @participant_id = args[:participant_id] if args.key?(:participant_id) end end # This is a JSON template for a participant in a turn-based match. class TurnBasedMatchParticipant include Google::Apis::Core::Hashable # True if this participant was auto-matched with the requesting player. # Corresponds to the JSON property `autoMatched` # @return [Boolean] attr_accessor :auto_matched alias_method :auto_matched?, :auto_matched # This is a JSON template for an anonymous player # Corresponds to the JSON property `autoMatchedPlayer` # @return [Google::Apis::GamesV1::AnonymousPlayer] attr_accessor :auto_matched_player # An identifier for the participant in the scope of the match. Cannot be used to # identify a player across matches or in other contexts. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatchParticipant. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for a Player resource. # Corresponds to the JSON property `player` # @return [Google::Apis::GamesV1::Player] attr_accessor :player # The status of the participant with respect to the match. # Possible values are: # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to # the match, but the invitation has not been sent; the invite will be sent when # it becomes their turn. # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, # but has not yet responded. # - "PARTICIPANT_JOINED" - The participant has joined the match (either after # creating it or accepting an invitation.) # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the # match. # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the # allotted time. # 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) @auto_matched = args[:auto_matched] if args.key?(:auto_matched) @auto_matched_player = args[:auto_matched_player] if args.key?(:auto_matched_player) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @player = args[:player] if args.key?(:player) @status = args[:status] if args.key?(:status) end end # This is a JSON template for a rematch response. class TurnBasedMatchRematch include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatchRematch. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for a turn-based match resource object. # Corresponds to the JSON property `previousMatch` # @return [Google::Apis::GamesV1::TurnBasedMatch] attr_accessor :previous_match # This is a JSON template for a turn-based match resource object. # Corresponds to the JSON property `rematch` # @return [Google::Apis::GamesV1::TurnBasedMatch] attr_accessor :rematch def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @previous_match = args[:previous_match] if args.key?(:previous_match) @rematch = args[:rematch] if args.key?(:rematch) end end # This is a JSON template for a turn-based match results object. class TurnBasedMatchResults include Google::Apis::Core::Hashable # This is a JSON template for sending a turn-based match data object. # Corresponds to the JSON property `data` # @return [Google::Apis::GamesV1::TurnBasedMatchDataRequest] attr_accessor :data # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatchResults. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The version of the match being updated. # Corresponds to the JSON property `matchVersion` # @return [Fixnum] attr_accessor :match_version # The match results for the participants in the match. # 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) @data = args[:data] if args.key?(:data) @kind = args[:kind] if args.key?(:kind) @match_version = args[:match_version] if args.key?(:match_version) @results = args[:results] if args.key?(:results) end end # This is a JSON template for a list of turn-based matches returned from a sync. class TurnBasedMatchSync include Google::Apis::Core::Hashable # The matches. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatchSync. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # True if there were more matches available to fetch at the time the response # was generated (which were not returned due to page size limits.) # Corresponds to the JSON property `moreAvailable` # @return [Boolean] attr_accessor :more_available alias_method :more_available?, :more_available # The pagination token for 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @more_available = args[:more_available] if args.key?(:more_available) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # This is a JSON template for the object representing a turn. class TurnBasedMatchTurn include Google::Apis::Core::Hashable # This is a JSON template for sending a turn-based match data object. # Corresponds to the JSON property `data` # @return [Google::Apis::GamesV1::TurnBasedMatchDataRequest] attr_accessor :data # Uniquely identifies the type of this resource. Value is always the fixed # string games#turnBasedMatchTurn. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The version of this match: an increasing counter, used to avoid out-of-date # updates to the match. # Corresponds to the JSON property `matchVersion` # @return [Fixnum] attr_accessor :match_version # The ID of the participant who should take their turn next. May be set to the # current player's participant ID to update match state without changing the # turn. If not set, the match will wait for other player(s) to join via # automatching; this is only valid if automatch criteria is set on the match # with remaining slots for automatched players. # Corresponds to the JSON property `pendingParticipantId` # @return [String] attr_accessor :pending_participant_id # The match results for the participants in the match. # 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) @data = args[:data] if args.key?(:data) @kind = args[:kind] if args.key?(:kind) @match_version = args[:match_version] if args.key?(:match_version) @pending_participant_id = args[:pending_participant_id] if args.key?(:pending_participant_id) @results = args[:results] if args.key?(:results) end end end end end google-api-client-0.19.8/generated/google/apis/games_v1/service.rb0000644000004100000410000042203713252673043025012 0ustar www-datawww-data# 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 GamesV1 # Google Play Game Services API # # The API for Google Play Game Services. # # @example # require 'google/apis/games_v1' # # Games = Google::Apis::GamesV1 # Alias the module # service = Games::GamesService.new # # @see https://developers.google.com/games/services/ class GamesService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'games/v1/') @batch_path = 'batch/games/v1' end # Lists all the achievement definitions for your application. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of achievement resources to return in the response, used # for paging. For any response, the actual number of achievement resources # returned may be less than the specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListAchievementDefinitionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListAchievementDefinitionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_achievement_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'achievements', options) command.response_representation = Google::Apis::GamesV1::ListAchievementDefinitionsResponse::Representation command.response_class = Google::Apis::GamesV1::ListAchievementDefinitionsResponse command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.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 # Increments the steps of the achievement with the given ID for the currently # authenticated player. # @param [String] achievement_id # The ID of the achievement used by this method. # @param [Fixnum] steps_to_increment # The number of steps to increment. # @param [Fixnum] request_id # A randomly generated numeric ID for each request specified by the caller. This # number is used at the server to ensure that the request is handled correctly # across retries. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::AchievementIncrementResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::AchievementIncrementResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def increment_achievement(achievement_id, steps_to_increment, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'achievements/{achievementId}/increment', options) command.response_representation = Google::Apis::GamesV1::AchievementIncrementResponse::Representation command.response_class = Google::Apis::GamesV1::AchievementIncrementResponse command.params['achievementId'] = achievement_id unless achievement_id.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['stepsToIncrement'] = steps_to_increment unless steps_to_increment.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 progress for all your application's achievements for the currently # authenticated player. # @param [String] player_id # A player ID. A value of me may be used in place of the authenticated player's # ID. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of achievement resources to return in the response, used # for paging. For any response, the actual number of achievement resources # returned may be less than the specified maxResults. # @param [String] page_token # The token returned by the previous request. # @param [String] state # Tells the server to return only achievements with the specified state. If this # parameter isn't specified, all achievements are 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListPlayerAchievementResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListPlayerAchievementResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_achievements(player_id, language: nil, max_results: nil, page_token: nil, state: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'players/{playerId}/achievements', options) command.response_representation = Google::Apis::GamesV1::ListPlayerAchievementResponse::Representation command.response_class = Google::Apis::GamesV1::ListPlayerAchievementResponse command.params['playerId'] = player_id unless player_id.nil? command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['state'] = state unless state.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 state of the achievement with the given ID to REVEALED for the # currently authenticated player. # @param [String] achievement_id # The ID of the achievement used by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::AchievementRevealResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::AchievementRevealResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def reveal_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'achievements/{achievementId}/reveal', options) command.response_representation = Google::Apis::GamesV1::AchievementRevealResponse::Representation command.response_class = Google::Apis::GamesV1::AchievementRevealResponse command.params['achievementId'] = achievement_id unless achievement_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 # Sets the steps for the currently authenticated player towards unlocking an # achievement. If the steps parameter is less than the current number of steps # that the player already gained for the achievement, the achievement is not # modified. # @param [String] achievement_id # The ID of the achievement used by this method. # @param [Fixnum] steps # The minimum value to set the steps to. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_achievement_steps_at_least(achievement_id, steps, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'achievements/{achievementId}/setStepsAtLeast', options) command.response_representation = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse::Representation command.response_class = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse command.params['achievementId'] = achievement_id unless achievement_id.nil? command.query['steps'] = steps unless steps.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 # Unlocks this achievement for the currently authenticated player. # @param [String] achievement_id # The ID of the achievement used by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::AchievementUnlockResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::AchievementUnlockResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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, 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['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 multiple achievements for the currently authenticated player. # @param [Google::Apis::GamesV1::AchievementUpdateMultipleRequest] achievement_update_multiple_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::AchievementUpdateMultipleResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::AchievementUpdateMultipleResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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, 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['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 the metadata of the application with the given ID. If the requested # application is not available for the specified platformType, the returned # response will not include any instance data. # @param [String] application_id # The application ID from the Google Play developer console. # @param [String] language # The preferred language to use for strings returned by this method. # @param [String] platform_type # Restrict application details returned to the specific platform. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::Application] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::Application] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_application(application_id, language: nil, platform_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'applications/{applicationId}', options) command.response_representation = Google::Apis::GamesV1::Application::Representation command.response_class = Google::Apis::GamesV1::Application command.params['applicationId'] = application_id unless application_id.nil? command.query['language'] = language unless language.nil? command.query['platformType'] = platform_type unless platform_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 # Indicate that the the currently authenticated user is playing your application. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 played_application(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'applications/played', options) 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 # Verifies the auth token provided with this request is for the application with # the specified ID, and returns the ID of the player it was granted for. # @param [String] application_id # The application ID from the Google Play developer console. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ApplicationVerifyResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ApplicationVerifyResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def verify_application(application_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'applications/{applicationId}/verify', options) command.response_representation = Google::Apis::GamesV1::ApplicationVerifyResponse::Representation command.response_class = Google::Apis::GamesV1::ApplicationVerifyResponse command.params['applicationId'] = application_id unless application_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 a list showing the current progress on events in this application for # the currently authenticated user. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of events to return in the response, used for paging. For # any response, the actual number of events to return may be less than the # specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListPlayerEventResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListPlayerEventResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_by_player(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'events', options) command.response_representation = Google::Apis::GamesV1::ListPlayerEventResponse::Representation command.response_class = Google::Apis::GamesV1::ListPlayerEventResponse command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.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 # Returns a list of the event definitions in this application. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of event definitions to return in the response, used for # paging. For any response, the actual number of event definitions to return may # be less than the specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListEventDefinitionResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListEventDefinitionResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'eventDefinitions', options) command.response_representation = Google::Apis::GamesV1::ListEventDefinitionResponse::Representation command.response_class = Google::Apis::GamesV1::ListEventDefinitionResponse command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.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 # Records a batch of changes to the number of times events have occurred for the # currently authenticated user of this application. # @param [Google::Apis::GamesV1::EventRecordRequest] event_record_request_object # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::UpdateEventResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::UpdateEventResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def record_event(event_record_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'events', options) command.request_representation = Google::Apis::GamesV1::EventRecordRequest::Representation command.request_object = event_record_request_object command.response_representation = Google::Apis::GamesV1::UpdateEventResponse::Representation command.response_class = Google::Apis::GamesV1::UpdateEventResponse command.query['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 # Retrieves the metadata of the leaderboard with the given ID. # @param [String] leaderboard_id # The ID of the leaderboard. # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::Leaderboard] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::Leaderboard] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_leaderboard(leaderboard_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'leaderboards/{leaderboardId}', options) command.response_representation = Google::Apis::GamesV1::Leaderboard::Representation command.response_class = Google::Apis::GamesV1::Leaderboard command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.query['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 leaderboard metadata for your application. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of leaderboards to return in the response. For any response, # the actual number of leaderboards returned may be less than the specified # maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListLeaderboardResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListLeaderboardResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_leaderboards(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'leaderboards', options) command.response_representation = Google::Apis::GamesV1::ListLeaderboardResponse::Representation command.response_class = Google::Apis::GamesV1::ListLeaderboardResponse command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.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 # Return the metagame configuration data for the calling application. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::MetagameConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::MetagameConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metagame_config(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'metagameConfig', options) command.response_representation = Google::Apis::GamesV1::MetagameConfig::Representation command.response_class = Google::Apis::GamesV1::MetagameConfig 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 play data aggregated per category for the player corresponding to # playerId. # @param [String] player_id # A player ID. A value of me may be used in place of the authenticated player's # ID. # @param [String] collection # The collection of categories for which data will be returned. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of category resources to return in the response, used for # paging. For any response, the actual number of category resources returned may # be less than the specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListCategoryResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListCategoryResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metagame_categories_by_player(player_id, collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'players/{playerId}/categories/{collection}', options) command.response_representation = Google::Apis::GamesV1::ListCategoryResponse::Representation command.response_class = Google::Apis::GamesV1::ListCategoryResponse command.params['playerId'] = player_id unless player_id.nil? command.params['collection'] = collection unless collection.nil? command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.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 # Retrieves the Player resource with the given ID. To retrieve the player for # the currently authenticated user, set playerId to me. # @param [String] player_id # A player ID. A value of me may be used in place of the authenticated player's # ID. # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::Player] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::Player] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_player(player_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'players/{playerId}', options) command.response_representation = Google::Apis::GamesV1::Player::Representation command.response_class = Google::Apis::GamesV1::Player command.params['playerId'] = player_id unless player_id.nil? command.query['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 # Get the collection of players for the currently authenticated user. # @param [String] collection # Collection of players being retrieved # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of player resources to return in the response, used for # paging. For any response, the actual number of player resources returned may # be less than the specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListPlayerResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListPlayerResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_players(collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'players/me/players/{collection}', options) command.response_representation = Google::Apis::GamesV1::ListPlayerResponse::Representation command.response_class = Google::Apis::GamesV1::ListPlayerResponse command.params['collection'] = collection unless collection.nil? command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.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 # Removes a push token for the current user and application. Removing a non- # existent push token will report success. # @param [Google::Apis::GamesV1::PushTokenId] push_token_id_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 remove_pushtoken(push_token_id_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'pushtokens/remove', options) command.request_representation = Google::Apis::GamesV1::PushTokenId::Representation command.request_object = push_token_id_object 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 # Registers a push token for the current user and application. # @param [Google::Apis::GamesV1::PushToken] push_token_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 update_pushtoken(push_token_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'pushtokens', options) command.request_representation = Google::Apis::GamesV1::PushToken::Representation command.request_object = push_token_object 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 # Report that a reward for the milestone corresponding to milestoneId for the # quest corresponding to questId has been claimed by the currently authorized # user. # @param [String] quest_id # The ID of the quest. # @param [String] milestone_id # The ID of the milestone. # @param [Fixnum] request_id # A numeric ID to ensure that the request is handled correctly across retries. # Your client application must generate this ID randomly. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 claim_quest_milestone(quest_id, milestone_id, request_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'quests/{questId}/milestones/{milestoneId}/claim', options) command.params['questId'] = quest_id unless quest_id.nil? command.params['milestoneId'] = milestone_id unless milestone_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 # Indicates that the currently authorized user will participate in the quest. # @param [String] quest_id # The ID of the quest. # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::Quest] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::Quest] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def accept_quest(quest_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'quests/{questId}/accept', options) command.response_representation = Google::Apis::GamesV1::Quest::Representation command.response_class = Google::Apis::GamesV1::Quest command.params['questId'] = quest_id unless quest_id.nil? command.query['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 # Get a list of quests for your application and the currently authenticated # player. # @param [String] player_id # A player ID. A value of me may be used in place of the authenticated player's # ID. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of quest resources to return in the response, used for # paging. For any response, the actual number of quest resources returned may be # less than the specified maxResults. Acceptable values are 1 to 50, inclusive. ( # Default: 50). # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListQuestResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListQuestResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_quests(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'players/{playerId}/quests', options) command.response_representation = Google::Apis::GamesV1::ListQuestResponse::Representation command.response_class = Google::Apis::GamesV1::ListQuestResponse command.params['playerId'] = player_id unless player_id.nil? command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.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 # Checks whether the games client is out of date. # @param [String] client_revision # The revision of the client SDK used by your application. Format: # [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: # # - "ANDROID" - Client is running the Android SDK. # - "IOS" - Client is running the iOS SDK. # - "WEB_APP" - Client is running as a Web 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::CheckRevisionResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::CheckRevisionResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def check_revision(client_revision, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'revisions/check', options) command.response_representation = Google::Apis::GamesV1::CheckRevisionResponse::Representation command.response_class = Google::Apis::GamesV1::CheckRevisionResponse command.query['clientRevision'] = client_revision unless client_revision.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 # Create a room. For internal use by the Games SDK only. Calling this method # directly is unsupported. # @param [Google::Apis::GamesV1::CreateRoomRequest] create_room_request_object # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::Room] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_room(create_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'rooms/create', options) command.request_representation = Google::Apis::GamesV1::CreateRoomRequest::Representation command.request_object = create_room_request_object command.response_representation = Google::Apis::GamesV1::Room::Representation command.response_class = Google::Apis::GamesV1::Room command.query['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 # Decline an invitation to join a room. For internal use by the Games SDK only. # Calling this method directly is unsupported. # @param [String] room_id # The ID of the room. # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::Room] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def decline_room(room_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'rooms/{roomId}/decline', options) command.response_representation = Google::Apis::GamesV1::Room::Representation command.response_class = Google::Apis::GamesV1::Room command.params['roomId'] = room_id unless room_id.nil? command.query['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 # Dismiss an invitation to join a room. For internal use by the Games SDK only. # Calling this method directly is unsupported. # @param [String] room_id # The ID of the room. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 dismiss_room(room_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'rooms/{roomId}/dismiss', options) command.params['roomId'] = room_id unless room_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 # Get the data for a room. # @param [String] room_id # The ID of the room. # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::Room] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_room(room_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'rooms/{roomId}', options) command.response_representation = Google::Apis::GamesV1::Room::Representation command.response_class = Google::Apis::GamesV1::Room command.params['roomId'] = room_id unless room_id.nil? command.query['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 # Join a room. For internal use by the Games SDK only. Calling this method # directly is unsupported. # @param [String] room_id # The ID of the room. # @param [Google::Apis::GamesV1::JoinRoomRequest] join_room_request_object # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::Room] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def join_room(room_id, join_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'rooms/{roomId}/join', options) command.request_representation = Google::Apis::GamesV1::JoinRoomRequest::Representation command.request_object = join_room_request_object command.response_representation = Google::Apis::GamesV1::Room::Representation command.response_class = Google::Apis::GamesV1::Room command.params['roomId'] = room_id unless room_id.nil? command.query['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 # Leave a room. For internal use by the Games SDK only. Calling this method # directly is unsupported. # @param [String] room_id # The ID of the room. # @param [Google::Apis::GamesV1::LeaveRoomRequest] leave_room_request_object # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::Room] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def leave_room(room_id, leave_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'rooms/{roomId}/leave', options) command.request_representation = Google::Apis::GamesV1::LeaveRoomRequest::Representation command.request_object = leave_room_request_object command.response_representation = Google::Apis::GamesV1::Room::Representation command.response_class = Google::Apis::GamesV1::Room command.params['roomId'] = room_id unless room_id.nil? command.query['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 invitations to join rooms. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of rooms to return in the response, used for paging. For # any response, the actual number of rooms to return may be less than the # specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::RoomList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::RoomList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_rooms(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'rooms', options) command.response_representation = Google::Apis::GamesV1::RoomList::Representation command.response_class = Google::Apis::GamesV1::RoomList command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.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 sent by a client reporting the status of peers in a room. For internal # use by the Games SDK only. Calling this method directly is unsupported. # @param [String] room_id # The ID of the room. # @param [Google::Apis::GamesV1::RoomP2PStatuses] room_p2_p_statuses_object # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::RoomStatus] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::RoomStatus] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def report_room_status(room_id, room_p2_p_statuses_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'rooms/{roomId}/reportstatus', options) command.request_representation = Google::Apis::GamesV1::RoomP2PStatuses::Representation command.request_object = room_p2_p_statuses_object command.response_representation = Google::Apis::GamesV1::RoomStatus::Representation command.response_class = Google::Apis::GamesV1::RoomStatus command.params['roomId'] = room_id unless room_id.nil? command.query['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 # Get high scores, and optionally ranks, in leaderboards for the currently # authenticated player. For a specific time span, leaderboardId can be set to # ALL to retrieve data for all leaderboards in a given time span. # NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same # request; only one parameter may be set to 'ALL'. # @param [String] player_id # A player ID. A value of me may be used in place of the authenticated player's # ID. # @param [String] leaderboard_id # The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all # leaderboards for this application. # @param [String] time_span # The time span for the scores and ranks you're requesting. # @param [String] include_rank_type # The types of ranks to return. If the parameter is omitted, no ranks will be # returned. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of leaderboard scores to return in the response. For any # response, the actual number of leaderboard scores returned may be less than # the specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_score(player_id, leaderboard_id, time_span, include_rank_type: nil, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}', options) command.response_representation = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse::Representation command.response_class = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse command.params['playerId'] = player_id unless player_id.nil? command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.params['timeSpan'] = time_span unless time_span.nil? command.query['includeRankType'] = include_rank_type unless include_rank_type.nil? command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.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 # Lists the scores in a leaderboard, starting from the top. # @param [String] leaderboard_id # The ID of the leaderboard. # @param [String] collection # The collection of scores you're requesting. # @param [String] time_span # The time span for the scores and ranks you're requesting. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of leaderboard scores to return in the response. For any # response, the actual number of leaderboard scores returned may be less than # the specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::LeaderboardScores] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::LeaderboardScores] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_scores(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'leaderboards/{leaderboardId}/scores/{collection}', options) command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation command.response_class = Google::Apis::GamesV1::LeaderboardScores command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.params['collection'] = collection unless collection.nil? command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['timeSpan'] = time_span unless time_span.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 scores in a leaderboard around (and including) a player's score. # @param [String] leaderboard_id # The ID of the leaderboard. # @param [String] collection # The collection of scores you're requesting. # @param [String] time_span # The time span for the scores and ranks you're requesting. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of leaderboard scores to return in the response. For any # response, the actual number of leaderboard scores returned may be less than # the specified maxResults. # @param [String] page_token # The token returned by the previous request. # @param [Fixnum] results_above # The preferred number of scores to return above the player's score. More scores # may be returned if the player is at the bottom of the leaderboard; fewer may # be returned if the player is at the top. Must be less than or equal to # maxResults. # @param [Boolean] return_top_if_absent # True if the top scores should be returned when the player is not in the # leaderboard. Defaults to true. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::LeaderboardScores] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::LeaderboardScores] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_score_window(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, results_above: nil, return_top_if_absent: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'leaderboards/{leaderboardId}/window/{collection}', options) command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation command.response_class = Google::Apis::GamesV1::LeaderboardScores command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.params['collection'] = collection unless collection.nil? command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['resultsAbove'] = results_above unless results_above.nil? command.query['returnTopIfAbsent'] = return_top_if_absent unless return_top_if_absent.nil? command.query['timeSpan'] = time_span unless time_span.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 # Submits a score to the specified leaderboard. # @param [String] leaderboard_id # The ID of the leaderboard. # @param [Fixnum] score # The score you're submitting. The submitted score is ignored if it is worse # than a previously submitted score, where worse depends on the leaderboard sort # order. The meaning of the score value depends on the leaderboard format type. # For fixed-point, the score represents the raw value. For time, the score # represents elapsed time in milliseconds. For currency, the score represents a # value in micro units. # @param [String] language # The preferred language to use for strings returned by this method. # @param [String] score_tag # Additional information about the score you're submitting. Values must contain # no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::PlayerScoreResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::PlayerScoreResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def submit_score(leaderboard_id, score, language: nil, score_tag: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'leaderboards/{leaderboardId}/scores', options) command.response_representation = Google::Apis::GamesV1::PlayerScoreResponse::Representation command.response_class = Google::Apis::GamesV1::PlayerScoreResponse command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.query['language'] = language unless language.nil? command.query['score'] = score unless score.nil? command.query['scoreTag'] = score_tag unless score_tag.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 # Submits multiple scores to leaderboards. # @param [Google::Apis::GamesV1::PlayerScoreSubmissionList] player_score_submission_list_object # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListPlayerScoreResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListPlayerScoreResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def submit_score_multiple(player_score_submission_list_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'leaderboards/scores', options) command.request_representation = Google::Apis::GamesV1::PlayerScoreSubmissionList::Representation command.request_object = player_score_submission_list_object command.response_representation = Google::Apis::GamesV1::ListPlayerScoreResponse::Representation command.response_class = Google::Apis::GamesV1::ListPlayerScoreResponse command.query['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 # Retrieves the metadata for a given snapshot ID. # @param [String] snapshot_id # The ID of the snapshot. # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::Snapshot] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::Snapshot] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_snapshot(snapshot_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'snapshots/{snapshotId}', options) command.response_representation = Google::Apis::GamesV1::Snapshot::Representation command.response_class = Google::Apis::GamesV1::Snapshot command.params['snapshotId'] = snapshot_id unless snapshot_id.nil? command.query['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 # Retrieves a list of snapshots created by your application for the player # corresponding to the player ID. # @param [String] player_id # A player ID. A value of me may be used in place of the authenticated player's # ID. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of snapshot resources to return in the response, used for # paging. For any response, the actual number of snapshot resources returned may # be less than the specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::ListSnapshotResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::ListSnapshotResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_snapshots(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'players/{playerId}/snapshots', options) command.response_representation = Google::Apis::GamesV1::ListSnapshotResponse::Representation command.response_class = Google::Apis::GamesV1::ListSnapshotResponse command.params['playerId'] = player_id unless player_id.nil? command.query['language'] = language unless language.nil? command.query['maxResults'] = max_results unless max_results.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 # Cancel a turn-based match. # @param [String] match_id # The ID of the match. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_turn_based_match(match_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'turnbasedmatches/{matchId}/cancel', options) command.params['matchId'] = match_id unless match_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 # Create a turn-based match. # @param [Google::Apis::GamesV1::CreateTurnBasedMatchRequest] create_turn_based_match_request_object # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatch] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_turn_based_match(create_turn_based_match_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'turnbasedmatches/create', options) command.request_representation = Google::Apis::GamesV1::CreateTurnBasedMatchRequest::Representation command.request_object = create_turn_based_match_request_object command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatch command.query['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 # Decline an invitation to play a turn-based match. # @param [String] match_id # The ID of the match. # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatch] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def decline_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'turnbasedmatches/{matchId}/decline', options) command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatch command.params['matchId'] = match_id unless match_id.nil? command.query['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 # Dismiss a turn-based match from the match list. The match will no longer show # up in the list and will not generate notifications. # @param [String] match_id # The ID of the match. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 dismiss_turn_based_match(match_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'turnbasedmatches/{matchId}/dismiss', options) command.params['matchId'] = match_id unless match_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 # Finish a turn-based match. Each player should make this call once, after all # results are in. Only the player whose turn it is may make the first call to # Finish, and can pass in the final match state. # @param [String] match_id # The ID of the match. # @param [Google::Apis::GamesV1::TurnBasedMatchResults] turn_based_match_results_object # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatch] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def finish_turn_based_match(match_id, turn_based_match_results_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'turnbasedmatches/{matchId}/finish', options) command.request_representation = Google::Apis::GamesV1::TurnBasedMatchResults::Representation command.request_object = turn_based_match_results_object command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatch command.params['matchId'] = match_id unless match_id.nil? command.query['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 # Get the data for a turn-based match. # @param [String] match_id # The ID of the match. # @param [Boolean] include_match_data # Get match data along with metadata. # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatch] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_turn_based_match(match_id, include_match_data: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'turnbasedmatches/{matchId}', options) command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatch command.params['matchId'] = match_id unless match_id.nil? command.query['includeMatchData'] = include_match_data unless include_match_data.nil? command.query['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 # Join a turn-based match. # @param [String] match_id # The ID of the match. # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatch] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def join_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'turnbasedmatches/{matchId}/join', options) command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatch command.params['matchId'] = match_id unless match_id.nil? command.query['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 # Leave a turn-based match when it is not the current player's turn, without # canceling the match. # @param [String] match_id # The ID of the match. # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatch] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def leave_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'turnbasedmatches/{matchId}/leave', options) command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatch command.params['matchId'] = match_id unless match_id.nil? command.query['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 # Leave a turn-based match during the current player's turn, without canceling # the match. # @param [String] match_id # The ID of the match. # @param [Fixnum] match_version # The version of the match being updated. # @param [String] language # The preferred language to use for strings returned by this method. # @param [String] pending_participant_id # The ID of another participant who should take their turn next. If not set, the # match will wait for other player(s) to join via automatching; this is only # valid if automatch criteria is set on the match with remaining slots for # automatched players. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatch] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def leave_turn(match_id, match_version, language: nil, pending_participant_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'turnbasedmatches/{matchId}/leaveTurn', options) command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatch command.params['matchId'] = match_id unless match_id.nil? command.query['language'] = language unless language.nil? command.query['matchVersion'] = match_version unless match_version.nil? command.query['pendingParticipantId'] = pending_participant_id unless pending_participant_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 turn-based matches the player is or was involved in. # @param [Boolean] include_match_data # True if match data should be returned in the response. Note that not all data # will necessarily be returned if include_match_data is true; the server may # decide to only return data for some of the matches to limit download size for # the client. The remainder of the data for these matches will be retrievable on # request. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_completed_matches # The maximum number of completed or canceled matches to return in the response. # If not set, all matches returned could be completed or canceled. # @param [Fixnum] max_results # The maximum number of matches to return in the response, used for paging. For # any response, the actual number of matches to return may be less than the # specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatchList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatchList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_turn_based_matches(include_match_data: nil, language: nil, max_completed_matches: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'turnbasedmatches', options) command.response_representation = Google::Apis::GamesV1::TurnBasedMatchList::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatchList command.query['includeMatchData'] = include_match_data unless include_match_data.nil? command.query['language'] = language unless language.nil? command.query['maxCompletedMatches'] = max_completed_matches unless max_completed_matches.nil? command.query['maxResults'] = max_results unless max_results.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 # Create a rematch of a match that was previously completed, with the same # participants. This can be called by only one player on a match still in their # list; the player must have called Finish first. Returns the newly created # match; it will be the caller's turn. # @param [String] match_id # The ID of the match. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] request_id # A randomly generated numeric ID for each request specified by the caller. This # number is used at the server to ensure that the request is handled correctly # across retries. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatchRematch] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatchRematch] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def rematch_turn_based_match(match_id, language: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'turnbasedmatches/{matchId}/rematch', options) command.response_representation = Google::Apis::GamesV1::TurnBasedMatchRematch::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatchRematch command.params['matchId'] = match_id unless match_id.nil? command.query['language'] = language unless language.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 turn-based matches the player is or was involved in that changed since # the last sync call, with the least recent changes coming first. Matches that # should be removed from the local cache will have a status of MATCH_DELETED. # @param [Boolean] include_match_data # True if match data should be returned in the response. Note that not all data # will necessarily be returned if include_match_data is true; the server may # decide to only return data for some of the matches to limit download size for # the client. The remainder of the data for these matches will be retrievable on # request. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_completed_matches # The maximum number of completed or canceled matches to return in the response. # If not set, all matches returned could be completed or canceled. # @param [Fixnum] max_results # The maximum number of matches to return in the response, used for paging. For # any response, the actual number of matches to return may be less than the # specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatchSync] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatchSync] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def sync_turn_based_match(include_match_data: nil, language: nil, max_completed_matches: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'turnbasedmatches/sync', options) command.response_representation = Google::Apis::GamesV1::TurnBasedMatchSync::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatchSync command.query['includeMatchData'] = include_match_data unless include_match_data.nil? command.query['language'] = language unless language.nil? command.query['maxCompletedMatches'] = max_completed_matches unless max_completed_matches.nil? command.query['maxResults'] = max_results unless max_results.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 # Commit the results of a player turn. # @param [String] match_id # The ID of the match. # @param [Google::Apis::GamesV1::TurnBasedMatchTurn] turn_based_match_turn_object # @param [String] language # The preferred language to use for strings returned by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesV1::TurnBasedMatch] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def take_turn(match_id, turn_based_match_turn_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'turnbasedmatches/{matchId}/turn', options) command.request_representation = Google::Apis::GamesV1::TurnBasedMatchTurn::Representation command.request_object = turn_based_match_turn_object command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation command.response_class = Google::Apis::GamesV1::TurnBasedMatch command.params['matchId'] = match_id unless match_id.nil? command.query['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 protected 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 end end google-api-client-0.19.8/generated/google/apis/appengine_v1alpha.rb0000644000004100000410000000301313252673043025217 0ustar www-datawww-data# 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/appengine_v1alpha/service.rb' require 'google/apis/appengine_v1alpha/classes.rb' require 'google/apis/appengine_v1alpha/representations.rb' module Google module Apis # Google App Engine Admin API # # The App Engine Admin API enables developers to provision and manage their App # Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1alpha VERSION = 'V1alpha' REVISION = '20180209' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' end end end google-api-client-0.19.8/generated/google/apis/logging_v2beta1.rb0000644000004100000410000000323513252673044024616 0ustar www-datawww-data# 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/logging_v2beta1/service.rb' require 'google/apis/logging_v2beta1/classes.rb' require 'google/apis/logging_v2beta1/representations.rb' module Google module Apis # Stackdriver Logging API # # Writes log entries and manages your Stackdriver Logging configuration. # # @see https://cloud.google.com/logging/docs/ module LoggingV2beta1 VERSION = 'V2beta1' REVISION = '20180213' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' # Administrate log data for your projects AUTH_LOGGING_ADMIN = 'https://www.googleapis.com/auth/logging.admin' # View log data for your projects AUTH_LOGGING_READ = 'https://www.googleapis.com/auth/logging.read' # Submit log data for your projects AUTH_LOGGING_WRITE = 'https://www.googleapis.com/auth/logging.write' end end end google-api-client-0.19.8/generated/google/apis/deploymentmanager_v2beta.rb0000644000004100000410000000346713252673043026630 0ustar www-datawww-data# 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/deploymentmanager_v2beta/service.rb' require 'google/apis/deploymentmanager_v2beta/classes.rb' require 'google/apis/deploymentmanager_v2beta/representations.rb' module Google module Apis # Google Cloud Deployment Manager API V2Beta Methods # # The Deployment Manager API allows users to declaratively configure, deploy and # run complex solutions on the Google Cloud Platform. # # @see https://developers.google.com/deployment-manager/ module DeploymentmanagerV2beta VERSION = 'V2beta' REVISION = '20180214' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' # View and manage your Google Cloud Platform management resources and deployment status information AUTH_NDEV_CLOUDMAN = 'https://www.googleapis.com/auth/ndev.cloudman' # View your Google Cloud Platform management resources and deployment status information AUTH_NDEV_CLOUDMAN_READONLY = 'https://www.googleapis.com/auth/ndev.cloudman.readonly' end end end google-api-client-0.19.8/generated/google/apis/games_management_v1management/0000755000004100000410000000000013252673043027246 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/games_management_v1management/representations.rb0000644000004100000410000002476013252673043033031 0ustar www-datawww-data# 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 GamesManagementV1management class AchievementResetAllResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AchievementResetMultipleForAllRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AchievementResetResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventsResetMultipleForAllRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GamesPlayedResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GamesPlayerExperienceInfoResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GamesPlayerLevelResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HiddenPlayer class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HiddenPlayerList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Player class Representation < Google::Apis::Core::JsonRepresentation; end class Name class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class PlayerScoreResetAllResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlayerScoreResetResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProfileSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuestsResetMultipleForAllRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ScoresResetMultipleForAllRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AchievementResetAllResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :results, as: 'results', class: Google::Apis::GamesManagementV1management::AchievementResetResponse, decorator: Google::Apis::GamesManagementV1management::AchievementResetResponse::Representation end end class AchievementResetMultipleForAllRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :achievement_ids, as: 'achievement_ids' property :kind, as: 'kind' end end class AchievementResetResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_state, as: 'currentState' property :definition_id, as: 'definitionId' property :kind, as: 'kind' property :update_occurred, as: 'updateOccurred' end end class EventsResetMultipleForAllRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :event_ids, as: 'event_ids' property :kind, as: 'kind' end end class GamesPlayedResource # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_matched, as: 'autoMatched' property :time_millis, :numeric_string => true, as: 'timeMillis' end end class GamesPlayerExperienceInfoResource # @private class Representation < Google::Apis::Core::JsonRepresentation property :current_experience_points, :numeric_string => true, as: 'currentExperiencePoints' property :current_level, as: 'currentLevel', class: Google::Apis::GamesManagementV1management::GamesPlayerLevelResource, decorator: Google::Apis::GamesManagementV1management::GamesPlayerLevelResource::Representation property :last_level_up_timestamp_millis, :numeric_string => true, as: 'lastLevelUpTimestampMillis' property :next_level, as: 'nextLevel', class: Google::Apis::GamesManagementV1management::GamesPlayerLevelResource, decorator: Google::Apis::GamesManagementV1management::GamesPlayerLevelResource::Representation end end class GamesPlayerLevelResource # @private class Representation < Google::Apis::Core::JsonRepresentation property :level, as: 'level' property :max_experience_points, :numeric_string => true, as: 'maxExperiencePoints' property :min_experience_points, :numeric_string => true, as: 'minExperiencePoints' end end class HiddenPlayer # @private class Representation < Google::Apis::Core::JsonRepresentation property :hidden_time_millis, :numeric_string => true, as: 'hiddenTimeMillis' property :kind, as: 'kind' property :player, as: 'player', class: Google::Apis::GamesManagementV1management::Player, decorator: Google::Apis::GamesManagementV1management::Player::Representation end end class HiddenPlayerList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::GamesManagementV1management::HiddenPlayer, decorator: Google::Apis::GamesManagementV1management::HiddenPlayer::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Player # @private class Representation < Google::Apis::Core::JsonRepresentation property :avatar_image_url, as: 'avatarImageUrl' property :banner_url_landscape, as: 'bannerUrlLandscape' property :banner_url_portrait, as: 'bannerUrlPortrait' property :display_name, as: 'displayName' property :experience_info, as: 'experienceInfo', class: Google::Apis::GamesManagementV1management::GamesPlayerExperienceInfoResource, decorator: Google::Apis::GamesManagementV1management::GamesPlayerExperienceInfoResource::Representation property :kind, as: 'kind' property :last_played_with, as: 'lastPlayedWith', class: Google::Apis::GamesManagementV1management::GamesPlayedResource, decorator: Google::Apis::GamesManagementV1management::GamesPlayedResource::Representation property :name, as: 'name', class: Google::Apis::GamesManagementV1management::Player::Name, decorator: Google::Apis::GamesManagementV1management::Player::Name::Representation property :original_player_id, as: 'originalPlayerId' property :player_id, as: 'playerId' property :profile_settings, as: 'profileSettings', class: Google::Apis::GamesManagementV1management::ProfileSettings, decorator: Google::Apis::GamesManagementV1management::ProfileSettings::Representation property :title, as: 'title' end class Name # @private class Representation < Google::Apis::Core::JsonRepresentation property :family_name, as: 'familyName' property :given_name, as: 'givenName' end end end class PlayerScoreResetAllResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :results, as: 'results', class: Google::Apis::GamesManagementV1management::PlayerScoreResetResponse, decorator: Google::Apis::GamesManagementV1management::PlayerScoreResetResponse::Representation end end class PlayerScoreResetResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :definition_id, as: 'definitionId' property :kind, as: 'kind' collection :reset_score_time_spans, as: 'resetScoreTimeSpans' end end class ProfileSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :profile_visible, as: 'profileVisible' end end class QuestsResetMultipleForAllRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :quest_ids, as: 'quest_ids' end end class ScoresResetMultipleForAllRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :leaderboard_ids, as: 'leaderboard_ids' end end end end end google-api-client-0.19.8/generated/google/apis/games_management_v1management/classes.rb0000644000004100000410000005256213252673043031242 0ustar www-datawww-data# 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 GamesManagementV1management # This is a JSON template for achievement reset all response. class AchievementResetAllResponse include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#achievementResetAllResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The achievement reset results. # 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) @kind = args[:kind] if args.key?(:kind) @results = args[:results] if args.key?(:results) end end # This is a JSON template for multiple achievements reset all request. class AchievementResetMultipleForAllRequest include Google::Apis::Core::Hashable # The IDs of achievements to reset. # Corresponds to the JSON property `achievement_ids` # @return [Array] attr_accessor :achievement_ids # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#achievementResetMultipleForAllRequest. # 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) @achievement_ids = args[:achievement_ids] if args.key?(:achievement_ids) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for an achievement reset response. class AchievementResetResponse include Google::Apis::Core::Hashable # The current state of the achievement. This is the same as the initial state of # the achievement. # Possible values are: # - "HIDDEN"- Achievement is hidden. # - "REVEALED" - Achievement is revealed. # - "UNLOCKED" - Achievement is unlocked. # Corresponds to the JSON property `currentState` # @return [String] attr_accessor :current_state # The ID of an achievement for which player state has been updated. # Corresponds to the JSON property `definitionId` # @return [String] attr_accessor :definition_id # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#achievementResetResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Flag to indicate if the requested update actually occurred. # Corresponds to the JSON property `updateOccurred` # @return [Boolean] attr_accessor :update_occurred alias_method :update_occurred?, :update_occurred def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_state = args[:current_state] if args.key?(:current_state) @definition_id = args[:definition_id] if args.key?(:definition_id) @kind = args[:kind] if args.key?(:kind) @update_occurred = args[:update_occurred] if args.key?(:update_occurred) end end # This is a JSON template for multiple events reset all request. class EventsResetMultipleForAllRequest include Google::Apis::Core::Hashable # The IDs of events to reset. # Corresponds to the JSON property `event_ids` # @return [Array] attr_accessor :event_ids # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#eventsResetMultipleForAllRequest. # 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) @event_ids = args[:event_ids] if args.key?(:event_ids) @kind = args[:kind] if args.key?(:kind) end end # This is a JSON template for metadata about a player playing a game with the # currently authenticated user. class GamesPlayedResource include Google::Apis::Core::Hashable # True if the player was auto-matched with the currently authenticated user. # Corresponds to the JSON property `autoMatched` # @return [Boolean] attr_accessor :auto_matched alias_method :auto_matched?, :auto_matched # The last time the player played the game in milliseconds since the epoch in # UTC. # Corresponds to the JSON property `timeMillis` # @return [Fixnum] attr_accessor :time_millis def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_matched = args[:auto_matched] if args.key?(:auto_matched) @time_millis = args[:time_millis] if args.key?(:time_millis) end end # This is a JSON template for 1P/3P metadata about the player's experience. class GamesPlayerExperienceInfoResource include Google::Apis::Core::Hashable # The current number of experience points for the player. # Corresponds to the JSON property `currentExperiencePoints` # @return [Fixnum] attr_accessor :current_experience_points # This is a JSON template for 1P/3P metadata about a user's level. # Corresponds to the JSON property `currentLevel` # @return [Google::Apis::GamesManagementV1management::GamesPlayerLevelResource] attr_accessor :current_level # The timestamp when the player was leveled up, in millis since Unix epoch UTC. # Corresponds to the JSON property `lastLevelUpTimestampMillis` # @return [Fixnum] attr_accessor :last_level_up_timestamp_millis # This is a JSON template for 1P/3P metadata about a user's level. # Corresponds to the JSON property `nextLevel` # @return [Google::Apis::GamesManagementV1management::GamesPlayerLevelResource] attr_accessor :next_level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_experience_points = args[:current_experience_points] if args.key?(:current_experience_points) @current_level = args[:current_level] if args.key?(:current_level) @last_level_up_timestamp_millis = args[:last_level_up_timestamp_millis] if args.key?(:last_level_up_timestamp_millis) @next_level = args[:next_level] if args.key?(:next_level) end end # This is a JSON template for 1P/3P metadata about a user's level. class GamesPlayerLevelResource include Google::Apis::Core::Hashable # The level for the user. # Corresponds to the JSON property `level` # @return [Fixnum] attr_accessor :level # The maximum experience points for this level. # Corresponds to the JSON property `maxExperiencePoints` # @return [Fixnum] attr_accessor :max_experience_points # The minimum experience points for this level. # Corresponds to the JSON property `minExperiencePoints` # @return [Fixnum] attr_accessor :min_experience_points def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @level = args[:level] if args.key?(:level) @max_experience_points = args[:max_experience_points] if args.key?(:max_experience_points) @min_experience_points = args[:min_experience_points] if args.key?(:min_experience_points) end end # This is a JSON template for the HiddenPlayer resource. class HiddenPlayer include Google::Apis::Core::Hashable # The time this player was hidden. # Corresponds to the JSON property `hiddenTimeMillis` # @return [Fixnum] attr_accessor :hidden_time_millis # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#hiddenPlayer. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for a Player resource. # Corresponds to the JSON property `player` # @return [Google::Apis::GamesManagementV1management::Player] attr_accessor :player def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @hidden_time_millis = args[:hidden_time_millis] if args.key?(:hidden_time_millis) @kind = args[:kind] if args.key?(:kind) @player = args[:player] if args.key?(:player) end end # This is a JSON template for a list of hidden players. class HiddenPlayerList include Google::Apis::Core::Hashable # The players. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#hiddenPlayerList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The pagination token for 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) @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) end end # This is a JSON template for a Player resource. class Player include Google::Apis::Core::Hashable # The base URL for the image that represents the player. # Corresponds to the JSON property `avatarImageUrl` # @return [String] attr_accessor :avatar_image_url # The url to the landscape mode player banner image. # Corresponds to the JSON property `bannerUrlLandscape` # @return [String] attr_accessor :banner_url_landscape # The url to the portrait mode player banner image. # Corresponds to the JSON property `bannerUrlPortrait` # @return [String] attr_accessor :banner_url_portrait # The name to display for the player. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # This is a JSON template for 1P/3P metadata about the player's experience. # Corresponds to the JSON property `experienceInfo` # @return [Google::Apis::GamesManagementV1management::GamesPlayerExperienceInfoResource] attr_accessor :experience_info # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#player. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # This is a JSON template for metadata about a player playing a game with the # currently authenticated user. # Corresponds to the JSON property `lastPlayedWith` # @return [Google::Apis::GamesManagementV1management::GamesPlayedResource] attr_accessor :last_played_with # An object representation of the individual components of the player's name. # For some players, these fields may not be present. # Corresponds to the JSON property `name` # @return [Google::Apis::GamesManagementV1management::Player::Name] attr_accessor :name # The player ID that was used for this player the first time they signed into # the game in question. This is only populated for calls to player.get for the # requesting player, only if the player ID has subsequently changed, and only to # clients that support remapping player IDs. # Corresponds to the JSON property `originalPlayerId` # @return [String] attr_accessor :original_player_id # The ID of the player. # Corresponds to the JSON property `playerId` # @return [String] attr_accessor :player_id # This is a JSON template for profile settings # Corresponds to the JSON property `profileSettings` # @return [Google::Apis::GamesManagementV1management::ProfileSettings] attr_accessor :profile_settings # The player's title rewarded for their game activities. # 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) @avatar_image_url = args[:avatar_image_url] if args.key?(:avatar_image_url) @banner_url_landscape = args[:banner_url_landscape] if args.key?(:banner_url_landscape) @banner_url_portrait = args[:banner_url_portrait] if args.key?(:banner_url_portrait) @display_name = args[:display_name] if args.key?(:display_name) @experience_info = args[:experience_info] if args.key?(:experience_info) @kind = args[:kind] if args.key?(:kind) @last_played_with = args[:last_played_with] if args.key?(:last_played_with) @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) @profile_settings = args[:profile_settings] if args.key?(:profile_settings) @title = args[:title] if args.key?(:title) end # An object representation of the individual components of the player's name. # For some players, these fields may not be present. class Name include Google::Apis::Core::Hashable # The family name of this player. In some places, this is known as the last name. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name # The given name of this player. In some places, this is known as the first name. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @family_name = args[:family_name] if args.key?(:family_name) @given_name = args[:given_name] if args.key?(:given_name) end end end # This is a JSON template for a list of leaderboard reset resources. class PlayerScoreResetAllResponse include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#playerScoreResetResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The leaderboard reset results. # 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) @kind = args[:kind] if args.key?(:kind) @results = args[:results] if args.key?(:results) end end # This is a JSON template for a list of reset leaderboard entry resources. class PlayerScoreResetResponse include Google::Apis::Core::Hashable # The ID of an leaderboard for which player state has been updated. # Corresponds to the JSON property `definitionId` # @return [String] attr_accessor :definition_id # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#playerScoreResetResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The time spans of the updated score. # Possible values are: # - "ALL_TIME" - The score is an all-time score. # - "WEEKLY" - The score is a weekly score. # - "DAILY" - The score is a daily score. # Corresponds to the JSON property `resetScoreTimeSpans` # @return [Array] attr_accessor :reset_score_time_spans def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @definition_id = args[:definition_id] if args.key?(:definition_id) @kind = args[:kind] if args.key?(:kind) @reset_score_time_spans = args[:reset_score_time_spans] if args.key?(:reset_score_time_spans) end end # This is a JSON template for profile settings class ProfileSettings include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#profileSettings. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The player's current profile visibility. This field is visible to both 1P and # 3P APIs. # Corresponds to the JSON property `profileVisible` # @return [Boolean] attr_accessor :profile_visible alias_method :profile_visible?, :profile_visible def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @profile_visible = args[:profile_visible] if args.key?(:profile_visible) end end # This is a JSON template for multiple quests reset all request. class QuestsResetMultipleForAllRequest include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#questsResetMultipleForAllRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The IDs of quests to reset. # Corresponds to the JSON property `quest_ids` # @return [Array] attr_accessor :quest_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @quest_ids = args[:quest_ids] if args.key?(:quest_ids) end end # This is a JSON template for multiple scores reset all request. class ScoresResetMultipleForAllRequest include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#scoresResetMultipleForAllRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The IDs of leaderboards to reset. # Corresponds to the JSON property `leaderboard_ids` # @return [Array] attr_accessor :leaderboard_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @leaderboard_ids = args[:leaderboard_ids] if args.key?(:leaderboard_ids) end end end end end google-api-client-0.19.8/generated/google/apis/games_management_v1management/service.rb0000644000004100000410000016322413252673043031243 0ustar www-datawww-data# 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 GamesManagementV1management # Google Play Game Services Management API # # The Management API for Google Play Game Services. # # @example # require 'google/apis/games_management_v1management' # # GamesManagement = Google::Apis::GamesManagementV1management # Alias the module # service = GamesManagement::GamesManagementService.new # # @see https://developers.google.com/games/services class GamesManagementService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'games/v1management/') @batch_path = 'batch/gamesManagement/v1management' end # Resets the achievement with the given ID for the currently authenticated # player. This method is only accessible to whitelisted tester accounts for your # application. # @param [String] achievement_id # The ID of the achievement used by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesManagementV1management::AchievementResetResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesManagementV1management::AchievementResetResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def reset_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'achievements/{achievementId}/reset', options) command.response_representation = Google::Apis::GamesManagementV1management::AchievementResetResponse::Representation command.response_class = Google::Apis::GamesManagementV1management::AchievementResetResponse command.params['achievementId'] = achievement_id unless achievement_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 # Resets all achievements for the currently authenticated player for your # application. This method is only accessible to whitelisted tester accounts for # your application. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesManagementV1management::AchievementResetAllResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesManagementV1management::AchievementResetAllResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def reset_achievement_all(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'achievements/reset', options) command.response_representation = Google::Apis::GamesManagementV1management::AchievementResetAllResponse::Representation command.response_class = Google::Apis::GamesManagementV1management::AchievementResetAllResponse 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 # Resets all draft achievements for all players. This method is only available # to user accounts for your developer console. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_achievement_all_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'achievements/resetAllForAllPlayers', options) 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 # Resets the achievement with the given ID for all players. This method is only # available to user accounts for your developer console. Only draft achievements # can be reset. # @param [String] achievement_id # The ID of the achievement used by this method. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_achievement_for_all_players(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'achievements/{achievementId}/resetForAllPlayers', options) command.params['achievementId'] = achievement_id unless achievement_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 # Resets achievements with the given IDs for all players. This method is only # available to user accounts for your developer console. Only draft achievements # may be reset. # @param [Google::Apis::GamesManagementV1management::AchievementResetMultipleForAllRequest] achievement_reset_multiple_for_all_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_achievement_multiple_for_all_players(achievement_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'achievements/resetMultipleForAllPlayers', options) command.request_representation = Google::Apis::GamesManagementV1management::AchievementResetMultipleForAllRequest::Representation command.request_object = achievement_reset_multiple_for_all_request_object 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 # Get the list of players hidden from the given application. This method is only # available to user accounts for your developer console. # @param [String] application_id # The application ID from the Google Play developer console. # @param [Fixnum] max_results # The maximum number of player resources to return in the response, used for # paging. For any response, the actual number of player resources returned may # be less than the specified maxResults. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesManagementV1management::HiddenPlayerList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesManagementV1management::HiddenPlayerList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_application_hidden(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'applications/{applicationId}/players/hidden', options) command.response_representation = Google::Apis::GamesManagementV1management::HiddenPlayerList::Representation command.response_class = Google::Apis::GamesManagementV1management::HiddenPlayerList command.params['applicationId'] = application_id unless application_id.nil? command.query['maxResults'] = max_results unless max_results.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 # Resets all player progress on the event with the given ID for the currently # authenticated player. This method is only accessible to whitelisted tester # accounts for your application. All quests for this player that use the event # will also be reset. # @param [String] event_id # The ID of the event. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_event(event_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'events/{eventId}/reset', options) command.params['eventId'] = event_id unless event_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 # Resets all player progress on all events for the currently authenticated # player. This method is only accessible to whitelisted tester accounts for your # application. All quests for this player will also be reset. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_event_all(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'events/reset', options) 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 # Resets all draft events for all players. This method is only available to user # accounts for your developer console. All quests that use any of these events # will also be reset. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_event_all_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'events/resetAllForAllPlayers', options) 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 # Resets the event with the given ID for all players. This method is only # available to user accounts for your developer console. Only draft events can # be reset. All quests that use the event will also be reset. # @param [String] event_id # The ID of the event. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_event_for_all_players(event_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'events/{eventId}/resetForAllPlayers', options) command.params['eventId'] = event_id unless event_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 # Resets events with the given IDs for all players. This method is only # available to user accounts for your developer console. Only draft events may # be reset. All quests that use any of the events will also be reset. # @param [Google::Apis::GamesManagementV1management::EventsResetMultipleForAllRequest] events_reset_multiple_for_all_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_event_multiple_for_all_players(events_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'events/resetMultipleForAllPlayers', options) command.request_representation = Google::Apis::GamesManagementV1management::EventsResetMultipleForAllRequest::Representation command.request_object = events_reset_multiple_for_all_request_object 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 # Hide the given player's leaderboard scores from the given application. This # method is only available to user accounts for your developer console. # @param [String] application_id # The application ID from the Google Play developer console. # @param [String] player_id # A player ID. A value of me may be used in place of the authenticated player's # 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 hide_player(application_id, player_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'applications/{applicationId}/players/hidden/{playerId}', options) command.params['applicationId'] = application_id unless application_id.nil? command.params['playerId'] = player_id unless player_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 # Unhide the given player's leaderboard scores from the given application. This # method is only available to user accounts for your developer console. # @param [String] application_id # The application ID from the Google Play developer console. # @param [String] player_id # A player ID. A value of me may be used in place of the authenticated player's # 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 unhide_player(application_id, player_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'applications/{applicationId}/players/hidden/{playerId}', options) command.params['applicationId'] = application_id unless application_id.nil? command.params['playerId'] = player_id unless player_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 # Resets all player progress on the quest with the given ID for the currently # authenticated player. This method is only accessible to whitelisted tester # accounts for your application. # @param [String] quest_id # The ID of the quest. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_quest(quest_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'quests/{questId}/reset', options) command.params['questId'] = quest_id unless quest_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 # Resets all player progress on all quests for the currently authenticated # player. This method is only accessible to whitelisted tester accounts for your # application. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_quest_all(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'quests/reset', options) 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 # Resets all draft quests for all players. This method is only available to user # accounts for your developer console. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_quest_all_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'quests/resetAllForAllPlayers', options) 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 # Resets all player progress on the quest with the given ID for all players. # This method is only available to user accounts for your developer console. # Only draft quests can be reset. # @param [String] quest_id # The ID of the quest. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_quest_for_all_players(quest_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'quests/{questId}/resetForAllPlayers', options) command.params['questId'] = quest_id unless quest_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 # Resets quests with the given IDs for all players. This method is only # available to user accounts for your developer console. Only draft quests may # be reset. # @param [Google::Apis::GamesManagementV1management::QuestsResetMultipleForAllRequest] quests_reset_multiple_for_all_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_quest_multiple_for_all_players(quests_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'quests/resetMultipleForAllPlayers', options) command.request_representation = Google::Apis::GamesManagementV1management::QuestsResetMultipleForAllRequest::Representation command.request_object = quests_reset_multiple_for_all_request_object 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 # Reset all rooms for the currently authenticated player for your application. # This method is only accessible to whitelisted tester accounts for your # application. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_room(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'rooms/reset', options) 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 rooms where the only room participants are from whitelisted tester # accounts for your application. This method is only available to user accounts # for your developer console. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_room_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'rooms/resetForAllPlayers', options) 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 # Resets scores for the leaderboard with the given ID for the currently # authenticated player. This method is only accessible to whitelisted tester # accounts for your application. # @param [String] leaderboard_id # The ID of the leaderboard. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesManagementV1management::PlayerScoreResetResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesManagementV1management::PlayerScoreResetResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def reset_score(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'leaderboards/{leaderboardId}/scores/reset', options) command.response_representation = Google::Apis::GamesManagementV1management::PlayerScoreResetResponse::Representation command.response_class = Google::Apis::GamesManagementV1management::PlayerScoreResetResponse command.params['leaderboardId'] = leaderboard_id unless leaderboard_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 # Resets all scores for all leaderboards for the currently authenticated players. # This method is only accessible to whitelisted tester accounts for your # application. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def reset_score_all(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'scores/reset', options) command.response_representation = Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse::Representation command.response_class = Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse 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 # Resets scores for all draft leaderboards for all players. This method is only # available to user accounts for your developer console. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_score_all_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'scores/resetAllForAllPlayers', options) 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 # Resets scores for the leaderboard with the given ID for all players. This # method is only available to user accounts for your developer console. Only # draft leaderboards can be reset. # @param [String] leaderboard_id # The ID of the leaderboard. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_score_for_all_players(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'leaderboards/{leaderboardId}/scores/resetForAllPlayers', options) command.params['leaderboardId'] = leaderboard_id unless leaderboard_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 # Resets scores for the leaderboards with the given IDs for all players. This # method is only available to user accounts for your developer console. Only # draft leaderboards may be reset. # @param [Google::Apis::GamesManagementV1management::ScoresResetMultipleForAllRequest] scores_reset_multiple_for_all_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_score_multiple_for_all_players(scores_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'scores/resetMultipleForAllPlayers', options) command.request_representation = Google::Apis::GamesManagementV1management::ScoresResetMultipleForAllRequest::Representation command.request_object = scores_reset_multiple_for_all_request_object 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 # Reset all turn-based match data for a user. This method is only accessible to # whitelisted tester accounts for your application. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_turn_based_match(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'turnbasedmatches/reset', options) 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 turn-based matches where the only match participants are from # whitelisted tester accounts for your application. This method is only # available to user accounts for your developer console. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 reset_turn_based_match_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'turnbasedmatches/resetForAllPlayers', options) 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 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 end end google-api-client-0.19.8/generated/google/apis/spectrum_v1explorer.rb0000644000004100000410000000177313252673044025702 0ustar www-datawww-data# 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/spectrum_v1explorer/service.rb' require 'google/apis/spectrum_v1explorer/classes.rb' require 'google/apis/spectrum_v1explorer/representations.rb' module Google module Apis # Google Spectrum Database API # # API for spectrum-management functions. # # @see http://developers.google.com/spectrum module SpectrumV1explorer VERSION = 'V1explorer' REVISION = '20170306' end end end google-api-client-0.19.8/generated/google/apis/bigquerydatatransfer_v1.rb0000644000004100000410000000275113252673043026501 0ustar www-datawww-data# 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/bigquerydatatransfer_v1/service.rb' require 'google/apis/bigquerydatatransfer_v1/classes.rb' require 'google/apis/bigquerydatatransfer_v1/representations.rb' module Google module Apis # BigQuery Data Transfer API # # Transfers data from partner SaaS applications to Google BigQuery on a # scheduled, managed basis. # # @see https://cloud.google.com/bigquery/ module BigquerydatatransferV1 VERSION = 'V1' REVISION = '20180202' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' end end end google-api-client-0.19.8/generated/google/apis/mybusiness_v3.rb0000644000004100000410000000203113252673044024446 0ustar www-datawww-data# 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/mybusiness_v3/service.rb' require 'google/apis/mybusiness_v3/classes.rb' require 'google/apis/mybusiness_v3/representations.rb' module Google module Apis # Google My Business API # # The Google My Business API provides an interface for managing business # location information on Google. # # @see https://developers.google.com/my-business/ module MybusinessV3 VERSION = 'V3' REVISION = '0' end end end google-api-client-0.19.8/generated/google/apis/compute_alpha.rb0000644000004100000410000000351613252673043024466 0ustar www-datawww-data# 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/compute_alpha/service.rb' require 'google/apis/compute_alpha/classes.rb' require 'google/apis/compute_alpha/representations.rb' module Google module Apis # Compute Engine API # # Creates and runs virtual machines on Google Cloud Platform. # # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeAlpha VERSION = 'Alpha' REVISION = '20180123' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View and manage your Google Compute Engine resources AUTH_COMPUTE = 'https://www.googleapis.com/auth/compute' # View your Google Compute Engine resources AUTH_COMPUTE_READONLY = 'https://www.googleapis.com/auth/compute.readonly' # Manage your data and permissions in Google Cloud Storage AUTH_DEVSTORAGE_FULL_CONTROL = 'https://www.googleapis.com/auth/devstorage.full_control' # View your data in Google Cloud Storage AUTH_DEVSTORAGE_READ_ONLY = 'https://www.googleapis.com/auth/devstorage.read_only' # Manage your data in Google Cloud Storage AUTH_DEVSTORAGE_READ_WRITE = 'https://www.googleapis.com/auth/devstorage.read_write' end end end google-api-client-0.19.8/generated/google/apis/analyticsreporting_v4/0000755000004100000410000000000013252673043025645 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/analyticsreporting_v4/representations.rb0000644000004100000410000006057213252673043031431 0ustar www-datawww-data# 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 AnalyticsreportingV4 class Cohort class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CohortGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ColumnHeader 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 DateRangeValues class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Dimension class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DimensionFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DimensionFilterClause class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DynamicSegment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetReportsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetReportsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Metric class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricFilterClause class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricHeader class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricHeaderEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrFiltersForSegment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderBy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Pivot class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PivotHeader class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PivotHeaderEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PivotValueRegion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Report class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceQuotasRemaining class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Segment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SegmentDefinition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SegmentDimensionFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SegmentFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SegmentFilterClause class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SegmentMetricFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SegmentSequenceStep class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SequenceSegment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SimpleSegment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Cohort # @private class Representation < Google::Apis::Core::JsonRepresentation property :date_range, as: 'dateRange', class: Google::Apis::AnalyticsreportingV4::DateRange, decorator: Google::Apis::AnalyticsreportingV4::DateRange::Representation property :name, as: 'name' property :type, as: 'type' end end class CohortGroup # @private class Representation < Google::Apis::Core::JsonRepresentation collection :cohorts, as: 'cohorts', class: Google::Apis::AnalyticsreportingV4::Cohort, decorator: Google::Apis::AnalyticsreportingV4::Cohort::Representation property :lifetime_value, as: 'lifetimeValue' end end class ColumnHeader # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dimensions, as: 'dimensions' property :metric_header, as: 'metricHeader', class: Google::Apis::AnalyticsreportingV4::MetricHeader, decorator: Google::Apis::AnalyticsreportingV4::MetricHeader::Representation end end class DateRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_date, as: 'endDate' property :start_date, as: 'startDate' end end class DateRangeValues # @private class Representation < Google::Apis::Core::JsonRepresentation collection :pivot_value_regions, as: 'pivotValueRegions', class: Google::Apis::AnalyticsreportingV4::PivotValueRegion, decorator: Google::Apis::AnalyticsreportingV4::PivotValueRegion::Representation collection :values, as: 'values' end end class Dimension # @private class Representation < Google::Apis::Core::JsonRepresentation collection :histogram_buckets, as: 'histogramBuckets' property :name, as: 'name' end end class DimensionFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :case_sensitive, as: 'caseSensitive' property :dimension_name, as: 'dimensionName' collection :expressions, as: 'expressions' property :not, as: 'not' property :operator, as: 'operator' end end class DimensionFilterClause # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filters, as: 'filters', class: Google::Apis::AnalyticsreportingV4::DimensionFilter, decorator: Google::Apis::AnalyticsreportingV4::DimensionFilter::Representation property :operator, as: 'operator' end end class DynamicSegment # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :session_segment, as: 'sessionSegment', class: Google::Apis::AnalyticsreportingV4::SegmentDefinition, decorator: Google::Apis::AnalyticsreportingV4::SegmentDefinition::Representation property :user_segment, as: 'userSegment', class: Google::Apis::AnalyticsreportingV4::SegmentDefinition, decorator: Google::Apis::AnalyticsreportingV4::SegmentDefinition::Representation end end class GetReportsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :report_requests, as: 'reportRequests', class: Google::Apis::AnalyticsreportingV4::ReportRequest, decorator: Google::Apis::AnalyticsreportingV4::ReportRequest::Representation property :use_resource_quotas, as: 'useResourceQuotas' end end class GetReportsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :query_cost, as: 'queryCost' collection :reports, as: 'reports', class: Google::Apis::AnalyticsreportingV4::Report, decorator: Google::Apis::AnalyticsreportingV4::Report::Representation property :resource_quotas_remaining, as: 'resourceQuotasRemaining', class: Google::Apis::AnalyticsreportingV4::ResourceQuotasRemaining, decorator: Google::Apis::AnalyticsreportingV4::ResourceQuotasRemaining::Representation end end class Metric # @private class Representation < Google::Apis::Core::JsonRepresentation property :alias, as: 'alias' property :expression, as: 'expression' property :formatting_type, as: 'formattingType' end end class MetricFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :comparison_value, as: 'comparisonValue' property :metric_name, as: 'metricName' property :not, as: 'not' property :operator, as: 'operator' end end class MetricFilterClause # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filters, as: 'filters', class: Google::Apis::AnalyticsreportingV4::MetricFilter, decorator: Google::Apis::AnalyticsreportingV4::MetricFilter::Representation property :operator, as: 'operator' end end class MetricHeader # @private class Representation < Google::Apis::Core::JsonRepresentation collection :metric_header_entries, as: 'metricHeaderEntries', class: Google::Apis::AnalyticsreportingV4::MetricHeaderEntry, decorator: Google::Apis::AnalyticsreportingV4::MetricHeaderEntry::Representation collection :pivot_headers, as: 'pivotHeaders', class: Google::Apis::AnalyticsreportingV4::PivotHeader, decorator: Google::Apis::AnalyticsreportingV4::PivotHeader::Representation end end class MetricHeaderEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :type, as: 'type' end end class OrFiltersForSegment # @private class Representation < Google::Apis::Core::JsonRepresentation collection :segment_filter_clauses, as: 'segmentFilterClauses', class: Google::Apis::AnalyticsreportingV4::SegmentFilterClause, decorator: Google::Apis::AnalyticsreportingV4::SegmentFilterClause::Representation end end class OrderBy # @private class Representation < Google::Apis::Core::JsonRepresentation property :field_name, as: 'fieldName' property :order_type, as: 'orderType' property :sort_order, as: 'sortOrder' end end class Pivot # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dimension_filter_clauses, as: 'dimensionFilterClauses', class: Google::Apis::AnalyticsreportingV4::DimensionFilterClause, decorator: Google::Apis::AnalyticsreportingV4::DimensionFilterClause::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsreportingV4::Dimension, decorator: Google::Apis::AnalyticsreportingV4::Dimension::Representation property :max_group_count, as: 'maxGroupCount' collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsreportingV4::Metric, decorator: Google::Apis::AnalyticsreportingV4::Metric::Representation property :start_group, as: 'startGroup' end end class PivotHeader # @private class Representation < Google::Apis::Core::JsonRepresentation collection :pivot_header_entries, as: 'pivotHeaderEntries', class: Google::Apis::AnalyticsreportingV4::PivotHeaderEntry, decorator: Google::Apis::AnalyticsreportingV4::PivotHeaderEntry::Representation property :total_pivot_groups_count, as: 'totalPivotGroupsCount' end end class PivotHeaderEntry # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dimension_names, as: 'dimensionNames' collection :dimension_values, as: 'dimensionValues' property :metric, as: 'metric', class: Google::Apis::AnalyticsreportingV4::MetricHeaderEntry, decorator: Google::Apis::AnalyticsreportingV4::MetricHeaderEntry::Representation end end class PivotValueRegion # @private class Representation < Google::Apis::Core::JsonRepresentation collection :values, as: 'values' end end class Report # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_header, as: 'columnHeader', class: Google::Apis::AnalyticsreportingV4::ColumnHeader, decorator: Google::Apis::AnalyticsreportingV4::ColumnHeader::Representation property :data, as: 'data', class: Google::Apis::AnalyticsreportingV4::ReportData, decorator: Google::Apis::AnalyticsreportingV4::ReportData::Representation property :next_page_token, as: 'nextPageToken' end end class ReportData # @private class Representation < Google::Apis::Core::JsonRepresentation property :data_last_refreshed, as: 'dataLastRefreshed' property :is_data_golden, as: 'isDataGolden' collection :maximums, as: 'maximums', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation collection :minimums, as: 'minimums', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation property :row_count, as: 'rowCount' collection :rows, as: 'rows', class: Google::Apis::AnalyticsreportingV4::ReportRow, decorator: Google::Apis::AnalyticsreportingV4::ReportRow::Representation collection :samples_read_counts, as: 'samplesReadCounts' collection :sampling_space_sizes, as: 'samplingSpaceSizes' collection :totals, as: 'totals', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation end end class ReportRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :cohort_group, as: 'cohortGroup', class: Google::Apis::AnalyticsreportingV4::CohortGroup, decorator: Google::Apis::AnalyticsreportingV4::CohortGroup::Representation collection :date_ranges, as: 'dateRanges', class: Google::Apis::AnalyticsreportingV4::DateRange, decorator: Google::Apis::AnalyticsreportingV4::DateRange::Representation collection :dimension_filter_clauses, as: 'dimensionFilterClauses', class: Google::Apis::AnalyticsreportingV4::DimensionFilterClause, decorator: Google::Apis::AnalyticsreportingV4::DimensionFilterClause::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsreportingV4::Dimension, decorator: Google::Apis::AnalyticsreportingV4::Dimension::Representation property :filters_expression, as: 'filtersExpression' property :hide_totals, as: 'hideTotals' property :hide_value_ranges, as: 'hideValueRanges' property :include_empty_rows, as: 'includeEmptyRows' collection :metric_filter_clauses, as: 'metricFilterClauses', class: Google::Apis::AnalyticsreportingV4::MetricFilterClause, decorator: Google::Apis::AnalyticsreportingV4::MetricFilterClause::Representation collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsreportingV4::Metric, decorator: Google::Apis::AnalyticsreportingV4::Metric::Representation collection :order_bys, as: 'orderBys', class: Google::Apis::AnalyticsreportingV4::OrderBy, decorator: Google::Apis::AnalyticsreportingV4::OrderBy::Representation property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' collection :pivots, as: 'pivots', class: Google::Apis::AnalyticsreportingV4::Pivot, decorator: Google::Apis::AnalyticsreportingV4::Pivot::Representation property :sampling_level, as: 'samplingLevel' collection :segments, as: 'segments', class: Google::Apis::AnalyticsreportingV4::Segment, decorator: Google::Apis::AnalyticsreportingV4::Segment::Representation property :view_id, as: 'viewId' end end class ReportRow # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dimensions, as: 'dimensions' collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation end end class ResourceQuotasRemaining # @private class Representation < Google::Apis::Core::JsonRepresentation property :daily_quota_tokens_remaining, as: 'dailyQuotaTokensRemaining' property :hourly_quota_tokens_remaining, as: 'hourlyQuotaTokensRemaining' end end class Segment # @private class Representation < Google::Apis::Core::JsonRepresentation property :dynamic_segment, as: 'dynamicSegment', class: Google::Apis::AnalyticsreportingV4::DynamicSegment, decorator: Google::Apis::AnalyticsreportingV4::DynamicSegment::Representation property :segment_id, as: 'segmentId' end end class SegmentDefinition # @private class Representation < Google::Apis::Core::JsonRepresentation collection :segment_filters, as: 'segmentFilters', class: Google::Apis::AnalyticsreportingV4::SegmentFilter, decorator: Google::Apis::AnalyticsreportingV4::SegmentFilter::Representation end end class SegmentDimensionFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :case_sensitive, as: 'caseSensitive' property :dimension_name, as: 'dimensionName' collection :expressions, as: 'expressions' property :max_comparison_value, as: 'maxComparisonValue' property :min_comparison_value, as: 'minComparisonValue' property :operator, as: 'operator' end end class SegmentFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :not, as: 'not' property :sequence_segment, as: 'sequenceSegment', class: Google::Apis::AnalyticsreportingV4::SequenceSegment, decorator: Google::Apis::AnalyticsreportingV4::SequenceSegment::Representation property :simple_segment, as: 'simpleSegment', class: Google::Apis::AnalyticsreportingV4::SimpleSegment, decorator: Google::Apis::AnalyticsreportingV4::SimpleSegment::Representation end end class SegmentFilterClause # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension_filter, as: 'dimensionFilter', class: Google::Apis::AnalyticsreportingV4::SegmentDimensionFilter, decorator: Google::Apis::AnalyticsreportingV4::SegmentDimensionFilter::Representation property :metric_filter, as: 'metricFilter', class: Google::Apis::AnalyticsreportingV4::SegmentMetricFilter, decorator: Google::Apis::AnalyticsreportingV4::SegmentMetricFilter::Representation property :not, as: 'not' end end class SegmentMetricFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :comparison_value, as: 'comparisonValue' property :max_comparison_value, as: 'maxComparisonValue' property :metric_name, as: 'metricName' property :operator, as: 'operator' property :scope, as: 'scope' end end class SegmentSequenceStep # @private class Representation < Google::Apis::Core::JsonRepresentation property :match_type, as: 'matchType' collection :or_filters_for_segment, as: 'orFiltersForSegment', class: Google::Apis::AnalyticsreportingV4::OrFiltersForSegment, decorator: Google::Apis::AnalyticsreportingV4::OrFiltersForSegment::Representation end end class SequenceSegment # @private class Representation < Google::Apis::Core::JsonRepresentation property :first_step_should_match_first_hit, as: 'firstStepShouldMatchFirstHit' collection :segment_sequence_steps, as: 'segmentSequenceSteps', class: Google::Apis::AnalyticsreportingV4::SegmentSequenceStep, decorator: Google::Apis::AnalyticsreportingV4::SegmentSequenceStep::Representation end end class SimpleSegment # @private class Representation < Google::Apis::Core::JsonRepresentation collection :or_filters_for_segment, as: 'orFiltersForSegment', class: Google::Apis::AnalyticsreportingV4::OrFiltersForSegment, decorator: Google::Apis::AnalyticsreportingV4::OrFiltersForSegment::Representation end end end end end google-api-client-0.19.8/generated/google/apis/analyticsreporting_v4/classes.rb0000644000004100000410000017237213252673043027643 0ustar www-datawww-data# 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 AnalyticsreportingV4 # Defines a cohort. A cohort is a group of users who share a common # characteristic. For example, all users with the same acquisition date # belong to the same cohort. class Cohort include Google::Apis::Core::Hashable # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. # The start and end dates are specified in # [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::AnalyticsreportingV4::DateRange] attr_accessor :date_range # A unique name for the cohort. If not defined name will be auto-generated # with values cohort_[1234...]. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Type of the cohort. The only supported type as of now is # `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated # as `FIRST_VISIT_DATE` type cohort. # 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) @date_range = args[:date_range] if args.key?(:date_range) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) end end # Defines a cohort group. # For example: # "cohortGroup": ` # "cohorts": [` # "name": "cohort 1", # "type": "FIRST_VISIT_DATE", # "dateRange": ` "startDate": "2015-08-01", "endDate": "2015-08-01" ` # `,` # "name": "cohort 2" # "type": "FIRST_VISIT_DATE" # "dateRange": ` "startDate": "2015-07-01", "endDate": "2015-07-01" ` # `] # ` class CohortGroup include Google::Apis::Core::Hashable # The definition for the cohort. # Corresponds to the JSON property `cohorts` # @return [Array] attr_accessor :cohorts # Enable Life Time Value (LTV). LTV measures lifetime value for users # acquired through different channels. # Please see: # [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and # [Lifetime Value](https://support.google.com/analytics/answer/6182550) # If the value of lifetimeValue is false: # - The metric values are similar to the values in the web interface cohort # report. # - The cohort definition date ranges must be aligned to the calendar week # and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in # the cohort definition should be a Sunday and the `endDate` should be the # following Saturday, and for `ga:cohortNthMonth`, the `startDate` # should be the 1st of the month and `endDate` should be the last day # of the month. # When the lifetimeValue is true: # - The metric values will correspond to the values in the web interface # LifeTime value report. # - The Lifetime Value report shows you how user value (Revenue) and # engagement (Appviews, Goal Completions, Sessions, and Session Duration) # grow during the 90 days after a user is acquired. # - The metrics are calculated as a cumulative average per user per the time # increment. # - The cohort definition date ranges need not be aligned to the calendar # week and month boundaries. # - The `viewId` must be an # [app view ID](https://support.google.com/analytics/answer/2649553# # WebVersusAppViews) # Corresponds to the JSON property `lifetimeValue` # @return [Boolean] attr_accessor :lifetime_value alias_method :lifetime_value?, :lifetime_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cohorts = args[:cohorts] if args.key?(:cohorts) @lifetime_value = args[:lifetime_value] if args.key?(:lifetime_value) end end # Column headers. class ColumnHeader include Google::Apis::Core::Hashable # The dimension names in the response. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # The headers for the metrics. # Corresponds to the JSON property `metricHeader` # @return [Google::Apis::AnalyticsreportingV4::MetricHeader] attr_accessor :metric_header def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimensions = args[:dimensions] if args.key?(:dimensions) @metric_header = args[:metric_header] if args.key?(:metric_header) end end # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. # The start and end dates are specified in # [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`. class DateRange include Google::Apis::Core::Hashable # The end date for the query in the format `YYYY-MM-DD`. # Corresponds to the JSON property `endDate` # @return [String] attr_accessor :end_date # The start date for the query in the format `YYYY-MM-DD`. # Corresponds to the JSON property `startDate` # @return [String] 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 # Used to return a list of metrics for a single DateRange / dimension # combination class DateRangeValues include Google::Apis::Core::Hashable # The values of each pivot region. # Corresponds to the JSON property `pivotValueRegions` # @return [Array] attr_accessor :pivot_value_regions # Each value corresponds to each Metric in the request. # 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) @pivot_value_regions = args[:pivot_value_regions] if args.key?(:pivot_value_regions) @values = args[:values] if args.key?(:values) end end # [Dimensions](https://support.google.com/analytics/answer/1033861) # are attributes of your data. For example, the dimension `ga:city` # indicates the city, for example, "Paris" or "New York", from which # a session originates. class Dimension include Google::Apis::Core::Hashable # If non-empty, we place dimension values into buckets after string to # int64. Dimension values that are not the string representation of an # integral value will be converted to zero. The bucket values have to be in # increasing order. Each bucket is closed on the lower end, and open on the # upper end. The "first" bucket includes all values less than the first # boundary, the "last" bucket includes all values up to infinity. Dimension # values that fall in a bucket get transformed to a new dimension value. For # example, if one gives a list of "0, 1, 3, 4, 7", then we return the # following buckets: # - bucket #1: values < 0, dimension value "<0" # - bucket #2: values in [0,1), dimension value "0" # - bucket #3: values in [1,3), dimension value "1-2" # - bucket #4: values in [3,4), dimension value "3" # - bucket #5: values in [4,7), dimension value "4-6" # - bucket #6: values >= 7, dimension value "7+" # NOTE: If you are applying histogram mutation on any dimension, and using # that dimension in sort, you will want to use the sort type # `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values # will be sorted according to dictionary # (lexicographic) order. For example the ascending dictionary order is: # "<50", "1001+", "121-1000", "50-120" # And the ascending `HISTOGRAM_BUCKET` order is: # "<50", "50-120", "121-1000", "1001+" # The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"` # for a histogram-mutated dimension. # Corresponds to the JSON property `histogramBuckets` # @return [Array] attr_accessor :histogram_buckets # Name of the dimension to fetch, for example `ga:browser`. # 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) @histogram_buckets = args[:histogram_buckets] if args.key?(:histogram_buckets) @name = args[:name] if args.key?(:name) end end # Dimension filter specifies the filtering options on a dimension. class DimensionFilter include Google::Apis::Core::Hashable # Should the match be case sensitive? Default is false. # Corresponds to the JSON property `caseSensitive` # @return [Boolean] attr_accessor :case_sensitive alias_method :case_sensitive?, :case_sensitive # The dimension to filter on. A DimensionFilter must contain a dimension. # Corresponds to the JSON property `dimensionName` # @return [String] attr_accessor :dimension_name # Strings or regular expression to match against. Only the first value of # the list is used for comparison unless the operator is `IN_LIST`. # If `IN_LIST` operator, then the entire list is used to filter the # dimensions as explained in the description of the `IN_LIST` operator. # Corresponds to the JSON property `expressions` # @return [Array] attr_accessor :expressions # Logical `NOT` operator. If this boolean is set to true, then the matching # dimension values will be excluded in the report. The default is false. # Corresponds to the JSON property `not` # @return [Boolean] attr_accessor :not alias_method :not?, :not # How to match the dimension to the expression. The default is REGEXP. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive) @dimension_name = args[:dimension_name] if args.key?(:dimension_name) @expressions = args[:expressions] if args.key?(:expressions) @not = args[:not] if args.key?(:not) @operator = args[:operator] if args.key?(:operator) end end # A group of dimension filters. Set the operator value to specify how # the filters are logically combined. class DimensionFilterClause include Google::Apis::Core::Hashable # The repeated set of filters. They are logically combined based on the # operator specified. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters # The operator for combining multiple dimension filters. If unspecified, it # is treated as an `OR`. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filters = args[:filters] if args.key?(:filters) @operator = args[:operator] if args.key?(:operator) end end # Dynamic segment definition for defining the segment within the request. # A segment can select users, sessions or both. class DynamicSegment include Google::Apis::Core::Hashable # The name of the dynamic segment. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # SegmentDefinition defines the segment to be a set of SegmentFilters which # are combined together with a logical `AND` operation. # Corresponds to the JSON property `sessionSegment` # @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition] attr_accessor :session_segment # SegmentDefinition defines the segment to be a set of SegmentFilters which # are combined together with a logical `AND` operation. # Corresponds to the JSON property `userSegment` # @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition] attr_accessor :user_segment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @session_segment = args[:session_segment] if args.key?(:session_segment) @user_segment = args[:user_segment] if args.key?(:user_segment) end end # The batch request containing multiple report request. class GetReportsRequest include Google::Apis::Core::Hashable # Requests, each request will have a separate response. # There can be a maximum of 5 requests. All requests should have the same # `dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`. # Corresponds to the JSON property `reportRequests` # @return [Array] attr_accessor :report_requests # Enables # [resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas# # analytics_reporting_api_v4), # (defaults to `False`). If this field is set to `True` the # per view (profile) quotas are governed by the computational # cost of the request. Note that using cost based quotas will # higher enable sampling rates. (10 Million for `SMALL`, # 100M for `LARGE`. See the # [limits and quotas documentation](/analytics/devguides/reporting/core/v4/ # limits-quotas#analytics_reporting_api_v4) for details. # Corresponds to the JSON property `useResourceQuotas` # @return [Boolean] attr_accessor :use_resource_quotas alias_method :use_resource_quotas?, :use_resource_quotas def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @report_requests = args[:report_requests] if args.key?(:report_requests) @use_resource_quotas = args[:use_resource_quotas] if args.key?(:use_resource_quotas) end end # The main response class which holds the reports from the Reporting API # `batchGet` call. class GetReportsResponse include Google::Apis::Core::Hashable # The amount of resource quota tokens deducted to execute the query. Includes # all responses. # Corresponds to the JSON property `queryCost` # @return [Fixnum] attr_accessor :query_cost # Responses corresponding to each of the request. # Corresponds to the JSON property `reports` # @return [Array] attr_accessor :reports # The resource quota tokens remaining for the property after the request is # completed. # Corresponds to the JSON property `resourceQuotasRemaining` # @return [Google::Apis::AnalyticsreportingV4::ResourceQuotasRemaining] attr_accessor :resource_quotas_remaining def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @query_cost = args[:query_cost] if args.key?(:query_cost) @reports = args[:reports] if args.key?(:reports) @resource_quotas_remaining = args[:resource_quotas_remaining] if args.key?(:resource_quotas_remaining) end end # [Metrics](https://support.google.com/analytics/answer/1033861) # are the quantitative measurements. For example, the metric `ga:users` # indicates the total number of users for the requested time period. class Metric include Google::Apis::Core::Hashable # An alias for the metric expression is an alternate name for the # expression. The alias can be used for filtering and sorting. This field # is optional and is useful if the expression is not a single metric but # a complex expression which cannot be used in filtering and sorting. # The alias is also used in the response column header. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias # A metric expression in the request. An expression is constructed from one # or more metrics and numbers. Accepted operators include: Plus (+), Minus # (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, # Positive cardinal numbers (0-9), can include decimals and is limited to # 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the # metric expression is just a single metric name like `ga:users`. # Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics # will result in unexpected results. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression # Specifies how the metric expression should be formatted, for example # `INTEGER`. # Corresponds to the JSON property `formattingType` # @return [String] attr_accessor :formatting_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alias = args[:alias] if args.key?(:alias) @expression = args[:expression] if args.key?(:expression) @formatting_type = args[:formatting_type] if args.key?(:formatting_type) end end # MetricFilter specifies the filter on a metric. class MetricFilter include Google::Apis::Core::Hashable # The value to compare against. # Corresponds to the JSON property `comparisonValue` # @return [String] attr_accessor :comparison_value # The metric that will be filtered on. A metricFilter must contain a metric # name. A metric name can be an alias earlier defined as a metric or it can # also be a metric expression. # Corresponds to the JSON property `metricName` # @return [String] attr_accessor :metric_name # Logical `NOT` operator. If this boolean is set to true, then the matching # metric values will be excluded in the report. The default is false. # Corresponds to the JSON property `not` # @return [Boolean] attr_accessor :not alias_method :not?, :not # Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the # comparisonValue, the default is `EQUAL`. If the operator is # `IS_MISSING`, checks if the metric is missing and would ignore the # comparisonValue. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @comparison_value = args[:comparison_value] if args.key?(:comparison_value) @metric_name = args[:metric_name] if args.key?(:metric_name) @not = args[:not] if args.key?(:not) @operator = args[:operator] if args.key?(:operator) end end # Represents a group of metric filters. # Set the operator value to specify how the filters are logically combined. class MetricFilterClause include Google::Apis::Core::Hashable # The repeated set of filters. They are logically combined based on the # operator specified. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters # The operator for combining multiple metric filters. If unspecified, it is # treated as an `OR`. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filters = args[:filters] if args.key?(:filters) @operator = args[:operator] if args.key?(:operator) end end # The headers for the metrics. class MetricHeader include Google::Apis::Core::Hashable # Headers for the metrics in the response. # Corresponds to the JSON property `metricHeaderEntries` # @return [Array] attr_accessor :metric_header_entries # Headers for the pivots in the response. # Corresponds to the JSON property `pivotHeaders` # @return [Array] attr_accessor :pivot_headers def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @metric_header_entries = args[:metric_header_entries] if args.key?(:metric_header_entries) @pivot_headers = args[:pivot_headers] if args.key?(:pivot_headers) end end # Header for the metrics. class MetricHeaderEntry include Google::Apis::Core::Hashable # The name of the header. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The type of the metric, for example `INTEGER`. # 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 # A list of segment filters in the `OR` group are combined with the logical OR # operator. class OrFiltersForSegment include Google::Apis::Core::Hashable # List of segment filters to be combined with a `OR` operator. # Corresponds to the JSON property `segmentFilterClauses` # @return [Array] attr_accessor :segment_filter_clauses def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @segment_filter_clauses = args[:segment_filter_clauses] if args.key?(:segment_filter_clauses) end end # Specifies the sorting options. class OrderBy include Google::Apis::Core::Hashable # The field which to sort by. The default sort order is ascending. Example: # `ga:browser`. # Note, that you can only specify one field for sort here. For example, # `ga:browser, ga:city` is not valid. # Corresponds to the JSON property `fieldName` # @return [String] attr_accessor :field_name # The order type. The default orderType is `VALUE`. # Corresponds to the JSON property `orderType` # @return [String] attr_accessor :order_type # The sorting order for the field. # Corresponds to the JSON property `sortOrder` # @return [String] attr_accessor :sort_order def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @field_name = args[:field_name] if args.key?(:field_name) @order_type = args[:order_type] if args.key?(:order_type) @sort_order = args[:sort_order] if args.key?(:sort_order) end end # The Pivot describes the pivot section in the request. # The Pivot helps rearrange the information in the table for certain reports # by pivoting your data on a second dimension. class Pivot include Google::Apis::Core::Hashable # DimensionFilterClauses are logically combined with an `AND` operator: only # data that is included by all these DimensionFilterClauses contributes to # the values in this pivot region. Dimension filters can be used to restrict # the columns shown in the pivot region. For example if you have # `ga:browser` as the requested dimension in the pivot region, and you # specify key filters to restrict `ga:browser` to only "IE" or "Firefox", # then only those two browsers would show up as columns. # Corresponds to the JSON property `dimensionFilterClauses` # @return [Array] attr_accessor :dimension_filter_clauses # A list of dimensions to show as pivot columns. A Pivot can have a maximum # of 4 dimensions. Pivot dimensions are part of the restriction on the # total number of dimensions allowed in the request. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # Specifies the maximum number of groups to return. # The default value is 10, also the maximum value is 1,000. # Corresponds to the JSON property `maxGroupCount` # @return [Fixnum] attr_accessor :max_group_count # The pivot metrics. Pivot metrics are part of the # restriction on total number of metrics allowed in the request. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # If k metrics were requested, then the response will contain some # data-dependent multiple of k columns in the report. E.g., if you pivoted # on the dimension `ga:browser` then you'd get k columns for "Firefox", k # columns for "IE", k columns for "Chrome", etc. The ordering of the groups # of columns is determined by descending order of "total" for the first of # the k values. Ties are broken by lexicographic ordering of the first # pivot dimension, then lexicographic ordering of the second pivot # dimension, and so on. E.g., if the totals for the first value for # Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns # would be Chrome, Firefox, IE. # The following let you choose which of the groups of k columns are # included in the response. # Corresponds to the JSON property `startGroup` # @return [Fixnum] attr_accessor :start_group def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimension_filter_clauses = args[:dimension_filter_clauses] if args.key?(:dimension_filter_clauses) @dimensions = args[:dimensions] if args.key?(:dimensions) @max_group_count = args[:max_group_count] if args.key?(:max_group_count) @metrics = args[:metrics] if args.key?(:metrics) @start_group = args[:start_group] if args.key?(:start_group) end end # The headers for each of the pivot sections defined in the request. class PivotHeader include Google::Apis::Core::Hashable # A single pivot section header. # Corresponds to the JSON property `pivotHeaderEntries` # @return [Array] attr_accessor :pivot_header_entries # The total number of groups for this pivot. # Corresponds to the JSON property `totalPivotGroupsCount` # @return [Fixnum] attr_accessor :total_pivot_groups_count def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @pivot_header_entries = args[:pivot_header_entries] if args.key?(:pivot_header_entries) @total_pivot_groups_count = args[:total_pivot_groups_count] if args.key?(:total_pivot_groups_count) end end # The headers for the each of the metric column corresponding to the metrics # requested in the pivots section of the response. class PivotHeaderEntry include Google::Apis::Core::Hashable # The name of the dimensions in the pivot response. # Corresponds to the JSON property `dimensionNames` # @return [Array] attr_accessor :dimension_names # The values for the dimensions in the pivot. # Corresponds to the JSON property `dimensionValues` # @return [Array] attr_accessor :dimension_values # Header for the metrics. # Corresponds to the JSON property `metric` # @return [Google::Apis::AnalyticsreportingV4::MetricHeaderEntry] attr_accessor :metric def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimension_names = args[:dimension_names] if args.key?(:dimension_names) @dimension_values = args[:dimension_values] if args.key?(:dimension_values) @metric = args[:metric] if args.key?(:metric) end end # The metric values in the pivot region. class PivotValueRegion include Google::Apis::Core::Hashable # The values of the metrics in each of the pivot regions. # 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) @values = args[:values] if args.key?(:values) end end # The data response corresponding to the request. class Report include Google::Apis::Core::Hashable # Column headers. # Corresponds to the JSON property `columnHeader` # @return [Google::Apis::AnalyticsreportingV4::ColumnHeader] attr_accessor :column_header # The data part of the report. # Corresponds to the JSON property `data` # @return [Google::Apis::AnalyticsreportingV4::ReportData] attr_accessor :data # Page token to retrieve the next page of 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) @column_header = args[:column_header] if args.key?(:column_header) @data = args[:data] if args.key?(:data) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The data part of the report. class ReportData include Google::Apis::Core::Hashable # The last time the data in the report was refreshed. All the hits received # before this timestamp are included in the calculation of the report. # Corresponds to the JSON property `dataLastRefreshed` # @return [String] attr_accessor :data_last_refreshed # Indicates if response to this request is golden or not. Data is # golden when the exact same request will not produce any new results if # asked at a later point in time. # Corresponds to the JSON property `isDataGolden` # @return [Boolean] attr_accessor :is_data_golden alias_method :is_data_golden?, :is_data_golden # Minimum and maximum values seen over all matching rows. These are both # empty when `hideValueRanges` in the request is false, or when # rowCount is zero. # Corresponds to the JSON property `maximums` # @return [Array] attr_accessor :maximums # Minimum and maximum values seen over all matching rows. These are both # empty when `hideValueRanges` in the request is false, or when # rowCount is zero. # Corresponds to the JSON property `minimums` # @return [Array] attr_accessor :minimums # Total number of matching rows for this query. # Corresponds to the JSON property `rowCount` # @return [Fixnum] attr_accessor :row_count # There's one ReportRow for every unique combination of dimensions. # Corresponds to the JSON property `rows` # @return [Array] attr_accessor :rows # If the results are # [sampled](https://support.google.com/analytics/answer/2637192), # this returns the total number of samples read, one entry per date range. # If the results are not sampled this field will not be defined. See # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) # for details. # Corresponds to the JSON property `samplesReadCounts` # @return [Array] attr_accessor :samples_read_counts # If the results are # [sampled](https://support.google.com/analytics/answer/2637192), # this returns the total number of # samples present, one entry per date range. If the results are not sampled # this field will not be defined. See # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) # for details. # Corresponds to the JSON property `samplingSpaceSizes` # @return [Array] attr_accessor :sampling_space_sizes # For each requested date range, for the set of all rows that match # the query, every requested value format gets a total. The total # for a value format is computed by first totaling the metrics # mentioned in the value format and then evaluating the value # format as a scalar expression. E.g., The "totals" for # `3 / (ga:sessions + 2)` we compute # `3 / ((sum of all relevant ga:sessions) + 2)`. # Totals are computed before pagination. # Corresponds to the JSON property `totals` # @return [Array] attr_accessor :totals def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data_last_refreshed = args[:data_last_refreshed] if args.key?(:data_last_refreshed) @is_data_golden = args[:is_data_golden] if args.key?(:is_data_golden) @maximums = args[:maximums] if args.key?(:maximums) @minimums = args[:minimums] if args.key?(:minimums) @row_count = args[:row_count] if args.key?(:row_count) @rows = args[:rows] if args.key?(:rows) @samples_read_counts = args[:samples_read_counts] if args.key?(:samples_read_counts) @sampling_space_sizes = args[:sampling_space_sizes] if args.key?(:sampling_space_sizes) @totals = args[:totals] if args.key?(:totals) end end # The main request class which specifies the Reporting API request. class ReportRequest include Google::Apis::Core::Hashable # Defines a cohort group. # For example: # "cohortGroup": ` # "cohorts": [` # "name": "cohort 1", # "type": "FIRST_VISIT_DATE", # "dateRange": ` "startDate": "2015-08-01", "endDate": "2015-08-01" ` # `,` # "name": "cohort 2" # "type": "FIRST_VISIT_DATE" # "dateRange": ` "startDate": "2015-07-01", "endDate": "2015-07-01" ` # `] # ` # Corresponds to the JSON property `cohortGroup` # @return [Google::Apis::AnalyticsreportingV4::CohortGroup] attr_accessor :cohort_group # Date ranges in the request. The request can have a maximum of 2 date # ranges. The response will contain a set of metric values for each # combination of the dimensions for each date range in the request. So, if # there are two date ranges, there will be two set of metric values, one for # the original date range and one for the second date range. # The `reportRequest.dateRanges` field should not be specified for cohorts # or Lifetime value requests. # If a date range is not provided, the default date range is (startDate: # current date - 7 days, endDate: current date - 1 day). Every # [ReportRequest](#ReportRequest) within a `batchGet` method must # contain the same `dateRanges` definition. # Corresponds to the JSON property `dateRanges` # @return [Array] attr_accessor :date_ranges # The dimension filter clauses for filtering Dimension Values. They are # logically combined with the `AND` operator. Note that filtering occurs # before any dimensions are aggregated, so that the returned metrics # represent the total for only the relevant dimensions. # Corresponds to the JSON property `dimensionFilterClauses` # @return [Array] attr_accessor :dimension_filter_clauses # The dimensions requested. # Requests can have a total of 7 dimensions. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # Dimension or metric filters that restrict the data returned for your # request. To use the `filtersExpression`, supply a dimension or metric on # which to filter, followed by the filter expression. For example, the # following expression selects `ga:browser` dimension which starts with # Firefox; `ga:browser=~^Firefox`. For more information on dimensions # and metric filters, see # [Filters reference](https://developers.google.com/analytics/devguides/ # reporting/core/v3/reference#filters). # Corresponds to the JSON property `filtersExpression` # @return [String] attr_accessor :filters_expression # If set to true, hides the total of all metrics for all the matching rows, # for every date range. The default false and will return the totals. # Corresponds to the JSON property `hideTotals` # @return [Boolean] attr_accessor :hide_totals alias_method :hide_totals?, :hide_totals # If set to true, hides the minimum and maximum across all matching rows. # The default is false and the value ranges are returned. # Corresponds to the JSON property `hideValueRanges` # @return [Boolean] attr_accessor :hide_value_ranges alias_method :hide_value_ranges?, :hide_value_ranges # If set to false, the response does not include rows if all the retrieved # metrics are equal to zero. The default is false which will exclude these # rows. # Corresponds to the JSON property `includeEmptyRows` # @return [Boolean] attr_accessor :include_empty_rows alias_method :include_empty_rows?, :include_empty_rows # The metric filter clauses. They are logically combined with the `AND` # operator. Metric filters look at only the first date range and not the # comparing date range. Note that filtering on metrics occurs after the # metrics are aggregated. # Corresponds to the JSON property `metricFilterClauses` # @return [Array] attr_accessor :metric_filter_clauses # The metrics requested. # Requests must specify at least one metric. Requests can have a # total of 10 metrics. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Sort order on output rows. To compare two rows, the elements of the # following are applied in order until a difference is found. All date # ranges in the output get the same row order. # Corresponds to the JSON property `orderBys` # @return [Array] attr_accessor :order_bys # Page size is for paging and specifies the maximum number of returned rows. # Page size should be >= 0. A query returns the default of 1,000 rows. # The Analytics Core Reporting API returns a maximum of 10,000 rows per # request, no matter how many you ask for. It can also return fewer rows # than requested, if there aren't as many dimension segments as you expect. # For instance, there are fewer than 300 possible values for `ga:country`, # so when segmenting only by country, you can't get more than 300 rows, # even if you set `pageSize` to a higher value. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # A continuation token to get the next page of the results. Adding this to # the request will return the rows after the pageToken. The pageToken should # be the value returned in the nextPageToken parameter in the response to # the GetReports request. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token # The pivot definitions. Requests can have a maximum of 2 pivots. # Corresponds to the JSON property `pivots` # @return [Array] attr_accessor :pivots # The desired report # [sample](https://support.google.com/analytics/answer/2637192) size. # If the the `samplingLevel` field is unspecified the `DEFAULT` sampling # level is used. Every [ReportRequest](#ReportRequest) within a # `batchGet` method must contain the same `samplingLevel` definition. See # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) # for details. # Corresponds to the JSON property `samplingLevel` # @return [String] attr_accessor :sampling_level # Segment the data returned for the request. A segment definition helps look # at a subset of the segment request. A request can contain up to four # segments. Every [ReportRequest](#ReportRequest) within a # `batchGet` method must contain the same `segments` definition. Requests # with segments must have the `ga:segment` dimension. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments # The Analytics # [view ID](https://support.google.com/analytics/answer/1009618) # from which to retrieve data. Every [ReportRequest](#ReportRequest) # within a `batchGet` method must contain the same `viewId`. # Corresponds to the JSON property `viewId` # @return [String] attr_accessor :view_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cohort_group = args[:cohort_group] if args.key?(:cohort_group) @date_ranges = args[:date_ranges] if args.key?(:date_ranges) @dimension_filter_clauses = args[:dimension_filter_clauses] if args.key?(:dimension_filter_clauses) @dimensions = args[:dimensions] if args.key?(:dimensions) @filters_expression = args[:filters_expression] if args.key?(:filters_expression) @hide_totals = args[:hide_totals] if args.key?(:hide_totals) @hide_value_ranges = args[:hide_value_ranges] if args.key?(:hide_value_ranges) @include_empty_rows = args[:include_empty_rows] if args.key?(:include_empty_rows) @metric_filter_clauses = args[:metric_filter_clauses] if args.key?(:metric_filter_clauses) @metrics = args[:metrics] if args.key?(:metrics) @order_bys = args[:order_bys] if args.key?(:order_bys) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @pivots = args[:pivots] if args.key?(:pivots) @sampling_level = args[:sampling_level] if args.key?(:sampling_level) @segments = args[:segments] if args.key?(:segments) @view_id = args[:view_id] if args.key?(:view_id) end end # A row in the report. class ReportRow include Google::Apis::Core::Hashable # List of requested dimensions. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # List of metrics for each requested DateRange. # 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) @metrics = args[:metrics] if args.key?(:metrics) end end # The resource quota tokens remaining for the property after the request is # completed. class ResourceQuotasRemaining include Google::Apis::Core::Hashable # Daily resource quota remaining remaining. # Corresponds to the JSON property `dailyQuotaTokensRemaining` # @return [Fixnum] attr_accessor :daily_quota_tokens_remaining # Hourly resource quota tokens remaining. # Corresponds to the JSON property `hourlyQuotaTokensRemaining` # @return [Fixnum] attr_accessor :hourly_quota_tokens_remaining def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @daily_quota_tokens_remaining = args[:daily_quota_tokens_remaining] if args.key?(:daily_quota_tokens_remaining) @hourly_quota_tokens_remaining = args[:hourly_quota_tokens_remaining] if args.key?(:hourly_quota_tokens_remaining) end end # The segment definition, if the report needs to be segmented. # A Segment is a subset of the Analytics data. For example, of the entire # set of users, one Segment might be users from a particular country or city. class Segment include Google::Apis::Core::Hashable # Dynamic segment definition for defining the segment within the request. # A segment can select users, sessions or both. # Corresponds to the JSON property `dynamicSegment` # @return [Google::Apis::AnalyticsreportingV4::DynamicSegment] attr_accessor :dynamic_segment # The segment ID of a built-in or custom segment, for example `gaid::-3`. # Corresponds to the JSON property `segmentId` # @return [String] attr_accessor :segment_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dynamic_segment = args[:dynamic_segment] if args.key?(:dynamic_segment) @segment_id = args[:segment_id] if args.key?(:segment_id) end end # SegmentDefinition defines the segment to be a set of SegmentFilters which # are combined together with a logical `AND` operation. class SegmentDefinition include Google::Apis::Core::Hashable # A segment is defined by a set of segment filters which are combined # together with a logical `AND` operation. # Corresponds to the JSON property `segmentFilters` # @return [Array] attr_accessor :segment_filters def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @segment_filters = args[:segment_filters] if args.key?(:segment_filters) end end # Dimension filter specifies the filtering options on a dimension. class SegmentDimensionFilter include Google::Apis::Core::Hashable # Should the match be case sensitive, ignored for `IN_LIST` operator. # Corresponds to the JSON property `caseSensitive` # @return [Boolean] attr_accessor :case_sensitive alias_method :case_sensitive?, :case_sensitive # Name of the dimension for which the filter is being applied. # Corresponds to the JSON property `dimensionName` # @return [String] attr_accessor :dimension_name # The list of expressions, only the first element is used for all operators # Corresponds to the JSON property `expressions` # @return [Array] attr_accessor :expressions # Maximum comparison values for `BETWEEN` match type. # Corresponds to the JSON property `maxComparisonValue` # @return [String] attr_accessor :max_comparison_value # Minimum comparison values for `BETWEEN` match type. # Corresponds to the JSON property `minComparisonValue` # @return [String] attr_accessor :min_comparison_value # The operator to use to match the dimension with the expressions. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive) @dimension_name = args[:dimension_name] if args.key?(:dimension_name) @expressions = args[:expressions] if args.key?(:expressions) @max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value) @min_comparison_value = args[:min_comparison_value] if args.key?(:min_comparison_value) @operator = args[:operator] if args.key?(:operator) end end # SegmentFilter defines the segment to be either a simple or a sequence # segment. A simple segment condition contains dimension and metric conditions # to select the sessions or users. A sequence segment condition can be used to # select users or sessions based on sequential conditions. class SegmentFilter include Google::Apis::Core::Hashable # If true, match the complement of simple or sequence segment. # For example, to match all visits not from "New York", we can define the # segment as follows: # "sessionSegment": ` # "segmentFilters": [` # "simpleSegment" :` # "orFiltersForSegment": [` # "segmentFilterClauses":[` # "dimensionFilter": ` # "dimensionName": "ga:city", # "expressions": ["New York"] # ` # `] # `] # `, # "not": "True" # `] # `, # Corresponds to the JSON property `not` # @return [Boolean] attr_accessor :not alias_method :not?, :not # Sequence conditions consist of one or more steps, where each step is defined # by one or more dimension/metric conditions. Multiple steps can be combined # with special sequence operators. # Corresponds to the JSON property `sequenceSegment` # @return [Google::Apis::AnalyticsreportingV4::SequenceSegment] attr_accessor :sequence_segment # A Simple segment conditions consist of one or more dimension/metric # conditions that can be combined. # Corresponds to the JSON property `simpleSegment` # @return [Google::Apis::AnalyticsreportingV4::SimpleSegment] attr_accessor :simple_segment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @not = args[:not] if args.key?(:not) @sequence_segment = args[:sequence_segment] if args.key?(:sequence_segment) @simple_segment = args[:simple_segment] if args.key?(:simple_segment) end end # Filter Clause to be used in a segment definition, can be wither a metric or # a dimension filter. class SegmentFilterClause include Google::Apis::Core::Hashable # Dimension filter specifies the filtering options on a dimension. # Corresponds to the JSON property `dimensionFilter` # @return [Google::Apis::AnalyticsreportingV4::SegmentDimensionFilter] attr_accessor :dimension_filter # Metric filter to be used in a segment filter clause. # Corresponds to the JSON property `metricFilter` # @return [Google::Apis::AnalyticsreportingV4::SegmentMetricFilter] attr_accessor :metric_filter # Matches the complement (`!`) of the filter. # Corresponds to the JSON property `not` # @return [Boolean] attr_accessor :not alias_method :not?, :not def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter) @metric_filter = args[:metric_filter] if args.key?(:metric_filter) @not = args[:not] if args.key?(:not) end end # Metric filter to be used in a segment filter clause. class SegmentMetricFilter include Google::Apis::Core::Hashable # The value to compare against. If the operator is `BETWEEN`, this value is # treated as minimum comparison value. # Corresponds to the JSON property `comparisonValue` # @return [String] attr_accessor :comparison_value # Max comparison value is only used for `BETWEEN` operator. # Corresponds to the JSON property `maxComparisonValue` # @return [String] attr_accessor :max_comparison_value # The metric that will be filtered on. A `metricFilter` must contain a # metric name. # Corresponds to the JSON property `metricName` # @return [String] attr_accessor :metric_name # Specifies is the operation to perform to compare the metric. The default # is `EQUAL`. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator # Scope for a metric defines the level at which that metric is defined. The # specified metric scope must be equal to or greater than its primary scope # as defined in the data model. The primary scope is defined by if the # segment is selecting users or sessions. # Corresponds to the JSON property `scope` # @return [String] attr_accessor :scope def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @comparison_value = args[:comparison_value] if args.key?(:comparison_value) @max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value) @metric_name = args[:metric_name] if args.key?(:metric_name) @operator = args[:operator] if args.key?(:operator) @scope = args[:scope] if args.key?(:scope) end end # A segment sequence definition. class SegmentSequenceStep include Google::Apis::Core::Hashable # Specifies if the step immediately precedes or can be any time before the # next step. # Corresponds to the JSON property `matchType` # @return [String] attr_accessor :match_type # A sequence is specified with a list of Or grouped filters which are # combined with `AND` operator. # Corresponds to the JSON property `orFiltersForSegment` # @return [Array] attr_accessor :or_filters_for_segment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @match_type = args[:match_type] if args.key?(:match_type) @or_filters_for_segment = args[:or_filters_for_segment] if args.key?(:or_filters_for_segment) end end # Sequence conditions consist of one or more steps, where each step is defined # by one or more dimension/metric conditions. Multiple steps can be combined # with special sequence operators. class SequenceSegment include Google::Apis::Core::Hashable # If set, first step condition must match the first hit of the visitor (in # the date range). # Corresponds to the JSON property `firstStepShouldMatchFirstHit` # @return [Boolean] attr_accessor :first_step_should_match_first_hit alias_method :first_step_should_match_first_hit?, :first_step_should_match_first_hit # The list of steps in the sequence. # Corresponds to the JSON property `segmentSequenceSteps` # @return [Array] attr_accessor :segment_sequence_steps def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @first_step_should_match_first_hit = args[:first_step_should_match_first_hit] if args.key?(:first_step_should_match_first_hit) @segment_sequence_steps = args[:segment_sequence_steps] if args.key?(:segment_sequence_steps) end end # A Simple segment conditions consist of one or more dimension/metric # conditions that can be combined. class SimpleSegment include Google::Apis::Core::Hashable # A list of segment filters groups which are combined with logical `AND` # operator. # Corresponds to the JSON property `orFiltersForSegment` # @return [Array] attr_accessor :or_filters_for_segment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @or_filters_for_segment = args[:or_filters_for_segment] if args.key?(:or_filters_for_segment) end end end end end google-api-client-0.19.8/generated/google/apis/analyticsreporting_v4/service.rb0000644000004100000410000001000013252673043027621 0ustar www-datawww-data# 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 AnalyticsreportingV4 # Google Analytics Reporting API # # Accesses Analytics report data. # # @example # require 'google/apis/analyticsreporting_v4' # # Analyticsreporting = Google::Apis::AnalyticsreportingV4 # Alias the module # service = Analyticsreporting::AnalyticsReportingService.new # # @see https://developers.google.com/analytics/devguides/reporting/core/v4/ class AnalyticsReportingService < 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://analyticsreporting.googleapis.com/', '') @batch_path = 'batch' end # Returns the Analytics data. # @param [Google::Apis::AnalyticsreportingV4::GetReportsRequest] get_reports_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::AnalyticsreportingV4::GetReportsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticsreportingV4::GetReportsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_get_reports(get_reports_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v4/reports:batchGet', options) command.request_representation = Google::Apis::AnalyticsreportingV4::GetReportsRequest::Representation command.request_object = get_reports_request_object command.response_representation = Google::Apis::AnalyticsreportingV4::GetReportsResponse::Representation command.response_class = Google::Apis::AnalyticsreportingV4::GetReportsResponse 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 google-api-client-0.19.8/generated/google/apis/tasks_v1/0000755000004100000410000000000013252673044023047 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/tasks_v1/representations.rb0000644000004100000410000001001213252673044026613 0ustar www-datawww-data# 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 TasksV1 class Task class Representation < Google::Apis::Core::JsonRepresentation; end class Link class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class TaskList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TaskLists class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Tasks class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Task # @private class Representation < Google::Apis::Core::JsonRepresentation property :completed, as: 'completed', type: DateTime property :deleted, as: 'deleted' property :due, as: 'due', type: DateTime property :etag, as: 'etag' property :hidden, as: 'hidden' property :id, as: 'id' property :kind, as: 'kind' collection :links, as: 'links', class: Google::Apis::TasksV1::Task::Link, decorator: Google::Apis::TasksV1::Task::Link::Representation property :notes, as: 'notes' property :parent, as: 'parent' property :position, as: 'position' property :self_link, as: 'selfLink' property :status, as: 'status' property :title, as: 'title' property :updated, as: 'updated', type: DateTime end class Link # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :link, as: 'link' property :type, as: 'type' end end end class TaskList # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :self_link, as: 'selfLink' property :title, as: 'title' property :updated, as: 'updated', type: DateTime end end class TaskLists # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::TasksV1::TaskList, decorator: Google::Apis::TasksV1::TaskList::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Tasks # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::TasksV1::Task, decorator: Google::Apis::TasksV1::Task::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end end end end google-api-client-0.19.8/generated/google/apis/tasks_v1/classes.rb0000644000004100000410000002421413252673044025034 0ustar www-datawww-data# 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 TasksV1 # class Task include Google::Apis::Core::Hashable # Completion date of the task (as a RFC 3339 timestamp). This field is omitted # if the task has not been completed. # Corresponds to the JSON property `completed` # @return [DateTime] attr_accessor :completed # Flag indicating whether the task has been deleted. The default if False. # Corresponds to the JSON property `deleted` # @return [Boolean] attr_accessor :deleted alias_method :deleted?, :deleted # Due date of the task (as a RFC 3339 timestamp). Optional. # Corresponds to the JSON property `due` # @return [DateTime] attr_accessor :due # ETag of the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Flag indicating whether the task is hidden. This is the case if the task had # been marked completed when the task list was last cleared. The default is # False. This field is read-only. # Corresponds to the JSON property `hidden` # @return [Boolean] attr_accessor :hidden alias_method :hidden?, :hidden # Task identifier. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Type of the resource. This is always "tasks#task". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Collection of links. This collection is read-only. # Corresponds to the JSON property `links` # @return [Array] attr_accessor :links # Notes describing the task. Optional. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # Parent task identifier. This field is omitted if it is a top-level task. This # field is read-only. Use the "move" method to move the task under a different # parent or to the top level. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent # String indicating the position of the task among its sibling tasks under the # same parent task or at the top level. If this string is greater than another # task's corresponding position string according to lexicographical ordering, # the task is positioned after the other task under the same parent task (or at # the top level). This field is read-only. Use the "move" method to move the # task to another position. # Corresponds to the JSON property `position` # @return [String] attr_accessor :position # URL pointing to this task. Used to retrieve, update, or delete this task. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Status of the task. This is either "needsAction" or "completed". # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Title of the task. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Last modification time of the task (as a RFC 3339 timestamp). # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @completed = args[:completed] if args.key?(:completed) @deleted = args[:deleted] if args.key?(:deleted) @due = args[:due] if args.key?(:due) @etag = args[:etag] if args.key?(:etag) @hidden = args[:hidden] if args.key?(:hidden) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @links = args[:links] if args.key?(:links) @notes = args[:notes] if args.key?(:notes) @parent = args[:parent] if args.key?(:parent) @position = args[:position] if args.key?(:position) @self_link = args[:self_link] if args.key?(:self_link) @status = args[:status] if args.key?(:status) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) end # class Link include Google::Apis::Core::Hashable # The description. In HTML speak: Everything between and . # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The URL. # Corresponds to the JSON property `link` # @return [String] attr_accessor :link # Type of the link, e.g. "email". # 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) @description = args[:description] if args.key?(:description) @link = args[:link] if args.key?(:link) @type = args[:type] if args.key?(:type) end end end # class TaskList include Google::Apis::Core::Hashable # ETag of the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Task list identifier. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Type of the resource. This is always "tasks#taskList". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # URL pointing to this task list. Used to retrieve, update, or delete this task # list. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Title of the task list. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Last modification time of the task list (as a RFC 3339 timestamp). # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @self_link = args[:self_link] if args.key?(:self_link) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) end end # class TaskLists include Google::Apis::Core::Hashable # ETag of the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Collection of task lists. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of the resource. This is always "tasks#taskLists". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token that can be used to request the next page of this result. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # class Tasks include Google::Apis::Core::Hashable # ETag of the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Collection of tasks. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Type of the resource. This is always "tasks#tasks". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Token used to access the next page of this result. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end end end end google-api-client-0.19.8/generated/google/apis/tasks_v1/service.rb0000644000004100000410000010712113252673044025036 0ustar www-datawww-data# 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 TasksV1 # Tasks API # # Lets you manage your tasks and task lists. # # @example # require 'google/apis/tasks_v1' # # Tasks = Google::Apis::TasksV1 # Alias the module # service = Tasks::TasksService.new # # @see https://developers.google.com/google-apps/tasks/firstapp class TasksService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'tasks/v1/') @batch_path = 'batch/tasks/v1' end # Deletes the authenticated user's specified task list. # @param [String] tasklist # Task list identifier. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_tasklist(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'users/@me/lists/{tasklist}', options) command.params['tasklist'] = tasklist unless tasklist.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 authenticated user's specified task list. # @param [String] tasklist # Task list identifier. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::TaskList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::TaskList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tasklist(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'users/@me/lists/{tasklist}', options) command.response_representation = Google::Apis::TasksV1::TaskList::Representation command.response_class = Google::Apis::TasksV1::TaskList command.params['tasklist'] = tasklist unless tasklist.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 task list and adds it to the authenticated user's task lists. # @param [Google::Apis::TasksV1::TaskList] task_list_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::TaskList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::TaskList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tasklist(task_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'users/@me/lists', options) command.request_representation = Google::Apis::TasksV1::TaskList::Representation command.request_object = task_list_object command.response_representation = Google::Apis::TasksV1::TaskList::Representation command.response_class = Google::Apis::TasksV1::TaskList 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 the authenticated user's task lists. # @param [Fixnum] max_results # Maximum number of task lists returned on one page. Optional. The default is # 100. # @param [String] page_token # Token specifying the result page to return. 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::TaskLists] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::TaskLists] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tasklists(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'users/@me/lists', options) command.response_representation = Google::Apis::TasksV1::TaskLists::Representation command.response_class = Google::Apis::TasksV1::TaskLists command.query['maxResults'] = max_results unless max_results.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 the authenticated user's specified task list. This method supports # patch semantics. # @param [String] tasklist # Task list identifier. # @param [Google::Apis::TasksV1::TaskList] task_list_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::TaskList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::TaskList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tasklist(tasklist, task_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'users/@me/lists/{tasklist}', options) command.request_representation = Google::Apis::TasksV1::TaskList::Representation command.request_object = task_list_object command.response_representation = Google::Apis::TasksV1::TaskList::Representation command.response_class = Google::Apis::TasksV1::TaskList command.params['tasklist'] = tasklist unless tasklist.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 authenticated user's specified task list. # @param [String] tasklist # Task list identifier. # @param [Google::Apis::TasksV1::TaskList] task_list_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::TaskList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::TaskList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tasklist(tasklist, task_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'users/@me/lists/{tasklist}', options) command.request_representation = Google::Apis::TasksV1::TaskList::Representation command.request_object = task_list_object command.response_representation = Google::Apis::TasksV1::TaskList::Representation command.response_class = Google::Apis::TasksV1::TaskList command.params['tasklist'] = tasklist unless tasklist.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 # Clears all completed tasks from the specified task list. The affected tasks # will be marked as 'hidden' and no longer be returned by default when # retrieving all tasks for a task list. # @param [String] tasklist # Task list identifier. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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 clear_task(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'lists/{tasklist}/clear', options) command.params['tasklist'] = tasklist unless tasklist.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 task from the task list. # @param [String] tasklist # Task list identifier. # @param [String] task # Task identifier. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_task(tasklist, task, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'lists/{tasklist}/tasks/{task}', options) command.params['tasklist'] = tasklist unless tasklist.nil? command.params['task'] = task unless task.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 task. # @param [String] tasklist # Task list identifier. # @param [String] task # Task identifier. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_task(tasklist, task, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'lists/{tasklist}/tasks/{task}', options) command.response_representation = Google::Apis::TasksV1::Task::Representation command.response_class = Google::Apis::TasksV1::Task command.params['tasklist'] = tasklist unless tasklist.nil? command.params['task'] = task unless task.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 task on the specified task list. # @param [String] tasklist # Task list identifier. # @param [Google::Apis::TasksV1::Task] task_object # @param [String] parent # Parent task identifier. If the task is created at the top level, this # parameter is omitted. Optional. # @param [String] previous # Previous sibling task identifier. If the task is created at the first position # among its siblings, this parameter is omitted. 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_task(tasklist, task_object = nil, parent: nil, previous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'lists/{tasklist}/tasks', options) command.request_representation = Google::Apis::TasksV1::Task::Representation command.request_object = task_object command.response_representation = Google::Apis::TasksV1::Task::Representation command.response_class = Google::Apis::TasksV1::Task command.params['tasklist'] = tasklist unless tasklist.nil? command.query['parent'] = parent unless parent.nil? command.query['previous'] = previous unless previous.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 tasks in the specified task list. # @param [String] tasklist # Task list identifier. # @param [String] completed_max # Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter # by. Optional. The default is not to filter by completion date. # @param [String] completed_min # Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter # by. Optional. The default is not to filter by completion date. # @param [String] due_max # Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. # Optional. The default is not to filter by due date. # @param [String] due_min # Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. # Optional. The default is not to filter by due date. # @param [Fixnum] max_results # Maximum number of task lists returned on one page. Optional. The default is # 100. # @param [String] page_token # Token specifying the result page to return. Optional. # @param [Boolean] show_completed # Flag indicating whether completed tasks are returned in the result. Optional. # The default is True. # @param [Boolean] show_deleted # Flag indicating whether deleted tasks are returned in the result. Optional. # The default is False. # @param [Boolean] show_hidden # Flag indicating whether hidden tasks are returned in the result. Optional. The # default is False. # @param [String] updated_min # Lower bound for a task's last modification time (as a RFC 3339 timestamp) to # filter by. Optional. The default is not to filter by last modification 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::Tasks] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::Tasks] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tasks(tasklist, completed_max: nil, completed_min: nil, due_max: nil, due_min: nil, max_results: nil, page_token: nil, show_completed: nil, show_deleted: nil, show_hidden: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'lists/{tasklist}/tasks', options) command.response_representation = Google::Apis::TasksV1::Tasks::Representation command.response_class = Google::Apis::TasksV1::Tasks command.params['tasklist'] = tasklist unless tasklist.nil? command.query['completedMax'] = completed_max unless completed_max.nil? command.query['completedMin'] = completed_min unless completed_min.nil? command.query['dueMax'] = due_max unless due_max.nil? command.query['dueMin'] = due_min unless due_min.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['showCompleted'] = show_completed unless show_completed.nil? command.query['showDeleted'] = show_deleted unless show_deleted.nil? command.query['showHidden'] = show_hidden unless show_hidden.nil? command.query['updatedMin'] = updated_min unless updated_min.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 # Moves the specified task to another position in the task list. This can # include putting it as a child task under a new parent and/or move it to a # different position among its sibling tasks. # @param [String] tasklist # Task list identifier. # @param [String] task # Task identifier. # @param [String] parent # New parent task identifier. If the task is moved to the top level, this # parameter is omitted. Optional. # @param [String] previous # New previous sibling task identifier. If the task is moved to the first # position among its siblings, this parameter is omitted. 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def move_task(tasklist, task, parent: nil, previous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'lists/{tasklist}/tasks/{task}/move', options) command.response_representation = Google::Apis::TasksV1::Task::Representation command.response_class = Google::Apis::TasksV1::Task command.params['tasklist'] = tasklist unless tasklist.nil? command.params['task'] = task unless task.nil? command.query['parent'] = parent unless parent.nil? command.query['previous'] = previous unless previous.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 specified task. This method supports patch semantics. # @param [String] tasklist # Task list identifier. # @param [String] task # Task identifier. # @param [Google::Apis::TasksV1::Task] task_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_task(tasklist, task, task_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'lists/{tasklist}/tasks/{task}', options) command.request_representation = Google::Apis::TasksV1::Task::Representation command.request_object = task_object command.response_representation = Google::Apis::TasksV1::Task::Representation command.response_class = Google::Apis::TasksV1::Task command.params['tasklist'] = tasklist unless tasklist.nil? command.params['task'] = task unless task.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 specified task. # @param [String] tasklist # Task list identifier. # @param [String] task # Task identifier. # @param [Google::Apis::TasksV1::Task] task_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TasksV1::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TasksV1::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_task(tasklist, task, task_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'lists/{tasklist}/tasks/{task}', options) command.request_representation = Google::Apis::TasksV1::Task::Representation command.request_object = task_object command.response_representation = Google::Apis::TasksV1::Task::Representation command.response_class = Google::Apis::TasksV1::Task command.params['tasklist'] = tasklist unless tasklist.nil? command.params['task'] = task unless task.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 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 end end google-api-client-0.19.8/generated/google/apis/surveys_v2.rb0000644000004100000410000000254113252673044023772 0ustar www-datawww-data# 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/surveys_v2/service.rb' require 'google/apis/surveys_v2/classes.rb' require 'google/apis/surveys_v2/representations.rb' module Google module Apis # Surveys API # # Creates and conducts surveys, lists the surveys that an authenticated user # owns, and retrieves survey results and information about specified surveys. # module SurveysV2 VERSION = 'V2' REVISION = '20170407' # View and manage your surveys and results AUTH_SURVEYS = 'https://www.googleapis.com/auth/surveys' # View your surveys and survey results AUTH_SURVEYS_READONLY = 'https://www.googleapis.com/auth/surveys.readonly' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' end end end google-api-client-0.19.8/generated/google/apis/androidpublisher_v1_1.rb0000644000004100000410000000226113252673043026025 0ustar www-datawww-data# 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/androidpublisher_v1_1/service.rb' require 'google/apis/androidpublisher_v1_1/classes.rb' require 'google/apis/androidpublisher_v1_1/representations.rb' module Google module Apis # Google Play Developer API # # Lets Android application developers access their Google Play accounts. # # @see https://developers.google.com/android-publisher module AndroidpublisherV1_1 VERSION = 'V1_1' REVISION = '20180211' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' end end end google-api-client-0.19.8/generated/google/apis/digitalassetlinks_v1/0000755000004100000410000000000013252673043025437 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/digitalassetlinks_v1/representations.rb0000644000004100000410000001105713252673043031215 0ustar www-datawww-data# 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 DigitalassetlinksV1 class AndroidAppAsset 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 CertificateInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CheckResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Statement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WebAsset class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AndroidAppAsset # @private class Representation < Google::Apis::Core::JsonRepresentation property :certificate, as: 'certificate', class: Google::Apis::DigitalassetlinksV1::CertificateInfo, decorator: Google::Apis::DigitalassetlinksV1::CertificateInfo::Representation property :package_name, as: 'packageName' end end class Asset # @private class Representation < Google::Apis::Core::JsonRepresentation property :android_app, as: 'androidApp', class: Google::Apis::DigitalassetlinksV1::AndroidAppAsset, decorator: Google::Apis::DigitalassetlinksV1::AndroidAppAsset::Representation property :web, as: 'web', class: Google::Apis::DigitalassetlinksV1::WebAsset, decorator: Google::Apis::DigitalassetlinksV1::WebAsset::Representation end end class CertificateInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :sha256_fingerprint, as: 'sha256Fingerprint' end end class CheckResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :debug_string, as: 'debugString' collection :error_code, as: 'errorCode' property :linked, as: 'linked' property :max_age, as: 'maxAge' end end class ListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :debug_string, as: 'debugString' collection :error_code, as: 'errorCode' property :max_age, as: 'maxAge' collection :statements, as: 'statements', class: Google::Apis::DigitalassetlinksV1::Statement, decorator: Google::Apis::DigitalassetlinksV1::Statement::Representation end end class Statement # @private class Representation < Google::Apis::Core::JsonRepresentation property :relation, as: 'relation' property :source, as: 'source', class: Google::Apis::DigitalassetlinksV1::Asset, decorator: Google::Apis::DigitalassetlinksV1::Asset::Representation property :target, as: 'target', class: Google::Apis::DigitalassetlinksV1::Asset, decorator: Google::Apis::DigitalassetlinksV1::Asset::Representation end end class WebAsset # @private class Representation < Google::Apis::Core::JsonRepresentation property :site, as: 'site' end end end end end google-api-client-0.19.8/generated/google/apis/digitalassetlinks_v1/classes.rb0000644000004100000410000003053213252673043027424 0ustar www-datawww-data# 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 DigitalassetlinksV1 # Describes an android app asset. class AndroidAppAsset include Google::Apis::Core::Hashable # Describes an X509 certificate. # Corresponds to the JSON property `certificate` # @return [Google::Apis::DigitalassetlinksV1::CertificateInfo] attr_accessor :certificate # Android App assets are naturally identified by their Java package name. # For example, the Google Maps app uses the package name # `com.google.android.apps.maps`. # REQUIRED # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @certificate = args[:certificate] if args.key?(:certificate) @package_name = args[:package_name] if args.key?(:package_name) end end # Uniquely identifies an asset. # A digital asset is an identifiable and addressable online entity that # typically provides some service or content. Examples of assets are websites, # Android apps, Twitter feeds, and Plus Pages. class Asset include Google::Apis::Core::Hashable # Describes an android app asset. # Corresponds to the JSON property `androidApp` # @return [Google::Apis::DigitalassetlinksV1::AndroidAppAsset] attr_accessor :android_app # Describes a web asset. # Corresponds to the JSON property `web` # @return [Google::Apis::DigitalassetlinksV1::WebAsset] attr_accessor :web def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @android_app = args[:android_app] if args.key?(:android_app) @web = args[:web] if args.key?(:web) end end # Describes an X509 certificate. class CertificateInfo include Google::Apis::Core::Hashable # The uppercase SHA-265 fingerprint of the certificate. From the PEM # certificate, it can be acquired like this: # $ keytool -printcert -file $CERTFILE | grep SHA256: # SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ # 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 # or like this: # $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 # SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ # 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 # In this example, the contents of this field would be `14:6D:E9:83:C5:73: # 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: # 44:E5`. # If these tools are not available to you, you can convert the PEM # certificate into the DER format, compute the SHA-256 hash of that string # and represent the result as a hexstring (that is, uppercase hexadecimal # representations of each octet, separated by colons). # Corresponds to the JSON property `sha256Fingerprint` # @return [String] attr_accessor :sha256_fingerprint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @sha256_fingerprint = args[:sha256_fingerprint] if args.key?(:sha256_fingerprint) end end # Response message for the CheckAssetLinks call. class CheckResponse include Google::Apis::Core::Hashable # Human-readable message containing information intended to help end users # understand, reproduce and debug the result. # The message will be in English and we are currently not planning to offer # any translations. # Please note that no guarantees are made about the contents or format of # this string. Any aspect of it may be subject to change without notice. # You should not attempt to programmatically parse this data. For # programmatic access, use the error_code field below. # Corresponds to the JSON property `debugString` # @return [String] attr_accessor :debug_string # Error codes that describe the result of the Check operation. # Corresponds to the JSON property `errorCode` # @return [Array] attr_accessor :error_code # Set to true if the assets specified in the request are linked by the # relation specified in the request. # Corresponds to the JSON property `linked` # @return [Boolean] attr_accessor :linked alias_method :linked?, :linked # From serving time, how much longer the response should be considered valid # barring further updates. # REQUIRED # Corresponds to the JSON property `maxAge` # @return [String] attr_accessor :max_age def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @debug_string = args[:debug_string] if args.key?(:debug_string) @error_code = args[:error_code] if args.key?(:error_code) @linked = args[:linked] if args.key?(:linked) @max_age = args[:max_age] if args.key?(:max_age) end end # Response message for the List call. class ListResponse include Google::Apis::Core::Hashable # Human-readable message containing information intended to help end users # understand, reproduce and debug the result. # The message will be in English and we are currently not planning to offer # any translations. # Please note that no guarantees are made about the contents or format of # this string. Any aspect of it may be subject to change without notice. # You should not attempt to programmatically parse this data. For # programmatic access, use the error_code field below. # Corresponds to the JSON property `debugString` # @return [String] attr_accessor :debug_string # Error codes that describe the result of the List operation. # Corresponds to the JSON property `errorCode` # @return [Array] attr_accessor :error_code # From serving time, how much longer the response should be considered valid # barring further updates. # REQUIRED # Corresponds to the JSON property `maxAge` # @return [String] attr_accessor :max_age # A list of all the matching statements that have been found. # Corresponds to the JSON property `statements` # @return [Array] attr_accessor :statements def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @debug_string = args[:debug_string] if args.key?(:debug_string) @error_code = args[:error_code] if args.key?(:error_code) @max_age = args[:max_age] if args.key?(:max_age) @statements = args[:statements] if args.key?(:statements) end end # Describes a reliable statement that has been made about the relationship # between a source asset and a target asset. # Statements are always made by the source asset, either directly or by # delegating to a statement list that is stored elsewhere. # For more detailed definitions of statements and assets, please refer # to our [API documentation landing # page](/digital-asset-links/v1/getting-started). class Statement include Google::Apis::Core::Hashable # The relation identifies the use of the statement as intended by the source # asset's owner (that is, the person or entity who issued the statement). # Every complete statement has a relation. # We identify relations with strings of the format `/`, where # `` must be one of a set of pre-defined purpose categories, and # `` is a free-form lowercase alphanumeric string that describes the # specific use case of the statement. # Refer to [our API documentation](/digital-asset-links/v1/relation-strings) # for the current list of supported relations. # Example: `delegate_permission/common.handle_all_urls` # REQUIRED # Corresponds to the JSON property `relation` # @return [String] attr_accessor :relation # Uniquely identifies an asset. # A digital asset is an identifiable and addressable online entity that # typically provides some service or content. Examples of assets are websites, # Android apps, Twitter feeds, and Plus Pages. # Corresponds to the JSON property `source` # @return [Google::Apis::DigitalassetlinksV1::Asset] attr_accessor :source # Uniquely identifies an asset. # A digital asset is an identifiable and addressable online entity that # typically provides some service or content. Examples of assets are websites, # Android apps, Twitter feeds, and Plus Pages. # Corresponds to the JSON property `target` # @return [Google::Apis::DigitalassetlinksV1::Asset] attr_accessor :target def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @relation = args[:relation] if args.key?(:relation) @source = args[:source] if args.key?(:source) @target = args[:target] if args.key?(:target) end end # Describes a web asset. class WebAsset include Google::Apis::Core::Hashable # Web assets are identified by a URL that contains only the scheme, hostname # and port parts. The format is # http[s]://[:] # Hostnames must be fully qualified: they must end in a single period # ("`.`"). # Only the schemes "http" and "https" are currently allowed. # Port numbers are given as a decimal number, and they must be omitted if the # standard port numbers are used: 80 for http and 443 for https. # We call this limited URL the "site". All URLs that share the same scheme, # hostname and port are considered to be a part of the site and thus belong # to the web asset. # Example: the asset with the site `https://www.google.com` contains all # these URLs: # * `https://www.google.com/` # * `https://www.google.com:443/` # * `https://www.google.com/foo` # * `https://www.google.com/foo?bar` # * `https://www.google.com/foo#bar` # * `https://user@password:www.google.com/` # But it does not contain these URLs: # * `http://www.google.com/` (wrong scheme) # * `https://google.com/` (hostname does not match) # * `https://www.google.com:444/` (port does not match) # REQUIRED # Corresponds to the JSON property `site` # @return [String] attr_accessor :site def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @site = args[:site] if args.key?(:site) end end end end end google-api-client-0.19.8/generated/google/apis/digitalassetlinks_v1/service.rb0000644000004100000410000004652513252673043027440 0ustar www-datawww-data# 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 DigitalassetlinksV1 # Digital Asset Links API # # API for discovering relationships between online assets such as web sites or # mobile apps. # # @example # require 'google/apis/digitalassetlinks_v1' # # Digitalassetlinks = Google::Apis::DigitalassetlinksV1 # Alias the module # service = Digitalassetlinks::DigitalassetlinksService.new # # @see https://developers.google.com/digital-asset-links/ class DigitalassetlinksService < 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://digitalassetlinks.googleapis.com/', '') @batch_path = 'batch' end # Determines whether the specified (directional) relationship exists between # the specified source and target assets. # The relation describes the intent of the link between the two assets as # claimed by the source asset. An example for such relationships is the # delegation of privileges or permissions. # This command is most often used by infrastructure systems to check # preconditions for an action. For example, a client may want to know if it # is OK to send a web URL to a particular mobile app instead. The client can # check for the relevant asset link from the website to the mobile app to # decide if the operation should be allowed. # A note about security: if you specify a secure asset as the source, such as # an HTTPS website or an Android app, the API will ensure that any # statements used to generate the response have been made in a secure way by # the owner of that asset. Conversely, if the source asset is an insecure # HTTP website (that is, the URL starts with `http://` instead of `https://`), # the API cannot verify its statements securely, and it is not possible to # ensure that the website's statements have not been altered by a third # party. For more information, see the [Digital Asset Links technical design # specification](https://github.com/google/digitalassetlinks/blob/master/well- # known/details.md). # @param [String] relation # Query string for the relation. # We identify relations with strings of the format `/`, where # `` must be one of a set of pre-defined purpose categories, and # `` is a free-form lowercase alphanumeric string that describes the # specific use case of the statement. # Refer to [our API documentation](/digital-asset-links/v1/relation-strings) # for the current list of supported relations. # For a query to match an asset link, both the query's and the asset link's # relation strings must match exactly. # Example: A query with relation `delegate_permission/common.handle_all_urls` # matches an asset link with relation # `delegate_permission/common.handle_all_urls`. # @param [String] source_android_app_certificate_sha256_fingerprint # The uppercase SHA-265 fingerprint of the certificate. From the PEM # certificate, it can be acquired like this: # $ keytool -printcert -file $CERTFILE | grep SHA256: # SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ # 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 # or like this: # $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 # SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ # 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 # In this example, the contents of this field would be `14:6D:E9:83:C5:73: # 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: # 44:E5`. # If these tools are not available to you, you can convert the PEM # certificate into the DER format, compute the SHA-256 hash of that string # and represent the result as a hexstring (that is, uppercase hexadecimal # representations of each octet, separated by colons). # @param [String] source_android_app_package_name # Android App assets are naturally identified by their Java package name. # For example, the Google Maps app uses the package name # `com.google.android.apps.maps`. # REQUIRED # @param [String] source_web_site # Web assets are identified by a URL that contains only the scheme, hostname # and port parts. The format is # http[s]://[:] # Hostnames must be fully qualified: they must end in a single period # ("`.`"). # Only the schemes "http" and "https" are currently allowed. # Port numbers are given as a decimal number, and they must be omitted if the # standard port numbers are used: 80 for http and 443 for https. # We call this limited URL the "site". All URLs that share the same scheme, # hostname and port are considered to be a part of the site and thus belong # to the web asset. # Example: the asset with the site `https://www.google.com` contains all # these URLs: # * `https://www.google.com/` # * `https://www.google.com:443/` # * `https://www.google.com/foo` # * `https://www.google.com/foo?bar` # * `https://www.google.com/foo#bar` # * `https://user@password:www.google.com/` # But it does not contain these URLs: # * `http://www.google.com/` (wrong scheme) # * `https://google.com/` (hostname does not match) # * `https://www.google.com:444/` (port does not match) # REQUIRED # @param [String] target_android_app_certificate_sha256_fingerprint # The uppercase SHA-265 fingerprint of the certificate. From the PEM # certificate, it can be acquired like this: # $ keytool -printcert -file $CERTFILE | grep SHA256: # SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ # 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 # or like this: # $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 # SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ # 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 # In this example, the contents of this field would be `14:6D:E9:83:C5:73: # 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: # 44:E5`. # If these tools are not available to you, you can convert the PEM # certificate into the DER format, compute the SHA-256 hash of that string # and represent the result as a hexstring (that is, uppercase hexadecimal # representations of each octet, separated by colons). # @param [String] target_android_app_package_name # Android App assets are naturally identified by their Java package name. # For example, the Google Maps app uses the package name # `com.google.android.apps.maps`. # REQUIRED # @param [String] target_web_site # Web assets are identified by a URL that contains only the scheme, hostname # and port parts. The format is # http[s]://[:] # Hostnames must be fully qualified: they must end in a single period # ("`.`"). # Only the schemes "http" and "https" are currently allowed. # Port numbers are given as a decimal number, and they must be omitted if the # standard port numbers are used: 80 for http and 443 for https. # We call this limited URL the "site". All URLs that share the same scheme, # hostname and port are considered to be a part of the site and thus belong # to the web asset. # Example: the asset with the site `https://www.google.com` contains all # these URLs: # * `https://www.google.com/` # * `https://www.google.com:443/` # * `https://www.google.com/foo` # * `https://www.google.com/foo?bar` # * `https://www.google.com/foo#bar` # * `https://user@password:www.google.com/` # But it does not contain these URLs: # * `http://www.google.com/` (wrong scheme) # * `https://google.com/` (hostname does not match) # * `https://www.google.com:444/` (port does not match) # 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::DigitalassetlinksV1::CheckResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DigitalassetlinksV1::CheckResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def check_assetlink(relation: nil, source_android_app_certificate_sha256_fingerprint: nil, source_android_app_package_name: nil, source_web_site: nil, target_android_app_certificate_sha256_fingerprint: nil, target_android_app_package_name: nil, target_web_site: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/assetlinks:check', options) command.response_representation = Google::Apis::DigitalassetlinksV1::CheckResponse::Representation command.response_class = Google::Apis::DigitalassetlinksV1::CheckResponse command.query['relation'] = relation unless relation.nil? command.query['source.androidApp.certificate.sha256Fingerprint'] = source_android_app_certificate_sha256_fingerprint unless source_android_app_certificate_sha256_fingerprint.nil? command.query['source.androidApp.packageName'] = source_android_app_package_name unless source_android_app_package_name.nil? command.query['source.web.site'] = source_web_site unless source_web_site.nil? command.query['target.androidApp.certificate.sha256Fingerprint'] = target_android_app_certificate_sha256_fingerprint unless target_android_app_certificate_sha256_fingerprint.nil? command.query['target.androidApp.packageName'] = target_android_app_package_name unless target_android_app_package_name.nil? command.query['target.web.site'] = target_web_site unless target_web_site.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 list of all statements from a given source that match the # specified target and statement string. # The API guarantees that all statements with secure source assets, such as # HTTPS websites or Android apps, have been made in a secure way by the owner # of those assets, as described in the [Digital Asset Links technical design # specification](https://github.com/google/digitalassetlinks/blob/master/well- # known/details.md). # Specifically, you should consider that for insecure websites (that is, # where the URL starts with `http://` instead of `https://`), this guarantee # cannot be made. # The `List` command is most useful in cases where the API client wants to # know all the ways in which two assets are related, or enumerate all the # relationships from a particular source asset. Example: a feature that # helps users navigate to related items. When a mobile app is running on a # device, the feature would make it easy to navigate to the corresponding web # site or Google+ profile. # @param [String] relation # Use only associations that match the specified relation. # See the [`Statement`](#Statement) message for a detailed definition of # relation strings. # For a query to match a statement, one of the following must be true: # * both the query's and the statement's relation strings match exactly, # or # * the query's relation string is empty or missing. # Example: A query with relation `delegate_permission/common.handle_all_urls` # matches an asset link with relation # `delegate_permission/common.handle_all_urls`. # @param [String] source_android_app_certificate_sha256_fingerprint # The uppercase SHA-265 fingerprint of the certificate. From the PEM # certificate, it can be acquired like this: # $ keytool -printcert -file $CERTFILE | grep SHA256: # SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ # 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 # or like this: # $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 # SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ # 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 # In this example, the contents of this field would be `14:6D:E9:83:C5:73: # 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: # 44:E5`. # If these tools are not available to you, you can convert the PEM # certificate into the DER format, compute the SHA-256 hash of that string # and represent the result as a hexstring (that is, uppercase hexadecimal # representations of each octet, separated by colons). # @param [String] source_android_app_package_name # Android App assets are naturally identified by their Java package name. # For example, the Google Maps app uses the package name # `com.google.android.apps.maps`. # REQUIRED # @param [String] source_web_site # Web assets are identified by a URL that contains only the scheme, hostname # and port parts. The format is # http[s]://[:] # Hostnames must be fully qualified: they must end in a single period # ("`.`"). # Only the schemes "http" and "https" are currently allowed. # Port numbers are given as a decimal number, and they must be omitted if the # standard port numbers are used: 80 for http and 443 for https. # We call this limited URL the "site". All URLs that share the same scheme, # hostname and port are considered to be a part of the site and thus belong # to the web asset. # Example: the asset with the site `https://www.google.com` contains all # these URLs: # * `https://www.google.com/` # * `https://www.google.com:443/` # * `https://www.google.com/foo` # * `https://www.google.com/foo?bar` # * `https://www.google.com/foo#bar` # * `https://user@password:www.google.com/` # But it does not contain these URLs: # * `http://www.google.com/` (wrong scheme) # * `https://google.com/` (hostname does not match) # * `https://www.google.com:444/` (port does not match) # 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::DigitalassetlinksV1::ListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DigitalassetlinksV1::ListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_statements(relation: nil, source_android_app_certificate_sha256_fingerprint: nil, source_android_app_package_name: nil, source_web_site: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/statements:list', options) command.response_representation = Google::Apis::DigitalassetlinksV1::ListResponse::Representation command.response_class = Google::Apis::DigitalassetlinksV1::ListResponse command.query['relation'] = relation unless relation.nil? command.query['source.androidApp.certificate.sha256Fingerprint'] = source_android_app_certificate_sha256_fingerprint unless source_android_app_certificate_sha256_fingerprint.nil? command.query['source.androidApp.packageName'] = source_android_app_package_name unless source_android_app_package_name.nil? command.query['source.web.site'] = source_web_site unless source_web_site.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 google-api-client-0.19.8/generated/google/apis/identitytoolkit_v3/0000755000004100000410000000000013252673043025162 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/identitytoolkit_v3/representations.rb0000644000004100000410000010456613252673043030750 0ustar www-datawww-data# 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 IdentitytoolkitV3 class CreateAuthUriResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteAccountResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DownloadAccountResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EmailLinkSigninResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EmailTemplate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetAccountInfoResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetOobConfirmationCodeResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetRecaptchaParamResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateAuthUriRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteAccountRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DownloadAccountRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IdentitytoolkitRelyingpartyEmailLinkSigninRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetAccountInfoRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetProjectConfigResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResetPasswordRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IdentitytoolkitRelyingpartySendVerificationCodeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IdentitytoolkitRelyingpartySendVerificationCodeResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetAccountInfoRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetProjectConfigRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IdentitytoolkitRelyingpartySetProjectConfigResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SignOutUserRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SignOutUserResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SignupNewUserRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UploadAccountRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VerifyAssertionRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VerifyCustomTokenRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VerifyPasswordRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IdpConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Relyingparty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResetPasswordResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetAccountInfoResponse class Representation < Google::Apis::Core::JsonRepresentation; end class ProviderUserInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class SignupNewUserResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UploadAccountResponse class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class UserInfo class Representation < Google::Apis::Core::JsonRepresentation; end class ProviderUserInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class VerifyAssertionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VerifyCustomTokenResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VerifyPasswordResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateAuthUriResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :all_providers, as: 'allProviders' property :auth_uri, as: 'authUri' property :captcha_required, as: 'captchaRequired' property :for_existing_provider, as: 'forExistingProvider' property :kind, as: 'kind' property :provider_id, as: 'providerId' property :registered, as: 'registered' property :session_id, as: 'sessionId' collection :signin_methods, as: 'signinMethods' end end class DeleteAccountResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' end end class DownloadAccountResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :users, as: 'users', class: Google::Apis::IdentitytoolkitV3::UserInfo, decorator: Google::Apis::IdentitytoolkitV3::UserInfo::Representation end end class EmailLinkSigninResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' property :expires_in, :numeric_string => true, as: 'expiresIn' property :id_token, as: 'idToken' property :is_new_user, as: 'isNewUser' property :kind, as: 'kind' property :local_id, as: 'localId' property :refresh_token, as: 'refreshToken' end end class EmailTemplate # @private class Representation < Google::Apis::Core::JsonRepresentation property :body, as: 'body' property :format, as: 'format' property :from, as: 'from' property :from_display_name, as: 'fromDisplayName' property :reply_to, as: 'replyTo' property :subject, as: 'subject' end end class GetAccountInfoResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :users, as: 'users', class: Google::Apis::IdentitytoolkitV3::UserInfo, decorator: Google::Apis::IdentitytoolkitV3::UserInfo::Representation end end class GetOobConfirmationCodeResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' property :kind, as: 'kind' property :oob_code, as: 'oobCode' end end class GetRecaptchaParamResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :recaptcha_site_key, as: 'recaptchaSiteKey' property :recaptcha_stoken, as: 'recaptchaStoken' end end class CreateAuthUriRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :app_id, as: 'appId' property :auth_flow_type, as: 'authFlowType' property :client_id, as: 'clientId' property :context, as: 'context' property :continue_uri, as: 'continueUri' hash :custom_parameter, as: 'customParameter' property :hosted_domain, as: 'hostedDomain' property :identifier, as: 'identifier' property :oauth_consumer_key, as: 'oauthConsumerKey' property :oauth_scope, as: 'oauthScope' property :openid_realm, as: 'openidRealm' property :ota_app, as: 'otaApp' property :provider_id, as: 'providerId' property :session_id, as: 'sessionId' end end class DeleteAccountRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :delegated_project_number, :numeric_string => true, as: 'delegatedProjectNumber' property :id_token, as: 'idToken' property :local_id, as: 'localId' end end class DownloadAccountRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :delegated_project_number, :numeric_string => true, as: 'delegatedProjectNumber' property :max_results, as: 'maxResults' property :next_page_token, as: 'nextPageToken' property :target_project_id, as: 'targetProjectId' end end class IdentitytoolkitRelyingpartyEmailLinkSigninRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' property :id_token, as: 'idToken' property :oob_code, as: 'oobCode' end end class GetAccountInfoRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :delegated_project_number, :numeric_string => true, as: 'delegatedProjectNumber' collection :email, as: 'email' property :id_token, as: 'idToken' collection :local_id, as: 'localId' collection :phone_number, as: 'phoneNumber' end end class GetProjectConfigResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_password_user, as: 'allowPasswordUser' property :api_key, as: 'apiKey' collection :authorized_domains, as: 'authorizedDomains' property :change_email_template, as: 'changeEmailTemplate', class: Google::Apis::IdentitytoolkitV3::EmailTemplate, decorator: Google::Apis::IdentitytoolkitV3::EmailTemplate::Representation property :dynamic_links_domain, as: 'dynamicLinksDomain' property :enable_anonymous_user, as: 'enableAnonymousUser' collection :idp_config, as: 'idpConfig', class: Google::Apis::IdentitytoolkitV3::IdpConfig, decorator: Google::Apis::IdentitytoolkitV3::IdpConfig::Representation property :legacy_reset_password_template, as: 'legacyResetPasswordTemplate', class: Google::Apis::IdentitytoolkitV3::EmailTemplate, decorator: Google::Apis::IdentitytoolkitV3::EmailTemplate::Representation property :project_id, as: 'projectId' property :reset_password_template, as: 'resetPasswordTemplate', class: Google::Apis::IdentitytoolkitV3::EmailTemplate, decorator: Google::Apis::IdentitytoolkitV3::EmailTemplate::Representation property :use_email_sending, as: 'useEmailSending' property :verify_email_template, as: 'verifyEmailTemplate', class: Google::Apis::IdentitytoolkitV3::EmailTemplate, decorator: Google::Apis::IdentitytoolkitV3::EmailTemplate::Representation end end class ResetPasswordRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' property :new_password, as: 'newPassword' property :old_password, as: 'oldPassword' property :oob_code, as: 'oobCode' end end class IdentitytoolkitRelyingpartySendVerificationCodeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :ios_receipt, as: 'iosReceipt' property :ios_secret, as: 'iosSecret' property :phone_number, as: 'phoneNumber' property :recaptcha_token, as: 'recaptchaToken' end end class IdentitytoolkitRelyingpartySendVerificationCodeResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :session_info, as: 'sessionInfo' end end class SetAccountInfoRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :captcha_challenge, as: 'captchaChallenge' property :captcha_response, as: 'captchaResponse' property :created_at, :numeric_string => true, as: 'createdAt' property :custom_attributes, as: 'customAttributes' property :delegated_project_number, :numeric_string => true, as: 'delegatedProjectNumber' collection :delete_attribute, as: 'deleteAttribute' collection :delete_provider, as: 'deleteProvider' property :disable_user, as: 'disableUser' property :display_name, as: 'displayName' property :email, as: 'email' property :email_verified, as: 'emailVerified' property :id_token, as: 'idToken' property :instance_id, as: 'instanceId' property :last_login_at, :numeric_string => true, as: 'lastLoginAt' property :local_id, as: 'localId' property :oob_code, as: 'oobCode' property :password, as: 'password' property :phone_number, as: 'phoneNumber' property :photo_url, as: 'photoUrl' collection :provider, as: 'provider' property :return_secure_token, as: 'returnSecureToken' property :upgrade_to_federated_login, as: 'upgradeToFederatedLogin' property :valid_since, :numeric_string => true, as: 'validSince' end end class SetProjectConfigRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_password_user, as: 'allowPasswordUser' property :api_key, as: 'apiKey' collection :authorized_domains, as: 'authorizedDomains' property :change_email_template, as: 'changeEmailTemplate', class: Google::Apis::IdentitytoolkitV3::EmailTemplate, decorator: Google::Apis::IdentitytoolkitV3::EmailTemplate::Representation property :delegated_project_number, :numeric_string => true, as: 'delegatedProjectNumber' property :enable_anonymous_user, as: 'enableAnonymousUser' collection :idp_config, as: 'idpConfig', class: Google::Apis::IdentitytoolkitV3::IdpConfig, decorator: Google::Apis::IdentitytoolkitV3::IdpConfig::Representation property :legacy_reset_password_template, as: 'legacyResetPasswordTemplate', class: Google::Apis::IdentitytoolkitV3::EmailTemplate, decorator: Google::Apis::IdentitytoolkitV3::EmailTemplate::Representation property :reset_password_template, as: 'resetPasswordTemplate', class: Google::Apis::IdentitytoolkitV3::EmailTemplate, decorator: Google::Apis::IdentitytoolkitV3::EmailTemplate::Representation property :use_email_sending, as: 'useEmailSending' property :verify_email_template, as: 'verifyEmailTemplate', class: Google::Apis::IdentitytoolkitV3::EmailTemplate, decorator: Google::Apis::IdentitytoolkitV3::EmailTemplate::Representation end end class IdentitytoolkitRelyingpartySetProjectConfigResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :project_id, as: 'projectId' end end class SignOutUserRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :instance_id, as: 'instanceId' property :local_id, as: 'localId' end end class SignOutUserResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :local_id, as: 'localId' end end class SignupNewUserRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :captcha_challenge, as: 'captchaChallenge' property :captcha_response, as: 'captchaResponse' property :disabled, as: 'disabled' property :display_name, as: 'displayName' property :email, as: 'email' property :email_verified, as: 'emailVerified' property :id_token, as: 'idToken' property :instance_id, as: 'instanceId' property :local_id, as: 'localId' property :password, as: 'password' property :phone_number, as: 'phoneNumber' property :photo_url, as: 'photoUrl' end end class UploadAccountRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_overwrite, as: 'allowOverwrite' property :block_size, as: 'blockSize' property :cpu_mem_cost, as: 'cpuMemCost' property :delegated_project_number, :numeric_string => true, as: 'delegatedProjectNumber' property :dk_len, as: 'dkLen' property :hash_algorithm, as: 'hashAlgorithm' property :memory_cost, as: 'memoryCost' property :parallelization, as: 'parallelization' property :rounds, as: 'rounds' property :salt_separator, :base64 => true, as: 'saltSeparator' property :sanity_check, as: 'sanityCheck' property :signer_key, :base64 => true, as: 'signerKey' property :target_project_id, as: 'targetProjectId' collection :users, as: 'users', class: Google::Apis::IdentitytoolkitV3::UserInfo, decorator: Google::Apis::IdentitytoolkitV3::UserInfo::Representation end end class VerifyAssertionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_create, as: 'autoCreate' property :delegated_project_number, :numeric_string => true, as: 'delegatedProjectNumber' property :id_token, as: 'idToken' property :instance_id, as: 'instanceId' property :pending_id_token, as: 'pendingIdToken' property :post_body, as: 'postBody' property :request_uri, as: 'requestUri' property :return_idp_credential, as: 'returnIdpCredential' property :return_refresh_token, as: 'returnRefreshToken' property :return_secure_token, as: 'returnSecureToken' property :session_id, as: 'sessionId' end end class VerifyCustomTokenRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :delegated_project_number, :numeric_string => true, as: 'delegatedProjectNumber' property :instance_id, as: 'instanceId' property :return_secure_token, as: 'returnSecureToken' property :token, as: 'token' end end class VerifyPasswordRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :captcha_challenge, as: 'captchaChallenge' property :captcha_response, as: 'captchaResponse' property :delegated_project_number, :numeric_string => true, as: 'delegatedProjectNumber' property :email, as: 'email' property :id_token, as: 'idToken' property :instance_id, as: 'instanceId' property :password, as: 'password' property :pending_id_token, as: 'pendingIdToken' property :return_secure_token, as: 'returnSecureToken' end end class IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :id_token, as: 'idToken' property :operation, as: 'operation' property :phone_number, as: 'phoneNumber' property :session_info, as: 'sessionInfo' property :temporary_proof, as: 'temporaryProof' property :verification_proof, as: 'verificationProof' end end class IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :expires_in, :numeric_string => true, as: 'expiresIn' property :id_token, as: 'idToken' property :is_new_user, as: 'isNewUser' property :local_id, as: 'localId' property :phone_number, as: 'phoneNumber' property :refresh_token, as: 'refreshToken' property :temporary_proof, as: 'temporaryProof' property :temporary_proof_expires_in, :numeric_string => true, as: 'temporaryProofExpiresIn' property :verification_proof, as: 'verificationProof' property :verification_proof_expires_in, :numeric_string => true, as: 'verificationProofExpiresIn' end end class IdpConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_id, as: 'clientId' property :enabled, as: 'enabled' property :experiment_percent, as: 'experimentPercent' property :provider, as: 'provider' property :secret, as: 'secret' collection :whitelisted_audiences, as: 'whitelistedAudiences' end end class Relyingparty # @private class Representation < Google::Apis::Core::JsonRepresentation property :android_install_app, as: 'androidInstallApp' property :android_minimum_version, as: 'androidMinimumVersion' property :android_package_name, as: 'androidPackageName' property :can_handle_code_in_app, as: 'canHandleCodeInApp' property :captcha_resp, as: 'captchaResp' property :challenge, as: 'challenge' property :continue_url, as: 'continueUrl' property :email, as: 'email' property :i_os_app_store_id, as: 'iOSAppStoreId' property :i_os_bundle_id, as: 'iOSBundleId' property :id_token, as: 'idToken' property :kind, as: 'kind' property :new_email, as: 'newEmail' property :request_type, as: 'requestType' property :user_ip, as: 'userIp' end end class ResetPasswordResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' property :kind, as: 'kind' property :new_email, as: 'newEmail' property :request_type, as: 'requestType' end end class SetAccountInfoResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :email, as: 'email' property :email_verified, as: 'emailVerified' property :expires_in, :numeric_string => true, as: 'expiresIn' property :id_token, as: 'idToken' property :kind, as: 'kind' property :local_id, as: 'localId' property :new_email, as: 'newEmail' property :password_hash, :base64 => true, as: 'passwordHash' property :photo_url, as: 'photoUrl' collection :provider_user_info, as: 'providerUserInfo', class: Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse::ProviderUserInfo, decorator: Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse::ProviderUserInfo::Representation property :refresh_token, as: 'refreshToken' end class ProviderUserInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :federated_id, as: 'federatedId' property :photo_url, as: 'photoUrl' property :provider_id, as: 'providerId' end end end class SignupNewUserResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :email, as: 'email' property :expires_in, :numeric_string => true, as: 'expiresIn' property :id_token, as: 'idToken' property :kind, as: 'kind' property :local_id, as: 'localId' property :refresh_token, as: 'refreshToken' end end class UploadAccountResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :error, as: 'error', class: Google::Apis::IdentitytoolkitV3::UploadAccountResponse::Error, decorator: Google::Apis::IdentitytoolkitV3::UploadAccountResponse::Error::Representation property :kind, as: 'kind' end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :index, as: 'index' property :message, as: 'message' end end end class UserInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :created_at, :numeric_string => true, as: 'createdAt' property :custom_attributes, as: 'customAttributes' property :custom_auth, as: 'customAuth' property :disabled, as: 'disabled' property :display_name, as: 'displayName' property :email, as: 'email' property :email_verified, as: 'emailVerified' property :last_login_at, :numeric_string => true, as: 'lastLoginAt' property :local_id, as: 'localId' property :password_hash, :base64 => true, as: 'passwordHash' property :password_updated_at, as: 'passwordUpdatedAt' property :phone_number, as: 'phoneNumber' property :photo_url, as: 'photoUrl' collection :provider_user_info, as: 'providerUserInfo', class: Google::Apis::IdentitytoolkitV3::UserInfo::ProviderUserInfo, decorator: Google::Apis::IdentitytoolkitV3::UserInfo::ProviderUserInfo::Representation property :raw_password, as: 'rawPassword' property :salt, :base64 => true, as: 'salt' property :screen_name, as: 'screenName' property :valid_since, :numeric_string => true, as: 'validSince' property :version, as: 'version' end class ProviderUserInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :email, as: 'email' property :federated_id, as: 'federatedId' property :phone_number, as: 'phoneNumber' property :photo_url, as: 'photoUrl' property :provider_id, as: 'providerId' property :raw_id, as: 'rawId' property :screen_name, as: 'screenName' end end end class VerifyAssertionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' property :app_installation_url, as: 'appInstallationUrl' property :app_scheme, as: 'appScheme' property :context, as: 'context' property :date_of_birth, as: 'dateOfBirth' property :display_name, as: 'displayName' property :email, as: 'email' property :email_recycled, as: 'emailRecycled' property :email_verified, as: 'emailVerified' property :error_message, as: 'errorMessage' property :expires_in, :numeric_string => true, as: 'expiresIn' property :federated_id, as: 'federatedId' property :first_name, as: 'firstName' property :full_name, as: 'fullName' property :id_token, as: 'idToken' property :input_email, as: 'inputEmail' property :is_new_user, as: 'isNewUser' property :kind, as: 'kind' property :language, as: 'language' property :last_name, as: 'lastName' property :local_id, as: 'localId' property :need_confirmation, as: 'needConfirmation' property :need_email, as: 'needEmail' property :nick_name, as: 'nickName' property :oauth_access_token, as: 'oauthAccessToken' property :oauth_authorization_code, as: 'oauthAuthorizationCode' property :oauth_expire_in, as: 'oauthExpireIn' property :oauth_id_token, as: 'oauthIdToken' property :oauth_request_token, as: 'oauthRequestToken' property :oauth_scope, as: 'oauthScope' property :oauth_token_secret, as: 'oauthTokenSecret' property :original_email, as: 'originalEmail' property :photo_url, as: 'photoUrl' property :provider_id, as: 'providerId' property :raw_user_info, as: 'rawUserInfo' property :refresh_token, as: 'refreshToken' property :screen_name, as: 'screenName' property :time_zone, as: 'timeZone' collection :verified_provider, as: 'verifiedProvider' end end class VerifyCustomTokenResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :expires_in, :numeric_string => true, as: 'expiresIn' property :id_token, as: 'idToken' property :is_new_user, as: 'isNewUser' property :kind, as: 'kind' property :refresh_token, as: 'refreshToken' end end class VerifyPasswordResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :email, as: 'email' property :expires_in, :numeric_string => true, as: 'expiresIn' property :id_token, as: 'idToken' property :kind, as: 'kind' property :local_id, as: 'localId' property :oauth_access_token, as: 'oauthAccessToken' property :oauth_authorization_code, as: 'oauthAuthorizationCode' property :oauth_expire_in, as: 'oauthExpireIn' property :photo_url, as: 'photoUrl' property :refresh_token, as: 'refreshToken' property :registered, as: 'registered' end end end end end google-api-client-0.19.8/generated/google/apis/identitytoolkit_v3/classes.rb0000644000004100000410000030774013252673043027157 0ustar www-datawww-data# 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 IdentitytoolkitV3 # Response of creating the IDP authentication URL. class CreateAuthUriResponse include Google::Apis::Core::Hashable # all providers the user has once used to do federated login # Corresponds to the JSON property `allProviders` # @return [Array] attr_accessor :all_providers # The URI used by the IDP to authenticate the user. # Corresponds to the JSON property `authUri` # @return [String] attr_accessor :auth_uri # True if captcha is required. # Corresponds to the JSON property `captchaRequired` # @return [Boolean] attr_accessor :captcha_required alias_method :captcha_required?, :captcha_required # True if the authUri is for user's existing provider. # Corresponds to the JSON property `forExistingProvider` # @return [Boolean] attr_accessor :for_existing_provider alias_method :for_existing_provider?, :for_existing_provider # The fixed string identitytoolkit#CreateAuthUriResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The provider ID of the auth URI. # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id # Whether the user is registered if the identifier is an email. # Corresponds to the JSON property `registered` # @return [Boolean] attr_accessor :registered alias_method :registered?, :registered # Session ID which should be passed in the following verifyAssertion request. # Corresponds to the JSON property `sessionId` # @return [String] attr_accessor :session_id # All sign-in methods this user has used. # Corresponds to the JSON property `signinMethods` # @return [Array] attr_accessor :signin_methods def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @all_providers = args[:all_providers] if args.key?(:all_providers) @auth_uri = args[:auth_uri] if args.key?(:auth_uri) @captcha_required = args[:captcha_required] if args.key?(:captcha_required) @for_existing_provider = args[:for_existing_provider] if args.key?(:for_existing_provider) @kind = args[:kind] if args.key?(:kind) @provider_id = args[:provider_id] if args.key?(:provider_id) @registered = args[:registered] if args.key?(:registered) @session_id = args[:session_id] if args.key?(:session_id) @signin_methods = args[:signin_methods] if args.key?(:signin_methods) end end # Respone of deleting account. class DeleteAccountResponse include Google::Apis::Core::Hashable # The fixed string "identitytoolkit#DeleteAccountResponse". # 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) @kind = args[:kind] if args.key?(:kind) end end # Response of downloading accounts in batch. class DownloadAccountResponse include Google::Apis::Core::Hashable # The fixed string "identitytoolkit#DownloadAccountResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The next page token. To be used in a subsequent request to return the next # page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The user accounts data. # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users 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) @users = args[:users] if args.key?(:users) end end # Response of email signIn. class EmailLinkSigninResponse include Google::Apis::Core::Hashable # The user's email. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # Expiration time of STS id token in seconds. # Corresponds to the JSON property `expiresIn` # @return [Fixnum] attr_accessor :expires_in # The STS id token to login the newly signed in user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # Whether the user is new. # Corresponds to the JSON property `isNewUser` # @return [Boolean] attr_accessor :is_new_user alias_method :is_new_user?, :is_new_user # The fixed string "identitytoolkit#EmailLinkSigninResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The RP local ID of the user. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id # The refresh token for the signed in user. # Corresponds to the JSON property `refreshToken` # @return [String] attr_accessor :refresh_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) @expires_in = args[:expires_in] if args.key?(:expires_in) @id_token = args[:id_token] if args.key?(:id_token) @is_new_user = args[:is_new_user] if args.key?(:is_new_user) @kind = args[:kind] if args.key?(:kind) @local_id = args[:local_id] if args.key?(:local_id) @refresh_token = args[:refresh_token] if args.key?(:refresh_token) end end # Template for an email template. class EmailTemplate include Google::Apis::Core::Hashable # Email body. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body # Email body format. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # From address of the email. # Corresponds to the JSON property `from` # @return [String] attr_accessor :from # From display name. # Corresponds to the JSON property `fromDisplayName` # @return [String] attr_accessor :from_display_name # Reply-to address. # Corresponds to the JSON property `replyTo` # @return [String] attr_accessor :reply_to # Subject of the email. # Corresponds to the JSON property `subject` # @return [String] attr_accessor :subject def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @body = args[:body] if args.key?(:body) @format = args[:format] if args.key?(:format) @from = args[:from] if args.key?(:from) @from_display_name = args[:from_display_name] if args.key?(:from_display_name) @reply_to = args[:reply_to] if args.key?(:reply_to) @subject = args[:subject] if args.key?(:subject) end end # Response of getting account information. class GetAccountInfoResponse include Google::Apis::Core::Hashable # The fixed string "identitytoolkit#GetAccountInfoResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The info of the users. # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @users = args[:users] if args.key?(:users) end end # Response of getting a code for user confirmation (reset password, change email # etc.). class GetOobConfirmationCodeResponse include Google::Apis::Core::Hashable # The email address that the email is sent to. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The fixed string "identitytoolkit#GetOobConfirmationCodeResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The code to be send to the user. # Corresponds to the JSON property `oobCode` # @return [String] attr_accessor :oob_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) @kind = args[:kind] if args.key?(:kind) @oob_code = args[:oob_code] if args.key?(:oob_code) end end # Response of getting recaptcha param. class GetRecaptchaParamResponse include Google::Apis::Core::Hashable # The fixed string "identitytoolkit#GetRecaptchaParamResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Site key registered at recaptcha. # Corresponds to the JSON property `recaptchaSiteKey` # @return [String] attr_accessor :recaptcha_site_key # The stoken field for the recaptcha widget, used to request captcha challenge. # Corresponds to the JSON property `recaptchaStoken` # @return [String] attr_accessor :recaptcha_stoken def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @recaptcha_site_key = args[:recaptcha_site_key] if args.key?(:recaptcha_site_key) @recaptcha_stoken = args[:recaptcha_stoken] if args.key?(:recaptcha_stoken) end end # Request to get the IDP authentication URL. class CreateAuthUriRequest include Google::Apis::Core::Hashable # The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, # BUNDLE_ID for iOS. # Corresponds to the JSON property `appId` # @return [String] attr_accessor :app_id # Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. # The field is only used for Google provider. # Corresponds to the JSON property `authFlowType` # @return [String] attr_accessor :auth_flow_type # The relying party OAuth client ID. # Corresponds to the JSON property `clientId` # @return [String] attr_accessor :client_id # The opaque value used by the client to maintain context info between the # authentication request and the IDP callback. # Corresponds to the JSON property `context` # @return [String] attr_accessor :context # The URI to which the IDP redirects the user after the federated login flow. # Corresponds to the JSON property `continueUri` # @return [String] attr_accessor :continue_uri # The query parameter that client can customize by themselves in auth url. The # following parameters are reserved for server so that they cannot be customized # by clients: client_id, response_type, scope, redirect_uri, state, oauth_token. # Corresponds to the JSON property `customParameter` # @return [Hash] attr_accessor :custom_parameter # The hosted domain to restrict sign-in to accounts at that domain for Google # Apps hosted accounts. # Corresponds to the JSON property `hostedDomain` # @return [String] attr_accessor :hosted_domain # The email or federated ID of the user. # Corresponds to the JSON property `identifier` # @return [String] attr_accessor :identifier # The developer's consumer key for OpenId OAuth Extension # Corresponds to the JSON property `oauthConsumerKey` # @return [String] attr_accessor :oauth_consumer_key # Additional oauth scopes, beyond the basid user profile, that the user would be # prompted to grant # Corresponds to the JSON property `oauthScope` # @return [String] attr_accessor :oauth_scope # Optional realm for OpenID protocol. The sub string "scheme://domain:port" of # the param "continueUri" is used if this is not set. # Corresponds to the JSON property `openidRealm` # @return [String] attr_accessor :openid_realm # The native app package for OTA installation. # Corresponds to the JSON property `otaApp` # @return [String] attr_accessor :ota_app # The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, # aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier. # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id # The session_id passed by client. # 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) @app_id = args[:app_id] if args.key?(:app_id) @auth_flow_type = args[:auth_flow_type] if args.key?(:auth_flow_type) @client_id = args[:client_id] if args.key?(:client_id) @context = args[:context] if args.key?(:context) @continue_uri = args[:continue_uri] if args.key?(:continue_uri) @custom_parameter = args[:custom_parameter] if args.key?(:custom_parameter) @hosted_domain = args[:hosted_domain] if args.key?(:hosted_domain) @identifier = args[:identifier] if args.key?(:identifier) @oauth_consumer_key = args[:oauth_consumer_key] if args.key?(:oauth_consumer_key) @oauth_scope = args[:oauth_scope] if args.key?(:oauth_scope) @openid_realm = args[:openid_realm] if args.key?(:openid_realm) @ota_app = args[:ota_app] if args.key?(:ota_app) @provider_id = args[:provider_id] if args.key?(:provider_id) @session_id = args[:session_id] if args.key?(:session_id) end end # Request to delete account. class DeleteAccountRequest include Google::Apis::Core::Hashable # GCP project number of the requesting delegated app. Currently only intended # for Firebase V1 migration. # Corresponds to the JSON property `delegatedProjectNumber` # @return [Fixnum] attr_accessor :delegated_project_number # The GITKit token or STS id token of the authenticated user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # The local ID of the user. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number) @id_token = args[:id_token] if args.key?(:id_token) @local_id = args[:local_id] if args.key?(:local_id) end end # Request to download user account in batch. class DownloadAccountRequest include Google::Apis::Core::Hashable # GCP project number of the requesting delegated app. Currently only intended # for Firebase V1 migration. # Corresponds to the JSON property `delegatedProjectNumber` # @return [Fixnum] attr_accessor :delegated_project_number # The max number of results to return in the response. # Corresponds to the JSON property `maxResults` # @return [Fixnum] attr_accessor :max_results # The token for the next page. This should be taken from the previous response. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Specify which project (field value is actually project id) to operate. Only # used when provided credential. # Corresponds to the JSON property `targetProjectId` # @return [String] attr_accessor :target_project_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number) @max_results = args[:max_results] if args.key?(:max_results) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @target_project_id = args[:target_project_id] if args.key?(:target_project_id) end end # Request to sign in with email. class IdentitytoolkitRelyingpartyEmailLinkSigninRequest include Google::Apis::Core::Hashable # The email address of the user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # Token for linking flow. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # The confirmation code. # Corresponds to the JSON property `oobCode` # @return [String] attr_accessor :oob_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) @id_token = args[:id_token] if args.key?(:id_token) @oob_code = args[:oob_code] if args.key?(:oob_code) end end # Request to get the account information. class GetAccountInfoRequest include Google::Apis::Core::Hashable # GCP project number of the requesting delegated app. Currently only intended # for Firebase V1 migration. # Corresponds to the JSON property `delegatedProjectNumber` # @return [Fixnum] attr_accessor :delegated_project_number # The list of emails of the users to inquiry. # Corresponds to the JSON property `email` # @return [Array] attr_accessor :email # The GITKit token of the authenticated user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # The list of local ID's of the users to inquiry. # Corresponds to the JSON property `localId` # @return [Array] attr_accessor :local_id # Privileged caller can query users by specified phone number. # Corresponds to the JSON property `phoneNumber` # @return [Array] attr_accessor :phone_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number) @email = args[:email] if args.key?(:email) @id_token = args[:id_token] if args.key?(:id_token) @local_id = args[:local_id] if args.key?(:local_id) @phone_number = args[:phone_number] if args.key?(:phone_number) end end # Response of getting the project configuration. class GetProjectConfigResponse include Google::Apis::Core::Hashable # Whether to allow password user sign in or sign up. # Corresponds to the JSON property `allowPasswordUser` # @return [Boolean] attr_accessor :allow_password_user alias_method :allow_password_user?, :allow_password_user # Browser API key, needed when making http request to Apiary. # Corresponds to the JSON property `apiKey` # @return [String] attr_accessor :api_key # Authorized domains. # Corresponds to the JSON property `authorizedDomains` # @return [Array] attr_accessor :authorized_domains # Template for an email template. # Corresponds to the JSON property `changeEmailTemplate` # @return [Google::Apis::IdentitytoolkitV3::EmailTemplate] attr_accessor :change_email_template # # Corresponds to the JSON property `dynamicLinksDomain` # @return [String] attr_accessor :dynamic_links_domain # Whether anonymous user is enabled. # Corresponds to the JSON property `enableAnonymousUser` # @return [Boolean] attr_accessor :enable_anonymous_user alias_method :enable_anonymous_user?, :enable_anonymous_user # OAuth2 provider configuration. # Corresponds to the JSON property `idpConfig` # @return [Array] attr_accessor :idp_config # Template for an email template. # Corresponds to the JSON property `legacyResetPasswordTemplate` # @return [Google::Apis::IdentitytoolkitV3::EmailTemplate] attr_accessor :legacy_reset_password_template # Project ID of the relying party. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # Template for an email template. # Corresponds to the JSON property `resetPasswordTemplate` # @return [Google::Apis::IdentitytoolkitV3::EmailTemplate] attr_accessor :reset_password_template # Whether to use email sending provided by Firebear. # Corresponds to the JSON property `useEmailSending` # @return [Boolean] attr_accessor :use_email_sending alias_method :use_email_sending?, :use_email_sending # Template for an email template. # Corresponds to the JSON property `verifyEmailTemplate` # @return [Google::Apis::IdentitytoolkitV3::EmailTemplate] attr_accessor :verify_email_template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allow_password_user = args[:allow_password_user] if args.key?(:allow_password_user) @api_key = args[:api_key] if args.key?(:api_key) @authorized_domains = args[:authorized_domains] if args.key?(:authorized_domains) @change_email_template = args[:change_email_template] if args.key?(:change_email_template) @dynamic_links_domain = args[:dynamic_links_domain] if args.key?(:dynamic_links_domain) @enable_anonymous_user = args[:enable_anonymous_user] if args.key?(:enable_anonymous_user) @idp_config = args[:idp_config] if args.key?(:idp_config) @legacy_reset_password_template = args[:legacy_reset_password_template] if args.key?(:legacy_reset_password_template) @project_id = args[:project_id] if args.key?(:project_id) @reset_password_template = args[:reset_password_template] if args.key?(:reset_password_template) @use_email_sending = args[:use_email_sending] if args.key?(:use_email_sending) @verify_email_template = args[:verify_email_template] if args.key?(:verify_email_template) end end # Request to reset the password. class ResetPasswordRequest include Google::Apis::Core::Hashable # The email address of the user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The new password inputted by the user. # Corresponds to the JSON property `newPassword` # @return [String] attr_accessor :new_password # The old password inputted by the user. # Corresponds to the JSON property `oldPassword` # @return [String] attr_accessor :old_password # The confirmation code. # Corresponds to the JSON property `oobCode` # @return [String] attr_accessor :oob_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) @new_password = args[:new_password] if args.key?(:new_password) @old_password = args[:old_password] if args.key?(:old_password) @oob_code = args[:oob_code] if args.key?(:oob_code) end end # Request for Identitytoolkit-SendVerificationCode class IdentitytoolkitRelyingpartySendVerificationCodeRequest include Google::Apis::Core::Hashable # Receipt of successful app token validation with APNS. # Corresponds to the JSON property `iosReceipt` # @return [String] attr_accessor :ios_receipt # Secret delivered to iOS app via APNS. # Corresponds to the JSON property `iosSecret` # @return [String] attr_accessor :ios_secret # The phone number to send the verification code to in E.164 format. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number # Recaptcha solution. # Corresponds to the JSON property `recaptchaToken` # @return [String] attr_accessor :recaptcha_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ios_receipt = args[:ios_receipt] if args.key?(:ios_receipt) @ios_secret = args[:ios_secret] if args.key?(:ios_secret) @phone_number = args[:phone_number] if args.key?(:phone_number) @recaptcha_token = args[:recaptcha_token] if args.key?(:recaptcha_token) end end # Response for Identitytoolkit-SendVerificationCode class IdentitytoolkitRelyingpartySendVerificationCodeResponse include Google::Apis::Core::Hashable # Encrypted session information # Corresponds to the JSON property `sessionInfo` # @return [String] attr_accessor :session_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @session_info = args[:session_info] if args.key?(:session_info) end end # Request to set the account information. class SetAccountInfoRequest include Google::Apis::Core::Hashable # The captcha challenge. # Corresponds to the JSON property `captchaChallenge` # @return [String] attr_accessor :captcha_challenge # Response to the captcha. # Corresponds to the JSON property `captchaResponse` # @return [String] attr_accessor :captcha_response # The timestamp when the account is created. # Corresponds to the JSON property `createdAt` # @return [Fixnum] attr_accessor :created_at # The custom attributes to be set in the user's id token. # Corresponds to the JSON property `customAttributes` # @return [String] attr_accessor :custom_attributes # GCP project number of the requesting delegated app. Currently only intended # for Firebase V1 migration. # Corresponds to the JSON property `delegatedProjectNumber` # @return [Fixnum] attr_accessor :delegated_project_number # The attributes users request to delete. # Corresponds to the JSON property `deleteAttribute` # @return [Array] attr_accessor :delete_attribute # The IDPs the user request to delete. # Corresponds to the JSON property `deleteProvider` # @return [Array] attr_accessor :delete_provider # Whether to disable the user. # Corresponds to the JSON property `disableUser` # @return [Boolean] attr_accessor :disable_user alias_method :disable_user?, :disable_user # The name of the user. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The email of the user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # Mark the email as verified or not. # Corresponds to the JSON property `emailVerified` # @return [Boolean] attr_accessor :email_verified alias_method :email_verified?, :email_verified # The GITKit token of the authenticated user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # Instance id token of the app. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id # Last login timestamp. # Corresponds to the JSON property `lastLoginAt` # @return [Fixnum] attr_accessor :last_login_at # The local ID of the user. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id # The out-of-band code of the change email request. # Corresponds to the JSON property `oobCode` # @return [String] attr_accessor :oob_code # The new password of the user. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # Privileged caller can update user with specified phone number. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number # The photo url of the user. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url # The associated IDPs of the user. # Corresponds to the JSON property `provider` # @return [Array] attr_accessor :provider # Whether return sts id token and refresh token instead of gitkit token. # Corresponds to the JSON property `returnSecureToken` # @return [Boolean] attr_accessor :return_secure_token alias_method :return_secure_token?, :return_secure_token # Mark the user to upgrade to federated login. # Corresponds to the JSON property `upgradeToFederatedLogin` # @return [Boolean] attr_accessor :upgrade_to_federated_login alias_method :upgrade_to_federated_login?, :upgrade_to_federated_login # Timestamp in seconds for valid login token. # Corresponds to the JSON property `validSince` # @return [Fixnum] attr_accessor :valid_since def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @captcha_challenge = args[:captcha_challenge] if args.key?(:captcha_challenge) @captcha_response = args[:captcha_response] if args.key?(:captcha_response) @created_at = args[:created_at] if args.key?(:created_at) @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes) @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number) @delete_attribute = args[:delete_attribute] if args.key?(:delete_attribute) @delete_provider = args[:delete_provider] if args.key?(:delete_provider) @disable_user = args[:disable_user] if args.key?(:disable_user) @display_name = args[:display_name] if args.key?(:display_name) @email = args[:email] if args.key?(:email) @email_verified = args[:email_verified] if args.key?(:email_verified) @id_token = args[:id_token] if args.key?(:id_token) @instance_id = args[:instance_id] if args.key?(:instance_id) @last_login_at = args[:last_login_at] if args.key?(:last_login_at) @local_id = args[:local_id] if args.key?(:local_id) @oob_code = args[:oob_code] if args.key?(:oob_code) @password = args[:password] if args.key?(:password) @phone_number = args[:phone_number] if args.key?(:phone_number) @photo_url = args[:photo_url] if args.key?(:photo_url) @provider = args[:provider] if args.key?(:provider) @return_secure_token = args[:return_secure_token] if args.key?(:return_secure_token) @upgrade_to_federated_login = args[:upgrade_to_federated_login] if args.key?(:upgrade_to_federated_login) @valid_since = args[:valid_since] if args.key?(:valid_since) end end # Request to set the project configuration. class SetProjectConfigRequest include Google::Apis::Core::Hashable # Whether to allow password user sign in or sign up. # Corresponds to the JSON property `allowPasswordUser` # @return [Boolean] attr_accessor :allow_password_user alias_method :allow_password_user?, :allow_password_user # Browser API key, needed when making http request to Apiary. # Corresponds to the JSON property `apiKey` # @return [String] attr_accessor :api_key # Authorized domains for widget redirect. # Corresponds to the JSON property `authorizedDomains` # @return [Array] attr_accessor :authorized_domains # Template for an email template. # Corresponds to the JSON property `changeEmailTemplate` # @return [Google::Apis::IdentitytoolkitV3::EmailTemplate] attr_accessor :change_email_template # GCP project number of the requesting delegated app. Currently only intended # for Firebase V1 migration. # Corresponds to the JSON property `delegatedProjectNumber` # @return [Fixnum] attr_accessor :delegated_project_number # Whether to enable anonymous user. # Corresponds to the JSON property `enableAnonymousUser` # @return [Boolean] attr_accessor :enable_anonymous_user alias_method :enable_anonymous_user?, :enable_anonymous_user # Oauth2 provider configuration. # Corresponds to the JSON property `idpConfig` # @return [Array] attr_accessor :idp_config # Template for an email template. # Corresponds to the JSON property `legacyResetPasswordTemplate` # @return [Google::Apis::IdentitytoolkitV3::EmailTemplate] attr_accessor :legacy_reset_password_template # Template for an email template. # Corresponds to the JSON property `resetPasswordTemplate` # @return [Google::Apis::IdentitytoolkitV3::EmailTemplate] attr_accessor :reset_password_template # Whether to use email sending provided by Firebear. # Corresponds to the JSON property `useEmailSending` # @return [Boolean] attr_accessor :use_email_sending alias_method :use_email_sending?, :use_email_sending # Template for an email template. # Corresponds to the JSON property `verifyEmailTemplate` # @return [Google::Apis::IdentitytoolkitV3::EmailTemplate] attr_accessor :verify_email_template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allow_password_user = args[:allow_password_user] if args.key?(:allow_password_user) @api_key = args[:api_key] if args.key?(:api_key) @authorized_domains = args[:authorized_domains] if args.key?(:authorized_domains) @change_email_template = args[:change_email_template] if args.key?(:change_email_template) @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number) @enable_anonymous_user = args[:enable_anonymous_user] if args.key?(:enable_anonymous_user) @idp_config = args[:idp_config] if args.key?(:idp_config) @legacy_reset_password_template = args[:legacy_reset_password_template] if args.key?(:legacy_reset_password_template) @reset_password_template = args[:reset_password_template] if args.key?(:reset_password_template) @use_email_sending = args[:use_email_sending] if args.key?(:use_email_sending) @verify_email_template = args[:verify_email_template] if args.key?(:verify_email_template) end end # Response of setting the project configuration. class IdentitytoolkitRelyingpartySetProjectConfigResponse include Google::Apis::Core::Hashable # Project ID of the relying party. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @project_id = args[:project_id] if args.key?(:project_id) end end # Request to sign out user. class SignOutUserRequest include Google::Apis::Core::Hashable # Instance id token of the app. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id # The local ID of the user. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @instance_id = args[:instance_id] if args.key?(:instance_id) @local_id = args[:local_id] if args.key?(:local_id) end end # Response of signing out user. class SignOutUserResponse include Google::Apis::Core::Hashable # The local ID of the user. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @local_id = args[:local_id] if args.key?(:local_id) end end # Request to signup new user, create anonymous user or anonymous user reauth. class SignupNewUserRequest include Google::Apis::Core::Hashable # The captcha challenge. # Corresponds to the JSON property `captchaChallenge` # @return [String] attr_accessor :captcha_challenge # Response to the captcha. # Corresponds to the JSON property `captchaResponse` # @return [String] attr_accessor :captcha_response # Whether to disable the user. Only can be used by service account. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled alias_method :disabled?, :disabled # The name of the user. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The email of the user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # Mark the email as verified or not. Only can be used by service account. # Corresponds to the JSON property `emailVerified` # @return [Boolean] attr_accessor :email_verified alias_method :email_verified?, :email_verified # The GITKit token of the authenticated user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # Instance id token of the app. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id # Privileged caller can create user with specified user id. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id # The new password of the user. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # Privileged caller can create user with specified phone number. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number # The photo url of the user. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @captcha_challenge = args[:captcha_challenge] if args.key?(:captcha_challenge) @captcha_response = args[:captcha_response] if args.key?(:captcha_response) @disabled = args[:disabled] if args.key?(:disabled) @display_name = args[:display_name] if args.key?(:display_name) @email = args[:email] if args.key?(:email) @email_verified = args[:email_verified] if args.key?(:email_verified) @id_token = args[:id_token] if args.key?(:id_token) @instance_id = args[:instance_id] if args.key?(:instance_id) @local_id = args[:local_id] if args.key?(:local_id) @password = args[:password] if args.key?(:password) @phone_number = args[:phone_number] if args.key?(:phone_number) @photo_url = args[:photo_url] if args.key?(:photo_url) end end # Request to upload user account in batch. class UploadAccountRequest include Google::Apis::Core::Hashable # Whether allow overwrite existing account when user local_id exists. # Corresponds to the JSON property `allowOverwrite` # @return [Boolean] attr_accessor :allow_overwrite alias_method :allow_overwrite?, :allow_overwrite # # Corresponds to the JSON property `blockSize` # @return [Fixnum] attr_accessor :block_size # The following 4 fields are for standard scrypt algorithm. # Corresponds to the JSON property `cpuMemCost` # @return [Fixnum] attr_accessor :cpu_mem_cost # GCP project number of the requesting delegated app. Currently only intended # for Firebase V1 migration. # Corresponds to the JSON property `delegatedProjectNumber` # @return [Fixnum] attr_accessor :delegated_project_number # # Corresponds to the JSON property `dkLen` # @return [Fixnum] attr_accessor :dk_len # The password hash algorithm. # Corresponds to the JSON property `hashAlgorithm` # @return [String] attr_accessor :hash_algorithm # Memory cost for hash calculation. Used by scrypt similar algorithms. # Corresponds to the JSON property `memoryCost` # @return [Fixnum] attr_accessor :memory_cost # # Corresponds to the JSON property `parallelization` # @return [Fixnum] attr_accessor :parallelization # Rounds for hash calculation. Used by scrypt and similar algorithms. # Corresponds to the JSON property `rounds` # @return [Fixnum] attr_accessor :rounds # The salt separator. # Corresponds to the JSON property `saltSeparator` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :salt_separator # If true, backend will do sanity check(including duplicate email and federated # id) when uploading account. # Corresponds to the JSON property `sanityCheck` # @return [Boolean] attr_accessor :sanity_check alias_method :sanity_check?, :sanity_check # The key for to hash the password. # Corresponds to the JSON property `signerKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :signer_key # Specify which project (field value is actually project id) to operate. Only # used when provided credential. # Corresponds to the JSON property `targetProjectId` # @return [String] attr_accessor :target_project_id # The account info to be stored. # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allow_overwrite = args[:allow_overwrite] if args.key?(:allow_overwrite) @block_size = args[:block_size] if args.key?(:block_size) @cpu_mem_cost = args[:cpu_mem_cost] if args.key?(:cpu_mem_cost) @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number) @dk_len = args[:dk_len] if args.key?(:dk_len) @hash_algorithm = args[:hash_algorithm] if args.key?(:hash_algorithm) @memory_cost = args[:memory_cost] if args.key?(:memory_cost) @parallelization = args[:parallelization] if args.key?(:parallelization) @rounds = args[:rounds] if args.key?(:rounds) @salt_separator = args[:salt_separator] if args.key?(:salt_separator) @sanity_check = args[:sanity_check] if args.key?(:sanity_check) @signer_key = args[:signer_key] if args.key?(:signer_key) @target_project_id = args[:target_project_id] if args.key?(:target_project_id) @users = args[:users] if args.key?(:users) end end # Request to verify the IDP assertion. class VerifyAssertionRequest include Google::Apis::Core::Hashable # When it's true, automatically creates a new account if the user doesn't exist. # When it's false, allows existing user to sign in normally and throws exception # if the user doesn't exist. # Corresponds to the JSON property `autoCreate` # @return [Boolean] attr_accessor :auto_create alias_method :auto_create?, :auto_create # GCP project number of the requesting delegated app. Currently only intended # for Firebase V1 migration. # Corresponds to the JSON property `delegatedProjectNumber` # @return [Fixnum] attr_accessor :delegated_project_number # The GITKit token of the authenticated user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # Instance id token of the app. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id # The GITKit token for the non-trusted IDP pending to be confirmed by the user. # Corresponds to the JSON property `pendingIdToken` # @return [String] attr_accessor :pending_id_token # The post body if the request is a HTTP POST. # Corresponds to the JSON property `postBody` # @return [String] attr_accessor :post_body # The URI to which the IDP redirects the user back. It may contain federated # login result params added by the IDP. # Corresponds to the JSON property `requestUri` # @return [String] attr_accessor :request_uri # Whether return 200 and IDP credential rather than throw exception when # federated id is already linked. # Corresponds to the JSON property `returnIdpCredential` # @return [Boolean] attr_accessor :return_idp_credential alias_method :return_idp_credential?, :return_idp_credential # Whether to return refresh tokens. # Corresponds to the JSON property `returnRefreshToken` # @return [Boolean] attr_accessor :return_refresh_token alias_method :return_refresh_token?, :return_refresh_token # Whether return sts id token and refresh token instead of gitkit token. # Corresponds to the JSON property `returnSecureToken` # @return [Boolean] attr_accessor :return_secure_token alias_method :return_secure_token?, :return_secure_token # Session ID, which should match the one in previous createAuthUri request. # 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) @auto_create = args[:auto_create] if args.key?(:auto_create) @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number) @id_token = args[:id_token] if args.key?(:id_token) @instance_id = args[:instance_id] if args.key?(:instance_id) @pending_id_token = args[:pending_id_token] if args.key?(:pending_id_token) @post_body = args[:post_body] if args.key?(:post_body) @request_uri = args[:request_uri] if args.key?(:request_uri) @return_idp_credential = args[:return_idp_credential] if args.key?(:return_idp_credential) @return_refresh_token = args[:return_refresh_token] if args.key?(:return_refresh_token) @return_secure_token = args[:return_secure_token] if args.key?(:return_secure_token) @session_id = args[:session_id] if args.key?(:session_id) end end # Request to verify a custom token class VerifyCustomTokenRequest include Google::Apis::Core::Hashable # GCP project number of the requesting delegated app. Currently only intended # for Firebase V1 migration. # Corresponds to the JSON property `delegatedProjectNumber` # @return [Fixnum] attr_accessor :delegated_project_number # Instance id token of the app. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id # Whether return sts id token and refresh token instead of gitkit token. # Corresponds to the JSON property `returnSecureToken` # @return [Boolean] attr_accessor :return_secure_token alias_method :return_secure_token?, :return_secure_token # The custom token to verify # Corresponds to the JSON property `token` # @return [String] attr_accessor :token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number) @instance_id = args[:instance_id] if args.key?(:instance_id) @return_secure_token = args[:return_secure_token] if args.key?(:return_secure_token) @token = args[:token] if args.key?(:token) end end # Request to verify the password. class VerifyPasswordRequest include Google::Apis::Core::Hashable # The captcha challenge. # Corresponds to the JSON property `captchaChallenge` # @return [String] attr_accessor :captcha_challenge # Response to the captcha. # Corresponds to the JSON property `captchaResponse` # @return [String] attr_accessor :captcha_response # GCP project number of the requesting delegated app. Currently only intended # for Firebase V1 migration. # Corresponds to the JSON property `delegatedProjectNumber` # @return [Fixnum] attr_accessor :delegated_project_number # The email of the user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The GITKit token of the authenticated user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # Instance id token of the app. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id # The password inputed by the user. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # The GITKit token for the non-trusted IDP, which is to be confirmed by the user. # Corresponds to the JSON property `pendingIdToken` # @return [String] attr_accessor :pending_id_token # Whether return sts id token and refresh token instead of gitkit token. # Corresponds to the JSON property `returnSecureToken` # @return [Boolean] attr_accessor :return_secure_token alias_method :return_secure_token?, :return_secure_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @captcha_challenge = args[:captcha_challenge] if args.key?(:captcha_challenge) @captcha_response = args[:captcha_response] if args.key?(:captcha_response) @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number) @email = args[:email] if args.key?(:email) @id_token = args[:id_token] if args.key?(:id_token) @instance_id = args[:instance_id] if args.key?(:instance_id) @password = args[:password] if args.key?(:password) @pending_id_token = args[:pending_id_token] if args.key?(:pending_id_token) @return_secure_token = args[:return_secure_token] if args.key?(:return_secure_token) end end # Request for Identitytoolkit-VerifyPhoneNumber class IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # # Corresponds to the JSON property `operation` # @return [String] attr_accessor :operation # # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number # The session info previously returned by IdentityToolkit-SendVerificationCode. # Corresponds to the JSON property `sessionInfo` # @return [String] attr_accessor :session_info # # Corresponds to the JSON property `temporaryProof` # @return [String] attr_accessor :temporary_proof # # Corresponds to the JSON property `verificationProof` # @return [String] attr_accessor :verification_proof def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @code = args[:code] if args.key?(:code) @id_token = args[:id_token] if args.key?(:id_token) @operation = args[:operation] if args.key?(:operation) @phone_number = args[:phone_number] if args.key?(:phone_number) @session_info = args[:session_info] if args.key?(:session_info) @temporary_proof = args[:temporary_proof] if args.key?(:temporary_proof) @verification_proof = args[:verification_proof] if args.key?(:verification_proof) end end # Response for Identitytoolkit-VerifyPhoneNumber class IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse include Google::Apis::Core::Hashable # # Corresponds to the JSON property `expiresIn` # @return [Fixnum] attr_accessor :expires_in # # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # # Corresponds to the JSON property `isNewUser` # @return [Boolean] attr_accessor :is_new_user alias_method :is_new_user?, :is_new_user # # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id # # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number # # Corresponds to the JSON property `refreshToken` # @return [String] attr_accessor :refresh_token # # Corresponds to the JSON property `temporaryProof` # @return [String] attr_accessor :temporary_proof # # Corresponds to the JSON property `temporaryProofExpiresIn` # @return [Fixnum] attr_accessor :temporary_proof_expires_in # # Corresponds to the JSON property `verificationProof` # @return [String] attr_accessor :verification_proof # # Corresponds to the JSON property `verificationProofExpiresIn` # @return [Fixnum] attr_accessor :verification_proof_expires_in def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expires_in = args[:expires_in] if args.key?(:expires_in) @id_token = args[:id_token] if args.key?(:id_token) @is_new_user = args[:is_new_user] if args.key?(:is_new_user) @local_id = args[:local_id] if args.key?(:local_id) @phone_number = args[:phone_number] if args.key?(:phone_number) @refresh_token = args[:refresh_token] if args.key?(:refresh_token) @temporary_proof = args[:temporary_proof] if args.key?(:temporary_proof) @temporary_proof_expires_in = args[:temporary_proof_expires_in] if args.key?(:temporary_proof_expires_in) @verification_proof = args[:verification_proof] if args.key?(:verification_proof) @verification_proof_expires_in = args[:verification_proof_expires_in] if args.key?(:verification_proof_expires_in) end end # Template for a single idp configuration. class IdpConfig include Google::Apis::Core::Hashable # OAuth2 client ID. # Corresponds to the JSON property `clientId` # @return [String] attr_accessor :client_id # Whether this IDP is enabled. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # Percent of users who will be prompted/redirected federated login for this IDP. # Corresponds to the JSON property `experimentPercent` # @return [Fixnum] attr_accessor :experiment_percent # OAuth2 provider. # Corresponds to the JSON property `provider` # @return [String] attr_accessor :provider # OAuth2 client secret. # Corresponds to the JSON property `secret` # @return [String] attr_accessor :secret # Whitelisted client IDs for audience check. # Corresponds to the JSON property `whitelistedAudiences` # @return [Array] attr_accessor :whitelisted_audiences def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_id = args[:client_id] if args.key?(:client_id) @enabled = args[:enabled] if args.key?(:enabled) @experiment_percent = args[:experiment_percent] if args.key?(:experiment_percent) @provider = args[:provider] if args.key?(:provider) @secret = args[:secret] if args.key?(:secret) @whitelisted_audiences = args[:whitelisted_audiences] if args.key?(:whitelisted_audiences) end end # Request of getting a code for user confirmation (reset password, change email # etc.) class Relyingparty include Google::Apis::Core::Hashable # whether or not to install the android app on the device where the link is # opened # Corresponds to the JSON property `androidInstallApp` # @return [Boolean] attr_accessor :android_install_app alias_method :android_install_app?, :android_install_app # minimum version of the app. if the version on the device is lower than this # version then the user is taken to the play store to upgrade the app # Corresponds to the JSON property `androidMinimumVersion` # @return [String] attr_accessor :android_minimum_version # android package name of the android app to handle the action code # Corresponds to the JSON property `androidPackageName` # @return [String] attr_accessor :android_package_name # whether or not the app can handle the oob code without first going to web # Corresponds to the JSON property `canHandleCodeInApp` # @return [Boolean] attr_accessor :can_handle_code_in_app alias_method :can_handle_code_in_app?, :can_handle_code_in_app # The recaptcha response from the user. # Corresponds to the JSON property `captchaResp` # @return [String] attr_accessor :captcha_resp # The recaptcha challenge presented to the user. # Corresponds to the JSON property `challenge` # @return [String] attr_accessor :challenge # The url to continue to the Gitkit app # Corresponds to the JSON property `continueUrl` # @return [String] attr_accessor :continue_url # The email of the user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # iOS app store id to download the app if it's not already installed # Corresponds to the JSON property `iOSAppStoreId` # @return [String] attr_accessor :i_os_app_store_id # the iOS bundle id of iOS app to handle the action code # Corresponds to the JSON property `iOSBundleId` # @return [String] attr_accessor :i_os_bundle_id # The user's Gitkit login token for email change. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # The fixed string "identitytoolkit#relyingparty". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The new email if the code is for email change. # Corresponds to the JSON property `newEmail` # @return [String] attr_accessor :new_email # The request type. # Corresponds to the JSON property `requestType` # @return [String] attr_accessor :request_type # The IP address of the user. # Corresponds to the JSON property `userIp` # @return [String] attr_accessor :user_ip def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @android_install_app = args[:android_install_app] if args.key?(:android_install_app) @android_minimum_version = args[:android_minimum_version] if args.key?(:android_minimum_version) @android_package_name = args[:android_package_name] if args.key?(:android_package_name) @can_handle_code_in_app = args[:can_handle_code_in_app] if args.key?(:can_handle_code_in_app) @captcha_resp = args[:captcha_resp] if args.key?(:captcha_resp) @challenge = args[:challenge] if args.key?(:challenge) @continue_url = args[:continue_url] if args.key?(:continue_url) @email = args[:email] if args.key?(:email) @i_os_app_store_id = args[:i_os_app_store_id] if args.key?(:i_os_app_store_id) @i_os_bundle_id = args[:i_os_bundle_id] if args.key?(:i_os_bundle_id) @id_token = args[:id_token] if args.key?(:id_token) @kind = args[:kind] if args.key?(:kind) @new_email = args[:new_email] if args.key?(:new_email) @request_type = args[:request_type] if args.key?(:request_type) @user_ip = args[:user_ip] if args.key?(:user_ip) end end # Response of resetting the password. class ResetPasswordResponse include Google::Apis::Core::Hashable # The user's email. If the out-of-band code is for email recovery, the user's # original email. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The fixed string "identitytoolkit#ResetPasswordResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # If the out-of-band code is for email recovery, the user's new email. # Corresponds to the JSON property `newEmail` # @return [String] attr_accessor :new_email # The request type. # Corresponds to the JSON property `requestType` # @return [String] attr_accessor :request_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) @kind = args[:kind] if args.key?(:kind) @new_email = args[:new_email] if args.key?(:new_email) @request_type = args[:request_type] if args.key?(:request_type) end end # Respone of setting the account information. class SetAccountInfoResponse include Google::Apis::Core::Hashable # The name of the user. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The email of the user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # If email has been verified. # Corresponds to the JSON property `emailVerified` # @return [Boolean] attr_accessor :email_verified alias_method :email_verified?, :email_verified # If idToken is STS id token, then this field will be expiration time of STS id # token in seconds. # Corresponds to the JSON property `expiresIn` # @return [Fixnum] attr_accessor :expires_in # The Gitkit id token to login the newly sign up user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # The fixed string "identitytoolkit#SetAccountInfoResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The local ID of the user. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id # The new email the user attempts to change to. # Corresponds to the JSON property `newEmail` # @return [String] attr_accessor :new_email # The user's hashed password. # Corresponds to the JSON property `passwordHash` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :password_hash # The photo url of the user. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url # The user's profiles at the associated IdPs. # Corresponds to the JSON property `providerUserInfo` # @return [Array] attr_accessor :provider_user_info # If idToken is STS id token, then this field will be refresh token. # Corresponds to the JSON property `refreshToken` # @return [String] attr_accessor :refresh_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @email = args[:email] if args.key?(:email) @email_verified = args[:email_verified] if args.key?(:email_verified) @expires_in = args[:expires_in] if args.key?(:expires_in) @id_token = args[:id_token] if args.key?(:id_token) @kind = args[:kind] if args.key?(:kind) @local_id = args[:local_id] if args.key?(:local_id) @new_email = args[:new_email] if args.key?(:new_email) @password_hash = args[:password_hash] if args.key?(:password_hash) @photo_url = args[:photo_url] if args.key?(:photo_url) @provider_user_info = args[:provider_user_info] if args.key?(:provider_user_info) @refresh_token = args[:refresh_token] if args.key?(:refresh_token) end # class ProviderUserInfo include Google::Apis::Core::Hashable # The user's display name at the IDP. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # User's identifier at IDP. # Corresponds to the JSON property `federatedId` # @return [String] attr_accessor :federated_id # The user's photo url at the IDP. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url # The IdP ID. For whitelisted IdPs it's a short domain name, e.g., google.com, # aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier. # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_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) @federated_id = args[:federated_id] if args.key?(:federated_id) @photo_url = args[:photo_url] if args.key?(:photo_url) @provider_id = args[:provider_id] if args.key?(:provider_id) end end end # Response of signing up new user, creating anonymous user or anonymous user # reauth. class SignupNewUserResponse include Google::Apis::Core::Hashable # The name of the user. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The email of the user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # If idToken is STS id token, then this field will be expiration time of STS id # token in seconds. # Corresponds to the JSON property `expiresIn` # @return [Fixnum] attr_accessor :expires_in # The Gitkit id token to login the newly sign up user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # The fixed string "identitytoolkit#SignupNewUserResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The RP local ID of the user. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id # If idToken is STS id token, then this field will be refresh token. # Corresponds to the JSON property `refreshToken` # @return [String] attr_accessor :refresh_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @email = args[:email] if args.key?(:email) @expires_in = args[:expires_in] if args.key?(:expires_in) @id_token = args[:id_token] if args.key?(:id_token) @kind = args[:kind] if args.key?(:kind) @local_id = args[:local_id] if args.key?(:local_id) @refresh_token = args[:refresh_token] if args.key?(:refresh_token) end end # Respone of uploading accounts in batch. class UploadAccountResponse include Google::Apis::Core::Hashable # The error encountered while processing the account info. # Corresponds to the JSON property `error` # @return [Array] attr_accessor :error # The fixed string "identitytoolkit#UploadAccountResponse". # 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) @error = args[:error] if args.key?(:error) @kind = args[:kind] if args.key?(:kind) end # class Error include Google::Apis::Core::Hashable # The index of the malformed account, starting from 0. # Corresponds to the JSON property `index` # @return [Fixnum] attr_accessor :index # Detailed error message for the account info. # 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) @index = args[:index] if args.key?(:index) @message = args[:message] if args.key?(:message) end end end # Template for an individual account info. class UserInfo include Google::Apis::Core::Hashable # User creation timestamp. # Corresponds to the JSON property `createdAt` # @return [Fixnum] attr_accessor :created_at # The custom attributes to be set in the user's id token. # Corresponds to the JSON property `customAttributes` # @return [String] attr_accessor :custom_attributes # Whether the user is authenticated by the developer. # Corresponds to the JSON property `customAuth` # @return [Boolean] attr_accessor :custom_auth alias_method :custom_auth?, :custom_auth # Whether the user is disabled. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled alias_method :disabled?, :disabled # The name of the user. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The email of the user. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # Whether the email has been verified. # Corresponds to the JSON property `emailVerified` # @return [Boolean] attr_accessor :email_verified alias_method :email_verified?, :email_verified # last login timestamp. # Corresponds to the JSON property `lastLoginAt` # @return [Fixnum] attr_accessor :last_login_at # The local ID of the user. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id # The user's hashed password. # Corresponds to the JSON property `passwordHash` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :password_hash # The timestamp when the password was last updated. # Corresponds to the JSON property `passwordUpdatedAt` # @return [Float] attr_accessor :password_updated_at # User's phone number. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number # The URL of the user profile photo. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url # The IDP of the user. # Corresponds to the JSON property `providerUserInfo` # @return [Array] attr_accessor :provider_user_info # The user's plain text password. # Corresponds to the JSON property `rawPassword` # @return [String] attr_accessor :raw_password # The user's password salt. # Corresponds to the JSON property `salt` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :salt # User's screen name at Twitter or login name at Github. # Corresponds to the JSON property `screenName` # @return [String] attr_accessor :screen_name # Timestamp in seconds for valid login token. # Corresponds to the JSON property `validSince` # @return [Fixnum] attr_accessor :valid_since # Version of the user's password. # 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) @created_at = args[:created_at] if args.key?(:created_at) @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes) @custom_auth = args[:custom_auth] if args.key?(:custom_auth) @disabled = args[:disabled] if args.key?(:disabled) @display_name = args[:display_name] if args.key?(:display_name) @email = args[:email] if args.key?(:email) @email_verified = args[:email_verified] if args.key?(:email_verified) @last_login_at = args[:last_login_at] if args.key?(:last_login_at) @local_id = args[:local_id] if args.key?(:local_id) @password_hash = args[:password_hash] if args.key?(:password_hash) @password_updated_at = args[:password_updated_at] if args.key?(:password_updated_at) @phone_number = args[:phone_number] if args.key?(:phone_number) @photo_url = args[:photo_url] if args.key?(:photo_url) @provider_user_info = args[:provider_user_info] if args.key?(:provider_user_info) @raw_password = args[:raw_password] if args.key?(:raw_password) @salt = args[:salt] if args.key?(:salt) @screen_name = args[:screen_name] if args.key?(:screen_name) @valid_since = args[:valid_since] if args.key?(:valid_since) @version = args[:version] if args.key?(:version) end # class ProviderUserInfo include Google::Apis::Core::Hashable # The user's display name at the IDP. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # User's email at IDP. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # User's identifier at IDP. # Corresponds to the JSON property `federatedId` # @return [String] attr_accessor :federated_id # User's phone number. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number # The user's photo url at the IDP. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, # aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier. # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id # User's raw identifier directly returned from IDP. # Corresponds to the JSON property `rawId` # @return [String] attr_accessor :raw_id # User's screen name at Twitter or login name at Github. # Corresponds to the JSON property `screenName` # @return [String] attr_accessor :screen_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) @email = args[:email] if args.key?(:email) @federated_id = args[:federated_id] if args.key?(:federated_id) @phone_number = args[:phone_number] if args.key?(:phone_number) @photo_url = args[:photo_url] if args.key?(:photo_url) @provider_id = args[:provider_id] if args.key?(:provider_id) @raw_id = args[:raw_id] if args.key?(:raw_id) @screen_name = args[:screen_name] if args.key?(:screen_name) end end end # Response of verifying the IDP assertion. class VerifyAssertionResponse include Google::Apis::Core::Hashable # The action code. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # URL for OTA app installation. # Corresponds to the JSON property `appInstallationUrl` # @return [String] attr_accessor :app_installation_url # The custom scheme used by mobile app. # Corresponds to the JSON property `appScheme` # @return [String] attr_accessor :app_scheme # The opaque value used by the client to maintain context info between the # authentication request and the IDP callback. # Corresponds to the JSON property `context` # @return [String] attr_accessor :context # The birth date of the IdP account. # Corresponds to the JSON property `dateOfBirth` # @return [String] attr_accessor :date_of_birth # The display name of the user. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The email returned by the IdP. NOTE: The federated login user may not own the # email. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # It's true if the email is recycled. # Corresponds to the JSON property `emailRecycled` # @return [Boolean] attr_accessor :email_recycled alias_method :email_recycled?, :email_recycled # The value is true if the IDP is also the email provider. It means the user # owns the email. # Corresponds to the JSON property `emailVerified` # @return [Boolean] attr_accessor :email_verified alias_method :email_verified?, :email_verified # Client error code. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message # If idToken is STS id token, then this field will be expiration time of STS id # token in seconds. # Corresponds to the JSON property `expiresIn` # @return [Fixnum] attr_accessor :expires_in # The unique ID identifies the IdP account. # Corresponds to the JSON property `federatedId` # @return [String] attr_accessor :federated_id # The first name of the user. # Corresponds to the JSON property `firstName` # @return [String] attr_accessor :first_name # The full name of the user. # Corresponds to the JSON property `fullName` # @return [String] attr_accessor :full_name # The ID token. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # It's the identifier param in the createAuthUri request if the identifier is an # email. It can be used to check whether the user input email is different from # the asserted email. # Corresponds to the JSON property `inputEmail` # @return [String] attr_accessor :input_email # True if it's a new user sign-in, false if it's a returning user. # Corresponds to the JSON property `isNewUser` # @return [Boolean] attr_accessor :is_new_user alias_method :is_new_user?, :is_new_user # The fixed string "identitytoolkit#VerifyAssertionResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The language preference of the user. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # The last name of the user. # Corresponds to the JSON property `lastName` # @return [String] attr_accessor :last_name # The RP local ID if it's already been mapped to the IdP account identified by # the federated ID. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id # Whether the assertion is from a non-trusted IDP and need account linking # confirmation. # Corresponds to the JSON property `needConfirmation` # @return [Boolean] attr_accessor :need_confirmation alias_method :need_confirmation?, :need_confirmation # Whether need client to supply email to complete the federated login flow. # Corresponds to the JSON property `needEmail` # @return [Boolean] attr_accessor :need_email alias_method :need_email?, :need_email # The nick name of the user. # Corresponds to the JSON property `nickName` # @return [String] attr_accessor :nick_name # The OAuth2 access token. # Corresponds to the JSON property `oauthAccessToken` # @return [String] attr_accessor :oauth_access_token # The OAuth2 authorization code. # Corresponds to the JSON property `oauthAuthorizationCode` # @return [String] attr_accessor :oauth_authorization_code # The lifetime in seconds of the OAuth2 access token. # Corresponds to the JSON property `oauthExpireIn` # @return [Fixnum] attr_accessor :oauth_expire_in # The OIDC id token. # Corresponds to the JSON property `oauthIdToken` # @return [String] attr_accessor :oauth_id_token # The user approved request token for the OpenID OAuth extension. # Corresponds to the JSON property `oauthRequestToken` # @return [String] attr_accessor :oauth_request_token # The scope for the OpenID OAuth extension. # Corresponds to the JSON property `oauthScope` # @return [String] attr_accessor :oauth_scope # The OAuth1 access token secret. # Corresponds to the JSON property `oauthTokenSecret` # @return [String] attr_accessor :oauth_token_secret # The original email stored in the mapping storage. It's returned when the # federated ID is associated to a different email. # Corresponds to the JSON property `originalEmail` # @return [String] attr_accessor :original_email # The URI of the public accessible profiel picture. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url # The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, # aol.com, live.net and yahoo.com. If the "providerId" param is set to OpenID OP # identifer other than the whilte listed IdPs the OP identifier is returned. If # the "identifier" param is federated ID in the createAuthUri request. The # domain part of the federated ID is returned. # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id # Raw IDP-returned user info. # Corresponds to the JSON property `rawUserInfo` # @return [String] attr_accessor :raw_user_info # If idToken is STS id token, then this field will be refresh token. # Corresponds to the JSON property `refreshToken` # @return [String] attr_accessor :refresh_token # The screen_name of a Twitter user or the login name at Github. # Corresponds to the JSON property `screenName` # @return [String] attr_accessor :screen_name # The timezone of the user. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone # When action is 'map', contains the idps which can be used for confirmation. # Corresponds to the JSON property `verifiedProvider` # @return [Array] attr_accessor :verified_provider def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) @app_installation_url = args[:app_installation_url] if args.key?(:app_installation_url) @app_scheme = args[:app_scheme] if args.key?(:app_scheme) @context = args[:context] if args.key?(:context) @date_of_birth = args[:date_of_birth] if args.key?(:date_of_birth) @display_name = args[:display_name] if args.key?(:display_name) @email = args[:email] if args.key?(:email) @email_recycled = args[:email_recycled] if args.key?(:email_recycled) @email_verified = args[:email_verified] if args.key?(:email_verified) @error_message = args[:error_message] if args.key?(:error_message) @expires_in = args[:expires_in] if args.key?(:expires_in) @federated_id = args[:federated_id] if args.key?(:federated_id) @first_name = args[:first_name] if args.key?(:first_name) @full_name = args[:full_name] if args.key?(:full_name) @id_token = args[:id_token] if args.key?(:id_token) @input_email = args[:input_email] if args.key?(:input_email) @is_new_user = args[:is_new_user] if args.key?(:is_new_user) @kind = args[:kind] if args.key?(:kind) @language = args[:language] if args.key?(:language) @last_name = args[:last_name] if args.key?(:last_name) @local_id = args[:local_id] if args.key?(:local_id) @need_confirmation = args[:need_confirmation] if args.key?(:need_confirmation) @need_email = args[:need_email] if args.key?(:need_email) @nick_name = args[:nick_name] if args.key?(:nick_name) @oauth_access_token = args[:oauth_access_token] if args.key?(:oauth_access_token) @oauth_authorization_code = args[:oauth_authorization_code] if args.key?(:oauth_authorization_code) @oauth_expire_in = args[:oauth_expire_in] if args.key?(:oauth_expire_in) @oauth_id_token = args[:oauth_id_token] if args.key?(:oauth_id_token) @oauth_request_token = args[:oauth_request_token] if args.key?(:oauth_request_token) @oauth_scope = args[:oauth_scope] if args.key?(:oauth_scope) @oauth_token_secret = args[:oauth_token_secret] if args.key?(:oauth_token_secret) @original_email = args[:original_email] if args.key?(:original_email) @photo_url = args[:photo_url] if args.key?(:photo_url) @provider_id = args[:provider_id] if args.key?(:provider_id) @raw_user_info = args[:raw_user_info] if args.key?(:raw_user_info) @refresh_token = args[:refresh_token] if args.key?(:refresh_token) @screen_name = args[:screen_name] if args.key?(:screen_name) @time_zone = args[:time_zone] if args.key?(:time_zone) @verified_provider = args[:verified_provider] if args.key?(:verified_provider) end end # Response from verifying a custom token class VerifyCustomTokenResponse include Google::Apis::Core::Hashable # If idToken is STS id token, then this field will be expiration time of STS id # token in seconds. # Corresponds to the JSON property `expiresIn` # @return [Fixnum] attr_accessor :expires_in # The GITKit token for authenticated user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # True if it's a new user sign-in, false if it's a returning user. # Corresponds to the JSON property `isNewUser` # @return [Boolean] attr_accessor :is_new_user alias_method :is_new_user?, :is_new_user # The fixed string "identitytoolkit#VerifyCustomTokenResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # If idToken is STS id token, then this field will be refresh token. # Corresponds to the JSON property `refreshToken` # @return [String] attr_accessor :refresh_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expires_in = args[:expires_in] if args.key?(:expires_in) @id_token = args[:id_token] if args.key?(:id_token) @is_new_user = args[:is_new_user] if args.key?(:is_new_user) @kind = args[:kind] if args.key?(:kind) @refresh_token = args[:refresh_token] if args.key?(:refresh_token) end end # Request of verifying the password. class VerifyPasswordResponse include Google::Apis::Core::Hashable # The name of the user. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The email returned by the IdP. NOTE: The federated login user may not own the # email. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # If idToken is STS id token, then this field will be expiration time of STS id # token in seconds. # Corresponds to the JSON property `expiresIn` # @return [Fixnum] attr_accessor :expires_in # The GITKit token for authenticated user. # Corresponds to the JSON property `idToken` # @return [String] attr_accessor :id_token # The fixed string "identitytoolkit#VerifyPasswordResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The RP local ID if it's already been mapped to the IdP account identified by # the federated ID. # Corresponds to the JSON property `localId` # @return [String] attr_accessor :local_id # The OAuth2 access token. # Corresponds to the JSON property `oauthAccessToken` # @return [String] attr_accessor :oauth_access_token # The OAuth2 authorization code. # Corresponds to the JSON property `oauthAuthorizationCode` # @return [String] attr_accessor :oauth_authorization_code # The lifetime in seconds of the OAuth2 access token. # Corresponds to the JSON property `oauthExpireIn` # @return [Fixnum] attr_accessor :oauth_expire_in # The URI of the user's photo at IdP # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url # If idToken is STS id token, then this field will be refresh token. # Corresponds to the JSON property `refreshToken` # @return [String] attr_accessor :refresh_token # Whether the email is registered. # Corresponds to the JSON property `registered` # @return [Boolean] attr_accessor :registered alias_method :registered?, :registered def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @email = args[:email] if args.key?(:email) @expires_in = args[:expires_in] if args.key?(:expires_in) @id_token = args[:id_token] if args.key?(:id_token) @kind = args[:kind] if args.key?(:kind) @local_id = args[:local_id] if args.key?(:local_id) @oauth_access_token = args[:oauth_access_token] if args.key?(:oauth_access_token) @oauth_authorization_code = args[:oauth_authorization_code] if args.key?(:oauth_authorization_code) @oauth_expire_in = args[:oauth_expire_in] if args.key?(:oauth_expire_in) @photo_url = args[:photo_url] if args.key?(:photo_url) @refresh_token = args[:refresh_token] if args.key?(:refresh_token) @registered = args[:registered] if args.key?(:registered) end end end end end google-api-client-0.19.8/generated/google/apis/identitytoolkit_v3/service.rb0000644000004100000410000013676213252673043027166 0ustar www-datawww-data# 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 IdentitytoolkitV3 # Google Identity Toolkit API # # Help the third party sites to implement federated login. # # @example # require 'google/apis/identitytoolkit_v3' # # Identitytoolkit = Google::Apis::IdentitytoolkitV3 # Alias the module # service = Identitytoolkit::IdentityToolkitService.new # # @see https://developers.google.com/identity-toolkit/v3/ class IdentityToolkitService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'identitytoolkit/v3/relyingparty/') @batch_path = 'batch/identitytoolkit/v3' end # Creates the URI used by the IdP to authenticate the user. # @param [Google::Apis::IdentitytoolkitV3::CreateAuthUriRequest] create_auth_uri_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_auth_uri(create_auth_uri_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'createAuthUri', options) command.request_representation = Google::Apis::IdentitytoolkitV3::CreateAuthUriRequest::Representation command.request_object = create_auth_uri_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse 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 user account. # @param [Google::Apis::IdentitytoolkitV3::DeleteAccountRequest] delete_account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::DeleteAccountResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::DeleteAccountResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(delete_account_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'deleteAccount', options) command.request_representation = Google::Apis::IdentitytoolkitV3::DeleteAccountRequest::Representation command.request_object = delete_account_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::DeleteAccountResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::DeleteAccountResponse 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 # Batch download user accounts. # @param [Google::Apis::IdentitytoolkitV3::DownloadAccountRequest] download_account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::DownloadAccountResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::DownloadAccountResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def download_account(download_account_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'downloadAccount', options) command.request_representation = Google::Apis::IdentitytoolkitV3::DownloadAccountRequest::Representation command.request_object = download_account_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::DownloadAccountResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::DownloadAccountResponse 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 # Reset password for a user. # @param [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyEmailLinkSigninRequest] identitytoolkit_relyingparty_email_link_signin_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def email_relyingparty_link_signin(identitytoolkit_relyingparty_email_link_signin_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'emailLinkSignin', options) command.request_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyEmailLinkSigninRequest::Representation command.request_object = identitytoolkit_relyingparty_email_link_signin_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse 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 account info. # @param [Google::Apis::IdentitytoolkitV3::GetAccountInfoRequest] get_account_info_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_info(get_account_info_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'getAccountInfo', options) command.request_representation = Google::Apis::IdentitytoolkitV3::GetAccountInfoRequest::Representation command.request_object = get_account_info_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::GetAccountInfoResponse 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 # Get a code for user action confirmation. # @param [Google::Apis::IdentitytoolkitV3::Relyingparty] relyingparty_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_oob_confirmation_code(relyingparty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'getOobConfirmationCode', options) command.request_representation = Google::Apis::IdentitytoolkitV3::Relyingparty::Representation command.request_object = relyingparty_object command.response_representation = Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::GetOobConfirmationCodeResponse 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 # Get project configuration. # @param [String] delegated_project_number # Delegated GCP project number of the request. # @param [String] project_number # GCP project number of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_config(delegated_project_number: nil, project_number: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'getProjectConfig', options) command.response_representation = Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::GetProjectConfigResponse command.query['delegatedProjectNumber'] = delegated_project_number unless delegated_project_number.nil? command.query['projectNumber'] = project_number unless project_number.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 # Get token signing public 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Hash] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Hash] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_public_keys(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'publicKeys', options) command.response_representation = Hash::Representation command.response_class = Hash 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 # Get recaptcha secure param. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_recaptcha_param(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'getRecaptchaParam', options) command.response_representation = Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::GetRecaptchaParamResponse 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 # Reset password for a user. # @param [Google::Apis::IdentitytoolkitV3::ResetPasswordRequest] reset_password_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::ResetPasswordResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::ResetPasswordResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def reset_password(reset_password_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'resetPassword', options) command.request_representation = Google::Apis::IdentitytoolkitV3::ResetPasswordRequest::Representation command.request_object = reset_password_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::ResetPasswordResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::ResetPasswordResponse 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 # Send SMS verification code. # @param [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeRequest] identitytoolkit_relyingparty_send_verification_code_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def send_relyingparty_verification_code(identitytoolkit_relyingparty_send_verification_code_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'sendVerificationCode', options) command.request_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeRequest::Representation command.request_object = identitytoolkit_relyingparty_send_verification_code_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySendVerificationCodeResponse 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 # Set account info for a user. # @param [Google::Apis::IdentitytoolkitV3::SetAccountInfoRequest] set_account_info_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_info(set_account_info_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'setAccountInfo', options) command.request_representation = Google::Apis::IdentitytoolkitV3::SetAccountInfoRequest::Representation command.request_object = set_account_info_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::SetAccountInfoResponse 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 # Set project configuration. # @param [Google::Apis::IdentitytoolkitV3::SetProjectConfigRequest] set_project_config_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_relyingparty_project_config(set_project_config_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'setProjectConfig', options) command.request_representation = Google::Apis::IdentitytoolkitV3::SetProjectConfigRequest::Representation command.request_object = set_project_config_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartySetProjectConfigResponse 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 # Sign out user. # @param [Google::Apis::IdentitytoolkitV3::SignOutUserRequest] sign_out_user_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::SignOutUserResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::SignOutUserResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def sign_out_user(sign_out_user_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'signOutUser', options) command.request_representation = Google::Apis::IdentitytoolkitV3::SignOutUserRequest::Representation command.request_object = sign_out_user_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::SignOutUserResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::SignOutUserResponse 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 # Signup new user. # @param [Google::Apis::IdentitytoolkitV3::SignupNewUserRequest] signup_new_user_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::SignupNewUserResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::SignupNewUserResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def signup_new_user(signup_new_user_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'signupNewUser', options) command.request_representation = Google::Apis::IdentitytoolkitV3::SignupNewUserRequest::Representation command.request_object = signup_new_user_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::SignupNewUserResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::SignupNewUserResponse 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 # Batch upload existing user accounts. # @param [Google::Apis::IdentitytoolkitV3::UploadAccountRequest] upload_account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::UploadAccountResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::UploadAccountResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(upload_account_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'uploadAccount', options) command.request_representation = Google::Apis::IdentitytoolkitV3::UploadAccountRequest::Representation command.request_object = upload_account_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::UploadAccountResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::UploadAccountResponse 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 # Verifies the assertion returned by the IdP. # @param [Google::Apis::IdentitytoolkitV3::VerifyAssertionRequest] verify_assertion_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def verify_assertion(verify_assertion_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'verifyAssertion', options) command.request_representation = Google::Apis::IdentitytoolkitV3::VerifyAssertionRequest::Representation command.request_object = verify_assertion_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse 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 # Verifies the developer asserted ID token. # @param [Google::Apis::IdentitytoolkitV3::VerifyCustomTokenRequest] verify_custom_token_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def verify_custom_token(verify_custom_token_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'verifyCustomToken', options) command.request_representation = Google::Apis::IdentitytoolkitV3::VerifyCustomTokenRequest::Representation command.request_object = verify_custom_token_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::VerifyCustomTokenResponse 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 # Verifies the user entered password. # @param [Google::Apis::IdentitytoolkitV3::VerifyPasswordRequest] verify_password_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def verify_password(verify_password_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'verifyPassword', options) command.request_representation = Google::Apis::IdentitytoolkitV3::VerifyPasswordRequest::Representation command.request_object = verify_password_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::VerifyPasswordResponse 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 # Verifies ownership of a phone number and creates/updates the user account # accordingly. # @param [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest] identitytoolkit_relyingparty_verify_phone_number_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def verify_relyingparty_phone_number(identitytoolkit_relyingparty_verify_phone_number_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'verifyPhoneNumber', options) command.request_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest::Representation command.request_object = identitytoolkit_relyingparty_verify_phone_number_request_object command.response_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse::Representation command.response_class = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse 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 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 end end google-api-client-0.19.8/generated/google/apis/firebaseremoteconfig_v1/0000755000004100000410000000000013252673043026103 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/firebaseremoteconfig_v1/representations.rb0000644000004100000410000000647613252673043031672 0ustar www-datawww-data# 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 FirebaseremoteconfigV1 class RemoteConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemoteConfigCondition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemoteConfigParameter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemoteConfigParameterValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemoteConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :conditions, as: 'conditions', class: Google::Apis::FirebaseremoteconfigV1::RemoteConfigCondition, decorator: Google::Apis::FirebaseremoteconfigV1::RemoteConfigCondition::Representation hash :parameters, as: 'parameters', class: Google::Apis::FirebaseremoteconfigV1::RemoteConfigParameter, decorator: Google::Apis::FirebaseremoteconfigV1::RemoteConfigParameter::Representation end end class RemoteConfigCondition # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :expression, as: 'expression' property :name, as: 'name' property :tag_color, as: 'tagColor' end end class RemoteConfigParameter # @private class Representation < Google::Apis::Core::JsonRepresentation hash :conditional_values, as: 'conditionalValues', class: Google::Apis::FirebaseremoteconfigV1::RemoteConfigParameterValue, decorator: Google::Apis::FirebaseremoteconfigV1::RemoteConfigParameterValue::Representation property :default_value, as: 'defaultValue', class: Google::Apis::FirebaseremoteconfigV1::RemoteConfigParameterValue, decorator: Google::Apis::FirebaseremoteconfigV1::RemoteConfigParameterValue::Representation property :description, as: 'description' end end class RemoteConfigParameterValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :use_in_app_default, as: 'useInAppDefault' property :value, as: 'value' end end end end end google-api-client-0.19.8/generated/google/apis/firebaseremoteconfig_v1/classes.rb0000644000004100000410000002200113252673043030060 0ustar www-datawww-data# 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 FirebaseremoteconfigV1 # * # The RemoteConfig consists of a list of conditions (which can be # thought of as named "if" statements) and a map of parameters (parameter key # to a structure containing an optional default value, as well as a optional # submap of (condition name to value when that condition is true). class RemoteConfig include Google::Apis::Core::Hashable # The list of named conditions. The order *does* affect the semantics. # The condition_name values of these entries must be unique. # The resolved value of a config parameter P is determined as follow: # * Let Y be the set of values from the submap of P that refer to conditions # that evaluate to true. # * If Y is non empty, the value is taken from the specific submap in Y whose # condition_name is the earliest in this condition list. # * Else, if P has a default value option (condition_name is empty) then # the value is taken from that option. # * Else, parameter P has no value and is omitted from the config result. # Example: parameter key "p1", default value "v1", submap specified as # `"c1": v2, "c2": v3` where "c1" and "c2" are names of conditions in the # condition list (where "c1" in this example appears before "c2"). The # value of p1 would be v2 as long as c1 is true. Otherwise, if c2 is true, # p1 would evaluate to v3, and if c1 and c2 are both false, p1 would evaluate # to v1. If no default value was specified, and c1 and c2 were both false, # no value for p1 would be generated. # Corresponds to the JSON property `conditions` # @return [Array] attr_accessor :conditions # Map of parameter keys to their optional default values and optional submap # of (condition name : value). Order doesn't affect semantics, and so is # sorted by the server. The 'key' values of the params must be unique. # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @conditions = args[:conditions] if args.key?(:conditions) @parameters = args[:parameters] if args.key?(:parameters) end end # A single RemoteConfig Condition. A list of these (because order matters) are # part of a single RemoteConfig template. class RemoteConfigCondition include Google::Apis::Core::Hashable # DO NOT USE. Implementation removed and will not be added unless requested. # A description for this Condition. Length must be less than or equal to # 100 characters (or more precisely, unicode code points, which is defined in # java/com/google/wireless/android/config/ConstsExporter.java). # A description may contain any Unicode characters # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Required. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression # Required. # A non empty and unique name of this condition. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. # The display (tag) color of this condition. This serves as part of a tag # (in the future, we may add tag text as well as tag color, but that is not # yet implemented in the UI). # This value has no affect on the semantics of the delivered config and it # is ignored by the backend, except for passing it through write/read # requests. # Not having this value or having the "CONDITION_DISPLAY_COLOR_UNSPECIFIED" # value (0) have the same meaning: Let the UI choose any valid color when # displaying the condition. # Corresponds to the JSON property `tagColor` # @return [String] attr_accessor :tag_color 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) @name = args[:name] if args.key?(:name) @tag_color = args[:tag_color] if args.key?(:tag_color) end end # While default_value and conditional_values are each optional, at least one of # the two is required - otherwise, the parameter is meaningless (and an # exception will be thrown by the validation logic). class RemoteConfigParameter include Google::Apis::Core::Hashable # Optional - a map of (condition_name, value). The condition_name of the # highest priority (the one listed first in the conditions array) determines # the value of this parameter. # Corresponds to the JSON property `conditionalValues` # @return [Hash] attr_accessor :conditional_values # A RemoteConfigParameter's "value" (either the default value, or the value # associated with a condition name) is either a string, or the # "use_in_app_default" indicator (which means to leave out the parameter from # the returned map that is the output of the parameter fetch). # We represent the "use_in_app_default" as a bool, but (when using the boolean # instead of the string) it should always be true. # Corresponds to the JSON property `defaultValue` # @return [Google::Apis::FirebaseremoteconfigV1::RemoteConfigParameterValue] attr_accessor :default_value # Optional. # A description for this Parameter. Length must be less than or equal to # 100 characters (or more precisely, unicode code points, which is defined in # java/com/google/wireless/android/config/ConstsExporter.java). # A description may contain any Unicode 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) @conditional_values = args[:conditional_values] if args.key?(:conditional_values) @default_value = args[:default_value] if args.key?(:default_value) @description = args[:description] if args.key?(:description) end end # A RemoteConfigParameter's "value" (either the default value, or the value # associated with a condition name) is either a string, or the # "use_in_app_default" indicator (which means to leave out the parameter from # the returned map that is the output of the parameter fetch). # We represent the "use_in_app_default" as a bool, but (when using the boolean # instead of the string) it should always be true. class RemoteConfigParameterValue include Google::Apis::Core::Hashable # if true, omit the parameter from the map of fetched parameter values # Corresponds to the JSON property `useInAppDefault` # @return [Boolean] attr_accessor :use_in_app_default alias_method :use_in_app_default?, :use_in_app_default # the string to set the parameter to # 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) @use_in_app_default = args[:use_in_app_default] if args.key?(:use_in_app_default) @value = args[:value] if args.key?(:value) end end end end end google-api-client-0.19.8/generated/google/apis/firebaseremoteconfig_v1/service.rb0000644000004100000410000002022613252673043030072 0ustar www-datawww-data# 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 FirebaseremoteconfigV1 # Firebase Remote Config API # # Firebase Remote Config API allows the 3P clients to manage Remote Config # conditions and parameters for Firebase applications. # # @example # require 'google/apis/firebaseremoteconfig_v1' # # Firebaseremoteconfig = Google::Apis::FirebaseremoteconfigV1 # Alias the module # service = Firebaseremoteconfig::FirebaseRemoteConfigService.new # # @see https://firebase.google.com/docs/remote-config/ class FirebaseRemoteConfigService < 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://firebaseremoteconfig.googleapis.com/', '') @batch_path = 'batch' end # Get the latest version Remote Configuration for a project. # Returns the RemoteConfig as the payload, and also the eTag as a # response header. # @param [String] project # The GMP project identifier. Required. # See note at the beginning of this file regarding project ids. # @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::FirebaseremoteconfigV1::RemoteConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::FirebaseremoteconfigV1::RemoteConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remote_config(project, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+project}/remoteConfig', options) command.response_representation = Google::Apis::FirebaseremoteconfigV1::RemoteConfig::Representation command.response_class = Google::Apis::FirebaseremoteconfigV1::RemoteConfig command.params['project'] = project unless project.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 a RemoteConfig. We treat this as an always-existing # resource (when it is not found in our data store, we treat it as version # 0, a template with zero conditions and zero parameters). Hence there are # no Create or Delete operations. Returns the updated template when # successful (and the updated eTag as a response header), or an error if # things go wrong. # Possible error messages: # * VALIDATION_ERROR (HTTP status 400) with additional details if the # template being passed in can not be validated. # * AUTHENTICATION_ERROR (HTTP status 401) if the request can not be # authenticate (e.g. no access token, or invalid access token). # * AUTHORIZATION_ERROR (HTTP status 403) if the request can not be # authorized (e.g. the user has no access to the specified project id). # * VERSION_MISMATCH (HTTP status 412) when trying to update when the # expected eTag (passed in via the "If-match" header) is not specified, or # is specified but does does not match the current eTag. # * Internal error (HTTP status 500) for Database problems or other internal # errors. # @param [String] project # The GMP project identifier. Required. # See note at the beginning of this file regarding project ids. # @param [Google::Apis::FirebaseremoteconfigV1::RemoteConfig] remote_config_object # @param [Boolean] validate_only # Optional. Defaults to false (UpdateRemoteConfig call should # update the backend if there are no validation/interal errors). May be set # to true to indicate that, should no validation errors occur, # the call should return a "200 OK" instead of performing the update. Note # that other error messages (500 Internal Error, 412 Version Mismatch, etc) # may still result after flipping to false, even if getting a # "200 OK" when calling with true. # @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::FirebaseremoteconfigV1::RemoteConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::FirebaseremoteconfigV1::RemoteConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_remote_config(project, remote_config_object = nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/{+project}/remoteConfig', options) command.request_representation = Google::Apis::FirebaseremoteconfigV1::RemoteConfig::Representation command.request_object = remote_config_object command.response_representation = Google::Apis::FirebaseremoteconfigV1::RemoteConfig::Representation command.response_class = Google::Apis::FirebaseremoteconfigV1::RemoteConfig command.params['project'] = project unless project.nil? command.query['validateOnly'] = validate_only unless validate_only.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 google-api-client-0.19.8/generated/google/apis/testing_v1.rb0000644000004100000410000000251013252673044023722 0ustar www-datawww-data# 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/testing_v1/service.rb' require 'google/apis/testing_v1/classes.rb' require 'google/apis/testing_v1/representations.rb' module Google module Apis # Google Cloud Testing API # # Allows developers to run automated tests for their mobile applications on # Google infrastructure. # # @see https://developers.google.com/cloud-test-lab/ module TestingV1 VERSION = 'V1' REVISION = '20180208' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' end end end google-api-client-0.19.8/generated/google/apis/oauth2_v2.rb0000644000004100000410000000271013252673044023452 0ustar www-datawww-data# 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/oauth2_v2/service.rb' require 'google/apis/oauth2_v2/classes.rb' require 'google/apis/oauth2_v2/representations.rb' module Google module Apis # Google OAuth2 API # # Obtains end-user authorization grants for use with other Google APIs. # # @see https://developers.google.com/accounts/docs/OAuth2 module Oauth2V2 VERSION = 'V2' REVISION = '20170807' # Know the list of people in your circles, your age range, and language AUTH_PLUS_LOGIN = 'https://www.googleapis.com/auth/plus.login' # Know who you are on Google AUTH_PLUS_ME = 'https://www.googleapis.com/auth/plus.me' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' # View your basic profile info AUTH_USERINFO_PROFILE = 'https://www.googleapis.com/auth/userinfo.profile' end end end google-api-client-0.19.8/generated/google/apis/language_v1beta1/0000755000004100000410000000000013252673044024422 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/language_v1beta1/representations.rb0000644000004100000410000003036613252673044030204 0ustar www-datawww-data# 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 LanguageV1beta1 class AnalyzeEntitiesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeEntitiesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeSentimentRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeSentimentResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeSyntaxRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeSyntaxResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnnotateTextRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnnotateTextResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DependencyEdge class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Document class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Entity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EntityMention class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Features class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PartOfSpeech class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Sentence class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Sentiment 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 TextSpan class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Token class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AnalyzeEntitiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation property :encoding_type, as: 'encodingType' end end class AnalyzeEntitiesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entities, as: 'entities', class: Google::Apis::LanguageV1beta1::Entity, decorator: Google::Apis::LanguageV1beta1::Entity::Representation property :language, as: 'language' end end class AnalyzeSentimentRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation property :encoding_type, as: 'encodingType' end end class AnalyzeSentimentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :document_sentiment, as: 'documentSentiment', class: Google::Apis::LanguageV1beta1::Sentiment, decorator: Google::Apis::LanguageV1beta1::Sentiment::Representation property :language, as: 'language' collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta1::Sentence, decorator: Google::Apis::LanguageV1beta1::Sentence::Representation end end class AnalyzeSyntaxRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation property :encoding_type, as: 'encodingType' end end class AnalyzeSyntaxResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :language, as: 'language' collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta1::Sentence, decorator: Google::Apis::LanguageV1beta1::Sentence::Representation collection :tokens, as: 'tokens', class: Google::Apis::LanguageV1beta1::Token, decorator: Google::Apis::LanguageV1beta1::Token::Representation end end class AnnotateTextRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation property :encoding_type, as: 'encodingType' property :features, as: 'features', class: Google::Apis::LanguageV1beta1::Features, decorator: Google::Apis::LanguageV1beta1::Features::Representation end end class AnnotateTextResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :document_sentiment, as: 'documentSentiment', class: Google::Apis::LanguageV1beta1::Sentiment, decorator: Google::Apis::LanguageV1beta1::Sentiment::Representation collection :entities, as: 'entities', class: Google::Apis::LanguageV1beta1::Entity, decorator: Google::Apis::LanguageV1beta1::Entity::Representation property :language, as: 'language' collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta1::Sentence, decorator: Google::Apis::LanguageV1beta1::Sentence::Representation collection :tokens, as: 'tokens', class: Google::Apis::LanguageV1beta1::Token, decorator: Google::Apis::LanguageV1beta1::Token::Representation end end class DependencyEdge # @private class Representation < Google::Apis::Core::JsonRepresentation property :head_token_index, as: 'headTokenIndex' property :label, as: 'label' end end class Document # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :gcs_content_uri, as: 'gcsContentUri' property :language, as: 'language' property :type, as: 'type' end end class Entity # @private class Representation < Google::Apis::Core::JsonRepresentation collection :mentions, as: 'mentions', class: Google::Apis::LanguageV1beta1::EntityMention, decorator: Google::Apis::LanguageV1beta1::EntityMention::Representation hash :metadata, as: 'metadata' property :name, as: 'name' property :salience, as: 'salience' property :type, as: 'type' end end class EntityMention # @private class Representation < Google::Apis::Core::JsonRepresentation property :text, as: 'text', class: Google::Apis::LanguageV1beta1::TextSpan, decorator: Google::Apis::LanguageV1beta1::TextSpan::Representation property :type, as: 'type' end end class Features # @private class Representation < Google::Apis::Core::JsonRepresentation property :extract_document_sentiment, as: 'extractDocumentSentiment' property :extract_entities, as: 'extractEntities' property :extract_syntax, as: 'extractSyntax' end end class PartOfSpeech # @private class Representation < Google::Apis::Core::JsonRepresentation property :aspect, as: 'aspect' property :case, as: 'case' property :form, as: 'form' property :gender, as: 'gender' property :mood, as: 'mood' property :number, as: 'number' property :person, as: 'person' property :proper, as: 'proper' property :reciprocity, as: 'reciprocity' property :tag, as: 'tag' property :tense, as: 'tense' property :voice, as: 'voice' end end class Sentence # @private class Representation < Google::Apis::Core::JsonRepresentation property :sentiment, as: 'sentiment', class: Google::Apis::LanguageV1beta1::Sentiment, decorator: Google::Apis::LanguageV1beta1::Sentiment::Representation property :text, as: 'text', class: Google::Apis::LanguageV1beta1::TextSpan, decorator: Google::Apis::LanguageV1beta1::TextSpan::Representation end end class Sentiment # @private class Representation < Google::Apis::Core::JsonRepresentation property :magnitude, as: 'magnitude' property :polarity, as: 'polarity' property :score, as: 'score' 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 TextSpan # @private class Representation < Google::Apis::Core::JsonRepresentation property :begin_offset, as: 'beginOffset' property :content, as: 'content' end end class Token # @private class Representation < Google::Apis::Core::JsonRepresentation property :dependency_edge, as: 'dependencyEdge', class: Google::Apis::LanguageV1beta1::DependencyEdge, decorator: Google::Apis::LanguageV1beta1::DependencyEdge::Representation property :lemma, as: 'lemma' property :part_of_speech, as: 'partOfSpeech', class: Google::Apis::LanguageV1beta1::PartOfSpeech, decorator: Google::Apis::LanguageV1beta1::PartOfSpeech::Representation property :text, as: 'text', class: Google::Apis::LanguageV1beta1::TextSpan, decorator: Google::Apis::LanguageV1beta1::TextSpan::Representation end end end end end google-api-client-0.19.8/generated/google/apis/language_v1beta1/classes.rb0000644000004100000410000007165713252673044026424 0ustar www-datawww-data# 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 LanguageV1beta1 # The entity analysis request message. class AnalyzeEntitiesRequest include Google::Apis::Core::Hashable # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta1::Document] attr_accessor :document # The encoding type used by the API to calculate offsets. # Corresponds to the JSON property `encodingType` # @return [String] attr_accessor :encoding_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) end end # The entity analysis response message. class AnalyzeEntitiesResponse include Google::Apis::Core::Hashable # The recognized entities in the input document. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # The language of the text, which will be the same as the language specified # in the request or, if not specified, the automatically-detected language. # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entities = args[:entities] if args.key?(:entities) @language = args[:language] if args.key?(:language) end end # The sentiment analysis request message. class AnalyzeSentimentRequest include Google::Apis::Core::Hashable # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta1::Document] attr_accessor :document # The encoding type used by the API to calculate sentence offsets for the # sentence sentiment. # Corresponds to the JSON property `encodingType` # @return [String] attr_accessor :encoding_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) end end # The sentiment analysis response message. class AnalyzeSentimentResponse include Google::Apis::Core::Hashable # Represents the feeling associated with the entire text or entities in # the text. # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1beta1::Sentiment] attr_accessor :document_sentiment # The language of the text, which will be the same as the language specified # in the request or, if not specified, the automatically-detected language. # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # The sentiment for all the sentences in the document. # Corresponds to the JSON property `sentences` # @return [Array] attr_accessor :sentences def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document_sentiment = args[:document_sentiment] if args.key?(:document_sentiment) @language = args[:language] if args.key?(:language) @sentences = args[:sentences] if args.key?(:sentences) end end # The syntax analysis request message. class AnalyzeSyntaxRequest include Google::Apis::Core::Hashable # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta1::Document] attr_accessor :document # The encoding type used by the API to calculate offsets. # Corresponds to the JSON property `encodingType` # @return [String] attr_accessor :encoding_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) end end # The syntax analysis response message. class AnalyzeSyntaxResponse include Google::Apis::Core::Hashable # The language of the text, which will be the same as the language specified # in the request or, if not specified, the automatically-detected language. # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # Sentences in the input document. # Corresponds to the JSON property `sentences` # @return [Array] attr_accessor :sentences # Tokens, along with their syntactic information, in the input document. # Corresponds to the JSON property `tokens` # @return [Array] attr_accessor :tokens def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @language = args[:language] if args.key?(:language) @sentences = args[:sentences] if args.key?(:sentences) @tokens = args[:tokens] if args.key?(:tokens) end end # The request message for the text annotation API, which can perform multiple # analysis types (sentiment, entities, and syntax) in one call. class AnnotateTextRequest include Google::Apis::Core::Hashable # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta1::Document] attr_accessor :document # The encoding type used by the API to calculate offsets. # Corresponds to the JSON property `encodingType` # @return [String] attr_accessor :encoding_type # All available features for sentiment, syntax, and semantic analysis. # Setting each one to true will enable that specific analysis for the input. # Corresponds to the JSON property `features` # @return [Google::Apis::LanguageV1beta1::Features] attr_accessor :features def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) @features = args[:features] if args.key?(:features) end end # The text annotations response message. class AnnotateTextResponse include Google::Apis::Core::Hashable # Represents the feeling associated with the entire text or entities in # the text. # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1beta1::Sentiment] attr_accessor :document_sentiment # Entities, along with their semantic information, in the input document. # Populated if the user enables # AnnotateTextRequest.Features.extract_entities. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # The language of the text, which will be the same as the language specified # in the request or, if not specified, the automatically-detected language. # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # Sentences in the input document. Populated if the user enables # AnnotateTextRequest.Features.extract_syntax. # Corresponds to the JSON property `sentences` # @return [Array] attr_accessor :sentences # Tokens, along with their syntactic information, in the input document. # Populated if the user enables # AnnotateTextRequest.Features.extract_syntax. # Corresponds to the JSON property `tokens` # @return [Array] attr_accessor :tokens def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @document_sentiment = args[:document_sentiment] if args.key?(:document_sentiment) @entities = args[:entities] if args.key?(:entities) @language = args[:language] if args.key?(:language) @sentences = args[:sentences] if args.key?(:sentences) @tokens = args[:tokens] if args.key?(:tokens) end end # Represents dependency parse tree information for a token. class DependencyEdge include Google::Apis::Core::Hashable # Represents the head of this token in the dependency tree. # This is the index of the token which has an arc going to this token. # The index is the position of the token in the array of tokens returned # by the API method. If this token is a root token, then the # `head_token_index` is its own index. # Corresponds to the JSON property `headTokenIndex` # @return [Fixnum] attr_accessor :head_token_index # The parse label for the token. # Corresponds to the JSON property `label` # @return [String] attr_accessor :label def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @head_token_index = args[:head_token_index] if args.key?(:head_token_index) @label = args[:label] if args.key?(:label) end end # ################################################################ # # Represents the input to API methods. class Document include Google::Apis::Core::Hashable # The content of the input in string format. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The Google Cloud Storage URI where the file content is located. # This URI must be of the form: gs://bucket_name/object_name. For more # details, see https://cloud.google.com/storage/docs/reference-uris. # NOTE: Cloud Storage object versioning is not supported. # Corresponds to the JSON property `gcsContentUri` # @return [String] attr_accessor :gcs_content_uri # The language of the document (if not specified, the language is # automatically detected). Both ISO and BCP-47 language codes are # accepted.
# [Language Support](/natural-language/docs/languages) # lists currently supported languages for each API method. # If the language (either specified by the caller or automatically detected) # is not supported by the called API method, an `INVALID_ARGUMENT` error # is returned. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # Required. If the type is not set or is `TYPE_UNSPECIFIED`, # returns an `INVALID_ARGUMENT` error. # 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) @content = args[:content] if args.key?(:content) @gcs_content_uri = args[:gcs_content_uri] if args.key?(:gcs_content_uri) @language = args[:language] if args.key?(:language) @type = args[:type] if args.key?(:type) end end # Represents a phrase in the text that is a known entity, such as # a person, an organization, or location. The API associates information, such # as salience and mentions, with entities. class Entity include Google::Apis::Core::Hashable # The mentions of this entity in the input document. The API currently # supports proper noun mentions. # Corresponds to the JSON property `mentions` # @return [Array] attr_accessor :mentions # Metadata associated with the entity. # Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if # available. The associated keys are "wikipedia_url" and "mid", respectively. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The representative name for the entity. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The salience score associated with the entity in the [0, 1.0] range. # The salience score for an entity provides information about the # importance or centrality of that entity to the entire document text. # Scores closer to 0 are less salient, while scores closer to 1.0 are highly # salient. # Corresponds to the JSON property `salience` # @return [Float] attr_accessor :salience # The entity 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) @mentions = args[:mentions] if args.key?(:mentions) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @salience = args[:salience] if args.key?(:salience) @type = args[:type] if args.key?(:type) end end # Represents a mention for an entity in the text. Currently, proper noun # mentions are supported. class EntityMention include Google::Apis::Core::Hashable # Represents an output piece of text. # Corresponds to the JSON property `text` # @return [Google::Apis::LanguageV1beta1::TextSpan] attr_accessor :text # The type of the entity mention. # 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 # All available features for sentiment, syntax, and semantic analysis. # Setting each one to true will enable that specific analysis for the input. class Features include Google::Apis::Core::Hashable # Extract document-level sentiment. # Corresponds to the JSON property `extractDocumentSentiment` # @return [Boolean] attr_accessor :extract_document_sentiment alias_method :extract_document_sentiment?, :extract_document_sentiment # Extract entities. # Corresponds to the JSON property `extractEntities` # @return [Boolean] attr_accessor :extract_entities alias_method :extract_entities?, :extract_entities # Extract syntax information. # Corresponds to the JSON property `extractSyntax` # @return [Boolean] attr_accessor :extract_syntax alias_method :extract_syntax?, :extract_syntax def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @extract_document_sentiment = args[:extract_document_sentiment] if args.key?(:extract_document_sentiment) @extract_entities = args[:extract_entities] if args.key?(:extract_entities) @extract_syntax = args[:extract_syntax] if args.key?(:extract_syntax) end end # Represents part of speech information for a token. class PartOfSpeech include Google::Apis::Core::Hashable # The grammatical aspect. # Corresponds to the JSON property `aspect` # @return [String] attr_accessor :aspect # The grammatical case. # Corresponds to the JSON property `case` # @return [String] attr_accessor :case # The grammatical form. # Corresponds to the JSON property `form` # @return [String] attr_accessor :form # The grammatical gender. # Corresponds to the JSON property `gender` # @return [String] attr_accessor :gender # The grammatical mood. # Corresponds to the JSON property `mood` # @return [String] attr_accessor :mood # The grammatical number. # Corresponds to the JSON property `number` # @return [String] attr_accessor :number # The grammatical person. # Corresponds to the JSON property `person` # @return [String] attr_accessor :person # The grammatical properness. # Corresponds to the JSON property `proper` # @return [String] attr_accessor :proper # The grammatical reciprocity. # Corresponds to the JSON property `reciprocity` # @return [String] attr_accessor :reciprocity # The part of speech tag. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag # The grammatical tense. # Corresponds to the JSON property `tense` # @return [String] attr_accessor :tense # The grammatical voice. # Corresponds to the JSON property `voice` # @return [String] attr_accessor :voice def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aspect = args[:aspect] if args.key?(:aspect) @case = args[:case] if args.key?(:case) @form = args[:form] if args.key?(:form) @gender = args[:gender] if args.key?(:gender) @mood = args[:mood] if args.key?(:mood) @number = args[:number] if args.key?(:number) @person = args[:person] if args.key?(:person) @proper = args[:proper] if args.key?(:proper) @reciprocity = args[:reciprocity] if args.key?(:reciprocity) @tag = args[:tag] if args.key?(:tag) @tense = args[:tense] if args.key?(:tense) @voice = args[:voice] if args.key?(:voice) end end # Represents a sentence in the input document. class Sentence include Google::Apis::Core::Hashable # Represents the feeling associated with the entire text or entities in # the text. # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1beta1::Sentiment] attr_accessor :sentiment # Represents an output piece of text. # Corresponds to the JSON property `text` # @return [Google::Apis::LanguageV1beta1::TextSpan] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @sentiment = args[:sentiment] if args.key?(:sentiment) @text = args[:text] if args.key?(:text) end end # Represents the feeling associated with the entire text or entities in # the text. class Sentiment include Google::Apis::Core::Hashable # A non-negative number in the [0, +inf) range, which represents # the absolute magnitude of sentiment regardless of score (positive or # negative). # Corresponds to the JSON property `magnitude` # @return [Float] attr_accessor :magnitude # DEPRECATED FIELD - This field is being deprecated in # favor of score. Please refer to our documentation at # https://cloud.google.com/natural-language/docs for more information. # Corresponds to the JSON property `polarity` # @return [Float] attr_accessor :polarity # Sentiment score between -1.0 (negative sentiment) and 1.0 # (positive sentiment). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @magnitude = args[:magnitude] if args.key?(:magnitude) @polarity = args[:polarity] if args.key?(:polarity) @score = args[:score] if args.key?(:score) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 an output piece of text. class TextSpan include Google::Apis::Core::Hashable # The API calculates the beginning offset of the content in the original # document according to the EncodingType specified in the API request. # Corresponds to the JSON property `beginOffset` # @return [Fixnum] attr_accessor :begin_offset # The content of the output text. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @begin_offset = args[:begin_offset] if args.key?(:begin_offset) @content = args[:content] if args.key?(:content) end end # Represents the smallest syntactic building block of the text. class Token include Google::Apis::Core::Hashable # Represents dependency parse tree information for a token. # Corresponds to the JSON property `dependencyEdge` # @return [Google::Apis::LanguageV1beta1::DependencyEdge] attr_accessor :dependency_edge # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token. # Corresponds to the JSON property `lemma` # @return [String] attr_accessor :lemma # Represents part of speech information for a token. # Corresponds to the JSON property `partOfSpeech` # @return [Google::Apis::LanguageV1beta1::PartOfSpeech] attr_accessor :part_of_speech # Represents an output piece of text. # Corresponds to the JSON property `text` # @return [Google::Apis::LanguageV1beta1::TextSpan] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dependency_edge = args[:dependency_edge] if args.key?(:dependency_edge) @lemma = args[:lemma] if args.key?(:lemma) @part_of_speech = args[:part_of_speech] if args.key?(:part_of_speech) @text = args[:text] if args.key?(:text) end end end end end google-api-client-0.19.8/generated/google/apis/language_v1beta1/service.rb0000644000004100000410000002470113252673044026413 0ustar www-datawww-data# 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 LanguageV1beta1 # Google Cloud Natural Language API # # Provides natural language understanding technologies to developers. Examples # include sentiment analysis, entity recognition, entity sentiment analysis, and # text annotations. # # @example # require 'google/apis/language_v1beta1' # # Language = Google::Apis::LanguageV1beta1 # Alias the module # service = Language::CloudNaturalLanguageService.new # # @see https://cloud.google.com/natural-language/ class CloudNaturalLanguageService < 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://language.googleapis.com/', '') @batch_path = 'batch' end # Finds named entities (currently proper names and common nouns) in the text # along with entity types, salience, mentions for each entity, and # other properties. # @param [Google::Apis::LanguageV1beta1::AnalyzeEntitiesRequest] analyze_entities_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::LanguageV1beta1::AnalyzeEntitiesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LanguageV1beta1::AnalyzeEntitiesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_document_entities(analyze_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/documents:analyzeEntities', options) command.request_representation = Google::Apis::LanguageV1beta1::AnalyzeEntitiesRequest::Representation command.request_object = analyze_entities_request_object command.response_representation = Google::Apis::LanguageV1beta1::AnalyzeEntitiesResponse::Representation command.response_class = Google::Apis::LanguageV1beta1::AnalyzeEntitiesResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Analyzes the sentiment of the provided text. # @param [Google::Apis::LanguageV1beta1::AnalyzeSentimentRequest] analyze_sentiment_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::LanguageV1beta1::AnalyzeSentimentResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LanguageV1beta1::AnalyzeSentimentResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_document_sentiment(analyze_sentiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/documents:analyzeSentiment', options) command.request_representation = Google::Apis::LanguageV1beta1::AnalyzeSentimentRequest::Representation command.request_object = analyze_sentiment_request_object command.response_representation = Google::Apis::LanguageV1beta1::AnalyzeSentimentResponse::Representation command.response_class = Google::Apis::LanguageV1beta1::AnalyzeSentimentResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Analyzes the syntax of the text and provides sentence boundaries and # tokenization along with part of speech tags, dependency trees, and other # properties. # @param [Google::Apis::LanguageV1beta1::AnalyzeSyntaxRequest] analyze_syntax_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::LanguageV1beta1::AnalyzeSyntaxResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LanguageV1beta1::AnalyzeSyntaxResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_document_syntax(analyze_syntax_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/documents:analyzeSyntax', options) command.request_representation = Google::Apis::LanguageV1beta1::AnalyzeSyntaxRequest::Representation command.request_object = analyze_syntax_request_object command.response_representation = Google::Apis::LanguageV1beta1::AnalyzeSyntaxResponse::Representation command.response_class = Google::Apis::LanguageV1beta1::AnalyzeSyntaxResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # A convenience method that provides all the features that analyzeSentiment, # analyzeEntities, and analyzeSyntax provide in one call. # @param [Google::Apis::LanguageV1beta1::AnnotateTextRequest] annotate_text_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::LanguageV1beta1::AnnotateTextResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::LanguageV1beta1::AnnotateTextResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def annotate_document_text(annotate_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/documents:annotateText', options) command.request_representation = Google::Apis::LanguageV1beta1::AnnotateTextRequest::Representation command.request_object = annotate_text_request_object command.response_representation = Google::Apis::LanguageV1beta1::AnnotateTextResponse::Representation command.response_class = Google::Apis::LanguageV1beta1::AnnotateTextResponse 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 google-api-client-0.19.8/generated/google/apis/androiddeviceprovisioning_v1.rb0000644000004100000410000000213013252673043027511 0ustar www-datawww-data# 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/androiddeviceprovisioning_v1/service.rb' require 'google/apis/androiddeviceprovisioning_v1/classes.rb' require 'google/apis/androiddeviceprovisioning_v1/representations.rb' module Google module Apis # Android Device Provisioning Partner API # # Automates Android zero-touch enrollment for device resellers, customers, and # EMMs. # # @see https://developers.google.com/zero-touch/ module AndroiddeviceprovisioningV1 VERSION = 'V1' REVISION = '20180203' end end end google-api-client-0.19.8/generated/google/apis/slides_v1.rb0000644000004100000410000000360513252673044023536 0ustar www-datawww-data# 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/slides_v1/service.rb' require 'google/apis/slides_v1/classes.rb' require 'google/apis/slides_v1/representations.rb' module Google module Apis # Google Slides API # # An API for creating and editing Google Slides presentations. # # @see https://developers.google.com/slides/ module SlidesV1 VERSION = 'V1' REVISION = '20180208' # View and manage the files in your Google Drive AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' # View and manage Google Drive files and folders that you have opened or created with this app AUTH_DRIVE_FILE = 'https://www.googleapis.com/auth/drive.file' # View the files in your Google Drive AUTH_DRIVE_READONLY = 'https://www.googleapis.com/auth/drive.readonly' # View and manage your Google Slides presentations AUTH_PRESENTATIONS = 'https://www.googleapis.com/auth/presentations' # View your Google Slides presentations AUTH_PRESENTATIONS_READONLY = 'https://www.googleapis.com/auth/presentations.readonly' # View and manage your spreadsheets in Google Drive AUTH_SPREADSHEETS = 'https://www.googleapis.com/auth/spreadsheets' # View your Google Spreadsheets AUTH_SPREADSHEETS_READONLY = 'https://www.googleapis.com/auth/spreadsheets.readonly' end end end google-api-client-0.19.8/generated/google/apis/dfareporting_v3_0/0000755000004100000410000000000013252673043024626 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/dfareporting_v3_0/representations.rb0000644000004100000410000060155513252673043030414 0ustar www-datawww-data# 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 DfareportingV3_0 class Account class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountActiveAdSummary class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountPermission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountPermissionGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountPermissionGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountPermissionsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountUserProfile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountUserProfilesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Activities class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Ad class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdBlockingConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdSlot class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdsListResponse 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 AdvertiserGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdvertiserGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdvertiserLandingPagesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdvertisersListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AudienceSegment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AudienceSegmentGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Browser class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BrowsersListResponse 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 CampaignCreativeAssociation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CampaignCreativeAssociationsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CampaignsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChangeLog class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChangeLogsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CitiesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class City class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClickTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClickThroughUrl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClickThroughUrlSuffixProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompanionClickThroughOverride class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompanionSetting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CompatibleFields class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConnectionType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConnectionTypesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContentCategoriesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContentCategory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Conversion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionsBatchInsertRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionsBatchInsertResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionsBatchUpdateRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ConversionsBatchUpdateResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CountriesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Country 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 CreativeAsset class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeAssetId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeAssetMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeAssetSelection class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeClickThroughUrl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeCustomEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeField class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeFieldAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeFieldValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeFieldValuesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeFieldsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeGroupAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeOptimizationConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeRotation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CrossDimensionReachReportCompatibleFields class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomFloodlightVariable class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomRichMediaEvents 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 DayPartTargeting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DefaultClickThroughEventTagProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeliverySchedule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DfpSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Dimension class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DimensionFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DimensionValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DimensionValueList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DimensionValueRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySite class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySiteContact class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySiteContactAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySiteContactsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySiteSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectorySitesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DynamicTargetingKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DynamicTargetingKeysListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EncryptionInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventTagOverride class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EventTagsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class File class Representation < Google::Apis::Core::JsonRepresentation; end class Urls class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class FileList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Flight class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivitiesGenerateTagResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivitiesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivityDynamicTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivityGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivityGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightActivityPublisherDynamicTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightConfigurationsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightReportCompatibleFields 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 FsCommand class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GeoTargeting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InventoryItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InventoryItemsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class KeyValueTargetingExpression class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LandingPage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Language class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LanguageTargeting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LanguagesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LastModifiedInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPopulationClause class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPopulationRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPopulationTerm class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTargetingExpression class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LookbackConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Metric class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Metro class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetrosListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MobileCarrier class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MobileCarriersListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ObjectFilter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OffsetPosition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OmnitureSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperatingSystem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperatingSystemVersion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperatingSystemVersionsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperatingSystemsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OptimizationActivity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Order class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderContact class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderDocument class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderDocumentsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PathToConversionReportCompatibleFields class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Placement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementAssignment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementStrategiesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementStrategy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementsGenerateTagsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlacementsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlatformType class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlatformTypesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PopupWindowProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PostalCode class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PostalCodesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Pricing class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PricingSchedule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PricingSchedulePricingPeriod class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Project class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReachReportCompatibleFields class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Recipient class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Region class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RegionsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemarketingList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemarketingListShare class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemarketingListsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Report class Representation < Google::Apis::Core::JsonRepresentation; end class Criteria class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CrossDimensionReachCriteria class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Delivery class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FloodlightCriteria class Representation < Google::Apis::Core::JsonRepresentation; end class ReportProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class PathToConversionCriteria class Representation < Google::Apis::Core::JsonRepresentation; end class ReportProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ReachCriteria class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Schedule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ReportCompatibleFields class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportsConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RichMediaExitOverride class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Rule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Site class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SiteContact class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SiteSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SitesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Size class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SizesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SkippableSetting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SortedDimension class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Subaccount class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SubaccountsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TagData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TagSetting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TagSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetWindow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetableRemarketingList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetableRemarketingListsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetingTemplate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TargetingTemplatesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TechnologyTargeting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThirdPartyAuthenticationToken class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThirdPartyTrackingUrl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TranscodeSetting 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 UserDefinedVariableConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserProfile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserProfileList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRole class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRolePermission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRolePermissionGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRolePermissionGroupsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRolePermissionsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserRolesListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoFormat class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoFormatsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoOffset class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Account # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_permission_ids, as: 'accountPermissionIds' property :account_profile, as: 'accountProfile' property :active, as: 'active' property :active_ads_limit_tier, as: 'activeAdsLimitTier' property :active_view_opt_out, as: 'activeViewOptOut' collection :available_permission_ids, as: 'availablePermissionIds' property :country_id, :numeric_string => true, as: 'countryId' property :currency_id, :numeric_string => true, as: 'currencyId' property :default_creative_size_id, :numeric_string => true, as: 'defaultCreativeSizeId' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :locale, as: 'locale' property :maximum_image_size, :numeric_string => true, as: 'maximumImageSize' property :name, as: 'name' property :nielsen_ocr_enabled, as: 'nielsenOcrEnabled' property :reports_configuration, as: 'reportsConfiguration', class: Google::Apis::DfareportingV3_0::ReportsConfiguration, decorator: Google::Apis::DfareportingV3_0::ReportsConfiguration::Representation property :share_reports_with_twitter, as: 'shareReportsWithTwitter' property :teaser_size_limit, :numeric_string => true, as: 'teaserSizeLimit' end end class AccountActiveAdSummary # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active_ads, :numeric_string => true, as: 'activeAds' property :active_ads_limit_tier, as: 'activeAdsLimitTier' property :available_ads, :numeric_string => true, as: 'availableAds' property :kind, as: 'kind' end end class AccountPermission # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_profiles, as: 'accountProfiles' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :level, as: 'level' property :name, as: 'name' property :permission_group_id, :numeric_string => true, as: 'permissionGroupId' end end class AccountPermissionGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class AccountPermissionGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_permission_groups, as: 'accountPermissionGroups', class: Google::Apis::DfareportingV3_0::AccountPermissionGroup, decorator: Google::Apis::DfareportingV3_0::AccountPermissionGroup::Representation property :kind, as: 'kind' end end class AccountPermissionsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_permissions, as: 'accountPermissions', class: Google::Apis::DfareportingV3_0::AccountPermission, decorator: Google::Apis::DfareportingV3_0::AccountPermission::Representation property :kind, as: 'kind' end end class AccountUserProfile # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active, as: 'active' property :advertiser_filter, as: 'advertiserFilter', class: Google::Apis::DfareportingV3_0::ObjectFilter, decorator: Google::Apis::DfareportingV3_0::ObjectFilter::Representation property :campaign_filter, as: 'campaignFilter', class: Google::Apis::DfareportingV3_0::ObjectFilter, decorator: Google::Apis::DfareportingV3_0::ObjectFilter::Representation property :comments, as: 'comments' property :email, as: 'email' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :locale, as: 'locale' property :name, as: 'name' property :site_filter, as: 'siteFilter', class: Google::Apis::DfareportingV3_0::ObjectFilter, decorator: Google::Apis::DfareportingV3_0::ObjectFilter::Representation property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :trafficker_type, as: 'traffickerType' property :user_access_type, as: 'userAccessType' property :user_role_filter, as: 'userRoleFilter', class: Google::Apis::DfareportingV3_0::ObjectFilter, decorator: Google::Apis::DfareportingV3_0::ObjectFilter::Representation property :user_role_id, :numeric_string => true, as: 'userRoleId' end end class AccountUserProfilesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_user_profiles, as: 'accountUserProfiles', class: Google::Apis::DfareportingV3_0::AccountUserProfile, decorator: Google::Apis::DfareportingV3_0::AccountUserProfile::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class AccountsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accounts, as: 'accounts', class: Google::Apis::DfareportingV3_0::Account, decorator: Google::Apis::DfareportingV3_0::Account::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Activities # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filters, as: 'filters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :kind, as: 'kind' collection :metric_names, as: 'metricNames' end end class Ad # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active, as: 'active' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :archived, as: 'archived' property :audience_segment_id, :numeric_string => true, as: 'audienceSegmentId' property :campaign_id, :numeric_string => true, as: 'campaignId' property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_0::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrl::Representation property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties::Representation property :comments, as: 'comments' property :compatibility, as: 'compatibility' property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV3_0::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV3_0::CreativeGroupAssignment::Representation property :creative_rotation, as: 'creativeRotation', class: Google::Apis::DfareportingV3_0::CreativeRotation, decorator: Google::Apis::DfareportingV3_0::CreativeRotation::Representation property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV3_0::DayPartTargeting, decorator: Google::Apis::DfareportingV3_0::DayPartTargeting::Representation property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties::Representation property :delivery_schedule, as: 'deliverySchedule', class: Google::Apis::DfareportingV3_0::DeliverySchedule, decorator: Google::Apis::DfareportingV3_0::DeliverySchedule::Representation property :dynamic_click_tracker, as: 'dynamicClickTracker' property :end_time, as: 'endTime', type: DateTime collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV3_0::EventTagOverride, decorator: Google::Apis::DfareportingV3_0::EventTagOverride::Representation property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV3_0::GeoTargeting, decorator: Google::Apis::DfareportingV3_0::GeoTargeting::Representation property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV3_0::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV3_0::KeyValueTargetingExpression::Representation property :kind, as: 'kind' property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV3_0::LanguageTargeting, decorator: Google::Apis::DfareportingV3_0::LanguageTargeting::Representation property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :name, as: 'name' collection :placement_assignments, as: 'placementAssignments', class: Google::Apis::DfareportingV3_0::PlacementAssignment, decorator: Google::Apis::DfareportingV3_0::PlacementAssignment::Representation property :remarketing_list_expression, as: 'remarketingListExpression', class: Google::Apis::DfareportingV3_0::ListTargetingExpression, decorator: Google::Apis::DfareportingV3_0::ListTargetingExpression::Representation property :size, as: 'size', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation property :ssl_compliant, as: 'sslCompliant' property :ssl_required, as: 'sslRequired' property :start_time, as: 'startTime', type: DateTime property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :targeting_template_id, :numeric_string => true, as: 'targetingTemplateId' property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV3_0::TechnologyTargeting, decorator: Google::Apis::DfareportingV3_0::TechnologyTargeting::Representation property :type, as: 'type' end end class AdBlockingConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through_url, as: 'clickThroughUrl' property :creative_bundle_id, :numeric_string => true, as: 'creativeBundleId' property :enabled, as: 'enabled' property :override_click_through_url, as: 'overrideClickThroughUrl' end end class AdSlot # @private class Representation < Google::Apis::Core::JsonRepresentation property :comment, as: 'comment' property :compatibility, as: 'compatibility' property :height, :numeric_string => true, as: 'height' property :linked_placement_id, :numeric_string => true, as: 'linkedPlacementId' property :name, as: 'name' property :payment_source_type, as: 'paymentSourceType' property :primary, as: 'primary' property :width, :numeric_string => true, as: 'width' end end class AdsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ads, as: 'ads', class: Google::Apis::DfareportingV3_0::Ad, decorator: Google::Apis::DfareportingV3_0::Ad::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Advertiser # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_group_id, :numeric_string => true, as: 'advertiserGroupId' property :click_through_url_suffix, as: 'clickThroughUrlSuffix' property :default_click_through_event_tag_id, :numeric_string => true, as: 'defaultClickThroughEventTagId' property :default_email, as: 'defaultEmail' property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :kind, as: 'kind' property :name, as: 'name' property :original_floodlight_configuration_id, :numeric_string => true, as: 'originalFloodlightConfigurationId' property :status, as: 'status' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :suspended, as: 'suspended' end end class AdvertiserGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class AdvertiserGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :advertiser_groups, as: 'advertiserGroups', class: Google::Apis::DfareportingV3_0::AdvertiserGroup, decorator: Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class AdvertiserLandingPagesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :landing_pages, as: 'landingPages', class: Google::Apis::DfareportingV3_0::LandingPage, decorator: Google::Apis::DfareportingV3_0::LandingPage::Representation property :next_page_token, as: 'nextPageToken' end end class AdvertisersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :advertisers, as: 'advertisers', class: Google::Apis::DfareportingV3_0::Advertiser, decorator: Google::Apis::DfareportingV3_0::Advertiser::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class AudienceSegment # @private class Representation < Google::Apis::Core::JsonRepresentation property :allocation, as: 'allocation' property :id, :numeric_string => true, as: 'id' property :name, as: 'name' end end class AudienceSegmentGroup # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audience_segments, as: 'audienceSegments', class: Google::Apis::DfareportingV3_0::AudienceSegment, decorator: Google::Apis::DfareportingV3_0::AudienceSegment::Representation property :id, :numeric_string => true, as: 'id' property :name, as: 'name' end end class Browser # @private class Representation < Google::Apis::Core::JsonRepresentation property :browser_version_id, :numeric_string => true, as: 'browserVersionId' property :dart_id, :numeric_string => true, as: 'dartId' property :kind, as: 'kind' property :major_version, as: 'majorVersion' property :minor_version, as: 'minorVersion' property :name, as: 'name' end end class BrowsersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :browsers, as: 'browsers', class: Google::Apis::DfareportingV3_0::Browser, decorator: Google::Apis::DfareportingV3_0::Browser::Representation property :kind, as: 'kind' end end class Campaign # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :ad_blocking_configuration, as: 'adBlockingConfiguration', class: Google::Apis::DfareportingV3_0::AdBlockingConfiguration, decorator: Google::Apis::DfareportingV3_0::AdBlockingConfiguration::Representation collection :additional_creative_optimization_configurations, as: 'additionalCreativeOptimizationConfigurations', class: Google::Apis::DfareportingV3_0::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV3_0::CreativeOptimizationConfiguration::Representation property :advertiser_group_id, :numeric_string => true, as: 'advertiserGroupId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :archived, as: 'archived' collection :audience_segment_groups, as: 'audienceSegmentGroups', class: Google::Apis::DfareportingV3_0::AudienceSegmentGroup, decorator: Google::Apis::DfareportingV3_0::AudienceSegmentGroup::Representation property :billing_invoice_code, as: 'billingInvoiceCode' property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties::Representation property :comment, as: 'comment' property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation collection :creative_group_ids, as: 'creativeGroupIds' property :creative_optimization_configuration, as: 'creativeOptimizationConfiguration', class: Google::Apis::DfareportingV3_0::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV3_0::CreativeOptimizationConfiguration::Representation property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties::Representation property :default_landing_page_id, :numeric_string => true, as: 'defaultLandingPageId' property :end_date, as: 'endDate', type: Date collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV3_0::EventTagOverride, decorator: Google::Apis::DfareportingV3_0::EventTagOverride::Representation property :external_id, as: 'externalId' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_0::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_0::LookbackConfiguration::Representation property :name, as: 'name' property :nielsen_ocr_enabled, as: 'nielsenOcrEnabled' property :start_date, as: 'startDate', type: Date property :subaccount_id, :numeric_string => true, as: 'subaccountId' collection :trafficker_emails, as: 'traffickerEmails' end end class CampaignCreativeAssociation # @private class Representation < Google::Apis::Core::JsonRepresentation property :creative_id, :numeric_string => true, as: 'creativeId' property :kind, as: 'kind' end end class CampaignCreativeAssociationsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :campaign_creative_associations, as: 'campaignCreativeAssociations', class: Google::Apis::DfareportingV3_0::CampaignCreativeAssociation, decorator: Google::Apis::DfareportingV3_0::CampaignCreativeAssociation::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CampaignsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :campaigns, as: 'campaigns', class: Google::Apis::DfareportingV3_0::Campaign, decorator: Google::Apis::DfareportingV3_0::Campaign::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class ChangeLog # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :action, as: 'action' property :change_time, as: 'changeTime', type: DateTime property :field_name, as: 'fieldName' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :new_value, as: 'newValue' property :object_id_prop, :numeric_string => true, as: 'objectId' property :object_type, as: 'objectType' property :old_value, as: 'oldValue' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :transaction_id, :numeric_string => true, as: 'transactionId' property :user_profile_id, :numeric_string => true, as: 'userProfileId' property :user_profile_name, as: 'userProfileName' end end class ChangeLogsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :change_logs, as: 'changeLogs', class: Google::Apis::DfareportingV3_0::ChangeLog, decorator: Google::Apis::DfareportingV3_0::ChangeLog::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CitiesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :cities, as: 'cities', class: Google::Apis::DfareportingV3_0::City, decorator: Google::Apis::DfareportingV3_0::City::Representation property :kind, as: 'kind' end end class City # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :country_dart_id, :numeric_string => true, as: 'countryDartId' property :dart_id, :numeric_string => true, as: 'dartId' property :kind, as: 'kind' property :metro_code, as: 'metroCode' property :metro_dma_id, :numeric_string => true, as: 'metroDmaId' property :name, as: 'name' property :region_code, as: 'regionCode' property :region_dart_id, :numeric_string => true, as: 'regionDartId' end end class ClickTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl::Representation property :event_name, as: 'eventName' property :name, as: 'name' end end class ClickThroughUrl # @private class Representation < Google::Apis::Core::JsonRepresentation property :computed_click_through_url, as: 'computedClickThroughUrl' property :custom_click_through_url, as: 'customClickThroughUrl' property :default_landing_page, as: 'defaultLandingPage' property :landing_page_id, :numeric_string => true, as: 'landingPageId' end end class ClickThroughUrlSuffixProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through_url_suffix, as: 'clickThroughUrlSuffix' property :override_inherited_suffix, as: 'overrideInheritedSuffix' end end class CompanionClickThroughOverride # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_0::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrl::Representation property :creative_id, :numeric_string => true, as: 'creativeId' end end class CompanionSetting # @private class Representation < Google::Apis::Core::JsonRepresentation property :companions_disabled, as: 'companionsDisabled' collection :enabled_sizes, as: 'enabledSizes', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation property :image_only, as: 'imageOnly' property :kind, as: 'kind' end end class CompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation property :cross_dimension_reach_report_compatible_fields, as: 'crossDimensionReachReportCompatibleFields', class: Google::Apis::DfareportingV3_0::CrossDimensionReachReportCompatibleFields, decorator: Google::Apis::DfareportingV3_0::CrossDimensionReachReportCompatibleFields::Representation property :floodlight_report_compatible_fields, as: 'floodlightReportCompatibleFields', class: Google::Apis::DfareportingV3_0::FloodlightReportCompatibleFields, decorator: Google::Apis::DfareportingV3_0::FloodlightReportCompatibleFields::Representation property :kind, as: 'kind' property :path_to_conversion_report_compatible_fields, as: 'pathToConversionReportCompatibleFields', class: Google::Apis::DfareportingV3_0::PathToConversionReportCompatibleFields, decorator: Google::Apis::DfareportingV3_0::PathToConversionReportCompatibleFields::Representation property :reach_report_compatible_fields, as: 'reachReportCompatibleFields', class: Google::Apis::DfareportingV3_0::ReachReportCompatibleFields, decorator: Google::Apis::DfareportingV3_0::ReachReportCompatibleFields::Representation property :report_compatible_fields, as: 'reportCompatibleFields', class: Google::Apis::DfareportingV3_0::ReportCompatibleFields, decorator: Google::Apis::DfareportingV3_0::ReportCompatibleFields::Representation end end class ConnectionType # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class ConnectionTypesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :connection_types, as: 'connectionTypes', class: Google::Apis::DfareportingV3_0::ConnectionType, decorator: Google::Apis::DfareportingV3_0::ConnectionType::Representation property :kind, as: 'kind' end end class ContentCategoriesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :content_categories, as: 'contentCategories', class: Google::Apis::DfareportingV3_0::ContentCategory, decorator: Google::Apis::DfareportingV3_0::ContentCategory::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class ContentCategory # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class Conversion # @private class Representation < Google::Apis::Core::JsonRepresentation property :child_directed_treatment, as: 'childDirectedTreatment' collection :custom_variables, as: 'customVariables', class: Google::Apis::DfareportingV3_0::CustomFloodlightVariable, decorator: Google::Apis::DfareportingV3_0::CustomFloodlightVariable::Representation property :encrypted_user_id, as: 'encryptedUserId' collection :encrypted_user_id_candidates, as: 'encryptedUserIdCandidates' property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' property :gclid, as: 'gclid' property :kind, as: 'kind' property :limit_ad_tracking, as: 'limitAdTracking' property :mobile_device_id, as: 'mobileDeviceId' property :ordinal, as: 'ordinal' property :quantity, :numeric_string => true, as: 'quantity' property :timestamp_micros, :numeric_string => true, as: 'timestampMicros' property :value, as: 'value' end end class ConversionError # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :kind, as: 'kind' property :message, as: 'message' end end class ConversionStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :conversion, as: 'conversion', class: Google::Apis::DfareportingV3_0::Conversion, decorator: Google::Apis::DfareportingV3_0::Conversion::Representation collection :errors, as: 'errors', class: Google::Apis::DfareportingV3_0::ConversionError, decorator: Google::Apis::DfareportingV3_0::ConversionError::Representation property :kind, as: 'kind' end end class ConversionsBatchInsertRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV3_0::Conversion, decorator: Google::Apis::DfareportingV3_0::Conversion::Representation property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV3_0::EncryptionInfo, decorator: Google::Apis::DfareportingV3_0::EncryptionInfo::Representation property :kind, as: 'kind' end end class ConversionsBatchInsertResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :has_failures, as: 'hasFailures' property :kind, as: 'kind' collection :status, as: 'status', class: Google::Apis::DfareportingV3_0::ConversionStatus, decorator: Google::Apis::DfareportingV3_0::ConversionStatus::Representation end end class ConversionsBatchUpdateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV3_0::Conversion, decorator: Google::Apis::DfareportingV3_0::Conversion::Representation property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV3_0::EncryptionInfo, decorator: Google::Apis::DfareportingV3_0::EncryptionInfo::Representation property :kind, as: 'kind' end end class ConversionsBatchUpdateResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :has_failures, as: 'hasFailures' property :kind, as: 'kind' collection :status, as: 'status', class: Google::Apis::DfareportingV3_0::ConversionStatus, decorator: Google::Apis::DfareportingV3_0::ConversionStatus::Representation end end class CountriesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :countries, as: 'countries', class: Google::Apis::DfareportingV3_0::Country, decorator: Google::Apis::DfareportingV3_0::Country::Representation property :kind, as: 'kind' end end class Country # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :dart_id, :numeric_string => true, as: 'dartId' property :kind, as: 'kind' property :name, as: 'name' property :ssl_enabled, as: 'sslEnabled' end end class Creative # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active, as: 'active' property :ad_parameters, as: 'adParameters' collection :ad_tag_keys, as: 'adTagKeys' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :allow_script_access, as: 'allowScriptAccess' property :archived, as: 'archived' property :artwork_type, as: 'artworkType' property :authoring_source, as: 'authoringSource' property :authoring_tool, as: 'authoringTool' property :auto_advance_images, as: 'autoAdvanceImages' property :background_color, as: 'backgroundColor' property :backup_image_click_through_url, as: 'backupImageClickThroughUrl', class: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl::Representation collection :backup_image_features, as: 'backupImageFeatures' property :backup_image_reporting_label, as: 'backupImageReportingLabel' property :backup_image_target_window, as: 'backupImageTargetWindow', class: Google::Apis::DfareportingV3_0::TargetWindow, decorator: Google::Apis::DfareportingV3_0::TargetWindow::Representation collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV3_0::ClickTag, decorator: Google::Apis::DfareportingV3_0::ClickTag::Representation property :commercial_id, as: 'commercialId' collection :companion_creatives, as: 'companionCreatives' collection :compatibility, as: 'compatibility' property :convert_flash_to_html5, as: 'convertFlashToHtml5' collection :counter_custom_events, as: 'counterCustomEvents', class: Google::Apis::DfareportingV3_0::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_0::CreativeCustomEvent::Representation property :creative_asset_selection, as: 'creativeAssetSelection', class: Google::Apis::DfareportingV3_0::CreativeAssetSelection, decorator: Google::Apis::DfareportingV3_0::CreativeAssetSelection::Representation collection :creative_assets, as: 'creativeAssets', class: Google::Apis::DfareportingV3_0::CreativeAsset, decorator: Google::Apis::DfareportingV3_0::CreativeAsset::Representation collection :creative_field_assignments, as: 'creativeFieldAssignments', class: Google::Apis::DfareportingV3_0::CreativeFieldAssignment, decorator: Google::Apis::DfareportingV3_0::CreativeFieldAssignment::Representation collection :custom_key_values, as: 'customKeyValues' property :dynamic_asset_selection, as: 'dynamicAssetSelection' collection :exit_custom_events, as: 'exitCustomEvents', class: Google::Apis::DfareportingV3_0::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_0::CreativeCustomEvent::Representation property :fs_command, as: 'fsCommand', class: Google::Apis::DfareportingV3_0::FsCommand, decorator: Google::Apis::DfareportingV3_0::FsCommand::Representation property :html_code, as: 'htmlCode' property :html_code_locked, as: 'htmlCodeLocked' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :latest_trafficked_creative_id, :numeric_string => true, as: 'latestTraffickedCreativeId' property :name, as: 'name' property :override_css, as: 'overrideCss' property :polite_load_asset_id, :numeric_string => true, as: 'politeLoadAssetId' property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV3_0::VideoOffset, decorator: Google::Apis::DfareportingV3_0::VideoOffset::Representation property :redirect_url, as: 'redirectUrl' property :rendering_id, :numeric_string => true, as: 'renderingId' property :rendering_id_dimension_value, as: 'renderingIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :required_flash_plugin_version, as: 'requiredFlashPluginVersion' property :required_flash_version, as: 'requiredFlashVersion' property :size, as: 'size', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV3_0::VideoOffset, decorator: Google::Apis::DfareportingV3_0::VideoOffset::Representation property :skippable, as: 'skippable' property :ssl_compliant, as: 'sslCompliant' property :ssl_override, as: 'sslOverride' property :studio_advertiser_id, :numeric_string => true, as: 'studioAdvertiserId' property :studio_creative_id, :numeric_string => true, as: 'studioCreativeId' property :studio_trafficked_creative_id, :numeric_string => true, as: 'studioTraffickedCreativeId' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :third_party_backup_image_impressions_url, as: 'thirdPartyBackupImageImpressionsUrl' property :third_party_rich_media_impressions_url, as: 'thirdPartyRichMediaImpressionsUrl' collection :third_party_urls, as: 'thirdPartyUrls', class: Google::Apis::DfareportingV3_0::ThirdPartyTrackingUrl, decorator: Google::Apis::DfareportingV3_0::ThirdPartyTrackingUrl::Representation collection :timer_custom_events, as: 'timerCustomEvents', class: Google::Apis::DfareportingV3_0::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_0::CreativeCustomEvent::Representation property :total_file_size, :numeric_string => true, as: 'totalFileSize' property :type, as: 'type' property :universal_ad_id, as: 'universalAdId', class: Google::Apis::DfareportingV3_0::UniversalAdId, decorator: Google::Apis::DfareportingV3_0::UniversalAdId::Representation property :version, as: 'version' property :video_description, as: 'videoDescription' property :video_duration, as: 'videoDuration' end end class CreativeAsset # @private class Representation < Google::Apis::Core::JsonRepresentation property :action_script3, as: 'actionScript3' property :active, as: 'active' property :alignment, as: 'alignment' property :artwork_type, as: 'artworkType' property :asset_identifier, as: 'assetIdentifier', class: Google::Apis::DfareportingV3_0::CreativeAssetId, decorator: Google::Apis::DfareportingV3_0::CreativeAssetId::Representation property :backup_image_exit, as: 'backupImageExit', class: Google::Apis::DfareportingV3_0::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_0::CreativeCustomEvent::Representation property :bit_rate, as: 'bitRate' property :child_asset_type, as: 'childAssetType' property :collapsed_size, as: 'collapsedSize', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation collection :companion_creative_ids, as: 'companionCreativeIds' property :custom_start_time_value, as: 'customStartTimeValue' collection :detected_features, as: 'detectedFeatures' property :display_type, as: 'displayType' property :duration, as: 'duration' property :duration_type, as: 'durationType' property :expanded_dimension, as: 'expandedDimension', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation property :file_size, :numeric_string => true, as: 'fileSize' property :flash_version, as: 'flashVersion' property :hide_flash_objects, as: 'hideFlashObjects' property :hide_selection_boxes, as: 'hideSelectionBoxes' property :horizontally_locked, as: 'horizontallyLocked' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :mime_type, as: 'mimeType' property :offset, as: 'offset', class: Google::Apis::DfareportingV3_0::OffsetPosition, decorator: Google::Apis::DfareportingV3_0::OffsetPosition::Representation property :orientation, as: 'orientation' property :original_backup, as: 'originalBackup' property :position, as: 'position', class: Google::Apis::DfareportingV3_0::OffsetPosition, decorator: Google::Apis::DfareportingV3_0::OffsetPosition::Representation property :position_left_unit, as: 'positionLeftUnit' property :position_top_unit, as: 'positionTopUnit' property :progressive_serving_url, as: 'progressiveServingUrl' property :pushdown, as: 'pushdown' property :pushdown_duration, as: 'pushdownDuration' property :role, as: 'role' property :size, as: 'size', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation property :ssl_compliant, as: 'sslCompliant' property :start_time_type, as: 'startTimeType' property :streaming_serving_url, as: 'streamingServingUrl' property :transparency, as: 'transparency' property :vertically_locked, as: 'verticallyLocked' property :video_duration, as: 'videoDuration' property :window_mode, as: 'windowMode' property :z_index, as: 'zIndex' property :zip_filename, as: 'zipFilename' property :zip_filesize, as: 'zipFilesize' end end class CreativeAssetId # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :type, as: 'type' end end class CreativeAssetMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :asset_identifier, as: 'assetIdentifier', class: Google::Apis::DfareportingV3_0::CreativeAssetId, decorator: Google::Apis::DfareportingV3_0::CreativeAssetId::Representation collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV3_0::ClickTag, decorator: Google::Apis::DfareportingV3_0::ClickTag::Representation collection :detected_features, as: 'detectedFeatures' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :kind, as: 'kind' collection :warned_validation_rules, as: 'warnedValidationRules' end end class CreativeAssetSelection # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_asset_id, :numeric_string => true, as: 'defaultAssetId' collection :rules, as: 'rules', class: Google::Apis::DfareportingV3_0::Rule, decorator: Google::Apis::DfareportingV3_0::Rule::Representation end end class CreativeAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :active, as: 'active' property :apply_event_tags, as: 'applyEventTags' property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_0::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrl::Representation collection :companion_creative_overrides, as: 'companionCreativeOverrides', class: Google::Apis::DfareportingV3_0::CompanionClickThroughOverride, decorator: Google::Apis::DfareportingV3_0::CompanionClickThroughOverride::Representation collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV3_0::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV3_0::CreativeGroupAssignment::Representation property :creative_id, :numeric_string => true, as: 'creativeId' property :creative_id_dimension_value, as: 'creativeIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :end_time, as: 'endTime', type: DateTime collection :rich_media_exit_overrides, as: 'richMediaExitOverrides', class: Google::Apis::DfareportingV3_0::RichMediaExitOverride, decorator: Google::Apis::DfareportingV3_0::RichMediaExitOverride::Representation property :sequence, as: 'sequence' property :ssl_compliant, as: 'sslCompliant' property :start_time, as: 'startTime', type: DateTime property :weight, as: 'weight' end end class CreativeClickThroughUrl # @private class Representation < Google::Apis::Core::JsonRepresentation property :computed_click_through_url, as: 'computedClickThroughUrl' property :custom_click_through_url, as: 'customClickThroughUrl' property :landing_page_id, :numeric_string => true, as: 'landingPageId' end end class CreativeCustomEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :advertiser_custom_event_id, :numeric_string => true, as: 'advertiserCustomEventId' property :advertiser_custom_event_name, as: 'advertiserCustomEventName' property :advertiser_custom_event_type, as: 'advertiserCustomEventType' property :artwork_label, as: 'artworkLabel' property :artwork_type, as: 'artworkType' property :exit_click_through_url, as: 'exitClickThroughUrl', class: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl::Representation property :id, :numeric_string => true, as: 'id' property :popup_window_properties, as: 'popupWindowProperties', class: Google::Apis::DfareportingV3_0::PopupWindowProperties, decorator: Google::Apis::DfareportingV3_0::PopupWindowProperties::Representation property :target_type, as: 'targetType' property :video_reporting_id, as: 'videoReportingId' end end class CreativeField # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class CreativeFieldAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :creative_field_id, :numeric_string => true, as: 'creativeFieldId' property :creative_field_value_id, :numeric_string => true, as: 'creativeFieldValueId' end end class CreativeFieldValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :value, as: 'value' end end class CreativeFieldValuesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creative_field_values, as: 'creativeFieldValues', class: Google::Apis::DfareportingV3_0::CreativeFieldValue, decorator: Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CreativeFieldsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creative_fields, as: 'creativeFields', class: Google::Apis::DfareportingV3_0::CreativeField, decorator: Google::Apis::DfareportingV3_0::CreativeField::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CreativeGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :group_number, as: 'groupNumber' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class CreativeGroupAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :creative_group_id, :numeric_string => true, as: 'creativeGroupId' property :creative_group_number, as: 'creativeGroupNumber' end end class CreativeGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creative_groups, as: 'creativeGroups', class: Google::Apis::DfareportingV3_0::CreativeGroup, decorator: Google::Apis::DfareportingV3_0::CreativeGroup::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CreativeOptimizationConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :name, as: 'name' collection :optimization_activitys, as: 'optimizationActivitys', class: Google::Apis::DfareportingV3_0::OptimizationActivity, decorator: Google::Apis::DfareportingV3_0::OptimizationActivity::Representation property :optimization_model, as: 'optimizationModel' end end class CreativeRotation # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creative_assignments, as: 'creativeAssignments', class: Google::Apis::DfareportingV3_0::CreativeAssignment, decorator: Google::Apis::DfareportingV3_0::CreativeAssignment::Representation property :creative_optimization_configuration_id, :numeric_string => true, as: 'creativeOptimizationConfigurationId' property :type, as: 'type' property :weight_calculation_strategy, as: 'weightCalculationStrategy' end end class CreativeSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :i_frame_footer, as: 'iFrameFooter' property :i_frame_header, as: 'iFrameHeader' end end class CreativesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creatives, as: 'creatives', class: Google::Apis::DfareportingV3_0::Creative, decorator: Google::Apis::DfareportingV3_0::Creative::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class CrossDimensionReachReportCompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation collection :breakdown, as: 'breakdown', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation property :kind, as: 'kind' collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation collection :overlap_metrics, as: 'overlapMetrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation end end class CustomFloodlightVariable # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :type, as: 'type' property :value, as: 'value' end end class CustomRichMediaEvents # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filtered_event_ids, as: 'filteredEventIds', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :kind, as: 'kind' end end class DateRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_date, as: 'endDate', type: Date property :kind, as: 'kind' property :relative_date_range, as: 'relativeDateRange' property :start_date, as: 'startDate', type: Date end end class DayPartTargeting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :days_of_week, as: 'daysOfWeek' collection :hours_of_day, as: 'hoursOfDay' property :user_local_time, as: 'userLocalTime' end end class DefaultClickThroughEventTagProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_click_through_event_tag_id, :numeric_string => true, as: 'defaultClickThroughEventTagId' property :override_inherited_event_tag, as: 'overrideInheritedEventTag' end end class DeliverySchedule # @private class Representation < Google::Apis::Core::JsonRepresentation property :frequency_cap, as: 'frequencyCap', class: Google::Apis::DfareportingV3_0::FrequencyCap, decorator: Google::Apis::DfareportingV3_0::FrequencyCap::Representation property :hard_cutoff, as: 'hardCutoff' property :impression_ratio, :numeric_string => true, as: 'impressionRatio' property :priority, as: 'priority' end end class DfpSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :dfp_network_code, as: 'dfpNetworkCode' property :dfp_network_name, as: 'dfpNetworkName' property :programmatic_placement_accepted, as: 'programmaticPlacementAccepted' property :pub_paid_placement_accepted, as: 'pubPaidPlacementAccepted' property :publisher_portal_only, as: 'publisherPortalOnly' end end class Dimension # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :name, as: 'name' end end class DimensionFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension_name, as: 'dimensionName' property :kind, as: 'kind' property :value, as: 'value' end end class DimensionValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension_name, as: 'dimensionName' property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :match_type, as: 'matchType' property :value, as: 'value' end end class DimensionValueList # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class DimensionValueRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension_name, as: 'dimensionName' property :end_date, as: 'endDate', type: Date collection :filters, as: 'filters', class: Google::Apis::DfareportingV3_0::DimensionFilter, decorator: Google::Apis::DfareportingV3_0::DimensionFilter::Representation property :kind, as: 'kind' property :start_date, as: 'startDate', type: Date end end class DirectorySite # @private class Representation < Google::Apis::Core::JsonRepresentation property :active, as: 'active' collection :contact_assignments, as: 'contactAssignments', class: Google::Apis::DfareportingV3_0::DirectorySiteContactAssignment, decorator: Google::Apis::DfareportingV3_0::DirectorySiteContactAssignment::Representation property :country_id, :numeric_string => true, as: 'countryId' property :currency_id, :numeric_string => true, as: 'currencyId' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation collection :inpage_tag_formats, as: 'inpageTagFormats' collection :interstitial_tag_formats, as: 'interstitialTagFormats' property :kind, as: 'kind' property :name, as: 'name' property :parent_id, :numeric_string => true, as: 'parentId' property :settings, as: 'settings', class: Google::Apis::DfareportingV3_0::DirectorySiteSettings, decorator: Google::Apis::DfareportingV3_0::DirectorySiteSettings::Representation property :url, as: 'url' end end class DirectorySiteContact # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address' property :email, as: 'email' property :first_name, as: 'firstName' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :last_name, as: 'lastName' property :phone, as: 'phone' property :role, as: 'role' property :title, as: 'title' property :type, as: 'type' end end class DirectorySiteContactAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :contact_id, :numeric_string => true, as: 'contactId' property :visibility, as: 'visibility' end end class DirectorySiteContactsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :directory_site_contacts, as: 'directorySiteContacts', class: Google::Apis::DfareportingV3_0::DirectorySiteContact, decorator: Google::Apis::DfareportingV3_0::DirectorySiteContact::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class DirectorySiteSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :active_view_opt_out, as: 'activeViewOptOut' property :dfp_settings, as: 'dfpSettings', class: Google::Apis::DfareportingV3_0::DfpSettings, decorator: Google::Apis::DfareportingV3_0::DfpSettings::Representation property :instream_video_placement_accepted, as: 'instreamVideoPlacementAccepted' property :interstitial_placement_accepted, as: 'interstitialPlacementAccepted' property :nielsen_ocr_opt_out, as: 'nielsenOcrOptOut' property :verification_tag_opt_out, as: 'verificationTagOptOut' property :video_active_view_opt_out, as: 'videoActiveViewOptOut' end end class DirectorySitesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :directory_sites, as: 'directorySites', class: Google::Apis::DfareportingV3_0::DirectorySite, decorator: Google::Apis::DfareportingV3_0::DirectorySite::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class DynamicTargetingKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :name, as: 'name' property :object_id_prop, :numeric_string => true, as: 'objectId' property :object_type, as: 'objectType' end end class DynamicTargetingKeysListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dynamic_targeting_keys, as: 'dynamicTargetingKeys', class: Google::Apis::DfareportingV3_0::DynamicTargetingKey, decorator: Google::Apis::DfareportingV3_0::DynamicTargetingKey::Representation property :kind, as: 'kind' end end class EncryptionInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :encryption_entity_id, :numeric_string => true, as: 'encryptionEntityId' property :encryption_entity_type, as: 'encryptionEntityType' property :encryption_source, as: 'encryptionSource' property :kind, as: 'kind' end end class EventTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :campaign_id, :numeric_string => true, as: 'campaignId' property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :enabled_by_default, as: 'enabledByDefault' property :exclude_from_adx_requests, as: 'excludeFromAdxRequests' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :site_filter_type, as: 'siteFilterType' collection :site_ids, as: 'siteIds' property :ssl_compliant, as: 'sslCompliant' property :status, as: 'status' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :type, as: 'type' property :url, as: 'url' property :url_escape_levels, as: 'urlEscapeLevels' end end class EventTagOverride # @private class Representation < Google::Apis::Core::JsonRepresentation property :enabled, as: 'enabled' property :id, :numeric_string => true, as: 'id' end end class EventTagsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :event_tags, as: 'eventTags', class: Google::Apis::DfareportingV3_0::EventTag, decorator: Google::Apis::DfareportingV3_0::EventTag::Representation property :kind, as: 'kind' end end class File # @private class Representation < Google::Apis::Core::JsonRepresentation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation property :etag, as: 'etag' property :file_name, as: 'fileName' property :format, as: 'format' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :last_modified_time, :numeric_string => true, as: 'lastModifiedTime' property :report_id, :numeric_string => true, as: 'reportId' property :status, as: 'status' property :urls, as: 'urls', class: Google::Apis::DfareportingV3_0::File::Urls, decorator: Google::Apis::DfareportingV3_0::File::Urls::Representation end class Urls # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_url, as: 'apiUrl' property :browser_url, as: 'browserUrl' end end end class FileList # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::DfareportingV3_0::File, decorator: Google::Apis::DfareportingV3_0::File::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class Flight # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_date, as: 'endDate', type: Date property :rate_or_cost, :numeric_string => true, as: 'rateOrCost' property :start_date, as: 'startDate', type: Date property :units, :numeric_string => true, as: 'units' end end class FloodlightActivitiesGenerateTagResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :floodlight_activity_tag, as: 'floodlightActivityTag' property :global_site_tag_global_snippet, as: 'globalSiteTagGlobalSnippet' property :kind, as: 'kind' end end class FloodlightActivitiesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :floodlight_activities, as: 'floodlightActivities', class: Google::Apis::DfareportingV3_0::FloodlightActivity, decorator: Google::Apis::DfareportingV3_0::FloodlightActivity::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class FloodlightActivity # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :cache_busting_type, as: 'cacheBustingType' property :counting_method, as: 'countingMethod' collection :default_tags, as: 'defaultTags', class: Google::Apis::DfareportingV3_0::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV3_0::FloodlightActivityDynamicTag::Representation property :expected_url, as: 'expectedUrl' property :floodlight_activity_group_id, :numeric_string => true, as: 'floodlightActivityGroupId' property :floodlight_activity_group_name, as: 'floodlightActivityGroupName' property :floodlight_activity_group_tag_string, as: 'floodlightActivityGroupTagString' property :floodlight_activity_group_type, as: 'floodlightActivityGroupType' property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :floodlight_tag_type, as: 'floodlightTagType' property :hidden, as: 'hidden' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :kind, as: 'kind' property :name, as: 'name' property :notes, as: 'notes' collection :publisher_tags, as: 'publisherTags', class: Google::Apis::DfareportingV3_0::FloodlightActivityPublisherDynamicTag, decorator: Google::Apis::DfareportingV3_0::FloodlightActivityPublisherDynamicTag::Representation property :secure, as: 'secure' property :ssl_compliant, as: 'sslCompliant' property :ssl_required, as: 'sslRequired' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :tag_format, as: 'tagFormat' property :tag_string, as: 'tagString' collection :user_defined_variable_types, as: 'userDefinedVariableTypes' end end class FloodlightActivityDynamicTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :name, as: 'name' property :tag, as: 'tag' end end class FloodlightActivityGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :kind, as: 'kind' property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :tag_string, as: 'tagString' property :type, as: 'type' end end class FloodlightActivityGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :floodlight_activity_groups, as: 'floodlightActivityGroups', class: Google::Apis::DfareportingV3_0::FloodlightActivityGroup, decorator: Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class FloodlightActivityPublisherDynamicTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through, as: 'clickThrough' property :directory_site_id, :numeric_string => true, as: 'directorySiteId' property :dynamic_tag, as: 'dynamicTag', class: Google::Apis::DfareportingV3_0::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV3_0::FloodlightActivityDynamicTag::Representation property :site_id, :numeric_string => true, as: 'siteId' property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :view_through, as: 'viewThrough' end end class FloodlightConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :analytics_data_sharing_enabled, as: 'analyticsDataSharingEnabled' property :exposure_to_conversion_enabled, as: 'exposureToConversionEnabled' property :first_day_of_week, as: 'firstDayOfWeek' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :in_app_attribution_tracking_enabled, as: 'inAppAttributionTrackingEnabled' property :kind, as: 'kind' property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_0::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_0::LookbackConfiguration::Representation property :natural_search_conversion_attribution_option, as: 'naturalSearchConversionAttributionOption' property :omniture_settings, as: 'omnitureSettings', class: Google::Apis::DfareportingV3_0::OmnitureSettings, decorator: Google::Apis::DfareportingV3_0::OmnitureSettings::Representation property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :tag_settings, as: 'tagSettings', class: Google::Apis::DfareportingV3_0::TagSettings, decorator: Google::Apis::DfareportingV3_0::TagSettings::Representation collection :third_party_authentication_tokens, as: 'thirdPartyAuthenticationTokens', class: Google::Apis::DfareportingV3_0::ThirdPartyAuthenticationToken, decorator: Google::Apis::DfareportingV3_0::ThirdPartyAuthenticationToken::Representation collection :user_defined_variable_configurations, as: 'userDefinedVariableConfigurations', class: Google::Apis::DfareportingV3_0::UserDefinedVariableConfiguration, decorator: Google::Apis::DfareportingV3_0::UserDefinedVariableConfiguration::Representation end end class FloodlightConfigurationsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :floodlight_configurations, as: 'floodlightConfigurations', class: Google::Apis::DfareportingV3_0::FloodlightConfiguration, decorator: Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation property :kind, as: 'kind' end end class FloodlightReportCompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation property :kind, as: 'kind' collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation end end class FrequencyCap # @private class Representation < Google::Apis::Core::JsonRepresentation property :duration, :numeric_string => true, as: 'duration' property :impressions, :numeric_string => true, as: 'impressions' end end class FsCommand # @private class Representation < Google::Apis::Core::JsonRepresentation property :left, as: 'left' property :position_option, as: 'positionOption' property :top, as: 'top' property :window_height, as: 'windowHeight' property :window_width, as: 'windowWidth' end end class GeoTargeting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :cities, as: 'cities', class: Google::Apis::DfareportingV3_0::City, decorator: Google::Apis::DfareportingV3_0::City::Representation collection :countries, as: 'countries', class: Google::Apis::DfareportingV3_0::Country, decorator: Google::Apis::DfareportingV3_0::Country::Representation property :exclude_countries, as: 'excludeCountries' collection :metros, as: 'metros', class: Google::Apis::DfareportingV3_0::Metro, decorator: Google::Apis::DfareportingV3_0::Metro::Representation collection :postal_codes, as: 'postalCodes', class: Google::Apis::DfareportingV3_0::PostalCode, decorator: Google::Apis::DfareportingV3_0::PostalCode::Representation collection :regions, as: 'regions', class: Google::Apis::DfareportingV3_0::Region, decorator: Google::Apis::DfareportingV3_0::Region::Representation end end class InventoryItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' collection :ad_slots, as: 'adSlots', class: Google::Apis::DfareportingV3_0::AdSlot, decorator: Google::Apis::DfareportingV3_0::AdSlot::Representation property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :content_category_id, :numeric_string => true, as: 'contentCategoryId' property :estimated_click_through_rate, :numeric_string => true, as: 'estimatedClickThroughRate' property :estimated_conversion_rate, :numeric_string => true, as: 'estimatedConversionRate' property :id, :numeric_string => true, as: 'id' property :in_plan, as: 'inPlan' property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :name, as: 'name' property :negotiation_channel_id, :numeric_string => true, as: 'negotiationChannelId' property :order_id, :numeric_string => true, as: 'orderId' property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' property :pricing, as: 'pricing', class: Google::Apis::DfareportingV3_0::Pricing, decorator: Google::Apis::DfareportingV3_0::Pricing::Representation property :project_id, :numeric_string => true, as: 'projectId' property :rfp_id, :numeric_string => true, as: 'rfpId' property :site_id, :numeric_string => true, as: 'siteId' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :type, as: 'type' end end class InventoryItemsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :inventory_items, as: 'inventoryItems', class: Google::Apis::DfareportingV3_0::InventoryItem, decorator: Google::Apis::DfareportingV3_0::InventoryItem::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class KeyValueTargetingExpression # @private class Representation < Google::Apis::Core::JsonRepresentation property :expression, as: 'expression' end end class LandingPage # @private class Representation < Google::Apis::Core::JsonRepresentation property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :archived, as: 'archived' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :url, as: 'url' end end class Language # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :language_code, as: 'languageCode' property :name, as: 'name' end end class LanguageTargeting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :languages, as: 'languages', class: Google::Apis::DfareportingV3_0::Language, decorator: Google::Apis::DfareportingV3_0::Language::Representation end end class LanguagesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :languages, as: 'languages', class: Google::Apis::DfareportingV3_0::Language, decorator: Google::Apis::DfareportingV3_0::Language::Representation end end class LastModifiedInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :time, :numeric_string => true, as: 'time' end end class ListPopulationClause # @private class Representation < Google::Apis::Core::JsonRepresentation collection :terms, as: 'terms', class: Google::Apis::DfareportingV3_0::ListPopulationTerm, decorator: Google::Apis::DfareportingV3_0::ListPopulationTerm::Representation end end class ListPopulationRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' property :floodlight_activity_name, as: 'floodlightActivityName' collection :list_population_clauses, as: 'listPopulationClauses', class: Google::Apis::DfareportingV3_0::ListPopulationClause, decorator: Google::Apis::DfareportingV3_0::ListPopulationClause::Representation end end class ListPopulationTerm # @private class Representation < Google::Apis::Core::JsonRepresentation property :contains, as: 'contains' property :negation, as: 'negation' property :operator, as: 'operator' property :remarketing_list_id, :numeric_string => true, as: 'remarketingListId' property :type, as: 'type' property :value, as: 'value' property :variable_friendly_name, as: 'variableFriendlyName' property :variable_name, as: 'variableName' end end class ListTargetingExpression # @private class Representation < Google::Apis::Core::JsonRepresentation property :expression, as: 'expression' end end class LookbackConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_duration, as: 'clickDuration' property :post_impression_activities_duration, as: 'postImpressionActivitiesDuration' end end class Metric # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :name, as: 'name' end end class Metro # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :country_dart_id, :numeric_string => true, as: 'countryDartId' property :dart_id, :numeric_string => true, as: 'dartId' property :dma_id, :numeric_string => true, as: 'dmaId' property :kind, as: 'kind' property :metro_code, as: 'metroCode' property :name, as: 'name' end end class MetrosListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :metros, as: 'metros', class: Google::Apis::DfareportingV3_0::Metro, decorator: Google::Apis::DfareportingV3_0::Metro::Representation end end class MobileCarrier # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :country_dart_id, :numeric_string => true, as: 'countryDartId' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class MobileCarriersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :mobile_carriers, as: 'mobileCarriers', class: Google::Apis::DfareportingV3_0::MobileCarrier, decorator: Google::Apis::DfareportingV3_0::MobileCarrier::Representation end end class ObjectFilter # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :object_ids, as: 'objectIds' property :status, as: 'status' end end class OffsetPosition # @private class Representation < Google::Apis::Core::JsonRepresentation property :left, as: 'left' property :top, as: 'top' end end class OmnitureSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :omniture_cost_data_enabled, as: 'omnitureCostDataEnabled' property :omniture_integration_enabled, as: 'omnitureIntegrationEnabled' end end class OperatingSystem # @private class Representation < Google::Apis::Core::JsonRepresentation property :dart_id, :numeric_string => true, as: 'dartId' property :desktop, as: 'desktop' property :kind, as: 'kind' property :mobile, as: 'mobile' property :name, as: 'name' end end class OperatingSystemVersion # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :major_version, as: 'majorVersion' property :minor_version, as: 'minorVersion' property :name, as: 'name' property :operating_system, as: 'operatingSystem', class: Google::Apis::DfareportingV3_0::OperatingSystem, decorator: Google::Apis::DfareportingV3_0::OperatingSystem::Representation end end class OperatingSystemVersionsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :operating_system_versions, as: 'operatingSystemVersions', class: Google::Apis::DfareportingV3_0::OperatingSystemVersion, decorator: Google::Apis::DfareportingV3_0::OperatingSystemVersion::Representation end end class OperatingSystemsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :operating_systems, as: 'operatingSystems', class: Google::Apis::DfareportingV3_0::OperatingSystem, decorator: Google::Apis::DfareportingV3_0::OperatingSystem::Representation end end class OptimizationActivity # @private class Representation < Google::Apis::Core::JsonRepresentation property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' property :floodlight_activity_id_dimension_value, as: 'floodlightActivityIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :weight, as: 'weight' end end class Order # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' collection :approver_user_profile_ids, as: 'approverUserProfileIds' property :buyer_invoice_id, as: 'buyerInvoiceId' property :buyer_organization_name, as: 'buyerOrganizationName' property :comments, as: 'comments' collection :contacts, as: 'contacts', class: Google::Apis::DfareportingV3_0::OrderContact, decorator: Google::Apis::DfareportingV3_0::OrderContact::Representation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :name, as: 'name' property :notes, as: 'notes' property :planning_term_id, :numeric_string => true, as: 'planningTermId' property :project_id, :numeric_string => true, as: 'projectId' property :seller_order_id, as: 'sellerOrderId' property :seller_organization_name, as: 'sellerOrganizationName' collection :site_id, as: 'siteId' collection :site_names, as: 'siteNames' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :terms_and_conditions, as: 'termsAndConditions' end end class OrderContact # @private class Representation < Google::Apis::Core::JsonRepresentation property :contact_info, as: 'contactInfo' property :contact_name, as: 'contactName' property :contact_title, as: 'contactTitle' property :contact_type, as: 'contactType' property :signature_user_profile_id, :numeric_string => true, as: 'signatureUserProfileId' end end class OrderDocument # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :amended_order_document_id, :numeric_string => true, as: 'amendedOrderDocumentId' collection :approved_by_user_profile_ids, as: 'approvedByUserProfileIds' property :cancelled, as: 'cancelled' property :created_info, as: 'createdInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :effective_date, as: 'effectiveDate', type: Date property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' collection :last_sent_recipients, as: 'lastSentRecipients' property :last_sent_time, as: 'lastSentTime', type: DateTime property :order_id, :numeric_string => true, as: 'orderId' property :project_id, :numeric_string => true, as: 'projectId' property :signed, as: 'signed' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :title, as: 'title' property :type, as: 'type' end end class OrderDocumentsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :order_documents, as: 'orderDocuments', class: Google::Apis::DfareportingV3_0::OrderDocument, decorator: Google::Apis::DfareportingV3_0::OrderDocument::Representation end end class OrdersListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :orders, as: 'orders', class: Google::Apis::DfareportingV3_0::Order, decorator: Google::Apis::DfareportingV3_0::Order::Representation end end class PathToConversionReportCompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation property :kind, as: 'kind' collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation end end class Placement # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :ad_blocking_opt_out, as: 'adBlockingOptOut' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :archived, as: 'archived' property :campaign_id, :numeric_string => true, as: 'campaignId' property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :comment, as: 'comment' property :compatibility, as: 'compatibility' property :content_category_id, :numeric_string => true, as: 'contentCategoryId' property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :directory_site_id, :numeric_string => true, as: 'directorySiteId' property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :external_id, as: 'externalId' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :key_name, as: 'keyName' property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_0::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_0::LookbackConfiguration::Representation property :name, as: 'name' property :payment_approved, as: 'paymentApproved' property :payment_source, as: 'paymentSource' property :placement_group_id, :numeric_string => true, as: 'placementGroupId' property :placement_group_id_dimension_value, as: 'placementGroupIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV3_0::PricingSchedule, decorator: Google::Apis::DfareportingV3_0::PricingSchedule::Representation property :primary, as: 'primary' property :publisher_update_info, as: 'publisherUpdateInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :site_id, :numeric_string => true, as: 'siteId' property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :size, as: 'size', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation property :ssl_required, as: 'sslRequired' property :status, as: 'status' property :subaccount_id, :numeric_string => true, as: 'subaccountId' collection :tag_formats, as: 'tagFormats' property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV3_0::TagSetting, decorator: Google::Apis::DfareportingV3_0::TagSetting::Representation property :video_active_view_opt_out, as: 'videoActiveViewOptOut' property :video_settings, as: 'videoSettings', class: Google::Apis::DfareportingV3_0::VideoSettings, decorator: Google::Apis::DfareportingV3_0::VideoSettings::Representation property :vpaid_adapter_choice, as: 'vpaidAdapterChoice' end end class PlacementAssignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :active, as: 'active' property :placement_id, :numeric_string => true, as: 'placementId' property :placement_id_dimension_value, as: 'placementIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :ssl_required, as: 'sslRequired' end end class PlacementGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :archived, as: 'archived' property :campaign_id, :numeric_string => true, as: 'campaignId' property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation collection :child_placement_ids, as: 'childPlacementIds' property :comment, as: 'comment' property :content_category_id, :numeric_string => true, as: 'contentCategoryId' property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :directory_site_id, :numeric_string => true, as: 'directorySiteId' property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :external_id, as: 'externalId' property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :name, as: 'name' property :placement_group_type, as: 'placementGroupType' property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV3_0::PricingSchedule, decorator: Google::Apis::DfareportingV3_0::PricingSchedule::Representation property :primary_placement_id, :numeric_string => true, as: 'primaryPlacementId' property :primary_placement_id_dimension_value, as: 'primaryPlacementIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :site_id, :numeric_string => true, as: 'siteId' property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class PlacementGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :placement_groups, as: 'placementGroups', class: Google::Apis::DfareportingV3_0::PlacementGroup, decorator: Google::Apis::DfareportingV3_0::PlacementGroup::Representation end end class PlacementStrategiesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :placement_strategies, as: 'placementStrategies', class: Google::Apis::DfareportingV3_0::PlacementStrategy, decorator: Google::Apis::DfareportingV3_0::PlacementStrategy::Representation end end class PlacementStrategy # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class PlacementTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :placement_id, :numeric_string => true, as: 'placementId' collection :tag_datas, as: 'tagDatas', class: Google::Apis::DfareportingV3_0::TagData, decorator: Google::Apis::DfareportingV3_0::TagData::Representation end end class PlacementsGenerateTagsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :placement_tags, as: 'placementTags', class: Google::Apis::DfareportingV3_0::PlacementTag, decorator: Google::Apis::DfareportingV3_0::PlacementTag::Representation end end class PlacementsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :placements, as: 'placements', class: Google::Apis::DfareportingV3_0::Placement, decorator: Google::Apis::DfareportingV3_0::Placement::Representation end end class PlatformType # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class PlatformTypesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :platform_types, as: 'platformTypes', class: Google::Apis::DfareportingV3_0::PlatformType, decorator: Google::Apis::DfareportingV3_0::PlatformType::Representation end end class PopupWindowProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension, as: 'dimension', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation property :offset, as: 'offset', class: Google::Apis::DfareportingV3_0::OffsetPosition, decorator: Google::Apis::DfareportingV3_0::OffsetPosition::Representation property :position_type, as: 'positionType' property :show_address_bar, as: 'showAddressBar' property :show_menu_bar, as: 'showMenuBar' property :show_scroll_bar, as: 'showScrollBar' property :show_status_bar, as: 'showStatusBar' property :show_tool_bar, as: 'showToolBar' property :title, as: 'title' end end class PostalCode # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :country_code, as: 'countryCode' property :country_dart_id, :numeric_string => true, as: 'countryDartId' property :id, as: 'id' property :kind, as: 'kind' end end class PostalCodesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :postal_codes, as: 'postalCodes', class: Google::Apis::DfareportingV3_0::PostalCode, decorator: Google::Apis::DfareportingV3_0::PostalCode::Representation end end class Pricing # @private class Representation < Google::Apis::Core::JsonRepresentation property :cap_cost_type, as: 'capCostType' property :end_date, as: 'endDate', type: Date collection :flights, as: 'flights', class: Google::Apis::DfareportingV3_0::Flight, decorator: Google::Apis::DfareportingV3_0::Flight::Representation property :group_type, as: 'groupType' property :pricing_type, as: 'pricingType' property :start_date, as: 'startDate', type: Date end end class PricingSchedule # @private class Representation < Google::Apis::Core::JsonRepresentation property :cap_cost_option, as: 'capCostOption' property :disregard_overdelivery, as: 'disregardOverdelivery' property :end_date, as: 'endDate', type: Date property :flighted, as: 'flighted' property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' collection :pricing_periods, as: 'pricingPeriods', class: Google::Apis::DfareportingV3_0::PricingSchedulePricingPeriod, decorator: Google::Apis::DfareportingV3_0::PricingSchedulePricingPeriod::Representation property :pricing_type, as: 'pricingType' property :start_date, as: 'startDate', type: Date property :testing_start_date, as: 'testingStartDate', type: Date end end class PricingSchedulePricingPeriod # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_date, as: 'endDate', type: Date property :pricing_comment, as: 'pricingComment' property :rate_or_cost_nanos, :numeric_string => true, as: 'rateOrCostNanos' property :start_date, as: 'startDate', type: Date property :units, :numeric_string => true, as: 'units' end end class Project # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :audience_age_group, as: 'audienceAgeGroup' property :audience_gender, as: 'audienceGender' property :budget, :numeric_string => true, as: 'budget' property :client_billing_code, as: 'clientBillingCode' property :client_name, as: 'clientName' property :end_date, as: 'endDate', type: Date property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation property :name, as: 'name' property :overview, as: 'overview' property :start_date, as: 'startDate', type: Date property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :target_clicks, :numeric_string => true, as: 'targetClicks' property :target_conversions, :numeric_string => true, as: 'targetConversions' property :target_cpa_nanos, :numeric_string => true, as: 'targetCpaNanos' property :target_cpc_nanos, :numeric_string => true, as: 'targetCpcNanos' property :target_cpm_active_view_nanos, :numeric_string => true, as: 'targetCpmActiveViewNanos' property :target_cpm_nanos, :numeric_string => true, as: 'targetCpmNanos' property :target_impressions, :numeric_string => true, as: 'targetImpressions' end end class ProjectsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :projects, as: 'projects', class: Google::Apis::DfareportingV3_0::Project, decorator: Google::Apis::DfareportingV3_0::Project::Representation end end class ReachReportCompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation property :kind, as: 'kind' collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation collection :reach_by_frequency_metrics, as: 'reachByFrequencyMetrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation end end class Recipient # @private class Representation < Google::Apis::Core::JsonRepresentation property :delivery_type, as: 'deliveryType' property :email, as: 'email' property :kind, as: 'kind' end end class Region # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :country_dart_id, :numeric_string => true, as: 'countryDartId' property :dart_id, :numeric_string => true, as: 'dartId' property :kind, as: 'kind' property :name, as: 'name' property :region_code, as: 'regionCode' end end class RegionsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :regions, as: 'regions', class: Google::Apis::DfareportingV3_0::Region, decorator: Google::Apis::DfareportingV3_0::Region::Representation end end class RemarketingList # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active, as: 'active' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :life_span, :numeric_string => true, as: 'lifeSpan' property :list_population_rule, as: 'listPopulationRule', class: Google::Apis::DfareportingV3_0::ListPopulationRule, decorator: Google::Apis::DfareportingV3_0::ListPopulationRule::Representation property :list_size, :numeric_string => true, as: 'listSize' property :list_source, as: 'listSource' property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class RemarketingListShare # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :remarketing_list_id, :numeric_string => true, as: 'remarketingListId' collection :shared_account_ids, as: 'sharedAccountIds' collection :shared_advertiser_ids, as: 'sharedAdvertiserIds' end end class RemarketingListsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :remarketing_lists, as: 'remarketingLists', class: Google::Apis::DfareportingV3_0::RemarketingList, decorator: Google::Apis::DfareportingV3_0::RemarketingList::Representation end end class Report # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :criteria, as: 'criteria', class: Google::Apis::DfareportingV3_0::Report::Criteria, decorator: Google::Apis::DfareportingV3_0::Report::Criteria::Representation property :cross_dimension_reach_criteria, as: 'crossDimensionReachCriteria', class: Google::Apis::DfareportingV3_0::Report::CrossDimensionReachCriteria, decorator: Google::Apis::DfareportingV3_0::Report::CrossDimensionReachCriteria::Representation property :delivery, as: 'delivery', class: Google::Apis::DfareportingV3_0::Report::Delivery, decorator: Google::Apis::DfareportingV3_0::Report::Delivery::Representation property :etag, as: 'etag' property :file_name, as: 'fileName' property :floodlight_criteria, as: 'floodlightCriteria', class: Google::Apis::DfareportingV3_0::Report::FloodlightCriteria, decorator: Google::Apis::DfareportingV3_0::Report::FloodlightCriteria::Representation property :format, as: 'format' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :last_modified_time, :numeric_string => true, as: 'lastModifiedTime' property :name, as: 'name' property :owner_profile_id, :numeric_string => true, as: 'ownerProfileId' property :path_to_conversion_criteria, as: 'pathToConversionCriteria', class: Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria, decorator: Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria::Representation property :reach_criteria, as: 'reachCriteria', class: Google::Apis::DfareportingV3_0::Report::ReachCriteria, decorator: Google::Apis::DfareportingV3_0::Report::ReachCriteria::Representation property :schedule, as: 'schedule', class: Google::Apis::DfareportingV3_0::Report::Schedule, decorator: Google::Apis::DfareportingV3_0::Report::Schedule::Representation property :sub_account_id, :numeric_string => true, as: 'subAccountId' property :type, as: 'type' end class Criteria # @private class Representation < Google::Apis::Core::JsonRepresentation property :activities, as: 'activities', class: Google::Apis::DfareportingV3_0::Activities, decorator: Google::Apis::DfareportingV3_0::Activities::Representation property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_0::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV3_0::CustomRichMediaEvents::Representation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation collection :metric_names, as: 'metricNames' end end class CrossDimensionReachCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation collection :breakdown, as: 'breakdown', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation property :dimension, as: 'dimension' collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation collection :metric_names, as: 'metricNames' collection :overlap_metric_names, as: 'overlapMetricNames' property :pivoted, as: 'pivoted' end end class Delivery # @private class Representation < Google::Apis::Core::JsonRepresentation property :email_owner, as: 'emailOwner' property :email_owner_delivery_type, as: 'emailOwnerDeliveryType' property :message, as: 'message' collection :recipients, as: 'recipients', class: Google::Apis::DfareportingV3_0::Recipient, decorator: Google::Apis::DfareportingV3_0::Recipient::Representation end end class FloodlightCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation collection :metric_names, as: 'metricNames' property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV3_0::Report::FloodlightCriteria::ReportProperties, decorator: Google::Apis::DfareportingV3_0::Report::FloodlightCriteria::ReportProperties::Representation end class ReportProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :include_attributed_ip_conversions, as: 'includeAttributedIPConversions' property :include_unattributed_cookie_conversions, as: 'includeUnattributedCookieConversions' property :include_unattributed_ip_conversions, as: 'includeUnattributedIPConversions' end end end class PathToConversionCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation collection :activity_filters, as: 'activityFilters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation collection :metric_names, as: 'metricNames' collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria::ReportProperties, decorator: Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria::ReportProperties::Representation end class ReportProperties # @private class Representation < Google::Apis::Core::JsonRepresentation property :clicks_lookback_window, as: 'clicksLookbackWindow' property :impressions_lookback_window, as: 'impressionsLookbackWindow' property :include_attributed_ip_conversions, as: 'includeAttributedIPConversions' property :include_unattributed_cookie_conversions, as: 'includeUnattributedCookieConversions' property :include_unattributed_ip_conversions, as: 'includeUnattributedIPConversions' property :maximum_click_interactions, as: 'maximumClickInteractions' property :maximum_impression_interactions, as: 'maximumImpressionInteractions' property :maximum_interaction_gap, as: 'maximumInteractionGap' property :pivot_on_interaction_path, as: 'pivotOnInteractionPath' end end end class ReachCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation property :activities, as: 'activities', class: Google::Apis::DfareportingV3_0::Activities, decorator: Google::Apis::DfareportingV3_0::Activities::Representation property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_0::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV3_0::CustomRichMediaEvents::Representation property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation property :enable_all_dimension_combinations, as: 'enableAllDimensionCombinations' collection :metric_names, as: 'metricNames' collection :reach_by_frequency_metric_names, as: 'reachByFrequencyMetricNames' end end class Schedule # @private class Representation < Google::Apis::Core::JsonRepresentation property :active, as: 'active' property :every, as: 'every' property :expiration_date, as: 'expirationDate', type: Date property :repeats, as: 'repeats' collection :repeats_on_week_days, as: 'repeatsOnWeekDays' property :runs_on_day_of_month, as: 'runsOnDayOfMonth' property :start_date, as: 'startDate', type: Date end end end class ReportCompatibleFields # @private class Representation < Google::Apis::Core::JsonRepresentation collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation property :kind, as: 'kind' collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation end end class ReportList # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::DfareportingV3_0::Report, decorator: Google::Apis::DfareportingV3_0::Report::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class ReportsConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :exposure_to_conversion_enabled, as: 'exposureToConversionEnabled' property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_0::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_0::LookbackConfiguration::Representation property :report_generation_time_zone_id, :numeric_string => true, as: 'reportGenerationTimeZoneId' end end class RichMediaExitOverride # @private class Representation < Google::Apis::Core::JsonRepresentation property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_0::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrl::Representation property :enabled, as: 'enabled' property :exit_id, :numeric_string => true, as: 'exitId' end end class Rule # @private class Representation < Google::Apis::Core::JsonRepresentation property :asset_id, :numeric_string => true, as: 'assetId' property :name, as: 'name' property :targeting_template_id, :numeric_string => true, as: 'targetingTemplateId' end end class Site # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :approved, as: 'approved' property :directory_site_id, :numeric_string => true, as: 'directorySiteId' property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :key_name, as: 'keyName' property :kind, as: 'kind' property :name, as: 'name' collection :site_contacts, as: 'siteContacts', class: Google::Apis::DfareportingV3_0::SiteContact, decorator: Google::Apis::DfareportingV3_0::SiteContact::Representation property :site_settings, as: 'siteSettings', class: Google::Apis::DfareportingV3_0::SiteSettings, decorator: Google::Apis::DfareportingV3_0::SiteSettings::Representation property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class SiteContact # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address' property :contact_type, as: 'contactType' property :email, as: 'email' property :first_name, as: 'firstName' property :id, :numeric_string => true, as: 'id' property :last_name, as: 'lastName' property :phone, as: 'phone' property :title, as: 'title' end end class SiteSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :active_view_opt_out, as: 'activeViewOptOut' property :ad_blocking_opt_out, as: 'adBlockingOptOut' property :creative_settings, as: 'creativeSettings', class: Google::Apis::DfareportingV3_0::CreativeSettings, decorator: Google::Apis::DfareportingV3_0::CreativeSettings::Representation property :disable_new_cookie, as: 'disableNewCookie' property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_0::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_0::LookbackConfiguration::Representation property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV3_0::TagSetting, decorator: Google::Apis::DfareportingV3_0::TagSetting::Representation property :video_active_view_opt_out_template, as: 'videoActiveViewOptOutTemplate' property :vpaid_adapter_choice_template, as: 'vpaidAdapterChoiceTemplate' end end class SitesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :sites, as: 'sites', class: Google::Apis::DfareportingV3_0::Site, decorator: Google::Apis::DfareportingV3_0::Site::Representation end end class Size # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :iab, as: 'iab' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :width, as: 'width' end end class SizesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :sizes, as: 'sizes', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation end end class SkippableSetting # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV3_0::VideoOffset, decorator: Google::Apis::DfareportingV3_0::VideoOffset::Representation property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV3_0::VideoOffset, decorator: Google::Apis::DfareportingV3_0::VideoOffset::Representation property :skippable, as: 'skippable' end end class SortedDimension # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :name, as: 'name' property :sort_order, as: 'sortOrder' end end class Subaccount # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' collection :available_permission_ids, as: 'availablePermissionIds' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class SubaccountsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :subaccounts, as: 'subaccounts', class: Google::Apis::DfareportingV3_0::Subaccount, decorator: Google::Apis::DfareportingV3_0::Subaccount::Representation end end class TagData # @private class Representation < Google::Apis::Core::JsonRepresentation property :ad_id, :numeric_string => true, as: 'adId' property :click_tag, as: 'clickTag' property :creative_id, :numeric_string => true, as: 'creativeId' property :format, as: 'format' property :impression_tag, as: 'impressionTag' end end class TagSetting # @private class Representation < Google::Apis::Core::JsonRepresentation property :additional_key_values, as: 'additionalKeyValues' property :include_click_through_urls, as: 'includeClickThroughUrls' property :include_click_tracking, as: 'includeClickTracking' property :keyword_option, as: 'keywordOption' end end class TagSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :dynamic_tag_enabled, as: 'dynamicTagEnabled' property :image_tag_enabled, as: 'imageTagEnabled' end end class TargetWindow # @private class Representation < Google::Apis::Core::JsonRepresentation property :custom_html, as: 'customHtml' property :target_window_option, as: 'targetWindowOption' end end class TargetableRemarketingList # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :active, as: 'active' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :life_span, :numeric_string => true, as: 'lifeSpan' property :list_size, :numeric_string => true, as: 'listSize' property :list_source, as: 'listSource' property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class TargetableRemarketingListsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :targetable_remarketing_lists, as: 'targetableRemarketingLists', class: Google::Apis::DfareportingV3_0::TargetableRemarketingList, decorator: Google::Apis::DfareportingV3_0::TargetableRemarketingList::Representation end end class TargetingTemplate # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :advertiser_id, :numeric_string => true, as: 'advertiserId' property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV3_0::DayPartTargeting, decorator: Google::Apis::DfareportingV3_0::DayPartTargeting::Representation property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV3_0::GeoTargeting, decorator: Google::Apis::DfareportingV3_0::GeoTargeting::Representation property :id, :numeric_string => true, as: 'id' property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV3_0::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV3_0::KeyValueTargetingExpression::Representation property :kind, as: 'kind' property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV3_0::LanguageTargeting, decorator: Google::Apis::DfareportingV3_0::LanguageTargeting::Representation property :list_targeting_expression, as: 'listTargetingExpression', class: Google::Apis::DfareportingV3_0::ListTargetingExpression, decorator: Google::Apis::DfareportingV3_0::ListTargetingExpression::Representation property :name, as: 'name' property :subaccount_id, :numeric_string => true, as: 'subaccountId' property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV3_0::TechnologyTargeting, decorator: Google::Apis::DfareportingV3_0::TechnologyTargeting::Representation end end class TargetingTemplatesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :targeting_templates, as: 'targetingTemplates', class: Google::Apis::DfareportingV3_0::TargetingTemplate, decorator: Google::Apis::DfareportingV3_0::TargetingTemplate::Representation end end class TechnologyTargeting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :browsers, as: 'browsers', class: Google::Apis::DfareportingV3_0::Browser, decorator: Google::Apis::DfareportingV3_0::Browser::Representation collection :connection_types, as: 'connectionTypes', class: Google::Apis::DfareportingV3_0::ConnectionType, decorator: Google::Apis::DfareportingV3_0::ConnectionType::Representation collection :mobile_carriers, as: 'mobileCarriers', class: Google::Apis::DfareportingV3_0::MobileCarrier, decorator: Google::Apis::DfareportingV3_0::MobileCarrier::Representation collection :operating_system_versions, as: 'operatingSystemVersions', class: Google::Apis::DfareportingV3_0::OperatingSystemVersion, decorator: Google::Apis::DfareportingV3_0::OperatingSystemVersion::Representation collection :operating_systems, as: 'operatingSystems', class: Google::Apis::DfareportingV3_0::OperatingSystem, decorator: Google::Apis::DfareportingV3_0::OperatingSystem::Representation collection :platform_types, as: 'platformTypes', class: Google::Apis::DfareportingV3_0::PlatformType, decorator: Google::Apis::DfareportingV3_0::PlatformType::Representation end end class ThirdPartyAuthenticationToken # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :value, as: 'value' end end class ThirdPartyTrackingUrl # @private class Representation < Google::Apis::Core::JsonRepresentation property :third_party_url_type, as: 'thirdPartyUrlType' property :url, as: 'url' end end class TranscodeSetting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :enabled_video_formats, as: 'enabledVideoFormats' property :kind, as: 'kind' end end class UniversalAdId # @private class Representation < Google::Apis::Core::JsonRepresentation property :registry, as: 'registry' property :value, as: 'value' end end class UserDefinedVariableConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation property :data_type, as: 'dataType' property :report_name, as: 'reportName' property :variable_type, as: 'variableType' end end class UserProfile # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :account_name, as: 'accountName' property :etag, as: 'etag' property :kind, as: 'kind' property :profile_id, :numeric_string => true, as: 'profileId' property :sub_account_id, :numeric_string => true, as: 'subAccountId' property :sub_account_name, as: 'subAccountName' property :user_name, as: 'userName' end end class UserProfileList # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::DfareportingV3_0::UserProfile, decorator: Google::Apis::DfareportingV3_0::UserProfile::Representation property :kind, as: 'kind' end end class UserRole # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :default_user_role, as: 'defaultUserRole' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :parent_user_role_id, :numeric_string => true, as: 'parentUserRoleId' collection :permissions, as: 'permissions', class: Google::Apis::DfareportingV3_0::UserRolePermission, decorator: Google::Apis::DfareportingV3_0::UserRolePermission::Representation property :subaccount_id, :numeric_string => true, as: 'subaccountId' end end class UserRolePermission # @private class Representation < Google::Apis::Core::JsonRepresentation property :availability, as: 'availability' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :permission_group_id, :numeric_string => true, as: 'permissionGroupId' end end class UserRolePermissionGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' end end class UserRolePermissionGroupsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :user_role_permission_groups, as: 'userRolePermissionGroups', class: Google::Apis::DfareportingV3_0::UserRolePermissionGroup, decorator: Google::Apis::DfareportingV3_0::UserRolePermissionGroup::Representation end end class UserRolePermissionsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :user_role_permissions, as: 'userRolePermissions', class: Google::Apis::DfareportingV3_0::UserRolePermission, decorator: Google::Apis::DfareportingV3_0::UserRolePermission::Representation end end class UserRolesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' collection :user_roles, as: 'userRoles', class: Google::Apis::DfareportingV3_0::UserRole, decorator: Google::Apis::DfareportingV3_0::UserRole::Representation end end class VideoFormat # @private class Representation < Google::Apis::Core::JsonRepresentation property :file_type, as: 'fileType' property :id, as: 'id' property :kind, as: 'kind' property :resolution, as: 'resolution', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation property :target_bit_rate, as: 'targetBitRate' end end class VideoFormatsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' collection :video_formats, as: 'videoFormats', class: Google::Apis::DfareportingV3_0::VideoFormat, decorator: Google::Apis::DfareportingV3_0::VideoFormat::Representation end end class VideoOffset # @private class Representation < Google::Apis::Core::JsonRepresentation property :offset_percentage, as: 'offsetPercentage' property :offset_seconds, as: 'offsetSeconds' end end class VideoSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :companion_settings, as: 'companionSettings', class: Google::Apis::DfareportingV3_0::CompanionSetting, decorator: Google::Apis::DfareportingV3_0::CompanionSetting::Representation property :kind, as: 'kind' property :orientation, as: 'orientation' property :skippable_settings, as: 'skippableSettings', class: Google::Apis::DfareportingV3_0::SkippableSetting, decorator: Google::Apis::DfareportingV3_0::SkippableSetting::Representation property :transcode_settings, as: 'transcodeSettings', class: Google::Apis::DfareportingV3_0::TranscodeSetting, decorator: Google::Apis::DfareportingV3_0::TranscodeSetting::Representation end end end end end google-api-client-0.19.8/generated/google/apis/dfareporting_v3_0/classes.rb0000644000004100000410000175755713252673043026643 0ustar www-datawww-data# 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 DfareportingV3_0 # Contains properties of a DCM account. class Account include Google::Apis::Core::Hashable # Account permissions assigned to this account. # Corresponds to the JSON property `accountPermissionIds` # @return [Array] attr_accessor :account_permission_ids # Profile for this account. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountProfile` # @return [String] attr_accessor :account_profile # Whether this account is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Maximum number of active ads allowed for this account. # Corresponds to the JSON property `activeAdsLimitTier` # @return [String] attr_accessor :active_ads_limit_tier # Whether to serve creatives with Active View tags. If disabled, viewability # data will not be available for any impressions. # Corresponds to the JSON property `activeViewOptOut` # @return [Boolean] attr_accessor :active_view_opt_out alias_method :active_view_opt_out?, :active_view_opt_out # User role permissions available to the user roles of this account. # Corresponds to the JSON property `availablePermissionIds` # @return [Array] attr_accessor :available_permission_ids # ID of the country associated with this account. # Corresponds to the JSON property `countryId` # @return [Fixnum] attr_accessor :country_id # ID of currency associated with this account. This is a required field. # Acceptable values are: # - "1" for USD # - "2" for GBP # - "3" for ESP # - "4" for SEK # - "5" for CAD # - "6" for JPY # - "7" for DEM # - "8" for AUD # - "9" for FRF # - "10" for ITL # - "11" for DKK # - "12" for NOK # - "13" for FIM # - "14" for ZAR # - "15" for IEP # - "16" for NLG # - "17" for EUR # - "18" for KRW # - "19" for TWD # - "20" for SGD # - "21" for CNY # - "22" for HKD # - "23" for NZD # - "24" for MYR # - "25" for BRL # - "26" for PTE # - "27" for MXP # - "28" for CLP # - "29" for TRY # - "30" for ARS # - "31" for PEN # - "32" for ILS # - "33" for CHF # - "34" for VEF # - "35" for COP # - "36" for GTQ # - "37" for PLN # - "39" for INR # - "40" for THB # - "41" for IDR # - "42" for CZK # - "43" for RON # - "44" for HUF # - "45" for RUB # - "46" for AED # - "47" for BGN # - "48" for HRK # - "49" for MXN # - "50" for NGN # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id # Default placement dimensions for this account. # Corresponds to the JSON property `defaultCreativeSizeId` # @return [Fixnum] attr_accessor :default_creative_size_id # Description of this account. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # ID of this account. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#account". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Locale of this account. # Acceptable values are: # - "cs" (Czech) # - "de" (German) # - "en" (English) # - "en-GB" (English United Kingdom) # - "es" (Spanish) # - "fr" (French) # - "it" (Italian) # - "ja" (Japanese) # - "ko" (Korean) # - "pl" (Polish) # - "pt-BR" (Portuguese Brazil) # - "ru" (Russian) # - "sv" (Swedish) # - "tr" (Turkish) # - "zh-CN" (Chinese Simplified) # - "zh-TW" (Chinese Traditional) # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # Maximum image size allowed for this account, in kilobytes. Value must be # greater than or equal to 1. # Corresponds to the JSON property `maximumImageSize` # @return [Fixnum] attr_accessor :maximum_image_size # Name of this account. This is a required field, and must be less than 128 # characters long and be globally unique. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether campaigns created in this account will be enabled for Nielsen OCR # reach ratings by default. # Corresponds to the JSON property `nielsenOcrEnabled` # @return [Boolean] attr_accessor :nielsen_ocr_enabled alias_method :nielsen_ocr_enabled?, :nielsen_ocr_enabled # Reporting Configuration # Corresponds to the JSON property `reportsConfiguration` # @return [Google::Apis::DfareportingV3_0::ReportsConfiguration] attr_accessor :reports_configuration # Share Path to Conversion reports with Twitter. # Corresponds to the JSON property `shareReportsWithTwitter` # @return [Boolean] attr_accessor :share_reports_with_twitter alias_method :share_reports_with_twitter?, :share_reports_with_twitter # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values # are 1 to 10240, inclusive. # Corresponds to the JSON property `teaserSizeLimit` # @return [Fixnum] attr_accessor :teaser_size_limit def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_permission_ids = args[:account_permission_ids] if args.key?(:account_permission_ids) @account_profile = args[:account_profile] if args.key?(:account_profile) @active = args[:active] if args.key?(:active) @active_ads_limit_tier = args[:active_ads_limit_tier] if args.key?(:active_ads_limit_tier) @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) @available_permission_ids = args[:available_permission_ids] if args.key?(:available_permission_ids) @country_id = args[:country_id] if args.key?(:country_id) @currency_id = args[:currency_id] if args.key?(:currency_id) @default_creative_size_id = args[:default_creative_size_id] if args.key?(:default_creative_size_id) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @locale = args[:locale] if args.key?(:locale) @maximum_image_size = args[:maximum_image_size] if args.key?(:maximum_image_size) @name = args[:name] if args.key?(:name) @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] if args.key?(:nielsen_ocr_enabled) @reports_configuration = args[:reports_configuration] if args.key?(:reports_configuration) @share_reports_with_twitter = args[:share_reports_with_twitter] if args.key?(:share_reports_with_twitter) @teaser_size_limit = args[:teaser_size_limit] if args.key?(:teaser_size_limit) end end # Gets a summary of active ads in an account. class AccountActiveAdSummary include Google::Apis::Core::Hashable # ID of the account. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Ads that have been activated for the account # Corresponds to the JSON property `activeAds` # @return [Fixnum] attr_accessor :active_ads # Maximum number of active ads allowed for the account. # Corresponds to the JSON property `activeAdsLimitTier` # @return [String] attr_accessor :active_ads_limit_tier # Ads that can be activated for the account. # Corresponds to the JSON property `availableAds` # @return [Fixnum] attr_accessor :available_ads # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountActiveAdSummary". # 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) @account_id = args[:account_id] if args.key?(:account_id) @active_ads = args[:active_ads] if args.key?(:active_ads) @active_ads_limit_tier = args[:active_ads_limit_tier] if args.key?(:active_ads_limit_tier) @available_ads = args[:available_ads] if args.key?(:available_ads) @kind = args[:kind] if args.key?(:kind) end end # AccountPermissions contains information about a particular account permission. # Some features of DCM require an account permission to be present in the # account. class AccountPermission include Google::Apis::Core::Hashable # Account profiles associated with this account permission. # Possible values are: # - "ACCOUNT_PROFILE_BASIC" # - "ACCOUNT_PROFILE_STANDARD" # Corresponds to the JSON property `accountProfiles` # @return [Array] attr_accessor :account_profiles # ID of this account permission. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountPermission". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Administrative level required to enable this account permission. # Corresponds to the JSON property `level` # @return [String] attr_accessor :level # Name of this account permission. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Permission group of this account permission. # Corresponds to the JSON property `permissionGroupId` # @return [Fixnum] attr_accessor :permission_group_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_profiles = args[:account_profiles] if args.key?(:account_profiles) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @level = args[:level] if args.key?(:level) @name = args[:name] if args.key?(:name) @permission_group_id = args[:permission_group_id] if args.key?(:permission_group_id) end end # AccountPermissionGroups contains a mapping of permission group IDs to names. A # permission group is a grouping of account permissions. class AccountPermissionGroup include Google::Apis::Core::Hashable # ID of this account permission group. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountPermissionGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this account permission 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Account Permission Group List Response class AccountPermissionGroupsListResponse include Google::Apis::Core::Hashable # Account permission group collection. # Corresponds to the JSON property `accountPermissionGroups` # @return [Array] attr_accessor :account_permission_groups # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountPermissionGroupsListResponse". # 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) @account_permission_groups = args[:account_permission_groups] if args.key?(:account_permission_groups) @kind = args[:kind] if args.key?(:kind) end end # Account Permission List Response class AccountPermissionsListResponse include Google::Apis::Core::Hashable # Account permission collection. # Corresponds to the JSON property `accountPermissions` # @return [Array] attr_accessor :account_permissions # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountPermissionsListResponse". # 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) @account_permissions = args[:account_permissions] if args.key?(:account_permissions) @kind = args[:kind] if args.key?(:kind) end end # AccountUserProfiles contains properties of a DCM user profile. This resource # is specifically for managing user profiles, whereas UserProfiles is for # accessing the API. class AccountUserProfile include Google::Apis::Core::Hashable # Account ID of the user profile. This is a read-only field that can be left # blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this user profile is active. This defaults to false, and must be set # true on insert for the user profile to be usable. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Object Filter. # Corresponds to the JSON property `advertiserFilter` # @return [Google::Apis::DfareportingV3_0::ObjectFilter] attr_accessor :advertiser_filter # Object Filter. # Corresponds to the JSON property `campaignFilter` # @return [Google::Apis::DfareportingV3_0::ObjectFilter] attr_accessor :campaign_filter # Comments for this user profile. # Corresponds to the JSON property `comments` # @return [String] attr_accessor :comments # Email of the user profile. The email addresss must be linked to a Google # Account. This field is required on insertion and is read-only after insertion. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # ID of the user profile. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountUserProfile". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Locale of the user profile. This is a required field. # Acceptable values are: # - "cs" (Czech) # - "de" (German) # - "en" (English) # - "en-GB" (English United Kingdom) # - "es" (Spanish) # - "fr" (French) # - "it" (Italian) # - "ja" (Japanese) # - "ko" (Korean) # - "pl" (Polish) # - "pt-BR" (Portuguese Brazil) # - "ru" (Russian) # - "sv" (Swedish) # - "tr" (Turkish) # - "zh-CN" (Chinese Simplified) # - "zh-TW" (Chinese Traditional) # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale # Name of the user profile. This is a required field. Must be less than 64 # characters long, must be globally unique, and cannot contain whitespace or any # of the following characters: "&;"#%,". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Object Filter. # Corresponds to the JSON property `siteFilter` # @return [Google::Apis::DfareportingV3_0::ObjectFilter] attr_accessor :site_filter # Subaccount ID of the user profile. This is a read-only field that can be left # blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Trafficker type of this user profile. # Corresponds to the JSON property `traffickerType` # @return [String] attr_accessor :trafficker_type # User type of the user profile. This is a read-only field that can be left # blank. # Corresponds to the JSON property `userAccessType` # @return [String] attr_accessor :user_access_type # Object Filter. # Corresponds to the JSON property `userRoleFilter` # @return [Google::Apis::DfareportingV3_0::ObjectFilter] attr_accessor :user_role_filter # User role ID of the user profile. This is a required field. # Corresponds to the JSON property `userRoleId` # @return [Fixnum] attr_accessor :user_role_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @advertiser_filter = args[:advertiser_filter] if args.key?(:advertiser_filter) @campaign_filter = args[:campaign_filter] if args.key?(:campaign_filter) @comments = args[:comments] if args.key?(:comments) @email = args[:email] if args.key?(:email) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @locale = args[:locale] if args.key?(:locale) @name = args[:name] if args.key?(:name) @site_filter = args[:site_filter] if args.key?(:site_filter) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @trafficker_type = args[:trafficker_type] if args.key?(:trafficker_type) @user_access_type = args[:user_access_type] if args.key?(:user_access_type) @user_role_filter = args[:user_role_filter] if args.key?(:user_role_filter) @user_role_id = args[:user_role_id] if args.key?(:user_role_id) end end # Account User Profile List Response class AccountUserProfilesListResponse include Google::Apis::Core::Hashable # Account user profile collection. # Corresponds to the JSON property `accountUserProfiles` # @return [Array] attr_accessor :account_user_profiles # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountUserProfilesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @account_user_profiles = args[:account_user_profiles] if args.key?(:account_user_profiles) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Account List Response class AccountsListResponse include Google::Apis::Core::Hashable # Account collection. # Corresponds to the JSON property `accounts` # @return [Array] attr_accessor :accounts # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#accountsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @accounts = args[:accounts] if args.key?(:accounts) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Represents an activity group. class Activities include Google::Apis::Core::Hashable # List of activity filters. The dimension values need to be all either of type " # dfa:activity" or "dfa:activityGroup". # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters # The kind of resource this is, in this case dfareporting#activities. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # List of names of floodlight activity metrics. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filters = args[:filters] if args.key?(:filters) @kind = args[:kind] if args.key?(:kind) @metric_names = args[:metric_names] if args.key?(:metric_names) end end # Contains properties of a DCM ad. class Ad include Google::Apis::Core::Hashable # Account ID of this ad. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this ad is active. When true, archived must be false. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Advertiser ID of this ad. This is a required field on insertion. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Whether this ad is archived. When true, active must be false. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # Audience segment ID that is being targeted for this ad. Applicable when type # is AD_SERVING_STANDARD_AD. # Corresponds to the JSON property `audienceSegmentId` # @return [Fixnum] attr_accessor :audience_segment_id # Campaign ID of this ad. This is a required field on insertion. # Corresponds to the JSON property `campaignId` # @return [Fixnum] attr_accessor :campaign_id # Represents a DimensionValue resource. # Corresponds to the JSON property `campaignIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :campaign_id_dimension_value # Click-through URL # Corresponds to the JSON property `clickThroughUrl` # @return [Google::Apis::DfareportingV3_0::ClickThroughUrl] attr_accessor :click_through_url # Click Through URL Suffix settings. # Corresponds to the JSON property `clickThroughUrlSuffixProperties` # @return [Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties] attr_accessor :click_through_url_suffix_properties # Comments for this ad. # Corresponds to the JSON property `comments` # @return [String] attr_accessor :comments # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. # DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on # mobile devices or in mobile apps for regular or interstitial ads, respectively. # APP and APP_INTERSTITIAL are only used for existing default ads. New mobile # placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads # created for those placements will be limited to those compatibility types. # IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the # VAST standard. # Corresponds to the JSON property `compatibility` # @return [String] attr_accessor :compatibility # Modification timestamp. # Corresponds to the JSON property `createInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :create_info # Creative group assignments for this ad. Applicable when type is # AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is # allowed for a maximum of two assignments. # Corresponds to the JSON property `creativeGroupAssignments` # @return [Array] attr_accessor :creative_group_assignments # Creative Rotation. # Corresponds to the JSON property `creativeRotation` # @return [Google::Apis::DfareportingV3_0::CreativeRotation] attr_accessor :creative_rotation # Day Part Targeting. # Corresponds to the JSON property `dayPartTargeting` # @return [Google::Apis::DfareportingV3_0::DayPartTargeting] attr_accessor :day_part_targeting # Properties of inheriting and overriding the default click-through event tag. A # campaign may override the event tag defined at the advertiser level, and an ad # may also override the campaign's setting further. # Corresponds to the JSON property `defaultClickThroughEventTagProperties` # @return [Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties] attr_accessor :default_click_through_event_tag_properties # Delivery Schedule. # Corresponds to the JSON property `deliverySchedule` # @return [Google::Apis::DfareportingV3_0::DeliverySchedule] attr_accessor :delivery_schedule # Whether this ad is a dynamic click tracker. Applicable when type is # AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only # after insert. # Corresponds to the JSON property `dynamicClickTracker` # @return [Boolean] attr_accessor :dynamic_click_tracker alias_method :dynamic_click_tracker?, :dynamic_click_tracker # Date and time that this ad should stop serving. Must be later than the start # time. This is a required field on insertion. # Corresponds to the JSON property `endTime` # @return [DateTime] attr_accessor :end_time # Event tag overrides for this ad. # Corresponds to the JSON property `eventTagOverrides` # @return [Array] attr_accessor :event_tag_overrides # Geographical Targeting. # Corresponds to the JSON property `geoTargeting` # @return [Google::Apis::DfareportingV3_0::GeoTargeting] attr_accessor :geo_targeting # ID of this ad. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Key Value Targeting Expression. # Corresponds to the JSON property `keyValueTargetingExpression` # @return [Google::Apis::DfareportingV3_0::KeyValueTargetingExpression] attr_accessor :key_value_targeting_expression # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#ad". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Language Targeting. # Corresponds to the JSON property `languageTargeting` # @return [Google::Apis::DfareportingV3_0::LanguageTargeting] attr_accessor :language_targeting # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :last_modified_info # Name of this ad. This is a required field and must be less than 256 characters # long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Placement assignments for this ad. # Corresponds to the JSON property `placementAssignments` # @return [Array] attr_accessor :placement_assignments # Remarketing List Targeting Expression. # Corresponds to the JSON property `remarketingListExpression` # @return [Google::Apis::DfareportingV3_0::ListTargetingExpression] attr_accessor :remarketing_list_expression # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `size` # @return [Google::Apis::DfareportingV3_0::Size] attr_accessor :size # Whether this ad is ssl compliant. This is a read-only field that is auto- # generated when the ad is inserted or updated. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Whether this ad requires ssl. This is a read-only field that is auto-generated # when the ad is inserted or updated. # Corresponds to the JSON property `sslRequired` # @return [Boolean] attr_accessor :ssl_required alias_method :ssl_required?, :ssl_required # Date and time that this ad should start serving. If creating an ad, this field # must be a time in the future. This is a required field on insertion. # Corresponds to the JSON property `startTime` # @return [DateTime] attr_accessor :start_time # Subaccount ID of this ad. This is a read-only field that can be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Targeting template ID, used to apply preconfigured targeting information to # this ad. This cannot be set while any of dayPartTargeting, geoTargeting, # keyValueTargetingExpression, languageTargeting, remarketingListExpression, or # technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. # Corresponds to the JSON property `targetingTemplateId` # @return [Fixnum] attr_accessor :targeting_template_id # Technology Targeting. # Corresponds to the JSON property `technologyTargeting` # @return [Google::Apis::DfareportingV3_0::TechnologyTargeting] attr_accessor :technology_targeting # Type of ad. This is a required field on insertion. Note that default ads ( # AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). # 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) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @archived = args[:archived] if args.key?(:archived) @audience_segment_id = args[:audience_segment_id] if args.key?(:audience_segment_id) @campaign_id = args[:campaign_id] if args.key?(:campaign_id) @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties) @comments = args[:comments] if args.key?(:comments) @compatibility = args[:compatibility] if args.key?(:compatibility) @create_info = args[:create_info] if args.key?(:create_info) @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments) @creative_rotation = args[:creative_rotation] if args.key?(:creative_rotation) @day_part_targeting = args[:day_part_targeting] if args.key?(:day_part_targeting) @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties) @delivery_schedule = args[:delivery_schedule] if args.key?(:delivery_schedule) @dynamic_click_tracker = args[:dynamic_click_tracker] if args.key?(:dynamic_click_tracker) @end_time = args[:end_time] if args.key?(:end_time) @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides) @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @key_value_targeting_expression = args[:key_value_targeting_expression] if args.key?(:key_value_targeting_expression) @kind = args[:kind] if args.key?(:kind) @language_targeting = args[:language_targeting] if args.key?(:language_targeting) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @name = args[:name] if args.key?(:name) @placement_assignments = args[:placement_assignments] if args.key?(:placement_assignments) @remarketing_list_expression = args[:remarketing_list_expression] if args.key?(:remarketing_list_expression) @size = args[:size] if args.key?(:size) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @ssl_required = args[:ssl_required] if args.key?(:ssl_required) @start_time = args[:start_time] if args.key?(:start_time) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @targeting_template_id = args[:targeting_template_id] if args.key?(:targeting_template_id) @technology_targeting = args[:technology_targeting] if args.key?(:technology_targeting) @type = args[:type] if args.key?(:type) end end # Campaign ad blocking settings. class AdBlockingConfiguration include Google::Apis::Core::Hashable # Click-through URL used by brand-neutral ads. This is a required field when # overrideClickThroughUrl is set to true. # Corresponds to the JSON property `clickThroughUrl` # @return [String] attr_accessor :click_through_url # ID of a creative bundle to use for this campaign. If set, brand-neutral ads # will select creatives from this bundle. Otherwise, a default transparent pixel # will be used. # Corresponds to the JSON property `creativeBundleId` # @return [Fixnum] attr_accessor :creative_bundle_id # Whether this campaign has enabled ad blocking. When true, ad blocking is # enabled for placements in the campaign, but this may be overridden by site and # placement settings. When false, ad blocking is disabled for all placements # under the campaign, regardless of site and placement settings. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # Whether the brand-neutral ad's click-through URL comes from the campaign's # creative bundle or the override URL. Must be set to true if ad blocking is # enabled and no creative bundle is configured. # Corresponds to the JSON property `overrideClickThroughUrl` # @return [Boolean] attr_accessor :override_click_through_url alias_method :override_click_through_url?, :override_click_through_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @creative_bundle_id = args[:creative_bundle_id] if args.key?(:creative_bundle_id) @enabled = args[:enabled] if args.key?(:enabled) @override_click_through_url = args[:override_click_through_url] if args.key?(:override_click_through_url) end end # Ad Slot class AdSlot include Google::Apis::Core::Hashable # Comment for this ad slot. # Corresponds to the JSON property `comment` # @return [String] attr_accessor :comment # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering # either on desktop, mobile devices or in mobile apps for regular or # interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in # mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads # developed with the VAST standard. # Corresponds to the JSON property `compatibility` # @return [String] attr_accessor :compatibility # Height of this ad slot. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # ID of the placement from an external platform that is linked to this ad slot. # Corresponds to the JSON property `linkedPlacementId` # @return [Fixnum] attr_accessor :linked_placement_id # Name of this ad slot. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Payment source type of this ad slot. # Corresponds to the JSON property `paymentSourceType` # @return [String] attr_accessor :payment_source_type # Primary ad slot of a roadblock inventory item. # Corresponds to the JSON property `primary` # @return [Boolean] attr_accessor :primary alias_method :primary?, :primary # Width of this ad slot. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @comment = args[:comment] if args.key?(:comment) @compatibility = args[:compatibility] if args.key?(:compatibility) @height = args[:height] if args.key?(:height) @linked_placement_id = args[:linked_placement_id] if args.key?(:linked_placement_id) @name = args[:name] if args.key?(:name) @payment_source_type = args[:payment_source_type] if args.key?(:payment_source_type) @primary = args[:primary] if args.key?(:primary) @width = args[:width] if args.key?(:width) end end # Ad List Response class AdsListResponse include Google::Apis::Core::Hashable # Ad collection. # Corresponds to the JSON property `ads` # @return [Array] attr_accessor :ads # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#adsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @ads = args[:ads] if args.key?(:ads) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Contains properties of a DCM advertiser. class Advertiser include Google::Apis::Core::Hashable # Account ID of this advertiser.This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # ID of the advertiser group this advertiser belongs to. You can group # advertisers for reporting purposes, allowing you to see aggregated information # for all advertisers in each group. # Corresponds to the JSON property `advertiserGroupId` # @return [Fixnum] attr_accessor :advertiser_group_id # Suffix added to click-through URL of ad creative associations under this # advertiser. Must be less than 129 characters long. # Corresponds to the JSON property `clickThroughUrlSuffix` # @return [String] attr_accessor :click_through_url_suffix # ID of the click-through event tag to apply by default to the landing pages of # this advertiser's campaigns. # Corresponds to the JSON property `defaultClickThroughEventTagId` # @return [Fixnum] attr_accessor :default_click_through_event_tag_id # Default email address used in sender field for tag emails. # Corresponds to the JSON property `defaultEmail` # @return [String] attr_accessor :default_email # Floodlight configuration ID of this advertiser. The floodlight configuration # ID will be created automatically, so on insert this field should be left blank. # This field can be set to another advertiser's floodlight configuration ID in # order to share that advertiser's floodlight configuration with this advertiser, # so long as: # - This advertiser's original floodlight configuration is not already # associated with floodlight activities or floodlight activity groups. # - This advertiser's original floodlight configuration is not already shared # with another advertiser. # Corresponds to the JSON property `floodlightConfigurationId` # @return [Fixnum] attr_accessor :floodlight_configuration_id # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :floodlight_configuration_id_dimension_value # ID of this advertiser. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#advertiser". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this advertiser. This is a required field and must be less than 256 # characters long and unique among advertisers of the same account. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Original floodlight configuration before any sharing occurred. Set the # floodlightConfigurationId of this advertiser to # originalFloodlightConfigurationId to unshare the advertiser's current # floodlight configuration. You cannot unshare an advertiser's floodlight # configuration if the shared configuration has activities associated with any # campaign or placement. # Corresponds to the JSON property `originalFloodlightConfigurationId` # @return [Fixnum] attr_accessor :original_floodlight_configuration_id # Status of this advertiser. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Subaccount ID of this advertiser.This is a read-only field that can be left # blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Suspension status of this advertiser. # Corresponds to the JSON property `suspended` # @return [Boolean] attr_accessor :suspended alias_method :suspended?, :suspended def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id) @click_through_url_suffix = args[:click_through_url_suffix] if args.key?(:click_through_url_suffix) @default_click_through_event_tag_id = args[:default_click_through_event_tag_id] if args.key?(:default_click_through_event_tag_id) @default_email = args[:default_email] if args.key?(:default_email) @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @original_floodlight_configuration_id = args[:original_floodlight_configuration_id] if args.key?(:original_floodlight_configuration_id) @status = args[:status] if args.key?(:status) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @suspended = args[:suspended] if args.key?(:suspended) end end # Groups advertisers together so that reports can be generated for the entire # group at once. class AdvertiserGroup include Google::Apis::Core::Hashable # Account ID of this advertiser group. This is a read-only field that can be # left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # ID of this advertiser group. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#advertiserGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this advertiser group. This is a required field and must be less than # 256 characters long and unique among advertiser groups of the same account. # 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) @account_id = args[:account_id] if args.key?(:account_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Advertiser Group List Response class AdvertiserGroupsListResponse include Google::Apis::Core::Hashable # Advertiser group collection. # Corresponds to the JSON property `advertiserGroups` # @return [Array] attr_accessor :advertiser_groups # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#advertiserGroupsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @advertiser_groups = args[:advertiser_groups] if args.key?(:advertiser_groups) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Landing Page List Response class AdvertiserLandingPagesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#advertiserLandingPagesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Landing page collection # Corresponds to the JSON property `landingPages` # @return [Array] attr_accessor :landing_pages # Pagination token to be used for the next list operation. # 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) @kind = args[:kind] if args.key?(:kind) @landing_pages = args[:landing_pages] if args.key?(:landing_pages) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Advertiser List Response class AdvertisersListResponse include Google::Apis::Core::Hashable # Advertiser collection. # Corresponds to the JSON property `advertisers` # @return [Array] attr_accessor :advertisers # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#advertisersListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Audience Segment. class AudienceSegment include Google::Apis::Core::Hashable # Weight allocated to this segment. The weight assigned will be understood in # proportion to the weights assigned to other segments in the same segment group. # Acceptable values are 1 to 1000, inclusive. # Corresponds to the JSON property `allocation` # @return [Fixnum] attr_accessor :allocation # ID of this audience segment. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Name of this audience segment. This is a required field and must be less than # 65 characters long. # 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) @allocation = args[:allocation] if args.key?(:allocation) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) end end # Audience Segment Group. class AudienceSegmentGroup include Google::Apis::Core::Hashable # Audience segments assigned to this group. The number of segments must be # between 2 and 100. # Corresponds to the JSON property `audienceSegments` # @return [Array] attr_accessor :audience_segments # ID of this audience segment group. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Name of this audience segment group. This is a required field and must be less # than 65 characters long. # 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) @audience_segments = args[:audience_segments] if args.key?(:audience_segments) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) end end # Contains information about a browser that can be targeted by ads. class Browser include Google::Apis::Core::Hashable # ID referring to this grouping of browser and version numbers. This is the ID # used for targeting. # Corresponds to the JSON property `browserVersionId` # @return [Fixnum] attr_accessor :browser_version_id # DART ID of this browser. This is the ID used when generating reports. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#browser". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Major version number (leftmost number) of this browser. For example, for # Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be # used to target any version number, and a question mark (?) may be used to # target cases where the version number cannot be identified. For example, # Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* # targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad # server knows the browser is Firefox but can't tell which version it is. # Corresponds to the JSON property `majorVersion` # @return [String] attr_accessor :major_version # Minor version number (number after first dot on left) of this browser. For # example, for Chrome 5.0.375.86 beta, this field should be set to 0. An # asterisk (*) may be used to target any version number, and a question mark (?) # may be used to target cases where the version number cannot be identified. For # example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. # Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases # where the ad server knows the browser is Firefox but can't tell which version # it is. # Corresponds to the JSON property `minorVersion` # @return [String] attr_accessor :minor_version # Name of this browser. # 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) @browser_version_id = args[:browser_version_id] if args.key?(:browser_version_id) @dart_id = args[:dart_id] if args.key?(:dart_id) @kind = args[:kind] if args.key?(:kind) @major_version = args[:major_version] if args.key?(:major_version) @minor_version = args[:minor_version] if args.key?(:minor_version) @name = args[:name] if args.key?(:name) end end # Browser List Response class BrowsersListResponse include Google::Apis::Core::Hashable # Browser collection. # Corresponds to the JSON property `browsers` # @return [Array] attr_accessor :browsers # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#browsersListResponse". # 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) @browsers = args[:browsers] if args.key?(:browsers) @kind = args[:kind] if args.key?(:kind) end end # Contains properties of a DCM campaign. class Campaign include Google::Apis::Core::Hashable # Account ID of this campaign. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Campaign ad blocking settings. # Corresponds to the JSON property `adBlockingConfiguration` # @return [Google::Apis::DfareportingV3_0::AdBlockingConfiguration] attr_accessor :ad_blocking_configuration # Additional creative optimization configurations for the campaign. # Corresponds to the JSON property `additionalCreativeOptimizationConfigurations` # @return [Array] attr_accessor :additional_creative_optimization_configurations # Advertiser group ID of the associated advertiser. # Corresponds to the JSON property `advertiserGroupId` # @return [Fixnum] attr_accessor :advertiser_group_id # Advertiser ID of this campaign. This is a required field. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Whether this campaign has been archived. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # Audience segment groups assigned to this campaign. Cannot have more than 300 # segment groups. # Corresponds to the JSON property `audienceSegmentGroups` # @return [Array] attr_accessor :audience_segment_groups # Billing invoice code included in the DCM client billing invoices associated # with the campaign. # Corresponds to the JSON property `billingInvoiceCode` # @return [String] attr_accessor :billing_invoice_code # Click Through URL Suffix settings. # Corresponds to the JSON property `clickThroughUrlSuffixProperties` # @return [Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties] attr_accessor :click_through_url_suffix_properties # Arbitrary comments about this campaign. Must be less than 256 characters long. # Corresponds to the JSON property `comment` # @return [String] attr_accessor :comment # Modification timestamp. # Corresponds to the JSON property `createInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :create_info # List of creative group IDs that are assigned to the campaign. # Corresponds to the JSON property `creativeGroupIds` # @return [Array] attr_accessor :creative_group_ids # Creative optimization settings. # Corresponds to the JSON property `creativeOptimizationConfiguration` # @return [Google::Apis::DfareportingV3_0::CreativeOptimizationConfiguration] attr_accessor :creative_optimization_configuration # Properties of inheriting and overriding the default click-through event tag. A # campaign may override the event tag defined at the advertiser level, and an ad # may also override the campaign's setting further. # Corresponds to the JSON property `defaultClickThroughEventTagProperties` # @return [Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties] attr_accessor :default_click_through_event_tag_properties # The default landing page ID for this campaign. # Corresponds to the JSON property `defaultLandingPageId` # @return [Fixnum] attr_accessor :default_landing_page_id # Date on which the campaign will stop running. On insert, the end date must be # today or a future date. The end date must be later than or be the same as the # start date. If, for example, you set 6/25/2015 as both the start and end dates, # the effective campaign run date is just that day only, 6/25/2015. The hours, # minutes, and seconds of the end date should not be set, as doing so will # result in an error. This is a required field. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # Overrides that can be used to activate or deactivate advertiser event tags. # Corresponds to the JSON property `eventTagOverrides` # @return [Array] attr_accessor :event_tag_overrides # External ID for this campaign. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id # ID of this campaign. This is a read-only auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#campaign". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :last_modified_info # Lookback configuration settings. # Corresponds to the JSON property `lookbackConfiguration` # @return [Google::Apis::DfareportingV3_0::LookbackConfiguration] attr_accessor :lookback_configuration # Name of this campaign. This is a required field and must be less than 256 # characters long and unique among campaigns of the same advertiser. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether Nielsen reports are enabled for this campaign. # Corresponds to the JSON property `nielsenOcrEnabled` # @return [Boolean] attr_accessor :nielsen_ocr_enabled alias_method :nielsen_ocr_enabled?, :nielsen_ocr_enabled # Date on which the campaign starts running. The start date can be any date. The # hours, minutes, and seconds of the start date should not be set, as doing so # will result in an error. This is a required field. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date # Subaccount ID of this campaign. This is a read-only field that can be left # blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Campaign trafficker contact emails. # Corresponds to the JSON property `traffickerEmails` # @return [Array] attr_accessor :trafficker_emails def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @ad_blocking_configuration = args[:ad_blocking_configuration] if args.key?(:ad_blocking_configuration) @additional_creative_optimization_configurations = args[:additional_creative_optimization_configurations] if args.key?(:additional_creative_optimization_configurations) @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @archived = args[:archived] if args.key?(:archived) @audience_segment_groups = args[:audience_segment_groups] if args.key?(:audience_segment_groups) @billing_invoice_code = args[:billing_invoice_code] if args.key?(:billing_invoice_code) @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties) @comment = args[:comment] if args.key?(:comment) @create_info = args[:create_info] if args.key?(:create_info) @creative_group_ids = args[:creative_group_ids] if args.key?(:creative_group_ids) @creative_optimization_configuration = args[:creative_optimization_configuration] if args.key?(:creative_optimization_configuration) @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties) @default_landing_page_id = args[:default_landing_page_id] if args.key?(:default_landing_page_id) @end_date = args[:end_date] if args.key?(:end_date) @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides) @external_id = args[:external_id] if args.key?(:external_id) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @name = args[:name] if args.key?(:name) @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] if args.key?(:nielsen_ocr_enabled) @start_date = args[:start_date] if args.key?(:start_date) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @trafficker_emails = args[:trafficker_emails] if args.key?(:trafficker_emails) end end # Identifies a creative which has been associated with a given campaign. class CampaignCreativeAssociation include Google::Apis::Core::Hashable # ID of the creative associated with the campaign. This is a required field. # Corresponds to the JSON property `creativeId` # @return [Fixnum] attr_accessor :creative_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#campaignCreativeAssociation". # 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) @creative_id = args[:creative_id] if args.key?(:creative_id) @kind = args[:kind] if args.key?(:kind) end end # Campaign Creative Association List Response class CampaignCreativeAssociationsListResponse include Google::Apis::Core::Hashable # Campaign creative association collection # Corresponds to the JSON property `campaignCreativeAssociations` # @return [Array] attr_accessor :campaign_creative_associations # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#campaignCreativeAssociationsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @campaign_creative_associations = args[:campaign_creative_associations] if args.key?(:campaign_creative_associations) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Campaign List Response class CampaignsListResponse include Google::Apis::Core::Hashable # Campaign collection. # Corresponds to the JSON property `campaigns` # @return [Array] attr_accessor :campaigns # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#campaignsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Describes a change that a user has made to a resource. class ChangeLog include Google::Apis::Core::Hashable # Account ID of the modified object. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Action which caused the change. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Time when the object was modified. # Corresponds to the JSON property `changeTime` # @return [DateTime] attr_accessor :change_time # Field name of the object which changed. # Corresponds to the JSON property `fieldName` # @return [String] attr_accessor :field_name # ID of this change log. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#changeLog". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # New value of the object field. # Corresponds to the JSON property `newValue` # @return [String] attr_accessor :new_value # ID of the object of this change log. The object could be a campaign, placement, # ad, or other type. # Corresponds to the JSON property `objectId` # @return [Fixnum] attr_accessor :object_id_prop # Object type of the change log. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # Old value of the object field. # Corresponds to the JSON property `oldValue` # @return [String] attr_accessor :old_value # Subaccount ID of the modified object. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Transaction ID of this change log. When a single API call results in many # changes, each change will have a separate ID in the change log but will share # the same transactionId. # Corresponds to the JSON property `transactionId` # @return [Fixnum] attr_accessor :transaction_id # ID of the user who modified the object. # Corresponds to the JSON property `userProfileId` # @return [Fixnum] attr_accessor :user_profile_id # User profile name of the user who modified the object. # Corresponds to the JSON property `userProfileName` # @return [String] attr_accessor :user_profile_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @action = args[:action] if args.key?(:action) @change_time = args[:change_time] if args.key?(:change_time) @field_name = args[:field_name] if args.key?(:field_name) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @new_value = args[:new_value] if args.key?(:new_value) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @object_type = args[:object_type] if args.key?(:object_type) @old_value = args[:old_value] if args.key?(:old_value) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @transaction_id = args[:transaction_id] if args.key?(:transaction_id) @user_profile_id = args[:user_profile_id] if args.key?(:user_profile_id) @user_profile_name = args[:user_profile_name] if args.key?(:user_profile_name) end end # Change Log List Response class ChangeLogsListResponse include Google::Apis::Core::Hashable # Change log collection. # Corresponds to the JSON property `changeLogs` # @return [Array] attr_accessor :change_logs # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#changeLogsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @change_logs = args[:change_logs] if args.key?(:change_logs) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # City List Response class CitiesListResponse include Google::Apis::Core::Hashable # City collection. # Corresponds to the JSON property `cities` # @return [Array] attr_accessor :cities # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#citiesListResponse". # 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) @cities = args[:cities] if args.key?(:cities) @kind = args[:kind] if args.key?(:kind) end end # Contains information about a city that can be targeted by ads. class City include Google::Apis::Core::Hashable # Country code of the country to which this city belongs. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of the country to which this city belongs. # Corresponds to the JSON property `countryDartId` # @return [Fixnum] attr_accessor :country_dart_id # DART ID of this city. This is the ID used for targeting and generating reports. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#city". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metro region code of the metro region (DMA) to which this city belongs. # Corresponds to the JSON property `metroCode` # @return [String] attr_accessor :metro_code # ID of the metro region (DMA) to which this city belongs. # Corresponds to the JSON property `metroDmaId` # @return [Fixnum] attr_accessor :metro_dma_id # Name of this city. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Region code of the region to which this city belongs. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code # DART ID of the region to which this city belongs. # Corresponds to the JSON property `regionDartId` # @return [Fixnum] attr_accessor :region_dart_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country_code = args[:country_code] if args.key?(:country_code) @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) @dart_id = args[:dart_id] if args.key?(:dart_id) @kind = args[:kind] if args.key?(:kind) @metro_code = args[:metro_code] if args.key?(:metro_code) @metro_dma_id = args[:metro_dma_id] if args.key?(:metro_dma_id) @name = args[:name] if args.key?(:name) @region_code = args[:region_code] if args.key?(:region_code) @region_dart_id = args[:region_dart_id] if args.key?(:region_dart_id) end end # Creative Click Tag. class ClickTag include Google::Apis::Core::Hashable # Click-through URL # Corresponds to the JSON property `clickThroughUrl` # @return [Google::Apis::DfareportingV3_0::CreativeClickThroughUrl] attr_accessor :click_through_url # Advertiser event name associated with the click tag. This field is used by # DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when # the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `eventName` # @return [String] attr_accessor :event_name # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative # assets, this field must match the value of the creative asset's # creativeAssetId.name field. # 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) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @event_name = args[:event_name] if args.key?(:event_name) @name = args[:name] if args.key?(:name) end end # Click-through URL class ClickThroughUrl include Google::Apis::Core::Hashable # Read-only convenience field representing the actual URL that will be used for # this click-through. The URL is computed as follows: # - If defaultLandingPage is enabled then the campaign's default landing page # URL is assigned to this field. # - If defaultLandingPage is not enabled and a landingPageId is specified then # that landing page's URL is assigned to this field. # - If neither of the above cases apply, then the customClickThroughUrl is # assigned to this field. # Corresponds to the JSON property `computedClickThroughUrl` # @return [String] attr_accessor :computed_click_through_url # Custom click-through URL. Applicable if the defaultLandingPage field is set to # false and the landingPageId field is left unset. # Corresponds to the JSON property `customClickThroughUrl` # @return [String] attr_accessor :custom_click_through_url # Whether the campaign default landing page is used. # Corresponds to the JSON property `defaultLandingPage` # @return [Boolean] attr_accessor :default_landing_page alias_method :default_landing_page?, :default_landing_page # ID of the landing page for the click-through URL. Applicable if the # defaultLandingPage field is set to false. # Corresponds to the JSON property `landingPageId` # @return [Fixnum] attr_accessor :landing_page_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @computed_click_through_url = args[:computed_click_through_url] if args.key?(:computed_click_through_url) @custom_click_through_url = args[:custom_click_through_url] if args.key?(:custom_click_through_url) @default_landing_page = args[:default_landing_page] if args.key?(:default_landing_page) @landing_page_id = args[:landing_page_id] if args.key?(:landing_page_id) end end # Click Through URL Suffix settings. class ClickThroughUrlSuffixProperties include Google::Apis::Core::Hashable # Click-through URL suffix to apply to all ads in this entity's scope. Must be # less than 128 characters long. # Corresponds to the JSON property `clickThroughUrlSuffix` # @return [String] attr_accessor :click_through_url_suffix # Whether this entity should override the inherited click-through URL suffix # with its own defined value. # Corresponds to the JSON property `overrideInheritedSuffix` # @return [Boolean] attr_accessor :override_inherited_suffix alias_method :override_inherited_suffix?, :override_inherited_suffix def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_through_url_suffix = args[:click_through_url_suffix] if args.key?(:click_through_url_suffix) @override_inherited_suffix = args[:override_inherited_suffix] if args.key?(:override_inherited_suffix) end end # Companion Click-through override. class CompanionClickThroughOverride include Google::Apis::Core::Hashable # Click-through URL # Corresponds to the JSON property `clickThroughUrl` # @return [Google::Apis::DfareportingV3_0::ClickThroughUrl] attr_accessor :click_through_url # ID of the creative for this companion click-through override. # Corresponds to the JSON property `creativeId` # @return [Fixnum] attr_accessor :creative_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @creative_id = args[:creative_id] if args.key?(:creative_id) end end # Companion Settings class CompanionSetting include Google::Apis::Core::Hashable # Whether companions are disabled for this placement. # Corresponds to the JSON property `companionsDisabled` # @return [Boolean] attr_accessor :companions_disabled alias_method :companions_disabled?, :companions_disabled # Whitelist of companion sizes to be served to this placement. Set this list to # null or empty to serve all companion sizes. # Corresponds to the JSON property `enabledSizes` # @return [Array] attr_accessor :enabled_sizes # Whether to serve only static images as companions. # Corresponds to the JSON property `imageOnly` # @return [Boolean] attr_accessor :image_only alias_method :image_only?, :image_only # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#companionSetting". # 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) @companions_disabled = args[:companions_disabled] if args.key?(:companions_disabled) @enabled_sizes = args[:enabled_sizes] if args.key?(:enabled_sizes) @image_only = args[:image_only] if args.key?(:image_only) @kind = args[:kind] if args.key?(:kind) end end # Represents a response to the queryCompatibleFields method. class CompatibleFields include Google::Apis::Core::Hashable # Represents fields that are compatible to be selected for a report of type " # CROSS_DIMENSION_REACH". # Corresponds to the JSON property `crossDimensionReachReportCompatibleFields` # @return [Google::Apis::DfareportingV3_0::CrossDimensionReachReportCompatibleFields] attr_accessor :cross_dimension_reach_report_compatible_fields # Represents fields that are compatible to be selected for a report of type " # FlOODLIGHT". # Corresponds to the JSON property `floodlightReportCompatibleFields` # @return [Google::Apis::DfareportingV3_0::FloodlightReportCompatibleFields] attr_accessor :floodlight_report_compatible_fields # The kind of resource this is, in this case dfareporting#compatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Represents fields that are compatible to be selected for a report of type " # PATH_TO_CONVERSION". # Corresponds to the JSON property `pathToConversionReportCompatibleFields` # @return [Google::Apis::DfareportingV3_0::PathToConversionReportCompatibleFields] attr_accessor :path_to_conversion_report_compatible_fields # Represents fields that are compatible to be selected for a report of type " # REACH". # Corresponds to the JSON property `reachReportCompatibleFields` # @return [Google::Apis::DfareportingV3_0::ReachReportCompatibleFields] attr_accessor :reach_report_compatible_fields # Represents fields that are compatible to be selected for a report of type " # STANDARD". # Corresponds to the JSON property `reportCompatibleFields` # @return [Google::Apis::DfareportingV3_0::ReportCompatibleFields] attr_accessor :report_compatible_fields def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cross_dimension_reach_report_compatible_fields = args[:cross_dimension_reach_report_compatible_fields] if args.key?(:cross_dimension_reach_report_compatible_fields) @floodlight_report_compatible_fields = args[:floodlight_report_compatible_fields] if args.key?(:floodlight_report_compatible_fields) @kind = args[:kind] if args.key?(:kind) @path_to_conversion_report_compatible_fields = args[:path_to_conversion_report_compatible_fields] if args.key?(:path_to_conversion_report_compatible_fields) @reach_report_compatible_fields = args[:reach_report_compatible_fields] if args.key?(:reach_report_compatible_fields) @report_compatible_fields = args[:report_compatible_fields] if args.key?(:report_compatible_fields) end end # Contains information about an internet connection type that can be targeted by # ads. Clients can use the connection type to target mobile vs. broadband users. class ConnectionType include Google::Apis::Core::Hashable # ID of this connection type. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#connectionType". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this connection type. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Connection Type List Response class ConnectionTypesListResponse include Google::Apis::Core::Hashable # Collection of connection types such as broadband and mobile. # Corresponds to the JSON property `connectionTypes` # @return [Array] attr_accessor :connection_types # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#connectionTypesListResponse". # 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) @connection_types = args[:connection_types] if args.key?(:connection_types) @kind = args[:kind] if args.key?(:kind) end end # Content Category List Response class ContentCategoriesListResponse include Google::Apis::Core::Hashable # Content category collection. # Corresponds to the JSON property `contentCategories` # @return [Array] attr_accessor :content_categories # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#contentCategoriesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @content_categories = args[:content_categories] if args.key?(:content_categories) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Organizes placements according to the contents of their associated webpages. class ContentCategory include Google::Apis::Core::Hashable # Account ID of this content category. This is a read-only field that can be # left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # ID of this content category. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#contentCategory". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this content category. This is a required field and must be less than # 256 characters long and unique among content categories of the same account. # 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) @account_id = args[:account_id] if args.key?(:account_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # A Conversion represents when a user successfully performs a desired action # after seeing an ad. class Conversion include Google::Apis::Core::Hashable # Whether the conversion was directed toward children. # Corresponds to the JSON property `childDirectedTreatment` # @return [Boolean] attr_accessor :child_directed_treatment alias_method :child_directed_treatment?, :child_directed_treatment # Custom floodlight variables. # Corresponds to the JSON property `customVariables` # @return [Array] attr_accessor :custom_variables # The alphanumeric encrypted user ID. When set, encryptionInfo should also be # specified. This field is mutually exclusive with encryptedUserIdCandidates[], # mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or # mobileDeviceId or gclid is a required field. # Corresponds to the JSON property `encryptedUserId` # @return [String] attr_accessor :encrypted_user_id # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior # to the conversion timestamp will be used in the inserted conversion. If no # such user ID is found then the conversion will be rejected with # NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. # This field may only be used when calling batchinsert; it is not supported by # batchupdate. This field is mutually exclusive with encryptedUserId, # mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid # is a required field. # Corresponds to the JSON property `encryptedUserIdCandidates` # @return [Array] attr_accessor :encrypted_user_id_candidates # Floodlight Activity ID of this conversion. This is a required field. # Corresponds to the JSON property `floodlightActivityId` # @return [Fixnum] attr_accessor :floodlight_activity_id # Floodlight Configuration ID of this conversion. This is a required field. # Corresponds to the JSON property `floodlightConfigurationId` # @return [Fixnum] attr_accessor :floodlight_configuration_id # The Google click ID. This field is mutually exclusive with encryptedUserId, # encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or # encryptedUserIdCandidates[] or mobileDeviceId is a required field. # Corresponds to the JSON property `gclid` # @return [String] attr_accessor :gclid # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversion". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be # used for reporting but not targeting. This will prevent remarketing. # Corresponds to the JSON property `limitAdTracking` # @return [Boolean] attr_accessor :limit_ad_tracking alias_method :limit_ad_tracking?, :limit_ad_tracking # The mobile device ID. This field is mutually exclusive with encryptedUserId, # encryptedUserIdCandidates[] and gclid. This or encryptedUserId or # encryptedUserIdCandidates[] or gclid is a required field. # Corresponds to the JSON property `mobileDeviceId` # @return [String] attr_accessor :mobile_device_id # The ordinal of the conversion. Use this field to control how conversions of # the same user and day are de-duplicated. This is a required field. # Corresponds to the JSON property `ordinal` # @return [String] attr_accessor :ordinal # The quantity of the conversion. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # The timestamp of conversion, in Unix epoch micros. This is a required field. # Corresponds to the JSON property `timestampMicros` # @return [Fixnum] attr_accessor :timestamp_micros # The value of the conversion. # 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) @child_directed_treatment = args[:child_directed_treatment] if args.key?(:child_directed_treatment) @custom_variables = args[:custom_variables] if args.key?(:custom_variables) @encrypted_user_id = args[:encrypted_user_id] if args.key?(:encrypted_user_id) @encrypted_user_id_candidates = args[:encrypted_user_id_candidates] if args.key?(:encrypted_user_id_candidates) @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) @gclid = args[:gclid] if args.key?(:gclid) @kind = args[:kind] if args.key?(:kind) @limit_ad_tracking = args[:limit_ad_tracking] if args.key?(:limit_ad_tracking) @mobile_device_id = args[:mobile_device_id] if args.key?(:mobile_device_id) @ordinal = args[:ordinal] if args.key?(:ordinal) @quantity = args[:quantity] if args.key?(:quantity) @timestamp_micros = args[:timestamp_micros] if args.key?(:timestamp_micros) @value = args[:value] if args.key?(:value) end end # The error code and description for a conversion that failed to insert or # update. class ConversionError include Google::Apis::Core::Hashable # The error code. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionError". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A description of the error. # 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) @kind = args[:kind] if args.key?(:kind) @message = args[:message] if args.key?(:message) end end # The original conversion that was inserted or updated and whether there were # any errors. class ConversionStatus include Google::Apis::Core::Hashable # A Conversion represents when a user successfully performs a desired action # after seeing an ad. # Corresponds to the JSON property `conversion` # @return [Google::Apis::DfareportingV3_0::Conversion] attr_accessor :conversion # A list of errors related to this conversion. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionStatus". # 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) @conversion = args[:conversion] if args.key?(:conversion) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) end end # Insert Conversions Request. class ConversionsBatchInsertRequest include Google::Apis::Core::Hashable # The set of conversions to insert. # Corresponds to the JSON property `conversions` # @return [Array] attr_accessor :conversions # A description of how user IDs are encrypted. # Corresponds to the JSON property `encryptionInfo` # @return [Google::Apis::DfareportingV3_0::EncryptionInfo] attr_accessor :encryption_info # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionsBatchInsertRequest". # 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) @conversions = args[:conversions] if args.key?(:conversions) @encryption_info = args[:encryption_info] if args.key?(:encryption_info) @kind = args[:kind] if args.key?(:kind) end end # Insert Conversions Response. class ConversionsBatchInsertResponse include Google::Apis::Core::Hashable # Indicates that some or all conversions failed to insert. # Corresponds to the JSON property `hasFailures` # @return [Boolean] attr_accessor :has_failures alias_method :has_failures?, :has_failures # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionsBatchInsertResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The insert status of each conversion. Statuses are returned in the same order # that conversions are inserted. # Corresponds to the JSON property `status` # @return [Array] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @has_failures = args[:has_failures] if args.key?(:has_failures) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) end end # Update Conversions Request. class ConversionsBatchUpdateRequest include Google::Apis::Core::Hashable # The set of conversions to update. # Corresponds to the JSON property `conversions` # @return [Array] attr_accessor :conversions # A description of how user IDs are encrypted. # Corresponds to the JSON property `encryptionInfo` # @return [Google::Apis::DfareportingV3_0::EncryptionInfo] attr_accessor :encryption_info # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionsBatchUpdateRequest". # 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) @conversions = args[:conversions] if args.key?(:conversions) @encryption_info = args[:encryption_info] if args.key?(:encryption_info) @kind = args[:kind] if args.key?(:kind) end end # Update Conversions Response. class ConversionsBatchUpdateResponse include Google::Apis::Core::Hashable # Indicates that some or all conversions failed to update. # Corresponds to the JSON property `hasFailures` # @return [Boolean] attr_accessor :has_failures alias_method :has_failures?, :has_failures # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#conversionsBatchUpdateResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The update status of each conversion. Statuses are returned in the same order # that conversions are updated. # Corresponds to the JSON property `status` # @return [Array] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @has_failures = args[:has_failures] if args.key?(:has_failures) @kind = args[:kind] if args.key?(:kind) @status = args[:status] if args.key?(:status) end end # Country List Response class CountriesListResponse include Google::Apis::Core::Hashable # Country collection. # Corresponds to the JSON property `countries` # @return [Array] attr_accessor :countries # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#countriesListResponse". # 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) @countries = args[:countries] if args.key?(:countries) @kind = args[:kind] if args.key?(:kind) end end # Contains information about a country that can be targeted by ads. class Country include Google::Apis::Core::Hashable # Country code. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of this country. This is the ID used for targeting and generating # reports. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#country". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this country. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether ad serving supports secure servers in this country. # Corresponds to the JSON property `sslEnabled` # @return [Boolean] attr_accessor :ssl_enabled alias_method :ssl_enabled?, :ssl_enabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country_code = args[:country_code] if args.key?(:country_code) @dart_id = args[:dart_id] if args.key?(:dart_id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @ssl_enabled = args[:ssl_enabled] if args.key?(:ssl_enabled) end end # Contains properties of a Creative. class Creative include Google::Apis::Core::Hashable # Account ID of this creative. This field, if left unset, will be auto-generated # for both insert and update operations. Applicable to all creative types. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether the creative is active. Applicable to all creative types. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Ad parameters user for VPAID creative. This is a read-only field. Applicable # to the following creative types: all VPAID. # Corresponds to the JSON property `adParameters` # @return [String] attr_accessor :ad_parameters # Keywords for a Rich Media creative. Keywords let you customize the creative # settings of a Rich Media ad running on your site without having to contact the # advertiser. You can use keywords to dynamically change the look or # functionality of a creative. Applicable to the following creative types: all # RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `adTagKeys` # @return [Array] attr_accessor :ad_tag_keys # Advertiser ID of this creative. This is a required field. Applicable to all # creative types. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Whether script access is allowed for this creative. This is a read-only and # deprecated field which will automatically be set to true on update. Applicable # to the following creative types: FLASH_INPAGE. # Corresponds to the JSON property `allowScriptAccess` # @return [Boolean] attr_accessor :allow_script_access alias_method :allow_script_access?, :allow_script_access # Whether the creative is archived. Applicable to all creative types. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # Type of artwork used for the creative. This is a read-only field. Applicable # to the following creative types: all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `artworkType` # @return [String] attr_accessor :artwork_type # Source application where creative was authored. Presently, only DBM authored # creatives will have this field set. Applicable to all creative types. # Corresponds to the JSON property `authoringSource` # @return [String] attr_accessor :authoring_source # Authoring tool for HTML5 banner creatives. This is a read-only field. # Applicable to the following creative types: HTML5_BANNER. # Corresponds to the JSON property `authoringTool` # @return [String] attr_accessor :authoring_tool # Whether images are automatically advanced for image gallery creatives. # Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. # Corresponds to the JSON property `autoAdvanceImages` # @return [Boolean] attr_accessor :auto_advance_images alias_method :auto_advance_images?, :auto_advance_images # The 6-character HTML color code, beginning with #, for the background of the # window area where the Flash file is displayed. Default is white. Applicable to # the following creative types: FLASH_INPAGE. # Corresponds to the JSON property `backgroundColor` # @return [String] attr_accessor :background_color # Click-through URL # Corresponds to the JSON property `backupImageClickThroughUrl` # @return [Google::Apis::DfareportingV3_0::CreativeClickThroughUrl] attr_accessor :backup_image_click_through_url # List of feature dependencies that will cause a backup image to be served if # the browser that serves the ad does not support them. Feature dependencies are # features that a browser must be able to support in order to render your HTML5 # creative asset correctly. This field is initially auto-generated to contain # all features detected by DCM for all the assets of this creative and can then # be modified by the client. To reset this field, copy over all the # creativeAssets' detected features. Applicable to the following creative types: # HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not # HTML_IMAGE. # Corresponds to the JSON property `backupImageFeatures` # @return [Array] attr_accessor :backup_image_features # Reporting label used for HTML5 banner backup image. Applicable to the # following creative types: DISPLAY when the primary asset type is not # HTML_IMAGE. # Corresponds to the JSON property `backupImageReportingLabel` # @return [String] attr_accessor :backup_image_reporting_label # Target Window. # Corresponds to the JSON property `backupImageTargetWindow` # @return [Google::Apis::DfareportingV3_0::TargetWindow] attr_accessor :backup_image_target_window # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER # creatives, this is a subset of detected click tags for the assets associated # with this creative. After creating a flash asset, detected click tags will be # returned in the creativeAssetMetadata. When inserting the creative, populate # the creative clickTags field using the creativeAssetMetadata.clickTags field. # For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this # list for each image creative asset. A click tag is matched with a # corresponding creative asset by matching the clickTag.name field with the # creativeAsset.assetIdentifier.name field. Applicable to the following creative # types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to # DISPLAY when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `clickTags` # @return [Array] attr_accessor :click_tags # Industry standard ID assigned to creative for reach and frequency. Applicable # to INSTREAM_VIDEO_REDIRECT creatives. # Corresponds to the JSON property `commercialId` # @return [String] attr_accessor :commercial_id # List of companion creatives assigned to an in-Stream videocreative. Acceptable # values include IDs of existing flash and image creatives. Applicable to the # following creative types: all VPAID and all INSTREAM_VIDEO with # dynamicAssetSelection set to false. # Corresponds to the JSON property `companionCreatives` # @return [Array] attr_accessor :companion_creatives # Compatibilities associated with this creative. This is a read-only field. # DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on # mobile devices or in mobile apps for regular or interstitial ads, respectively. # APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing # creatives may have these compatibilities since new creatives will either be # assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to # rendering in in-stream video ads developed with the VAST standard. Applicable # to all creative types. # Acceptable values are: # - "APP" # - "APP_INTERSTITIAL" # - "IN_STREAM_VIDEO" # - "DISPLAY" # - "DISPLAY_INTERSTITIAL" # Corresponds to the JSON property `compatibility` # @return [Array] attr_accessor :compatibility # Whether Flash assets associated with the creative need to be automatically # converted to HTML5. This flag is enabled by default and users can choose to # disable it if they don't want the system to generate and use HTML5 asset for # this creative. Applicable to the following creative type: FLASH_INPAGE. # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `convertFlashToHtml5` # @return [Boolean] attr_accessor :convert_flash_to_html5 alias_method :convert_flash_to_html5?, :convert_flash_to_html5 # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY # creatives, these are read-only and auto-generated from clickTags. Applicable # to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and # all VPAID. # Corresponds to the JSON property `counterCustomEvents` # @return [Array] attr_accessor :counter_custom_events # Encapsulates the list of rules for asset selection and a default asset in case # none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Corresponds to the JSON property `creativeAssetSelection` # @return [Google::Apis::DfareportingV3_0::CreativeAssetSelection] attr_accessor :creative_asset_selection # Assets associated with a creative. Applicable to all but the following # creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and # REDIRECT # Corresponds to the JSON property `creativeAssets` # @return [Array] attr_accessor :creative_assets # Creative field assignments for this creative. Applicable to all creative types. # Corresponds to the JSON property `creativeFieldAssignments` # @return [Array] attr_accessor :creative_field_assignments # Custom key-values for a Rich Media creative. Key-values let you customize the # creative settings of a Rich Media ad running on your site without having to # contact the advertiser. You can use key-values to dynamically change the look # or functionality of a creative. Applicable to the following creative types: # all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `customKeyValues` # @return [Array] attr_accessor :custom_key_values # Set this to true to enable the use of rules to target individual assets in # this creative. When set to true creativeAssetSelection must be set. This also # controls asset-level companions. When this is true, companion creatives should # be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO # creatives. # Corresponds to the JSON property `dynamicAssetSelection` # @return [Boolean] attr_accessor :dynamic_asset_selection alias_method :dynamic_asset_selection?, :dynamic_asset_selection # List of exit events configured for the creative. For DISPLAY and # DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from # clickTags, For DISPLAY, an event is also created from the # backupImageReportingLabel. Applicable to the following creative types: # DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY # when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `exitCustomEvents` # @return [Array] attr_accessor :exit_custom_events # FsCommand. # Corresponds to the JSON property `fsCommand` # @return [Google::Apis::DfareportingV3_0::FsCommand] attr_accessor :fs_command # HTML code for the creative. This is a required field when applicable. This # field is ignored if htmlCodeLocked is true. Applicable to the following # creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. # Corresponds to the JSON property `htmlCode` # @return [String] attr_accessor :html_code # Whether HTML code is DCM-generated or manually entered. Set to true to ignore # changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE # and HTML5_BANNER. # Corresponds to the JSON property `htmlCodeLocked` # @return [Boolean] attr_accessor :html_code_locked alias_method :html_code_locked?, :html_code_locked # ID of this creative. This is a read-only, auto-generated field. Applicable to # all creative types. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creative". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :last_modified_info # Latest Studio trafficked creative ID associated with rich media and VPAID # creatives. This is a read-only field. Applicable to the following creative # types: all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `latestTraffickedCreativeId` # @return [Fixnum] attr_accessor :latest_trafficked_creative_id # Name of the creative. This is a required field and must be less than 256 # characters long. Applicable to all creative types. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Override CSS value for rich media creatives. Applicable to the following # creative types: all RICH_MEDIA. # Corresponds to the JSON property `overrideCss` # @return [String] attr_accessor :override_css # The asset ID of the polite load image asset. Applicable to the creative type: # DISPLAY. # Corresponds to the JSON property `politeLoadAssetId` # @return [Fixnum] attr_accessor :polite_load_asset_id # Video Offset # Corresponds to the JSON property `progressOffset` # @return [Google::Apis::DfareportingV3_0::VideoOffset] attr_accessor :progress_offset # URL of hosted image or hosted video or another ad tag. For # INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. # The standard for a VAST (Video Ad Serving Template) ad response allows for a # redirect link to another VAST 2.0 or 3.0 call. This is a required field when # applicable. Applicable to the following creative types: DISPLAY_REDIRECT, # INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT # Corresponds to the JSON property `redirectUrl` # @return [String] attr_accessor :redirect_url # ID of current rendering version. This is a read-only field. Applicable to all # creative types. # Corresponds to the JSON property `renderingId` # @return [Fixnum] attr_accessor :rendering_id # Represents a DimensionValue resource. # Corresponds to the JSON property `renderingIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :rendering_id_dimension_value # The minimum required Flash plugin version for this creative. For example, 11.2. # 202.235. This is a read-only field. Applicable to the following creative types: # all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `requiredFlashPluginVersion` # @return [String] attr_accessor :required_flash_plugin_version # The internal Flash version for this creative as calculated by DoubleClick # Studio. This is a read-only field. Applicable to the following creative types: # FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the # primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `requiredFlashVersion` # @return [Fixnum] attr_accessor :required_flash_version # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `size` # @return [Google::Apis::DfareportingV3_0::Size] attr_accessor :size # Video Offset # Corresponds to the JSON property `skipOffset` # @return [Google::Apis::DfareportingV3_0::VideoOffset] attr_accessor :skip_offset # Whether the user can choose to skip the creative. Applicable to the following # creative types: all INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `skippable` # @return [Boolean] attr_accessor :skippable alias_method :skippable?, :skippable # Whether the creative is SSL-compliant. This is a read-only field. Applicable # to all creative types. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Whether creative should be treated as SSL compliant even if the system scan # shows it's not. Applicable to all creative types. # Corresponds to the JSON property `sslOverride` # @return [Boolean] attr_accessor :ssl_override alias_method :ssl_override?, :ssl_override # Studio advertiser ID associated with rich media and VPAID creatives. This is a # read-only field. Applicable to the following creative types: all RICH_MEDIA, # and all VPAID. # Corresponds to the JSON property `studioAdvertiserId` # @return [Fixnum] attr_accessor :studio_advertiser_id # Studio creative ID associated with rich media and VPAID creatives. This is a # read-only field. Applicable to the following creative types: all RICH_MEDIA, # and all VPAID. # Corresponds to the JSON property `studioCreativeId` # @return [Fixnum] attr_accessor :studio_creative_id # Studio trafficked creative ID associated with rich media and VPAID creatives. # This is a read-only field. Applicable to the following creative types: all # RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `studioTraffickedCreativeId` # @return [Fixnum] attr_accessor :studio_trafficked_creative_id # Subaccount ID of this creative. This field, if left unset, will be auto- # generated for both insert and update operations. Applicable to all creative # types. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Third-party URL used to record backup image impressions. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `thirdPartyBackupImageImpressionsUrl` # @return [String] attr_accessor :third_party_backup_image_impressions_url # Third-party URL used to record rich media impressions. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `thirdPartyRichMediaImpressionsUrl` # @return [String] attr_accessor :third_party_rich_media_impressions_url # Third-party URLs for tracking in-stream video creative events. Applicable to # the following creative types: all INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `thirdPartyUrls` # @return [Array] attr_accessor :third_party_urls # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY # creatives, these are read-only and auto-generated from clickTags. Applicable # to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and # all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. # Corresponds to the JSON property `timerCustomEvents` # @return [Array] attr_accessor :timer_custom_events # Combined size of all creative assets. This is a read-only field. Applicable to # the following creative types: all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `totalFileSize` # @return [Fixnum] attr_accessor :total_file_size # Type of this creative. This is a required field. Applicable to all creative # types. # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing # creatives. New creatives should use DISPLAY as a replacement for these types. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following # creative types: INSTREAM_VIDEO and VPAID. # Corresponds to the JSON property `universalAdId` # @return [Google::Apis::DfareportingV3_0::UniversalAdId] attr_accessor :universal_ad_id # The version number helps you keep track of multiple versions of your creative # in your reports. The version number will always be auto-generated during # insert operations to start at 1. For tracking creatives the version cannot be # incremented and will always remain at 1. For all other creative types the # version can be incremented only by 1 during update operations. In addition, # the version will be automatically incremented by 1 when undergoing Rich Media # creative merging. Applicable to all creative types. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version # Description of the video ad. Applicable to the following creative types: all # INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `videoDescription` # @return [String] attr_accessor :video_description # Creative video duration in seconds. This is a read-only field. Applicable to # the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID. # Corresponds to the JSON property `videoDuration` # @return [Float] attr_accessor :video_duration def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @ad_parameters = args[:ad_parameters] if args.key?(:ad_parameters) @ad_tag_keys = args[:ad_tag_keys] if args.key?(:ad_tag_keys) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @allow_script_access = args[:allow_script_access] if args.key?(:allow_script_access) @archived = args[:archived] if args.key?(:archived) @artwork_type = args[:artwork_type] if args.key?(:artwork_type) @authoring_source = args[:authoring_source] if args.key?(:authoring_source) @authoring_tool = args[:authoring_tool] if args.key?(:authoring_tool) @auto_advance_images = args[:auto_advance_images] if args.key?(:auto_advance_images) @background_color = args[:background_color] if args.key?(:background_color) @backup_image_click_through_url = args[:backup_image_click_through_url] if args.key?(:backup_image_click_through_url) @backup_image_features = args[:backup_image_features] if args.key?(:backup_image_features) @backup_image_reporting_label = args[:backup_image_reporting_label] if args.key?(:backup_image_reporting_label) @backup_image_target_window = args[:backup_image_target_window] if args.key?(:backup_image_target_window) @click_tags = args[:click_tags] if args.key?(:click_tags) @commercial_id = args[:commercial_id] if args.key?(:commercial_id) @companion_creatives = args[:companion_creatives] if args.key?(:companion_creatives) @compatibility = args[:compatibility] if args.key?(:compatibility) @convert_flash_to_html5 = args[:convert_flash_to_html5] if args.key?(:convert_flash_to_html5) @counter_custom_events = args[:counter_custom_events] if args.key?(:counter_custom_events) @creative_asset_selection = args[:creative_asset_selection] if args.key?(:creative_asset_selection) @creative_assets = args[:creative_assets] if args.key?(:creative_assets) @creative_field_assignments = args[:creative_field_assignments] if args.key?(:creative_field_assignments) @custom_key_values = args[:custom_key_values] if args.key?(:custom_key_values) @dynamic_asset_selection = args[:dynamic_asset_selection] if args.key?(:dynamic_asset_selection) @exit_custom_events = args[:exit_custom_events] if args.key?(:exit_custom_events) @fs_command = args[:fs_command] if args.key?(:fs_command) @html_code = args[:html_code] if args.key?(:html_code) @html_code_locked = args[:html_code_locked] if args.key?(:html_code_locked) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @latest_trafficked_creative_id = args[:latest_trafficked_creative_id] if args.key?(:latest_trafficked_creative_id) @name = args[:name] if args.key?(:name) @override_css = args[:override_css] if args.key?(:override_css) @polite_load_asset_id = args[:polite_load_asset_id] if args.key?(:polite_load_asset_id) @progress_offset = args[:progress_offset] if args.key?(:progress_offset) @redirect_url = args[:redirect_url] if args.key?(:redirect_url) @rendering_id = args[:rendering_id] if args.key?(:rendering_id) @rendering_id_dimension_value = args[:rendering_id_dimension_value] if args.key?(:rendering_id_dimension_value) @required_flash_plugin_version = args[:required_flash_plugin_version] if args.key?(:required_flash_plugin_version) @required_flash_version = args[:required_flash_version] if args.key?(:required_flash_version) @size = args[:size] if args.key?(:size) @skip_offset = args[:skip_offset] if args.key?(:skip_offset) @skippable = args[:skippable] if args.key?(:skippable) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @ssl_override = args[:ssl_override] if args.key?(:ssl_override) @studio_advertiser_id = args[:studio_advertiser_id] if args.key?(:studio_advertiser_id) @studio_creative_id = args[:studio_creative_id] if args.key?(:studio_creative_id) @studio_trafficked_creative_id = args[:studio_trafficked_creative_id] if args.key?(:studio_trafficked_creative_id) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @third_party_backup_image_impressions_url = args[:third_party_backup_image_impressions_url] if args.key?(:third_party_backup_image_impressions_url) @third_party_rich_media_impressions_url = args[:third_party_rich_media_impressions_url] if args.key?(:third_party_rich_media_impressions_url) @third_party_urls = args[:third_party_urls] if args.key?(:third_party_urls) @timer_custom_events = args[:timer_custom_events] if args.key?(:timer_custom_events) @total_file_size = args[:total_file_size] if args.key?(:total_file_size) @type = args[:type] if args.key?(:type) @universal_ad_id = args[:universal_ad_id] if args.key?(:universal_ad_id) @version = args[:version] if args.key?(:version) @video_description = args[:video_description] if args.key?(:video_description) @video_duration = args[:video_duration] if args.key?(:video_duration) end end # Creative Asset. class CreativeAsset include Google::Apis::Core::Hashable # Whether ActionScript3 is enabled for the flash asset. This is a read-only # field. Applicable to the following creative type: FLASH_INPAGE. Applicable to # DISPLAY when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `actionScript3` # @return [Boolean] attr_accessor :action_script3 alias_method :action_script3?, :action_script3 # Whether the video asset is active. This is a read-only field for # VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: # INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Possible alignments for an asset. This is a read-only field. Applicable to the # following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. # Corresponds to the JSON property `alignment` # @return [String] attr_accessor :alignment # Artwork type of rich media creative. This is a read-only field. Applicable to # the following creative types: all RICH_MEDIA. # Corresponds to the JSON property `artworkType` # @return [String] attr_accessor :artwork_type # Creative Asset ID. # Corresponds to the JSON property `assetIdentifier` # @return [Google::Apis::DfareportingV3_0::CreativeAssetId] attr_accessor :asset_identifier # Creative Custom Event. # Corresponds to the JSON property `backupImageExit` # @return [Google::Apis::DfareportingV3_0::CreativeCustomEvent] attr_accessor :backup_image_exit # Detected bit-rate for video asset. This is a read-only field. Applicable to # the following creative types: INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `bitRate` # @return [Fixnum] attr_accessor :bit_rate # Rich media child asset type. This is a read-only field. Applicable to the # following creative types: all VPAID. # Corresponds to the JSON property `childAssetType` # @return [String] attr_accessor :child_asset_type # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `collapsedSize` # @return [Google::Apis::DfareportingV3_0::Size] attr_accessor :collapsed_size # List of companion creatives assigned to an in-stream video creative asset. # Acceptable values include IDs of existing flash and image creatives. # Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to # true. # Corresponds to the JSON property `companionCreativeIds` # @return [Array] attr_accessor :companion_creative_ids # Custom start time in seconds for making the asset visible. Applicable to the # following creative types: all RICH_MEDIA. Value must be greater than or equal # to 0. # Corresponds to the JSON property `customStartTimeValue` # @return [Fixnum] attr_accessor :custom_start_time_value # List of feature dependencies for the creative asset that are detected by DCM. # Feature dependencies are features that a browser must be able to support in # order to render your HTML5 creative correctly. This is a read-only, auto- # generated field. Applicable to the following creative types: HTML5_BANNER. # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `detectedFeatures` # @return [Array] attr_accessor :detected_features # Type of rich media asset. This is a read-only field. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `displayType` # @return [String] attr_accessor :display_type # Duration in seconds for which an asset will be displayed. Applicable to the # following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be # greater than or equal to 1. # Corresponds to the JSON property `duration` # @return [Fixnum] attr_accessor :duration # Duration type for which an asset will be displayed. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `durationType` # @return [String] attr_accessor :duration_type # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `expandedDimension` # @return [Google::Apis::DfareportingV3_0::Size] attr_accessor :expanded_dimension # File size associated with this creative asset. This is a read-only field. # Applicable to all but the following creative types: all REDIRECT and # TRACKING_TEXT. # Corresponds to the JSON property `fileSize` # @return [Fixnum] attr_accessor :file_size # Flash version of the asset. This is a read-only field. Applicable to the # following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. # Corresponds to the JSON property `flashVersion` # @return [Fixnum] attr_accessor :flash_version # Whether to hide Flash objects flag for an asset. Applicable to the following # creative types: all RICH_MEDIA. # Corresponds to the JSON property `hideFlashObjects` # @return [Boolean] attr_accessor :hide_flash_objects alias_method :hide_flash_objects?, :hide_flash_objects # Whether to hide selection boxes flag for an asset. Applicable to the following # creative types: all RICH_MEDIA. # Corresponds to the JSON property `hideSelectionBoxes` # @return [Boolean] attr_accessor :hide_selection_boxes alias_method :hide_selection_boxes?, :hide_selection_boxes # Whether the asset is horizontally locked. This is a read-only field. # Applicable to the following creative types: all RICH_MEDIA. # Corresponds to the JSON property `horizontallyLocked` # @return [Boolean] attr_accessor :horizontally_locked alias_method :horizontally_locked?, :horizontally_locked # Numeric ID of this creative asset. This is a required field and should not be # modified. Applicable to all but the following creative types: all REDIRECT and # TRACKING_TEXT. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Detected MIME type for video asset. This is a read-only field. Applicable to # the following creative types: INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type # Offset Position. # Corresponds to the JSON property `offset` # @return [Google::Apis::DfareportingV3_0::OffsetPosition] attr_accessor :offset # Orientation of video asset. This is a read-only, auto-generated field. # Corresponds to the JSON property `orientation` # @return [String] attr_accessor :orientation # Whether the backup asset is original or changed by the user in DCM. Applicable # to the following creative types: all RICH_MEDIA. # Corresponds to the JSON property `originalBackup` # @return [Boolean] attr_accessor :original_backup alias_method :original_backup?, :original_backup # Offset Position. # Corresponds to the JSON property `position` # @return [Google::Apis::DfareportingV3_0::OffsetPosition] attr_accessor :position # Offset left unit for an asset. This is a read-only field. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `positionLeftUnit` # @return [String] attr_accessor :position_left_unit # Offset top unit for an asset. This is a read-only field if the asset # displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following # creative types: all RICH_MEDIA. # Corresponds to the JSON property `positionTopUnit` # @return [String] attr_accessor :position_top_unit # Progressive URL for video asset. This is a read-only field. Applicable to the # following creative types: INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `progressiveServingUrl` # @return [String] attr_accessor :progressive_serving_url # Whether the asset pushes down other content. Applicable to the following # creative types: all RICH_MEDIA. Additionally, only applicable when the asset # offsets are 0, the collapsedSize.width matches size.width, and the # collapsedSize.height is less than size.height. # Corresponds to the JSON property `pushdown` # @return [Boolean] attr_accessor :pushdown alias_method :pushdown?, :pushdown # Pushdown duration in seconds for an asset. Applicable to the following # creative types: all RICH_MEDIA.Additionally, only applicable when the asset # pushdown field is true, the offsets are 0, the collapsedSize.width matches # size.width, and the collapsedSize.height is less than size.height. Acceptable # values are 0 to 9.99, inclusive. # Corresponds to the JSON property `pushdownDuration` # @return [Float] attr_accessor :pushdown_duration # Role of the asset in relation to creative. Applicable to all but the following # creative types: all REDIRECT and TRACKING_TEXT. This is a required field. # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, # DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary # assets), and all VPAID creatives. # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all # VPAID creatives. Applicable to DISPLAY when the primary asset type is not # HTML_IMAGE. # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. # OTHER refers to assets from sources other than DCM, such as Studio uploaded # assets, applicable to all RICH_MEDIA and all VPAID creatives. # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to # INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets # and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from # Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be # added or removed within DCM. # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and # ALTERNATE_VIDEO assets that are marked active serve as backup in case the # VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or # removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `size` # @return [Google::Apis::DfareportingV3_0::Size] attr_accessor :size # Whether the asset is SSL-compliant. This is a read-only field. Applicable to # all but the following creative types: all REDIRECT and TRACKING_TEXT. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Initial wait time type before making the asset visible. Applicable to the # following creative types: all RICH_MEDIA. # Corresponds to the JSON property `startTimeType` # @return [String] attr_accessor :start_time_type # Streaming URL for video asset. This is a read-only field. Applicable to the # following creative types: INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `streamingServingUrl` # @return [String] attr_accessor :streaming_serving_url # Whether the asset is transparent. Applicable to the following creative types: # all RICH_MEDIA. Additionally, only applicable to HTML5 assets. # Corresponds to the JSON property `transparency` # @return [Boolean] attr_accessor :transparency alias_method :transparency?, :transparency # Whether the asset is vertically locked. This is a read-only field. Applicable # to the following creative types: all RICH_MEDIA. # Corresponds to the JSON property `verticallyLocked` # @return [Boolean] attr_accessor :vertically_locked alias_method :vertically_locked?, :vertically_locked # Detected video duration for video asset. This is a read-only field. Applicable # to the following creative types: INSTREAM_VIDEO and all VPAID. # Corresponds to the JSON property `videoDuration` # @return [Float] attr_accessor :video_duration # Window mode options for flash assets. Applicable to the following creative # types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, # RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. # Corresponds to the JSON property `windowMode` # @return [String] attr_accessor :window_mode # zIndex value of an asset. Applicable to the following creative types: all # RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT # one of the following types: ASSET_DISPLAY_TYPE_INPAGE or # ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, # inclusive. # Corresponds to the JSON property `zIndex` # @return [Fixnum] attr_accessor :z_index # File name of zip file. This is a read-only field. Applicable to the following # creative types: HTML5_BANNER. # Corresponds to the JSON property `zipFilename` # @return [String] attr_accessor :zip_filename # Size of zip file. This is a read-only field. Applicable to the following # creative types: HTML5_BANNER. # Corresponds to the JSON property `zipFilesize` # @return [String] attr_accessor :zip_filesize def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action_script3 = args[:action_script3] if args.key?(:action_script3) @active = args[:active] if args.key?(:active) @alignment = args[:alignment] if args.key?(:alignment) @artwork_type = args[:artwork_type] if args.key?(:artwork_type) @asset_identifier = args[:asset_identifier] if args.key?(:asset_identifier) @backup_image_exit = args[:backup_image_exit] if args.key?(:backup_image_exit) @bit_rate = args[:bit_rate] if args.key?(:bit_rate) @child_asset_type = args[:child_asset_type] if args.key?(:child_asset_type) @collapsed_size = args[:collapsed_size] if args.key?(:collapsed_size) @companion_creative_ids = args[:companion_creative_ids] if args.key?(:companion_creative_ids) @custom_start_time_value = args[:custom_start_time_value] if args.key?(:custom_start_time_value) @detected_features = args[:detected_features] if args.key?(:detected_features) @display_type = args[:display_type] if args.key?(:display_type) @duration = args[:duration] if args.key?(:duration) @duration_type = args[:duration_type] if args.key?(:duration_type) @expanded_dimension = args[:expanded_dimension] if args.key?(:expanded_dimension) @file_size = args[:file_size] if args.key?(:file_size) @flash_version = args[:flash_version] if args.key?(:flash_version) @hide_flash_objects = args[:hide_flash_objects] if args.key?(:hide_flash_objects) @hide_selection_boxes = args[:hide_selection_boxes] if args.key?(:hide_selection_boxes) @horizontally_locked = args[:horizontally_locked] if args.key?(:horizontally_locked) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @mime_type = args[:mime_type] if args.key?(:mime_type) @offset = args[:offset] if args.key?(:offset) @orientation = args[:orientation] if args.key?(:orientation) @original_backup = args[:original_backup] if args.key?(:original_backup) @position = args[:position] if args.key?(:position) @position_left_unit = args[:position_left_unit] if args.key?(:position_left_unit) @position_top_unit = args[:position_top_unit] if args.key?(:position_top_unit) @progressive_serving_url = args[:progressive_serving_url] if args.key?(:progressive_serving_url) @pushdown = args[:pushdown] if args.key?(:pushdown) @pushdown_duration = args[:pushdown_duration] if args.key?(:pushdown_duration) @role = args[:role] if args.key?(:role) @size = args[:size] if args.key?(:size) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @start_time_type = args[:start_time_type] if args.key?(:start_time_type) @streaming_serving_url = args[:streaming_serving_url] if args.key?(:streaming_serving_url) @transparency = args[:transparency] if args.key?(:transparency) @vertically_locked = args[:vertically_locked] if args.key?(:vertically_locked) @video_duration = args[:video_duration] if args.key?(:video_duration) @window_mode = args[:window_mode] if args.key?(:window_mode) @z_index = args[:z_index] if args.key?(:z_index) @zip_filename = args[:zip_filename] if args.key?(:zip_filename) @zip_filesize = args[:zip_filesize] if args.key?(:zip_filesize) end end # Creative Asset ID. class CreativeAssetId include Google::Apis::Core::Hashable # Name of the creative asset. This is a required field while inserting an asset. # After insertion, this assetIdentifier is used to identify the uploaded asset. # Characters in the name must be alphanumeric or one of the following: ".-_ ". # Spaces are allowed. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Type of asset to upload. This is a required field. FLASH and IMAGE are no # longer supported for new uploads. All image assets should use HTML_IMAGE. # 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 # CreativeAssets contains properties of a creative asset file which will be # uploaded or has already been uploaded. Refer to the creative sample code for # how to upload assets and insert a creative. class CreativeAssetMetadata include Google::Apis::Core::Hashable # Creative Asset ID. # Corresponds to the JSON property `assetIdentifier` # @return [Google::Apis::DfareportingV3_0::CreativeAssetId] attr_accessor :asset_identifier # List of detected click tags for assets. This is a read-only auto-generated # field. # Corresponds to the JSON property `clickTags` # @return [Array] attr_accessor :click_tags # List of feature dependencies for the creative asset that are detected by DCM. # Feature dependencies are features that a browser must be able to support in # order to render your HTML5 creative correctly. This is a read-only, auto- # generated field. # Corresponds to the JSON property `detectedFeatures` # @return [Array] attr_accessor :detected_features # Numeric ID of the asset. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeAssetMetadata". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Rules validated during code generation that generated a warning. This is a # read-only, auto-generated field. # Possible values are: # - "ADMOB_REFERENCED" # - "ASSET_FORMAT_UNSUPPORTED_DCM" # - "ASSET_INVALID" # - "CLICK_TAG_HARD_CODED" # - "CLICK_TAG_INVALID" # - "CLICK_TAG_IN_GWD" # - "CLICK_TAG_MISSING" # - "CLICK_TAG_MORE_THAN_ONE" # - "CLICK_TAG_NON_TOP_LEVEL" # - "COMPONENT_UNSUPPORTED_DCM" # - "ENABLER_UNSUPPORTED_METHOD_DCM" # - "EXTERNAL_FILE_REFERENCED" # - "FILE_DETAIL_EMPTY" # - "FILE_TYPE_INVALID" # - "GWD_PROPERTIES_INVALID" # - "HTML5_FEATURE_UNSUPPORTED" # - "LINKED_FILE_NOT_FOUND" # - "MAX_FLASH_VERSION_11" # - "MRAID_REFERENCED" # - "NOT_SSL_COMPLIANT" # - "ORPHANED_ASSET" # - "PRIMARY_HTML_MISSING" # - "SVG_INVALID" # - "ZIP_INVALID" # Corresponds to the JSON property `warnedValidationRules` # @return [Array] attr_accessor :warned_validation_rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @asset_identifier = args[:asset_identifier] if args.key?(:asset_identifier) @click_tags = args[:click_tags] if args.key?(:click_tags) @detected_features = args[:detected_features] if args.key?(:detected_features) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @warned_validation_rules = args[:warned_validation_rules] if args.key?(:warned_validation_rules) end end # Encapsulates the list of rules for asset selection and a default asset in case # none of the rules match. Applicable to INSTREAM_VIDEO creatives. class CreativeAssetSelection include Google::Apis::Core::Hashable # A creativeAssets[].id. This should refer to one of the parent assets in this # creative, and will be served if none of the rules match. This is a required # field. # Corresponds to the JSON property `defaultAssetId` # @return [Fixnum] attr_accessor :default_asset_id # Rules determine which asset will be served to a viewer. Rules will be # evaluated in the order in which they are stored in this list. This list must # contain at least one rule. Applicable to INSTREAM_VIDEO creatives. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_asset_id = args[:default_asset_id] if args.key?(:default_asset_id) @rules = args[:rules] if args.key?(:rules) end end # Creative Assignment. class CreativeAssignment include Google::Apis::Core::Hashable # Whether this creative assignment is active. When true, the creative will be # included in the ad's rotation. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Whether applicable event tags should fire when this creative assignment is # rendered. If this value is unset when the ad is inserted or updated, it will # default to true for all creative types EXCEPT for INTERNAL_REDIRECT, # INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. # Corresponds to the JSON property `applyEventTags` # @return [Boolean] attr_accessor :apply_event_tags alias_method :apply_event_tags?, :apply_event_tags # Click-through URL # Corresponds to the JSON property `clickThroughUrl` # @return [Google::Apis::DfareportingV3_0::ClickThroughUrl] attr_accessor :click_through_url # Companion creative overrides for this creative assignment. Applicable to video # ads. # Corresponds to the JSON property `companionCreativeOverrides` # @return [Array] attr_accessor :companion_creative_overrides # Creative group assignments for this creative assignment. Only one assignment # per creative group number is allowed for a maximum of two assignments. # Corresponds to the JSON property `creativeGroupAssignments` # @return [Array] attr_accessor :creative_group_assignments # ID of the creative to be assigned. This is a required field. # Corresponds to the JSON property `creativeId` # @return [Fixnum] attr_accessor :creative_id # Represents a DimensionValue resource. # Corresponds to the JSON property `creativeIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :creative_id_dimension_value # Date and time that the assigned creative should stop serving. Must be later # than the start time. # Corresponds to the JSON property `endTime` # @return [DateTime] attr_accessor :end_time # Rich media exit overrides for this creative assignment. # Applicable when the creative type is any of the following: # - DISPLAY # - RICH_MEDIA_INPAGE # - RICH_MEDIA_INPAGE_FLOATING # - RICH_MEDIA_IM_EXPAND # - RICH_MEDIA_EXPANDING # - RICH_MEDIA_INTERSTITIAL_FLOAT # - RICH_MEDIA_MOBILE_IN_APP # - RICH_MEDIA_MULTI_FLOATING # - RICH_MEDIA_PEEL_DOWN # - VPAID_LINEAR # - VPAID_NON_LINEAR # Corresponds to the JSON property `richMediaExitOverrides` # @return [Array] attr_accessor :rich_media_exit_overrides # Sequence number of the creative assignment, applicable when the rotation type # is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, # inclusive. # Corresponds to the JSON property `sequence` # @return [Fixnum] attr_accessor :sequence # Whether the creative to be assigned is SSL-compliant. This is a read-only # field that is auto-generated when the ad is inserted or updated. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Date and time that the assigned creative should start serving. # Corresponds to the JSON property `startTime` # @return [DateTime] attr_accessor :start_time # Weight of the creative assignment, applicable when the rotation type is # CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. # Corresponds to the JSON property `weight` # @return [Fixnum] attr_accessor :weight def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active = args[:active] if args.key?(:active) @apply_event_tags = args[:apply_event_tags] if args.key?(:apply_event_tags) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @companion_creative_overrides = args[:companion_creative_overrides] if args.key?(:companion_creative_overrides) @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments) @creative_id = args[:creative_id] if args.key?(:creative_id) @creative_id_dimension_value = args[:creative_id_dimension_value] if args.key?(:creative_id_dimension_value) @end_time = args[:end_time] if args.key?(:end_time) @rich_media_exit_overrides = args[:rich_media_exit_overrides] if args.key?(:rich_media_exit_overrides) @sequence = args[:sequence] if args.key?(:sequence) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @start_time = args[:start_time] if args.key?(:start_time) @weight = args[:weight] if args.key?(:weight) end end # Click-through URL class CreativeClickThroughUrl include Google::Apis::Core::Hashable # Read-only convenience field representing the actual URL that will be used for # this click-through. The URL is computed as follows: # - If landingPageId is specified then that landing page's URL is assigned to # this field. # - Otherwise, the customClickThroughUrl is assigned to this field. # Corresponds to the JSON property `computedClickThroughUrl` # @return [String] attr_accessor :computed_click_through_url # Custom click-through URL. Applicable if the landingPageId field is left unset. # Corresponds to the JSON property `customClickThroughUrl` # @return [String] attr_accessor :custom_click_through_url # ID of the landing page for the click-through URL. # Corresponds to the JSON property `landingPageId` # @return [Fixnum] attr_accessor :landing_page_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @computed_click_through_url = args[:computed_click_through_url] if args.key?(:computed_click_through_url) @custom_click_through_url = args[:custom_click_through_url] if args.key?(:custom_click_through_url) @landing_page_id = args[:landing_page_id] if args.key?(:landing_page_id) end end # Creative Custom Event. class CreativeCustomEvent include Google::Apis::Core::Hashable # Unique ID of this event used by DDM Reporting and Data Transfer. This is a # read-only field. # Corresponds to the JSON property `advertiserCustomEventId` # @return [Fixnum] attr_accessor :advertiser_custom_event_id # User-entered name for the event. # Corresponds to the JSON property `advertiserCustomEventName` # @return [String] attr_accessor :advertiser_custom_event_name # Type of the event. This is a read-only field. # Corresponds to the JSON property `advertiserCustomEventType` # @return [String] attr_accessor :advertiser_custom_event_type # Artwork label column, used to link events in DCM back to events in Studio. # This is a required field and should not be modified after insertion. # Corresponds to the JSON property `artworkLabel` # @return [String] attr_accessor :artwork_label # Artwork type used by the creative.This is a read-only field. # Corresponds to the JSON property `artworkType` # @return [String] attr_accessor :artwork_type # Click-through URL # Corresponds to the JSON property `exitClickThroughUrl` # @return [Google::Apis::DfareportingV3_0::CreativeClickThroughUrl] attr_accessor :exit_click_through_url # ID of this event. This is a required field and should not be modified after # insertion. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Popup Window Properties. # Corresponds to the JSON property `popupWindowProperties` # @return [Google::Apis::DfareportingV3_0::PopupWindowProperties] attr_accessor :popup_window_properties # Target type used by the event. # Corresponds to the JSON property `targetType` # @return [String] attr_accessor :target_type # Video reporting ID, used to differentiate multiple videos in a single creative. # This is a read-only field. # Corresponds to the JSON property `videoReportingId` # @return [String] attr_accessor :video_reporting_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @advertiser_custom_event_id = args[:advertiser_custom_event_id] if args.key?(:advertiser_custom_event_id) @advertiser_custom_event_name = args[:advertiser_custom_event_name] if args.key?(:advertiser_custom_event_name) @advertiser_custom_event_type = args[:advertiser_custom_event_type] if args.key?(:advertiser_custom_event_type) @artwork_label = args[:artwork_label] if args.key?(:artwork_label) @artwork_type = args[:artwork_type] if args.key?(:artwork_type) @exit_click_through_url = args[:exit_click_through_url] if args.key?(:exit_click_through_url) @id = args[:id] if args.key?(:id) @popup_window_properties = args[:popup_window_properties] if args.key?(:popup_window_properties) @target_type = args[:target_type] if args.key?(:target_type) @video_reporting_id = args[:video_reporting_id] if args.key?(:video_reporting_id) end end # Contains properties of a creative field. class CreativeField include Google::Apis::Core::Hashable # Account ID of this creative field. This is a read-only field that can be left # blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this creative field. This is a required field on insertion. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # ID of this creative field. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeField". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this creative field. This is a required field and must be less than # 256 characters long and unique among creative fields of the same advertiser. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this creative field. This is a read-only field that can be # left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Creative Field Assignment. class CreativeFieldAssignment include Google::Apis::Core::Hashable # ID of the creative field. # Corresponds to the JSON property `creativeFieldId` # @return [Fixnum] attr_accessor :creative_field_id # ID of the creative field value. # Corresponds to the JSON property `creativeFieldValueId` # @return [Fixnum] attr_accessor :creative_field_value_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creative_field_id = args[:creative_field_id] if args.key?(:creative_field_id) @creative_field_value_id = args[:creative_field_value_id] if args.key?(:creative_field_value_id) end end # Contains properties of a creative field value. class CreativeFieldValue include Google::Apis::Core::Hashable # ID of this creative field value. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeFieldValue". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Value of this creative field value. It needs to be less than 256 characters in # length and unique per creative field. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @value = args[:value] if args.key?(:value) end end # Creative Field Value List Response class CreativeFieldValuesListResponse include Google::Apis::Core::Hashable # Creative field value collection. # Corresponds to the JSON property `creativeFieldValues` # @return [Array] attr_accessor :creative_field_values # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeFieldValuesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @creative_field_values = args[:creative_field_values] if args.key?(:creative_field_values) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Creative Field List Response class CreativeFieldsListResponse include Google::Apis::Core::Hashable # Creative field collection. # Corresponds to the JSON property `creativeFields` # @return [Array] attr_accessor :creative_fields # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeFieldsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @creative_fields = args[:creative_fields] if args.key?(:creative_fields) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Contains properties of a creative group. class CreativeGroup include Google::Apis::Core::Hashable # Account ID of this creative group. This is a read-only field that can be left # blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this creative group. This is a required field on insertion. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Subgroup of the creative group. Assign your creative groups to a subgroup in # order to filter or manage them more easily. This field is required on # insertion and is read-only after insertion. Acceptable values are 1 to 2, # inclusive. # Corresponds to the JSON property `groupNumber` # @return [Fixnum] attr_accessor :group_number # ID of this creative group. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this creative group. This is a required field and must be less than # 256 characters long and unique among creative groups of the same advertiser. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this creative group. This is a read-only field that can be # left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @group_number = args[:group_number] if args.key?(:group_number) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Creative Group Assignment. class CreativeGroupAssignment include Google::Apis::Core::Hashable # ID of the creative group to be assigned. # Corresponds to the JSON property `creativeGroupId` # @return [Fixnum] attr_accessor :creative_group_id # Creative group number of the creative group assignment. # Corresponds to the JSON property `creativeGroupNumber` # @return [String] attr_accessor :creative_group_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creative_group_id = args[:creative_group_id] if args.key?(:creative_group_id) @creative_group_number = args[:creative_group_number] if args.key?(:creative_group_number) end end # Creative Group List Response class CreativeGroupsListResponse include Google::Apis::Core::Hashable # Creative group collection. # Corresponds to the JSON property `creativeGroups` # @return [Array] attr_accessor :creative_groups # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativeGroupsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @creative_groups = args[:creative_groups] if args.key?(:creative_groups) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Creative optimization settings. class CreativeOptimizationConfiguration include Google::Apis::Core::Hashable # ID of this creative optimization config. This field is auto-generated when the # campaign is inserted or updated. It can be null for existing campaigns. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Name of this creative optimization config. This is a required field and must # be less than 129 characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # List of optimization activities associated with this configuration. # Corresponds to the JSON property `optimizationActivitys` # @return [Array] attr_accessor :optimization_activitys # Optimization model for this configuration. # Corresponds to the JSON property `optimizationModel` # @return [String] attr_accessor :optimization_model def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @optimization_activitys = args[:optimization_activitys] if args.key?(:optimization_activitys) @optimization_model = args[:optimization_model] if args.key?(:optimization_model) end end # Creative Rotation. class CreativeRotation include Google::Apis::Core::Hashable # Creative assignments in this creative rotation. # Corresponds to the JSON property `creativeAssignments` # @return [Array] attr_accessor :creative_assignments # Creative optimization configuration that is used by this ad. It should refer # to one of the existing optimization configurations in the ad's campaign. If it # is unset or set to 0, then the campaign's default optimization configuration # will be used for this ad. # Corresponds to the JSON property `creativeOptimizationConfigurationId` # @return [Fixnum] attr_accessor :creative_optimization_configuration_id # Type of creative rotation. Can be used to specify whether to use sequential or # random rotation. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. # Corresponds to the JSON property `weightCalculationStrategy` # @return [String] attr_accessor :weight_calculation_strategy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creative_assignments = args[:creative_assignments] if args.key?(:creative_assignments) @creative_optimization_configuration_id = args[:creative_optimization_configuration_id] if args.key?(:creative_optimization_configuration_id) @type = args[:type] if args.key?(:type) @weight_calculation_strategy = args[:weight_calculation_strategy] if args.key?(:weight_calculation_strategy) end end # Creative Settings class CreativeSettings include Google::Apis::Core::Hashable # Header text for iFrames for this site. Must be less than or equal to 2000 # characters long. # Corresponds to the JSON property `iFrameFooter` # @return [String] attr_accessor :i_frame_footer # Header text for iFrames for this site. Must be less than or equal to 2000 # characters long. # Corresponds to the JSON property `iFrameHeader` # @return [String] attr_accessor :i_frame_header def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @i_frame_footer = args[:i_frame_footer] if args.key?(:i_frame_footer) @i_frame_header = args[:i_frame_header] if args.key?(:i_frame_header) end end # Creative List Response class CreativesListResponse include Google::Apis::Core::Hashable # Creative collection. # Corresponds to the JSON property `creatives` # @return [Array] attr_accessor :creatives # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#creativesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Represents fields that are compatible to be selected for a report of type " # CROSS_DIMENSION_REACH". class CrossDimensionReachReportCompatibleFields include Google::Apis::Core::Hashable # Dimensions which are compatible to be selected in the "breakdown" section of # the report. # Corresponds to the JSON property `breakdown` # @return [Array] attr_accessor :breakdown # Dimensions which are compatible to be selected in the "dimensionFilters" # section of the report. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # The kind of resource this is, in this case dfareporting# # crossDimensionReachReportCompatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metrics which are compatible to be selected in the "metricNames" section of # the report. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Metrics which are compatible to be selected in the "overlapMetricNames" # section of the report. # Corresponds to the JSON property `overlapMetrics` # @return [Array] attr_accessor :overlap_metrics def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @breakdown = args[:breakdown] if args.key?(:breakdown) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) @overlap_metrics = args[:overlap_metrics] if args.key?(:overlap_metrics) end end # A custom floodlight variable. class CustomFloodlightVariable include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#customFloodlightVariable". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The type of custom floodlight variable to supply a value for. These map to the # "u[1-20]=" in the tags. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The value of the custom floodlight variable. The length of string must not # exceed 50 characters. # 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) @kind = args[:kind] if args.key?(:kind) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) end end # Represents a Custom Rich Media Events group. class CustomRichMediaEvents include Google::Apis::Core::Hashable # List of custom rich media event IDs. Dimension values must be all of type dfa: # richMediaEventTypeIdAndName. # Corresponds to the JSON property `filteredEventIds` # @return [Array] attr_accessor :filtered_event_ids # The kind of resource this is, in this case dfareporting#customRichMediaEvents. # 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) @filtered_event_ids = args[:filtered_event_ids] if args.key?(:filtered_event_ids) @kind = args[:kind] if args.key?(:kind) end end # Represents a date range. class DateRange include Google::Apis::Core::Hashable # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" # . # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # The kind of resource this is, in this case dfareporting#dateRange. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The date range relative to the date of when the report is run. # Corresponds to the JSON property `relativeDateRange` # @return [String] attr_accessor :relative_date_range # The start date of the date range, inclusive. A string of the format: "yyyy-MM- # dd". # Corresponds to the JSON property `startDate` # @return [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) @kind = args[:kind] if args.key?(:kind) @relative_date_range = args[:relative_date_range] if args.key?(:relative_date_range) @start_date = args[:start_date] if args.key?(:start_date) end end # Day Part Targeting. class DayPartTargeting include Google::Apis::Core::Hashable # Days of the week when the ad will serve. # Acceptable values are: # - "SUNDAY" # - "MONDAY" # - "TUESDAY" # - "WEDNESDAY" # - "THURSDAY" # - "FRIDAY" # - "SATURDAY" # Corresponds to the JSON property `daysOfWeek` # @return [Array] attr_accessor :days_of_week # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is # 11 PM to midnight. Can be specified with days of week, in which case the ad # would serve during these hours on the specified days. For example if Monday, # Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, # 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays # at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. # Corresponds to the JSON property `hoursOfDay` # @return [Array] attr_accessor :hours_of_day # Whether or not to use the user's local time. If false, the America/New York # time zone applies. # Corresponds to the JSON property `userLocalTime` # @return [Boolean] attr_accessor :user_local_time alias_method :user_local_time?, :user_local_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @days_of_week = args[:days_of_week] if args.key?(:days_of_week) @hours_of_day = args[:hours_of_day] if args.key?(:hours_of_day) @user_local_time = args[:user_local_time] if args.key?(:user_local_time) end end # Properties of inheriting and overriding the default click-through event tag. A # campaign may override the event tag defined at the advertiser level, and an ad # may also override the campaign's setting further. class DefaultClickThroughEventTagProperties include Google::Apis::Core::Hashable # ID of the click-through event tag to apply to all ads in this entity's scope. # Corresponds to the JSON property `defaultClickThroughEventTagId` # @return [Fixnum] attr_accessor :default_click_through_event_tag_id # Whether this entity should override the inherited default click-through event # tag with its own defined value. # Corresponds to the JSON property `overrideInheritedEventTag` # @return [Boolean] attr_accessor :override_inherited_event_tag alias_method :override_inherited_event_tag?, :override_inherited_event_tag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_click_through_event_tag_id = args[:default_click_through_event_tag_id] if args.key?(:default_click_through_event_tag_id) @override_inherited_event_tag = args[:override_inherited_event_tag] if args.key?(:override_inherited_event_tag) end end # Delivery Schedule. class DeliverySchedule include Google::Apis::Core::Hashable # Frequency Cap. # Corresponds to the JSON property `frequencyCap` # @return [Google::Apis::DfareportingV3_0::FrequencyCap] attr_accessor :frequency_cap # Whether or not hard cutoff is enabled. If true, the ad will not serve after # the end date and time. Otherwise the ad will continue to be served until it # has reached its delivery goals. # Corresponds to the JSON property `hardCutoff` # @return [Boolean] attr_accessor :hard_cutoff alias_method :hard_cutoff?, :hard_cutoff # Impression ratio for this ad. This ratio determines how often each ad is # served relative to the others. For example, if ad A has an impression ratio of # 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times # as often as ad A. Acceptable values are 1 to 10, inclusive. # Corresponds to the JSON property `impressionRatio` # @return [Fixnum] attr_accessor :impression_ratio # Serving priority of an ad, with respect to other ads. The lower the priority # number, the greater the priority with which it is served. # Corresponds to the JSON property `priority` # @return [String] attr_accessor :priority def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @frequency_cap = args[:frequency_cap] if args.key?(:frequency_cap) @hard_cutoff = args[:hard_cutoff] if args.key?(:hard_cutoff) @impression_ratio = args[:impression_ratio] if args.key?(:impression_ratio) @priority = args[:priority] if args.key?(:priority) end end # DFP Settings class DfpSettings include Google::Apis::Core::Hashable # DFP network code for this directory site. # Corresponds to the JSON property `dfpNetworkCode` # @return [String] attr_accessor :dfp_network_code # DFP network name for this directory site. # Corresponds to the JSON property `dfpNetworkName` # @return [String] attr_accessor :dfp_network_name # Whether this directory site accepts programmatic placements. # Corresponds to the JSON property `programmaticPlacementAccepted` # @return [Boolean] attr_accessor :programmatic_placement_accepted alias_method :programmatic_placement_accepted?, :programmatic_placement_accepted # Whether this directory site accepts publisher-paid tags. # Corresponds to the JSON property `pubPaidPlacementAccepted` # @return [Boolean] attr_accessor :pub_paid_placement_accepted alias_method :pub_paid_placement_accepted?, :pub_paid_placement_accepted # Whether this directory site is available only via DoubleClick Publisher Portal. # Corresponds to the JSON property `publisherPortalOnly` # @return [Boolean] attr_accessor :publisher_portal_only alias_method :publisher_portal_only?, :publisher_portal_only def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dfp_network_code = args[:dfp_network_code] if args.key?(:dfp_network_code) @dfp_network_name = args[:dfp_network_name] if args.key?(:dfp_network_name) @programmatic_placement_accepted = args[:programmatic_placement_accepted] if args.key?(:programmatic_placement_accepted) @pub_paid_placement_accepted = args[:pub_paid_placement_accepted] if args.key?(:pub_paid_placement_accepted) @publisher_portal_only = args[:publisher_portal_only] if args.key?(:publisher_portal_only) end end # Represents a dimension. class Dimension include Google::Apis::Core::Hashable # The kind of resource this is, in this case dfareporting#dimension. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The dimension name, e.g. dfa:advertiser # 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) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Represents a dimension filter. class DimensionFilter include Google::Apis::Core::Hashable # The name of the dimension to filter. # Corresponds to the JSON property `dimensionName` # @return [String] attr_accessor :dimension_name # The kind of resource this is, in this case dfareporting#dimensionFilter. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The value of the dimension to filter. # 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) @dimension_name = args[:dimension_name] if args.key?(:dimension_name) @kind = args[:kind] if args.key?(:kind) @value = args[:value] if args.key?(:value) end end # Represents a DimensionValue resource. class DimensionValue include Google::Apis::Core::Hashable # The name of the dimension. # Corresponds to the JSON property `dimensionName` # @return [String] attr_accessor :dimension_name # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID associated with the value if available. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of resource this is, in this case dfareporting#dimensionValue. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Determines how the 'value' field is matched when filtering. If not specified, # defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a # placeholder for variable length character sequences, and it can be escaped # with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow # a matchType other than EXACT. # Corresponds to the JSON property `matchType` # @return [String] attr_accessor :match_type # The value of the dimension. # 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) @dimension_name = args[:dimension_name] if args.key?(:dimension_name) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @match_type = args[:match_type] if args.key?(:match_type) @value = args[:value] if args.key?(:value) end end # Represents the list of DimensionValue resources. class DimensionValueList include Google::Apis::Core::Hashable # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The dimension values returned in this response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of list this is, in this case dfareporting#dimensionValueList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through dimension values. To retrieve the next # page of results, set the next request's "pageToken" to the value of this field. # The page token is only valid for a limited amount of time and should not be # persisted. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # Represents a DimensionValuesRequest. class DimensionValueRequest include Google::Apis::Core::Hashable # The name of the dimension for which values should be requested. # Corresponds to the JSON property `dimensionName` # @return [String] attr_accessor :dimension_name # The end date of the date range for which to retrieve dimension values. A # string of the format "yyyy-MM-dd". # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # The list of filters by which to filter values. The filters are ANDed. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters # The kind of request this is, in this case dfareporting#dimensionValueRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The start date of the date range for which to retrieve dimension values. A # string of the format "yyyy-MM-dd". # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimension_name = args[:dimension_name] if args.key?(:dimension_name) @end_date = args[:end_date] if args.key?(:end_date) @filters = args[:filters] if args.key?(:filters) @kind = args[:kind] if args.key?(:kind) @start_date = args[:start_date] if args.key?(:start_date) end end # DirectorySites contains properties of a website from the Site Directory. Sites # need to be added to an account via the Sites resource before they can be # assigned to a placement. class DirectorySite include Google::Apis::Core::Hashable # Whether this directory site is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Directory site contacts. # Corresponds to the JSON property `contactAssignments` # @return [Array] attr_accessor :contact_assignments # Country ID of this directory site. This is a read-only field. # Corresponds to the JSON property `countryId` # @return [Fixnum] attr_accessor :country_id # Currency ID of this directory site. This is a read-only field. # Possible values are: # - "1" for USD # - "2" for GBP # - "3" for ESP # - "4" for SEK # - "5" for CAD # - "6" for JPY # - "7" for DEM # - "8" for AUD # - "9" for FRF # - "10" for ITL # - "11" for DKK # - "12" for NOK # - "13" for FIM # - "14" for ZAR # - "15" for IEP # - "16" for NLG # - "17" for EUR # - "18" for KRW # - "19" for TWD # - "20" for SGD # - "21" for CNY # - "22" for HKD # - "23" for NZD # - "24" for MYR # - "25" for BRL # - "26" for PTE # - "27" for MXP # - "28" for CLP # - "29" for TRY # - "30" for ARS # - "31" for PEN # - "32" for ILS # - "33" for CHF # - "34" for VEF # - "35" for COP # - "36" for GTQ # - "37" for PLN # - "39" for INR # - "40" for THB # - "41" for IDR # - "42" for CZK # - "43" for RON # - "44" for HUF # - "45" for RUB # - "46" for AED # - "47" for BGN # - "48" for HRK # - "49" for MXN # - "50" for NGN # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id # Description of this directory site. This is a read-only field. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # ID of this directory site. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Tag types for regular placements. # Acceptable values are: # - "STANDARD" # - "IFRAME_JAVASCRIPT_INPAGE" # - "INTERNAL_REDIRECT_INPAGE" # - "JAVASCRIPT_INPAGE" # Corresponds to the JSON property `inpageTagFormats` # @return [Array] attr_accessor :inpage_tag_formats # Tag types for interstitial placements. # Acceptable values are: # - "IFRAME_JAVASCRIPT_INTERSTITIAL" # - "INTERNAL_REDIRECT_INTERSTITIAL" # - "JAVASCRIPT_INTERSTITIAL" # Corresponds to the JSON property `interstitialTagFormats` # @return [Array] attr_accessor :interstitial_tag_formats # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#directorySite". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this directory site. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Parent directory site ID. # Corresponds to the JSON property `parentId` # @return [Fixnum] attr_accessor :parent_id # Directory Site Settings # Corresponds to the JSON property `settings` # @return [Google::Apis::DfareportingV3_0::DirectorySiteSettings] attr_accessor :settings # URL of this directory site. # 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) @active = args[:active] if args.key?(:active) @contact_assignments = args[:contact_assignments] if args.key?(:contact_assignments) @country_id = args[:country_id] if args.key?(:country_id) @currency_id = args[:currency_id] if args.key?(:currency_id) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @inpage_tag_formats = args[:inpage_tag_formats] if args.key?(:inpage_tag_formats) @interstitial_tag_formats = args[:interstitial_tag_formats] if args.key?(:interstitial_tag_formats) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @parent_id = args[:parent_id] if args.key?(:parent_id) @settings = args[:settings] if args.key?(:settings) @url = args[:url] if args.key?(:url) end end # Contains properties of a Site Directory contact. class DirectorySiteContact include Google::Apis::Core::Hashable # Address of this directory site contact. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Email address of this directory site contact. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # First name of this directory site contact. # Corresponds to the JSON property `firstName` # @return [String] attr_accessor :first_name # ID of this directory site contact. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#directorySiteContact". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Last name of this directory site contact. # Corresponds to the JSON property `lastName` # @return [String] attr_accessor :last_name # Phone number of this directory site contact. # Corresponds to the JSON property `phone` # @return [String] attr_accessor :phone # Directory site contact role. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role # Title or designation of this directory site contact. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Directory site contact 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) @address = args[:address] if args.key?(:address) @email = args[:email] if args.key?(:email) @first_name = args[:first_name] if args.key?(:first_name) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_name = args[:last_name] if args.key?(:last_name) @phone = args[:phone] if args.key?(:phone) @role = args[:role] if args.key?(:role) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) end end # Directory Site Contact Assignment class DirectorySiteContactAssignment include Google::Apis::Core::Hashable # ID of this directory site contact. This is a read-only, auto-generated field. # Corresponds to the JSON property `contactId` # @return [Fixnum] attr_accessor :contact_id # Visibility of this directory site contact assignment. When set to PUBLIC this # contact assignment is visible to all account and agency users; when set to # PRIVATE it is visible only to the site. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contact_id = args[:contact_id] if args.key?(:contact_id) @visibility = args[:visibility] if args.key?(:visibility) end end # Directory Site Contact List Response class DirectorySiteContactsListResponse include Google::Apis::Core::Hashable # Directory site contact collection # Corresponds to the JSON property `directorySiteContacts` # @return [Array] attr_accessor :directory_site_contacts # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#directorySiteContactsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @directory_site_contacts = args[:directory_site_contacts] if args.key?(:directory_site_contacts) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Directory Site Settings class DirectorySiteSettings include Google::Apis::Core::Hashable # Whether this directory site has disabled active view creatives. # Corresponds to the JSON property `activeViewOptOut` # @return [Boolean] attr_accessor :active_view_opt_out alias_method :active_view_opt_out?, :active_view_opt_out # DFP Settings # Corresponds to the JSON property `dfpSettings` # @return [Google::Apis::DfareportingV3_0::DfpSettings] attr_accessor :dfp_settings # Whether this site accepts in-stream video ads. # Corresponds to the JSON property `instreamVideoPlacementAccepted` # @return [Boolean] attr_accessor :instream_video_placement_accepted alias_method :instream_video_placement_accepted?, :instream_video_placement_accepted # Whether this site accepts interstitial ads. # Corresponds to the JSON property `interstitialPlacementAccepted` # @return [Boolean] attr_accessor :interstitial_placement_accepted alias_method :interstitial_placement_accepted?, :interstitial_placement_accepted # Whether this directory site has disabled Nielsen OCR reach ratings. # Corresponds to the JSON property `nielsenOcrOptOut` # @return [Boolean] attr_accessor :nielsen_ocr_opt_out alias_method :nielsen_ocr_opt_out?, :nielsen_ocr_opt_out # Whether this directory site has disabled generation of Verification ins tags. # Corresponds to the JSON property `verificationTagOptOut` # @return [Boolean] attr_accessor :verification_tag_opt_out alias_method :verification_tag_opt_out?, :verification_tag_opt_out # Whether this directory site has disabled active view for in-stream video # creatives. This is a read-only field. # Corresponds to the JSON property `videoActiveViewOptOut` # @return [Boolean] attr_accessor :video_active_view_opt_out alias_method :video_active_view_opt_out?, :video_active_view_opt_out def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) @dfp_settings = args[:dfp_settings] if args.key?(:dfp_settings) @instream_video_placement_accepted = args[:instream_video_placement_accepted] if args.key?(:instream_video_placement_accepted) @interstitial_placement_accepted = args[:interstitial_placement_accepted] if args.key?(:interstitial_placement_accepted) @nielsen_ocr_opt_out = args[:nielsen_ocr_opt_out] if args.key?(:nielsen_ocr_opt_out) @verification_tag_opt_out = args[:verification_tag_opt_out] if args.key?(:verification_tag_opt_out) @video_active_view_opt_out = args[:video_active_view_opt_out] if args.key?(:video_active_view_opt_out) end end # Directory Site List Response class DirectorySitesListResponse include Google::Apis::Core::Hashable # Directory site collection. # Corresponds to the JSON property `directorySites` # @return [Array] attr_accessor :directory_sites # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#directorySitesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @directory_sites = args[:directory_sites] if args.key?(:directory_sites) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Contains properties of a dynamic targeting key. Dynamic targeting keys are # unique, user-friendly labels, created at the advertiser level in DCM, that can # be assigned to ads, creatives, and placements and used for targeting with # DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM # IDs (such as placement IDs) to save time and avoid errors in your dynamic # feeds. class DynamicTargetingKey include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#dynamicTargetingKey". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this dynamic targeting key. This is a required field. Must be less # than 256 characters long and cannot contain commas. All characters are # converted to lowercase. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # ID of the object of this dynamic targeting key. This is a required field. # Corresponds to the JSON property `objectId` # @return [Fixnum] attr_accessor :object_id_prop # Type of the object of this dynamic targeting key. This is a required field. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @object_type = args[:object_type] if args.key?(:object_type) end end # Dynamic Targeting Key List Response class DynamicTargetingKeysListResponse include Google::Apis::Core::Hashable # Dynamic targeting key collection. # Corresponds to the JSON property `dynamicTargetingKeys` # @return [Array] attr_accessor :dynamic_targeting_keys # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#dynamicTargetingKeysListResponse". # 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) @dynamic_targeting_keys = args[:dynamic_targeting_keys] if args.key?(:dynamic_targeting_keys) @kind = args[:kind] if args.key?(:kind) end end # A description of how user IDs are encrypted. class EncryptionInfo include Google::Apis::Core::Hashable # The encryption entity ID. This should match the encryption configuration for # ad serving or Data Transfer. # Corresponds to the JSON property `encryptionEntityId` # @return [Fixnum] attr_accessor :encryption_entity_id # The encryption entity type. This should match the encryption configuration for # ad serving or Data Transfer. # Corresponds to the JSON property `encryptionEntityType` # @return [String] attr_accessor :encryption_entity_type # Describes whether the encrypted cookie was received from ad serving (the %m # macro) or from Data Transfer. # Corresponds to the JSON property `encryptionSource` # @return [String] attr_accessor :encryption_source # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#encryptionInfo". # 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) @encryption_entity_id = args[:encryption_entity_id] if args.key?(:encryption_entity_id) @encryption_entity_type = args[:encryption_entity_type] if args.key?(:encryption_entity_type) @encryption_source = args[:encryption_source] if args.key?(:encryption_source) @kind = args[:kind] if args.key?(:kind) end end # Contains properties of an event tag. class EventTag include Google::Apis::Core::Hashable # Account ID of this event tag. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this event tag. This field or the campaignId field is # required on insertion. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Campaign ID of this event tag. This field or the advertiserId field is # required on insertion. # Corresponds to the JSON property `campaignId` # @return [Fixnum] attr_accessor :campaign_id # Represents a DimensionValue resource. # Corresponds to the JSON property `campaignIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :campaign_id_dimension_value # Whether this event tag should be automatically enabled for all of the # advertiser's campaigns and ads. # Corresponds to the JSON property `enabledByDefault` # @return [Boolean] attr_accessor :enabled_by_default alias_method :enabled_by_default?, :enabled_by_default # Whether to remove this event tag from ads that are trafficked through # DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag # uses a pixel that is unapproved for Ad Exchange bids on one or more networks, # such as the Google Display Network. # Corresponds to the JSON property `excludeFromAdxRequests` # @return [Boolean] attr_accessor :exclude_from_adx_requests alias_method :exclude_from_adx_requests?, :exclude_from_adx_requests # ID of this event tag. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#eventTag". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this event tag. This is a required field and must be less than 256 # characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Site filter type for this event tag. If no type is specified then the event # tag will be applied to all sites. # Corresponds to the JSON property `siteFilterType` # @return [String] attr_accessor :site_filter_type # Filter list of site IDs associated with this event tag. The siteFilterType # determines whether this is a whitelist or blacklist filter. # Corresponds to the JSON property `siteIds` # @return [Array] attr_accessor :site_ids # Whether this tag is SSL-compliant or not. This is a read-only field. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Status of this event tag. Must be ENABLED for this event tag to fire. This is # a required field. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Subaccount ID of this event tag. This is a read-only field that can be left # blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Event tag type. Can be used to specify whether to use a third-party pixel, a # third-party JavaScript URL, or a third-party click-through URL for either # impression or click tracking. This is a required field. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Payload URL for this event tag. The URL on a click-through event tag should # have a landing page URL appended to the end of it. This field is required on # insertion. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Number of times the landing page URL should be URL-escaped before being # appended to the click-through event tag URL. Only applies to click-through # event tags as specified by the event tag type. # Corresponds to the JSON property `urlEscapeLevels` # @return [Fixnum] attr_accessor :url_escape_levels def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @campaign_id = args[:campaign_id] if args.key?(:campaign_id) @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) @enabled_by_default = args[:enabled_by_default] if args.key?(:enabled_by_default) @exclude_from_adx_requests = args[:exclude_from_adx_requests] if args.key?(:exclude_from_adx_requests) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @site_filter_type = args[:site_filter_type] if args.key?(:site_filter_type) @site_ids = args[:site_ids] if args.key?(:site_ids) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @status = args[:status] if args.key?(:status) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @type = args[:type] if args.key?(:type) @url = args[:url] if args.key?(:url) @url_escape_levels = args[:url_escape_levels] if args.key?(:url_escape_levels) end end # Event tag override information. class EventTagOverride include Google::Apis::Core::Hashable # Whether this override is enabled. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # ID of this event tag override. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enabled = args[:enabled] if args.key?(:enabled) @id = args[:id] if args.key?(:id) end end # Event Tag List Response class EventTagsListResponse include Google::Apis::Core::Hashable # Event tag collection. # Corresponds to the JSON property `eventTags` # @return [Array] attr_accessor :event_tags # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#eventTagsListResponse". # 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) @event_tags = args[:event_tags] if args.key?(:event_tags) @kind = args[:kind] if args.key?(:kind) end end # Represents a File resource. A file contains the metadata for a report run. It # shows the status of the run and holds the URLs to the generated report data if # the run is finished and the status is "REPORT_AVAILABLE". class File include Google::Apis::Core::Hashable # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV3_0::DateRange] attr_accessor :date_range # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The filename of the file. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name # The output format of the report. Only available once the file is available. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # The unique ID of this report file. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The kind of resource this is, in this case dfareporting#file. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The timestamp in milliseconds since epoch when this file was last modified. # Corresponds to the JSON property `lastModifiedTime` # @return [Fixnum] attr_accessor :last_modified_time # The ID of the report this file was generated from. # Corresponds to the JSON property `reportId` # @return [Fixnum] attr_accessor :report_id # The status of the report file. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The URLs where the completed report file can be downloaded. # Corresponds to the JSON property `urls` # @return [Google::Apis::DfareportingV3_0::File::Urls] attr_accessor :urls def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @date_range = args[:date_range] if args.key?(:date_range) @etag = args[:etag] if args.key?(:etag) @file_name = args[:file_name] if args.key?(:file_name) @format = args[:format] if args.key?(:format) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time) @report_id = args[:report_id] if args.key?(:report_id) @status = args[:status] if args.key?(:status) @urls = args[:urls] if args.key?(:urls) end # The URLs where the completed report file can be downloaded. class Urls include Google::Apis::Core::Hashable # The URL for downloading the report data through the API. # Corresponds to the JSON property `apiUrl` # @return [String] attr_accessor :api_url # The URL for downloading the report data through a browser. # Corresponds to the JSON property `browserUrl` # @return [String] attr_accessor :browser_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @api_url = args[:api_url] if args.key?(:api_url) @browser_url = args[:browser_url] if args.key?(:browser_url) end end end # Represents the list of File resources. class FileList include Google::Apis::Core::Hashable # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The files returned in this response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of list this is, in this case dfareporting#fileList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through files. To retrieve the next page of # results, set the next request's "pageToken" to the value of this field. The # page token is only valid for a limited amount of time and should not be # persisted. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # Flight class Flight include Google::Apis::Core::Hashable # Inventory item flight end date. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # Rate or cost of this flight. # Corresponds to the JSON property `rateOrCost` # @return [Fixnum] attr_accessor :rate_or_cost # Inventory item flight start date. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date # Units of this flight. # 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) @end_date = args[:end_date] if args.key?(:end_date) @rate_or_cost = args[:rate_or_cost] if args.key?(:rate_or_cost) @start_date = args[:start_date] if args.key?(:start_date) @units = args[:units] if args.key?(:units) end end # Floodlight Activity GenerateTag Response class FloodlightActivitiesGenerateTagResponse include Google::Apis::Core::Hashable # Generated tag for this Floodlight activity. For global site tags, this is the # event snippet. # Corresponds to the JSON property `floodlightActivityTag` # @return [String] attr_accessor :floodlight_activity_tag # The global snippet section of a global site tag. The global site tag sets new # cookies on your domain, which will store a unique identifier for a user or the # ad click that brought the user to your site. Learn more. # Corresponds to the JSON property `globalSiteTagGlobalSnippet` # @return [String] attr_accessor :global_site_tag_global_snippet # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightActivitiesGenerateTagResponse". # 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) @floodlight_activity_tag = args[:floodlight_activity_tag] if args.key?(:floodlight_activity_tag) @global_site_tag_global_snippet = args[:global_site_tag_global_snippet] if args.key?(:global_site_tag_global_snippet) @kind = args[:kind] if args.key?(:kind) end end # Floodlight Activity List Response class FloodlightActivitiesListResponse include Google::Apis::Core::Hashable # Floodlight activity collection. # Corresponds to the JSON property `floodlightActivities` # @return [Array] attr_accessor :floodlight_activities # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightActivitiesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @floodlight_activities = args[:floodlight_activities] if args.key?(:floodlight_activities) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Contains properties of a Floodlight activity. class FloodlightActivity include Google::Apis::Core::Hashable # Account ID of this floodlight activity. This is a read-only field that can be # left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this floodlight activity. If this field is left blank, the # value will be copied over either from the activity group's advertiser or the # existing activity's advertiser. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Code type used for cache busting in the generated tag. Applicable only when # floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING # or UNIQUE_COUNTING. # Corresponds to the JSON property `cacheBustingType` # @return [String] attr_accessor :cache_busting_type # Counting method for conversions for this floodlight activity. This is a # required field. # Corresponds to the JSON property `countingMethod` # @return [String] attr_accessor :counting_method # Dynamic floodlight tags. # Corresponds to the JSON property `defaultTags` # @return [Array] attr_accessor :default_tags # URL where this tag will be deployed. If specified, must be less than 256 # characters long. # Corresponds to the JSON property `expectedUrl` # @return [String] attr_accessor :expected_url # Floodlight activity group ID of this floodlight activity. This is a required # field. # Corresponds to the JSON property `floodlightActivityGroupId` # @return [Fixnum] attr_accessor :floodlight_activity_group_id # Name of the associated floodlight activity group. This is a read-only field. # Corresponds to the JSON property `floodlightActivityGroupName` # @return [String] attr_accessor :floodlight_activity_group_name # Tag string of the associated floodlight activity group. This is a read-only # field. # Corresponds to the JSON property `floodlightActivityGroupTagString` # @return [String] attr_accessor :floodlight_activity_group_tag_string # Type of the associated floodlight activity group. This is a read-only field. # Corresponds to the JSON property `floodlightActivityGroupType` # @return [String] attr_accessor :floodlight_activity_group_type # Floodlight configuration ID of this floodlight activity. If this field is left # blank, the value will be copied over either from the activity group's # floodlight configuration or from the existing activity's floodlight # configuration. # Corresponds to the JSON property `floodlightConfigurationId` # @return [Fixnum] attr_accessor :floodlight_configuration_id # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :floodlight_configuration_id_dimension_value # The type of Floodlight tag this activity will generate. This is a required # field. # Corresponds to the JSON property `floodlightTagType` # @return [String] attr_accessor :floodlight_tag_type # Whether this activity is archived. # Corresponds to the JSON property `hidden` # @return [Boolean] attr_accessor :hidden alias_method :hidden?, :hidden # ID of this floodlight activity. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightActivity". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this floodlight activity. This is a required field. Must be less than # 129 characters long and cannot contain quotes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # General notes or implementation instructions for the tag. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # Publisher dynamic floodlight tags. # Corresponds to the JSON property `publisherTags` # @return [Array] attr_accessor :publisher_tags # Whether this tag should use SSL. # Corresponds to the JSON property `secure` # @return [Boolean] attr_accessor :secure alias_method :secure?, :secure # Whether the floodlight activity is SSL-compliant. This is a read-only field, # its value detected by the system from the floodlight tags. # Corresponds to the JSON property `sslCompliant` # @return [Boolean] attr_accessor :ssl_compliant alias_method :ssl_compliant?, :ssl_compliant # Whether this floodlight activity must be SSL-compliant. # Corresponds to the JSON property `sslRequired` # @return [Boolean] attr_accessor :ssl_required alias_method :ssl_required?, :ssl_required # Subaccount ID of this floodlight activity. This is a read-only field that can # be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Tag format type for the floodlight activity. If left blank, the tag format # will default to HTML. # Corresponds to the JSON property `tagFormat` # @return [String] attr_accessor :tag_format # Value of the cat= parameter in the floodlight tag, which the ad servers use to # identify the activity. This is optional: if empty, a new tag string will be # generated for you. This string must be 1 to 8 characters long, with valid # characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique # among activities of the same activity group. This field is read-only after # insertion. # Corresponds to the JSON property `tagString` # @return [String] attr_accessor :tag_string # List of the user-defined variables used by this conversion tag. These map to # the "u[1-100]=" in the tags. Each of these can have a user defined type. # Acceptable values are U1 to U100, inclusive. # Corresponds to the JSON property `userDefinedVariableTypes` # @return [Array] attr_accessor :user_defined_variable_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @cache_busting_type = args[:cache_busting_type] if args.key?(:cache_busting_type) @counting_method = args[:counting_method] if args.key?(:counting_method) @default_tags = args[:default_tags] if args.key?(:default_tags) @expected_url = args[:expected_url] if args.key?(:expected_url) @floodlight_activity_group_id = args[:floodlight_activity_group_id] if args.key?(:floodlight_activity_group_id) @floodlight_activity_group_name = args[:floodlight_activity_group_name] if args.key?(:floodlight_activity_group_name) @floodlight_activity_group_tag_string = args[:floodlight_activity_group_tag_string] if args.key?(:floodlight_activity_group_tag_string) @floodlight_activity_group_type = args[:floodlight_activity_group_type] if args.key?(:floodlight_activity_group_type) @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) @floodlight_tag_type = args[:floodlight_tag_type] if args.key?(:floodlight_tag_type) @hidden = args[:hidden] if args.key?(:hidden) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @publisher_tags = args[:publisher_tags] if args.key?(:publisher_tags) @secure = args[:secure] if args.key?(:secure) @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) @ssl_required = args[:ssl_required] if args.key?(:ssl_required) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @tag_format = args[:tag_format] if args.key?(:tag_format) @tag_string = args[:tag_string] if args.key?(:tag_string) @user_defined_variable_types = args[:user_defined_variable_types] if args.key?(:user_defined_variable_types) end end # Dynamic Tag class FloodlightActivityDynamicTag include Google::Apis::Core::Hashable # ID of this dynamic tag. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Name of this tag. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Tag code. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @tag = args[:tag] if args.key?(:tag) end end # Contains properties of a Floodlight activity group. class FloodlightActivityGroup include Google::Apis::Core::Hashable # Account ID of this floodlight activity group. This is a read-only field that # can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this floodlight activity group. If this field is left blank, # the value will be copied over either from the floodlight configuration's # advertiser or from the existing activity group's advertiser. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Floodlight configuration ID of this floodlight activity group. This is a # required field. # Corresponds to the JSON property `floodlightConfigurationId` # @return [Fixnum] attr_accessor :floodlight_configuration_id # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :floodlight_configuration_id_dimension_value # ID of this floodlight activity group. This is a read-only, auto-generated # field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightActivityGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this floodlight activity group. This is a required field. Must be less # than 65 characters long and cannot contain quotes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this floodlight activity group. This is a read-only field # that can be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Value of the type= parameter in the floodlight tag, which the ad servers use # to identify the activity group that the activity belongs to. This is optional: # if empty, a new tag string will be generated for you. This string must be 1 to # 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This # tag string must also be unique among activity groups of the same floodlight # configuration. This field is read-only after insertion. # Corresponds to the JSON property `tagString` # @return [String] attr_accessor :tag_string # Type of the floodlight activity group. This is a required field that is read- # only after insertion. # 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) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @tag_string = args[:tag_string] if args.key?(:tag_string) @type = args[:type] if args.key?(:type) end end # Floodlight Activity Group List Response class FloodlightActivityGroupsListResponse include Google::Apis::Core::Hashable # Floodlight activity group collection. # Corresponds to the JSON property `floodlightActivityGroups` # @return [Array] attr_accessor :floodlight_activity_groups # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightActivityGroupsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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) @floodlight_activity_groups = args[:floodlight_activity_groups] if args.key?(:floodlight_activity_groups) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Publisher Dynamic Tag class FloodlightActivityPublisherDynamicTag include Google::Apis::Core::Hashable # Whether this tag is applicable only for click-throughs. # Corresponds to the JSON property `clickThrough` # @return [Boolean] attr_accessor :click_through alias_method :click_through?, :click_through # Directory site ID of this dynamic tag. This is a write-only field that can be # used as an alternative to the siteId field. When this resource is retrieved, # only the siteId field will be populated. # Corresponds to the JSON property `directorySiteId` # @return [Fixnum] attr_accessor :directory_site_id # Dynamic Tag # Corresponds to the JSON property `dynamicTag` # @return [Google::Apis::DfareportingV3_0::FloodlightActivityDynamicTag] attr_accessor :dynamic_tag # Site ID of this dynamic tag. # Corresponds to the JSON property `siteId` # @return [Fixnum] attr_accessor :site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `siteIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :site_id_dimension_value # Whether this tag is applicable only for view-throughs. # Corresponds to the JSON property `viewThrough` # @return [Boolean] attr_accessor :view_through alias_method :view_through?, :view_through def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_through = args[:click_through] if args.key?(:click_through) @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) @dynamic_tag = args[:dynamic_tag] if args.key?(:dynamic_tag) @site_id = args[:site_id] if args.key?(:site_id) @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) @view_through = args[:view_through] if args.key?(:view_through) end end # Contains properties of a Floodlight configuration. class FloodlightConfiguration include Google::Apis::Core::Hashable # Account ID of this floodlight configuration. This is a read-only field that # can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of the parent advertiser of this floodlight configuration. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Whether advertiser data is shared with Google Analytics. # Corresponds to the JSON property `analyticsDataSharingEnabled` # @return [Boolean] attr_accessor :analytics_data_sharing_enabled alias_method :analytics_data_sharing_enabled?, :analytics_data_sharing_enabled # Whether the exposure-to-conversion report is enabled. This report shows # detailed pathway information on up to 10 of the most recent ad exposures seen # by a user before converting. # Corresponds to the JSON property `exposureToConversionEnabled` # @return [Boolean] attr_accessor :exposure_to_conversion_enabled alias_method :exposure_to_conversion_enabled?, :exposure_to_conversion_enabled # Day that will be counted as the first day of the week in reports. This is a # required field. # Corresponds to the JSON property `firstDayOfWeek` # @return [String] attr_accessor :first_day_of_week # ID of this floodlight configuration. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Whether in-app attribution tracking is enabled. # Corresponds to the JSON property `inAppAttributionTrackingEnabled` # @return [Boolean] attr_accessor :in_app_attribution_tracking_enabled alias_method :in_app_attribution_tracking_enabled?, :in_app_attribution_tracking_enabled # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightConfiguration". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Lookback configuration settings. # Corresponds to the JSON property `lookbackConfiguration` # @return [Google::Apis::DfareportingV3_0::LookbackConfiguration] attr_accessor :lookback_configuration # Types of attribution options for natural search conversions. # Corresponds to the JSON property `naturalSearchConversionAttributionOption` # @return [String] attr_accessor :natural_search_conversion_attribution_option # Omniture Integration Settings. # Corresponds to the JSON property `omnitureSettings` # @return [Google::Apis::DfareportingV3_0::OmnitureSettings] attr_accessor :omniture_settings # Subaccount ID of this floodlight configuration. This is a read-only field that # can be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Dynamic and Image Tag Settings. # Corresponds to the JSON property `tagSettings` # @return [Google::Apis::DfareportingV3_0::TagSettings] attr_accessor :tag_settings # List of third-party authentication tokens enabled for this configuration. # Corresponds to the JSON property `thirdPartyAuthenticationTokens` # @return [Array] attr_accessor :third_party_authentication_tokens # List of user defined variables enabled for this configuration. # Corresponds to the JSON property `userDefinedVariableConfigurations` # @return [Array] attr_accessor :user_defined_variable_configurations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @analytics_data_sharing_enabled = args[:analytics_data_sharing_enabled] if args.key?(:analytics_data_sharing_enabled) @exposure_to_conversion_enabled = args[:exposure_to_conversion_enabled] if args.key?(:exposure_to_conversion_enabled) @first_day_of_week = args[:first_day_of_week] if args.key?(:first_day_of_week) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @in_app_attribution_tracking_enabled = args[:in_app_attribution_tracking_enabled] if args.key?(:in_app_attribution_tracking_enabled) @kind = args[:kind] if args.key?(:kind) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @natural_search_conversion_attribution_option = args[:natural_search_conversion_attribution_option] if args.key?(:natural_search_conversion_attribution_option) @omniture_settings = args[:omniture_settings] if args.key?(:omniture_settings) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @tag_settings = args[:tag_settings] if args.key?(:tag_settings) @third_party_authentication_tokens = args[:third_party_authentication_tokens] if args.key?(:third_party_authentication_tokens) @user_defined_variable_configurations = args[:user_defined_variable_configurations] if args.key?(:user_defined_variable_configurations) end end # Floodlight Configuration List Response class FloodlightConfigurationsListResponse include Google::Apis::Core::Hashable # Floodlight configuration collection. # Corresponds to the JSON property `floodlightConfigurations` # @return [Array] attr_accessor :floodlight_configurations # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#floodlightConfigurationsListResponse". # 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) @floodlight_configurations = args[:floodlight_configurations] if args.key?(:floodlight_configurations) @kind = args[:kind] if args.key?(:kind) end end # Represents fields that are compatible to be selected for a report of type " # FlOODLIGHT". class FloodlightReportCompatibleFields include Google::Apis::Core::Hashable # Dimensions which are compatible to be selected in the "dimensionFilters" # section of the report. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # Dimensions which are compatible to be selected in the "dimensions" section of # the report. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # The kind of resource this is, in this case dfareporting# # floodlightReportCompatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metrics which are compatible to be selected in the "metricNames" section of # the report. # 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) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) end end # Frequency Cap. class FrequencyCap include Google::Apis::Core::Hashable # Duration of time, in seconds, for this frequency cap. The maximum duration is # 90 days. Acceptable values are 1 to 7776000, inclusive. # Corresponds to the JSON property `duration` # @return [Fixnum] attr_accessor :duration # Number of times an individual user can be served the ad within the specified # duration. Acceptable values are 1 to 15, inclusive. # Corresponds to the JSON property `impressions` # @return [Fixnum] attr_accessor :impressions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @duration = args[:duration] if args.key?(:duration) @impressions = args[:impressions] if args.key?(:impressions) end end # FsCommand. class FsCommand include Google::Apis::Core::Hashable # Distance from the left of the browser.Applicable when positionOption is # DISTANCE_FROM_TOP_LEFT_CORNER. # Corresponds to the JSON property `left` # @return [Fixnum] attr_accessor :left # Position in the browser where the window will open. # Corresponds to the JSON property `positionOption` # @return [String] attr_accessor :position_option # Distance from the top of the browser. Applicable when positionOption is # DISTANCE_FROM_TOP_LEFT_CORNER. # Corresponds to the JSON property `top` # @return [Fixnum] attr_accessor :top # Height of the window. # Corresponds to the JSON property `windowHeight` # @return [Fixnum] attr_accessor :window_height # Width of the window. # Corresponds to the JSON property `windowWidth` # @return [Fixnum] attr_accessor :window_width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @left = args[:left] if args.key?(:left) @position_option = args[:position_option] if args.key?(:position_option) @top = args[:top] if args.key?(:top) @window_height = args[:window_height] if args.key?(:window_height) @window_width = args[:window_width] if args.key?(:window_width) end end # Geographical Targeting. class GeoTargeting include Google::Apis::Core::Hashable # Cities to be targeted. For each city only dartId is required. The other fields # are populated automatically when the ad is inserted or updated. If targeting a # city, do not target or exclude the country of the city, and do not target the # metro or region of the city. # Corresponds to the JSON property `cities` # @return [Array] attr_accessor :cities # Countries to be targeted or excluded from targeting, depending on the setting # of the excludeCountries field. For each country only dartId is required. The # other fields are populated automatically when the ad is inserted or updated. # If targeting or excluding a country, do not target regions, cities, metros, or # postal codes in the same country. # Corresponds to the JSON property `countries` # @return [Array] attr_accessor :countries # Whether or not to exclude the countries in the countries field from targeting. # If false, the countries field refers to countries which will be targeted by # the ad. # Corresponds to the JSON property `excludeCountries` # @return [Boolean] attr_accessor :exclude_countries alias_method :exclude_countries?, :exclude_countries # Metros to be targeted. For each metro only dmaId is required. The other fields # are populated automatically when the ad is inserted or updated. If targeting a # metro, do not target or exclude the country of the metro. # Corresponds to the JSON property `metros` # @return [Array] attr_accessor :metros # Postal codes to be targeted. For each postal code only id is required. The # other fields are populated automatically when the ad is inserted or updated. # If targeting a postal code, do not target or exclude the country of the postal # code. # Corresponds to the JSON property `postalCodes` # @return [Array] attr_accessor :postal_codes # Regions to be targeted. For each region only dartId is required. The other # fields are populated automatically when the ad is inserted or updated. If # targeting a region, do not target or exclude the country of the region. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cities = args[:cities] if args.key?(:cities) @countries = args[:countries] if args.key?(:countries) @exclude_countries = args[:exclude_countries] if args.key?(:exclude_countries) @metros = args[:metros] if args.key?(:metros) @postal_codes = args[:postal_codes] if args.key?(:postal_codes) @regions = args[:regions] if args.key?(:regions) end end # Represents a buy from the DoubleClick Planning inventory store. class InventoryItem include Google::Apis::Core::Hashable # Account ID of this inventory item. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Ad slots of this inventory item. If this inventory item represents a # standalone placement, there will be exactly one ad slot. If this inventory # item represents a placement group, there will be more than one ad slot, each # representing one child placement in that placement group. # Corresponds to the JSON property `adSlots` # @return [Array] attr_accessor :ad_slots # Advertiser ID of this inventory item. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Content category ID of this inventory item. # Corresponds to the JSON property `contentCategoryId` # @return [Fixnum] attr_accessor :content_category_id # Estimated click-through rate of this inventory item. # Corresponds to the JSON property `estimatedClickThroughRate` # @return [Fixnum] attr_accessor :estimated_click_through_rate # Estimated conversion rate of this inventory item. # Corresponds to the JSON property `estimatedConversionRate` # @return [Fixnum] attr_accessor :estimated_conversion_rate # ID of this inventory item. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Whether this inventory item is in plan. # Corresponds to the JSON property `inPlan` # @return [Boolean] attr_accessor :in_plan alias_method :in_plan?, :in_plan # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#inventoryItem". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :last_modified_info # Name of this inventory item. For standalone inventory items, this is the same # name as that of its only ad slot. For group inventory items, this can differ # from the name of any of its ad slots. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Negotiation channel ID of this inventory item. # Corresponds to the JSON property `negotiationChannelId` # @return [Fixnum] attr_accessor :negotiation_channel_id # Order ID of this inventory item. # Corresponds to the JSON property `orderId` # @return [Fixnum] attr_accessor :order_id # Placement strategy ID of this inventory item. # Corresponds to the JSON property `placementStrategyId` # @return [Fixnum] attr_accessor :placement_strategy_id # Pricing Information # Corresponds to the JSON property `pricing` # @return [Google::Apis::DfareportingV3_0::Pricing] attr_accessor :pricing # Project ID of this inventory item. # Corresponds to the JSON property `projectId` # @return [Fixnum] attr_accessor :project_id # RFP ID of this inventory item. # Corresponds to the JSON property `rfpId` # @return [Fixnum] attr_accessor :rfp_id # ID of the site this inventory item is associated with. # Corresponds to the JSON property `siteId` # @return [Fixnum] attr_accessor :site_id # Subaccount ID of this inventory item. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Type of inventory item. # 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) @account_id = args[:account_id] if args.key?(:account_id) @ad_slots = args[:ad_slots] if args.key?(:ad_slots) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @content_category_id = args[:content_category_id] if args.key?(:content_category_id) @estimated_click_through_rate = args[:estimated_click_through_rate] if args.key?(:estimated_click_through_rate) @estimated_conversion_rate = args[:estimated_conversion_rate] if args.key?(:estimated_conversion_rate) @id = args[:id] if args.key?(:id) @in_plan = args[:in_plan] if args.key?(:in_plan) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @name = args[:name] if args.key?(:name) @negotiation_channel_id = args[:negotiation_channel_id] if args.key?(:negotiation_channel_id) @order_id = args[:order_id] if args.key?(:order_id) @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) @pricing = args[:pricing] if args.key?(:pricing) @project_id = args[:project_id] if args.key?(:project_id) @rfp_id = args[:rfp_id] if args.key?(:rfp_id) @site_id = args[:site_id] if args.key?(:site_id) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @type = args[:type] if args.key?(:type) end end # Inventory item List Response class InventoryItemsListResponse include Google::Apis::Core::Hashable # Inventory item collection # Corresponds to the JSON property `inventoryItems` # @return [Array] attr_accessor :inventory_items # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#inventoryItemsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # 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_items = args[:inventory_items] if args.key?(:inventory_items) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Key Value Targeting Expression. class KeyValueTargetingExpression include Google::Apis::Core::Hashable # Keyword expression being targeted by the ad. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expression = args[:expression] if args.key?(:expression) end end # Contains information about where a user's browser is taken after the user # clicks an ad. class LandingPage include Google::Apis::Core::Hashable # Advertiser ID of this landing page. This is a required field. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Whether this landing page has been archived. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # ID of this landing page. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#landingPage". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this landing page. This is a required field. It must be less than 256 # characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # URL of this landing page. This is a required field. # 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) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @archived = args[:archived] if args.key?(:archived) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @url = args[:url] if args.key?(:url) end end # Contains information about a language that can be targeted by ads. class Language include Google::Apis::Core::Hashable # Language ID of this language. This is the ID used for targeting and generating # reports. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#language". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Format of language code is an ISO 639 two-letter language code optionally # followed by an underscore followed by an ISO 3166 code. Examples are "en" for # English or "zh_CN" for Simplified Chinese. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Name of this language. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @language_code = args[:language_code] if args.key?(:language_code) @name = args[:name] if args.key?(:name) end end # Language Targeting. class LanguageTargeting include Google::Apis::Core::Hashable # Languages that this ad targets. For each language only languageId is required. # The other fields are populated automatically when the ad is inserted or # updated. # 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) @languages = args[:languages] if args.key?(:languages) end end # Language List Response class LanguagesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#languagesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Language collection. # 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) @kind = args[:kind] if args.key?(:kind) @languages = args[:languages] if args.key?(:languages) end end # Modification timestamp. class LastModifiedInfo include Google::Apis::Core::Hashable # Timestamp of the last change in milliseconds since epoch. # Corresponds to the JSON property `time` # @return [Fixnum] attr_accessor :time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @time = args[:time] if args.key?(:time) end end # A group clause made up of list population terms representing constraints # joined by ORs. class ListPopulationClause include Google::Apis::Core::Hashable # Terms of this list population clause. Each clause is made up of list # population terms representing constraints and are joined by ORs. # Corresponds to the JSON property `terms` # @return [Array] attr_accessor :terms def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @terms = args[:terms] if args.key?(:terms) end end # Remarketing List Population Rule. class ListPopulationRule include Google::Apis::Core::Hashable # Floodlight activity ID associated with this rule. This field can be left blank. # Corresponds to the JSON property `floodlightActivityId` # @return [Fixnum] attr_accessor :floodlight_activity_id # Name of floodlight activity associated with this rule. This is a read-only, # auto-generated field. # Corresponds to the JSON property `floodlightActivityName` # @return [String] attr_accessor :floodlight_activity_name # Clauses that make up this list population rule. Clauses are joined by ANDs, # and the clauses themselves are made up of list population terms which are # joined by ORs. # Corresponds to the JSON property `listPopulationClauses` # @return [Array] attr_accessor :list_population_clauses 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) @floodlight_activity_name = args[:floodlight_activity_name] if args.key?(:floodlight_activity_name) @list_population_clauses = args[:list_population_clauses] if args.key?(:list_population_clauses) end end # Remarketing List Population Rule Term. class ListPopulationTerm include Google::Apis::Core::Hashable # Will be true if the term should check if the user is in the list and false if # the term should check if the user is not in the list. This field is only # relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. # Corresponds to the JSON property `contains` # @return [Boolean] attr_accessor :contains alias_method :contains?, :contains # Whether to negate the comparison result of this term during rule evaluation. # This field is only relevant when type is left unset or set to # CUSTOM_VARIABLE_TERM or REFERRER_TERM. # Corresponds to the JSON property `negation` # @return [Boolean] attr_accessor :negation alias_method :negation?, :negation # Comparison operator of this term. This field is only relevant when type is # left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator # ID of the list in question. This field is only relevant when type is set to # LIST_MEMBERSHIP_TERM. # Corresponds to the JSON property `remarketingListId` # @return [Fixnum] attr_accessor :remarketing_list_id # List population term type determines the applicable fields in this object. If # left unset or set to CUSTOM_VARIABLE_TERM, then variableName, # variableFriendlyName, operator, value, and negation are applicable. If set to # LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If # set to REFERRER_TERM then operator, value, and negation are applicable. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Literal to compare the variable to. This field is only relevant when type is # left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value # Friendly name of this term's variable. This is a read-only, auto-generated # field. This field is only relevant when type is left unset or set to # CUSTOM_VARIABLE_TERM. # Corresponds to the JSON property `variableFriendlyName` # @return [String] attr_accessor :variable_friendly_name # Name of the variable (U1, U2, etc.) being compared in this term. This field is # only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. # Corresponds to the JSON property `variableName` # @return [String] attr_accessor :variable_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contains = args[:contains] if args.key?(:contains) @negation = args[:negation] if args.key?(:negation) @operator = args[:operator] if args.key?(:operator) @remarketing_list_id = args[:remarketing_list_id] if args.key?(:remarketing_list_id) @type = args[:type] if args.key?(:type) @value = args[:value] if args.key?(:value) @variable_friendly_name = args[:variable_friendly_name] if args.key?(:variable_friendly_name) @variable_name = args[:variable_name] if args.key?(:variable_name) end end # Remarketing List Targeting Expression. class ListTargetingExpression include Google::Apis::Core::Hashable # Expression describing which lists are being targeted by the ad. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @expression = args[:expression] if args.key?(:expression) end end # Lookback configuration settings. class LookbackConfiguration include Google::Apis::Core::Hashable # Lookback window, in days, from the last time a given user clicked on one of # your ads. If you enter 0, clicks will not be considered as triggering events # for floodlight tracking. If you leave this field blank, the default value for # your account will be used. Acceptable values are 0 to 90, inclusive. # Corresponds to the JSON property `clickDuration` # @return [Fixnum] attr_accessor :click_duration # Lookback window, in days, from the last time a given user viewed one of your # ads. If you enter 0, impressions will not be considered as triggering events # for floodlight tracking. If you leave this field blank, the default value for # your account will be used. Acceptable values are 0 to 90, inclusive. # Corresponds to the JSON property `postImpressionActivitiesDuration` # @return [Fixnum] attr_accessor :post_impression_activities_duration def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_duration = args[:click_duration] if args.key?(:click_duration) @post_impression_activities_duration = args[:post_impression_activities_duration] if args.key?(:post_impression_activities_duration) end end # Represents a metric. class Metric include Google::Apis::Core::Hashable # The kind of resource this is, in this case dfareporting#metric. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The metric name, e.g. dfa:impressions # 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) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Contains information about a metro region that can be targeted by ads. class Metro include Google::Apis::Core::Hashable # Country code of the country to which this metro region belongs. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of the country to which this metro region belongs. # Corresponds to the JSON property `countryDartId` # @return [Fixnum] attr_accessor :country_dart_id # DART ID of this metro region. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # DMA ID of this metro region. This is the ID used for targeting and generating # reports, and is equivalent to metro_code. # Corresponds to the JSON property `dmaId` # @return [Fixnum] attr_accessor :dma_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#metro". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metro code of this metro region. This is equivalent to dma_id. # Corresponds to the JSON property `metroCode` # @return [String] attr_accessor :metro_code # Name of this metro region. # 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) @country_code = args[:country_code] if args.key?(:country_code) @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) @dart_id = args[:dart_id] if args.key?(:dart_id) @dma_id = args[:dma_id] if args.key?(:dma_id) @kind = args[:kind] if args.key?(:kind) @metro_code = args[:metro_code] if args.key?(:metro_code) @name = args[:name] if args.key?(:name) end end # Metro List Response class MetrosListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#metrosListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metro collection. # Corresponds to the JSON property `metros` # @return [Array] attr_accessor :metros def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @metros = args[:metros] if args.key?(:metros) end end # Contains information about a mobile carrier that can be targeted by ads. class MobileCarrier include Google::Apis::Core::Hashable # Country code of the country to which this mobile carrier belongs. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of the country to which this mobile carrier belongs. # Corresponds to the JSON property `countryDartId` # @return [Fixnum] attr_accessor :country_dart_id # ID of this mobile carrier. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#mobileCarrier". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this mobile carrier. # 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) @country_code = args[:country_code] if args.key?(:country_code) @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Mobile Carrier List Response class MobileCarriersListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#mobileCarriersListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Mobile carrier collection. # Corresponds to the JSON property `mobileCarriers` # @return [Array] attr_accessor :mobile_carriers def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers) end end # Object Filter. class ObjectFilter include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#objectFilter". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Applicable when status is ASSIGNED. The user has access to objects with these # object IDs. # Corresponds to the JSON property `objectIds` # @return [Array] attr_accessor :object_ids # Status of the filter. NONE means the user has access to none of the objects. # ALL means the user has access to all objects. ASSIGNED means the user has # access to the objects with IDs in the objectIds list. # 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) @kind = args[:kind] if args.key?(:kind) @object_ids = args[:object_ids] if args.key?(:object_ids) @status = args[:status] if args.key?(:status) end end # Offset Position. class OffsetPosition include Google::Apis::Core::Hashable # Offset distance from left side of an asset or a window. # Corresponds to the JSON property `left` # @return [Fixnum] attr_accessor :left # Offset distance from top side of an asset or a window. # Corresponds to the JSON property `top` # @return [Fixnum] attr_accessor :top def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @left = args[:left] if args.key?(:left) @top = args[:top] if args.key?(:top) end end # Omniture Integration Settings. class OmnitureSettings include Google::Apis::Core::Hashable # Whether placement cost data will be sent to Omniture. This property can be # enabled only if omnitureIntegrationEnabled is true. # Corresponds to the JSON property `omnitureCostDataEnabled` # @return [Boolean] attr_accessor :omniture_cost_data_enabled alias_method :omniture_cost_data_enabled?, :omniture_cost_data_enabled # Whether Omniture integration is enabled. This property can be enabled only # when the "Advanced Ad Serving" account setting is enabled. # Corresponds to the JSON property `omnitureIntegrationEnabled` # @return [Boolean] attr_accessor :omniture_integration_enabled alias_method :omniture_integration_enabled?, :omniture_integration_enabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @omniture_cost_data_enabled = args[:omniture_cost_data_enabled] if args.key?(:omniture_cost_data_enabled) @omniture_integration_enabled = args[:omniture_integration_enabled] if args.key?(:omniture_integration_enabled) end end # Contains information about an operating system that can be targeted by ads. class OperatingSystem include Google::Apis::Core::Hashable # DART ID of this operating system. This is the ID used for targeting. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # Whether this operating system is for desktop. # Corresponds to the JSON property `desktop` # @return [Boolean] attr_accessor :desktop alias_method :desktop?, :desktop # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#operatingSystem". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Whether this operating system is for mobile. # Corresponds to the JSON property `mobile` # @return [Boolean] attr_accessor :mobile alias_method :mobile?, :mobile # Name of this operating system. # 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) @dart_id = args[:dart_id] if args.key?(:dart_id) @desktop = args[:desktop] if args.key?(:desktop) @kind = args[:kind] if args.key?(:kind) @mobile = args[:mobile] if args.key?(:mobile) @name = args[:name] if args.key?(:name) end end # Contains information about a particular version of an operating system that # can be targeted by ads. class OperatingSystemVersion include Google::Apis::Core::Hashable # ID of this operating system version. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#operatingSystemVersion". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Major version (leftmost number) of this operating system version. # Corresponds to the JSON property `majorVersion` # @return [String] attr_accessor :major_version # Minor version (number after the first dot) of this operating system version. # Corresponds to the JSON property `minorVersion` # @return [String] attr_accessor :minor_version # Name of this operating system version. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Contains information about an operating system that can be targeted by ads. # Corresponds to the JSON property `operatingSystem` # @return [Google::Apis::DfareportingV3_0::OperatingSystem] attr_accessor :operating_system def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @major_version = args[:major_version] if args.key?(:major_version) @minor_version = args[:minor_version] if args.key?(:minor_version) @name = args[:name] if args.key?(:name) @operating_system = args[:operating_system] if args.key?(:operating_system) end end # Operating System Version List Response class OperatingSystemVersionsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#operatingSystemVersionsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Operating system version collection. # Corresponds to the JSON property `operatingSystemVersions` # @return [Array] attr_accessor :operating_system_versions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @operating_system_versions = args[:operating_system_versions] if args.key?(:operating_system_versions) end end # Operating System List Response class OperatingSystemsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#operatingSystemsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Operating system collection. # Corresponds to the JSON property `operatingSystems` # @return [Array] attr_accessor :operating_systems def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @operating_systems = args[:operating_systems] if args.key?(:operating_systems) end end # Creative optimization activity. class OptimizationActivity include Google::Apis::Core::Hashable # Floodlight activity ID of this optimization activity. This is a required field. # Corresponds to the JSON property `floodlightActivityId` # @return [Fixnum] attr_accessor :floodlight_activity_id # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightActivityIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :floodlight_activity_id_dimension_value # Weight associated with this optimization. The weight assigned will be # understood in proportion to the weights assigned to the other optimization # activities. Value must be greater than or equal to 1. # Corresponds to the JSON property `weight` # @return [Fixnum] attr_accessor :weight 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) @floodlight_activity_id_dimension_value = args[:floodlight_activity_id_dimension_value] if args.key?(:floodlight_activity_id_dimension_value) @weight = args[:weight] if args.key?(:weight) end end # Describes properties of a DoubleClick Planning order. class Order include Google::Apis::Core::Hashable # Account ID of this order. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this order. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # IDs for users that have to approve documents created for this order. # Corresponds to the JSON property `approverUserProfileIds` # @return [Array] attr_accessor :approver_user_profile_ids # Buyer invoice ID associated with this order. # Corresponds to the JSON property `buyerInvoiceId` # @return [String] attr_accessor :buyer_invoice_id # Name of the buyer organization. # Corresponds to the JSON property `buyerOrganizationName` # @return [String] attr_accessor :buyer_organization_name # Comments in this order. # Corresponds to the JSON property `comments` # @return [String] attr_accessor :comments # Contacts for this order. # Corresponds to the JSON property `contacts` # @return [Array] attr_accessor :contacts # ID of this order. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#order". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :last_modified_info # Name of this order. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Notes of this order. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # ID of the terms and conditions template used in this order. # Corresponds to the JSON property `planningTermId` # @return [Fixnum] attr_accessor :planning_term_id # Project ID of this order. # Corresponds to the JSON property `projectId` # @return [Fixnum] attr_accessor :project_id # Seller order ID associated with this order. # Corresponds to the JSON property `sellerOrderId` # @return [String] attr_accessor :seller_order_id # Name of the seller organization. # Corresponds to the JSON property `sellerOrganizationName` # @return [String] attr_accessor :seller_organization_name # Site IDs this order is associated with. # Corresponds to the JSON property `siteId` # @return [Array] attr_accessor :site_id # Free-form site names this order is associated with. # Corresponds to the JSON property `siteNames` # @return [Array] attr_accessor :site_names # Subaccount ID of this order. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Terms and conditions of this order. # Corresponds to the JSON property `termsAndConditions` # @return [String] attr_accessor :terms_and_conditions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @approver_user_profile_ids = args[:approver_user_profile_ids] if args.key?(:approver_user_profile_ids) @buyer_invoice_id = args[:buyer_invoice_id] if args.key?(:buyer_invoice_id) @buyer_organization_name = args[:buyer_organization_name] if args.key?(:buyer_organization_name) @comments = args[:comments] if args.key?(:comments) @contacts = args[:contacts] if args.key?(:contacts) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @planning_term_id = args[:planning_term_id] if args.key?(:planning_term_id) @project_id = args[:project_id] if args.key?(:project_id) @seller_order_id = args[:seller_order_id] if args.key?(:seller_order_id) @seller_organization_name = args[:seller_organization_name] if args.key?(:seller_organization_name) @site_id = args[:site_id] if args.key?(:site_id) @site_names = args[:site_names] if args.key?(:site_names) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @terms_and_conditions = args[:terms_and_conditions] if args.key?(:terms_and_conditions) end end # Contact of an order. class OrderContact include Google::Apis::Core::Hashable # Free-form information about this contact. It could be any information related # to this contact in addition to type, title, name, and signature user profile # ID. # Corresponds to the JSON property `contactInfo` # @return [String] attr_accessor :contact_info # Name of this contact. # Corresponds to the JSON property `contactName` # @return [String] attr_accessor :contact_name # Title of this contact. # Corresponds to the JSON property `contactTitle` # @return [String] attr_accessor :contact_title # Type of this contact. # Corresponds to the JSON property `contactType` # @return [String] attr_accessor :contact_type # ID of the user profile containing the signature that will be embedded into # order documents. # Corresponds to the JSON property `signatureUserProfileId` # @return [Fixnum] attr_accessor :signature_user_profile_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contact_info = args[:contact_info] if args.key?(:contact_info) @contact_name = args[:contact_name] if args.key?(:contact_name) @contact_title = args[:contact_title] if args.key?(:contact_title) @contact_type = args[:contact_type] if args.key?(:contact_type) @signature_user_profile_id = args[:signature_user_profile_id] if args.key?(:signature_user_profile_id) end end # Contains properties of a DoubleClick Planning order document. class OrderDocument include Google::Apis::Core::Hashable # Account ID of this order document. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this order document. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # The amended order document ID of this order document. An order document can be # created by optionally amending another order document so that the change # history can be preserved. # Corresponds to the JSON property `amendedOrderDocumentId` # @return [Fixnum] attr_accessor :amended_order_document_id # IDs of users who have approved this order document. # Corresponds to the JSON property `approvedByUserProfileIds` # @return [Array] attr_accessor :approved_by_user_profile_ids # Whether this order document is cancelled. # Corresponds to the JSON property `cancelled` # @return [Boolean] attr_accessor :cancelled alias_method :cancelled?, :cancelled # Modification timestamp. # Corresponds to the JSON property `createdInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :created_info # Effective date of this order document. # Corresponds to the JSON property `effectiveDate` # @return [Date] attr_accessor :effective_date # ID of this order document. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#orderDocument". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # List of email addresses that received the last sent document. # Corresponds to the JSON property `lastSentRecipients` # @return [Array] attr_accessor :last_sent_recipients # Timestamp of the last email sent with this order document. # Corresponds to the JSON property `lastSentTime` # @return [DateTime] attr_accessor :last_sent_time # ID of the order from which this order document is created. # Corresponds to the JSON property `orderId` # @return [Fixnum] attr_accessor :order_id # Project ID of this order document. # Corresponds to the JSON property `projectId` # @return [Fixnum] attr_accessor :project_id # Whether this order document has been signed. # Corresponds to the JSON property `signed` # @return [Boolean] attr_accessor :signed alias_method :signed?, :signed # Subaccount ID of this order document. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Title of this order document. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Type of this order document # 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) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @amended_order_document_id = args[:amended_order_document_id] if args.key?(:amended_order_document_id) @approved_by_user_profile_ids = args[:approved_by_user_profile_ids] if args.key?(:approved_by_user_profile_ids) @cancelled = args[:cancelled] if args.key?(:cancelled) @created_info = args[:created_info] if args.key?(:created_info) @effective_date = args[:effective_date] if args.key?(:effective_date) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_sent_recipients = args[:last_sent_recipients] if args.key?(:last_sent_recipients) @last_sent_time = args[:last_sent_time] if args.key?(:last_sent_time) @order_id = args[:order_id] if args.key?(:order_id) @project_id = args[:project_id] if args.key?(:project_id) @signed = args[:signed] if args.key?(:signed) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) end end # Order document List Response class OrderDocumentsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#orderDocumentsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Order document collection # Corresponds to the JSON property `orderDocuments` # @return [Array] attr_accessor :order_documents 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) @order_documents = args[:order_documents] if args.key?(:order_documents) end end # Order List Response class OrdersListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#ordersListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Order collection. # Corresponds to the JSON property `orders` # @return [Array] attr_accessor :orders 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) @orders = args[:orders] if args.key?(:orders) end end # Represents fields that are compatible to be selected for a report of type " # PATH_TO_CONVERSION". class PathToConversionReportCompatibleFields include Google::Apis::Core::Hashable # Conversion dimensions which are compatible to be selected in the " # conversionDimensions" section of the report. # Corresponds to the JSON property `conversionDimensions` # @return [Array] attr_accessor :conversion_dimensions # Custom floodlight variables which are compatible to be selected in the " # customFloodlightVariables" section of the report. # Corresponds to the JSON property `customFloodlightVariables` # @return [Array] attr_accessor :custom_floodlight_variables # The kind of resource this is, in this case dfareporting# # pathToConversionReportCompatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metrics which are compatible to be selected in the "metricNames" section of # the report. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Per-interaction dimensions which are compatible to be selected in the " # perInteractionDimensions" section of the report. # Corresponds to the JSON property `perInteractionDimensions` # @return [Array] attr_accessor :per_interaction_dimensions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @conversion_dimensions = args[:conversion_dimensions] if args.key?(:conversion_dimensions) @custom_floodlight_variables = args[:custom_floodlight_variables] if args.key?(:custom_floodlight_variables) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) @per_interaction_dimensions = args[:per_interaction_dimensions] if args.key?(:per_interaction_dimensions) end end # Contains properties of a placement. class Placement include Google::Apis::Core::Hashable # Account ID of this placement. This field can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this placement opts out of ad blocking. When true, ad blocking is # disabled for this placement. When false, the campaign and site settings take # effect. # Corresponds to the JSON property `adBlockingOptOut` # @return [Boolean] attr_accessor :ad_blocking_opt_out alias_method :ad_blocking_opt_out?, :ad_blocking_opt_out # Advertiser ID of this placement. This field can be left blank. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Whether this placement is archived. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # Campaign ID of this placement. This field is a required field on insertion. # Corresponds to the JSON property `campaignId` # @return [Fixnum] attr_accessor :campaign_id # Represents a DimensionValue resource. # Corresponds to the JSON property `campaignIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :campaign_id_dimension_value # Comments for this placement. # Corresponds to the JSON property `comment` # @return [String] attr_accessor :comment # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering # on desktop, on mobile devices or in mobile apps for regular or interstitial # ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new # placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. # IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the # VAST standard. This field is required on insertion. # Corresponds to the JSON property `compatibility` # @return [String] attr_accessor :compatibility # ID of the content category assigned to this placement. # Corresponds to the JSON property `contentCategoryId` # @return [Fixnum] attr_accessor :content_category_id # Modification timestamp. # Corresponds to the JSON property `createInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :create_info # Directory site ID of this placement. On insert, you must set either this field # or the siteId field to specify the site associated with this placement. This # is a required field that is read-only after insertion. # Corresponds to the JSON property `directorySiteId` # @return [Fixnum] attr_accessor :directory_site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `directorySiteIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :directory_site_id_dimension_value # External ID for this placement. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id # ID of this placement. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Key name of this placement. This is a read-only, auto-generated field. # Corresponds to the JSON property `keyName` # @return [String] attr_accessor :key_name # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placement". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :last_modified_info # Lookback configuration settings. # Corresponds to the JSON property `lookbackConfiguration` # @return [Google::Apis::DfareportingV3_0::LookbackConfiguration] attr_accessor :lookback_configuration # Name of this placement.This is a required field and must be less than 256 # characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Whether payment was approved for this placement. This is a read-only field # relevant only to publisher-paid placements. # Corresponds to the JSON property `paymentApproved` # @return [Boolean] attr_accessor :payment_approved alias_method :payment_approved?, :payment_approved # Payment source for this placement. This is a required field that is read-only # after insertion. # Corresponds to the JSON property `paymentSource` # @return [String] attr_accessor :payment_source # ID of this placement's group, if applicable. # Corresponds to the JSON property `placementGroupId` # @return [Fixnum] attr_accessor :placement_group_id # Represents a DimensionValue resource. # Corresponds to the JSON property `placementGroupIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :placement_group_id_dimension_value # ID of the placement strategy assigned to this placement. # Corresponds to the JSON property `placementStrategyId` # @return [Fixnum] attr_accessor :placement_strategy_id # Pricing Schedule # Corresponds to the JSON property `pricingSchedule` # @return [Google::Apis::DfareportingV3_0::PricingSchedule] attr_accessor :pricing_schedule # Whether this placement is the primary placement of a roadblock (placement # group). You cannot change this field from true to false. Setting this field to # true will automatically set the primary field on the original primary # placement of the roadblock to false, and it will automatically set the # roadblock's primaryPlacementId field to the ID of this placement. # Corresponds to the JSON property `primary` # @return [Boolean] attr_accessor :primary alias_method :primary?, :primary # Modification timestamp. # Corresponds to the JSON property `publisherUpdateInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :publisher_update_info # Site ID associated with this placement. On insert, you must set either this # field or the directorySiteId field to specify the site associated with this # placement. This is a required field that is read-only after insertion. # Corresponds to the JSON property `siteId` # @return [Fixnum] attr_accessor :site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `siteIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :site_id_dimension_value # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `size` # @return [Google::Apis::DfareportingV3_0::Size] attr_accessor :size # Whether creatives assigned to this placement must be SSL-compliant. # Corresponds to the JSON property `sslRequired` # @return [Boolean] attr_accessor :ssl_required alias_method :ssl_required?, :ssl_required # Third-party placement status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Subaccount ID of this placement. This field can be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Tag formats to generate for this placement. This field is required on # insertion. # Acceptable values are: # - "PLACEMENT_TAG_STANDARD" # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" # - "PLACEMENT_TAG_IFRAME_ILAYER" # - "PLACEMENT_TAG_INTERNAL_REDIRECT" # - "PLACEMENT_TAG_JAVASCRIPT" # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" # - "PLACEMENT_TAG_CLICK_COMMANDS" # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" # - "PLACEMENT_TAG_TRACKING" # - "PLACEMENT_TAG_TRACKING_IFRAME" # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" # Corresponds to the JSON property `tagFormats` # @return [Array] attr_accessor :tag_formats # Tag Settings # Corresponds to the JSON property `tagSetting` # @return [Google::Apis::DfareportingV3_0::TagSetting] attr_accessor :tag_setting # Whether Verification and ActiveView are disabled for in-stream video creatives # for this placement. The same setting videoActiveViewOptOut exists on the site # level -- the opt out occurs if either of these settings are true. These # settings are distinct from DirectorySites.settings.activeViewOptOut or Sites. # siteSettings.activeViewOptOut which only apply to display ads. However, # Accounts.activeViewOptOut opts out both video traffic, as well as display ads, # from Verification and ActiveView. # Corresponds to the JSON property `videoActiveViewOptOut` # @return [Boolean] attr_accessor :video_active_view_opt_out alias_method :video_active_view_opt_out?, :video_active_view_opt_out # Video Settings # Corresponds to the JSON property `videoSettings` # @return [Google::Apis::DfareportingV3_0::VideoSettings] attr_accessor :video_settings # VPAID adapter setting for this placement. Controls which VPAID format the # measurement adapter will use for in-stream video creatives assigned to this # placement. # Note: Flash is no longer supported. This field now defaults to HTML5 when the # following values are provided: FLASH, BOTH. # Corresponds to the JSON property `vpaidAdapterChoice` # @return [String] attr_accessor :vpaid_adapter_choice def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @ad_blocking_opt_out = args[:ad_blocking_opt_out] if args.key?(:ad_blocking_opt_out) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @archived = args[:archived] if args.key?(:archived) @campaign_id = args[:campaign_id] if args.key?(:campaign_id) @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) @comment = args[:comment] if args.key?(:comment) @compatibility = args[:compatibility] if args.key?(:compatibility) @content_category_id = args[:content_category_id] if args.key?(:content_category_id) @create_info = args[:create_info] if args.key?(:create_info) @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) @external_id = args[:external_id] if args.key?(:external_id) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @key_name = args[:key_name] if args.key?(:key_name) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @name = args[:name] if args.key?(:name) @payment_approved = args[:payment_approved] if args.key?(:payment_approved) @payment_source = args[:payment_source] if args.key?(:payment_source) @placement_group_id = args[:placement_group_id] if args.key?(:placement_group_id) @placement_group_id_dimension_value = args[:placement_group_id_dimension_value] if args.key?(:placement_group_id_dimension_value) @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) @pricing_schedule = args[:pricing_schedule] if args.key?(:pricing_schedule) @primary = args[:primary] if args.key?(:primary) @publisher_update_info = args[:publisher_update_info] if args.key?(:publisher_update_info) @site_id = args[:site_id] if args.key?(:site_id) @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) @size = args[:size] if args.key?(:size) @ssl_required = args[:ssl_required] if args.key?(:ssl_required) @status = args[:status] if args.key?(:status) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @tag_formats = args[:tag_formats] if args.key?(:tag_formats) @tag_setting = args[:tag_setting] if args.key?(:tag_setting) @video_active_view_opt_out = args[:video_active_view_opt_out] if args.key?(:video_active_view_opt_out) @video_settings = args[:video_settings] if args.key?(:video_settings) @vpaid_adapter_choice = args[:vpaid_adapter_choice] if args.key?(:vpaid_adapter_choice) end end # Placement Assignment. class PlacementAssignment include Google::Apis::Core::Hashable # Whether this placement assignment is active. When true, the placement will be # included in the ad's rotation. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # ID of the placement to be assigned. This is a required field. # Corresponds to the JSON property `placementId` # @return [Fixnum] attr_accessor :placement_id # Represents a DimensionValue resource. # Corresponds to the JSON property `placementIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :placement_id_dimension_value # Whether the placement to be assigned requires SSL. This is a read-only field # that is auto-generated when the ad is inserted or updated. # Corresponds to the JSON property `sslRequired` # @return [Boolean] attr_accessor :ssl_required alias_method :ssl_required?, :ssl_required def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active = args[:active] if args.key?(:active) @placement_id = args[:placement_id] if args.key?(:placement_id) @placement_id_dimension_value = args[:placement_id_dimension_value] if args.key?(:placement_id_dimension_value) @ssl_required = args[:ssl_required] if args.key?(:ssl_required) end end # Contains properties of a package or roadblock. class PlacementGroup include Google::Apis::Core::Hashable # Account ID of this placement group. This is a read-only field that can be left # blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this placement group. This is a required field on insertion. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Whether this placement group is archived. # Corresponds to the JSON property `archived` # @return [Boolean] attr_accessor :archived alias_method :archived?, :archived # Campaign ID of this placement group. This field is required on insertion. # Corresponds to the JSON property `campaignId` # @return [Fixnum] attr_accessor :campaign_id # Represents a DimensionValue resource. # Corresponds to the JSON property `campaignIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :campaign_id_dimension_value # IDs of placements which are assigned to this placement group. This is a read- # only, auto-generated field. # Corresponds to the JSON property `childPlacementIds` # @return [Array] attr_accessor :child_placement_ids # Comments for this placement group. # Corresponds to the JSON property `comment` # @return [String] attr_accessor :comment # ID of the content category assigned to this placement group. # Corresponds to the JSON property `contentCategoryId` # @return [Fixnum] attr_accessor :content_category_id # Modification timestamp. # Corresponds to the JSON property `createInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :create_info # Directory site ID associated with this placement group. On insert, you must # set either this field or the site_id field to specify the site associated with # this placement group. This is a required field that is read-only after # insertion. # Corresponds to the JSON property `directorySiteId` # @return [Fixnum] attr_accessor :directory_site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `directorySiteIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :directory_site_id_dimension_value # External ID for this placement. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id # ID of this placement group. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :last_modified_info # Name of this placement group. This is a required field and must be less than # 256 characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Type of this placement group. A package is a simple group of placements that # acts as a single pricing point for a group of tags. A roadblock is a group of # placements that not only acts as a single pricing point, but also assumes that # all the tags in it will be served at the same time. A roadblock requires one # of its assigned placements to be marked as primary for reporting. This field # is required on insertion. # Corresponds to the JSON property `placementGroupType` # @return [String] attr_accessor :placement_group_type # ID of the placement strategy assigned to this placement group. # Corresponds to the JSON property `placementStrategyId` # @return [Fixnum] attr_accessor :placement_strategy_id # Pricing Schedule # Corresponds to the JSON property `pricingSchedule` # @return [Google::Apis::DfareportingV3_0::PricingSchedule] attr_accessor :pricing_schedule # ID of the primary placement, used to calculate the media cost of a roadblock ( # placement group). Modifying this field will automatically modify the primary # field on all affected roadblock child placements. # Corresponds to the JSON property `primaryPlacementId` # @return [Fixnum] attr_accessor :primary_placement_id # Represents a DimensionValue resource. # Corresponds to the JSON property `primaryPlacementIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :primary_placement_id_dimension_value # Site ID associated with this placement group. On insert, you must set either # this field or the directorySiteId field to specify the site associated with # this placement group. This is a required field that is read-only after # insertion. # Corresponds to the JSON property `siteId` # @return [Fixnum] attr_accessor :site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `siteIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :site_id_dimension_value # Subaccount ID of this placement group. This is a read-only field that can be # left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @archived = args[:archived] if args.key?(:archived) @campaign_id = args[:campaign_id] if args.key?(:campaign_id) @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) @child_placement_ids = args[:child_placement_ids] if args.key?(:child_placement_ids) @comment = args[:comment] if args.key?(:comment) @content_category_id = args[:content_category_id] if args.key?(:content_category_id) @create_info = args[:create_info] if args.key?(:create_info) @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) @external_id = args[:external_id] if args.key?(:external_id) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @name = args[:name] if args.key?(:name) @placement_group_type = args[:placement_group_type] if args.key?(:placement_group_type) @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) @pricing_schedule = args[:pricing_schedule] if args.key?(:pricing_schedule) @primary_placement_id = args[:primary_placement_id] if args.key?(:primary_placement_id) @primary_placement_id_dimension_value = args[:primary_placement_id_dimension_value] if args.key?(:primary_placement_id_dimension_value) @site_id = args[:site_id] if args.key?(:site_id) @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Placement Group List Response class PlacementGroupsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementGroupsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Placement group collection. # Corresponds to the JSON property `placementGroups` # @return [Array] attr_accessor :placement_groups 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) @placement_groups = args[:placement_groups] if args.key?(:placement_groups) end end # Placement Strategy List Response class PlacementStrategiesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementStrategiesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Placement strategy collection. # Corresponds to the JSON property `placementStrategies` # @return [Array] attr_accessor :placement_strategies 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) @placement_strategies = args[:placement_strategies] if args.key?(:placement_strategies) end end # Contains properties of a placement strategy. class PlacementStrategy include Google::Apis::Core::Hashable # Account ID of this placement strategy.This is a read-only field that can be # left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # ID of this placement strategy. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementStrategy". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this placement strategy. This is a required field. It must be less # than 256 characters long and unique among placement strategies of the same # account. # 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) @account_id = args[:account_id] if args.key?(:account_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Placement Tag class PlacementTag include Google::Apis::Core::Hashable # Placement ID # Corresponds to the JSON property `placementId` # @return [Fixnum] attr_accessor :placement_id # Tags generated for this placement. # Corresponds to the JSON property `tagDatas` # @return [Array] attr_accessor :tag_datas def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @placement_id = args[:placement_id] if args.key?(:placement_id) @tag_datas = args[:tag_datas] if args.key?(:tag_datas) end end # Placement GenerateTags Response class PlacementsGenerateTagsResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementsGenerateTagsResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Set of generated tags for the specified placements. # Corresponds to the JSON property `placementTags` # @return [Array] attr_accessor :placement_tags def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @placement_tags = args[:placement_tags] if args.key?(:placement_tags) end end # Placement List Response class PlacementsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#placementsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Placement collection. # Corresponds to the JSON property `placements` # @return [Array] attr_accessor :placements 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) @placements = args[:placements] if args.key?(:placements) end end # Contains information about a platform type that can be targeted by ads. class PlatformType include Google::Apis::Core::Hashable # ID of this platform type. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#platformType". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this platform type. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Platform Type List Response class PlatformTypesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#platformTypesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Platform type collection. # Corresponds to the JSON property `platformTypes` # @return [Array] attr_accessor :platform_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @platform_types = args[:platform_types] if args.key?(:platform_types) end end # Popup Window Properties. class PopupWindowProperties include Google::Apis::Core::Hashable # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `dimension` # @return [Google::Apis::DfareportingV3_0::Size] attr_accessor :dimension # Offset Position. # Corresponds to the JSON property `offset` # @return [Google::Apis::DfareportingV3_0::OffsetPosition] attr_accessor :offset # Popup window position either centered or at specific coordinate. # Corresponds to the JSON property `positionType` # @return [String] attr_accessor :position_type # Whether to display the browser address bar. # Corresponds to the JSON property `showAddressBar` # @return [Boolean] attr_accessor :show_address_bar alias_method :show_address_bar?, :show_address_bar # Whether to display the browser menu bar. # Corresponds to the JSON property `showMenuBar` # @return [Boolean] attr_accessor :show_menu_bar alias_method :show_menu_bar?, :show_menu_bar # Whether to display the browser scroll bar. # Corresponds to the JSON property `showScrollBar` # @return [Boolean] attr_accessor :show_scroll_bar alias_method :show_scroll_bar?, :show_scroll_bar # Whether to display the browser status bar. # Corresponds to the JSON property `showStatusBar` # @return [Boolean] attr_accessor :show_status_bar alias_method :show_status_bar?, :show_status_bar # Whether to display the browser tool bar. # Corresponds to the JSON property `showToolBar` # @return [Boolean] attr_accessor :show_tool_bar alias_method :show_tool_bar?, :show_tool_bar # Title of popup window. # 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) @dimension = args[:dimension] if args.key?(:dimension) @offset = args[:offset] if args.key?(:offset) @position_type = args[:position_type] if args.key?(:position_type) @show_address_bar = args[:show_address_bar] if args.key?(:show_address_bar) @show_menu_bar = args[:show_menu_bar] if args.key?(:show_menu_bar) @show_scroll_bar = args[:show_scroll_bar] if args.key?(:show_scroll_bar) @show_status_bar = args[:show_status_bar] if args.key?(:show_status_bar) @show_tool_bar = args[:show_tool_bar] if args.key?(:show_tool_bar) @title = args[:title] if args.key?(:title) end end # Contains information about a postal code that can be targeted by ads. class PostalCode include Google::Apis::Core::Hashable # Postal code. This is equivalent to the id field. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # Country code of the country to which this postal code belongs. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of the country to which this postal code belongs. # Corresponds to the JSON property `countryDartId` # @return [Fixnum] attr_accessor :country_dart_id # ID of this postal code. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#postalCode". # 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) @code = args[:code] if args.key?(:code) @country_code = args[:country_code] if args.key?(:country_code) @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) end end # Postal Code List Response class PostalCodesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#postalCodesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Postal code collection. # Corresponds to the JSON property `postalCodes` # @return [Array] attr_accessor :postal_codes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @postal_codes = args[:postal_codes] if args.key?(:postal_codes) end end # Pricing Information class Pricing include Google::Apis::Core::Hashable # Cap cost type of this inventory item. # Corresponds to the JSON property `capCostType` # @return [String] attr_accessor :cap_cost_type # End date of this inventory item. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # Flights of this inventory item. A flight (a.k.a. pricing period) represents # the inventory item pricing information for a specific period of time. # Corresponds to the JSON property `flights` # @return [Array] attr_accessor :flights # Group type of this inventory item if it represents a placement group. Is null # otherwise. There are two type of placement groups: # PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items # that acts as a single pricing point for a group of tags. # PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not # only acts as a single pricing point, but also assumes that all the tags in it # will be served at the same time. A roadblock requires one of its assigned # inventory items to be marked as primary. # Corresponds to the JSON property `groupType` # @return [String] attr_accessor :group_type # Pricing type of this inventory item. # Corresponds to the JSON property `pricingType` # @return [String] attr_accessor :pricing_type # Start date of this inventory item. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cap_cost_type = args[:cap_cost_type] if args.key?(:cap_cost_type) @end_date = args[:end_date] if args.key?(:end_date) @flights = args[:flights] if args.key?(:flights) @group_type = args[:group_type] if args.key?(:group_type) @pricing_type = args[:pricing_type] if args.key?(:pricing_type) @start_date = args[:start_date] if args.key?(:start_date) end end # Pricing Schedule class PricingSchedule include Google::Apis::Core::Hashable # Placement cap cost option. # Corresponds to the JSON property `capCostOption` # @return [String] attr_accessor :cap_cost_option # Whether cap costs are ignored by ad serving. # Corresponds to the JSON property `disregardOverdelivery` # @return [Boolean] attr_accessor :disregard_overdelivery alias_method :disregard_overdelivery?, :disregard_overdelivery # Placement end date. This date must be later than, or the same day as, the # placement start date, but not later than the campaign end date. If, for # example, you set 6/25/2015 as both the start and end dates, the effective # placement date is just that day only, 6/25/2015. The hours, minutes, and # seconds of the end date should not be set, as doing so will result in an error. # This field is required on insertion. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # Whether this placement is flighted. If true, pricing periods will be computed # automatically. # Corresponds to the JSON property `flighted` # @return [Boolean] attr_accessor :flighted alias_method :flighted?, :flighted # Floodlight activity ID associated with this placement. This field should be # set when placement pricing type is set to PRICING_TYPE_CPA. # Corresponds to the JSON property `floodlightActivityId` # @return [Fixnum] attr_accessor :floodlight_activity_id # Pricing periods for this placement. # Corresponds to the JSON property `pricingPeriods` # @return [Array] attr_accessor :pricing_periods # Placement pricing type. This field is required on insertion. # Corresponds to the JSON property `pricingType` # @return [String] attr_accessor :pricing_type # Placement start date. This date must be later than, or the same day as, the # campaign start date. The hours, minutes, and seconds of the start date should # not be set, as doing so will result in an error. This field is required on # insertion. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date # Testing start date of this placement. The hours, minutes, and seconds of the # start date should not be set, as doing so will result in an error. # Corresponds to the JSON property `testingStartDate` # @return [Date] attr_accessor :testing_start_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cap_cost_option = args[:cap_cost_option] if args.key?(:cap_cost_option) @disregard_overdelivery = args[:disregard_overdelivery] if args.key?(:disregard_overdelivery) @end_date = args[:end_date] if args.key?(:end_date) @flighted = args[:flighted] if args.key?(:flighted) @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) @pricing_periods = args[:pricing_periods] if args.key?(:pricing_periods) @pricing_type = args[:pricing_type] if args.key?(:pricing_type) @start_date = args[:start_date] if args.key?(:start_date) @testing_start_date = args[:testing_start_date] if args.key?(:testing_start_date) end end # Pricing Period class PricingSchedulePricingPeriod include Google::Apis::Core::Hashable # Pricing period end date. This date must be later than, or the same day as, the # pricing period start date, but not later than the placement end date. The # period end date can be the same date as the period start date. If, for example, # you set 6/25/2015 as both the start and end dates, the effective pricing # period date is just that day only, 6/25/2015. The hours, minutes, and seconds # of the end date should not be set, as doing so will result in an error. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # Comments for this pricing period. # Corresponds to the JSON property `pricingComment` # @return [String] attr_accessor :pricing_comment # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). # Acceptable values are 0 to 1000000000000000000, inclusive. # Corresponds to the JSON property `rateOrCostNanos` # @return [Fixnum] attr_accessor :rate_or_cost_nanos # Pricing period start date. This date must be later than, or the same day as, # the placement start date. The hours, minutes, and seconds of the start date # should not be set, as doing so will result in an error. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date # Units of this pricing period. Acceptable values are 0 to 10000000000, # inclusive. # 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) @end_date = args[:end_date] if args.key?(:end_date) @pricing_comment = args[:pricing_comment] if args.key?(:pricing_comment) @rate_or_cost_nanos = args[:rate_or_cost_nanos] if args.key?(:rate_or_cost_nanos) @start_date = args[:start_date] if args.key?(:start_date) @units = args[:units] if args.key?(:units) end end # Contains properties of a DoubleClick Planning project. class Project include Google::Apis::Core::Hashable # Account ID of this project. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this project. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Audience age group of this project. # Corresponds to the JSON property `audienceAgeGroup` # @return [String] attr_accessor :audience_age_group # Audience gender of this project. # Corresponds to the JSON property `audienceGender` # @return [String] attr_accessor :audience_gender # Budget of this project in the currency specified by the current account. The # value stored in this field represents only the non-fractional amount. For # example, for USD, the smallest value that can be represented by this field is # 1 US dollar. # Corresponds to the JSON property `budget` # @return [Fixnum] attr_accessor :budget # Client billing code of this project. # Corresponds to the JSON property `clientBillingCode` # @return [String] attr_accessor :client_billing_code # Name of the project client. # Corresponds to the JSON property `clientName` # @return [String] attr_accessor :client_name # End date of the project. # Corresponds to the JSON property `endDate` # @return [Date] attr_accessor :end_date # ID of this project. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#project". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Modification timestamp. # Corresponds to the JSON property `lastModifiedInfo` # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] attr_accessor :last_modified_info # Name of this project. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Overview of this project. # Corresponds to the JSON property `overview` # @return [String] attr_accessor :overview # Start date of the project. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date # Subaccount ID of this project. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Number of clicks that the advertiser is targeting. # Corresponds to the JSON property `targetClicks` # @return [Fixnum] attr_accessor :target_clicks # Number of conversions that the advertiser is targeting. # Corresponds to the JSON property `targetConversions` # @return [Fixnum] attr_accessor :target_conversions # CPA that the advertiser is targeting. # Corresponds to the JSON property `targetCpaNanos` # @return [Fixnum] attr_accessor :target_cpa_nanos # CPC that the advertiser is targeting. # Corresponds to the JSON property `targetCpcNanos` # @return [Fixnum] attr_accessor :target_cpc_nanos # vCPM from Active View that the advertiser is targeting. # Corresponds to the JSON property `targetCpmActiveViewNanos` # @return [Fixnum] attr_accessor :target_cpm_active_view_nanos # CPM that the advertiser is targeting. # Corresponds to the JSON property `targetCpmNanos` # @return [Fixnum] attr_accessor :target_cpm_nanos # Number of impressions that the advertiser is targeting. # Corresponds to the JSON property `targetImpressions` # @return [Fixnum] attr_accessor :target_impressions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @audience_age_group = args[:audience_age_group] if args.key?(:audience_age_group) @audience_gender = args[:audience_gender] if args.key?(:audience_gender) @budget = args[:budget] if args.key?(:budget) @client_billing_code = args[:client_billing_code] if args.key?(:client_billing_code) @client_name = args[:client_name] if args.key?(:client_name) @end_date = args[:end_date] if args.key?(:end_date) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @name = args[:name] if args.key?(:name) @overview = args[:overview] if args.key?(:overview) @start_date = args[:start_date] if args.key?(:start_date) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @target_clicks = args[:target_clicks] if args.key?(:target_clicks) @target_conversions = args[:target_conversions] if args.key?(:target_conversions) @target_cpa_nanos = args[:target_cpa_nanos] if args.key?(:target_cpa_nanos) @target_cpc_nanos = args[:target_cpc_nanos] if args.key?(:target_cpc_nanos) @target_cpm_active_view_nanos = args[:target_cpm_active_view_nanos] if args.key?(:target_cpm_active_view_nanos) @target_cpm_nanos = args[:target_cpm_nanos] if args.key?(:target_cpm_nanos) @target_impressions = args[:target_impressions] if args.key?(:target_impressions) end end # Project List Response class ProjectsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#projectsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Project collection. # Corresponds to the JSON property `projects` # @return [Array] attr_accessor :projects 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) @projects = args[:projects] if args.key?(:projects) end end # Represents fields that are compatible to be selected for a report of type " # REACH". class ReachReportCompatibleFields include Google::Apis::Core::Hashable # Dimensions which are compatible to be selected in the "dimensionFilters" # section of the report. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # Dimensions which are compatible to be selected in the "dimensions" section of # the report. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # The kind of resource this is, in this case dfareporting# # reachReportCompatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metrics which are compatible to be selected in the "metricNames" section of # the report. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Metrics which are compatible to be selected as activity metrics to pivot on in # the "activities" section of the report. # Corresponds to the JSON property `pivotedActivityMetrics` # @return [Array] attr_accessor :pivoted_activity_metrics # Metrics which are compatible to be selected in the " # reachByFrequencyMetricNames" section of the report. # Corresponds to the JSON property `reachByFrequencyMetrics` # @return [Array] attr_accessor :reach_by_frequency_metrics def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) @pivoted_activity_metrics = args[:pivoted_activity_metrics] if args.key?(:pivoted_activity_metrics) @reach_by_frequency_metrics = args[:reach_by_frequency_metrics] if args.key?(:reach_by_frequency_metrics) end end # Represents a recipient. class Recipient include Google::Apis::Core::Hashable # The delivery type for the recipient. # Corresponds to the JSON property `deliveryType` # @return [String] attr_accessor :delivery_type # The email address of the recipient. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The kind of resource this is, in this case dfareporting#recipient. # 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) @delivery_type = args[:delivery_type] if args.key?(:delivery_type) @email = args[:email] if args.key?(:email) @kind = args[:kind] if args.key?(:kind) end end # Contains information about a region that can be targeted by ads. class Region include Google::Apis::Core::Hashable # Country code of the country to which this region belongs. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # DART ID of the country to which this region belongs. # Corresponds to the JSON property `countryDartId` # @return [Fixnum] attr_accessor :country_dart_id # DART ID of this region. # Corresponds to the JSON property `dartId` # @return [Fixnum] attr_accessor :dart_id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#region". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this region. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Region code. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country_code = args[:country_code] if args.key?(:country_code) @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) @dart_id = args[:dart_id] if args.key?(:dart_id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @region_code = args[:region_code] if args.key?(:region_code) end end # Region List Response class RegionsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#regionsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Region collection. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @regions = args[:regions] if args.key?(:regions) end end # Contains properties of a remarketing list. Remarketing enables you to create # lists of users who have performed specific actions on a site, then target ads # to members of those lists. This resource can be used to manage remarketing # lists that are owned by your advertisers. To see all remarketing lists that # are visible to your advertisers, including those that are shared to your # advertiser or account, use the TargetableRemarketingLists resource. class RemarketingList include Google::Apis::Core::Hashable # Account ID of this remarketing list. This is a read-only, auto-generated field # that is only returned in GET requests. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this remarketing list is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Dimension value for the advertiser ID that owns this remarketing list. This is # a required field. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Remarketing list description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Remarketing list ID. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#remarketingList". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Number of days that a user should remain in the remarketing list without an # impression. Acceptable values are 1 to 540, inclusive. # Corresponds to the JSON property `lifeSpan` # @return [Fixnum] attr_accessor :life_span # Remarketing List Population Rule. # Corresponds to the JSON property `listPopulationRule` # @return [Google::Apis::DfareportingV3_0::ListPopulationRule] attr_accessor :list_population_rule # Number of users currently in the list. This is a read-only field. # Corresponds to the JSON property `listSize` # @return [Fixnum] attr_accessor :list_size # Product from which this remarketing list was originated. # Corresponds to the JSON property `listSource` # @return [String] attr_accessor :list_source # Name of the remarketing list. This is a required field. Must be no greater # than 128 characters long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this remarketing list. This is a read-only, auto-generated # field that is only returned in GET requests. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @life_span = args[:life_span] if args.key?(:life_span) @list_population_rule = args[:list_population_rule] if args.key?(:list_population_rule) @list_size = args[:list_size] if args.key?(:list_size) @list_source = args[:list_source] if args.key?(:list_source) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Contains properties of a remarketing list's sharing information. Sharing # allows other accounts or advertisers to target to your remarketing lists. This # resource can be used to manage remarketing list sharing to other accounts and # advertisers. class RemarketingListShare include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#remarketingListShare". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Remarketing list ID. This is a read-only, auto-generated field. # Corresponds to the JSON property `remarketingListId` # @return [Fixnum] attr_accessor :remarketing_list_id # Accounts that the remarketing list is shared with. # Corresponds to the JSON property `sharedAccountIds` # @return [Array] attr_accessor :shared_account_ids # Advertisers that the remarketing list is shared with. # Corresponds to the JSON property `sharedAdvertiserIds` # @return [Array] attr_accessor :shared_advertiser_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @remarketing_list_id = args[:remarketing_list_id] if args.key?(:remarketing_list_id) @shared_account_ids = args[:shared_account_ids] if args.key?(:shared_account_ids) @shared_advertiser_ids = args[:shared_advertiser_ids] if args.key?(:shared_advertiser_ids) end end # Remarketing list response class RemarketingListsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#remarketingListsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Remarketing list collection. # Corresponds to the JSON property `remarketingLists` # @return [Array] attr_accessor :remarketing_lists 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) @remarketing_lists = args[:remarketing_lists] if args.key?(:remarketing_lists) end end # Represents a Report resource. class Report include Google::Apis::Core::Hashable # The account ID to which this report belongs. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # The report criteria for a report of type "STANDARD". # Corresponds to the JSON property `criteria` # @return [Google::Apis::DfareportingV3_0::Report::Criteria] attr_accessor :criteria # The report criteria for a report of type "CROSS_DIMENSION_REACH". # Corresponds to the JSON property `crossDimensionReachCriteria` # @return [Google::Apis::DfareportingV3_0::Report::CrossDimensionReachCriteria] attr_accessor :cross_dimension_reach_criteria # The report's email delivery settings. # Corresponds to the JSON property `delivery` # @return [Google::Apis::DfareportingV3_0::Report::Delivery] attr_accessor :delivery # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The filename used when generating report files for this report. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name # The report criteria for a report of type "FLOODLIGHT". # Corresponds to the JSON property `floodlightCriteria` # @return [Google::Apis::DfareportingV3_0::Report::FloodlightCriteria] attr_accessor :floodlight_criteria # The output format of the report. If not specified, default format is "CSV". # Note that the actual format in the completed report file might differ if for # instance the report's size exceeds the format's capabilities. "CSV" will then # be the fallback format. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # The unique ID identifying this report resource. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The kind of resource this is, in this case dfareporting#report. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The timestamp (in milliseconds since epoch) of when this report was last # modified. # Corresponds to the JSON property `lastModifiedTime` # @return [Fixnum] attr_accessor :last_modified_time # The name of the report. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The user profile id of the owner of this report. # Corresponds to the JSON property `ownerProfileId` # @return [Fixnum] attr_accessor :owner_profile_id # The report criteria for a report of type "PATH_TO_CONVERSION". # Corresponds to the JSON property `pathToConversionCriteria` # @return [Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria] attr_accessor :path_to_conversion_criteria # The report criteria for a report of type "REACH". # Corresponds to the JSON property `reachCriteria` # @return [Google::Apis::DfareportingV3_0::Report::ReachCriteria] attr_accessor :reach_criteria # The report's schedule. Can only be set if the report's 'dateRange' is a # relative date range and the relative date range is not "TODAY". # Corresponds to the JSON property `schedule` # @return [Google::Apis::DfareportingV3_0::Report::Schedule] attr_accessor :schedule # The subaccount ID to which this report belongs if applicable. # Corresponds to the JSON property `subAccountId` # @return [Fixnum] attr_accessor :sub_account_id # The type of the report. # 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) @account_id = args[:account_id] if args.key?(:account_id) @criteria = args[:criteria] if args.key?(:criteria) @cross_dimension_reach_criteria = args[:cross_dimension_reach_criteria] if args.key?(:cross_dimension_reach_criteria) @delivery = args[:delivery] if args.key?(:delivery) @etag = args[:etag] if args.key?(:etag) @file_name = args[:file_name] if args.key?(:file_name) @floodlight_criteria = args[:floodlight_criteria] if args.key?(:floodlight_criteria) @format = args[:format] if args.key?(:format) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time) @name = args[:name] if args.key?(:name) @owner_profile_id = args[:owner_profile_id] if args.key?(:owner_profile_id) @path_to_conversion_criteria = args[:path_to_conversion_criteria] if args.key?(:path_to_conversion_criteria) @reach_criteria = args[:reach_criteria] if args.key?(:reach_criteria) @schedule = args[:schedule] if args.key?(:schedule) @sub_account_id = args[:sub_account_id] if args.key?(:sub_account_id) @type = args[:type] if args.key?(:type) end # The report criteria for a report of type "STANDARD". class Criteria include Google::Apis::Core::Hashable # Represents an activity group. # Corresponds to the JSON property `activities` # @return [Google::Apis::DfareportingV3_0::Activities] attr_accessor :activities # Represents a Custom Rich Media Events group. # Corresponds to the JSON property `customRichMediaEvents` # @return [Google::Apis::DfareportingV3_0::CustomRichMediaEvents] attr_accessor :custom_rich_media_events # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV3_0::DateRange] attr_accessor :date_range # The list of filters on which dimensions are filtered. # Filters for different dimensions are ANDed, filters for the same dimension are # grouped together and ORed. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # The list of standard dimensions the report should include. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # The list of names of metrics the report should include. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @activities = args[:activities] if args.key?(:activities) @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) @date_range = args[:date_range] if args.key?(:date_range) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @metric_names = args[:metric_names] if args.key?(:metric_names) end end # The report criteria for a report of type "CROSS_DIMENSION_REACH". class CrossDimensionReachCriteria include Google::Apis::Core::Hashable # The list of dimensions the report should include. # Corresponds to the JSON property `breakdown` # @return [Array] attr_accessor :breakdown # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV3_0::DateRange] attr_accessor :date_range # The dimension option. # Corresponds to the JSON property `dimension` # @return [String] attr_accessor :dimension # The list of filters on which dimensions are filtered. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # The list of names of metrics the report should include. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names # The list of names of overlap metrics the report should include. # Corresponds to the JSON property `overlapMetricNames` # @return [Array] attr_accessor :overlap_metric_names # Whether the report is pivoted or not. Defaults to true. # Corresponds to the JSON property `pivoted` # @return [Boolean] attr_accessor :pivoted alias_method :pivoted?, :pivoted def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @breakdown = args[:breakdown] if args.key?(:breakdown) @date_range = args[:date_range] if args.key?(:date_range) @dimension = args[:dimension] if args.key?(:dimension) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @metric_names = args[:metric_names] if args.key?(:metric_names) @overlap_metric_names = args[:overlap_metric_names] if args.key?(:overlap_metric_names) @pivoted = args[:pivoted] if args.key?(:pivoted) end end # The report's email delivery settings. class Delivery include Google::Apis::Core::Hashable # Whether the report should be emailed to the report owner. # Corresponds to the JSON property `emailOwner` # @return [Boolean] attr_accessor :email_owner alias_method :email_owner?, :email_owner # The type of delivery for the owner to receive, if enabled. # Corresponds to the JSON property `emailOwnerDeliveryType` # @return [String] attr_accessor :email_owner_delivery_type # The message to be sent with each email. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message # The list of recipients to which to email the report. # Corresponds to the JSON property `recipients` # @return [Array] attr_accessor :recipients def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email_owner = args[:email_owner] if args.key?(:email_owner) @email_owner_delivery_type = args[:email_owner_delivery_type] if args.key?(:email_owner_delivery_type) @message = args[:message] if args.key?(:message) @recipients = args[:recipients] if args.key?(:recipients) end end # The report criteria for a report of type "FLOODLIGHT". class FloodlightCriteria include Google::Apis::Core::Hashable # The list of custom rich media events to include. # Corresponds to the JSON property `customRichMediaEvents` # @return [Array] attr_accessor :custom_rich_media_events # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV3_0::DateRange] attr_accessor :date_range # The list of filters on which dimensions are filtered. # Filters for different dimensions are ANDed, filters for the same dimension are # grouped together and ORed. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # The list of dimensions the report should include. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightConfigId` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :floodlight_config_id # The list of names of metrics the report should include. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names # The properties of the report. # Corresponds to the JSON property `reportProperties` # @return [Google::Apis::DfareportingV3_0::Report::FloodlightCriteria::ReportProperties] attr_accessor :report_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) @date_range = args[:date_range] if args.key?(:date_range) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @floodlight_config_id = args[:floodlight_config_id] if args.key?(:floodlight_config_id) @metric_names = args[:metric_names] if args.key?(:metric_names) @report_properties = args[:report_properties] if args.key?(:report_properties) end # The properties of the report. class ReportProperties include Google::Apis::Core::Hashable # Include conversions that have no cookie, but do have an exposure path. # Corresponds to the JSON property `includeAttributedIPConversions` # @return [Boolean] attr_accessor :include_attributed_ip_conversions alias_method :include_attributed_ip_conversions?, :include_attributed_ip_conversions # Include conversions of users with a DoubleClick cookie but without an exposure. # That means the user did not click or see an ad from the advertiser within the # Floodlight group, or that the interaction happened outside the lookback window. # Corresponds to the JSON property `includeUnattributedCookieConversions` # @return [Boolean] attr_accessor :include_unattributed_cookie_conversions alias_method :include_unattributed_cookie_conversions?, :include_unattributed_cookie_conversions # Include conversions that have no associated cookies and no exposures. It’s # therefore impossible to know how the user was exposed to your ads during the # lookback window prior to a conversion. # Corresponds to the JSON property `includeUnattributedIPConversions` # @return [Boolean] attr_accessor :include_unattributed_ip_conversions alias_method :include_unattributed_ip_conversions?, :include_unattributed_ip_conversions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @include_attributed_ip_conversions = args[:include_attributed_ip_conversions] if args.key?(:include_attributed_ip_conversions) @include_unattributed_cookie_conversions = args[:include_unattributed_cookie_conversions] if args.key?(:include_unattributed_cookie_conversions) @include_unattributed_ip_conversions = args[:include_unattributed_ip_conversions] if args.key?(:include_unattributed_ip_conversions) end end end # The report criteria for a report of type "PATH_TO_CONVERSION". class PathToConversionCriteria include Google::Apis::Core::Hashable # The list of 'dfa:activity' values to filter on. # Corresponds to the JSON property `activityFilters` # @return [Array] attr_accessor :activity_filters # The list of conversion dimensions the report should include. # Corresponds to the JSON property `conversionDimensions` # @return [Array] attr_accessor :conversion_dimensions # The list of custom floodlight variables the report should include. # Corresponds to the JSON property `customFloodlightVariables` # @return [Array] attr_accessor :custom_floodlight_variables # The list of custom rich media events to include. # Corresponds to the JSON property `customRichMediaEvents` # @return [Array] attr_accessor :custom_rich_media_events # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV3_0::DateRange] attr_accessor :date_range # Represents a DimensionValue resource. # Corresponds to the JSON property `floodlightConfigId` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :floodlight_config_id # The list of names of metrics the report should include. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names # The list of per interaction dimensions the report should include. # Corresponds to the JSON property `perInteractionDimensions` # @return [Array] attr_accessor :per_interaction_dimensions # The properties of the report. # Corresponds to the JSON property `reportProperties` # @return [Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria::ReportProperties] attr_accessor :report_properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @activity_filters = args[:activity_filters] if args.key?(:activity_filters) @conversion_dimensions = args[:conversion_dimensions] if args.key?(:conversion_dimensions) @custom_floodlight_variables = args[:custom_floodlight_variables] if args.key?(:custom_floodlight_variables) @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) @date_range = args[:date_range] if args.key?(:date_range) @floodlight_config_id = args[:floodlight_config_id] if args.key?(:floodlight_config_id) @metric_names = args[:metric_names] if args.key?(:metric_names) @per_interaction_dimensions = args[:per_interaction_dimensions] if args.key?(:per_interaction_dimensions) @report_properties = args[:report_properties] if args.key?(:report_properties) end # The properties of the report. class ReportProperties include Google::Apis::Core::Hashable # DFA checks to see if a click interaction occurred within the specified period # of time before a conversion. By default the value is pulled from Floodlight or # you can manually enter a custom value. Valid values: 1-90. # Corresponds to the JSON property `clicksLookbackWindow` # @return [Fixnum] attr_accessor :clicks_lookback_window # DFA checks to see if an impression interaction occurred within the specified # period of time before a conversion. By default the value is pulled from # Floodlight or you can manually enter a custom value. Valid values: 1-90. # Corresponds to the JSON property `impressionsLookbackWindow` # @return [Fixnum] attr_accessor :impressions_lookback_window # Deprecated: has no effect. # Corresponds to the JSON property `includeAttributedIPConversions` # @return [Boolean] attr_accessor :include_attributed_ip_conversions alias_method :include_attributed_ip_conversions?, :include_attributed_ip_conversions # Include conversions of users with a DoubleClick cookie but without an exposure. # That means the user did not click or see an ad from the advertiser within the # Floodlight group, or that the interaction happened outside the lookback window. # Corresponds to the JSON property `includeUnattributedCookieConversions` # @return [Boolean] attr_accessor :include_unattributed_cookie_conversions alias_method :include_unattributed_cookie_conversions?, :include_unattributed_cookie_conversions # Include conversions that have no associated cookies and no exposures. It’s # therefore impossible to know how the user was exposed to your ads during the # lookback window prior to a conversion. # Corresponds to the JSON property `includeUnattributedIPConversions` # @return [Boolean] attr_accessor :include_unattributed_ip_conversions alias_method :include_unattributed_ip_conversions?, :include_unattributed_ip_conversions # The maximum number of click interactions to include in the report. Advertisers # currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). # If another advertiser in your network is paying for E2C, you can have up to 5 # total exposures per report. # Corresponds to the JSON property `maximumClickInteractions` # @return [Fixnum] attr_accessor :maximum_click_interactions # The maximum number of click interactions to include in the report. Advertisers # currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). # If another advertiser in your network is paying for E2C, you can have up to 5 # total exposures per report. # Corresponds to the JSON property `maximumImpressionInteractions` # @return [Fixnum] attr_accessor :maximum_impression_interactions # The maximum amount of time that can take place between interactions (clicks or # impressions) by the same user. Valid values: 1-90. # Corresponds to the JSON property `maximumInteractionGap` # @return [Fixnum] attr_accessor :maximum_interaction_gap # Enable pivoting on interaction path. # Corresponds to the JSON property `pivotOnInteractionPath` # @return [Boolean] attr_accessor :pivot_on_interaction_path alias_method :pivot_on_interaction_path?, :pivot_on_interaction_path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @clicks_lookback_window = args[:clicks_lookback_window] if args.key?(:clicks_lookback_window) @impressions_lookback_window = args[:impressions_lookback_window] if args.key?(:impressions_lookback_window) @include_attributed_ip_conversions = args[:include_attributed_ip_conversions] if args.key?(:include_attributed_ip_conversions) @include_unattributed_cookie_conversions = args[:include_unattributed_cookie_conversions] if args.key?(:include_unattributed_cookie_conversions) @include_unattributed_ip_conversions = args[:include_unattributed_ip_conversions] if args.key?(:include_unattributed_ip_conversions) @maximum_click_interactions = args[:maximum_click_interactions] if args.key?(:maximum_click_interactions) @maximum_impression_interactions = args[:maximum_impression_interactions] if args.key?(:maximum_impression_interactions) @maximum_interaction_gap = args[:maximum_interaction_gap] if args.key?(:maximum_interaction_gap) @pivot_on_interaction_path = args[:pivot_on_interaction_path] if args.key?(:pivot_on_interaction_path) end end end # The report criteria for a report of type "REACH". class ReachCriteria include Google::Apis::Core::Hashable # Represents an activity group. # Corresponds to the JSON property `activities` # @return [Google::Apis::DfareportingV3_0::Activities] attr_accessor :activities # Represents a Custom Rich Media Events group. # Corresponds to the JSON property `customRichMediaEvents` # @return [Google::Apis::DfareportingV3_0::CustomRichMediaEvents] attr_accessor :custom_rich_media_events # Represents a date range. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::DfareportingV3_0::DateRange] attr_accessor :date_range # The list of filters on which dimensions are filtered. # Filters for different dimensions are ANDed, filters for the same dimension are # grouped together and ORed. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # The list of dimensions the report should include. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # Whether to enable all reach dimension combinations in the report. Defaults to # false. If enabled, the date range of the report should be within the last 42 # days. # Corresponds to the JSON property `enableAllDimensionCombinations` # @return [Boolean] attr_accessor :enable_all_dimension_combinations alias_method :enable_all_dimension_combinations?, :enable_all_dimension_combinations # The list of names of metrics the report should include. # Corresponds to the JSON property `metricNames` # @return [Array] attr_accessor :metric_names # The list of names of Reach By Frequency metrics the report should include. # Corresponds to the JSON property `reachByFrequencyMetricNames` # @return [Array] attr_accessor :reach_by_frequency_metric_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @activities = args[:activities] if args.key?(:activities) @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) @date_range = args[:date_range] if args.key?(:date_range) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @enable_all_dimension_combinations = args[:enable_all_dimension_combinations] if args.key?(:enable_all_dimension_combinations) @metric_names = args[:metric_names] if args.key?(:metric_names) @reach_by_frequency_metric_names = args[:reach_by_frequency_metric_names] if args.key?(:reach_by_frequency_metric_names) end end # The report's schedule. Can only be set if the report's 'dateRange' is a # relative date range and the relative date range is not "TODAY". class Schedule include Google::Apis::Core::Hashable # Whether the schedule is active or not. Must be set to either true or false. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Defines every how many days, weeks or months the report should be run. Needs # to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY". # Corresponds to the JSON property `every` # @return [Fixnum] attr_accessor :every # The expiration date when the scheduled report stops running. # Corresponds to the JSON property `expirationDate` # @return [Date] attr_accessor :expiration_date # The interval for which the report is repeated. Note: # - "DAILY" also requires field "every" to be set. # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set. # Corresponds to the JSON property `repeats` # @return [String] attr_accessor :repeats # List of week days "WEEKLY" on which scheduled reports should run. # Corresponds to the JSON property `repeatsOnWeekDays` # @return [Array] attr_accessor :repeats_on_week_days # Enum to define for "MONTHLY" scheduled reports whether reports should be # repeated on the same day of the month as "startDate" or the same day of the # week of the month. # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" # would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" # would run subsequent reports on the first Monday of the month. # Corresponds to the JSON property `runsOnDayOfMonth` # @return [String] attr_accessor :runs_on_day_of_month # Start date of date range for which scheduled reports should be run. # Corresponds to the JSON property `startDate` # @return [Date] attr_accessor :start_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active = args[:active] if args.key?(:active) @every = args[:every] if args.key?(:every) @expiration_date = args[:expiration_date] if args.key?(:expiration_date) @repeats = args[:repeats] if args.key?(:repeats) @repeats_on_week_days = args[:repeats_on_week_days] if args.key?(:repeats_on_week_days) @runs_on_day_of_month = args[:runs_on_day_of_month] if args.key?(:runs_on_day_of_month) @start_date = args[:start_date] if args.key?(:start_date) end end end # Represents fields that are compatible to be selected for a report of type " # STANDARD". class ReportCompatibleFields include Google::Apis::Core::Hashable # Dimensions which are compatible to be selected in the "dimensionFilters" # section of the report. # Corresponds to the JSON property `dimensionFilters` # @return [Array] attr_accessor :dimension_filters # Dimensions which are compatible to be selected in the "dimensions" section of # the report. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions # The kind of resource this is, in this case dfareporting#reportCompatibleFields. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Metrics which are compatible to be selected in the "metricNames" section of # the report. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Metrics which are compatible to be selected as activity metrics to pivot on in # the "activities" section of the report. # Corresponds to the JSON property `pivotedActivityMetrics` # @return [Array] attr_accessor :pivoted_activity_metrics def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @kind = args[:kind] if args.key?(:kind) @metrics = args[:metrics] if args.key?(:metrics) @pivoted_activity_metrics = args[:pivoted_activity_metrics] if args.key?(:pivoted_activity_metrics) end end # Represents the list of reports. class ReportList include Google::Apis::Core::Hashable # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The reports returned in this response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of list this is, in this case dfareporting#reportList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Continuation token used to page through reports. To retrieve the next page of # results, set the next request's "pageToken" to the value of this field. The # page token is only valid for a limited amount of time and should not be # persisted. # 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) @etag = args[:etag] if args.key?(:etag) @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) end end # Reporting Configuration class ReportsConfiguration include Google::Apis::Core::Hashable # Whether the exposure to conversion report is enabled. This report shows # detailed pathway information on up to 10 of the most recent ad exposures seen # by a user before converting. # Corresponds to the JSON property `exposureToConversionEnabled` # @return [Boolean] attr_accessor :exposure_to_conversion_enabled alias_method :exposure_to_conversion_enabled?, :exposure_to_conversion_enabled # Lookback configuration settings. # Corresponds to the JSON property `lookbackConfiguration` # @return [Google::Apis::DfareportingV3_0::LookbackConfiguration] attr_accessor :lookback_configuration # Report generation time zone ID of this account. This is a required field that # can only be changed by a superuser. # Acceptable values are: # - "1" for "America/New_York" # - "2" for "Europe/London" # - "3" for "Europe/Paris" # - "4" for "Africa/Johannesburg" # - "5" for "Asia/Jerusalem" # - "6" for "Asia/Shanghai" # - "7" for "Asia/Hong_Kong" # - "8" for "Asia/Tokyo" # - "9" for "Australia/Sydney" # - "10" for "Asia/Dubai" # - "11" for "America/Los_Angeles" # - "12" for "Pacific/Auckland" # - "13" for "America/Sao_Paulo" # Corresponds to the JSON property `reportGenerationTimeZoneId` # @return [Fixnum] attr_accessor :report_generation_time_zone_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @exposure_to_conversion_enabled = args[:exposure_to_conversion_enabled] if args.key?(:exposure_to_conversion_enabled) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @report_generation_time_zone_id = args[:report_generation_time_zone_id] if args.key?(:report_generation_time_zone_id) end end # Rich Media Exit Override. class RichMediaExitOverride include Google::Apis::Core::Hashable # Click-through URL # Corresponds to the JSON property `clickThroughUrl` # @return [Google::Apis::DfareportingV3_0::ClickThroughUrl] attr_accessor :click_through_url # Whether to use the clickThroughUrl. If false, the creative-level exit will be # used. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # ID for the override to refer to a specific exit in the creative. # Corresponds to the JSON property `exitId` # @return [Fixnum] attr_accessor :exit_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @click_through_url = args[:click_through_url] if args.key?(:click_through_url) @enabled = args[:enabled] if args.key?(:enabled) @exit_id = args[:exit_id] if args.key?(:exit_id) end end # A rule associates an asset with a targeting template for asset-level targeting. # Applicable to INSTREAM_VIDEO creatives. class Rule include Google::Apis::Core::Hashable # A creativeAssets[].id. This should refer to one of the parent assets in this # creative. This is a required field. # Corresponds to the JSON property `assetId` # @return [Fixnum] attr_accessor :asset_id # A user-friendly name for this rule. This is a required field. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A targeting template ID. The targeting from the targeting template will be # used to determine whether this asset should be served. This is a required # field. # Corresponds to the JSON property `targetingTemplateId` # @return [Fixnum] attr_accessor :targeting_template_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @asset_id = args[:asset_id] if args.key?(:asset_id) @name = args[:name] if args.key?(:name) @targeting_template_id = args[:targeting_template_id] if args.key?(:targeting_template_id) end end # Contains properties of a site. class Site include Google::Apis::Core::Hashable # Account ID of this site. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this site is approved. # Corresponds to the JSON property `approved` # @return [Boolean] attr_accessor :approved alias_method :approved?, :approved # Directory site associated with this site. This is a required field that is # read-only after insertion. # Corresponds to the JSON property `directorySiteId` # @return [Fixnum] attr_accessor :directory_site_id # Represents a DimensionValue resource. # Corresponds to the JSON property `directorySiteIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :directory_site_id_dimension_value # ID of this site. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Represents a DimensionValue resource. # Corresponds to the JSON property `idDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :id_dimension_value # Key name of this site. This is a read-only, auto-generated field. # Corresponds to the JSON property `keyName` # @return [String] attr_accessor :key_name # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#site". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this site.This is a required field. Must be less than 128 characters # long. If this site is under a subaccount, the name must be unique among sites # of the same subaccount. Otherwise, this site is a top-level site, and the name # must be unique among top-level sites of the same account. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Site contacts. # Corresponds to the JSON property `siteContacts` # @return [Array] attr_accessor :site_contacts # Site Settings # Corresponds to the JSON property `siteSettings` # @return [Google::Apis::DfareportingV3_0::SiteSettings] attr_accessor :site_settings # Subaccount ID of this site. This is a read-only field that can be left blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @approved = args[:approved] if args.key?(:approved) @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @key_name = args[:key_name] if args.key?(:key_name) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @site_contacts = args[:site_contacts] if args.key?(:site_contacts) @site_settings = args[:site_settings] if args.key?(:site_settings) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Site Contact class SiteContact include Google::Apis::Core::Hashable # Address of this site contact. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Site contact type. # Corresponds to the JSON property `contactType` # @return [String] attr_accessor :contact_type # Email address of this site contact. This is a required field. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # First name of this site contact. # Corresponds to the JSON property `firstName` # @return [String] attr_accessor :first_name # ID of this site contact. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Last name of this site contact. # Corresponds to the JSON property `lastName` # @return [String] attr_accessor :last_name # Primary phone number of this site contact. # Corresponds to the JSON property `phone` # @return [String] attr_accessor :phone # Title or designation of this site contact. # 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) @address = args[:address] if args.key?(:address) @contact_type = args[:contact_type] if args.key?(:contact_type) @email = args[:email] if args.key?(:email) @first_name = args[:first_name] if args.key?(:first_name) @id = args[:id] if args.key?(:id) @last_name = args[:last_name] if args.key?(:last_name) @phone = args[:phone] if args.key?(:phone) @title = args[:title] if args.key?(:title) end end # Site Settings class SiteSettings include Google::Apis::Core::Hashable # Whether active view creatives are disabled for this site. # Corresponds to the JSON property `activeViewOptOut` # @return [Boolean] attr_accessor :active_view_opt_out alias_method :active_view_opt_out?, :active_view_opt_out # Whether this site opts out of ad blocking. When true, ad blocking is disabled # for all placements under the site, regardless of the individual placement # settings. When false, the campaign and placement settings take effect. # Corresponds to the JSON property `adBlockingOptOut` # @return [Boolean] attr_accessor :ad_blocking_opt_out alias_method :ad_blocking_opt_out?, :ad_blocking_opt_out # Creative Settings # Corresponds to the JSON property `creativeSettings` # @return [Google::Apis::DfareportingV3_0::CreativeSettings] attr_accessor :creative_settings # Whether new cookies are disabled for this site. # Corresponds to the JSON property `disableNewCookie` # @return [Boolean] attr_accessor :disable_new_cookie alias_method :disable_new_cookie?, :disable_new_cookie # Lookback configuration settings. # Corresponds to the JSON property `lookbackConfiguration` # @return [Google::Apis::DfareportingV3_0::LookbackConfiguration] attr_accessor :lookback_configuration # Tag Settings # Corresponds to the JSON property `tagSetting` # @return [Google::Apis::DfareportingV3_0::TagSetting] attr_accessor :tag_setting # Whether Verification and ActiveView for in-stream video creatives are disabled # by default for new placements created under this site. This value will be used # to populate the placement.videoActiveViewOptOut field, when no value is # specified for the new placement. # Corresponds to the JSON property `videoActiveViewOptOutTemplate` # @return [Boolean] attr_accessor :video_active_view_opt_out_template alias_method :video_active_view_opt_out_template?, :video_active_view_opt_out_template # Default VPAID adapter setting for new placements created under this site. This # value will be used to populate the placements.vpaidAdapterChoice field, when # no value is specified for the new placement. Controls which VPAID format the # measurement adapter will use for in-stream video creatives assigned to the # placement. The publisher's specifications will typically determine this # setting. For VPAID creatives, the adapter format will match the VPAID format ( # HTML5 VPAID creatives use the HTML5 adapter). # Note: Flash is no longer supported. This field now defaults to HTML5 when the # following values are provided: FLASH, BOTH. # Corresponds to the JSON property `vpaidAdapterChoiceTemplate` # @return [String] attr_accessor :vpaid_adapter_choice_template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) @ad_blocking_opt_out = args[:ad_blocking_opt_out] if args.key?(:ad_blocking_opt_out) @creative_settings = args[:creative_settings] if args.key?(:creative_settings) @disable_new_cookie = args[:disable_new_cookie] if args.key?(:disable_new_cookie) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @tag_setting = args[:tag_setting] if args.key?(:tag_setting) @video_active_view_opt_out_template = args[:video_active_view_opt_out_template] if args.key?(:video_active_view_opt_out_template) @vpaid_adapter_choice_template = args[:vpaid_adapter_choice_template] if args.key?(:vpaid_adapter_choice_template) end end # Site List Response class SitesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#sitesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Site collection. # Corresponds to the JSON property `sites` # @return [Array] attr_accessor :sites 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) @sites = args[:sites] if args.key?(:sites) end end # Represents the dimensions of ads, placements, creatives, or creative assets. class Size include Google::Apis::Core::Hashable # Height of this size. Acceptable values are 0 to 32767, inclusive. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # IAB standard size. This is a read-only, auto-generated field. # Corresponds to the JSON property `iab` # @return [Boolean] attr_accessor :iab alias_method :iab?, :iab # ID of this size. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#size". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Width of this size. Acceptable values are 0 to 32767, inclusive. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @iab = args[:iab] if args.key?(:iab) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @width = args[:width] if args.key?(:width) end end # Size List Response class SizesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#sizesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Size collection. # Corresponds to the JSON property `sizes` # @return [Array] attr_accessor :sizes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @sizes = args[:sizes] if args.key?(:sizes) end end # Skippable Settings class SkippableSetting include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#skippableSetting". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Video Offset # Corresponds to the JSON property `progressOffset` # @return [Google::Apis::DfareportingV3_0::VideoOffset] attr_accessor :progress_offset # Video Offset # Corresponds to the JSON property `skipOffset` # @return [Google::Apis::DfareportingV3_0::VideoOffset] attr_accessor :skip_offset # Whether the user can skip creatives served to this placement. # Corresponds to the JSON property `skippable` # @return [Boolean] attr_accessor :skippable alias_method :skippable?, :skippable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @progress_offset = args[:progress_offset] if args.key?(:progress_offset) @skip_offset = args[:skip_offset] if args.key?(:skip_offset) @skippable = args[:skippable] if args.key?(:skippable) end end # Represents a sorted dimension. class SortedDimension include Google::Apis::Core::Hashable # The kind of resource this is, in this case dfareporting#sortedDimension. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the dimension. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # An optional sort order for the dimension column. # Corresponds to the JSON property `sortOrder` # @return [String] attr_accessor :sort_order def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @sort_order = args[:sort_order] if args.key?(:sort_order) end end # Contains properties of a DCM subaccount. class Subaccount include Google::Apis::Core::Hashable # ID of the account that contains this subaccount. This is a read-only field # that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # IDs of the available user role permissions for this subaccount. # Corresponds to the JSON property `availablePermissionIds` # @return [Array] attr_accessor :available_permission_ids # ID of this subaccount. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#subaccount". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this subaccount. This is a required field. Must be less than 128 # characters long and be unique among subaccounts of the same account. # 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) @account_id = args[:account_id] if args.key?(:account_id) @available_permission_ids = args[:available_permission_ids] if args.key?(:available_permission_ids) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # Subaccount List Response class SubaccountsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#subaccountsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Subaccount collection. # Corresponds to the JSON property `subaccounts` # @return [Array] attr_accessor :subaccounts 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) @subaccounts = args[:subaccounts] if args.key?(:subaccounts) end end # Placement Tag Data class TagData include Google::Apis::Core::Hashable # Ad associated with this placement tag. Applicable only when format is # PLACEMENT_TAG_TRACKING. # Corresponds to the JSON property `adId` # @return [Fixnum] attr_accessor :ad_id # Tag string to record a click. # Corresponds to the JSON property `clickTag` # @return [String] attr_accessor :click_tag # Creative associated with this placement tag. Applicable only when format is # PLACEMENT_TAG_TRACKING. # Corresponds to the JSON property `creativeId` # @return [Fixnum] attr_accessor :creative_id # TagData tag format of this tag. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # Tag string for serving an ad. # Corresponds to the JSON property `impressionTag` # @return [String] attr_accessor :impression_tag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_id = args[:ad_id] if args.key?(:ad_id) @click_tag = args[:click_tag] if args.key?(:click_tag) @creative_id = args[:creative_id] if args.key?(:creative_id) @format = args[:format] if args.key?(:format) @impression_tag = args[:impression_tag] if args.key?(:impression_tag) end end # Tag Settings class TagSetting include Google::Apis::Core::Hashable # Additional key-values to be included in tags. Each key-value pair must be of # the form key=value, and pairs must be separated by a semicolon (;). Keys and # values must not contain commas. For example, id=2;color=red is a valid value # for this field. # Corresponds to the JSON property `additionalKeyValues` # @return [String] attr_accessor :additional_key_values # Whether static landing page URLs should be included in the tags. This setting # applies only to placements. # Corresponds to the JSON property `includeClickThroughUrls` # @return [Boolean] attr_accessor :include_click_through_urls alias_method :include_click_through_urls?, :include_click_through_urls # Whether click-tracking string should be included in the tags. # Corresponds to the JSON property `includeClickTracking` # @return [Boolean] attr_accessor :include_click_tracking alias_method :include_click_tracking?, :include_click_tracking # Option specifying how keywords are embedded in ad tags. This setting can be # used to specify whether keyword placeholders are inserted in placement tags # for this site. Publishers can then add keywords to those placeholders. # Corresponds to the JSON property `keywordOption` # @return [String] attr_accessor :keyword_option def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @additional_key_values = args[:additional_key_values] if args.key?(:additional_key_values) @include_click_through_urls = args[:include_click_through_urls] if args.key?(:include_click_through_urls) @include_click_tracking = args[:include_click_tracking] if args.key?(:include_click_tracking) @keyword_option = args[:keyword_option] if args.key?(:keyword_option) end end # Dynamic and Image Tag Settings. class TagSettings include Google::Apis::Core::Hashable # Whether dynamic floodlight tags are enabled. # Corresponds to the JSON property `dynamicTagEnabled` # @return [Boolean] attr_accessor :dynamic_tag_enabled alias_method :dynamic_tag_enabled?, :dynamic_tag_enabled # Whether image tags are enabled. # Corresponds to the JSON property `imageTagEnabled` # @return [Boolean] attr_accessor :image_tag_enabled alias_method :image_tag_enabled?, :image_tag_enabled def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @dynamic_tag_enabled = args[:dynamic_tag_enabled] if args.key?(:dynamic_tag_enabled) @image_tag_enabled = args[:image_tag_enabled] if args.key?(:image_tag_enabled) end end # Target Window. class TargetWindow include Google::Apis::Core::Hashable # User-entered value. # Corresponds to the JSON property `customHtml` # @return [String] attr_accessor :custom_html # Type of browser window for which the backup image of the flash creative can be # displayed. # Corresponds to the JSON property `targetWindowOption` # @return [String] attr_accessor :target_window_option def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @custom_html = args[:custom_html] if args.key?(:custom_html) @target_window_option = args[:target_window_option] if args.key?(:target_window_option) end end # Contains properties of a targetable remarketing list. Remarketing enables you # to create lists of users who have performed specific actions on a site, then # target ads to members of those lists. This resource is a read-only view of a # remarketing list to be used to faciliate targeting ads to specific lists. # Remarketing lists that are owned by your advertisers and those that are shared # to your advertisers or account are accessible via this resource. To manage # remarketing lists that are owned by your advertisers, use the RemarketingLists # resource. class TargetableRemarketingList include Google::Apis::Core::Hashable # Account ID of this remarketing list. This is a read-only, auto-generated field # that is only returned in GET requests. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this targetable remarketing list is active. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # Dimension value for the advertiser ID that owns this targetable remarketing # list. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Targetable remarketing list description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Targetable remarketing list ID. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#targetableRemarketingList". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Number of days that a user should remain in the targetable remarketing list # without an impression. # Corresponds to the JSON property `lifeSpan` # @return [Fixnum] attr_accessor :life_span # Number of users currently in the list. This is a read-only field. # Corresponds to the JSON property `listSize` # @return [Fixnum] attr_accessor :list_size # Product from which this targetable remarketing list was originated. # Corresponds to the JSON property `listSource` # @return [String] attr_accessor :list_source # Name of the targetable remarketing list. Is no greater than 128 characters # long. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this remarketing list. This is a read-only, auto-generated # field that is only returned in GET requests. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @active = args[:active] if args.key?(:active) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @life_span = args[:life_span] if args.key?(:life_span) @list_size = args[:list_size] if args.key?(:list_size) @list_source = args[:list_source] if args.key?(:list_source) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Targetable remarketing list response class TargetableRemarketingListsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#targetableRemarketingListsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Targetable remarketing list collection. # Corresponds to the JSON property `targetableRemarketingLists` # @return [Array] attr_accessor :targetable_remarketing_lists 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) @targetable_remarketing_lists = args[:targetable_remarketing_lists] if args.key?(:targetable_remarketing_lists) end end # Contains properties of a targeting template. A targeting template encapsulates # targeting information which can be reused across multiple ads. class TargetingTemplate include Google::Apis::Core::Hashable # Account ID of this targeting template. This field, if left unset, will be auto- # generated on insert and is read-only after insert. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Advertiser ID of this targeting template. This is a required field on insert # and is read-only after insert. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id # Represents a DimensionValue resource. # Corresponds to the JSON property `advertiserIdDimensionValue` # @return [Google::Apis::DfareportingV3_0::DimensionValue] attr_accessor :advertiser_id_dimension_value # Day Part Targeting. # Corresponds to the JSON property `dayPartTargeting` # @return [Google::Apis::DfareportingV3_0::DayPartTargeting] attr_accessor :day_part_targeting # Geographical Targeting. # Corresponds to the JSON property `geoTargeting` # @return [Google::Apis::DfareportingV3_0::GeoTargeting] attr_accessor :geo_targeting # ID of this targeting template. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Key Value Targeting Expression. # Corresponds to the JSON property `keyValueTargetingExpression` # @return [Google::Apis::DfareportingV3_0::KeyValueTargetingExpression] attr_accessor :key_value_targeting_expression # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#targetingTemplate". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Language Targeting. # Corresponds to the JSON property `languageTargeting` # @return [Google::Apis::DfareportingV3_0::LanguageTargeting] attr_accessor :language_targeting # Remarketing List Targeting Expression. # Corresponds to the JSON property `listTargetingExpression` # @return [Google::Apis::DfareportingV3_0::ListTargetingExpression] attr_accessor :list_targeting_expression # Name of this targeting template. This field is required. It must be less than # 256 characters long and unique within an advertiser. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subaccount ID of this targeting template. This field, if left unset, will be # auto-generated on insert and is read-only after insert. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id # Technology Targeting. # Corresponds to the JSON property `technologyTargeting` # @return [Google::Apis::DfareportingV3_0::TechnologyTargeting] attr_accessor :technology_targeting def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @day_part_targeting = args[:day_part_targeting] if args.key?(:day_part_targeting) @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting) @id = args[:id] if args.key?(:id) @key_value_targeting_expression = args[:key_value_targeting_expression] if args.key?(:key_value_targeting_expression) @kind = args[:kind] if args.key?(:kind) @language_targeting = args[:language_targeting] if args.key?(:language_targeting) @list_targeting_expression = args[:list_targeting_expression] if args.key?(:list_targeting_expression) @name = args[:name] if args.key?(:name) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @technology_targeting = args[:technology_targeting] if args.key?(:technology_targeting) end end # Targeting Template List Response class TargetingTemplatesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#targetingTemplatesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Targeting template collection. # Corresponds to the JSON property `targetingTemplates` # @return [Array] attr_accessor :targeting_templates 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) @targeting_templates = args[:targeting_templates] if args.key?(:targeting_templates) end end # Technology Targeting. class TechnologyTargeting include Google::Apis::Core::Hashable # Browsers that this ad targets. For each browser either set browserVersionId or # dartId along with the version numbers. If both are specified, only # browserVersionId will be used. The other fields are populated automatically # when the ad is inserted or updated. # Corresponds to the JSON property `browsers` # @return [Array] attr_accessor :browsers # Connection types that this ad targets. For each connection type only id is # required. The other fields are populated automatically when the ad is inserted # or updated. # Corresponds to the JSON property `connectionTypes` # @return [Array] attr_accessor :connection_types # Mobile carriers that this ad targets. For each mobile carrier only id is # required, and the other fields are populated automatically when the ad is # inserted or updated. If targeting a mobile carrier, do not set targeting for # any zip codes. # Corresponds to the JSON property `mobileCarriers` # @return [Array] attr_accessor :mobile_carriers # Operating system versions that this ad targets. To target all versions, use # operatingSystems. For each operating system version, only id is required. The # other fields are populated automatically when the ad is inserted or updated. # If targeting an operating system version, do not set targeting for the # corresponding operating system in operatingSystems. # Corresponds to the JSON property `operatingSystemVersions` # @return [Array] attr_accessor :operating_system_versions # Operating systems that this ad targets. To target specific versions, use # operatingSystemVersions. For each operating system only dartId is required. # The other fields are populated automatically when the ad is inserted or # updated. If targeting an operating system, do not set targeting for operating # system versions for the same operating system. # Corresponds to the JSON property `operatingSystems` # @return [Array] attr_accessor :operating_systems # Platform types that this ad targets. For example, desktop, mobile, or tablet. # For each platform type, only id is required, and the other fields are # populated automatically when the ad is inserted or updated. # Corresponds to the JSON property `platformTypes` # @return [Array] attr_accessor :platform_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @browsers = args[:browsers] if args.key?(:browsers) @connection_types = args[:connection_types] if args.key?(:connection_types) @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers) @operating_system_versions = args[:operating_system_versions] if args.key?(:operating_system_versions) @operating_systems = args[:operating_systems] if args.key?(:operating_systems) @platform_types = args[:platform_types] if args.key?(:platform_types) end end # Third Party Authentication Token class ThirdPartyAuthenticationToken include Google::Apis::Core::Hashable # Name of the third-party authentication token. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Value of the third-party authentication token. This is a read-only, auto- # generated field. # 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 # Third-party Tracking URL. class ThirdPartyTrackingUrl include Google::Apis::Core::Hashable # Third-party URL type for in-stream video creatives. # Corresponds to the JSON property `thirdPartyUrlType` # @return [String] attr_accessor :third_party_url_type # URL for the specified third-party URL type. # 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) @third_party_url_type = args[:third_party_url_type] if args.key?(:third_party_url_type) @url = args[:url] if args.key?(:url) end end # Transcode Settings class TranscodeSetting include Google::Apis::Core::Hashable # Whitelist of video formats to be served to this placement. Set this list to # null or empty to serve all video formats. # Corresponds to the JSON property `enabledVideoFormats` # @return [Array] attr_accessor :enabled_video_formats # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#transcodeSetting". # 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) @enabled_video_formats = args[:enabled_video_formats] if args.key?(:enabled_video_formats) @kind = args[:kind] if args.key?(:kind) end end # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following # creative types: INSTREAM_VIDEO and VPAID. class UniversalAdId include Google::Apis::Core::Hashable # Registry used for the Ad ID value. # Corresponds to the JSON property `registry` # @return [String] attr_accessor :registry # ID value for this creative. Only alphanumeric characters and the following # symbols are valid: "_/\-". Maximum length is 64 characters. Read only when # registry is DCM. # 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) @registry = args[:registry] if args.key?(:registry) @value = args[:value] if args.key?(:value) end end # User Defined Variable configuration. class UserDefinedVariableConfiguration include Google::Apis::Core::Hashable # Data type for the variable. This is a required field. # Corresponds to the JSON property `dataType` # @return [String] attr_accessor :data_type # User-friendly name for the variable which will appear in reports. This is a # required field, must be less than 64 characters long, and cannot contain the # following characters: ""<>". # Corresponds to the JSON property `reportName` # @return [String] attr_accessor :report_name # Variable name in the tag. This is a required field. # Corresponds to the JSON property `variableType` # @return [String] attr_accessor :variable_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data_type = args[:data_type] if args.key?(:data_type) @report_name = args[:report_name] if args.key?(:report_name) @variable_type = args[:variable_type] if args.key?(:variable_type) end end # Represents a UserProfile resource. class UserProfile include Google::Apis::Core::Hashable # The account ID to which this profile belongs. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # The account name this profile belongs to. # Corresponds to the JSON property `accountName` # @return [String] attr_accessor :account_name # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The kind of resource this is, in this case dfareporting#userProfile. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The unique ID of the user profile. # Corresponds to the JSON property `profileId` # @return [Fixnum] attr_accessor :profile_id # The sub account ID this profile belongs to if applicable. # Corresponds to the JSON property `subAccountId` # @return [Fixnum] attr_accessor :sub_account_id # The sub account name this profile belongs to if applicable. # Corresponds to the JSON property `subAccountName` # @return [String] attr_accessor :sub_account_name # The user name. # 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) @account_id = args[:account_id] if args.key?(:account_id) @account_name = args[:account_name] if args.key?(:account_name) @etag = args[:etag] if args.key?(:etag) @kind = args[:kind] if args.key?(:kind) @profile_id = args[:profile_id] if args.key?(:profile_id) @sub_account_id = args[:sub_account_id] if args.key?(:sub_account_id) @sub_account_name = args[:sub_account_name] if args.key?(:sub_account_name) @user_name = args[:user_name] if args.key?(:user_name) end end # Represents the list of user profiles. class UserProfileList include Google::Apis::Core::Hashable # The eTag of this response for caching purposes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The user profiles returned in this response. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of list this is, in this case dfareporting#userProfileList. # 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) @etag = args[:etag] if args.key?(:etag) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # Contains properties of auser role, which is used to manage user access. class UserRole include Google::Apis::Core::Hashable # Account ID of this user role. This is a read-only field that can be left blank. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Whether this is a default user role. Default user roles are created by the # system for the account/subaccount and cannot be modified or deleted. Each # default user role comes with a basic set of preassigned permissions. # Corresponds to the JSON property `defaultUserRole` # @return [Boolean] attr_accessor :default_user_role alias_method :default_user_role?, :default_user_role # ID of this user role. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRole". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this user role. This is a required field. Must be less than 256 # characters long. If this user role is under a subaccount, the name must be # unique among sites of the same subaccount. Otherwise, this user role is a top- # level user role, and the name must be unique among top-level user roles of the # same account. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # ID of the user role that this user role is based on or copied from. This is a # required field. # Corresponds to the JSON property `parentUserRoleId` # @return [Fixnum] attr_accessor :parent_user_role_id # List of permissions associated with this user role. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions # Subaccount ID of this user role. This is a read-only field that can be left # blank. # Corresponds to the JSON property `subaccountId` # @return [Fixnum] attr_accessor :subaccount_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @default_user_role = args[:default_user_role] if args.key?(:default_user_role) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @parent_user_role_id = args[:parent_user_role_id] if args.key?(:parent_user_role_id) @permissions = args[:permissions] if args.key?(:permissions) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) end end # Contains properties of a user role permission. class UserRolePermission include Google::Apis::Core::Hashable # Levels of availability for a user role permission. # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability # ID of this user role permission. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRolePermission". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this user role permission. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # ID of the permission group that this user role permission belongs to. # Corresponds to the JSON property `permissionGroupId` # @return [Fixnum] attr_accessor :permission_group_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @availability = args[:availability] if args.key?(:availability) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @permission_group_id = args[:permission_group_id] if args.key?(:permission_group_id) end end # Represents a grouping of related user role permissions. class UserRolePermissionGroup include Google::Apis::Core::Hashable # ID of this user role permission. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRolePermissionGroup". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of this user role permission 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # User Role Permission Group List Response class UserRolePermissionGroupsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRolePermissionGroupsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # User role permission group collection. # Corresponds to the JSON property `userRolePermissionGroups` # @return [Array] attr_accessor :user_role_permission_groups def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @user_role_permission_groups = args[:user_role_permission_groups] if args.key?(:user_role_permission_groups) end end # User Role Permission List Response class UserRolePermissionsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRolePermissionsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # User role permission collection. # Corresponds to the JSON property `userRolePermissions` # @return [Array] attr_accessor :user_role_permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @user_role_permissions = args[:user_role_permissions] if args.key?(:user_role_permissions) end end # User Role List Response class UserRolesListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#userRolesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Pagination token to be used for the next list operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # User role collection. # Corresponds to the JSON property `userRoles` # @return [Array] attr_accessor :user_roles 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) @user_roles = args[:user_roles] if args.key?(:user_roles) end end # Contains information about supported video formats. class VideoFormat include Google::Apis::Core::Hashable # File type of the video format. # Corresponds to the JSON property `fileType` # @return [String] attr_accessor :file_type # ID of the video format. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#videoFormat". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Represents the dimensions of ads, placements, creatives, or creative assets. # Corresponds to the JSON property `resolution` # @return [Google::Apis::DfareportingV3_0::Size] attr_accessor :resolution # The target bit rate of this video format. # Corresponds to the JSON property `targetBitRate` # @return [Fixnum] attr_accessor :target_bit_rate def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file_type = args[:file_type] if args.key?(:file_type) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @resolution = args[:resolution] if args.key?(:resolution) @target_bit_rate = args[:target_bit_rate] if args.key?(:target_bit_rate) end end # Video Format List Response class VideoFormatsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#videoFormatsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Video format collection. # Corresponds to the JSON property `videoFormats` # @return [Array] attr_accessor :video_formats def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @video_formats = args[:video_formats] if args.key?(:video_formats) end end # Video Offset class VideoOffset include Google::Apis::Core::Hashable # Duration, as a percentage of video duration. Do not set when offsetSeconds is # set. Acceptable values are 0 to 100, inclusive. # Corresponds to the JSON property `offsetPercentage` # @return [Fixnum] attr_accessor :offset_percentage # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable # values are 0 to 86399, inclusive. # Corresponds to the JSON property `offsetSeconds` # @return [Fixnum] attr_accessor :offset_seconds def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @offset_percentage = args[:offset_percentage] if args.key?(:offset_percentage) @offset_seconds = args[:offset_seconds] if args.key?(:offset_seconds) end end # Video Settings class VideoSettings include Google::Apis::Core::Hashable # Companion Settings # Corresponds to the JSON property `companionSettings` # @return [Google::Apis::DfareportingV3_0::CompanionSetting] attr_accessor :companion_settings # Identifies what kind of resource this is. Value: the fixed string " # dfareporting#videoSettings". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Orientation of a video placement. If this value is set, placement will return # assets matching the specified orientation. # Corresponds to the JSON property `orientation` # @return [String] attr_accessor :orientation # Skippable Settings # Corresponds to the JSON property `skippableSettings` # @return [Google::Apis::DfareportingV3_0::SkippableSetting] attr_accessor :skippable_settings # Transcode Settings # Corresponds to the JSON property `transcodeSettings` # @return [Google::Apis::DfareportingV3_0::TranscodeSetting] attr_accessor :transcode_settings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @companion_settings = args[:companion_settings] if args.key?(:companion_settings) @kind = args[:kind] if args.key?(:kind) @orientation = args[:orientation] if args.key?(:orientation) @skippable_settings = args[:skippable_settings] if args.key?(:skippable_settings) @transcode_settings = args[:transcode_settings] if args.key?(:transcode_settings) end end end end end google-api-client-0.19.8/generated/google/apis/dfareporting_v3_0/service.rb0000644000004100000410000213512013252673043026617 0ustar www-datawww-data# 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 DfareportingV3_0 # DCM/DFA Reporting And Trafficking API # # Manages your DoubleClick Campaign Manager ad campaigns and reports. # # @example # require 'google/apis/dfareporting_v3_0' # # Dfareporting = Google::Apis::DfareportingV3_0 # Alias the module # service = Dfareporting::DfareportingService.new # # @see https://developers.google.com/doubleclick-advertisers/ class DfareportingService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'dfareporting/v3.0/') @batch_path = 'batch/dfareporting/v3.0' end # Gets the account's active ad summary by account ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] summary_account_id # Account 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountActiveAdSummary] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountActiveAdSummary] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_active_ad_summary(profile_id, summary_account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}', options) command.response_representation = Google::Apis::DfareportingV3_0::AccountActiveAdSummary::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountActiveAdSummary command.params['profileId'] = profile_id unless profile_id.nil? command.params['summaryAccountId'] = summary_account_id unless summary_account_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 one account permission group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Account permission group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountPermissionGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountPermissionGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::AccountPermissionGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountPermissionGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 the list of account permission groups. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountPermissionGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountPermissionGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups', options) command.response_representation = Google::Apis::DfareportingV3_0::AccountPermissionGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountPermissionGroupsListResponse command.params['profileId'] = profile_id unless profile_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 one account permission by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Account permission 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountPermission] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountPermission] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::AccountPermission::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountPermission command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 the list of account permissions. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountPermissionsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountPermissionsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_permissions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions', options) command.response_representation = Google::Apis::DfareportingV3_0::AccountPermissionsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountPermissionsListResponse command.params['profileId'] = profile_id unless profile_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 one account user profile by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User profile 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountUserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_profile(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new account user profile. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::AccountUserProfile] account_user_profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountUserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/accountUserProfiles', options) command.request_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation command.request_object = account_user_profile_object command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile command.params['profileId'] = profile_id unless profile_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 account user profiles, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active user profiles. # @param [Array, Fixnum] ids # Select only user profiles with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name, ID or email. Wildcards (*) are allowed. # For example, "user profile*2015" will return objects with names like "user # profile June 2015", "user profile April 2015", or simply "user profile 2015". # Most of the searches also add wildcards implicitly at the start and the end of # the search string. For example, a search string of "user profile" will match # objects with name "my user profile", "user profile 2015", or simply "user # profile". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] subaccount_id # Select only user profiles with the specified subaccount ID. # @param [Fixnum] user_role_id # Select only user profiles with the specified user role 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountUserProfilesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountUserProfilesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_profiles(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, user_role_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles', options) command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfilesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfilesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? command.query['userRoleId'] = user_role_id unless user_role_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 an existing account user profile. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User profile ID. # @param [Google::Apis::DfareportingV3_0::AccountUserProfile] account_user_profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountUserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_profile(profile_id, id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/accountUserProfiles', options) command.request_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation command.request_object = account_user_profile_object command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing account user profile. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::AccountUserProfile] account_user_profile_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountUserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountUserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/accountUserProfiles', options) command.request_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation command.request_object = account_user_profile_object command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile command.params['profileId'] = profile_id unless profile_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 one account by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Account 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accounts/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Account::Representation command.response_class = Google::Apis::DfareportingV3_0::Account command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 the list of accounts, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active accounts. Don't set this field to select both active and # non-active accounts. # @param [Array, Fixnum] ids # Select only accounts with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "account*2015" will return objects with names like "account June 2015" # , "account April 2015", or simply "account 2015". Most of the searches also # add wildcards implicitly at the start and the end of the search string. For # example, a search string of "account" will match objects with name "my account" # , "account 2015", or simply "account". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AccountsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AccountsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_accounts(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/accounts', options) command.response_representation = Google::Apis::DfareportingV3_0::AccountsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::AccountsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 account. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Account ID. # @param [Google::Apis::DfareportingV3_0::Account] account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(profile_id, id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/accounts', options) command.request_representation = Google::Apis::DfareportingV3_0::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::DfareportingV3_0::Account::Representation command.response_class = Google::Apis::DfareportingV3_0::Account command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing account. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::Account] account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(profile_id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/accounts', options) command.request_representation = Google::Apis::DfareportingV3_0::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::DfareportingV3_0::Account::Representation command.response_class = Google::Apis::DfareportingV3_0::Account command.params['profileId'] = profile_id unless profile_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 one ad by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Ad 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Ad] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ad(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/ads/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation command.response_class = Google::Apis::DfareportingV3_0::Ad command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new ad. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::Ad] ad_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Ad] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/ads', options) command.request_representation = Google::Apis::DfareportingV3_0::Ad::Representation command.request_object = ad_object command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation command.response_class = Google::Apis::DfareportingV3_0::Ad command.params['profileId'] = profile_id unless profile_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 ads, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active ads. # @param [Fixnum] advertiser_id # Select only ads with this advertiser ID. # @param [Boolean] archived # Select only archived ads. # @param [Array, Fixnum] audience_segment_ids # Select only ads with these audience segment IDs. # @param [Array, Fixnum] campaign_ids # Select only ads with these campaign IDs. # @param [String] compatibility # Select default ads with the specified compatibility. Applicable when type is # AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering # either on desktop or on mobile devices for regular or interstitial ads, # respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. # IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the # VAST standard. # @param [Array, Fixnum] creative_ids # Select only ads with these creative IDs assigned. # @param [Array, Fixnum] creative_optimization_configuration_ids # Select only ads with these creative optimization configuration IDs. # @param [Boolean] dynamic_click_tracker # Select only dynamic click trackers. Applicable when type is # AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, # select static click trackers. Leave unset to select both. # @param [Array, Fixnum] ids # Select only ads with these IDs. # @param [Array, Fixnum] landing_page_ids # Select only ads with these landing page IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Fixnum] overridden_event_tag_id # Select only ads with this event tag override ID. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Array, Fixnum] placement_ids # Select only ads with these placement IDs assigned. # @param [Array, Fixnum] remarketing_list_ids # Select only ads whose list targeting expression use these remarketing list IDs. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "ad*2015" will return objects with names like "ad June 2015", "ad # April 2015", or simply "ad 2015". Most of the searches also add wildcards # implicitly at the start and the end of the search string. For example, a # search string of "ad" will match objects with name "my ad", "ad 2015", or # simply "ad". # @param [Array, Fixnum] size_ids # Select only ads with these size IDs. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Boolean] ssl_compliant # Select only ads that are SSL-compliant. # @param [Boolean] ssl_required # Select only ads that require SSL. # @param [Array, String] type # Select only ads with these types. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AdsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AdsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ads(profile_id, active: nil, advertiser_id: nil, archived: nil, audience_segment_ids: nil, campaign_ids: nil, compatibility: nil, creative_ids: nil, creative_optimization_configuration_ids: nil, dynamic_click_tracker: nil, ids: nil, landing_page_ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, placement_ids: nil, remarketing_list_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, ssl_compliant: nil, ssl_required: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/ads', options) command.response_representation = Google::Apis::DfareportingV3_0::AdsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::AdsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['archived'] = archived unless archived.nil? command.query['audienceSegmentIds'] = audience_segment_ids unless audience_segment_ids.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['compatibility'] = compatibility unless compatibility.nil? command.query['creativeIds'] = creative_ids unless creative_ids.nil? command.query['creativeOptimizationConfigurationIds'] = creative_optimization_configuration_ids unless creative_optimization_configuration_ids.nil? command.query['dynamicClickTracker'] = dynamic_click_tracker unless dynamic_click_tracker.nil? command.query['ids'] = ids unless ids.nil? command.query['landingPageIds'] = landing_page_ids unless landing_page_ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['overriddenEventTagId'] = overridden_event_tag_id unless overridden_event_tag_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['placementIds'] = placement_ids unless placement_ids.nil? command.query['remarketingListIds'] = remarketing_list_ids unless remarketing_list_ids.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sizeIds'] = size_ids unless size_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['sslCompliant'] = ssl_compliant unless ssl_compliant.nil? command.query['sslRequired'] = ssl_required unless ssl_required.nil? command.query['type'] = type unless 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 an existing ad. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Ad ID. # @param [Google::Apis::DfareportingV3_0::Ad] ad_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Ad] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ad(profile_id, id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/ads', options) command.request_representation = Google::Apis::DfareportingV3_0::Ad::Representation command.request_object = ad_object command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation command.response_class = Google::Apis::DfareportingV3_0::Ad command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing ad. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::Ad] ad_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Ad] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Ad] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/ads', options) command.request_representation = Google::Apis::DfareportingV3_0::Ad::Representation command.request_object = ad_object command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation command.response_class = Google::Apis::DfareportingV3_0::Ad command.params['profileId'] = profile_id unless profile_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 existing advertiser group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Advertiser group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_advertiser_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/advertiserGroups/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one advertiser group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Advertiser group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AdvertiserGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new advertiser group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::AdvertiserGroup] advertiser_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AdvertiserGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/advertiserGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation command.request_object = advertiser_group_object command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup command.params['profileId'] = profile_id unless profile_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 advertiser groups, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Select only advertiser groups with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "advertiser*2015" will return objects with names like "advertiser # group June 2015", "advertiser group April 2015", or simply "advertiser group # 2015". Most of the searches also add wildcards implicitly at the start and the # end of the search string. For example, a search string of "advertisergroup" # will match objects with name "my advertisergroup", "advertisergroup 2015", or # simply "advertisergroup". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AdvertiserGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_groups(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups', options) command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroupsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 advertiser group. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Advertiser group ID. # @param [Google::Apis::DfareportingV3_0::AdvertiserGroup] advertiser_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AdvertiserGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(profile_id, id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/advertiserGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation command.request_object = advertiser_group_object command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing advertiser group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::AdvertiserGroup] advertiser_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AdvertiserGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/advertiserGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation command.request_object = advertiser_group_object command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup command.params['profileId'] = profile_id unless profile_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 one landing page by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Landing page 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::LandingPage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_landing_page(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserLandingPages/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation command.response_class = Google::Apis::DfareportingV3_0::LandingPage command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new landing page. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::LandingPage] landing_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::LandingPage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/advertiserLandingPages', options) command.request_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation command.request_object = landing_page_object command.response_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation command.response_class = Google::Apis::DfareportingV3_0::LandingPage command.params['profileId'] = profile_id unless profile_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 landing pages. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only landing pages that belong to these advertisers. # @param [Boolean] archived # Select only archived landing pages. Don't set this field to select both # archived and non-archived landing pages. # @param [Array, Fixnum] ids # Select only landing pages with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for landing pages by name or ID. Wildcards (*) are allowed. # For example, "landingpage*2017" will return landing pages with names like " # landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". # Most of the searches also add wildcards implicitly at the start and the end # of the search string. For example, a search string of "landingpage" will match # campaigns with name "my landingpage", "landingpage 2015", or simply " # landingpage". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] subaccount_id # Select only landing pages that belong to this subaccount. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserLandingPagesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AdvertiserLandingPagesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_landing_pages(profile_id, advertiser_ids: nil, archived: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserLandingPages', options) command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserLandingPagesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::AdvertiserLandingPagesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['archived'] = archived unless archived.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_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 an existing landing page. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Landing page ID. # @param [Google::Apis::DfareportingV3_0::LandingPage] landing_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::LandingPage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_landing_page(profile_id, id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/advertiserLandingPages', options) command.request_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation command.request_object = landing_page_object command.response_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation command.response_class = Google::Apis::DfareportingV3_0::LandingPage command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing landing page. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::LandingPage] landing_page_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::LandingPage] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::LandingPage] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/advertiserLandingPages', options) command.request_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation command.request_object = landing_page_object command.response_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation command.response_class = Google::Apis::DfareportingV3_0::LandingPage command.params['profileId'] = profile_id unless profile_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 one advertiser by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Advertiser 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/advertisers/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation command.response_class = Google::Apis::DfareportingV3_0::Advertiser command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new advertiser. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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 insert_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/advertisers', options) command.request_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation command.request_object = advertiser_object command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation command.response_class = Google::Apis::DfareportingV3_0::Advertiser command.params['profileId'] = profile_id unless profile_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 advertisers, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_group_ids # Select only advertisers with these advertiser group IDs. # @param [Array, Fixnum] floodlight_configuration_ids # Select only advertisers with these floodlight configuration IDs. # @param [Array, Fixnum] ids # Select only advertisers with these IDs. # @param [Boolean] include_advertisers_without_groups_only # Select only advertisers which do not belong to any advertiser group. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Boolean] only_parent # Select only advertisers which use another advertiser's floodlight # configuration. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "advertiser*2015" will return objects with names like "advertiser # June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the # searches also add wildcards implicitly at the start and the end of the search # string. For example, a search string of "advertiser" will match objects with # name "my advertiser", "advertiser 2015", or simply "advertiser". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [String] status # Select only advertisers with the specified status. # @param [Fixnum] subaccount_id # Select only advertisers with these subaccount IDs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertisersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::AdvertisersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(profile_id, advertiser_group_ids: nil, floodlight_configuration_ids: nil, ids: nil, include_advertisers_without_groups_only: nil, max_results: nil, only_parent: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, status: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/advertisers', options) command.response_representation = Google::Apis::DfareportingV3_0::AdvertisersListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::AdvertisersListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserGroupIds'] = advertiser_group_ids unless advertiser_group_ids.nil? command.query['floodlightConfigurationIds'] = floodlight_configuration_ids unless floodlight_configuration_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['includeAdvertisersWithoutGroupsOnly'] = include_advertisers_without_groups_only unless include_advertisers_without_groups_only.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['onlyParent'] = only_parent unless only_parent.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['status'] = status unless status.nil? command.query['subaccountId'] = subaccount_id unless subaccount_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 an existing advertiser. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Advertiser ID. # @param [Google::Apis::DfareportingV3_0::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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(profile_id, id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/advertisers', options) command.request_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation command.request_object = advertiser_object command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation command.response_class = Google::Apis::DfareportingV3_0::Advertiser command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing advertiser. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Advertiser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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 update_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/advertisers', options) command.request_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation command.request_object = advertiser_object command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation command.response_class = Google::Apis::DfareportingV3_0::Advertiser command.params['profileId'] = profile_id unless profile_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 browsers. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::BrowsersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::BrowsersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_browsers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/browsers', options) command.response_representation = Google::Apis::DfareportingV3_0::BrowsersListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::BrowsersListResponse command.params['profileId'] = profile_id unless profile_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 # Associates a creative with the specified campaign. This method creates a # default ad with dimensions matching the creative in the campaign if such a # default ad does not exist already. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Campaign ID in this association. # @param [Google::Apis::DfareportingV3_0::CampaignCreativeAssociation] campaign_creative_association_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CampaignCreativeAssociation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CampaignCreativeAssociation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_campaign_creative_association(profile_id, campaign_id, campaign_creative_association_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options) command.request_representation = Google::Apis::DfareportingV3_0::CampaignCreativeAssociation::Representation command.request_object = campaign_creative_association_object command.response_representation = Google::Apis::DfareportingV3_0::CampaignCreativeAssociation::Representation command.response_class = Google::Apis::DfareportingV3_0::CampaignCreativeAssociation command.params['profileId'] = profile_id unless profile_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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves the list of creative IDs associated with the specified campaign. # This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Campaign ID in this association. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CampaignCreativeAssociationsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CampaignCreativeAssociationsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_campaign_creative_associations(profile_id, campaign_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options) command.response_representation = Google::Apis::DfareportingV3_0::CampaignCreativeAssociationsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::CampaignCreativeAssociationsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one campaign by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Campaign 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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_campaign(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation command.response_class = Google::Apis::DfareportingV3_0::Campaign command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new campaign. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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 insert_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns', options) command.request_representation = Google::Apis::DfareportingV3_0::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation command.response_class = Google::Apis::DfareportingV3_0::Campaign command.params['profileId'] = profile_id unless profile_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 campaigns, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_group_ids # Select only campaigns whose advertisers belong to these advertiser groups. # @param [Array, Fixnum] advertiser_ids # Select only campaigns that belong to these advertisers. # @param [Boolean] archived # Select only archived campaigns. Don't set this field to select both archived # and non-archived campaigns. # @param [Boolean] at_least_one_optimization_activity # Select only campaigns that have at least one optimization activity. # @param [Array, Fixnum] excluded_ids # Exclude campaigns with these IDs. # @param [Array, Fixnum] ids # Select only campaigns with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Fixnum] overridden_event_tag_id # Select only campaigns that have overridden this event tag ID. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For # example, "campaign*2015" will return campaigns with names like "campaign June # 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "campaign" will match campaigns with name "my # campaign", "campaign 2015", or simply "campaign". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] subaccount_id # Select only campaigns that belong to this subaccount. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CampaignsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CampaignsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_campaigns(profile_id, advertiser_group_ids: nil, advertiser_ids: nil, archived: nil, at_least_one_optimization_activity: nil, excluded_ids: nil, ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns', options) command.response_representation = Google::Apis::DfareportingV3_0::CampaignsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::CampaignsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserGroupIds'] = advertiser_group_ids unless advertiser_group_ids.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['archived'] = archived unless archived.nil? command.query['atLeastOneOptimizationActivity'] = at_least_one_optimization_activity unless at_least_one_optimization_activity.nil? command.query['excludedIds'] = excluded_ids unless excluded_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['overriddenEventTagId'] = overridden_event_tag_id unless overridden_event_tag_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_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 an existing campaign. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Campaign ID. # @param [Google::Apis::DfareportingV3_0::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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_campaign(profile_id, id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/campaigns', options) command.request_representation = Google::Apis::DfareportingV3_0::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation command.response_class = Google::Apis::DfareportingV3_0::Campaign command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing campaign. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Campaign] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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 update_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/campaigns', options) command.request_representation = Google::Apis::DfareportingV3_0::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation command.response_class = Google::Apis::DfareportingV3_0::Campaign command.params['profileId'] = profile_id unless profile_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 one change log by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Change log 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ChangeLog] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ChangeLog] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_change_log(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/changeLogs/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::ChangeLog::Representation command.response_class = Google::Apis::DfareportingV3_0::ChangeLog command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 change logs. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [String] action # Select only change logs with the specified action. # @param [Array, Fixnum] ids # Select only change logs with these IDs. # @param [String] max_change_time # Select only change logs whose change time is before the specified # maxChangeTime.The time should be formatted as an RFC3339 date/time string. For # example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, # the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, # day, the letter T, the hour (24-hour clock system), minute, second, and then # the time zone offset. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] min_change_time # Select only change logs whose change time is before the specified # minChangeTime.The time should be formatted as an RFC3339 date/time string. For # example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, # the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, # day, the letter T, the hour (24-hour clock system), minute, second, and then # the time zone offset. # @param [Array, Fixnum] object_ids # Select only change logs with these object IDs. # @param [String] object_type # Select only change logs with the specified object type. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Select only change logs whose object ID, user name, old or new values match # the search string. # @param [Array, Fixnum] user_profile_ids # Select only change logs with these user profile IDs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ChangeLogsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ChangeLogsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_change_logs(profile_id, action: nil, ids: nil, max_change_time: nil, max_results: nil, min_change_time: nil, object_ids: nil, object_type: nil, page_token: nil, search_string: nil, user_profile_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/changeLogs', options) command.response_representation = Google::Apis::DfareportingV3_0::ChangeLogsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::ChangeLogsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['action'] = action unless action.nil? command.query['ids'] = ids unless ids.nil? command.query['maxChangeTime'] = max_change_time unless max_change_time.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['minChangeTime'] = min_change_time unless min_change_time.nil? command.query['objectIds'] = object_ids unless object_ids.nil? command.query['objectType'] = object_type unless object_type.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['userProfileIds'] = user_profile_ids unless user_profile_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 a list of cities, possibly filtered. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] country_dart_ids # Select only cities from these countries. # @param [Array, Fixnum] dart_ids # Select only cities with these DART IDs. # @param [String] name_prefix # Select only cities with names starting with this prefix. # @param [Array, Fixnum] region_dart_ids # Select only cities from these regions. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CitiesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CitiesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_cities(profile_id, country_dart_ids: nil, dart_ids: nil, name_prefix: nil, region_dart_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/cities', options) command.response_representation = Google::Apis::DfareportingV3_0::CitiesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::CitiesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['countryDartIds'] = country_dart_ids unless country_dart_ids.nil? command.query['dartIds'] = dart_ids unless dart_ids.nil? command.query['namePrefix'] = name_prefix unless name_prefix.nil? command.query['regionDartIds'] = region_dart_ids unless region_dart_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 # Gets one connection type by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Connection type 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ConnectionType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ConnectionType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_connection_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::ConnectionType::Representation command.response_class = Google::Apis::DfareportingV3_0::ConnectionType command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 connection types. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ConnectionTypesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ConnectionTypesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_connection_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes', options) command.response_representation = Google::Apis::DfareportingV3_0::ConnectionTypesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::ConnectionTypesListResponse command.params['profileId'] = profile_id unless profile_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 existing content category. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Content category 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/contentCategories/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one content category by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Content category 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ContentCategory] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/contentCategories/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV3_0::ContentCategory command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new content category. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::ContentCategory] content_category_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ContentCategory] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/contentCategories', options) command.request_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation command.request_object = content_category_object command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV3_0::ContentCategory command.params['profileId'] = profile_id unless profile_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 content categories, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Select only content categories with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "contentcategory*2015" will return objects with names like " # contentcategory June 2015", "contentcategory April 2015", or simply " # contentcategory 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # contentcategory" will match objects with name "my contentcategory", " # contentcategory 2015", or simply "contentcategory". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ContentCategoriesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ContentCategoriesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_categories(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/contentCategories', options) command.response_representation = Google::Apis::DfareportingV3_0::ContentCategoriesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::ContentCategoriesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 content category. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Content category ID. # @param [Google::Apis::DfareportingV3_0::ContentCategory] content_category_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ContentCategory] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_category(profile_id, id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/contentCategories', options) command.request_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation command.request_object = content_category_object command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV3_0::ContentCategory command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing content category. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::ContentCategory] content_category_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ContentCategory] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ContentCategory] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/contentCategories', options) command.request_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation command.request_object = content_category_object command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation command.response_class = Google::Apis::DfareportingV3_0::ContentCategory command.params['profileId'] = profile_id unless profile_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 # Inserts conversions. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::ConversionsBatchInsertRequest] conversions_batch_insert_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ConversionsBatchInsertResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ConversionsBatchInsertResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def batchinsert_conversion(profile_id, conversions_batch_insert_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/conversions/batchinsert', options) command.request_representation = Google::Apis::DfareportingV3_0::ConversionsBatchInsertRequest::Representation command.request_object = conversions_batch_insert_request_object command.response_representation = Google::Apis::DfareportingV3_0::ConversionsBatchInsertResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::ConversionsBatchInsertResponse command.params['profileId'] = profile_id unless profile_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 existing conversions. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::ConversionsBatchUpdateRequest] conversions_batch_update_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ConversionsBatchUpdateResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ConversionsBatchUpdateResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def batchupdate_conversion(profile_id, conversions_batch_update_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/conversions/batchupdate', options) command.request_representation = Google::Apis::DfareportingV3_0::ConversionsBatchUpdateRequest::Representation command.request_object = conversions_batch_update_request_object command.response_representation = Google::Apis::DfareportingV3_0::ConversionsBatchUpdateResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::ConversionsBatchUpdateResponse command.params['profileId'] = profile_id unless profile_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 one country by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] dart_id # Country DART 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Country] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Country] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_country(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/countries/{dartId}', options) command.response_representation = Google::Apis::DfareportingV3_0::Country::Representation command.response_class = Google::Apis::DfareportingV3_0::Country command.params['profileId'] = profile_id unless profile_id.nil? command.params['dartId'] = dart_id unless dart_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 countries. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CountriesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CountriesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_countries(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/countries', options) command.response_representation = Google::Apis::DfareportingV3_0::CountriesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::CountriesListResponse command.params['profileId'] = profile_id unless profile_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 # Inserts a new creative asset. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Advertiser ID of this creative. This is a required field. # @param [Google::Apis::DfareportingV3_0::CreativeAssetMetadata] creative_asset_metadata_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::DfareportingV3_0::CreativeAssetMetadata] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeAssetMetadata] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_asset(profile_id, advertiser_id, creative_asset_metadata_object = 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, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options) else command = make_upload_command(:post, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::DfareportingV3_0::CreativeAssetMetadata::Representation command.request_object = creative_asset_metadata_object command.response_representation = Google::Apis::DfareportingV3_0::CreativeAssetMetadata::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeAssetMetadata command.params['profileId'] = profile_id unless profile_id.nil? 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes an existing creative field value. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Fixnum] id # Creative Field Value 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.params['id'] = id unless 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 one creative field value by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Fixnum] id # Creative Field Value 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeFieldValue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.params['id'] = id unless 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 # Inserts a new creative field value. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Google::Apis::DfareportingV3_0::CreativeFieldValue] creative_field_value_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeFieldValue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) command.request_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation command.request_object = creative_field_value_object command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_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 creative field values, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Array, Fixnum] ids # Select only creative field values with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for creative field values by their values. Wildcards (e.g. *) # are not allowed. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldValuesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeFieldValuesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field_values(profile_id, creative_field_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValuesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValuesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 creative field value. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Fixnum] id # Creative Field Value ID # @param [Google::Apis::DfareportingV3_0::CreativeFieldValue] creative_field_value_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeFieldValue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field_value(profile_id, creative_field_id, id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) command.request_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation command.request_object = creative_field_value_object command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? command.query['id'] = id unless 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 an existing creative field value. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] creative_field_id # Creative field ID for this creative field value. # @param [Google::Apis::DfareportingV3_0::CreativeFieldValue] creative_field_value_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldValue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeFieldValue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) command.request_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation command.request_object = creative_field_value_object command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue command.params['profileId'] = profile_id unless profile_id.nil? command.params['creativeFieldId'] = creative_field_id unless creative_field_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 existing creative field. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative Field 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/creativeFields/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one creative field by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative Field 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeField] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeField command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new creative field. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::CreativeField] creative_field_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeField] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/creativeFields', options) command.request_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation command.request_object = creative_field_object command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeField command.params['profileId'] = profile_id unless profile_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 creative fields, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only creative fields that belong to these advertisers. # @param [Array, Fixnum] ids # Select only creative fields with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for creative fields by name or ID. Wildcards (*) are allowed. # For example, "creativefield*2015" will return creative fields with names like " # creativefield June 2015", "creativefield April 2015", or simply "creativefield # 2015". Most of the searches also add wild-cards implicitly at the start and # the end of the search string. For example, a search string of "creativefield" # will match creative fields with the name "my creativefield", "creativefield # 2015", or simply "creativefield". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeFieldsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_fields(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields', options) command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 creative field. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative Field ID # @param [Google::Apis::DfareportingV3_0::CreativeField] creative_field_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeField] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field(profile_id, id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields', options) command.request_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation command.request_object = creative_field_object command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeField command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing creative field. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::CreativeField] creative_field_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeField] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeField] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/creativeFields', options) command.request_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation command.request_object = creative_field_object command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeField command.params['profileId'] = profile_id unless profile_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 one creative group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new creative group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::CreativeGroup] creative_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/creativeGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation command.request_object = creative_group_object command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup command.params['profileId'] = profile_id unless profile_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 creative groups, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only creative groups that belong to these advertisers. # @param [Fixnum] group_number # Select only creative groups that belong to this subgroup. # @param [Array, Fixnum] ids # Select only creative groups with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for creative groups by name or ID. Wildcards (*) are allowed. # For example, "creativegroup*2015" will return creative groups with names like " # creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup # 2015". Most of the searches also add wild-cards implicitly at the start and # the end of the search string. For example, a search string of "creativegroup" # will match creative groups with the name "my creativegroup", "creativegroup # 2015", or simply "creativegroup". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_groups(profile_id, advertiser_ids: nil, group_number: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups', options) command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeGroupsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['groupNumber'] = group_number unless group_number.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 creative group. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative group ID. # @param [Google::Apis::DfareportingV3_0::CreativeGroup] creative_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_group(profile_id, id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation command.request_object = creative_group_object command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing creative group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::CreativeGroup] creative_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativeGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/creativeGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation command.request_object = creative_group_object command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup command.params['profileId'] = profile_id unless profile_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 one creative by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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_creative(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creatives/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation command.response_class = Google::Apis::DfareportingV3_0::Creative command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new creative. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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 insert_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/creatives', options) command.request_representation = Google::Apis::DfareportingV3_0::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation command.response_class = Google::Apis::DfareportingV3_0::Creative command.params['profileId'] = profile_id unless profile_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 creatives, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] active # Select only active creatives. Leave blank to select active and inactive # creatives. # @param [Fixnum] advertiser_id # Select only creatives with this advertiser ID. # @param [Boolean] archived # Select only archived creatives. Leave blank to select archived and unarchived # creatives. # @param [Fixnum] campaign_id # Select only creatives with this campaign ID. # @param [Array, Fixnum] companion_creative_ids # Select only in-stream video creatives with these companion IDs. # @param [Array, Fixnum] creative_field_ids # Select only creatives with these creative field IDs. # @param [Array, Fixnum] ids # Select only creatives with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Array, Fixnum] rendering_ids # Select only creatives with these rendering IDs. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "creative*2015" will return objects with names like "creative June # 2015", "creative April 2015", or simply "creative 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "creative" will match objects with name "my # creative", "creative 2015", or simply "creative". # @param [Array, Fixnum] size_ids # Select only creatives with these size IDs. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] studio_creative_id # Select only creatives corresponding to this Studio creative ID. # @param [Array, String] types # Select only creatives with these creative types. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CreativesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CreativesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_creatives(profile_id, active: nil, advertiser_id: nil, archived: nil, campaign_id: nil, companion_creative_ids: nil, creative_field_ids: nil, ids: nil, max_results: nil, page_token: nil, rendering_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, studio_creative_id: nil, types: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/creatives', options) command.response_representation = Google::Apis::DfareportingV3_0::CreativesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::CreativesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['archived'] = archived unless archived.nil? command.query['campaignId'] = campaign_id unless campaign_id.nil? command.query['companionCreativeIds'] = companion_creative_ids unless companion_creative_ids.nil? command.query['creativeFieldIds'] = creative_field_ids unless creative_field_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['renderingIds'] = rendering_ids unless rendering_ids.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sizeIds'] = size_ids unless size_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['studioCreativeId'] = studio_creative_id unless studio_creative_id.nil? command.query['types'] = types unless 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 # Updates an existing creative. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Creative ID. # @param [Google::Apis::DfareportingV3_0::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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_creative(profile_id, id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/creatives', options) command.request_representation = Google::Apis::DfareportingV3_0::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation command.response_class = Google::Apis::DfareportingV3_0::Creative command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing creative. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::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 update_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/creatives', options) command.request_representation = Google::Apis::DfareportingV3_0::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation command.response_class = Google::Apis::DfareportingV3_0::Creative command.params['profileId'] = profile_id unless profile_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 list of report dimension values for a list of filters. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Google::Apis::DfareportingV3_0::DimensionValueRequest] dimension_value_request_object # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::DimensionValueList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::DimensionValueList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_dimension_value(profile_id, dimension_value_request_object = nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/dimensionvalues/query', options) command.request_representation = Google::Apis::DfareportingV3_0::DimensionValueRequest::Representation command.request_object = dimension_value_request_object command.response_representation = Google::Apis::DfareportingV3_0::DimensionValueList::Representation command.response_class = Google::Apis::DfareportingV3_0::DimensionValueList command.params['profileId'] = profile_id unless profile_id.nil? command.query['maxResults'] = max_results unless max_results.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 # Gets one directory site contact by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Directory site contact 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::DirectorySiteContact] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::DirectorySiteContact] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_directory_site_contact(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/directorySiteContacts/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::DirectorySiteContact::Representation command.response_class = Google::Apis::DfareportingV3_0::DirectorySiteContact command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 directory site contacts, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] directory_site_ids # Select only directory site contacts with these directory site IDs. This is a # required field. # @param [Array, Fixnum] ids # Select only directory site contacts with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name, ID or email. Wildcards (*) are allowed. # For example, "directory site contact*2015" will return objects with names like # "directory site contact June 2015", "directory site contact April 2015", or # simply "directory site contact 2015". Most of the searches also add wildcards # implicitly at the start and the end of the search string. For example, a # search string of "directory site contact" will match objects with name "my # directory site contact", "directory site contact 2015", or simply "directory # site contact". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_directory_site_contacts(profile_id, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/directorySiteContacts', options) command.response_representation = Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one directory site by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Directory site 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::DirectorySite] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::DirectorySite] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_directory_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/directorySites/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::DirectorySite::Representation command.response_class = Google::Apis::DfareportingV3_0::DirectorySite command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new directory site. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::DirectorySite] directory_site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::DirectorySite] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::DirectorySite] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_directory_site(profile_id, directory_site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/directorySites', options) command.request_representation = Google::Apis::DfareportingV3_0::DirectorySite::Representation command.request_object = directory_site_object command.response_representation = Google::Apis::DfareportingV3_0::DirectorySite::Representation command.response_class = Google::Apis::DfareportingV3_0::DirectorySite command.params['profileId'] = profile_id unless profile_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 directory sites, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] accepts_in_stream_video_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_interstitial_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_publisher_paid_placements # Select only directory sites that accept publisher paid placements. This field # can be left blank. # @param [Boolean] active # Select only active directory sites. Leave blank to retrieve both active and # inactive directory sites. # @param [Fixnum] country_id # Select only directory sites with this country ID. # @param [String] dfp_network_code # Select only directory sites with this DFP network code. # @param [Array, Fixnum] ids # Select only directory sites with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Fixnum] parent_id # Select only directory sites with this parent ID. # @param [String] search_string # Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. # For example, "directory site*2015" will return objects with names like " # directory site June 2015", "directory site April 2015", or simply "directory # site 2015". Most of the searches also add wildcards implicitly at the start # and the end of the search string. For example, a search string of "directory # site" will match objects with name "my directory site", "directory site 2015" # or simply, "directory site". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::DirectorySitesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::DirectorySitesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_directory_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, active: nil, country_id: nil, dfp_network_code: nil, ids: nil, max_results: nil, page_token: nil, parent_id: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/directorySites', options) command.response_representation = Google::Apis::DfareportingV3_0::DirectorySitesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::DirectorySitesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['acceptsInStreamVideoPlacements'] = accepts_in_stream_video_placements unless accepts_in_stream_video_placements.nil? command.query['acceptsInterstitialPlacements'] = accepts_interstitial_placements unless accepts_interstitial_placements.nil? command.query['acceptsPublisherPaidPlacements'] = accepts_publisher_paid_placements unless accepts_publisher_paid_placements.nil? command.query['active'] = active unless active.nil? command.query['countryId'] = country_id unless country_id.nil? command.query['dfpNetworkCode'] = dfp_network_code unless dfp_network_code.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parentId'] = parent_id unless parent_id.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 existing dynamic targeting key. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] object_id_ # ID of the object of this dynamic targeting key. This is a required field. # @param [String] name # Name of this dynamic targeting key. This is a required field. Must be less # than 256 characters long and cannot contain commas. All characters are # converted to lowercase. # @param [String] object_type # Type of the object of this dynamic targeting key. This is a required 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_dynamic_targeting_key(profile_id, object_id_, name, object_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/dynamicTargetingKeys/{objectId}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['objectId'] = object_id_ unless object_id_.nil? command.query['name'] = name unless name.nil? command.query['objectType'] = object_type unless object_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 # Inserts a new dynamic targeting key. Keys must be created at the advertiser # level before being assigned to the advertiser's ads, creatives, or placements. # There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 # keys can be assigned per ad, creative, or placement. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::DynamicTargetingKey] dynamic_targeting_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::DynamicTargetingKey] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::DynamicTargetingKey] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dynamic_targeting_key(profile_id, dynamic_targeting_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/dynamicTargetingKeys', options) command.request_representation = Google::Apis::DfareportingV3_0::DynamicTargetingKey::Representation command.request_object = dynamic_targeting_key_object command.response_representation = Google::Apis::DfareportingV3_0::DynamicTargetingKey::Representation command.response_class = Google::Apis::DfareportingV3_0::DynamicTargetingKey command.params['profileId'] = profile_id unless profile_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 dynamic targeting keys. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only dynamic targeting keys whose object has this advertiser ID. # @param [Array, String] names # Select only dynamic targeting keys exactly matching these names. # @param [Fixnum] object_id_ # Select only dynamic targeting keys with this object ID. # @param [String] object_type # Select only dynamic targeting keys with this object 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::DynamicTargetingKeysListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::DynamicTargetingKeysListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_dynamic_targeting_keys(profile_id, advertiser_id: nil, names: nil, object_id_: nil, object_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/dynamicTargetingKeys', options) command.response_representation = Google::Apis::DfareportingV3_0::DynamicTargetingKeysListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::DynamicTargetingKeysListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['names'] = names unless names.nil? command.query['objectId'] = object_id_ unless object_id_.nil? command.query['objectType'] = object_type unless object_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 an existing event tag. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Event tag 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/eventTags/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one event tag by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Event tag 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::EventTag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/eventTags/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation command.response_class = Google::Apis::DfareportingV3_0::EventTag command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new event tag. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::EventTag] event_tag_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::EventTag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/eventTags', options) command.request_representation = Google::Apis::DfareportingV3_0::EventTag::Representation command.request_object = event_tag_object command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation command.response_class = Google::Apis::DfareportingV3_0::EventTag command.params['profileId'] = profile_id unless profile_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 event tags, possibly filtered. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] ad_id # Select only event tags that belong to this ad. # @param [Fixnum] advertiser_id # Select only event tags that belong to this advertiser. # @param [Fixnum] campaign_id # Select only event tags that belong to this campaign. # @param [Boolean] definitions_only # Examine only the specified campaign or advertiser's event tags for matching # selector criteria. When set to false, the parent advertiser and parent # campaign of the specified ad or campaign is examined as well. In addition, # when set to false, the status field is examined as well, along with the # enabledByDefault field. This parameter can not be set to true when adId is # specified as ads do not define their own even tags. # @param [Boolean] enabled # Select only enabled event tags. What is considered enabled or disabled depends # on the definitionsOnly parameter. When definitionsOnly is set to true, only # the specified advertiser or campaign's event tags' enabledByDefault field is # examined. When definitionsOnly is set to false, the specified ad or specified # campaign's parent advertiser's or parent campaign's event tags' # enabledByDefault and status fields are examined as well. # @param [Array, String] event_tag_types # Select only event tags with the specified event tag types. Event tag types can # be used to specify whether to use a third-party pixel, a third-party # JavaScript URL, or a third-party click-through URL for either impression or # click tracking. # @param [Array, Fixnum] ids # Select only event tags with these IDs. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "eventtag*2015" will return objects with names like "eventtag June # 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "eventtag" will match objects with name "my # eventtag", "eventtag 2015", or simply "eventtag". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::EventTagsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::EventTagsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_tags(profile_id, ad_id: nil, advertiser_id: nil, campaign_id: nil, definitions_only: nil, enabled: nil, event_tag_types: nil, ids: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/eventTags', options) command.response_representation = Google::Apis::DfareportingV3_0::EventTagsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::EventTagsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['adId'] = ad_id unless ad_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['campaignId'] = campaign_id unless campaign_id.nil? command.query['definitionsOnly'] = definitions_only unless definitions_only.nil? command.query['enabled'] = enabled unless enabled.nil? command.query['eventTagTypes'] = event_tag_types unless event_tag_types.nil? command.query['ids'] = ids unless ids.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 event tag. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Event tag ID. # @param [Google::Apis::DfareportingV3_0::EventTag] event_tag_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::EventTag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_tag(profile_id, id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/eventTags', options) command.request_representation = Google::Apis::DfareportingV3_0::EventTag::Representation command.request_object = event_tag_object command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation command.response_class = Google::Apis::DfareportingV3_0::EventTag command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing event tag. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::EventTag] event_tag_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::EventTag] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::EventTag] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/eventTags', options) command.request_representation = Google::Apis::DfareportingV3_0::EventTag::Representation command.request_object = event_tag_object command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation command.response_class = Google::Apis::DfareportingV3_0::EventTag command.params['profileId'] = profile_id unless profile_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 report file by its report ID and file ID. This method supports # media download. # @param [Fixnum] report_id # The ID of the report. # @param [Fixnum] file_id # The ID of the report 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::File] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::File] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_file(report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'reports/{reportId}/files/{fileId}', options) else command = make_download_command(:get, 'reports/{reportId}/files/{fileId}', options) command.download_dest = download_dest end command.response_representation = Google::Apis::DfareportingV3_0::File::Representation command.response_class = Google::Apis::DfareportingV3_0::File command.params['reportId'] = report_id unless report_id.nil? command.params['fileId'] = file_id unless file_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 files for a user profile. # @param [Fixnum] profile_id # The DFA profile ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @param [String] scope # The scope that defines which results are returned. # @param [String] sort_field # The field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FileList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FileList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_files(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/files', options) command.response_representation = Google::Apis::DfareportingV3_0::FileList::Representation command.response_class = Google::Apis::DfareportingV3_0::FileList command.params['profileId'] = profile_id unless profile_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['scope'] = scope unless scope.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 existing floodlight activity. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight activity 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/floodlightActivities/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Generates a tag for a floodlight activity. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] floodlight_activity_id # Floodlight activity ID for which we want to generate a tag. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivitiesGenerateTagResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivitiesGenerateTagResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def generatetag_floodlight_activity(profile_id, floodlight_activity_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities/generatetag', options) command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivitiesGenerateTagResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivitiesGenerateTagResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_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 one floodlight activity by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight activity 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new floodlight activity. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::FloodlightActivity] floodlight_activity_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities', options) command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation command.request_object = floodlight_activity_object command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity command.params['profileId'] = profile_id unless profile_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 floodlight activities, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only floodlight activities for the specified advertiser ID. Must # specify either ids, advertiserId, or floodlightConfigurationId for a non-empty # result. # @param [Array, Fixnum] floodlight_activity_group_ids # Select only floodlight activities with the specified floodlight activity group # IDs. # @param [String] floodlight_activity_group_name # Select only floodlight activities with the specified floodlight activity group # name. # @param [String] floodlight_activity_group_tag_string # Select only floodlight activities with the specified floodlight activity group # tag string. # @param [String] floodlight_activity_group_type # Select only floodlight activities with the specified floodlight activity group # type. # @param [Fixnum] floodlight_configuration_id # Select only floodlight activities for the specified floodlight configuration # ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a # non-empty result. # @param [Array, Fixnum] ids # Select only floodlight activities with the specified IDs. Must specify either # ids, advertiserId, or floodlightConfigurationId for a non-empty result. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "floodlightactivity*2015" will return objects with names like " # floodlightactivity June 2015", "floodlightactivity April 2015", or simply " # floodlightactivity 2015". Most of the searches also add wildcards implicitly # at the start and the end of the search string. For example, a search string of # "floodlightactivity" will match objects with name "my floodlightactivity # activity", "floodlightactivity 2015", or simply "floodlightactivity". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [String] tag_string # Select only floodlight activities with the specified tag string. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivitiesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivitiesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activities(profile_id, advertiser_id: nil, floodlight_activity_group_ids: nil, floodlight_activity_group_name: nil, floodlight_activity_group_tag_string: nil, floodlight_activity_group_type: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, tag_string: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities', options) command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivitiesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivitiesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['floodlightActivityGroupIds'] = floodlight_activity_group_ids unless floodlight_activity_group_ids.nil? command.query['floodlightActivityGroupName'] = floodlight_activity_group_name unless floodlight_activity_group_name.nil? command.query['floodlightActivityGroupTagString'] = floodlight_activity_group_tag_string unless floodlight_activity_group_tag_string.nil? command.query['floodlightActivityGroupType'] = floodlight_activity_group_type unless floodlight_activity_group_type.nil? command.query['floodlightConfigurationId'] = floodlight_configuration_id unless floodlight_configuration_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['tagString'] = tag_string unless tag_string.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 floodlight activity. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight activity ID. # @param [Google::Apis::DfareportingV3_0::FloodlightActivity] floodlight_activity_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity(profile_id, id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivities', options) command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation command.request_object = floodlight_activity_object command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing floodlight activity. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::FloodlightActivity] floodlight_activity_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivity] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivity] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivities', options) command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation command.request_object = floodlight_activity_object command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity command.params['profileId'] = profile_id unless profile_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 one floodlight activity group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight activity Group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new floodlight activity group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] floodlight_activity_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivityGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation command.request_object = floodlight_activity_group_object command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_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 floodlight activity groups, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only floodlight activity groups with the specified advertiser ID. Must # specify either advertiserId or floodlightConfigurationId for a non-empty # result. # @param [Fixnum] floodlight_configuration_id # Select only floodlight activity groups with the specified floodlight # configuration ID. Must specify either advertiserId, or # floodlightConfigurationId for a non-empty result. # @param [Array, Fixnum] ids # Select only floodlight activity groups with the specified IDs. Must specify # either advertiserId or floodlightConfigurationId for a non-empty result. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "floodlightactivitygroup*2015" will return objects with names like " # floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or # simply "floodlightactivitygroup 2015". Most of the searches also add wildcards # implicitly at the start and the end of the search string. For example, a # search string of "floodlightactivitygroup" will match objects with name "my # floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply " # floodlightactivitygroup". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [String] type # Select only floodlight activity groups with the specified floodlight activity # group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivityGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivityGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activity_groups(profile_id, advertiser_id: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups', options) command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroupsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['floodlightConfigurationId'] = floodlight_configuration_id unless floodlight_configuration_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['type'] = type unless 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 an existing floodlight activity group. This method supports patch # semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight activity Group ID. # @param [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] floodlight_activity_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_activity_group(profile_id, id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivityGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation command.request_object = floodlight_activity_group_object command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing floodlight activity group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] floodlight_activity_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivityGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation command.request_object = floodlight_activity_group_object command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup command.params['profileId'] = profile_id unless profile_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 one floodlight configuration by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight configuration 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_configuration(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfiguration command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 floodlight configurations, possibly filtered. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Set of IDs of floodlight configurations to retrieve. Required field; otherwise # an empty list 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightConfigurationsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightConfigurationsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_configurations(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations', options) command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfigurationsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfigurationsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless 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 # Updates an existing floodlight configuration. This method supports patch # semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Floodlight configuration ID. # @param [Google::Apis::DfareportingV3_0::FloodlightConfiguration] floodlight_configuration_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_configuration(profile_id, id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightConfigurations', options) command.request_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation command.request_object = floodlight_configuration_object command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfiguration command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing floodlight configuration. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::FloodlightConfiguration] floodlight_configuration_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightConfiguration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FloodlightConfiguration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_floodlight_configuration(profile_id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightConfigurations', options) command.request_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation command.request_object = floodlight_configuration_object command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfiguration command.params['profileId'] = profile_id unless profile_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 one inventory item by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for order documents. # @param [Fixnum] id # Inventory item 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::InventoryItem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::InventoryItem] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_item(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::InventoryItem::Representation command.response_class = Google::Apis::DfareportingV3_0::InventoryItem command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless 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 inventory items, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for order documents. # @param [Array, Fixnum] ids # Select only inventory items with these IDs. # @param [Boolean] in_plan # Select only inventory items that are in plan. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Array, Fixnum] order_id # Select only inventory items that belong to specified orders. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [Array, Fixnum] site_id # Select only inventory items that are associated with these sites. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [String] type # Select only inventory items with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::InventoryItemsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::InventoryItemsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_items(profile_id, project_id, ids: nil, in_plan: nil, max_results: nil, order_id: nil, page_token: nil, site_id: nil, sort_field: nil, sort_order: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems', options) command.response_representation = Google::Apis::DfareportingV3_0::InventoryItemsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::InventoryItemsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.query['ids'] = ids unless ids.nil? command.query['inPlan'] = in_plan unless in_plan.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderId'] = order_id unless order_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['siteId'] = site_id unless site_id.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['type'] = type unless 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 # Retrieves a list of languages. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::LanguagesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::LanguagesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_languages(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/languages', options) command.response_representation = Google::Apis::DfareportingV3_0::LanguagesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::LanguagesListResponse command.params['profileId'] = profile_id unless profile_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 metros. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::MetrosListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::MetrosListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_metros(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/metros', options) command.response_representation = Google::Apis::DfareportingV3_0::MetrosListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::MetrosListResponse command.params['profileId'] = profile_id unless profile_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 one mobile carrier by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Mobile carrier 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::MobileCarrier] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::MobileCarrier] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_mobile_carrier(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::MobileCarrier::Representation command.response_class = Google::Apis::DfareportingV3_0::MobileCarrier command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 mobile carriers. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::MobileCarriersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::MobileCarriersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_mobile_carriers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers', options) command.response_representation = Google::Apis::DfareportingV3_0::MobileCarriersListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::MobileCarriersListResponse command.params['profileId'] = profile_id unless profile_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 one operating system version by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Operating system version 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::OperatingSystemVersion] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::OperatingSystemVersion] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operating_system_version(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystemVersion::Representation command.response_class = Google::Apis::DfareportingV3_0::OperatingSystemVersion command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 operating system versions. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::OperatingSystemVersionsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::OperatingSystemVersionsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operating_system_versions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions', options) command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystemVersionsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::OperatingSystemVersionsListResponse command.params['profileId'] = profile_id unless profile_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 one operating system by DART ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] dart_id # Operating system DART 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::OperatingSystem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::OperatingSystem] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operating_system(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems/{dartId}', options) command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystem::Representation command.response_class = Google::Apis::DfareportingV3_0::OperatingSystem command.params['profileId'] = profile_id unless profile_id.nil? command.params['dartId'] = dart_id unless dart_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 operating systems. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::OperatingSystemsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::OperatingSystemsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_operating_systems(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems', options) command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystemsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::OperatingSystemsListResponse command.params['profileId'] = profile_id unless profile_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 one order document by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for order documents. # @param [Fixnum] id # Order document 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::OrderDocument] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::OrderDocument] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order_document(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::OrderDocument::Representation command.response_class = Google::Apis::DfareportingV3_0::OrderDocument command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless 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 order documents, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for order documents. # @param [Boolean] approved # Select only order documents that have been approved by at least one user. # @param [Array, Fixnum] ids # Select only order documents with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [Array, Fixnum] order_id # Select only order documents for specified orders. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for order documents by name or ID. Wildcards (*) are allowed. # For example, "orderdocument*2015" will return order documents with names like " # orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument # 2015". Most of the searches also add wildcards implicitly at the start and the # end of the search string. For example, a search string of "orderdocument" will # match order documents with name "my orderdocument", "orderdocument 2015", or # simply "orderdocument". # @param [Array, Fixnum] site_id # Select only order documents that are associated with these sites. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::OrderDocumentsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::OrderDocumentsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order_documents(profile_id, project_id, approved: nil, ids: nil, max_results: nil, order_id: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments', options) command.response_representation = Google::Apis::DfareportingV3_0::OrderDocumentsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::OrderDocumentsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.query['approved'] = approved unless approved.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderId'] = order_id unless order_id.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteId'] = site_id unless site_id.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one order by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for orders. # @param [Fixnum] id # Order 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Order] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Order] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Order::Representation command.response_class = Google::Apis::DfareportingV3_0::Order command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless 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 orders, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] project_id # Project ID for orders. # @param [Array, Fixnum] ids # Select only orders with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for orders by name or ID. Wildcards (*) are allowed. For # example, "order*2015" will return orders with names like "order June 2015", " # order April 2015", or simply "order 2015". Most of the searches also add # wildcards implicitly at the start and the end of the search string. For # example, a search string of "order" will match orders with name "my order", " # order 2015", or simply "order". # @param [Array, Fixnum] site_id # Select only orders that are associated with these site IDs. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::OrdersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::OrdersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_orders(profile_id, project_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders', options) command.response_representation = Google::Apis::DfareportingV3_0::OrdersListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::OrdersListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.params['projectId'] = project_id unless project_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteId'] = site_id unless site_id.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one placement group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placementGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new placement group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::PlacementGroup] placement_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/placementGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation command.request_object = placement_group_object command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup command.params['profileId'] = profile_id unless profile_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 placement groups, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only placement groups that belong to these advertisers. # @param [Boolean] archived # Select only archived placements. Don't set this field to select both archived # and non-archived placements. # @param [Array, Fixnum] campaign_ids # Select only placement groups that belong to these campaigns. # @param [Array, Fixnum] content_category_ids # Select only placement groups that are associated with these content categories. # @param [Array, Fixnum] directory_site_ids # Select only placement groups that are associated with these directory sites. # @param [Array, Fixnum] ids # Select only placement groups with these IDs. # @param [String] max_end_date # Select only placements or placement groups whose end date is on or before the # specified maxEndDate. The date should be formatted as "yyyy-MM-dd". # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] max_start_date # Select only placements or placement groups whose start date is on or before # the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". # @param [String] min_end_date # Select only placements or placement groups whose end date is on or after the # specified minEndDate. The date should be formatted as "yyyy-MM-dd". # @param [String] min_start_date # Select only placements or placement groups whose start date is on or after the # specified minStartDate. The date should be formatted as "yyyy-MM-dd". # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] placement_group_type # Select only placement groups belonging with this group type. A package is a # simple group of placements that acts as a single pricing point for a group of # tags. A roadblock is a group of placements that not only acts as a single # pricing point but also assumes that all the tags in it will be served at the # same time. A roadblock requires one of its assigned placements to be marked as # primary for reporting. # @param [Array, Fixnum] placement_strategy_ids # Select only placement groups that are associated with these placement # strategies. # @param [Array, String] pricing_types # Select only placement groups with these pricing types. # @param [String] search_string # Allows searching for placement groups by name or ID. Wildcards (*) are allowed. # For example, "placement*2015" will return placement groups with names like " # placement group June 2015", "placement group May 2015", or simply "placements # 2015". Most of the searches also add wildcards implicitly at the start and the # end of the search string. For example, a search string of "placementgroup" # will match placement groups with name "my placementgroup", "placementgroup # 2015", or simply "placementgroup". # @param [Array, Fixnum] site_ids # Select only placement groups that are associated with these sites. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_groups(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, content_category_ids: nil, directory_site_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, placement_group_type: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placementGroups', options) command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementGroupsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['archived'] = archived unless archived.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxEndDate'] = max_end_date unless max_end_date.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['maxStartDate'] = max_start_date unless max_start_date.nil? command.query['minEndDate'] = min_end_date unless min_end_date.nil? command.query['minStartDate'] = min_start_date unless min_start_date.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['placementGroupType'] = placement_group_type unless placement_group_type.nil? command.query['placementStrategyIds'] = placement_strategy_ids unless placement_strategy_ids.nil? command.query['pricingTypes'] = pricing_types unless pricing_types.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteIds'] = site_ids unless site_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 placement group. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement group ID. # @param [Google::Apis::DfareportingV3_0::PlacementGroup] placement_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_group(profile_id, id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/placementGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation command.request_object = placement_group_object command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing placement group. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::PlacementGroup] placement_group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/placementGroups', options) command.request_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation command.request_object = placement_group_object command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup command.params['profileId'] = profile_id unless profile_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 existing placement strategy. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement strategy 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/placementStrategies/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one placement strategy by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement strategy 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementStrategy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new placement strategy. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::PlacementStrategy] placement_strategy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementStrategy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/placementStrategies', options) command.request_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation command.request_object = placement_strategy_object command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy command.params['profileId'] = profile_id unless profile_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 placement strategies, possibly filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Select only placement strategies with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "placementstrategy*2015" will return objects with names like " # placementstrategy June 2015", "placementstrategy April 2015", or simply " # placementstrategy 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # placementstrategy" will match objects with name "my placementstrategy", " # placementstrategy 2015", or simply "placementstrategy". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementStrategiesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementStrategiesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_strategies(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies', options) command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategiesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategiesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 placement strategy. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement strategy ID. # @param [Google::Apis::DfareportingV3_0::PlacementStrategy] placement_strategy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementStrategy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_strategy(profile_id, id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/placementStrategies', options) command.request_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation command.request_object = placement_strategy_object command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing placement strategy. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::PlacementStrategy] placement_strategy_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementStrategy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementStrategy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/placementStrategies', options) command.request_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation command.request_object = placement_strategy_object command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy command.params['profileId'] = profile_id unless profile_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 # Generates tags for a placement. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] campaign_id # Generate placements belonging to this campaign. This is a required field. # @param [Array, Fixnum] placement_ids # Generate tags for these placements. # @param [Array, String] tag_formats # Tag formats to generate for these placements. # Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementsGenerateTagsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementsGenerateTagsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def generatetags_placement(profile_id, campaign_id: nil, placement_ids: nil, tag_formats: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/placements/generatetags', options) command.response_representation = Google::Apis::DfareportingV3_0::PlacementsGenerateTagsResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementsGenerateTagsResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['campaignId'] = campaign_id unless campaign_id.nil? command.query['placementIds'] = placement_ids unless placement_ids.nil? command.query['tagFormats'] = tag_formats unless tag_formats.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 one placement by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Placement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placements/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation command.response_class = Google::Apis::DfareportingV3_0::Placement command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new placement. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::Placement] placement_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Placement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/placements', options) command.request_representation = Google::Apis::DfareportingV3_0::Placement::Representation command.request_object = placement_object command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation command.response_class = Google::Apis::DfareportingV3_0::Placement command.params['profileId'] = profile_id unless profile_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 placements, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only placements that belong to these advertisers. # @param [Boolean] archived # Select only archived placements. Don't set this field to select both archived # and non-archived placements. # @param [Array, Fixnum] campaign_ids # Select only placements that belong to these campaigns. # @param [Array, String] compatibilities # Select only placements that are associated with these compatibilities. DISPLAY # and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile # devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL # are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in- # stream video ads developed with the VAST standard. # @param [Array, Fixnum] content_category_ids # Select only placements that are associated with these content categories. # @param [Array, Fixnum] directory_site_ids # Select only placements that are associated with these directory sites. # @param [Array, Fixnum] group_ids # Select only placements that belong to these placement groups. # @param [Array, Fixnum] ids # Select only placements with these IDs. # @param [String] max_end_date # Select only placements or placement groups whose end date is on or before the # specified maxEndDate. The date should be formatted as "yyyy-MM-dd". # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] max_start_date # Select only placements or placement groups whose start date is on or before # the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". # @param [String] min_end_date # Select only placements or placement groups whose end date is on or after the # specified minEndDate. The date should be formatted as "yyyy-MM-dd". # @param [String] min_start_date # Select only placements or placement groups whose start date is on or after the # specified minStartDate. The date should be formatted as "yyyy-MM-dd". # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] payment_source # Select only placements with this payment source. # @param [Array, Fixnum] placement_strategy_ids # Select only placements that are associated with these placement strategies. # @param [Array, String] pricing_types # Select only placements with these pricing types. # @param [String] search_string # Allows searching for placements by name or ID. Wildcards (*) are allowed. For # example, "placement*2015" will return placements with names like "placement # June 2015", "placement May 2015", or simply "placements 2015". Most of the # searches also add wildcards implicitly at the start and the end of the search # string. For example, a search string of "placement" will match placements with # name "my placement", "placement 2015", or simply "placement". # @param [Array, Fixnum] site_ids # Select only placements that are associated with these sites. # @param [Array, Fixnum] size_ids # Select only placements that are associated with these sizes. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlacementsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placements(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, compatibilities: nil, content_category_ids: nil, directory_site_ids: nil, group_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, payment_source: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, size_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/placements', options) command.response_representation = Google::Apis::DfareportingV3_0::PlacementsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::PlacementsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['archived'] = archived unless archived.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['compatibilities'] = compatibilities unless compatibilities.nil? command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['groupIds'] = group_ids unless group_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxEndDate'] = max_end_date unless max_end_date.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['maxStartDate'] = max_start_date unless max_start_date.nil? command.query['minEndDate'] = min_end_date unless min_end_date.nil? command.query['minStartDate'] = min_start_date unless min_start_date.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['paymentSource'] = payment_source unless payment_source.nil? command.query['placementStrategyIds'] = placement_strategy_ids unless placement_strategy_ids.nil? command.query['pricingTypes'] = pricing_types unless pricing_types.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['siteIds'] = site_ids unless site_ids.nil? command.query['sizeIds'] = size_ids unless size_ids.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 placement. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Placement ID. # @param [Google::Apis::DfareportingV3_0::Placement] placement_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Placement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement(profile_id, id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/placements', options) command.request_representation = Google::Apis::DfareportingV3_0::Placement::Representation command.request_object = placement_object command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation command.response_class = Google::Apis::DfareportingV3_0::Placement command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing placement. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::Placement] placement_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Placement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Placement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/placements', options) command.request_representation = Google::Apis::DfareportingV3_0::Placement::Representation command.request_object = placement_object command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation command.response_class = Google::Apis::DfareportingV3_0::Placement command.params['profileId'] = profile_id unless profile_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 one platform type by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Platform type 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlatformType] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlatformType] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_platform_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/platformTypes/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::PlatformType::Representation command.response_class = Google::Apis::DfareportingV3_0::PlatformType command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 platform types. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PlatformTypesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PlatformTypesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_platform_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/platformTypes', options) command.response_representation = Google::Apis::DfareportingV3_0::PlatformTypesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::PlatformTypesListResponse command.params['profileId'] = profile_id unless profile_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 one postal code by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [String] code # Postal code 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PostalCode] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PostalCode] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_postal_code(profile_id, code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/postalCodes/{code}', options) command.response_representation = Google::Apis::DfareportingV3_0::PostalCode::Representation command.response_class = Google::Apis::DfareportingV3_0::PostalCode command.params['profileId'] = profile_id unless profile_id.nil? command.params['code'] = code unless 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 # Retrieves a list of postal codes. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::PostalCodesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::PostalCodesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_postal_codes(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/postalCodes', options) command.response_representation = Google::Apis::DfareportingV3_0::PostalCodesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::PostalCodesListResponse command.params['profileId'] = profile_id unless profile_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 one project by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Project 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Project] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Project] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Project::Representation command.response_class = Google::Apis::DfareportingV3_0::Project command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 projects, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] advertiser_ids # Select only projects with these advertiser IDs. # @param [Array, Fixnum] ids # Select only projects with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for projects by name or ID. Wildcards (*) are allowed. For # example, "project*2015" will return projects with names like "project June # 2015", "project April 2015", or simply "project 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "project" will match projects with name "my # project", "project 2015", or simply "project". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ProjectsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ProjectsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_projects(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/projects', options) command.response_representation = Google::Apis::DfareportingV3_0::ProjectsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::ProjectsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 regions. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::RegionsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::RegionsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_regions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/regions', options) command.response_representation = Google::Apis::DfareportingV3_0::RegionsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::RegionsListResponse command.params['profileId'] = profile_id unless profile_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 one remarketing list share by remarketing list ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] remarketing_list_id # Remarketing list 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingListShare] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::RemarketingListShare] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list_share(profile_id, remarketing_list_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingListShares/{remarketingListId}', options) command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation command.response_class = Google::Apis::DfareportingV3_0::RemarketingListShare command.params['profileId'] = profile_id unless profile_id.nil? command.params['remarketingListId'] = remarketing_list_id unless remarketing_list_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 an existing remarketing list share. This method supports patch # semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] remarketing_list_id # Remarketing list ID. # @param [Google::Apis::DfareportingV3_0::RemarketingListShare] remarketing_list_share_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingListShare] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::RemarketingListShare] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list_share(profile_id, remarketing_list_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/remarketingListShares', options) command.request_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation command.request_object = remarketing_list_share_object command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation command.response_class = Google::Apis::DfareportingV3_0::RemarketingListShare command.params['profileId'] = profile_id unless profile_id.nil? command.query['remarketingListId'] = remarketing_list_id unless remarketing_list_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 an existing remarketing list share. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::RemarketingListShare] remarketing_list_share_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingListShare] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::RemarketingListShare] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list_share(profile_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/remarketingListShares', options) command.request_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation command.request_object = remarketing_list_share_object command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation command.response_class = Google::Apis::DfareportingV3_0::RemarketingListShare command.params['profileId'] = profile_id unless profile_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 one remarketing list by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Remarketing list 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::RemarketingList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV3_0::RemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new remarketing list. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::RemarketingList] remarketing_list_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::RemarketingList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/remarketingLists', options) command.request_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation command.request_object = remarketing_list_object command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV3_0::RemarketingList command.params['profileId'] = profile_id unless profile_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 remarketing lists, possibly filtered. This method supports # paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only remarketing lists owned by this advertiser. # @param [Boolean] active # Select only active or only inactive remarketing lists. # @param [Fixnum] floodlight_activity_id # Select only remarketing lists that have this floodlight activity ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] name # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "remarketing list*2015" will return objects with names like " # remarketing list June 2015", "remarketing list April 2015", or simply " # remarketing list 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # remarketing list" will match objects with name "my remarketing list", " # remarketing list 2015", or simply "remarketing list". # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingListsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::RemarketingListsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_lists(profile_id, advertiser_id, active: nil, floodlight_activity_id: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists', options) command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::RemarketingListsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['name'] = name unless name.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 remarketing list. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Remarketing list ID. # @param [Google::Apis::DfareportingV3_0::RemarketingList] remarketing_list_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::RemarketingList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list(profile_id, id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/remarketingLists', options) command.request_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation command.request_object = remarketing_list_object command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV3_0::RemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing remarketing list. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::RemarketingList] remarketing_list_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::RemarketingList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/remarketingLists', options) command.request_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation command.request_object = remarketing_list_object command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation command.response_class = Google::Apis::DfareportingV3_0::RemarketingList command.params['profileId'] = profile_id unless profile_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 a report by its ID. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Fixnum] report_id # The ID of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/reports/{reportId}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_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 report by its ID. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Fixnum] report_id # The ID of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}', options) command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation command.response_class = Google::Apis::DfareportingV3_0::Report command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_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 report. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Google::Apis::DfareportingV3_0::Report] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/reports', options) command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation command.response_class = Google::Apis::DfareportingV3_0::Report command.params['profileId'] = profile_id unless profile_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 list of reports. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @param [String] scope # The scope that defines which results are returned. # @param [String] sort_field # The field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::ReportList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::ReportList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reports(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/reports', options) command.response_representation = Google::Apis::DfareportingV3_0::ReportList::Representation command.response_class = Google::Apis::DfareportingV3_0::ReportList command.params['profileId'] = profile_id unless profile_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['scope'] = scope unless scope.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 a report. This method supports patch semantics. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Fixnum] report_id # The ID of the report. # @param [Google::Apis::DfareportingV3_0::Report] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/reports/{reportId}', options) command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation command.response_class = Google::Apis::DfareportingV3_0::Report command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_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 # Runs a report. # @param [Fixnum] profile_id # The DFA profile ID. # @param [Fixnum] report_id # The ID of the report. # @param [Boolean] synchronous # If set and true, tries to run the report synchronously. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::File] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::File] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def run_report(profile_id, report_id, synchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/reports/{reportId}/run', options) command.response_representation = Google::Apis::DfareportingV3_0::File::Representation command.response_class = Google::Apis::DfareportingV3_0::File command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['synchronous'] = synchronous unless synchronous.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 a report. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Fixnum] report_id # The ID of the report. # @param [Google::Apis::DfareportingV3_0::Report] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/reports/{reportId}', options) command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation command.response_class = Google::Apis::DfareportingV3_0::Report command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_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 fields that are compatible to be selected in the respective # sections of a report criteria, given the fields already selected in the input # report and user permissions. # @param [Fixnum] profile_id # The DFA user profile ID. # @param [Google::Apis::DfareportingV3_0::Report] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::CompatibleFields] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::CompatibleFields] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def query_report_compatible_field(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/reports/compatiblefields/query', options) command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation command.request_object = report_object command.response_representation = Google::Apis::DfareportingV3_0::CompatibleFields::Representation command.response_class = Google::Apis::DfareportingV3_0::CompatibleFields command.params['profileId'] = profile_id unless profile_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 report file. This method supports media download. # @param [Fixnum] profile_id # The DFA profile ID. # @param [Fixnum] report_id # The ID of the report. # @param [Fixnum] file_id # The ID of the report 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::File] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::File] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report_file(profile_id, report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options) else command = make_download_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options) command.download_dest = download_dest end command.response_representation = Google::Apis::DfareportingV3_0::File::Representation command.response_class = Google::Apis::DfareportingV3_0::File command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.params['fileId'] = file_id unless file_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 files for a report. # @param [Fixnum] profile_id # The DFA profile ID. # @param [Fixnum] report_id # The ID of the parent report. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # The value of the nextToken from the previous result page. # @param [String] sort_field # The field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::FileList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::FileList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report_files(profile_id, report_id, max_results: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files', options) command.response_representation = Google::Apis::DfareportingV3_0::FileList::Representation command.response_class = Google::Apis::DfareportingV3_0::FileList command.params['profileId'] = profile_id unless profile_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one site by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Site 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Site] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/sites/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation command.response_class = Google::Apis::DfareportingV3_0::Site command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new site. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::Site] site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Site] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/sites', options) command.request_representation = Google::Apis::DfareportingV3_0::Site::Representation command.request_object = site_object command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation command.response_class = Google::Apis::DfareportingV3_0::Site command.params['profileId'] = profile_id unless profile_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 sites, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] accepts_in_stream_video_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_interstitial_placements # This search filter is no longer supported and will have no effect on the # results returned. # @param [Boolean] accepts_publisher_paid_placements # Select only sites that accept publisher paid placements. # @param [Boolean] ad_words_site # Select only AdWords sites. # @param [Boolean] approved # Select only approved sites. # @param [Array, Fixnum] campaign_ids # Select only sites with these campaign IDs. # @param [Array, Fixnum] directory_site_ids # Select only sites with these directory site IDs. # @param [Array, Fixnum] ids # Select only sites with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. # For example, "site*2015" will return objects with names like "site June 2015", # "site April 2015", or simply "site 2015". Most of the searches also add # wildcards implicitly at the start and the end of the search string. For # example, a search string of "site" will match objects with name "my site", " # site 2015", or simply "site". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] subaccount_id # Select only sites with this subaccount ID. # @param [Boolean] unmapped_site # Select only sites that have not been mapped to a directory site. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::SitesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::SitesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, ad_words_site: nil, approved: nil, campaign_ids: nil, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, unmapped_site: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/sites', options) command.response_representation = Google::Apis::DfareportingV3_0::SitesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::SitesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['acceptsInStreamVideoPlacements'] = accepts_in_stream_video_placements unless accepts_in_stream_video_placements.nil? command.query['acceptsInterstitialPlacements'] = accepts_interstitial_placements unless accepts_interstitial_placements.nil? command.query['acceptsPublisherPaidPlacements'] = accepts_publisher_paid_placements unless accepts_publisher_paid_placements.nil? command.query['adWordsSite'] = ad_words_site unless ad_words_site.nil? command.query['approved'] = approved unless approved.nil? command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? command.query['unmappedSite'] = unmapped_site unless unmapped_site.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 site. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Site ID. # @param [Google::Apis::DfareportingV3_0::Site] site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Site] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(profile_id, id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/sites', options) command.request_representation = Google::Apis::DfareportingV3_0::Site::Representation command.request_object = site_object command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation command.response_class = Google::Apis::DfareportingV3_0::Site command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing site. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::Site] site_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Site] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Site] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/sites', options) command.request_representation = Google::Apis::DfareportingV3_0::Site::Representation command.request_object = site_object command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation command.response_class = Google::Apis::DfareportingV3_0::Site command.params['profileId'] = profile_id unless profile_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 one size by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Size 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Size] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Size] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_size(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/sizes/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Size::Representation command.response_class = Google::Apis::DfareportingV3_0::Size command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new size. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::Size] size_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Size] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Size] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_size(profile_id, size_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/sizes', options) command.request_representation = Google::Apis::DfareportingV3_0::Size::Representation command.request_object = size_object command.response_representation = Google::Apis::DfareportingV3_0::Size::Representation command.response_class = Google::Apis::DfareportingV3_0::Size command.params['profileId'] = profile_id unless profile_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 sizes, possibly filtered. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] height # Select only sizes with this height. # @param [Boolean] iab_standard # Select only IAB standard sizes. # @param [Array, Fixnum] ids # Select only sizes with these IDs. # @param [Fixnum] width # Select only sizes with this width. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::SizesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::SizesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_sizes(profile_id, height: nil, iab_standard: nil, ids: nil, width: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/sizes', options) command.response_representation = Google::Apis::DfareportingV3_0::SizesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::SizesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['height'] = height unless height.nil? command.query['iabStandard'] = iab_standard unless iab_standard.nil? command.query['ids'] = ids unless ids.nil? command.query['width'] = width unless width.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 one subaccount by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Subaccount 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Subaccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subaccount(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/subaccounts/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation command.response_class = Google::Apis::DfareportingV3_0::Subaccount command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new subaccount. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::Subaccount] subaccount_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Subaccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/subaccounts', options) command.request_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation command.request_object = subaccount_object command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation command.response_class = Google::Apis::DfareportingV3_0::Subaccount command.params['profileId'] = profile_id unless profile_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 list of subaccounts, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Select only subaccounts with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "subaccount*2015" will return objects with names like "subaccount # June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the # searches also add wildcards implicitly at the start and the end of the search # string. For example, a search string of "subaccount" will match objects with # name "my subaccount", "subaccount 2015", or simply "subaccount". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::SubaccountsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::SubaccountsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subaccounts(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/subaccounts', options) command.response_representation = Google::Apis::DfareportingV3_0::SubaccountsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::SubaccountsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 subaccount. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Subaccount ID. # @param [Google::Apis::DfareportingV3_0::Subaccount] subaccount_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Subaccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subaccount(profile_id, id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/subaccounts', options) command.request_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation command.request_object = subaccount_object command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation command.response_class = Google::Apis::DfareportingV3_0::Subaccount command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing subaccount. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::Subaccount] subaccount_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::Subaccount] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::Subaccount] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/subaccounts', options) command.request_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation command.request_object = subaccount_object command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation command.response_class = Google::Apis::DfareportingV3_0::Subaccount command.params['profileId'] = profile_id unless profile_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 one remarketing list by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Remarketing list 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::TargetableRemarketingList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::TargetableRemarketingList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_targetable_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::TargetableRemarketingList::Representation command.response_class = Google::Apis::DfareportingV3_0::TargetableRemarketingList command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 targetable remarketing lists, possibly filtered. This # method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only targetable remarketing lists targetable by these advertisers. # @param [Boolean] active # Select only active or only inactive targetable remarketing lists. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] name # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "remarketing list*2015" will return objects with names like " # remarketing list June 2015", "remarketing list April 2015", or simply " # remarketing list 2015". Most of the searches also add wildcards implicitly at # the start and the end of the search string. For example, a search string of " # remarketing list" will match objects with name "my remarketing list", " # remarketing list 2015", or simply "remarketing list". # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::TargetableRemarketingListsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::TargetableRemarketingListsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_targetable_remarketing_lists(profile_id, advertiser_id, active: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists', options) command.response_representation = Google::Apis::DfareportingV3_0::TargetableRemarketingListsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::TargetableRemarketingListsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['active'] = active unless active.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['name'] = name unless name.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 one targeting template by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Targeting template 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::TargetingTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::TargetingTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_template(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation command.response_class = Google::Apis::DfareportingV3_0::TargetingTemplate command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new targeting template. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::TargetingTemplate] targeting_template_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::TargetingTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::TargetingTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/targetingTemplates', options) command.request_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation command.request_object = targeting_template_object command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation command.response_class = Google::Apis::DfareportingV3_0::TargetingTemplate command.params['profileId'] = profile_id unless profile_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 targeting templates, optionally filtered. This method # supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] advertiser_id # Select only targeting templates with this advertiser ID. # @param [Array, Fixnum] ids # Select only targeting templates with these IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "template*2015" will return objects with names like "template June # 2015", "template April 2015", or simply "template 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "template" will match objects with name "my # template", "template 2015", or simply "template". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::TargetingTemplatesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::TargetingTemplatesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_templates(profile_id, advertiser_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates', options) command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplatesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::TargetingTemplatesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.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 targeting template. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Targeting template ID. # @param [Google::Apis::DfareportingV3_0::TargetingTemplate] targeting_template_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::TargetingTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::TargetingTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_targeting_template(profile_id, id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/targetingTemplates', options) command.request_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation command.request_object = targeting_template_object command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation command.response_class = Google::Apis::DfareportingV3_0::TargetingTemplate command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing targeting template. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::TargetingTemplate] targeting_template_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::TargetingTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::TargetingTemplate] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/targetingTemplates', options) command.request_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation command.request_object = targeting_template_object command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation command.response_class = Google::Apis::DfareportingV3_0::TargetingTemplate command.params['profileId'] = profile_id unless profile_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 one user profile by ID. # @param [Fixnum] profile_id # The user profile 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profile(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}', options) command.response_representation = Google::Apis::DfareportingV3_0::UserProfile::Representation command.response_class = Google::Apis::DfareportingV3_0::UserProfile command.params['profileId'] = profile_id unless profile_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 list of user profiles for a user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserProfileList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserProfileList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profiles(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles', options) command.response_representation = Google::Apis::DfareportingV3_0::UserProfileList::Representation command.response_class = Google::Apis::DfareportingV3_0::UserProfileList 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 one user role permission group by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User role permission group 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserRolePermissionGroup] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserRolePermissionGroup] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermissionGroup::Representation command.response_class = Google::Apis::DfareportingV3_0::UserRolePermissionGroup command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 list of all supported user role permission groups. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserRolePermissionGroupsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserRolePermissionGroupsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups', options) command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermissionGroupsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::UserRolePermissionGroupsListResponse command.params['profileId'] = profile_id unless profile_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 one user role permission by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User role permission 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserRolePermission] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserRolePermission] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermission::Representation command.response_class = Google::Apis::DfareportingV3_0::UserRolePermission command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 list of user role permissions, possibly filtered. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Array, Fixnum] ids # Select only user role permissions with these IDs. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserRolePermissionsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserRolePermissionsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role_permissions(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions', options) command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermissionsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::UserRolePermissionsListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['ids'] = ids unless 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 # Deletes an existing user role. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User role 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'userprofiles/{profileId}/userRoles/{id}', options) command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 one user role by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User role 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserRole] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRoles/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation command.response_class = Google::Apis::DfareportingV3_0::UserRole command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 # Inserts a new user role. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::UserRole] user_role_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserRole] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'userprofiles/{profileId}/userRoles', options) command.request_representation = Google::Apis::DfareportingV3_0::UserRole::Representation command.request_object = user_role_object command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation command.response_class = Google::Apis::DfareportingV3_0::UserRole command.params['profileId'] = profile_id unless profile_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 user roles, possibly filtered. This method supports paging. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Boolean] account_user_role_only # Select only account level user roles not associated with any specific # subaccount. # @param [Array, Fixnum] ids # Select only user roles with the specified IDs. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token # Value of the nextPageToken from the previous result page. # @param [String] search_string # Allows searching for objects by name or ID. Wildcards (*) are allowed. For # example, "userrole*2015" will return objects with names like "userrole June # 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches # also add wildcards implicitly at the start and the end of the search string. # For example, a search string of "userrole" will match objects with name "my # userrole", "userrole 2015", or simply "userrole". # @param [String] sort_field # Field by which to sort the list. # @param [String] sort_order # Order of sorted results. # @param [Fixnum] subaccount_id # Select only user roles that belong to this subaccount. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserRolesListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserRolesListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_roles(profile_id, account_user_role_only: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/userRoles', options) command.response_representation = Google::Apis::DfareportingV3_0::UserRolesListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::UserRolesListResponse command.params['profileId'] = profile_id unless profile_id.nil? command.query['accountUserRoleOnly'] = account_user_role_only unless account_user_role_only.nil? command.query['ids'] = ids unless ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['searchString'] = search_string unless search_string.nil? command.query['sortField'] = sort_field unless sort_field.nil? command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['subaccountId'] = subaccount_id unless subaccount_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 an existing user role. This method supports patch semantics. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # User role ID. # @param [Google::Apis::DfareportingV3_0::UserRole] user_role_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserRole] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role(profile_id, id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'userprofiles/{profileId}/userRoles', options) command.request_representation = Google::Apis::DfareportingV3_0::UserRole::Representation command.request_object = user_role_object command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation command.response_class = Google::Apis::DfareportingV3_0::UserRole command.params['profileId'] = profile_id unless profile_id.nil? command.query['id'] = id unless 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 an existing user role. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Google::Apis::DfareportingV3_0::UserRole] user_role_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::UserRole] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::UserRole] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'userprofiles/{profileId}/userRoles', options) command.request_representation = Google::Apis::DfareportingV3_0::UserRole::Representation command.request_object = user_role_object command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation command.response_class = Google::Apis::DfareportingV3_0::UserRole command.params['profileId'] = profile_id unless profile_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 one video format by ID. # @param [Fixnum] profile_id # User profile ID associated with this request. # @param [Fixnum] id # Video format 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::VideoFormat] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::VideoFormat] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_video_format(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/videoFormats/{id}', options) command.response_representation = Google::Apis::DfareportingV3_0::VideoFormat::Representation command.response_class = Google::Apis::DfareportingV3_0::VideoFormat command.params['profileId'] = profile_id unless profile_id.nil? command.params['id'] = id unless 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 available video formats. # @param [Fixnum] profile_id # User profile ID associated with this 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DfareportingV3_0::VideoFormatsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DfareportingV3_0::VideoFormatsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_video_formats(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userprofiles/{profileId}/videoFormats', options) command.response_representation = Google::Apis::DfareportingV3_0::VideoFormatsListResponse::Representation command.response_class = Google::Apis::DfareportingV3_0::VideoFormatsListResponse command.params['profileId'] = profile_id unless profile_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 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 end end google-api-client-0.19.8/generated/google/apis/speech_v1/0000755000004100000410000000000013252673044023171 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/speech_v1/representations.rb0000644000004100000410000001557413252673044026757 0ustar www-datawww-data# 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 SpeechV1 class LongRunningRecognizeRequest 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 RecognitionAudio class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RecognitionConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RecognizeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RecognizeResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SpeechContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SpeechRecognitionAlternative class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SpeechRecognitionResult 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 WordInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LongRunningRecognizeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :audio, as: 'audio', class: Google::Apis::SpeechV1::RecognitionAudio, decorator: Google::Apis::SpeechV1::RecognitionAudio::Representation property :config, as: 'config', class: Google::Apis::SpeechV1::RecognitionConfig, decorator: Google::Apis::SpeechV1::RecognitionConfig::Representation end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::SpeechV1::Status, decorator: Google::Apis::SpeechV1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class RecognitionAudio # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, :base64 => true, as: 'content' property :uri, as: 'uri' end end class RecognitionConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :enable_word_confidence, as: 'enableWordConfidence' property :enable_word_time_offsets, as: 'enableWordTimeOffsets' property :encoding, as: 'encoding' property :language_code, as: 'languageCode' property :max_alternatives, as: 'maxAlternatives' property :profanity_filter, as: 'profanityFilter' property :sample_rate_hertz, as: 'sampleRateHertz' collection :speech_contexts, as: 'speechContexts', class: Google::Apis::SpeechV1::SpeechContext, decorator: Google::Apis::SpeechV1::SpeechContext::Representation end end class RecognizeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :audio, as: 'audio', class: Google::Apis::SpeechV1::RecognitionAudio, decorator: Google::Apis::SpeechV1::RecognitionAudio::Representation property :config, as: 'config', class: Google::Apis::SpeechV1::RecognitionConfig, decorator: Google::Apis::SpeechV1::RecognitionConfig::Representation end end class RecognizeResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :results, as: 'results', class: Google::Apis::SpeechV1::SpeechRecognitionResult, decorator: Google::Apis::SpeechV1::SpeechRecognitionResult::Representation end end class SpeechContext # @private class Representation < Google::Apis::Core::JsonRepresentation collection :phrases, as: 'phrases' end end class SpeechRecognitionAlternative # @private class Representation < Google::Apis::Core::JsonRepresentation property :confidence, as: 'confidence' property :transcript, as: 'transcript' collection :words, as: 'words', class: Google::Apis::SpeechV1::WordInfo, decorator: Google::Apis::SpeechV1::WordInfo::Representation end end class SpeechRecognitionResult # @private class Representation < Google::Apis::Core::JsonRepresentation collection :alternatives, as: 'alternatives', class: Google::Apis::SpeechV1::SpeechRecognitionAlternative, decorator: Google::Apis::SpeechV1::SpeechRecognitionAlternative::Representation 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 WordInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime' property :start_time, as: 'startTime' property :word, as: 'word' end end end end end google-api-client-0.19.8/generated/google/apis/speech_v1/classes.rb0000644000004100000410000005743413252673044025170 0ustar www-datawww-data# 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 SpeechV1 # The top-level message sent by the client for the `LongRunningRecognize` # method. class LongRunningRecognizeRequest include Google::Apis::Core::Hashable # 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 # [audio limits](https://cloud.google.com/speech/limits#content). # Corresponds to the JSON property `audio` # @return [Google::Apis::SpeechV1::RecognitionAudio] attr_accessor :audio # Provides information to the recognizer that specifies how to process the # request. # Corresponds to the JSON property `config` # @return [Google::Apis::SpeechV1::RecognitionConfig] attr_accessor :config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @audio = args[:audio] if args.key?(:audio) @config = args[:config] if args.key?(:config) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::SpeechV1::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 have the format of `operations/some/unique/name`. # 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 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 # [audio limits](https://cloud.google.com/speech/limits#content). class RecognitionAudio include Google::Apis::Core::Hashable # The audio data bytes encoded as specified in # `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a # pure binary representation, whereas JSON representations use base64. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :content # URI that points to a file that contains audio data bytes as specified in # `RecognitionConfig`. Currently, only Google Cloud Storage URIs are # supported, which must be specified in the following format: # `gs://bucket_name/object_name` (other URI formats return # google.rpc.Code.INVALID_ARGUMENT). For more information, see # [Request URIs](https://cloud.google.com/storage/docs/reference-uris). # 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) @content = args[:content] if args.key?(:content) @uri = args[:uri] if args.key?(:uri) end end # Provides information to the recognizer that specifies how to process the # request. class RecognitionConfig include Google::Apis::Core::Hashable # *Optional* If `true`, the top result includes a list of words and the # confidence for those words. If `false`, no word-level confidence # information is returned. The default is `false`. # Corresponds to the JSON property `enableWordConfidence` # @return [Boolean] attr_accessor :enable_word_confidence alias_method :enable_word_confidence?, :enable_word_confidence # *Optional* If `true`, the top result includes a list of words and # the start and end time offsets (timestamps) for those words. If # `false`, no word-level time offset information is returned. The default is # `false`. # Corresponds to the JSON property `enableWordTimeOffsets` # @return [Boolean] attr_accessor :enable_word_time_offsets alias_method :enable_word_time_offsets?, :enable_word_time_offsets # *Required* Encoding of audio data sent in all `RecognitionAudio` messages. # Corresponds to the JSON property `encoding` # @return [String] attr_accessor :encoding # *Required* The language of the supplied audio as a # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. # Example: "en-US". # See [Language Support](https://cloud.google.com/speech/docs/languages) # for a list of the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # *Optional* Maximum number of recognition hypotheses to be returned. # Specifically, the maximum number of `SpeechRecognitionAlternative` messages # within each `SpeechRecognitionResult`. # The server may return fewer than `max_alternatives`. # Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of # one. If omitted, will return a maximum of one. # Corresponds to the JSON property `maxAlternatives` # @return [Fixnum] attr_accessor :max_alternatives # *Optional* If set to `true`, the server will attempt to filter out # profanities, replacing all but the initial character in each filtered word # with asterisks, e.g. "f***". If set to `false` or omitted, profanities # won't be filtered out. # Corresponds to the JSON property `profanityFilter` # @return [Boolean] attr_accessor :profanity_filter alias_method :profanity_filter?, :profanity_filter # *Required* Sample rate in Hertz of the audio data sent in all # `RecognitionAudio` messages. Valid values are: 8000-48000. # 16000 is optimal. For best results, set the sampling rate of the audio # source to 16000 Hz. If that's not possible, use the native sample rate of # the audio source (instead of re-sampling). # Corresponds to the JSON property `sampleRateHertz` # @return [Fixnum] attr_accessor :sample_rate_hertz # *Optional* A means to provide context to assist the speech recognition. # Corresponds to the JSON property `speechContexts` # @return [Array] attr_accessor :speech_contexts def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enable_word_confidence = args[:enable_word_confidence] if args.key?(:enable_word_confidence) @enable_word_time_offsets = args[:enable_word_time_offsets] if args.key?(:enable_word_time_offsets) @encoding = args[:encoding] if args.key?(:encoding) @language_code = args[:language_code] if args.key?(:language_code) @max_alternatives = args[:max_alternatives] if args.key?(:max_alternatives) @profanity_filter = args[:profanity_filter] if args.key?(:profanity_filter) @sample_rate_hertz = args[:sample_rate_hertz] if args.key?(:sample_rate_hertz) @speech_contexts = args[:speech_contexts] if args.key?(:speech_contexts) end end # The top-level message sent by the client for the `Recognize` method. class RecognizeRequest include Google::Apis::Core::Hashable # 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 # [audio limits](https://cloud.google.com/speech/limits#content). # Corresponds to the JSON property `audio` # @return [Google::Apis::SpeechV1::RecognitionAudio] attr_accessor :audio # Provides information to the recognizer that specifies how to process the # request. # Corresponds to the JSON property `config` # @return [Google::Apis::SpeechV1::RecognitionConfig] attr_accessor :config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @audio = args[:audio] if args.key?(:audio) @config = args[:config] if args.key?(:config) end end # The only message returned to the client by the `Recognize` method. It # contains the result as zero or more sequential `SpeechRecognitionResult` # messages. class RecognizeResponse include Google::Apis::Core::Hashable # *Output-only* Sequential list of transcription results corresponding to # sequential portions of audio. # 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) @results = args[:results] if args.key?(:results) end end # Provides "hints" to the speech recognizer to favor specific words and phrases # in the results. class SpeechContext include Google::Apis::Core::Hashable # *Optional* A list of strings containing words and phrases "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/limits#content). # 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) @phrases = args[:phrases] if args.key?(:phrases) end end # Alternative hypotheses (a.k.a. n-best list). class SpeechRecognitionAlternative include Google::Apis::Core::Hashable # *Output-only* The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are # correct. This field is set only for the top alternative of a non-streaming # result or, of a streaming result where `is_final=true`. # This field is not guaranteed to be accurate and users should not rely on it # to be always provided. # The default of 0.0 is a sentinel value indicating `confidence` was not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence # *Output-only* Transcript text representing the words that the user spoke. # Corresponds to the JSON property `transcript` # @return [String] attr_accessor :transcript # *Output-only* A list of word-specific information for each recognized word. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @confidence = args[:confidence] if args.key?(:confidence) @transcript = args[:transcript] if args.key?(:transcript) @words = args[:words] if args.key?(:words) end end # A speech recognition result corresponding to a portion of the audio. class SpeechRecognitionResult include Google::Apis::Core::Hashable # *Output-only* May contain one or more recognition hypotheses (up to the # maximum specified in `max_alternatives`). # These alternatives are ordered in terms of accuracy, with the top (first) # alternative being the most probable, as ranked by the recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alternatives = args[:alternatives] if args.key?(:alternatives) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 # Word-specific information for recognized words. class WordInfo include Google::Apis::Core::Hashable # *Output-only* Time offset relative to the beginning of the audio, # and corresponding to the end of the spoken word. # This field is only set if `enable_word_time_offsets=true` and only # in the top hypothesis. # This is an experimental feature and the accuracy of the time offset can # vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # *Output-only* Time offset relative to the beginning of the audio, # and corresponding to the start of the spoken word. # This field is only set if `enable_word_time_offsets=true` and only # in the top hypothesis. # This is an experimental feature and the accuracy of the time offset can # vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # *Output-only* The word corresponding to this set of information. # Corresponds to the JSON property `word` # @return [String] attr_accessor :word 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) @word = args[:word] if args.key?(:word) end end end end end google-api-client-0.19.8/generated/google/apis/speech_v1/service.rb0000644000004100000410000001757313252673044025173 0ustar www-datawww-data# 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 SpeechV1 # Google Cloud Speech API # # Converts audio to text by applying powerful neural network models. # # @example # require 'google/apis/speech_v1' # # Speech = Google::Apis::SpeechV1 # Alias the module # service = Speech::SpeechService.new # # @see https://cloud.google.com/speech/ class SpeechService < 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://speech.googleapis.com/', '') @batch_path = 'batch' 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::SpeechV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SpeechV1::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_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/operations/{+name}', options) command.response_representation = Google::Apis::SpeechV1::Operation::Representation command.response_class = Google::Apis::SpeechV1::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 # Performs asynchronous speech recognition: receive results via the # google.longrunning.Operations interface. Returns either an # `Operation.error` or an `Operation.response` which contains # a `LongRunningRecognizeResponse` message. # @param [Google::Apis::SpeechV1::LongRunningRecognizeRequest] long_running_recognize_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::SpeechV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SpeechV1::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 longrunningrecognize_speech(long_running_recognize_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/speech:longrunningrecognize', options) command.request_representation = Google::Apis::SpeechV1::LongRunningRecognizeRequest::Representation command.request_object = long_running_recognize_request_object command.response_representation = Google::Apis::SpeechV1::Operation::Representation command.response_class = Google::Apis::SpeechV1::Operation command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Performs synchronous speech recognition: receive results after all audio # has been sent and processed. # @param [Google::Apis::SpeechV1::RecognizeRequest] recognize_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::SpeechV1::RecognizeResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SpeechV1::RecognizeResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def recognize_speech(recognize_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/speech:recognize', options) command.request_representation = Google::Apis::SpeechV1::RecognizeRequest::Representation command.request_object = recognize_request_object command.response_representation = Google::Apis::SpeechV1::RecognizeResponse::Representation command.response_class = Google::Apis::SpeechV1::RecognizeResponse 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 google-api-client-0.19.8/generated/google/apis/classroom_v1/0000755000004100000410000000000013252673043023723 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/classroom_v1/representations.rb0000644000004100000410000010762413252673043027507 0ustar www-datawww-data# 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 ClassroomV1 class Announcement 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 AssignmentSubmission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Attachment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CloudPubsubTopic class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Course class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CourseAlias class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CourseMaterial class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CourseMaterialSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CourseRosterChangesInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CourseWork 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 DriveFile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DriveFolder 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 Feed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Form class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GlobalPermission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GradeHistory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Guardian class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GuardianInvitation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IndividualStudentsOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Invitation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Link class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAnnouncementsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListCourseAliasesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListCourseWorkResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListCoursesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListGuardianInvitationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListGuardiansResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListInvitationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListStudentSubmissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListStudentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTeachersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTopicResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Material class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ModifyAnnouncementAssigneesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ModifyAttachmentsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ModifyCourseWorkAssigneesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ModifyIndividualStudentsOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MultipleChoiceQuestion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MultipleChoiceSubmission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Name class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReclaimStudentSubmissionRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Registration class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReturnStudentSubmissionRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SharedDriveFile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShortAnswerSubmission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StateHistory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Student class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StudentSubmission class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SubmissionHistory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Teacher 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 Topic class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TurnInStudentSubmissionRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserProfile class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class YouTubeVideo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Announcement # @private class Representation < Google::Apis::Core::JsonRepresentation property :alternate_link, as: 'alternateLink' property :assignee_mode, as: 'assigneeMode' property :course_id, as: 'courseId' property :creation_time, as: 'creationTime' property :creator_user_id, as: 'creatorUserId' property :id, as: 'id' property :individual_students_options, as: 'individualStudentsOptions', class: Google::Apis::ClassroomV1::IndividualStudentsOptions, decorator: Google::Apis::ClassroomV1::IndividualStudentsOptions::Representation collection :materials, as: 'materials', class: Google::Apis::ClassroomV1::Material, decorator: Google::Apis::ClassroomV1::Material::Representation property :scheduled_time, as: 'scheduledTime' property :state, as: 'state' property :text, as: 'text' property :update_time, as: 'updateTime' end end class Assignment # @private class Representation < Google::Apis::Core::JsonRepresentation property :student_work_folder, as: 'studentWorkFolder', class: Google::Apis::ClassroomV1::DriveFolder, decorator: Google::Apis::ClassroomV1::DriveFolder::Representation end end class AssignmentSubmission # @private class Representation < Google::Apis::Core::JsonRepresentation collection :attachments, as: 'attachments', class: Google::Apis::ClassroomV1::Attachment, decorator: Google::Apis::ClassroomV1::Attachment::Representation end end class Attachment # @private class Representation < Google::Apis::Core::JsonRepresentation property :drive_file, as: 'driveFile', class: Google::Apis::ClassroomV1::DriveFile, decorator: Google::Apis::ClassroomV1::DriveFile::Representation property :form, as: 'form', class: Google::Apis::ClassroomV1::Form, decorator: Google::Apis::ClassroomV1::Form::Representation property :link, as: 'link', class: Google::Apis::ClassroomV1::Link, decorator: Google::Apis::ClassroomV1::Link::Representation property :you_tube_video, as: 'youTubeVideo', class: Google::Apis::ClassroomV1::YouTubeVideo, decorator: Google::Apis::ClassroomV1::YouTubeVideo::Representation end end class CloudPubsubTopic # @private class Representation < Google::Apis::Core::JsonRepresentation property :topic_name, as: 'topicName' end end class Course # @private class Representation < Google::Apis::Core::JsonRepresentation property :alternate_link, as: 'alternateLink' property :calendar_id, as: 'calendarId' property :course_group_email, as: 'courseGroupEmail' collection :course_material_sets, as: 'courseMaterialSets', class: Google::Apis::ClassroomV1::CourseMaterialSet, decorator: Google::Apis::ClassroomV1::CourseMaterialSet::Representation property :course_state, as: 'courseState' property :creation_time, as: 'creationTime' property :description, as: 'description' property :description_heading, as: 'descriptionHeading' property :enrollment_code, as: 'enrollmentCode' property :guardians_enabled, as: 'guardiansEnabled' property :id, as: 'id' property :name, as: 'name' property :owner_id, as: 'ownerId' property :room, as: 'room' property :section, as: 'section' property :teacher_folder, as: 'teacherFolder', class: Google::Apis::ClassroomV1::DriveFolder, decorator: Google::Apis::ClassroomV1::DriveFolder::Representation property :teacher_group_email, as: 'teacherGroupEmail' property :update_time, as: 'updateTime' end end class CourseAlias # @private class Representation < Google::Apis::Core::JsonRepresentation property :alias, as: 'alias' end end class CourseMaterial # @private class Representation < Google::Apis::Core::JsonRepresentation property :drive_file, as: 'driveFile', class: Google::Apis::ClassroomV1::DriveFile, decorator: Google::Apis::ClassroomV1::DriveFile::Representation property :form, as: 'form', class: Google::Apis::ClassroomV1::Form, decorator: Google::Apis::ClassroomV1::Form::Representation property :link, as: 'link', class: Google::Apis::ClassroomV1::Link, decorator: Google::Apis::ClassroomV1::Link::Representation property :you_tube_video, as: 'youTubeVideo', class: Google::Apis::ClassroomV1::YouTubeVideo, decorator: Google::Apis::ClassroomV1::YouTubeVideo::Representation end end class CourseMaterialSet # @private class Representation < Google::Apis::Core::JsonRepresentation collection :materials, as: 'materials', class: Google::Apis::ClassroomV1::CourseMaterial, decorator: Google::Apis::ClassroomV1::CourseMaterial::Representation property :title, as: 'title' end end class CourseRosterChangesInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :course_id, as: 'courseId' end end class CourseWork # @private class Representation < Google::Apis::Core::JsonRepresentation property :alternate_link, as: 'alternateLink' property :assignee_mode, as: 'assigneeMode' property :assignment, as: 'assignment', class: Google::Apis::ClassroomV1::Assignment, decorator: Google::Apis::ClassroomV1::Assignment::Representation property :associated_with_developer, as: 'associatedWithDeveloper' property :course_id, as: 'courseId' property :creation_time, as: 'creationTime' property :creator_user_id, as: 'creatorUserId' property :description, as: 'description' property :due_date, as: 'dueDate', class: Google::Apis::ClassroomV1::Date, decorator: Google::Apis::ClassroomV1::Date::Representation property :due_time, as: 'dueTime', class: Google::Apis::ClassroomV1::TimeOfDay, decorator: Google::Apis::ClassroomV1::TimeOfDay::Representation property :id, as: 'id' property :individual_students_options, as: 'individualStudentsOptions', class: Google::Apis::ClassroomV1::IndividualStudentsOptions, decorator: Google::Apis::ClassroomV1::IndividualStudentsOptions::Representation collection :materials, as: 'materials', class: Google::Apis::ClassroomV1::Material, decorator: Google::Apis::ClassroomV1::Material::Representation property :max_points, as: 'maxPoints' property :multiple_choice_question, as: 'multipleChoiceQuestion', class: Google::Apis::ClassroomV1::MultipleChoiceQuestion, decorator: Google::Apis::ClassroomV1::MultipleChoiceQuestion::Representation property :scheduled_time, as: 'scheduledTime' property :state, as: 'state' property :submission_modification_mode, as: 'submissionModificationMode' property :title, as: 'title' property :update_time, as: 'updateTime' property :work_type, as: 'workType' 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 DriveFile # @private class Representation < Google::Apis::Core::JsonRepresentation property :alternate_link, as: 'alternateLink' property :id, as: 'id' property :thumbnail_url, as: 'thumbnailUrl' property :title, as: 'title' end end class DriveFolder # @private class Representation < Google::Apis::Core::JsonRepresentation property :alternate_link, as: 'alternateLink' property :id, as: 'id' property :title, as: 'title' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Feed # @private class Representation < Google::Apis::Core::JsonRepresentation property :course_roster_changes_info, as: 'courseRosterChangesInfo', class: Google::Apis::ClassroomV1::CourseRosterChangesInfo, decorator: Google::Apis::ClassroomV1::CourseRosterChangesInfo::Representation property :feed_type, as: 'feedType' end end class Form # @private class Representation < Google::Apis::Core::JsonRepresentation property :form_url, as: 'formUrl' property :response_url, as: 'responseUrl' property :thumbnail_url, as: 'thumbnailUrl' property :title, as: 'title' end end class GlobalPermission # @private class Representation < Google::Apis::Core::JsonRepresentation property :permission, as: 'permission' end end class GradeHistory # @private class Representation < Google::Apis::Core::JsonRepresentation property :actor_user_id, as: 'actorUserId' property :grade_change_type, as: 'gradeChangeType' property :grade_timestamp, as: 'gradeTimestamp' property :max_points, as: 'maxPoints' property :points_earned, as: 'pointsEarned' end end class Guardian # @private class Representation < Google::Apis::Core::JsonRepresentation property :guardian_id, as: 'guardianId' property :guardian_profile, as: 'guardianProfile', class: Google::Apis::ClassroomV1::UserProfile, decorator: Google::Apis::ClassroomV1::UserProfile::Representation property :invited_email_address, as: 'invitedEmailAddress' property :student_id, as: 'studentId' end end class GuardianInvitation # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_time, as: 'creationTime' property :invitation_id, as: 'invitationId' property :invited_email_address, as: 'invitedEmailAddress' property :state, as: 'state' property :student_id, as: 'studentId' end end class IndividualStudentsOptions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :student_ids, as: 'studentIds' end end class Invitation # @private class Representation < Google::Apis::Core::JsonRepresentation property :course_id, as: 'courseId' property :id, as: 'id' property :role, as: 'role' property :user_id, as: 'userId' end end class Link # @private class Representation < Google::Apis::Core::JsonRepresentation property :thumbnail_url, as: 'thumbnailUrl' property :title, as: 'title' property :url, as: 'url' end end class ListAnnouncementsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :announcements, as: 'announcements', class: Google::Apis::ClassroomV1::Announcement, decorator: Google::Apis::ClassroomV1::Announcement::Representation property :next_page_token, as: 'nextPageToken' end end class ListCourseAliasesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :aliases, as: 'aliases', class: Google::Apis::ClassroomV1::CourseAlias, decorator: Google::Apis::ClassroomV1::CourseAlias::Representation property :next_page_token, as: 'nextPageToken' end end class ListCourseWorkResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :course_work, as: 'courseWork', class: Google::Apis::ClassroomV1::CourseWork, decorator: Google::Apis::ClassroomV1::CourseWork::Representation property :next_page_token, as: 'nextPageToken' end end class ListCoursesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :courses, as: 'courses', class: Google::Apis::ClassroomV1::Course, decorator: Google::Apis::ClassroomV1::Course::Representation property :next_page_token, as: 'nextPageToken' end end class ListGuardianInvitationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :guardian_invitations, as: 'guardianInvitations', class: Google::Apis::ClassroomV1::GuardianInvitation, decorator: Google::Apis::ClassroomV1::GuardianInvitation::Representation property :next_page_token, as: 'nextPageToken' end end class ListGuardiansResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :guardians, as: 'guardians', class: Google::Apis::ClassroomV1::Guardian, decorator: Google::Apis::ClassroomV1::Guardian::Representation property :next_page_token, as: 'nextPageToken' end end class ListInvitationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :invitations, as: 'invitations', class: Google::Apis::ClassroomV1::Invitation, decorator: Google::Apis::ClassroomV1::Invitation::Representation property :next_page_token, as: 'nextPageToken' end end class ListStudentSubmissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :student_submissions, as: 'studentSubmissions', class: Google::Apis::ClassroomV1::StudentSubmission, decorator: Google::Apis::ClassroomV1::StudentSubmission::Representation end end class ListStudentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :students, as: 'students', class: Google::Apis::ClassroomV1::Student, decorator: Google::Apis::ClassroomV1::Student::Representation end end class ListTeachersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :teachers, as: 'teachers', class: Google::Apis::ClassroomV1::Teacher, decorator: Google::Apis::ClassroomV1::Teacher::Representation end end class ListTopicResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :topic, as: 'topic', class: Google::Apis::ClassroomV1::Topic, decorator: Google::Apis::ClassroomV1::Topic::Representation end end class Material # @private class Representation < Google::Apis::Core::JsonRepresentation property :drive_file, as: 'driveFile', class: Google::Apis::ClassroomV1::SharedDriveFile, decorator: Google::Apis::ClassroomV1::SharedDriveFile::Representation property :form, as: 'form', class: Google::Apis::ClassroomV1::Form, decorator: Google::Apis::ClassroomV1::Form::Representation property :link, as: 'link', class: Google::Apis::ClassroomV1::Link, decorator: Google::Apis::ClassroomV1::Link::Representation property :youtube_video, as: 'youtubeVideo', class: Google::Apis::ClassroomV1::YouTubeVideo, decorator: Google::Apis::ClassroomV1::YouTubeVideo::Representation end end class ModifyAnnouncementAssigneesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :assignee_mode, as: 'assigneeMode' property :modify_individual_students_options, as: 'modifyIndividualStudentsOptions', class: Google::Apis::ClassroomV1::ModifyIndividualStudentsOptions, decorator: Google::Apis::ClassroomV1::ModifyIndividualStudentsOptions::Representation end end class ModifyAttachmentsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :add_attachments, as: 'addAttachments', class: Google::Apis::ClassroomV1::Attachment, decorator: Google::Apis::ClassroomV1::Attachment::Representation end end class ModifyCourseWorkAssigneesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :assignee_mode, as: 'assigneeMode' property :modify_individual_students_options, as: 'modifyIndividualStudentsOptions', class: Google::Apis::ClassroomV1::ModifyIndividualStudentsOptions, decorator: Google::Apis::ClassroomV1::ModifyIndividualStudentsOptions::Representation end end class ModifyIndividualStudentsOptions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :add_student_ids, as: 'addStudentIds' collection :remove_student_ids, as: 'removeStudentIds' end end class MultipleChoiceQuestion # @private class Representation < Google::Apis::Core::JsonRepresentation collection :choices, as: 'choices' end end class MultipleChoiceSubmission # @private class Representation < Google::Apis::Core::JsonRepresentation property :answer, as: 'answer' end end class Name # @private class Representation < Google::Apis::Core::JsonRepresentation property :family_name, as: 'familyName' property :full_name, as: 'fullName' property :given_name, as: 'givenName' end end class ReclaimStudentSubmissionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Registration # @private class Representation < Google::Apis::Core::JsonRepresentation property :cloud_pubsub_topic, as: 'cloudPubsubTopic', class: Google::Apis::ClassroomV1::CloudPubsubTopic, decorator: Google::Apis::ClassroomV1::CloudPubsubTopic::Representation property :expiry_time, as: 'expiryTime' property :feed, as: 'feed', class: Google::Apis::ClassroomV1::Feed, decorator: Google::Apis::ClassroomV1::Feed::Representation property :registration_id, as: 'registrationId' end end class ReturnStudentSubmissionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class SharedDriveFile # @private class Representation < Google::Apis::Core::JsonRepresentation property :drive_file, as: 'driveFile', class: Google::Apis::ClassroomV1::DriveFile, decorator: Google::Apis::ClassroomV1::DriveFile::Representation property :share_mode, as: 'shareMode' end end class ShortAnswerSubmission # @private class Representation < Google::Apis::Core::JsonRepresentation property :answer, as: 'answer' end end class StateHistory # @private class Representation < Google::Apis::Core::JsonRepresentation property :actor_user_id, as: 'actorUserId' property :state, as: 'state' property :state_timestamp, as: 'stateTimestamp' end end class Student # @private class Representation < Google::Apis::Core::JsonRepresentation property :course_id, as: 'courseId' property :profile, as: 'profile', class: Google::Apis::ClassroomV1::UserProfile, decorator: Google::Apis::ClassroomV1::UserProfile::Representation property :student_work_folder, as: 'studentWorkFolder', class: Google::Apis::ClassroomV1::DriveFolder, decorator: Google::Apis::ClassroomV1::DriveFolder::Representation property :user_id, as: 'userId' end end class StudentSubmission # @private class Representation < Google::Apis::Core::JsonRepresentation property :alternate_link, as: 'alternateLink' property :assigned_grade, as: 'assignedGrade' property :assignment_submission, as: 'assignmentSubmission', class: Google::Apis::ClassroomV1::AssignmentSubmission, decorator: Google::Apis::ClassroomV1::AssignmentSubmission::Representation property :associated_with_developer, as: 'associatedWithDeveloper' property :course_id, as: 'courseId' property :course_work_id, as: 'courseWorkId' property :course_work_type, as: 'courseWorkType' property :creation_time, as: 'creationTime' property :draft_grade, as: 'draftGrade' property :id, as: 'id' property :late, as: 'late' property :multiple_choice_submission, as: 'multipleChoiceSubmission', class: Google::Apis::ClassroomV1::MultipleChoiceSubmission, decorator: Google::Apis::ClassroomV1::MultipleChoiceSubmission::Representation property :short_answer_submission, as: 'shortAnswerSubmission', class: Google::Apis::ClassroomV1::ShortAnswerSubmission, decorator: Google::Apis::ClassroomV1::ShortAnswerSubmission::Representation property :state, as: 'state' collection :submission_history, as: 'submissionHistory', class: Google::Apis::ClassroomV1::SubmissionHistory, decorator: Google::Apis::ClassroomV1::SubmissionHistory::Representation property :update_time, as: 'updateTime' property :user_id, as: 'userId' end end class SubmissionHistory # @private class Representation < Google::Apis::Core::JsonRepresentation property :grade_history, as: 'gradeHistory', class: Google::Apis::ClassroomV1::GradeHistory, decorator: Google::Apis::ClassroomV1::GradeHistory::Representation property :state_history, as: 'stateHistory', class: Google::Apis::ClassroomV1::StateHistory, decorator: Google::Apis::ClassroomV1::StateHistory::Representation end end class Teacher # @private class Representation < Google::Apis::Core::JsonRepresentation property :course_id, as: 'courseId' property :profile, as: 'profile', class: Google::Apis::ClassroomV1::UserProfile, decorator: Google::Apis::ClassroomV1::UserProfile::Representation property :user_id, as: 'userId' 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 Topic # @private class Representation < Google::Apis::Core::JsonRepresentation property :course_id, as: 'courseId' property :name, as: 'name' property :topic_id, as: 'topicId' property :update_time, as: 'updateTime' end end class TurnInStudentSubmissionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class UserProfile # @private class Representation < Google::Apis::Core::JsonRepresentation property :email_address, as: 'emailAddress' property :id, as: 'id' property :name, as: 'name', class: Google::Apis::ClassroomV1::Name, decorator: Google::Apis::ClassroomV1::Name::Representation collection :permissions, as: 'permissions', class: Google::Apis::ClassroomV1::GlobalPermission, decorator: Google::Apis::ClassroomV1::GlobalPermission::Representation property :photo_url, as: 'photoUrl' property :verified_teacher, as: 'verifiedTeacher' end end class YouTubeVideo # @private class Representation < Google::Apis::Core::JsonRepresentation property :alternate_link, as: 'alternateLink' property :id, as: 'id' property :thumbnail_url, as: 'thumbnailUrl' property :title, as: 'title' end end end end end google-api-client-0.19.8/generated/google/apis/classroom_v1/classes.rb0000644000004100000410000024361613252673043025721 0ustar www-datawww-data# 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 ClassroomV1 # Announcement created by a teacher for students of the course class Announcement include Google::Apis::Core::Hashable # Absolute link to this announcement in the Classroom web UI. # This is only populated if `state` is `PUBLISHED`. # Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link # Assignee mode of the announcement. # If unspecified, the default value is `ALL_STUDENTS`. # Corresponds to the JSON property `assigneeMode` # @return [String] attr_accessor :assignee_mode # Identifier of the course. # Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id # Timestamp when this announcement was created. # Read-only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time # Identifier for the user that created the announcement. # Read-only. # Corresponds to the JSON property `creatorUserId` # @return [String] attr_accessor :creator_user_id # Classroom-assigned identifier of this announcement, unique per course. # Read-only. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Assignee details about a coursework/announcement. # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Corresponds to the JSON property `individualStudentsOptions` # @return [Google::Apis::ClassroomV1::IndividualStudentsOptions] attr_accessor :individual_students_options # Additional materials. # Announcements must have no more than 20 material items. # Corresponds to the JSON property `materials` # @return [Array] attr_accessor :materials # Optional timestamp when this announcement is scheduled to be published. # Corresponds to the JSON property `scheduledTime` # @return [String] attr_accessor :scheduled_time # Status of this announcement. # If unspecified, the default state is `DRAFT`. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Description of this announcement. # The text must be a valid UTF-8 string containing no more # than 30,000 characters. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text # Timestamp of the most recent change to this announcement. # Read-only. # 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) @alternate_link = args[:alternate_link] if args.key?(:alternate_link) @assignee_mode = args[:assignee_mode] if args.key?(:assignee_mode) @course_id = args[:course_id] if args.key?(:course_id) @creation_time = args[:creation_time] if args.key?(:creation_time) @creator_user_id = args[:creator_user_id] if args.key?(:creator_user_id) @id = args[:id] if args.key?(:id) @individual_students_options = args[:individual_students_options] if args.key?(:individual_students_options) @materials = args[:materials] if args.key?(:materials) @scheduled_time = args[:scheduled_time] if args.key?(:scheduled_time) @state = args[:state] if args.key?(:state) @text = args[:text] if args.key?(:text) @update_time = args[:update_time] if args.key?(:update_time) end end # Additional details for assignments. class Assignment include Google::Apis::Core::Hashable # Representation of a Google Drive folder. # Corresponds to the JSON property `studentWorkFolder` # @return [Google::Apis::ClassroomV1::DriveFolder] attr_accessor :student_work_folder def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @student_work_folder = args[:student_work_folder] if args.key?(:student_work_folder) end end # Student work for an assignment. class AssignmentSubmission include Google::Apis::Core::Hashable # Attachments added by the student. # Drive files that correspond to materials with a share mode of # STUDENT_COPY may not exist yet if the student has not accessed the # assignment in Classroom. # Some attachment metadata is only populated if the requesting user has # permission to access it. Identifier and alternate_link fields are always # available, but others (e.g. title) may not be. # Corresponds to the JSON property `attachments` # @return [Array] attr_accessor :attachments def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @attachments = args[:attachments] if args.key?(:attachments) end end # Attachment added to student assignment work. # When creating attachments, setting the `form` field is not supported. class Attachment include Google::Apis::Core::Hashable # Representation of a Google Drive file. # Corresponds to the JSON property `driveFile` # @return [Google::Apis::ClassroomV1::DriveFile] attr_accessor :drive_file # Google Forms item. # Corresponds to the JSON property `form` # @return [Google::Apis::ClassroomV1::Form] attr_accessor :form # URL item. # Corresponds to the JSON property `link` # @return [Google::Apis::ClassroomV1::Link] attr_accessor :link # YouTube video item. # Corresponds to the JSON property `youTubeVideo` # @return [Google::Apis::ClassroomV1::YouTubeVideo] attr_accessor :you_tube_video def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @drive_file = args[:drive_file] if args.key?(:drive_file) @form = args[:form] if args.key?(:form) @link = args[:link] if args.key?(:link) @you_tube_video = args[:you_tube_video] if args.key?(:you_tube_video) end end # A reference to a Cloud Pub/Sub topic. # To register for notifications, the owner of the topic must grant # `classroom-notifications@system.gserviceaccount.com` the # `projects.topics.publish` permission. class CloudPubsubTopic include Google::Apis::Core::Hashable # The `name` field of a Cloud Pub/Sub # [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics# # Topic). # Corresponds to the JSON property `topicName` # @return [String] attr_accessor :topic_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @topic_name = args[:topic_name] if args.key?(:topic_name) end end # A Course in Classroom. class Course include Google::Apis::Core::Hashable # Absolute link to this course in the Classroom web UI. # Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link # The Calendar ID for a calendar that all course members can see, to which # Classroom adds events for course work and announcements in the course. # Read-only. # Corresponds to the JSON property `calendarId` # @return [String] attr_accessor :calendar_id # The email address of a Google group containing all members of the course. # This group does not accept email and can only be used for permissions. # Read-only. # Corresponds to the JSON property `courseGroupEmail` # @return [String] attr_accessor :course_group_email # Sets of materials that appear on the "about" page of this course. # Read-only. # Corresponds to the JSON property `courseMaterialSets` # @return [Array] attr_accessor :course_material_sets # State of the course. # If unspecified, the default state is `PROVISIONED`. # Corresponds to the JSON property `courseState` # @return [String] attr_accessor :course_state # Creation time of the course. # Specifying this field in a course update mask results in an error. # Read-only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time # Optional description. # For example, "We'll be learning about the structure of living # creatures from a combination of textbooks, guest lectures, and lab work. # Expect to be excited!" # If set, this field must be a valid UTF-8 string and no longer than 30,000 # characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional heading for the description. # For example, "Welcome to 10th Grade Biology." # If set, this field must be a valid UTF-8 string and no longer than 3600 # characters. # Corresponds to the JSON property `descriptionHeading` # @return [String] attr_accessor :description_heading # Enrollment code to use when joining this course. # Specifying this field in a course update mask results in an error. # Read-only. # Corresponds to the JSON property `enrollmentCode` # @return [String] attr_accessor :enrollment_code # Whether or not guardian notifications are enabled for this course. # Read-only. # Corresponds to the JSON property `guardiansEnabled` # @return [Boolean] attr_accessor :guardians_enabled alias_method :guardians_enabled?, :guardians_enabled # Identifier for this course assigned by Classroom. # When # creating a course, # you may optionally set this identifier to an # alias string in the # request to create a corresponding alias. The `id` is still assigned by # Classroom and cannot be updated after the course is created. # Specifying this field in a course update mask results in an error. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Name of the course. # For example, "10th Grade Biology". # The name is required. It must be between 1 and 750 characters and a valid # UTF-8 string. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The identifier of the owner of a course. # When specified as a parameter of a # create course request, this # field is required. # The identifier can be one of the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # This must be set in a create request. Admins can also specify this field # in a patch course request to # transfer ownership. In other contexts, it is read-only. # Corresponds to the JSON property `ownerId` # @return [String] attr_accessor :owner_id # Optional room location. # For example, "301". # If set, this field must be a valid UTF-8 string and no longer than 650 # characters. # Corresponds to the JSON property `room` # @return [String] attr_accessor :room # Section of the course. # For example, "Period 2". # If set, this field must be a valid UTF-8 string and no longer than 2800 # characters. # Corresponds to the JSON property `section` # @return [String] attr_accessor :section # Representation of a Google Drive folder. # Corresponds to the JSON property `teacherFolder` # @return [Google::Apis::ClassroomV1::DriveFolder] attr_accessor :teacher_folder # The email address of a Google group containing all teachers of the course. # This group does not accept email and can only be used for permissions. # Read-only. # Corresponds to the JSON property `teacherGroupEmail` # @return [String] attr_accessor :teacher_group_email # Time of the most recent update to this course. # Specifying this field in a course update mask results in an error. # Read-only. # 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) @alternate_link = args[:alternate_link] if args.key?(:alternate_link) @calendar_id = args[:calendar_id] if args.key?(:calendar_id) @course_group_email = args[:course_group_email] if args.key?(:course_group_email) @course_material_sets = args[:course_material_sets] if args.key?(:course_material_sets) @course_state = args[:course_state] if args.key?(:course_state) @creation_time = args[:creation_time] if args.key?(:creation_time) @description = args[:description] if args.key?(:description) @description_heading = args[:description_heading] if args.key?(:description_heading) @enrollment_code = args[:enrollment_code] if args.key?(:enrollment_code) @guardians_enabled = args[:guardians_enabled] if args.key?(:guardians_enabled) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @owner_id = args[:owner_id] if args.key?(:owner_id) @room = args[:room] if args.key?(:room) @section = args[:section] if args.key?(:section) @teacher_folder = args[:teacher_folder] if args.key?(:teacher_folder) @teacher_group_email = args[:teacher_group_email] if args.key?(:teacher_group_email) @update_time = args[:update_time] if args.key?(:update_time) end end # Alternative identifier for a course. # An alias uniquely identifies a course. It must be unique within one of the # following scopes: # * domain: A domain-scoped alias is visible to all users within the alias # creator's domain and can be created only by a domain admin. A domain-scoped # alias is often used when a course has an identifier external to Classroom. # * project: A project-scoped alias is visible to any request from an # application using the Developer Console project ID that created the alias # and can be created by any project. A project-scoped alias is often used when # an application has alternative identifiers. A random value can also be used # to avoid duplicate courses in the event of transmission failures, as retrying # a request will return `ALREADY_EXISTS` if a previous one has succeeded. class CourseAlias include Google::Apis::Core::Hashable # Alias string. The format of the string indicates the desired alias scoping. # * `d:` indicates a domain-scoped alias. # Example: `d:math_101` # * `p:` indicates a project-scoped alias. # Example: `p:abc123` # This field has a maximum length of 256 characters. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alias = args[:alias] if args.key?(:alias) end end # A material attached to a course as part of a material set. class CourseMaterial include Google::Apis::Core::Hashable # Representation of a Google Drive file. # Corresponds to the JSON property `driveFile` # @return [Google::Apis::ClassroomV1::DriveFile] attr_accessor :drive_file # Google Forms item. # Corresponds to the JSON property `form` # @return [Google::Apis::ClassroomV1::Form] attr_accessor :form # URL item. # Corresponds to the JSON property `link` # @return [Google::Apis::ClassroomV1::Link] attr_accessor :link # YouTube video item. # Corresponds to the JSON property `youTubeVideo` # @return [Google::Apis::ClassroomV1::YouTubeVideo] attr_accessor :you_tube_video def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @drive_file = args[:drive_file] if args.key?(:drive_file) @form = args[:form] if args.key?(:form) @link = args[:link] if args.key?(:link) @you_tube_video = args[:you_tube_video] if args.key?(:you_tube_video) end end # A set of materials that appears on the "About" page of the course. # These materials might include a syllabus, schedule, or other background # information relating to the course as a whole. class CourseMaterialSet include Google::Apis::Core::Hashable # Materials attached to this set. # Corresponds to the JSON property `materials` # @return [Array] attr_accessor :materials # Title for this set. # 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) @materials = args[:materials] if args.key?(:materials) @title = args[:title] if args.key?(:title) end end # Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. class CourseRosterChangesInfo include Google::Apis::Core::Hashable # The `course_id` of the course to subscribe to roster changes for. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @course_id = args[:course_id] if args.key?(:course_id) end end # Course work created by a teacher for students of the course. class CourseWork include Google::Apis::Core::Hashable # Absolute link to this course work in the Classroom web UI. # This is only populated if `state` is `PUBLISHED`. # Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link # Assignee mode of the coursework. # If unspecified, the default value is `ALL_STUDENTS`. # Corresponds to the JSON property `assigneeMode` # @return [String] attr_accessor :assignee_mode # Additional details for assignments. # Corresponds to the JSON property `assignment` # @return [Google::Apis::ClassroomV1::Assignment] attr_accessor :assignment # Whether this course work item is associated with the Developer Console # project making the request. # See google.classroom.Work.CreateCourseWork for more # details. # Read-only. # Corresponds to the JSON property `associatedWithDeveloper` # @return [Boolean] attr_accessor :associated_with_developer alias_method :associated_with_developer?, :associated_with_developer # Identifier of the course. # Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id # Timestamp when this course work was created. # Read-only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time # Identifier for the user that created the coursework. # Read-only. # Corresponds to the JSON property `creatorUserId` # @return [String] attr_accessor :creator_user_id # Optional description of this course work. # If set, the description must be a valid UTF-8 string containing no more # than 30,000 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary date. Related types are google.type.TimeOfDay # and `google.protobuf.Timestamp`. # Corresponds to the JSON property `dueDate` # @return [Google::Apis::ClassroomV1::Date] attr_accessor :due_date # 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 `dueTime` # @return [Google::Apis::ClassroomV1::TimeOfDay] attr_accessor :due_time # Classroom-assigned identifier of this course work, unique per course. # Read-only. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Assignee details about a coursework/announcement. # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Corresponds to the JSON property `individualStudentsOptions` # @return [Google::Apis::ClassroomV1::IndividualStudentsOptions] attr_accessor :individual_students_options # Additional materials. # CourseWork must have no more than 20 material items. # Corresponds to the JSON property `materials` # @return [Array] attr_accessor :materials # Maximum grade for this course work. # If zero or unspecified, this assignment is considered ungraded. # This must be a non-negative integer value. # Corresponds to the JSON property `maxPoints` # @return [Float] attr_accessor :max_points # Additional details for multiple-choice questions. # Corresponds to the JSON property `multipleChoiceQuestion` # @return [Google::Apis::ClassroomV1::MultipleChoiceQuestion] attr_accessor :multiple_choice_question # Optional timestamp when this course work is scheduled to be published. # Corresponds to the JSON property `scheduledTime` # @return [String] attr_accessor :scheduled_time # Status of this course work. # If unspecified, the default state is `DRAFT`. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Setting to determine when students are allowed to modify submissions. # If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. # Corresponds to the JSON property `submissionModificationMode` # @return [String] attr_accessor :submission_modification_mode # Title of this course work. # The title must be a valid UTF-8 string containing between 1 and 3000 # characters. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Timestamp of the most recent change to this course work. # Read-only. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Type of this course work. # The type is set when the course work is created and cannot be changed. # Corresponds to the JSON property `workType` # @return [String] attr_accessor :work_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alternate_link = args[:alternate_link] if args.key?(:alternate_link) @assignee_mode = args[:assignee_mode] if args.key?(:assignee_mode) @assignment = args[:assignment] if args.key?(:assignment) @associated_with_developer = args[:associated_with_developer] if args.key?(:associated_with_developer) @course_id = args[:course_id] if args.key?(:course_id) @creation_time = args[:creation_time] if args.key?(:creation_time) @creator_user_id = args[:creator_user_id] if args.key?(:creator_user_id) @description = args[:description] if args.key?(:description) @due_date = args[:due_date] if args.key?(:due_date) @due_time = args[:due_time] if args.key?(:due_time) @id = args[:id] if args.key?(:id) @individual_students_options = args[:individual_students_options] if args.key?(:individual_students_options) @materials = args[:materials] if args.key?(:materials) @max_points = args[:max_points] if args.key?(:max_points) @multiple_choice_question = args[:multiple_choice_question] if args.key?(:multiple_choice_question) @scheduled_time = args[:scheduled_time] if args.key?(:scheduled_time) @state = args[:state] if args.key?(:state) @submission_modification_mode = args[:submission_modification_mode] if args.key?(:submission_modification_mode) @title = args[:title] if args.key?(:title) @update_time = args[:update_time] if args.key?(:update_time) @work_type = args[:work_type] if args.key?(:work_type) end end # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary 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/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. # 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 # Representation of a Google Drive file. class DriveFile include Google::Apis::Core::Hashable # URL that can be used to access the Drive item. # Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link # Drive API resource ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # URL of a thumbnail image of the Drive item. # Read-only. # Corresponds to the JSON property `thumbnailUrl` # @return [String] attr_accessor :thumbnail_url # Title of the Drive item. # Read-only. # 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) @alternate_link = args[:alternate_link] if args.key?(:alternate_link) @id = args[:id] if args.key?(:id) @thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url) @title = args[:title] if args.key?(:title) end end # Representation of a Google Drive folder. class DriveFolder include Google::Apis::Core::Hashable # URL that can be used to access the Drive folder. # Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link # Drive API resource ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Title of the Drive folder. # Read-only. # 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) @alternate_link = args[:alternate_link] if args.key?(:alternate_link) @id = args[:id] if args.key?(:id) @title = args[:title] if args.key?(:title) 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 class of notifications that an application can register to receive. # For example: "all roster changes for a domain". class Feed include Google::Apis::Core::Hashable # Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. # Corresponds to the JSON property `courseRosterChangesInfo` # @return [Google::Apis::ClassroomV1::CourseRosterChangesInfo] attr_accessor :course_roster_changes_info # The type of feed. # Corresponds to the JSON property `feedType` # @return [String] attr_accessor :feed_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @course_roster_changes_info = args[:course_roster_changes_info] if args.key?(:course_roster_changes_info) @feed_type = args[:feed_type] if args.key?(:feed_type) end end # Google Forms item. class Form include Google::Apis::Core::Hashable # URL of the form. # Corresponds to the JSON property `formUrl` # @return [String] attr_accessor :form_url # URL of the form responses document. # Only set if respsonses have been recorded and only when the # requesting user is an editor of the form. # Read-only. # Corresponds to the JSON property `responseUrl` # @return [String] attr_accessor :response_url # URL of a thumbnail image of the Form. # Read-only. # Corresponds to the JSON property `thumbnailUrl` # @return [String] attr_accessor :thumbnail_url # Title of the Form. # Read-only. # 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) @form_url = args[:form_url] if args.key?(:form_url) @response_url = args[:response_url] if args.key?(:response_url) @thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url) @title = args[:title] if args.key?(:title) end end # Global user permission description. class GlobalPermission include Google::Apis::Core::Hashable # Permission value. # Corresponds to the JSON property `permission` # @return [String] attr_accessor :permission def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permission = args[:permission] if args.key?(:permission) end end # The history of each grade on this submission. class GradeHistory include Google::Apis::Core::Hashable # The teacher who made the grade change. # Corresponds to the JSON property `actorUserId` # @return [String] attr_accessor :actor_user_id # The type of grade change at this time in the submission grade history. # Corresponds to the JSON property `gradeChangeType` # @return [String] attr_accessor :grade_change_type # When the grade of the submission was changed. # Corresponds to the JSON property `gradeTimestamp` # @return [String] attr_accessor :grade_timestamp # The denominator of the grade at this time in the submission grade # history. # Corresponds to the JSON property `maxPoints` # @return [Float] attr_accessor :max_points # The numerator of the grade at this time in the submission grade history. # Corresponds to the JSON property `pointsEarned` # @return [Float] attr_accessor :points_earned def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @actor_user_id = args[:actor_user_id] if args.key?(:actor_user_id) @grade_change_type = args[:grade_change_type] if args.key?(:grade_change_type) @grade_timestamp = args[:grade_timestamp] if args.key?(:grade_timestamp) @max_points = args[:max_points] if args.key?(:max_points) @points_earned = args[:points_earned] if args.key?(:points_earned) end end # Association between a student and a guardian of that student. The guardian # may receive information about the student's course work. class Guardian include Google::Apis::Core::Hashable # Identifier for the guardian. # Corresponds to the JSON property `guardianId` # @return [String] attr_accessor :guardian_id # Global information for a user. # Corresponds to the JSON property `guardianProfile` # @return [Google::Apis::ClassroomV1::UserProfile] attr_accessor :guardian_profile # The email address to which the initial guardian invitation was sent. # This field is only visible to domain administrators. # Corresponds to the JSON property `invitedEmailAddress` # @return [String] attr_accessor :invited_email_address # Identifier for the student to whom the guardian relationship applies. # Corresponds to the JSON property `studentId` # @return [String] attr_accessor :student_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @guardian_id = args[:guardian_id] if args.key?(:guardian_id) @guardian_profile = args[:guardian_profile] if args.key?(:guardian_profile) @invited_email_address = args[:invited_email_address] if args.key?(:invited_email_address) @student_id = args[:student_id] if args.key?(:student_id) end end # An invitation to become the guardian of a specified user, sent to a specified # email address. class GuardianInvitation include Google::Apis::Core::Hashable # The time that this invitation was created. # Read-only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time # Unique identifier for this invitation. # Read-only. # Corresponds to the JSON property `invitationId` # @return [String] attr_accessor :invitation_id # Email address that the invitation was sent to. # This field is only visible to domain administrators. # Corresponds to the JSON property `invitedEmailAddress` # @return [String] attr_accessor :invited_email_address # The state that this invitation is in. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # ID of the student (in standard format) # Corresponds to the JSON property `studentId` # @return [String] attr_accessor :student_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_time = args[:creation_time] if args.key?(:creation_time) @invitation_id = args[:invitation_id] if args.key?(:invitation_id) @invited_email_address = args[:invited_email_address] if args.key?(:invited_email_address) @state = args[:state] if args.key?(:state) @student_id = args[:student_id] if args.key?(:student_id) end end # Assignee details about a coursework/announcement. # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. class IndividualStudentsOptions include Google::Apis::Core::Hashable # Identifiers for the students that have access to the # coursework/announcement. # Corresponds to the JSON property `studentIds` # @return [Array] attr_accessor :student_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @student_ids = args[:student_ids] if args.key?(:student_ids) end end # An invitation to join a course. class Invitation include Google::Apis::Core::Hashable # Identifier of the course to invite the user to. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id # Identifier assigned by Classroom. # Read-only. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Role to invite the user to have. # Must not be `COURSE_ROLE_UNSPECIFIED`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role # Identifier of the invited user. # When specified as a parameter of a request, this identifier can be set to # one of the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @course_id = args[:course_id] if args.key?(:course_id) @id = args[:id] if args.key?(:id) @role = args[:role] if args.key?(:role) @user_id = args[:user_id] if args.key?(:user_id) end end # URL item. class Link include Google::Apis::Core::Hashable # URL of a thumbnail image of the target URL. # Read-only. # Corresponds to the JSON property `thumbnailUrl` # @return [String] attr_accessor :thumbnail_url # Title of the target of the URL. # Read-only. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # URL to link to. # This must be a valid UTF-8 string containing between 1 and 2024 characters. # 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) @thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url) @title = args[:title] if args.key?(:title) @url = args[:url] if args.key?(:url) end end # Response when listing course work. class ListAnnouncementsResponse include Google::Apis::Core::Hashable # Announcement items that match the request. # Corresponds to the JSON property `announcements` # @return [Array] attr_accessor :announcements # Token identifying the next page of results to return. If empty, no further # results are available. # 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) @announcements = args[:announcements] if args.key?(:announcements) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response when listing course aliases. class ListCourseAliasesResponse include Google::Apis::Core::Hashable # The course aliases. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases # Token identifying the next page of results to return. If empty, no further # results are available. # 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) @aliases = args[:aliases] if args.key?(:aliases) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response when listing course work. class ListCourseWorkResponse include Google::Apis::Core::Hashable # Course work items that match the request. # Corresponds to the JSON property `courseWork` # @return [Array] attr_accessor :course_work # Token identifying the next page of results to return. If empty, no further # results are available. # 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) @course_work = args[:course_work] if args.key?(:course_work) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response when listing courses. class ListCoursesResponse include Google::Apis::Core::Hashable # Courses that match the list request. # Corresponds to the JSON property `courses` # @return [Array] attr_accessor :courses # Token identifying the next page of results to return. If empty, no further # results are available. # 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) @courses = args[:courses] if args.key?(:courses) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response when listing guardian invitations. class ListGuardianInvitationsResponse include Google::Apis::Core::Hashable # Guardian invitations that matched the list request. # Corresponds to the JSON property `guardianInvitations` # @return [Array] attr_accessor :guardian_invitations # Token identifying the next page of results to return. If empty, no further # results are available. # 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) @guardian_invitations = args[:guardian_invitations] if args.key?(:guardian_invitations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response when listing guardians. class ListGuardiansResponse include Google::Apis::Core::Hashable # Guardians on this page of results that met the criteria specified in # the request. # Corresponds to the JSON property `guardians` # @return [Array] attr_accessor :guardians # Token identifying the next page of results to return. If empty, no further # results are available. # 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) @guardians = args[:guardians] if args.key?(:guardians) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response when listing invitations. class ListInvitationsResponse include Google::Apis::Core::Hashable # Invitations that match the list request. # Corresponds to the JSON property `invitations` # @return [Array] attr_accessor :invitations # Token identifying the next page of results to return. If empty, no further # results are available. # 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) @invitations = args[:invitations] if args.key?(:invitations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response when listing student submissions. class ListStudentSubmissionsResponse include Google::Apis::Core::Hashable # Token identifying the next page of results to return. If empty, no further # results are available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Student work that matches the request. # Corresponds to the JSON property `studentSubmissions` # @return [Array] attr_accessor :student_submissions 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) @student_submissions = args[:student_submissions] if args.key?(:student_submissions) end end # Response when listing students. class ListStudentsResponse include Google::Apis::Core::Hashable # Token identifying the next page of results to return. If empty, no further # results are available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Students who match the list request. # Corresponds to the JSON property `students` # @return [Array] attr_accessor :students 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) @students = args[:students] if args.key?(:students) end end # Response when listing teachers. class ListTeachersResponse include Google::Apis::Core::Hashable # Token identifying the next page of results to return. If empty, no further # results are available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Teachers who match the list request. # Corresponds to the JSON property `teachers` # @return [Array] attr_accessor :teachers 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) @teachers = args[:teachers] if args.key?(:teachers) end end # Response when listing topics. class ListTopicResponse include Google::Apis::Core::Hashable # Token identifying the next page of results to return. If empty, no further # results are available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Topic items that match the request. # Corresponds to the JSON property `topic` # @return [Array] attr_accessor :topic 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) @topic = args[:topic] if args.key?(:topic) end end # Material attached to course work. # When creating attachments, setting the `form` field is not supported. class Material include Google::Apis::Core::Hashable # Drive file that is used as material for course work. # Corresponds to the JSON property `driveFile` # @return [Google::Apis::ClassroomV1::SharedDriveFile] attr_accessor :drive_file # Google Forms item. # Corresponds to the JSON property `form` # @return [Google::Apis::ClassroomV1::Form] attr_accessor :form # URL item. # Corresponds to the JSON property `link` # @return [Google::Apis::ClassroomV1::Link] attr_accessor :link # YouTube video item. # Corresponds to the JSON property `youtubeVideo` # @return [Google::Apis::ClassroomV1::YouTubeVideo] attr_accessor :youtube_video def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @drive_file = args[:drive_file] if args.key?(:drive_file) @form = args[:form] if args.key?(:form) @link = args[:link] if args.key?(:link) @youtube_video = args[:youtube_video] if args.key?(:youtube_video) end end # Request to modify assignee mode and options of an announcement. class ModifyAnnouncementAssigneesRequest include Google::Apis::Core::Hashable # Mode of the announcement describing whether it will be accessible by all # students or specified individual students. # Corresponds to the JSON property `assigneeMode` # @return [String] attr_accessor :assignee_mode # Contains fields to add or remove students from a course work or announcement # where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`. # Corresponds to the JSON property `modifyIndividualStudentsOptions` # @return [Google::Apis::ClassroomV1::ModifyIndividualStudentsOptions] attr_accessor :modify_individual_students_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @assignee_mode = args[:assignee_mode] if args.key?(:assignee_mode) @modify_individual_students_options = args[:modify_individual_students_options] if args.key?(:modify_individual_students_options) end end # Request to modify the attachments of a student submission. class ModifyAttachmentsRequest include Google::Apis::Core::Hashable # Attachments to add. # A student submission may not have more than 20 attachments. # Form attachments are not supported. # Corresponds to the JSON property `addAttachments` # @return [Array] attr_accessor :add_attachments def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @add_attachments = args[:add_attachments] if args.key?(:add_attachments) end end # Request to modify assignee mode and options of a coursework. class ModifyCourseWorkAssigneesRequest include Google::Apis::Core::Hashable # Mode of the coursework describing whether it will be assigned to all # students or specified individual students. # Corresponds to the JSON property `assigneeMode` # @return [String] attr_accessor :assignee_mode # Contains fields to add or remove students from a course work or announcement # where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`. # Corresponds to the JSON property `modifyIndividualStudentsOptions` # @return [Google::Apis::ClassroomV1::ModifyIndividualStudentsOptions] attr_accessor :modify_individual_students_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @assignee_mode = args[:assignee_mode] if args.key?(:assignee_mode) @modify_individual_students_options = args[:modify_individual_students_options] if args.key?(:modify_individual_students_options) end end # Contains fields to add or remove students from a course work or announcement # where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`. class ModifyIndividualStudentsOptions include Google::Apis::Core::Hashable # Ids of students to be added as having access to this # coursework/announcement. # Corresponds to the JSON property `addStudentIds` # @return [Array] attr_accessor :add_student_ids # Ids of students to be removed from having access to this # coursework/announcement. # Corresponds to the JSON property `removeStudentIds` # @return [Array] attr_accessor :remove_student_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @add_student_ids = args[:add_student_ids] if args.key?(:add_student_ids) @remove_student_ids = args[:remove_student_ids] if args.key?(:remove_student_ids) end end # Additional details for multiple-choice questions. class MultipleChoiceQuestion include Google::Apis::Core::Hashable # Possible choices. # Corresponds to the JSON property `choices` # @return [Array] attr_accessor :choices def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @choices = args[:choices] if args.key?(:choices) end end # Student work for a multiple-choice question. class MultipleChoiceSubmission include Google::Apis::Core::Hashable # Student's select choice. # Corresponds to the JSON property `answer` # @return [String] attr_accessor :answer def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @answer = args[:answer] if args.key?(:answer) end end # Details of the user's name. class Name include Google::Apis::Core::Hashable # The user's last name. # Read-only. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name # The user's full name formed by concatenating the first and last name # values. # Read-only. # Corresponds to the JSON property `fullName` # @return [String] attr_accessor :full_name # The user's first name. # Read-only. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @family_name = args[:family_name] if args.key?(:family_name) @full_name = args[:full_name] if args.key?(:full_name) @given_name = args[:given_name] if args.key?(:given_name) end end # Request to reclaim a student submission. class ReclaimStudentSubmissionRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # An instruction to Classroom to send notifications from the `feed` to the # provided `destination`. class Registration include Google::Apis::Core::Hashable # A reference to a Cloud Pub/Sub topic. # To register for notifications, the owner of the topic must grant # `classroom-notifications@system.gserviceaccount.com` the # `projects.topics.publish` permission. # Corresponds to the JSON property `cloudPubsubTopic` # @return [Google::Apis::ClassroomV1::CloudPubsubTopic] attr_accessor :cloud_pubsub_topic # The time until which the `Registration` is effective. # This is a read-only field assigned by the server. # Corresponds to the JSON property `expiryTime` # @return [String] attr_accessor :expiry_time # A class of notifications that an application can register to receive. # For example: "all roster changes for a domain". # Corresponds to the JSON property `feed` # @return [Google::Apis::ClassroomV1::Feed] attr_accessor :feed # A server-generated unique identifier for this `Registration`. # Read-only. # Corresponds to the JSON property `registrationId` # @return [String] attr_accessor :registration_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cloud_pubsub_topic = args[:cloud_pubsub_topic] if args.key?(:cloud_pubsub_topic) @expiry_time = args[:expiry_time] if args.key?(:expiry_time) @feed = args[:feed] if args.key?(:feed) @registration_id = args[:registration_id] if args.key?(:registration_id) end end # Request to return a student submission. class ReturnStudentSubmissionRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Drive file that is used as material for course work. class SharedDriveFile include Google::Apis::Core::Hashable # Representation of a Google Drive file. # Corresponds to the JSON property `driveFile` # @return [Google::Apis::ClassroomV1::DriveFile] attr_accessor :drive_file # Mechanism by which students access the Drive item. # Corresponds to the JSON property `shareMode` # @return [String] attr_accessor :share_mode def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @drive_file = args[:drive_file] if args.key?(:drive_file) @share_mode = args[:share_mode] if args.key?(:share_mode) end end # Student work for a short answer question. class ShortAnswerSubmission include Google::Apis::Core::Hashable # Student response to a short-answer question. # Corresponds to the JSON property `answer` # @return [String] attr_accessor :answer def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @answer = args[:answer] if args.key?(:answer) end end # The history of each state this submission has been in. class StateHistory include Google::Apis::Core::Hashable # The teacher or student who made the change # Corresponds to the JSON property `actorUserId` # @return [String] attr_accessor :actor_user_id # The workflow pipeline stage. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # When the submission entered this state. # Corresponds to the JSON property `stateTimestamp` # @return [String] attr_accessor :state_timestamp def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @actor_user_id = args[:actor_user_id] if args.key?(:actor_user_id) @state = args[:state] if args.key?(:state) @state_timestamp = args[:state_timestamp] if args.key?(:state_timestamp) end end # Student in a course. class Student include Google::Apis::Core::Hashable # Identifier of the course. # Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id # Global information for a user. # Corresponds to the JSON property `profile` # @return [Google::Apis::ClassroomV1::UserProfile] attr_accessor :profile # Representation of a Google Drive folder. # Corresponds to the JSON property `studentWorkFolder` # @return [Google::Apis::ClassroomV1::DriveFolder] attr_accessor :student_work_folder # Identifier of the user. # When specified as a parameter of a request, this identifier can be one of # the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @course_id = args[:course_id] if args.key?(:course_id) @profile = args[:profile] if args.key?(:profile) @student_work_folder = args[:student_work_folder] if args.key?(:student_work_folder) @user_id = args[:user_id] if args.key?(:user_id) end end # Student submission for course work. # StudentSubmission items are generated when a CourseWork item is created. # StudentSubmissions that have never been accessed (i.e. with `state` = NEW) # may not have a creation time or update time. class StudentSubmission include Google::Apis::Core::Hashable # Absolute link to the submission in the Classroom web UI. # Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link # Optional grade. If unset, no grade was set. # This value must be non-negative. Decimal (i.e. non-integer) values are # allowed, but will be rounded to two decimal places. # This may be modified only by course teachers. # Corresponds to the JSON property `assignedGrade` # @return [Float] attr_accessor :assigned_grade # Student work for an assignment. # Corresponds to the JSON property `assignmentSubmission` # @return [Google::Apis::ClassroomV1::AssignmentSubmission] attr_accessor :assignment_submission # Whether this student submission is associated with the Developer Console # project making the request. # See google.classroom.Work.CreateCourseWork for more # details. # Read-only. # Corresponds to the JSON property `associatedWithDeveloper` # @return [Boolean] attr_accessor :associated_with_developer alias_method :associated_with_developer?, :associated_with_developer # Identifier of the course. # Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id # Identifier for the course work this corresponds to. # Read-only. # Corresponds to the JSON property `courseWorkId` # @return [String] attr_accessor :course_work_id # Type of course work this submission is for. # Read-only. # Corresponds to the JSON property `courseWorkType` # @return [String] attr_accessor :course_work_type # Creation time of this submission. # This may be unset if the student has not accessed this item. # Read-only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time # Optional pending grade. If unset, no grade was set. # This value must be non-negative. Decimal (i.e. non-integer) values are # allowed, but will be rounded to two decimal places. # This is only visible to and modifiable by course teachers. # Corresponds to the JSON property `draftGrade` # @return [Float] attr_accessor :draft_grade # Classroom-assigned Identifier for the student submission. # This is unique among submissions for the relevant course work. # Read-only. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Whether this submission is late. # Read-only. # Corresponds to the JSON property `late` # @return [Boolean] attr_accessor :late alias_method :late?, :late # Student work for a multiple-choice question. # Corresponds to the JSON property `multipleChoiceSubmission` # @return [Google::Apis::ClassroomV1::MultipleChoiceSubmission] attr_accessor :multiple_choice_submission # Student work for a short answer question. # Corresponds to the JSON property `shortAnswerSubmission` # @return [Google::Apis::ClassroomV1::ShortAnswerSubmission] attr_accessor :short_answer_submission # State of this submission. # Read-only. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # The history of the submission (includes state and grade histories). # Read-only. # Corresponds to the JSON property `submissionHistory` # @return [Array] attr_accessor :submission_history # Last update time of this submission. # This may be unset if the student has not accessed this item. # Read-only. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Identifier for the student that owns this submission. # Read-only. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alternate_link = args[:alternate_link] if args.key?(:alternate_link) @assigned_grade = args[:assigned_grade] if args.key?(:assigned_grade) @assignment_submission = args[:assignment_submission] if args.key?(:assignment_submission) @associated_with_developer = args[:associated_with_developer] if args.key?(:associated_with_developer) @course_id = args[:course_id] if args.key?(:course_id) @course_work_id = args[:course_work_id] if args.key?(:course_work_id) @course_work_type = args[:course_work_type] if args.key?(:course_work_type) @creation_time = args[:creation_time] if args.key?(:creation_time) @draft_grade = args[:draft_grade] if args.key?(:draft_grade) @id = args[:id] if args.key?(:id) @late = args[:late] if args.key?(:late) @multiple_choice_submission = args[:multiple_choice_submission] if args.key?(:multiple_choice_submission) @short_answer_submission = args[:short_answer_submission] if args.key?(:short_answer_submission) @state = args[:state] if args.key?(:state) @submission_history = args[:submission_history] if args.key?(:submission_history) @update_time = args[:update_time] if args.key?(:update_time) @user_id = args[:user_id] if args.key?(:user_id) end end # The history of the submission. This currently includes state and grade # histories. class SubmissionHistory include Google::Apis::Core::Hashable # The history of each grade on this submission. # Corresponds to the JSON property `gradeHistory` # @return [Google::Apis::ClassroomV1::GradeHistory] attr_accessor :grade_history # The history of each state this submission has been in. # Corresponds to the JSON property `stateHistory` # @return [Google::Apis::ClassroomV1::StateHistory] attr_accessor :state_history def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @grade_history = args[:grade_history] if args.key?(:grade_history) @state_history = args[:state_history] if args.key?(:state_history) end end # Teacher of a course. class Teacher include Google::Apis::Core::Hashable # Identifier of the course. # Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id # Global information for a user. # Corresponds to the JSON property `profile` # @return [Google::Apis::ClassroomV1::UserProfile] attr_accessor :profile # Identifier of the user. # When specified as a parameter of a request, this identifier can be one of # the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @course_id = args[:course_id] if args.key?(:course_id) @profile = args[:profile] if args.key?(:profile) @user_id = args[:user_id] if args.key?(:user_id) 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 # Topic created by a teacher for the course class Topic include Google::Apis::Core::Hashable # Identifier of the course. # Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id # The name of the topic, generated by the user. # Leading and trailing whitespaces, if any, will be trimmed. Also, multiple # consecutive whitespaces will be collapsed into one inside the name. # Topic names are case sensitive, and must be no longer than 100 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Unique identifier for the topic. # Read-only. # Corresponds to the JSON property `topicId` # @return [String] attr_accessor :topic_id # The time the topic was last updated by the system. # Read-only. # 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) @course_id = args[:course_id] if args.key?(:course_id) @name = args[:name] if args.key?(:name) @topic_id = args[:topic_id] if args.key?(:topic_id) @update_time = args[:update_time] if args.key?(:update_time) end end # Request to turn in a student submission. class TurnInStudentSubmissionRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Global information for a user. class UserProfile include Google::Apis::Core::Hashable # Email address of the user. # Read-only. # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address # Identifier of the user. # Read-only. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Details of the user's name. # Corresponds to the JSON property `name` # @return [Google::Apis::ClassroomV1::Name] attr_accessor :name # Global permissions of the user. # Read-only. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions # URL of user's profile photo. # Read-only. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url # Represents whether a G Suite for Education user's domain administrator has # explicitly verified them as being a teacher. If the user is not a member of # a G Suite for Education domain, than this field will always be false. # Read-only # Corresponds to the JSON property `verifiedTeacher` # @return [Boolean] attr_accessor :verified_teacher alias_method :verified_teacher?, :verified_teacher def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email_address = args[:email_address] if args.key?(:email_address) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @permissions = args[:permissions] if args.key?(:permissions) @photo_url = args[:photo_url] if args.key?(:photo_url) @verified_teacher = args[:verified_teacher] if args.key?(:verified_teacher) end end # YouTube video item. class YouTubeVideo include Google::Apis::Core::Hashable # URL that can be used to view the YouTube video. # Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link # YouTube API resource ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # URL of a thumbnail image of the YouTube video. # Read-only. # Corresponds to the JSON property `thumbnailUrl` # @return [String] attr_accessor :thumbnail_url # Title of the YouTube video. # Read-only. # 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) @alternate_link = args[:alternate_link] if args.key?(:alternate_link) @id = args[:id] if args.key?(:id) @thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url) @title = args[:title] if args.key?(:title) end end end end end google-api-client-0.19.8/generated/google/apis/classroom_v1/service.rb0000644000004100000410000047576513252673043025740 0ustar www-datawww-data# 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 ClassroomV1 # Google Classroom API # # Manages classes, rosters, and invitations in Google Classroom. # # @example # require 'google/apis/classroom_v1' # # Classroom = Google::Apis::ClassroomV1 # Alias the module # service = Classroom::ClassroomService.new # # @see https://developers.google.com/classroom/ class ClassroomService < 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://classroom.googleapis.com/', '') @batch_path = 'batch' end # Creates a course. # The user specified in `ownerId` is the owner of the created course # and added as a teacher. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to create # courses or for access errors. # * `NOT_FOUND` if the primary teacher is not a valid user. # * `FAILED_PRECONDITION` if the course owner's account is disabled or for # the following request errors: # * UserGroupsMembershipLimitReached # * `ALREADY_EXISTS` if an alias was specified in the `id` and # already exists. # @param [Google::Apis::ClassroomV1::Course] course_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::ClassroomV1::Course] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Course] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course(course_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses', options) command.request_representation = Google::Apis::ClassroomV1::Course::Representation command.request_object = course_object command.response_representation = Google::Apis::ClassroomV1::Course::Representation command.response_class = Google::Apis::ClassroomV1::Course 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 course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to delete the # requested course or for access errors. # * `NOT_FOUND` if no course exists with the requested ID. # @param [String] id # Identifier of the course to delete. # This identifier can be either the Classroom-assigned identifier or an # 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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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_course(id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/courses/{id}', options) command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['id'] = id unless 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 # Returns a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or for access errors. # * `NOT_FOUND` if no course exists with the requested ID. # @param [String] id # Identifier of the course to return. # This identifier can be either the Classroom-assigned identifier or an # 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::ClassroomV1::Course] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Course] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course(id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{id}', options) command.response_representation = Google::Apis::ClassroomV1::Course::Representation command.response_class = Google::Apis::ClassroomV1::Course command.params['id'] = id unless 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 # Returns a list of courses that the requesting user is permitted to view, # restricted to those that match the request. Returned courses are ordered by # creation time, with the most recently created coming first. # This method returns the following error codes: # * `PERMISSION_DENIED` for access errors. # * `INVALID_ARGUMENT` if the query argument is malformed. # * `NOT_FOUND` if any users specified in the query arguments do not exist. # @param [Array, String] course_states # Restricts returned courses to those in one of the specified states # The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the # server may assign a maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, # indicating that the subsequent page of results should be returned. # The list request must be # otherwise identical to the one that resulted in this token. # @param [String] student_id # Restricts returned courses to those having a student with the specified # identifier. The identifier can be one of the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @param [String] teacher_id # Restricts returned courses to those having a teacher with the specified # identifier. The identifier can be one of the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @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::ClassroomV1::ListCoursesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListCoursesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_courses(course_states: nil, page_size: nil, page_token: nil, student_id: nil, teacher_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses', options) command.response_representation = Google::Apis::ClassroomV1::ListCoursesResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListCoursesResponse command.query['courseStates'] = course_states unless course_states.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['studentId'] = student_id unless student_id.nil? command.query['teacherId'] = teacher_id unless teacher_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 one or more fields in a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to modify the # requested course or for access errors. # * `NOT_FOUND` if no course exists with the requested ID. # * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or # if no update mask is supplied. # * `FAILED_PRECONDITION` for the following request errors: # * CourseNotModifiable # @param [String] id # Identifier of the course to update. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Google::Apis::ClassroomV1::Course] course_object # @param [String] update_mask # Mask that identifies which fields on the course to update. # This field is required to do an update. The update will fail if invalid # fields are specified. The following fields are valid: # * `name` # * `section` # * `descriptionHeading` # * `description` # * `room` # * `courseState` # * `ownerId` # Note: patches to ownerId are treated as being effective immediately, but in # practice it may take some time for the ownership transfer of all affected # resources to complete. # When set in a query parameter, this field should be specified as # `updateMask=,,...` # @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::ClassroomV1::Course] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Course] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course(id, course_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/courses/{id}', options) command.request_representation = Google::Apis::ClassroomV1::Course::Representation command.request_object = course_object command.response_representation = Google::Apis::ClassroomV1::Course::Representation command.response_class = Google::Apis::ClassroomV1::Course command.params['id'] = id unless 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 # Updates a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to modify the # requested course or for access errors. # * `NOT_FOUND` if no course exists with the requested ID. # * `FAILED_PRECONDITION` for the following request errors: # * CourseNotModifiable # @param [String] id # Identifier of the course to update. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Google::Apis::ClassroomV1::Course] course_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::ClassroomV1::Course] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Course] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course(id, course_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/courses/{id}', options) command.request_representation = Google::Apis::ClassroomV1::Course::Representation command.request_object = course_object command.response_representation = Google::Apis::ClassroomV1::Course::Representation command.response_class = Google::Apis::ClassroomV1::Course command.params['id'] = id unless 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 an alias for a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to create the # alias or for access errors. # * `NOT_FOUND` if the course does not exist. # * `ALREADY_EXISTS` if the alias already exists. # * `FAILED_PRECONDITION` if the alias requested does not make sense for the # requesting user or course (for example, if a user not in a domain # attempts to access a domain-scoped alias). # @param [String] course_id # Identifier of the course to alias. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Google::Apis::ClassroomV1::CourseAlias] course_alias_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::ClassroomV1::CourseAlias] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::CourseAlias] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_alias(course_id, course_alias_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/aliases', options) command.request_representation = Google::Apis::ClassroomV1::CourseAlias::Representation command.request_object = course_alias_object command.response_representation = Google::Apis::ClassroomV1::CourseAlias::Representation command.response_class = Google::Apis::ClassroomV1::CourseAlias command.params['courseId'] = course_id unless course_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 alias of a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to remove the # alias or for access errors. # * `NOT_FOUND` if the alias does not exist. # * `FAILED_PRECONDITION` if the alias requested does not make sense for the # requesting user or course (for example, if a user not in a domain # attempts to delete a domain-scoped alias). # @param [String] course_id # Identifier of the course whose alias should be deleted. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] alias_ # Alias to delete. # This may not be the Classroom-assigned identifier. # @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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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_course_alias(course_id, alias_, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/courses/{courseId}/aliases/{alias}', options) command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['courseId'] = course_id unless course_id.nil? command.params['alias'] = alias_ unless alias_.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 aliases for a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # course or for access errors. # * `NOT_FOUND` if the course does not exist. # @param [String] course_id # The identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the # server may assign a maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, # indicating that the subsequent page of results should be returned. # The list request # must be otherwise identical to the one that resulted in this 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::ClassroomV1::ListCourseAliasesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListCourseAliasesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_aliases(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/aliases', options) command.response_representation = Google::Apis::ClassroomV1::ListCourseAliasesResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListCourseAliasesResponse command.params['courseId'] = course_id unless course_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 # Creates an announcement. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course, create announcements in the requested course, share a # Drive attachment, or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course does not exist. # * `FAILED_PRECONDITION` for the following request error: # * AttachmentNotVisible # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Google::Apis::ClassroomV1::Announcement] announcement_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::ClassroomV1::Announcement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Announcement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_announcement(course_id, announcement_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/announcements', options) command.request_representation = Google::Apis::ClassroomV1::Announcement::Representation command.request_object = announcement_object command.response_representation = Google::Apis::ClassroomV1::Announcement::Representation command.response_class = Google::Apis::ClassroomV1::Announcement command.params['courseId'] = course_id unless course_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 announcement. # This request must be made by the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to # create the corresponding announcement item. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting developer project did not create # the corresponding announcement, if the requesting user is not permitted # to delete the requested course or for access errors. # * `FAILED_PRECONDITION` if the requested announcement has already been # deleted. # * `NOT_FOUND` if no course exists with the requested ID. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] id # Identifier of the announcement to delete. # This identifier is a Classroom-assigned identifier. # @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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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_course_announcement(course_id, id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/courses/{courseId}/announcements/{id}', options) command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['courseId'] = course_id unless course_id.nil? command.params['id'] = id unless 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 # Returns an announcement. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or announcement, or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course or announcement does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] id # Identifier of the announcement. # @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::ClassroomV1::Announcement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Announcement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_announcement(course_id, id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/announcements/{id}', options) command.response_representation = Google::Apis::ClassroomV1::Announcement::Representation command.response_class = Google::Apis::ClassroomV1::Announcement command.params['courseId'] = course_id unless course_id.nil? command.params['id'] = id unless 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 # Returns a list of announcements that the requester is permitted to view. # Course students may only view `PUBLISHED` announcements. Course teachers # and domain administrators may view all announcements. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access # the requested course or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Array, String] announcement_states # Restriction on the `state` of announcements returned. # If this argument is left unspecified, the default value is `PUBLISHED`. # @param [String] order_by # Optional sort ordering for results. A comma-separated list of fields with # an optional sort direction keyword. Supported field is `updateTime`. # Supported direction keywords are `asc` and `desc`. # If not specified, `updateTime desc` is the default behavior. # Examples: `updateTime asc`, `updateTime` # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the # server may assign a maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, # indicating that the subsequent page of results should be returned. # The list request # must be otherwise identical to the one that resulted in this 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::ClassroomV1::ListAnnouncementsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListAnnouncementsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_announcements(course_id, announcement_states: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/announcements', options) command.response_representation = Google::Apis::ClassroomV1::ListAnnouncementsResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListAnnouncementsResponse command.params['courseId'] = course_id unless course_id.nil? command.query['announcementStates'] = announcement_states unless announcement_states.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 # Modifies assignee mode and options of an announcement. # Only a teacher of the course that contains the announcement may # call this method. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or course work or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course or course work does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] id # Identifier of the announcement. # @param [Google::Apis::ClassroomV1::ModifyAnnouncementAssigneesRequest] modify_announcement_assignees_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::ClassroomV1::Announcement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Announcement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def modify_course_announcement_assignees(course_id, id, modify_announcement_assignees_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/announcements/{id}:modifyAssignees', options) command.request_representation = Google::Apis::ClassroomV1::ModifyAnnouncementAssigneesRequest::Representation command.request_object = modify_announcement_assignees_request_object command.response_representation = Google::Apis::ClassroomV1::Announcement::Representation command.response_class = Google::Apis::ClassroomV1::Announcement command.params['courseId'] = course_id unless course_id.nil? command.params['id'] = id unless 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 one or more fields of an announcement. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting developer project did not create # the corresponding announcement or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `FAILED_PRECONDITION` if the requested announcement has already been # deleted. # * `NOT_FOUND` if the requested course or announcement does not exist # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] id # Identifier of the announcement. # @param [Google::Apis::ClassroomV1::Announcement] announcement_object # @param [String] update_mask # Mask that identifies which fields on the announcement to update. # This field is required to do an update. The update fails if invalid # fields are specified. If a field supports empty values, it can be cleared # by specifying it in the update mask and not in the Announcement object. If # a field that does not support empty values is included in the update mask # and not set in the Announcement object, an `INVALID_ARGUMENT` error will be # returned. # The following fields may be specified by teachers: # * `text` # * `state` # * `scheduled_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::ClassroomV1::Announcement] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Announcement] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_announcement(course_id, id, announcement_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/courses/{courseId}/announcements/{id}', options) command.request_representation = Google::Apis::ClassroomV1::Announcement::Representation command.request_object = announcement_object command.response_representation = Google::Apis::ClassroomV1::Announcement::Representation command.response_class = Google::Apis::ClassroomV1::Announcement command.params['courseId'] = course_id unless course_id.nil? command.params['id'] = id unless 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 course work. # The resulting course work (and corresponding student submissions) are # associated with the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to # make the request. Classroom API requests to modify course work and student # submissions must be made with an OAuth client ID from the associated # Developer Console project. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course, create course work in the requested course, share a # Drive attachment, or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course does not exist. # * `FAILED_PRECONDITION` for the following request error: # * AttachmentNotVisible # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Google::Apis::ClassroomV1::CourseWork] course_work_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::ClassroomV1::CourseWork] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::CourseWork] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_work(course_id, course_work_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork', options) command.request_representation = Google::Apis::ClassroomV1::CourseWork::Representation command.request_object = course_work_object command.response_representation = Google::Apis::ClassroomV1::CourseWork::Representation command.response_class = Google::Apis::ClassroomV1::CourseWork command.params['courseId'] = course_id unless course_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 course work. # This request must be made by the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to # create the corresponding course work item. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting developer project did not create # the corresponding course work, if the requesting user is not permitted # to delete the requested course or for access errors. # * `FAILED_PRECONDITION` if the requested course work has already been # deleted. # * `NOT_FOUND` if no course exists with the requested ID. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] id # Identifier of the course work to delete. # This identifier is a Classroom-assigned identifier. # @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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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_course_course_work(course_id, id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/courses/{courseId}/courseWork/{id}', options) command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['courseId'] = course_id unless course_id.nil? command.params['id'] = id unless 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 # Returns course work. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or course work, or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course or course work does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] id # Identifier of the course work. # @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::ClassroomV1::CourseWork] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::CourseWork] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_work(course_id, id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/courseWork/{id}', options) command.response_representation = Google::Apis::ClassroomV1::CourseWork::Representation command.response_class = Google::Apis::ClassroomV1::CourseWork command.params['courseId'] = course_id unless course_id.nil? command.params['id'] = id unless 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 # Returns a list of course work that the requester is permitted to view. # Course students may only view `PUBLISHED` course work. Course teachers # and domain administrators may view all course work. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access # the requested course or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Array, String] course_work_states # Restriction on the work status to return. Only courseWork that matches # is returned. If unspecified, items with a work status of `PUBLISHED` # is returned. # @param [String] order_by # Optional sort ordering for results. A comma-separated list of fields with # an optional sort direction keyword. Supported fields are `updateTime` # and `dueDate`. Supported direction keywords are `asc` and `desc`. # If not specified, `updateTime desc` is the default behavior. # Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the # server may assign a maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, # indicating that the subsequent page of results should be returned. # The list request # must be otherwise identical to the one that resulted in this 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::ClassroomV1::ListCourseWorkResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListCourseWorkResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_works(course_id, course_work_states: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/courseWork', options) command.response_representation = Google::Apis::ClassroomV1::ListCourseWorkResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListCourseWorkResponse command.params['courseId'] = course_id unless course_id.nil? command.query['courseWorkStates'] = course_work_states unless course_work_states.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 # Modifies assignee mode and options of a coursework. # Only a teacher of the course that contains the coursework may # call this method. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or course work or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course or course work does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] id # Identifier of the coursework. # @param [Google::Apis::ClassroomV1::ModifyCourseWorkAssigneesRequest] modify_course_work_assignees_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::ClassroomV1::CourseWork] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::CourseWork] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def modify_course_course_work_assignees(course_id, id, modify_course_work_assignees_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{id}:modifyAssignees', options) command.request_representation = Google::Apis::ClassroomV1::ModifyCourseWorkAssigneesRequest::Representation command.request_object = modify_course_work_assignees_request_object command.response_representation = Google::Apis::ClassroomV1::CourseWork::Representation command.response_class = Google::Apis::ClassroomV1::CourseWork command.params['courseId'] = course_id unless course_id.nil? command.params['id'] = id unless 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 one or more fields of a course work. # See google.classroom.v1.CourseWork for details # of which fields may be updated and who may change them. # This request must be made by the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to # create the corresponding course work item. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting developer project did not create # the corresponding course work, if the user is not permitted to make the # requested modification to the student submission, or for # access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `FAILED_PRECONDITION` if the requested course work has already been # deleted. # * `NOT_FOUND` if the requested course, course work, or student submission # does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] id # Identifier of the course work. # @param [Google::Apis::ClassroomV1::CourseWork] course_work_object # @param [String] update_mask # Mask that identifies which fields on the course work to update. # This field is required to do an update. The update fails if invalid # fields are specified. If a field supports empty values, it can be cleared # by specifying it in the update mask and not in the CourseWork object. If a # field that does not support empty values is included in the update mask and # not set in the CourseWork object, an `INVALID_ARGUMENT` error will be # returned. # The following fields may be specified by teachers: # * `title` # * `description` # * `state` # * `due_date` # * `due_time` # * `max_points` # * `scheduled_time` # * `submission_modification_mode` # @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::ClassroomV1::CourseWork] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::CourseWork] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_course_work(course_id, id, course_work_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/courses/{courseId}/courseWork/{id}', options) command.request_representation = Google::Apis::ClassroomV1::CourseWork::Representation command.request_object = course_work_object command.response_representation = Google::Apis::ClassroomV1::CourseWork::Representation command.response_class = Google::Apis::ClassroomV1::CourseWork command.params['courseId'] = course_id unless course_id.nil? command.params['id'] = id unless 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 # Returns a student submission. # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course, course work, or student submission or for # access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course, course work, or student submission # does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id # Identifier of the student submission. # @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::ClassroomV1::StudentSubmission] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::StudentSubmission] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_student_submission(course_id, course_work_id, id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}', options) command.response_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation command.response_class = Google::Apis::ClassroomV1::StudentSubmission command.params['courseId'] = course_id unless course_id.nil? command.params['courseWorkId'] = course_work_id unless course_work_id.nil? command.params['id'] = id unless 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 # Returns a list of student submissions that the requester is permitted to # view, factoring in the OAuth scopes of the request. # `-` may be specified as the `course_work_id` to include student # submissions for multiple course work items. # Course students may only view their own work. Course teachers # and domain administrators may view all student submissions. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or course work, or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] course_work_id # Identifier of the student work to request. # This may be set to the string literal `"-"` to request student work for # all course work in the specified course. # @param [String] late # Requested lateness value. If specified, returned student submissions are # restricted by the requested value. # If unspecified, submissions are returned regardless of `late` value. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the # server may assign a maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, # indicating that the subsequent page of results should be returned. # The list request # must be otherwise identical to the one that resulted in this token. # @param [Array, String] states # Requested submission states. If specified, returned student submissions # match one of the specified submission states. # @param [String] user_id # Optional argument to restrict returned student work to those owned by the # student with the specified identifier. The identifier can be one of the # following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @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::ClassroomV1::ListStudentSubmissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListStudentSubmissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_student_submissions(course_id, course_work_id, late: nil, page_size: nil, page_token: nil, states: nil, user_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions', options) command.response_representation = Google::Apis::ClassroomV1::ListStudentSubmissionsResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListStudentSubmissionsResponse command.params['courseId'] = course_id unless course_id.nil? command.params['courseWorkId'] = course_work_id unless course_work_id.nil? command.query['late'] = late unless late.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['states'] = states unless states.nil? command.query['userId'] = user_id unless user_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 # Modifies attachments of student submission. # Attachments may only be added to student submissions belonging to course # work objects with a `workType` of `ASSIGNMENT`. # This request must be made by the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to # create the corresponding course work item. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or course work, if the user is not permitted to modify # attachments on the requested student submission, or for # access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course, course work, or student submission # does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id # Identifier of the student submission. # @param [Google::Apis::ClassroomV1::ModifyAttachmentsRequest] modify_attachments_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::ClassroomV1::StudentSubmission] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::StudentSubmission] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def modify_student_submission_attachments(course_id, course_work_id, id, modify_attachments_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments', options) command.request_representation = Google::Apis::ClassroomV1::ModifyAttachmentsRequest::Representation command.request_object = modify_attachments_request_object command.response_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation command.response_class = Google::Apis::ClassroomV1::StudentSubmission command.params['courseId'] = course_id unless course_id.nil? command.params['courseWorkId'] = course_work_id unless course_work_id.nil? command.params['id'] = id unless 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 one or more fields of a student submission. # See google.classroom.v1.StudentSubmission for details # of which fields may be updated and who may change them. # This request must be made by the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to # create the corresponding course work item. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting developer project did not create # the corresponding course work, if the user is not permitted to make the # requested modification to the student submission, or for # access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course, course work, or student submission # does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id # Identifier of the student submission. # @param [Google::Apis::ClassroomV1::StudentSubmission] student_submission_object # @param [String] update_mask # Mask that identifies which fields on the student submission to update. # This field is required to do an update. The update fails if invalid # fields are specified. # The following fields may be specified by teachers: # * `draft_grade` # * `assigned_grade` # @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::ClassroomV1::StudentSubmission] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::StudentSubmission] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_student_submission(course_id, course_work_id, id, student_submission_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}', options) command.request_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation command.request_object = student_submission_object command.response_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation command.response_class = Google::Apis::ClassroomV1::StudentSubmission command.params['courseId'] = course_id unless course_id.nil? command.params['courseWorkId'] = course_work_id unless course_work_id.nil? command.params['id'] = id unless 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 # Reclaims a student submission on behalf of the student that owns it. # Reclaiming a student submission transfers ownership of attached Drive # files to the student and update the submission state. # Only the student that owns the requested student submission may call this # method, and only for a student submission that has been turned in. # This request must be made by the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to # create the corresponding course work item. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or course work, unsubmit the requested student submission, # or for access errors. # * `FAILED_PRECONDITION` if the student submission has not been turned in. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course, course work, or student submission # does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id # Identifier of the student submission. # @param [Google::Apis::ClassroomV1::ReclaimStudentSubmissionRequest] reclaim_student_submission_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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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 reclaim_student_submission(course_id, course_work_id, id, reclaim_student_submission_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim', options) command.request_representation = Google::Apis::ClassroomV1::ReclaimStudentSubmissionRequest::Representation command.request_object = reclaim_student_submission_request_object command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['courseId'] = course_id unless course_id.nil? command.params['courseWorkId'] = course_work_id unless course_work_id.nil? command.params['id'] = id unless 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 # Returns a student submission. # Returning a student submission transfers ownership of attached Drive # files to the student and may also update the submission state. # Unlike the Classroom application, returning a student submission does not # set assignedGrade to the draftGrade value. # Only a teacher of the course that contains the requested student submission # may call this method. # This request must be made by the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to # create the corresponding course work item. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or course work, return the requested student submission, # or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course, course work, or student submission # does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id # Identifier of the student submission. # @param [Google::Apis::ClassroomV1::ReturnStudentSubmissionRequest] return_student_submission_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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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 return_student_submission(course_id, course_work_id, id, return_student_submission_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return', options) command.request_representation = Google::Apis::ClassroomV1::ReturnStudentSubmissionRequest::Representation command.request_object = return_student_submission_request_object command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['courseId'] = course_id unless course_id.nil? command.params['courseWorkId'] = course_work_id unless course_work_id.nil? command.params['id'] = id unless 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 # Turns in a student submission. # Turning in a student submission transfers ownership of attached Drive # files to the teacher and may also update the submission state. # This may only be called by the student that owns the specified student # submission. # This request must be made by the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to # create the corresponding course work item. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or course work, turn in the requested student submission, # or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course, course work, or student submission # does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id # Identifier of the student submission. # @param [Google::Apis::ClassroomV1::TurnInStudentSubmissionRequest] turn_in_student_submission_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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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 turn_in_student_submission(course_id, course_work_id, id, turn_in_student_submission_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn', options) command.request_representation = Google::Apis::ClassroomV1::TurnInStudentSubmissionRequest::Representation command.request_object = turn_in_student_submission_request_object command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['courseId'] = course_id unless course_id.nil? command.params['courseWorkId'] = course_work_id unless course_work_id.nil? command.params['id'] = id unless 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 # Adds a user as a student of a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to create # students in this course or for access errors. # * `NOT_FOUND` if the requested course ID does not exist. # * `FAILED_PRECONDITION` if the requested user's account is disabled, # for the following request errors: # * CourseMemberLimitReached # * CourseNotModifiable # * UserGroupsMembershipLimitReached # * `ALREADY_EXISTS` if the user is already a student or teacher in the # course. # @param [String] course_id # Identifier of the course to create the student in. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Google::Apis::ClassroomV1::Student] student_object # @param [String] enrollment_code # Enrollment code of the course to create the student in. # This code is required if userId # corresponds to the requesting user; it may be omitted if the requesting # user has administrative permissions to create students for any user. # @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::ClassroomV1::Student] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Student] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_student(course_id, student_object = nil, enrollment_code: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/students', options) command.request_representation = Google::Apis::ClassroomV1::Student::Representation command.request_object = student_object command.response_representation = Google::Apis::ClassroomV1::Student::Representation command.response_class = Google::Apis::ClassroomV1::Student command.params['courseId'] = course_id unless course_id.nil? command.query['enrollmentCode'] = enrollment_code unless enrollment_code.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 student of a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to delete # students of this course or for access errors. # * `NOT_FOUND` if no student of this course has the requested ID or if the # course does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] user_id # Identifier of the student to delete. The identifier can be one of the # following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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_course_student(course_id, user_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/courses/{courseId}/students/{userId}', options) command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['courseId'] = course_id unless course_id.nil? command.params['userId'] = user_id unless user_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 # Returns a student of a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to view # students of this course or for access errors. # * `NOT_FOUND` if no student of this course has the requested ID or if the # course does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] user_id # Identifier of the student to return. The identifier can be one of the # following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @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::ClassroomV1::Student] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Student] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_student(course_id, user_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/students/{userId}', options) command.response_representation = Google::Apis::ClassroomV1::Student::Representation command.response_class = Google::Apis::ClassroomV1::Student command.params['courseId'] = course_id unless course_id.nil? command.params['userId'] = user_id unless user_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 # Returns a list of students of this course that the requester # is permitted to view. # This method returns the following error codes: # * `NOT_FOUND` if the course does not exist. # * `PERMISSION_DENIED` for access errors. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Fixnum] page_size # Maximum number of items to return. Zero means no maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, indicating that # the subsequent page of results should be returned. # The list request must be # otherwise identical to the one that resulted in this 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::ClassroomV1::ListStudentsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListStudentsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_students(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/students', options) command.response_representation = Google::Apis::ClassroomV1::ListStudentsResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListStudentsResponse command.params['courseId'] = course_id unless course_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 # Creates a teacher of a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to create # teachers in this course or for access errors. # * `NOT_FOUND` if the requested course ID does not exist. # * `FAILED_PRECONDITION` if the requested user's account is disabled, # for the following request errors: # * CourseMemberLimitReached # * CourseNotModifiable # * CourseTeacherLimitReached # * UserGroupsMembershipLimitReached # * `ALREADY_EXISTS` if the user is already a teacher or student in the # course. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Google::Apis::ClassroomV1::Teacher] teacher_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::ClassroomV1::Teacher] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Teacher] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_teacher(course_id, teacher_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/courses/{courseId}/teachers', options) command.request_representation = Google::Apis::ClassroomV1::Teacher::Representation command.request_object = teacher_object command.response_representation = Google::Apis::ClassroomV1::Teacher::Representation command.response_class = Google::Apis::ClassroomV1::Teacher command.params['courseId'] = course_id unless course_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 teacher of a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to delete # teachers of this course or for access errors. # * `NOT_FOUND` if no teacher of this course has the requested ID or if the # course does not exist. # * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher # of this course. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] user_id # Identifier of the teacher to delete. The identifier can be one of the # following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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_course_teacher(course_id, user_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/courses/{courseId}/teachers/{userId}', options) command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['courseId'] = course_id unless course_id.nil? command.params['userId'] = user_id unless user_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 # Returns a teacher of a course. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to view # teachers of this course or for access errors. # * `NOT_FOUND` if no teacher of this course has the requested ID or if the # course does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [String] user_id # Identifier of the teacher to return. The identifier can be one of the # following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @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::ClassroomV1::Teacher] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Teacher] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_teacher(course_id, user_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/teachers/{userId}', options) command.response_representation = Google::Apis::ClassroomV1::Teacher::Representation command.response_class = Google::Apis::ClassroomV1::Teacher command.params['courseId'] = course_id unless course_id.nil? command.params['userId'] = user_id unless user_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 # Returns a list of teachers of this course that the requester # is permitted to view. # This method returns the following error codes: # * `NOT_FOUND` if the course does not exist. # * `PERMISSION_DENIED` for access errors. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Fixnum] page_size # Maximum number of items to return. Zero means no maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, indicating that # the subsequent page of results should be returned. # The list request must be # otherwise identical to the one that resulted in this 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::ClassroomV1::ListTeachersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListTeachersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_teachers(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/teachers', options) command.response_representation = Google::Apis::ClassroomV1::ListTeachersResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListTeachersResponse command.params['courseId'] = course_id unless course_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 # Returns a topic. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access the # requested course or topic, or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course or topic does not exist. # @param [String] course_id # Identifier of the course. # @param [String] id # Identifier of the topic. # @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::ClassroomV1::Topic] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Topic] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_topic(course_id, id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/topics/{id}', options) command.response_representation = Google::Apis::ClassroomV1::Topic::Representation command.response_class = Google::Apis::ClassroomV1::Topic command.params['courseId'] = course_id unless course_id.nil? command.params['id'] = id unless 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 # Returns the list of topics that the requester is permitted to view. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access # the requested course or for access errors. # * `INVALID_ARGUMENT` if the request is malformed. # * `NOT_FOUND` if the requested course does not exist. # @param [String] course_id # Identifier of the course. # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the # server may assign a maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, # indicating that the subsequent page of results should be returned. # The list request # must be otherwise identical to the one that resulted in this 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::ClassroomV1::ListTopicResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListTopicResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_course_topics(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/courses/{courseId}/topics', options) command.response_representation = Google::Apis::ClassroomV1::ListTopicResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListTopicResponse command.params['courseId'] = course_id unless course_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 # Accepts an invitation, removing it and adding the invited user to the # teachers or students (as appropriate) of the specified course. Only the # invited user may accept an invitation. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to accept the # requested invitation or for access errors. # * `FAILED_PRECONDITION` for the following request errors: # * CourseMemberLimitReached # * CourseNotModifiable # * CourseTeacherLimitReached # * UserGroupsMembershipLimitReached # * `NOT_FOUND` if no invitation exists with the requested ID. # @param [String] id # Identifier of the invitation to accept. # @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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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 accept_invitation(id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/invitations/{id}:accept', options) command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['id'] = id unless 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 an invitation. Only one invitation for a user and course may exist # at a time. Delete and re-create an invitation to make changes. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to create # invitations for this course or for access errors. # * `NOT_FOUND` if the course or the user does not exist. # * `FAILED_PRECONDITION` if the requested user's account is disabled or if # the user already has this role or a role with greater permissions. # * `ALREADY_EXISTS` if an invitation for the specified user and course # already exists. # @param [Google::Apis::ClassroomV1::Invitation] invitation_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::ClassroomV1::Invitation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Invitation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_invitation(invitation_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/invitations', options) command.request_representation = Google::Apis::ClassroomV1::Invitation::Representation command.request_object = invitation_object command.response_representation = Google::Apis::ClassroomV1::Invitation::Representation command.response_class = Google::Apis::ClassroomV1::Invitation 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 invitation. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to delete the # requested invitation or for access errors. # * `NOT_FOUND` if no invitation exists with the requested ID. # @param [String] id # Identifier of the invitation 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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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_invitation(id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/invitations/{id}', options) command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['id'] = id unless 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 # Returns an invitation. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to view the # requested invitation or for access errors. # * `NOT_FOUND` if no invitation exists with the requested ID. # @param [String] id # Identifier of the invitation to return. # @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::ClassroomV1::Invitation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Invitation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_invitation(id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/invitations/{id}', options) command.response_representation = Google::Apis::ClassroomV1::Invitation::Representation command.response_class = Google::Apis::ClassroomV1::Invitation command.params['id'] = id unless 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 # Returns a list of invitations that the requesting user is permitted to # view, restricted to those that match the list request. # *Note:* At least one of `user_id` or `course_id` must be supplied. Both # fields can be supplied. # This method returns the following error codes: # * `PERMISSION_DENIED` for access errors. # @param [String] course_id # Restricts returned invitations to those for a course with the specified # identifier. # @param [Fixnum] page_size # Maximum number of items to return. Zero means no maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, indicating # that the subsequent page of results should be returned. # The list request must be # otherwise identical to the one that resulted in this token. # @param [String] user_id # Restricts returned invitations to those for a specific user. The identifier # can be one of the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @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::ClassroomV1::ListInvitationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListInvitationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_invitations(course_id: nil, page_size: nil, page_token: nil, user_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/invitations', options) command.response_representation = Google::Apis::ClassroomV1::ListInvitationsResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListInvitationsResponse command.query['courseId'] = course_id unless course_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['userId'] = user_id unless user_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 `Registration`, causing Classroom to start sending notifications # from the provided `feed` to the provided `destination`. # Returns the created `Registration`. Currently, this will be the same as # the argument, but with server-assigned fields such as `expiry_time` and # `id` filled in. # Note that any value specified for the `expiry_time` or `id` fields will be # ignored. # While Classroom may validate the `destination` and return errors on a best # effort basis, it is the caller's responsibility to ensure that it exists # and that Classroom has permission to publish to it. # This method may return the following error codes: # * `PERMISSION_DENIED` if: # * the authenticated user does not have permission to receive # notifications from the requested field; or # * the credential provided does not include the appropriate scope for the # requested feed. # * another access error is encountered. # * `INVALID_ARGUMENT` if: # * no `destination` is specified, or the specified `destination` is not # valid; or # * no `feed` is specified, or the specified `feed` is not valid. # * `NOT_FOUND` if: # * the specified `feed` cannot be located, or the requesting user does not # have permission to determine whether or not it exists; or # * the specified `destination` cannot be located, or Classroom has not # been granted permission to publish to it. # @param [Google::Apis::ClassroomV1::Registration] registration_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::ClassroomV1::Registration] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Registration] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_registration(registration_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/registrations', options) command.request_representation = Google::Apis::ClassroomV1::Registration::Representation command.request_object = registration_object command.response_representation = Google::Apis::ClassroomV1::Registration::Representation command.response_class = Google::Apis::ClassroomV1::Registration 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 `Registration`, causing Classroom to stop sending notifications # for that `Registration`. # @param [String] registration_id # The `registration_id` of the `Registration` 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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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_registration(registration_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/registrations/{registrationId}', options) command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['registrationId'] = registration_id unless registration_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 # Returns a user profile. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to access # this user profile, if no profile exists with the requested ID, or for # access errors. # @param [String] user_id # Identifier of the profile to return. The identifier can be one of the # following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @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::ClassroomV1::UserProfile] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::UserProfile] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profile(user_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/userProfiles/{userId}', options) command.response_representation = Google::Apis::ClassroomV1::UserProfile::Representation command.response_class = Google::Apis::ClassroomV1::UserProfile command.params['userId'] = user_id unless user_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 guardian invitation, and sends an email to the guardian asking # them to confirm that they are the student's guardian. # Once the guardian accepts the invitation, their `state` will change to # `COMPLETED` and they will start receiving guardian notifications. A # `Guardian` resource will also be created to represent the active guardian. # The request object must have the `student_id` and # `invited_email_address` fields set. Failing to set these fields, or # setting any other fields in the request, will result in an error. # This method returns the following error codes: # * `PERMISSION_DENIED` if the current user does not have permission to # manage guardians, if the guardian in question has already rejected # too many requests for that student, if guardians are not enabled for the # domain in question, or for other access errors. # * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian # link limit. # * `INVALID_ARGUMENT` if the guardian email address is not valid (for # example, if it is too long), or if the format of the student ID provided # cannot be recognized (it is not an email address, nor a `user_id` from # this API). This error will also be returned if read-only fields are set, # or if the `state` field is set to to a value other than `PENDING`. # * `NOT_FOUND` if the student ID provided is a valid student ID, but # Classroom has no record of that student. # * `ALREADY_EXISTS` if there is already a pending guardian invitation for # the student and `invited_email_address` provided, or if the provided # `invited_email_address` matches the Google account of an existing # `Guardian` for this user. # @param [String] student_id # ID of the student (in standard format) # @param [Google::Apis::ClassroomV1::GuardianInvitation] guardian_invitation_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::ClassroomV1::GuardianInvitation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::GuardianInvitation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profile_guardian_invitation(student_id, guardian_invitation_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/userProfiles/{studentId}/guardianInvitations', options) command.request_representation = Google::Apis::ClassroomV1::GuardianInvitation::Representation command.request_object = guardian_invitation_object command.response_representation = Google::Apis::ClassroomV1::GuardianInvitation::Representation command.response_class = Google::Apis::ClassroomV1::GuardianInvitation command.params['studentId'] = student_id unless student_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 # Returns a specific guardian invitation. # This method returns the following error codes: # * `PERMISSION_DENIED` if the requesting user is not permitted to view # guardian invitations for the student identified by the `student_id`, if # guardians are not enabled for the domain in question, or for other # access errors. # * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot # be recognized (it is not an email address, nor a `student_id` from the # API, nor the literal string `me`). # * `NOT_FOUND` if Classroom cannot find any record of the given student or # `invitation_id`. May also be returned if the student exists, but the # requesting user does not have access to see that student. # @param [String] student_id # The ID of the student whose guardian invitation is being requested. # @param [String] invitation_id # The `id` field of the `GuardianInvitation` 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::ClassroomV1::GuardianInvitation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::GuardianInvitation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profile_guardian_invitation(student_id, invitation_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/userProfiles/{studentId}/guardianInvitations/{invitationId}', options) command.response_representation = Google::Apis::ClassroomV1::GuardianInvitation::Representation command.response_class = Google::Apis::ClassroomV1::GuardianInvitation command.params['studentId'] = student_id unless student_id.nil? command.params['invitationId'] = invitation_id unless invitation_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 # Returns a list of guardian invitations that the requesting user is # permitted to view, filtered by the parameters provided. # This method returns the following error codes: # * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting # user is not permitted to view guardian invitations for that student, if # `"-"` is specified as the `student_id` and the user is not a domain # administrator, if guardians are not enabled for the domain in question, # or for other access errors. # * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot # be recognized (it is not an email address, nor a `student_id` from the # API, nor the literal string `me`). May also be returned if an invalid # `page_token` or `state` is provided. # * `NOT_FOUND` if a `student_id` is specified, and its format can be # recognized, but Classroom has no record of that student. # @param [String] student_id # The ID of the student whose guardian invitations are to be returned. # The identifier can be one of the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # * the string literal `"-"`, indicating that results should be returned for # all students that the requesting user is permitted to view guardian # invitations. # @param [String] invited_email_address # If specified, only results with the specified `invited_email_address` # will be returned. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the # server may assign a maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, # indicating that the subsequent page of results should be returned. # The list request # must be otherwise identical to the one that resulted in this token. # @param [Array, String] states # If specified, only results with the specified `state` values will be # returned. Otherwise, results with a `state` of `PENDING` 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::ClassroomV1::ListGuardianInvitationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListGuardianInvitationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profile_guardian_invitations(student_id, invited_email_address: nil, page_size: nil, page_token: nil, states: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/userProfiles/{studentId}/guardianInvitations', options) command.response_representation = Google::Apis::ClassroomV1::ListGuardianInvitationsResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListGuardianInvitationsResponse command.params['studentId'] = student_id unless student_id.nil? command.query['invitedEmailAddress'] = invited_email_address unless invited_email_address.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['states'] = states unless states.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Modifies a guardian invitation. # Currently, the only valid modification is to change the `state` from # `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. # This method returns the following error codes: # * `PERMISSION_DENIED` if the current user does not have permission to # manage guardians, if guardians are not enabled for the domain in question # or for other access errors. # * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. # * `INVALID_ARGUMENT` if the format of the student ID provided # cannot be recognized (it is not an email address, nor a `user_id` from # this API), or if the passed `GuardianInvitation` has a `state` other than # `COMPLETE`, or if it modifies fields other than `state`. # * `NOT_FOUND` if the student ID provided is a valid student ID, but # Classroom has no record of that student, or if the `id` field does not # refer to a guardian invitation known to Classroom. # @param [String] student_id # The ID of the student whose guardian invitation is to be modified. # @param [String] invitation_id # The `id` field of the `GuardianInvitation` to be modified. # @param [Google::Apis::ClassroomV1::GuardianInvitation] guardian_invitation_object # @param [String] update_mask # Mask that identifies which fields on the course to update. # This field is required to do an update. The update will fail if invalid # fields are specified. The following fields are valid: # * `state` # When set in a query parameter, this field should be specified as # `updateMask=,,...` # @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::ClassroomV1::GuardianInvitation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::GuardianInvitation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profile_guardian_invitation(student_id, invitation_id, guardian_invitation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/userProfiles/{studentId}/guardianInvitations/{invitationId}', options) command.request_representation = Google::Apis::ClassroomV1::GuardianInvitation::Representation command.request_object = guardian_invitation_object command.response_representation = Google::Apis::ClassroomV1::GuardianInvitation::Representation command.response_class = Google::Apis::ClassroomV1::GuardianInvitation command.params['studentId'] = student_id unless student_id.nil? command.params['invitationId'] = invitation_id unless invitation_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 # Deletes a guardian. # The guardian will no longer receive guardian notifications and the guardian # will no longer be accessible via the API. # This method returns the following error codes: # * `PERMISSION_DENIED` if no user that matches the provided `student_id` # is visible to the requesting user, if the requesting user is not # permitted to manage guardians for the student identified by the # `student_id`, if guardians are not enabled for the domain in question, # or for other access errors. # * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot # be recognized (it is not an email address, nor a `student_id` from the # API). # * `NOT_FOUND` if the requesting user is permitted to modify guardians for # the requested `student_id`, but no `Guardian` record exists for that # student with the provided `guardian_id`. # @param [String] student_id # The student whose guardian is to be deleted. One of the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @param [String] guardian_id # The `id` field from a `Guardian`. # @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::ClassroomV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::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_user_profile_guardian(student_id, guardian_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/userProfiles/{studentId}/guardians/{guardianId}', options) command.response_representation = Google::Apis::ClassroomV1::Empty::Representation command.response_class = Google::Apis::ClassroomV1::Empty command.params['studentId'] = student_id unless student_id.nil? command.params['guardianId'] = guardian_id unless guardian_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 # Returns a specific guardian. # This method returns the following error codes: # * `PERMISSION_DENIED` if no user that matches the provided `student_id` # is visible to the requesting user, if the requesting user is not # permitted to view guardian information for the student identified by the # `student_id`, if guardians are not enabled for the domain in question, # or for other access errors. # * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot # be recognized (it is not an email address, nor a `student_id` from the # API, nor the literal string `me`). # * `NOT_FOUND` if the requesting user is permitted to view guardians for # the requested `student_id`, but no `Guardian` record exists for that # student that matches the provided `guardian_id`. # @param [String] student_id # The student whose guardian is being requested. One of the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # @param [String] guardian_id # The `id` field from a `Guardian`. # @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::ClassroomV1::Guardian] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::Guardian] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profile_guardian(student_id, guardian_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/userProfiles/{studentId}/guardians/{guardianId}', options) command.response_representation = Google::Apis::ClassroomV1::Guardian::Representation command.response_class = Google::Apis::ClassroomV1::Guardian command.params['studentId'] = student_id unless student_id.nil? command.params['guardianId'] = guardian_id unless guardian_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 # Returns a list of guardians that the requesting user is permitted to # view, restricted to those that match the request. # To list guardians for any student that the requesting user may view # guardians for, use the literal character `-` for the student ID. # This method returns the following error codes: # * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting # user is not permitted to view guardian information for that student, if # `"-"` is specified as the `student_id` and the user is not a domain # administrator, if guardians are not enabled for the domain in question, # if the `invited_email_address` filter is set by a user who is not a # domain administrator, or for other access errors. # * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot # be recognized (it is not an email address, nor a `student_id` from the # API, nor the literal string `me`). May also be returned if an invalid # `page_token` is provided. # * `NOT_FOUND` if a `student_id` is specified, and its format can be # recognized, but Classroom has no record of that student. # @param [String] student_id # Filter results by the student who the guardian is linked to. # The identifier can be one of the following: # * the numeric identifier for the user # * the email address of the user # * the string literal `"me"`, indicating the requesting user # * the string literal `"-"`, indicating that results should be returned for # all students that the requesting user has access to view. # @param [String] invited_email_address # Filter results by the email address that the original invitation was sent # to, resulting in this guardian link. # This filter can only be used by domain administrators. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the # server may assign a maximum. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken # value returned from a previous # list call, # indicating that the subsequent page of results should be returned. # The list request # must be otherwise identical to the one that resulted in this 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::ClassroomV1::ListGuardiansResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClassroomV1::ListGuardiansResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_profile_guardians(student_id, invited_email_address: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/userProfiles/{studentId}/guardians', options) command.response_representation = Google::Apis::ClassroomV1::ListGuardiansResponse::Representation command.response_class = Google::Apis::ClassroomV1::ListGuardiansResponse command.params['studentId'] = student_id unless student_id.nil? command.query['invitedEmailAddress'] = invited_email_address unless invited_email_address.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 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 google-api-client-0.19.8/generated/google/apis/discovery_v1/0000755000004100000410000000000013252673043023730 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/discovery_v1/representations.rb0000644000004100000410000003750013252673043027507 0ustar www-datawww-data# 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 DiscoveryV1 class DirectoryList class Representation < Google::Apis::Core::JsonRepresentation; end class Item class Representation < Google::Apis::Core::JsonRepresentation; end class Icons 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 JsonSchema class Representation < Google::Apis::Core::JsonRepresentation; end class Annotations class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Variant class Representation < Google::Apis::Core::JsonRepresentation; end class Map 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 RestDescription class Representation < Google::Apis::Core::JsonRepresentation; end class Auth class Representation < Google::Apis::Core::JsonRepresentation; end class Oauth2 class Representation < Google::Apis::Core::JsonRepresentation; end class Scope 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 Icons class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class RestMethod class Representation < Google::Apis::Core::JsonRepresentation; end class MediaUpload class Representation < Google::Apis::Core::JsonRepresentation; end class Protocols class Representation < Google::Apis::Core::JsonRepresentation; end class Resumable class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Simple 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 Request class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Response class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class RestResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DirectoryList # @private class Representation < Google::Apis::Core::JsonRepresentation property :discovery_version, as: 'discoveryVersion' collection :items, as: 'items', class: Google::Apis::DiscoveryV1::DirectoryList::Item, decorator: Google::Apis::DiscoveryV1::DirectoryList::Item::Representation property :kind, as: 'kind' end class Item # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :discovery_link, as: 'discoveryLink' property :discovery_rest_url, as: 'discoveryRestUrl' property :documentation_link, as: 'documentationLink' property :icons, as: 'icons', class: Google::Apis::DiscoveryV1::DirectoryList::Item::Icons, decorator: Google::Apis::DiscoveryV1::DirectoryList::Item::Icons::Representation property :id, as: 'id' property :kind, as: 'kind' collection :labels, as: 'labels' property :name, as: 'name' property :preferred, as: 'preferred' property :title, as: 'title' property :version, as: 'version' end class Icons # @private class Representation < Google::Apis::Core::JsonRepresentation property :x16, as: 'x16' property :x32, as: 'x32' end end end end class JsonSchema # @private class Representation < Google::Apis::Core::JsonRepresentation property :_ref, as: '$ref' property :additional_properties, as: 'additionalProperties', class: Google::Apis::DiscoveryV1::JsonSchema, decorator: Google::Apis::DiscoveryV1::JsonSchema::Representation property :annotations, as: 'annotations', class: Google::Apis::DiscoveryV1::JsonSchema::Annotations, decorator: Google::Apis::DiscoveryV1::JsonSchema::Annotations::Representation property :default, as: 'default' property :description, as: 'description' collection :enum, as: 'enum' collection :enum_descriptions, as: 'enumDescriptions' property :format, as: 'format' property :id, as: 'id' property :items, as: 'items', class: Google::Apis::DiscoveryV1::JsonSchema, decorator: Google::Apis::DiscoveryV1::JsonSchema::Representation property :location, as: 'location' property :maximum, as: 'maximum' property :minimum, as: 'minimum' property :pattern, as: 'pattern' hash :properties, as: 'properties', class: Google::Apis::DiscoveryV1::JsonSchema, decorator: Google::Apis::DiscoveryV1::JsonSchema::Representation property :read_only, as: 'readOnly' property :repeated, as: 'repeated' property :required, as: 'required' property :type, as: 'type' property :variant, as: 'variant', class: Google::Apis::DiscoveryV1::JsonSchema::Variant, decorator: Google::Apis::DiscoveryV1::JsonSchema::Variant::Representation end class Annotations # @private class Representation < Google::Apis::Core::JsonRepresentation collection :required, as: 'required' end end class Variant # @private class Representation < Google::Apis::Core::JsonRepresentation property :discriminant, as: 'discriminant' collection :map, as: 'map', class: Google::Apis::DiscoveryV1::JsonSchema::Variant::Map, decorator: Google::Apis::DiscoveryV1::JsonSchema::Variant::Map::Representation end class Map # @private class Representation < Google::Apis::Core::JsonRepresentation property :_ref, as: '$ref' property :type_value, as: 'type_value' end end end end class RestDescription # @private class Representation < Google::Apis::Core::JsonRepresentation property :auth, as: 'auth', class: Google::Apis::DiscoveryV1::RestDescription::Auth, decorator: Google::Apis::DiscoveryV1::RestDescription::Auth::Representation property :base_path, as: 'basePath' property :base_url, as: 'baseUrl' property :batch_path, as: 'batchPath' property :canonical_name, as: 'canonicalName' property :description, as: 'description' property :discovery_version, as: 'discoveryVersion' property :documentation_link, as: 'documentationLink' property :etag, as: 'etag' property :exponential_backoff_default, as: 'exponentialBackoffDefault' collection :features, as: 'features' property :icons, as: 'icons', class: Google::Apis::DiscoveryV1::RestDescription::Icons, decorator: Google::Apis::DiscoveryV1::RestDescription::Icons::Representation property :id, as: 'id' property :kind, as: 'kind' collection :labels, as: 'labels' hash :api_methods, as: 'methods', class: Google::Apis::DiscoveryV1::RestMethod, decorator: Google::Apis::DiscoveryV1::RestMethod::Representation property :name, as: 'name' property :owner_domain, as: 'ownerDomain' property :owner_name, as: 'ownerName' property :package_path, as: 'packagePath' hash :parameters, as: 'parameters', class: Google::Apis::DiscoveryV1::JsonSchema, decorator: Google::Apis::DiscoveryV1::JsonSchema::Representation property :protocol, as: 'protocol' hash :resources, as: 'resources', class: Google::Apis::DiscoveryV1::RestResource, decorator: Google::Apis::DiscoveryV1::RestResource::Representation property :revision, as: 'revision' property :root_url, as: 'rootUrl' hash :schemas, as: 'schemas', class: Google::Apis::DiscoveryV1::JsonSchema, decorator: Google::Apis::DiscoveryV1::JsonSchema::Representation property :service_path, as: 'servicePath' property :title, as: 'title' property :version, as: 'version' property :version_module, as: 'version_module' end class Auth # @private class Representation < Google::Apis::Core::JsonRepresentation property :oauth2, as: 'oauth2', class: Google::Apis::DiscoveryV1::RestDescription::Auth::Oauth2, decorator: Google::Apis::DiscoveryV1::RestDescription::Auth::Oauth2::Representation end class Oauth2 # @private class Representation < Google::Apis::Core::JsonRepresentation hash :scopes, as: 'scopes', class: Google::Apis::DiscoveryV1::RestDescription::Auth::Oauth2::Scope, decorator: Google::Apis::DiscoveryV1::RestDescription::Auth::Oauth2::Scope::Representation end class Scope # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' end end end end class Icons # @private class Representation < Google::Apis::Core::JsonRepresentation property :x16, as: 'x16' property :x32, as: 'x32' end end end class RestMethod # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :etag_required, as: 'etagRequired' property :http_method, as: 'httpMethod' property :id, as: 'id' property :media_upload, as: 'mediaUpload', class: Google::Apis::DiscoveryV1::RestMethod::MediaUpload, decorator: Google::Apis::DiscoveryV1::RestMethod::MediaUpload::Representation collection :parameter_order, as: 'parameterOrder' hash :parameters, as: 'parameters', class: Google::Apis::DiscoveryV1::JsonSchema, decorator: Google::Apis::DiscoveryV1::JsonSchema::Representation property :path, as: 'path' property :request, as: 'request', class: Google::Apis::DiscoveryV1::RestMethod::Request, decorator: Google::Apis::DiscoveryV1::RestMethod::Request::Representation property :response, as: 'response', class: Google::Apis::DiscoveryV1::RestMethod::Response, decorator: Google::Apis::DiscoveryV1::RestMethod::Response::Representation collection :scopes, as: 'scopes' property :supports_media_download, as: 'supportsMediaDownload' property :supports_media_upload, as: 'supportsMediaUpload' property :supports_subscription, as: 'supportsSubscription' property :use_media_download_service, as: 'useMediaDownloadService' end class MediaUpload # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accept, as: 'accept' property :max_size, as: 'maxSize' property :protocols, as: 'protocols', class: Google::Apis::DiscoveryV1::RestMethod::MediaUpload::Protocols, decorator: Google::Apis::DiscoveryV1::RestMethod::MediaUpload::Protocols::Representation end class Protocols # @private class Representation < Google::Apis::Core::JsonRepresentation property :resumable, as: 'resumable', class: Google::Apis::DiscoveryV1::RestMethod::MediaUpload::Protocols::Resumable, decorator: Google::Apis::DiscoveryV1::RestMethod::MediaUpload::Protocols::Resumable::Representation property :simple, as: 'simple', class: Google::Apis::DiscoveryV1::RestMethod::MediaUpload::Protocols::Simple, decorator: Google::Apis::DiscoveryV1::RestMethod::MediaUpload::Protocols::Simple::Representation end class Resumable # @private class Representation < Google::Apis::Core::JsonRepresentation property :multipart, as: 'multipart' property :path, as: 'path' end end class Simple # @private class Representation < Google::Apis::Core::JsonRepresentation property :multipart, as: 'multipart' property :path, as: 'path' end end end end class Request # @private class Representation < Google::Apis::Core::JsonRepresentation property :_ref, as: '$ref' property :parameter_name, as: 'parameterName' end end class Response # @private class Representation < Google::Apis::Core::JsonRepresentation property :_ref, as: '$ref' end end end class RestResource # @private class Representation < Google::Apis::Core::JsonRepresentation hash :api_methods, as: 'methods', class: Google::Apis::DiscoveryV1::RestMethod, decorator: Google::Apis::DiscoveryV1::RestMethod::Representation hash :resources, as: 'resources', class: Google::Apis::DiscoveryV1::RestResource, decorator: Google::Apis::DiscoveryV1::RestResource::Representation end end end end end google-api-client-0.19.8/generated/google/apis/discovery_v1/classes.rb0000644000004100000410000010770113252673043025720 0ustar www-datawww-data# 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 DiscoveryV1 # class DirectoryList include Google::Apis::Core::Hashable # Indicate the version of the Discovery API used to generate this doc. # Corresponds to the JSON property `discoveryVersion` # @return [String] attr_accessor :discovery_version # The individual directory entries. One entry per api/version pair. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind for this response. # 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) @discovery_version = args[:discovery_version] if args.key?(:discovery_version) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end # class Item include Google::Apis::Core::Hashable # The description of this API. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # A link to the discovery document. # Corresponds to the JSON property `discoveryLink` # @return [String] attr_accessor :discovery_link # The URL for the discovery REST document. # Corresponds to the JSON property `discoveryRestUrl` # @return [String] attr_accessor :discovery_rest_url # A link to human readable documentation for the API. # Corresponds to the JSON property `documentationLink` # @return [String] attr_accessor :documentation_link # Links to 16x16 and 32x32 icons representing the API. # Corresponds to the JSON property `icons` # @return [Google::Apis::DiscoveryV1::DirectoryList::Item::Icons] attr_accessor :icons # The id of this API. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind for this response. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Labels for the status of this API, such as labs or deprecated. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # The name of the API. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # True if this version is the preferred version to use. # Corresponds to the JSON property `preferred` # @return [Boolean] attr_accessor :preferred alias_method :preferred?, :preferred # The title of this API. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The version of the API. # 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) @description = args[:description] if args.key?(:description) @discovery_link = args[:discovery_link] if args.key?(:discovery_link) @discovery_rest_url = args[:discovery_rest_url] if args.key?(:discovery_rest_url) @documentation_link = args[:documentation_link] if args.key?(:documentation_link) @icons = args[:icons] if args.key?(:icons) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @preferred = args[:preferred] if args.key?(:preferred) @title = args[:title] if args.key?(:title) @version = args[:version] if args.key?(:version) end # Links to 16x16 and 32x32 icons representing the API. class Icons include Google::Apis::Core::Hashable # The URL of the 16x16 icon. # Corresponds to the JSON property `x16` # @return [String] attr_accessor :x16 # The URL of the 32x32 icon. # Corresponds to the JSON property `x32` # @return [String] attr_accessor :x32 def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @x16 = args[:x16] if args.key?(:x16) @x32 = args[:x32] if args.key?(:x32) end end end end # class JsonSchema include Google::Apis::Core::Hashable # A reference to another schema. The value of this property is the "id" of # another schema. # Corresponds to the JSON property `$ref` # @return [String] attr_accessor :_ref # If this is a schema for an object, this property is the schema for any # additional properties with dynamic keys on this object. # Corresponds to the JSON property `additionalProperties` # @return [Google::Apis::DiscoveryV1::JsonSchema] attr_accessor :additional_properties # Additional information about this property. # Corresponds to the JSON property `annotations` # @return [Google::Apis::DiscoveryV1::JsonSchema::Annotations] attr_accessor :annotations # The default value of this property (if one exists). # Corresponds to the JSON property `default` # @return [String] attr_accessor :default # A description of this object. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Values this parameter may take (if it is an enum). # Corresponds to the JSON property `enum` # @return [Array] attr_accessor :enum # The descriptions for the enums. Each position maps to the corresponding value # in the "enum" array. # Corresponds to the JSON property `enumDescriptions` # @return [Array] attr_accessor :enum_descriptions # An additional regular expression or key that helps constrain the value. For # more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section- # 5.23 # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # Unique identifier for this schema. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # If this is a schema for an array, this property is the schema for each element # in the array. # Corresponds to the JSON property `items` # @return [Google::Apis::DiscoveryV1::JsonSchema] attr_accessor :items # Whether this parameter goes in the query or the path for REST requests. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The maximum value of this parameter. # Corresponds to the JSON property `maximum` # @return [String] attr_accessor :maximum # The minimum value of this parameter. # Corresponds to the JSON property `minimum` # @return [String] attr_accessor :minimum # The regular expression this parameter must conform to. Uses Java 6 regex # format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html # Corresponds to the JSON property `pattern` # @return [String] attr_accessor :pattern # If this is a schema for an object, list the schema for each property of this # object. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties # The value is read-only, generated by the service. The value cannot be modified # by the client. If the value is included in a POST, PUT, or PATCH request, it # is ignored by the service. # Corresponds to the JSON property `readOnly` # @return [Boolean] attr_accessor :read_only alias_method :read_only?, :read_only # Whether this parameter may appear multiple times. # Corresponds to the JSON property `repeated` # @return [Boolean] attr_accessor :repeated alias_method :repeated?, :repeated # Whether the parameter is required. # Corresponds to the JSON property `required` # @return [Boolean] attr_accessor :required alias_method :required?, :required # The value type for this schema. A list of values can be found here: http:// # tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # In a variant data type, the value of one property is used to determine how to # interpret the entire entity. Its value must exist in a map of descriminant # values to schema names. # Corresponds to the JSON property `variant` # @return [Google::Apis::DiscoveryV1::JsonSchema::Variant] attr_accessor :variant def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @_ref = args[:_ref] if args.key?(:_ref) @additional_properties = args[:additional_properties] if args.key?(:additional_properties) @annotations = args[:annotations] if args.key?(:annotations) @default = args[:default] if args.key?(:default) @description = args[:description] if args.key?(:description) @enum = args[:enum] if args.key?(:enum) @enum_descriptions = args[:enum_descriptions] if args.key?(:enum_descriptions) @format = args[:format] if args.key?(:format) @id = args[:id] if args.key?(:id) @items = args[:items] if args.key?(:items) @location = args[:location] if args.key?(:location) @maximum = args[:maximum] if args.key?(:maximum) @minimum = args[:minimum] if args.key?(:minimum) @pattern = args[:pattern] if args.key?(:pattern) @properties = args[:properties] if args.key?(:properties) @read_only = args[:read_only] if args.key?(:read_only) @repeated = args[:repeated] if args.key?(:repeated) @required = args[:required] if args.key?(:required) @type = args[:type] if args.key?(:type) @variant = args[:variant] if args.key?(:variant) end # Additional information about this property. class Annotations include Google::Apis::Core::Hashable # A list of methods for which this property is required on requests. # Corresponds to the JSON property `required` # @return [Array] attr_accessor :required def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @required = args[:required] if args.key?(:required) end end # In a variant data type, the value of one property is used to determine how to # interpret the entire entity. Its value must exist in a map of descriminant # values to schema names. class Variant include Google::Apis::Core::Hashable # The name of the type discriminant property. # Corresponds to the JSON property `discriminant` # @return [String] attr_accessor :discriminant # The map of discriminant value to schema to use for parsing.. # Corresponds to the JSON property `map` # @return [Array] attr_accessor :map def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @discriminant = args[:discriminant] if args.key?(:discriminant) @map = args[:map] if args.key?(:map) end # class Map include Google::Apis::Core::Hashable # # Corresponds to the JSON property `$ref` # @return [String] attr_accessor :_ref # # Corresponds to the JSON property `type_value` # @return [String] attr_accessor :type_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @_ref = args[:_ref] if args.key?(:_ref) @type_value = args[:type_value] if args.key?(:type_value) end end end end # class RestDescription include Google::Apis::Core::Hashable # Authentication information. # Corresponds to the JSON property `auth` # @return [Google::Apis::DiscoveryV1::RestDescription::Auth] attr_accessor :auth # [DEPRECATED] The base path for REST requests. # Corresponds to the JSON property `basePath` # @return [String] attr_accessor :base_path # [DEPRECATED] The base URL for REST requests. # Corresponds to the JSON property `baseUrl` # @return [String] attr_accessor :base_url # The path for REST batch requests. # Corresponds to the JSON property `batchPath` # @return [String] attr_accessor :batch_path # Indicates how the API name should be capitalized and split into various parts. # Useful for generating pretty class names. # Corresponds to the JSON property `canonicalName` # @return [String] attr_accessor :canonical_name # The description of this API. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Indicate the version of the Discovery API used to generate this doc. # Corresponds to the JSON property `discoveryVersion` # @return [String] attr_accessor :discovery_version # A link to human readable documentation for the API. # Corresponds to the JSON property `documentationLink` # @return [String] attr_accessor :documentation_link # The ETag for this response. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Enable exponential backoff for suitable methods in the generated clients. # Corresponds to the JSON property `exponentialBackoffDefault` # @return [Boolean] attr_accessor :exponential_backoff_default alias_method :exponential_backoff_default?, :exponential_backoff_default # A list of supported features for this API. # Corresponds to the JSON property `features` # @return [Array] attr_accessor :features # Links to 16x16 and 32x32 icons representing the API. # Corresponds to the JSON property `icons` # @return [Google::Apis::DiscoveryV1::RestDescription::Icons] attr_accessor :icons # The ID of this API. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind for this response. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Labels for the status of this API, such as labs or deprecated. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # API-level methods for this API. # Corresponds to the JSON property `methods` # @return [Hash] attr_accessor :api_methods # The name of this API. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The domain of the owner of this API. Together with the ownerName and a # packagePath values, this can be used to generate a library for this API which # would have a unique fully qualified name. # Corresponds to the JSON property `ownerDomain` # @return [String] attr_accessor :owner_domain # The name of the owner of this API. See ownerDomain. # Corresponds to the JSON property `ownerName` # @return [String] attr_accessor :owner_name # The package of the owner of this API. See ownerDomain. # Corresponds to the JSON property `packagePath` # @return [String] attr_accessor :package_path # Common parameters that apply across all apis. # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters # The protocol described by this document. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol # The resources in this API. # Corresponds to the JSON property `resources` # @return [Hash] attr_accessor :resources # The version of this API. # Corresponds to the JSON property `revision` # @return [String] attr_accessor :revision # The root URL under which all API services live. # Corresponds to the JSON property `rootUrl` # @return [String] attr_accessor :root_url # The schemas for this API. # Corresponds to the JSON property `schemas` # @return [Hash] attr_accessor :schemas # The base path for all REST requests. # Corresponds to the JSON property `servicePath` # @return [String] attr_accessor :service_path # The title of this API. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The version of this API. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version # # Corresponds to the JSON property `version_module` # @return [Boolean] attr_accessor :version_module alias_method :version_module?, :version_module def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auth = args[:auth] if args.key?(:auth) @base_path = args[:base_path] if args.key?(:base_path) @base_url = args[:base_url] if args.key?(:base_url) @batch_path = args[:batch_path] if args.key?(:batch_path) @canonical_name = args[:canonical_name] if args.key?(:canonical_name) @description = args[:description] if args.key?(:description) @discovery_version = args[:discovery_version] if args.key?(:discovery_version) @documentation_link = args[:documentation_link] if args.key?(:documentation_link) @etag = args[:etag] if args.key?(:etag) @exponential_backoff_default = args[:exponential_backoff_default] if args.key?(:exponential_backoff_default) @features = args[:features] if args.key?(:features) @icons = args[:icons] if args.key?(:icons) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @labels = args[:labels] if args.key?(:labels) @api_methods = args[:api_methods] if args.key?(:api_methods) @name = args[:name] if args.key?(:name) @owner_domain = args[:owner_domain] if args.key?(:owner_domain) @owner_name = args[:owner_name] if args.key?(:owner_name) @package_path = args[:package_path] if args.key?(:package_path) @parameters = args[:parameters] if args.key?(:parameters) @protocol = args[:protocol] if args.key?(:protocol) @resources = args[:resources] if args.key?(:resources) @revision = args[:revision] if args.key?(:revision) @root_url = args[:root_url] if args.key?(:root_url) @schemas = args[:schemas] if args.key?(:schemas) @service_path = args[:service_path] if args.key?(:service_path) @title = args[:title] if args.key?(:title) @version = args[:version] if args.key?(:version) @version_module = args[:version_module] if args.key?(:version_module) end # Authentication information. class Auth include Google::Apis::Core::Hashable # OAuth 2.0 authentication information. # Corresponds to the JSON property `oauth2` # @return [Google::Apis::DiscoveryV1::RestDescription::Auth::Oauth2] attr_accessor :oauth2 def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @oauth2 = args[:oauth2] if args.key?(:oauth2) end # OAuth 2.0 authentication information. class Oauth2 include Google::Apis::Core::Hashable # Available OAuth 2.0 scopes. # Corresponds to the JSON property `scopes` # @return [Hash] attr_accessor :scopes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @scopes = args[:scopes] if args.key?(:scopes) end # The scope value. class Scope include Google::Apis::Core::Hashable # Description of scope. # 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) @description = args[:description] if args.key?(:description) end end end end # Links to 16x16 and 32x32 icons representing the API. class Icons include Google::Apis::Core::Hashable # The URL of the 16x16 icon. # Corresponds to the JSON property `x16` # @return [String] attr_accessor :x16 # The URL of the 32x32 icon. # Corresponds to the JSON property `x32` # @return [String] attr_accessor :x32 def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @x16 = args[:x16] if args.key?(:x16) @x32 = args[:x32] if args.key?(:x32) end end end # class RestMethod include Google::Apis::Core::Hashable # Description of this method. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Whether this method requires an ETag to be specified. The ETag is sent as an # HTTP If-Match or If-None-Match header. # Corresponds to the JSON property `etagRequired` # @return [Boolean] attr_accessor :etag_required alias_method :etag_required?, :etag_required # HTTP method used by this method. # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method # A unique ID for this method. This property can be used to match methods # between different versions of Discovery. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Media upload parameters. # Corresponds to the JSON property `mediaUpload` # @return [Google::Apis::DiscoveryV1::RestMethod::MediaUpload] attr_accessor :media_upload # Ordered list of required parameters, serves as a hint to clients on how to # structure their method signatures. The array is ordered such that the "most- # significant" parameter appears first. # Corresponds to the JSON property `parameterOrder` # @return [Array] attr_accessor :parameter_order # Details for all parameters in this method. # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters # The URI path of this REST method. Should be used in conjunction with the # basePath property at the api-level. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # The schema for the request. # Corresponds to the JSON property `request` # @return [Google::Apis::DiscoveryV1::RestMethod::Request] attr_accessor :request # The schema for the response. # Corresponds to the JSON property `response` # @return [Google::Apis::DiscoveryV1::RestMethod::Response] attr_accessor :response # OAuth 2.0 scopes applicable to this method. # Corresponds to the JSON property `scopes` # @return [Array] attr_accessor :scopes # Whether this method supports media downloads. # Corresponds to the JSON property `supportsMediaDownload` # @return [Boolean] attr_accessor :supports_media_download alias_method :supports_media_download?, :supports_media_download # Whether this method supports media uploads. # Corresponds to the JSON property `supportsMediaUpload` # @return [Boolean] attr_accessor :supports_media_upload alias_method :supports_media_upload?, :supports_media_upload # Whether this method supports subscriptions. # Corresponds to the JSON property `supportsSubscription` # @return [Boolean] attr_accessor :supports_subscription alias_method :supports_subscription?, :supports_subscription # Indicates that downloads from this method should use the download service URL ( # i.e. "/download"). Only applies if the method supports media download. # Corresponds to the JSON property `useMediaDownloadService` # @return [Boolean] attr_accessor :use_media_download_service alias_method :use_media_download_service?, :use_media_download_service def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @etag_required = args[:etag_required] if args.key?(:etag_required) @http_method = args[:http_method] if args.key?(:http_method) @id = args[:id] if args.key?(:id) @media_upload = args[:media_upload] if args.key?(:media_upload) @parameter_order = args[:parameter_order] if args.key?(:parameter_order) @parameters = args[:parameters] if args.key?(:parameters) @path = args[:path] if args.key?(:path) @request = args[:request] if args.key?(:request) @response = args[:response] if args.key?(:response) @scopes = args[:scopes] if args.key?(:scopes) @supports_media_download = args[:supports_media_download] if args.key?(:supports_media_download) @supports_media_upload = args[:supports_media_upload] if args.key?(:supports_media_upload) @supports_subscription = args[:supports_subscription] if args.key?(:supports_subscription) @use_media_download_service = args[:use_media_download_service] if args.key?(:use_media_download_service) end # Media upload parameters. class MediaUpload include Google::Apis::Core::Hashable # MIME Media Ranges for acceptable media uploads to this method. # Corresponds to the JSON property `accept` # @return [Array] attr_accessor :accept # Maximum size of a media upload, such as "1MB", "2GB" or "3TB". # Corresponds to the JSON property `maxSize` # @return [String] attr_accessor :max_size # Supported upload protocols. # Corresponds to the JSON property `protocols` # @return [Google::Apis::DiscoveryV1::RestMethod::MediaUpload::Protocols] attr_accessor :protocols def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accept = args[:accept] if args.key?(:accept) @max_size = args[:max_size] if args.key?(:max_size) @protocols = args[:protocols] if args.key?(:protocols) end # Supported upload protocols. class Protocols include Google::Apis::Core::Hashable # Supports the Resumable Media Upload protocol. # Corresponds to the JSON property `resumable` # @return [Google::Apis::DiscoveryV1::RestMethod::MediaUpload::Protocols::Resumable] attr_accessor :resumable # Supports uploading as a single HTTP request. # Corresponds to the JSON property `simple` # @return [Google::Apis::DiscoveryV1::RestMethod::MediaUpload::Protocols::Simple] attr_accessor :simple def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resumable = args[:resumable] if args.key?(:resumable) @simple = args[:simple] if args.key?(:simple) end # Supports the Resumable Media Upload protocol. class Resumable include Google::Apis::Core::Hashable # True if this endpoint supports uploading multipart media. # Corresponds to the JSON property `multipart` # @return [Boolean] attr_accessor :multipart alias_method :multipart?, :multipart # The URI path to be used for upload. Should be used in conjunction with the # basePath property at the api-level. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @multipart = args[:multipart] if args.key?(:multipart) @path = args[:path] if args.key?(:path) end end # Supports uploading as a single HTTP request. class Simple include Google::Apis::Core::Hashable # True if this endpoint supports upload multipart media. # Corresponds to the JSON property `multipart` # @return [Boolean] attr_accessor :multipart alias_method :multipart?, :multipart # The URI path to be used for upload. Should be used in conjunction with the # basePath property at the api-level. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @multipart = args[:multipart] if args.key?(:multipart) @path = args[:path] if args.key?(:path) end end end end # The schema for the request. class Request include Google::Apis::Core::Hashable # Schema ID for the request schema. # Corresponds to the JSON property `$ref` # @return [String] attr_accessor :_ref # parameter name. # Corresponds to the JSON property `parameterName` # @return [String] attr_accessor :parameter_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @_ref = args[:_ref] if args.key?(:_ref) @parameter_name = args[:parameter_name] if args.key?(:parameter_name) end end # The schema for the response. class Response include Google::Apis::Core::Hashable # Schema ID for the response schema. # Corresponds to the JSON property `$ref` # @return [String] attr_accessor :_ref def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @_ref = args[:_ref] if args.key?(:_ref) end end end # class RestResource include Google::Apis::Core::Hashable # Methods on this resource. # Corresponds to the JSON property `methods` # @return [Hash] attr_accessor :api_methods # Sub-resources on this resource. # Corresponds to the JSON property `resources` # @return [Hash] attr_accessor :resources def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @api_methods = args[:api_methods] if args.key?(:api_methods) @resources = args[:resources] if args.key?(:resources) end end end end end google-api-client-0.19.8/generated/google/apis/discovery_v1/service.rb0000644000004100000410000001534413252673043025724 0ustar www-datawww-data# 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 DiscoveryV1 # APIs Discovery Service # # Provides information about other Google APIs, such as what APIs are available, # the resource, and method details for each API. # # @example # require 'google/apis/discovery_v1' # # Discovery = Google::Apis::DiscoveryV1 # Alias the module # service = Discovery::DiscoveryService.new # # @see https://developers.google.com/discovery/ class DiscoveryService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'discovery/v1/') @batch_path = 'batch/discovery/v1' end # Retrieve the description of a particular version of an api. # @param [String] api # The name of the API. # @param [String] version # The version of the 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DiscoveryV1::RestDescription] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DiscoveryV1::RestDescription] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_rest_api(api, version, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'apis/{api}/{version}/rest', options) command.response_representation = Google::Apis::DiscoveryV1::RestDescription::Representation command.response_class = Google::Apis::DiscoveryV1::RestDescription command.params['api'] = api unless api.nil? command.params['version'] = version unless 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 # Retrieve the list of APIs supported at this endpoint. # @param [String] name # Only include APIs with the given name. # @param [Boolean] preferred # Return only the preferred version of an 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::DiscoveryV1::DirectoryList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::DiscoveryV1::DirectoryList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_apis(name: nil, preferred: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'apis', options) command.response_representation = Google::Apis::DiscoveryV1::DirectoryList::Representation command.response_class = Google::Apis::DiscoveryV1::DirectoryList command.query['name'] = name unless name.nil? command.query['preferred'] = preferred unless preferred.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 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 end end google-api-client-0.19.8/generated/google/apis/licensing_v1.rb0000644000004100000410000000216413252673044024225 0ustar www-datawww-data# 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/licensing_v1/service.rb' require 'google/apis/licensing_v1/classes.rb' require 'google/apis/licensing_v1/representations.rb' module Google module Apis # Enterprise License Manager API # # Views and manages licenses for your domain. # # @see https://developers.google.com/google-apps/licensing/ module LicensingV1 VERSION = 'V1' REVISION = '20170213' # View and manage G Suite licenses for your domain AUTH_APPS_LICENSING = 'https://www.googleapis.com/auth/apps.licensing' end end end google-api-client-0.19.8/generated/google/apis/clouduseraccounts_beta.rb0000644000004100000410000000324613252673043026405 0ustar www-datawww-data# 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/clouduseraccounts_beta/service.rb' require 'google/apis/clouduseraccounts_beta/classes.rb' require 'google/apis/clouduseraccounts_beta/representations.rb' module Google module Apis # Cloud User Accounts API # # Creates and manages users and groups for accessing Google Compute Engine # virtual machines. # # @see https://cloud.google.com/compute/docs/access/user-accounts/api/latest/ module ClouduseraccountsBeta VERSION = 'Beta' REVISION = '20160316' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' # Manage your Google Cloud User Accounts AUTH_CLOUD_USERACCOUNTS = 'https://www.googleapis.com/auth/cloud.useraccounts' # View your Google Cloud User Accounts AUTH_CLOUD_USERACCOUNTS_READONLY = 'https://www.googleapis.com/auth/cloud.useraccounts.readonly' end end end google-api-client-0.19.8/generated/google/apis/analytics_v2_4.rb0000644000004100000410000000233013252673043024457 0ustar www-datawww-data# 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/analytics_v2_4/service.rb' require 'google/apis/analytics_v2_4/classes.rb' require 'google/apis/analytics_v2_4/representations.rb' module Google module Apis # Google Analytics API # # Views and manages your Google Analytics data. # # @see https://developers.google.com/analytics/ module AnalyticsV2_4 VERSION = 'V2_4' REVISION = '20170807' # View and manage your Google Analytics data AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics' # View your Google Analytics data AUTH_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/analytics.readonly' end end end google-api-client-0.19.8/generated/google/apis/groupsmigration_v1.rb0000644000004100000410000000217113252673043025500 0ustar www-datawww-data# 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/groupsmigration_v1/service.rb' require 'google/apis/groupsmigration_v1/classes.rb' require 'google/apis/groupsmigration_v1/representations.rb' module Google module Apis # Groups Migration API # # Groups Migration Api. # # @see https://developers.google.com/google-apps/groups-migration/ module GroupsmigrationV1 VERSION = 'V1' REVISION = '20170607' # Manage messages in groups on your domain AUTH_APPS_GROUPS_MIGRATION = 'https://www.googleapis.com/auth/apps.groups.migration' end end end google-api-client-0.19.8/generated/google/apis/searchconsole_v1.rb0000644000004100000410000000205313252673044025077 0ustar www-datawww-data# 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/searchconsole_v1/service.rb' require 'google/apis/searchconsole_v1/classes.rb' require 'google/apis/searchconsole_v1/representations.rb' module Google module Apis # Google Search Console URL Testing Tools API # # Provides tools for running validation tests against single URLs # # @see https://developers.google.com/webmaster-tools/search-console-api/ module SearchconsoleV1 VERSION = 'V1' REVISION = '20170805' end end end google-api-client-0.19.8/generated/google/apis/bigquerydatatransfer_v1/0000755000004100000410000000000013252673043026147 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/bigquerydatatransfer_v1/representations.rb0000644000004100000410000002757613252673043031742 0ustar www-datawww-data# 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 BigquerydatatransferV1 class CheckValidCredsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CheckValidCredsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DataSource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DataSourceParameter 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 ListDataSourcesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLocationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTransferConfigsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTransferLogsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTransferRunsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Location class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ScheduleTransferRunsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ScheduleTransferRunsResponse 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 TransferConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TransferMessage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TransferRun class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CheckValidCredsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class CheckValidCredsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :has_valid_creds, as: 'hasValidCreds' end end class DataSource # @private class Representation < Google::Apis::Core::JsonRepresentation property :authorization_type, as: 'authorizationType' property :client_id, as: 'clientId' property :data_refresh_type, as: 'dataRefreshType' property :data_source_id, as: 'dataSourceId' property :default_data_refresh_window_days, as: 'defaultDataRefreshWindowDays' property :default_schedule, as: 'defaultSchedule' property :description, as: 'description' property :display_name, as: 'displayName' property :help_url, as: 'helpUrl' property :manual_runs_disabled, as: 'manualRunsDisabled' property :minimum_schedule_interval, as: 'minimumScheduleInterval' property :name, as: 'name' collection :parameters, as: 'parameters', class: Google::Apis::BigquerydatatransferV1::DataSourceParameter, decorator: Google::Apis::BigquerydatatransferV1::DataSourceParameter::Representation collection :scopes, as: 'scopes' property :supports_custom_schedule, as: 'supportsCustomSchedule' property :supports_multiple_transfers, as: 'supportsMultipleTransfers' property :transfer_type, as: 'transferType' property :update_deadline_seconds, as: 'updateDeadlineSeconds' end end class DataSourceParameter # @private class Representation < Google::Apis::Core::JsonRepresentation collection :allowed_values, as: 'allowedValues' property :description, as: 'description' property :display_name, as: 'displayName' collection :fields, as: 'fields', class: Google::Apis::BigquerydatatransferV1::DataSourceParameter, decorator: Google::Apis::BigquerydatatransferV1::DataSourceParameter::Representation property :immutable, as: 'immutable' property :max_value, as: 'maxValue' property :min_value, as: 'minValue' property :param_id, as: 'paramId' property :recurse, as: 'recurse' property :repeated, as: 'repeated' property :required, as: 'required' property :type, as: 'type' property :validation_description, as: 'validationDescription' property :validation_help_url, as: 'validationHelpUrl' property :validation_regex, as: 'validationRegex' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ListDataSourcesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :data_sources, as: 'dataSources', class: Google::Apis::BigquerydatatransferV1::DataSource, decorator: Google::Apis::BigquerydatatransferV1::DataSource::Representation property :next_page_token, as: 'nextPageToken' end end class ListLocationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :locations, as: 'locations', class: Google::Apis::BigquerydatatransferV1::Location, decorator: Google::Apis::BigquerydatatransferV1::Location::Representation property :next_page_token, as: 'nextPageToken' end end class ListTransferConfigsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :transfer_configs, as: 'transferConfigs', class: Google::Apis::BigquerydatatransferV1::TransferConfig, decorator: Google::Apis::BigquerydatatransferV1::TransferConfig::Representation end end class ListTransferLogsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :transfer_messages, as: 'transferMessages', class: Google::Apis::BigquerydatatransferV1::TransferMessage, decorator: Google::Apis::BigquerydatatransferV1::TransferMessage::Representation end end class ListTransferRunsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :transfer_runs, as: 'transferRuns', class: Google::Apis::BigquerydatatransferV1::TransferRun, decorator: Google::Apis::BigquerydatatransferV1::TransferRun::Representation end end class Location # @private class Representation < Google::Apis::Core::JsonRepresentation hash :labels, as: 'labels' property :location_id, as: 'locationId' hash :metadata, as: 'metadata' property :name, as: 'name' end end class ScheduleTransferRunsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime' property :start_time, as: 'startTime' end end class ScheduleTransferRunsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :runs, as: 'runs', class: Google::Apis::BigquerydatatransferV1::TransferRun, decorator: Google::Apis::BigquerydatatransferV1::TransferRun::Representation 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 TransferConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :data_refresh_window_days, as: 'dataRefreshWindowDays' property :data_source_id, as: 'dataSourceId' property :dataset_region, as: 'datasetRegion' property :destination_dataset_id, as: 'destinationDatasetId' property :disabled, as: 'disabled' property :display_name, as: 'displayName' property :name, as: 'name' property :next_run_time, as: 'nextRunTime' hash :params, as: 'params' property :schedule, as: 'schedule' property :state, as: 'state' property :update_time, as: 'updateTime' property :user_id, :numeric_string => true, as: 'userId' end end class TransferMessage # @private class Representation < Google::Apis::Core::JsonRepresentation property :message_text, as: 'messageText' property :message_time, as: 'messageTime' property :severity, as: 'severity' end end class TransferRun # @private class Representation < Google::Apis::Core::JsonRepresentation property :data_source_id, as: 'dataSourceId' property :destination_dataset_id, as: 'destinationDatasetId' property :end_time, as: 'endTime' property :error_status, as: 'errorStatus', class: Google::Apis::BigquerydatatransferV1::Status, decorator: Google::Apis::BigquerydatatransferV1::Status::Representation property :name, as: 'name' hash :params, as: 'params' property :run_time, as: 'runTime' property :schedule, as: 'schedule' property :schedule_time, as: 'scheduleTime' property :start_time, as: 'startTime' property :state, as: 'state' property :update_time, as: 'updateTime' property :user_id, :numeric_string => true, as: 'userId' end end end end end google-api-client-0.19.8/generated/google/apis/bigquerydatatransfer_v1/classes.rb0000644000004100000410000011720313252673043030135 0ustar www-datawww-data# 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 BigquerydatatransferV1 # A request to determine whether the user has valid credentials. This method # is used to limit the number of OAuth popups in the user interface. The # user id is inferred from the API call context. # If the data source has the Google+ authorization type, this method # returns false, as it cannot be determined whether the credentials are # already valid merely based on the user id. class CheckValidCredsRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # A response indicating whether the credentials exist and are valid. class CheckValidCredsResponse include Google::Apis::Core::Hashable # If set to `true`, the credentials exist and are valid. # Corresponds to the JSON property `hasValidCreds` # @return [Boolean] attr_accessor :has_valid_creds alias_method :has_valid_creds?, :has_valid_creds def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @has_valid_creds = args[:has_valid_creds] if args.key?(:has_valid_creds) end end # Represents data source metadata. Metadata is sufficient to # render UI and request proper OAuth tokens. class DataSource include Google::Apis::Core::Hashable # Indicates the type of authorization. # Corresponds to the JSON property `authorizationType` # @return [String] attr_accessor :authorization_type # Data source client id which should be used to receive refresh token. # When not supplied, no offline credentials are populated for data transfer. # Corresponds to the JSON property `clientId` # @return [String] attr_accessor :client_id # Specifies whether the data source supports automatic data refresh for the # past few days, and how it's supported. # For some data sources, data might not be complete until a few days later, # so it's useful to refresh data automatically. # Corresponds to the JSON property `dataRefreshType` # @return [String] attr_accessor :data_refresh_type # Data source id. # Corresponds to the JSON property `dataSourceId` # @return [String] attr_accessor :data_source_id # Default data refresh window on days. # Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. # Corresponds to the JSON property `defaultDataRefreshWindowDays` # @return [Fixnum] attr_accessor :default_data_refresh_window_days # Default data transfer schedule. # Examples of valid schedules include: # `1st,3rd monday of month 15:30`, # `every wed,fri of jan,jun 13:15`, and # `first sunday of quarter 00:00`. # Corresponds to the JSON property `defaultSchedule` # @return [String] attr_accessor :default_schedule # User friendly data source description string. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # User friendly data source name. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Url for the help document for this data source. # Corresponds to the JSON property `helpUrl` # @return [String] attr_accessor :help_url # Disables backfilling and manual run scheduling # for the data source. # Corresponds to the JSON property `manualRunsDisabled` # @return [Boolean] attr_accessor :manual_runs_disabled alias_method :manual_runs_disabled?, :manual_runs_disabled # The minimum interval for scheduler to schedule runs. # Corresponds to the JSON property `minimumScheduleInterval` # @return [String] attr_accessor :minimum_schedule_interval # Data source resource name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Data source parameters. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Api auth scopes for which refresh token needs to be obtained. Only valid # when `client_id` is specified. Ignored otherwise. These are scopes needed # by a data source to prepare data and ingest them into BigQuery, # e.g., https://www.googleapis.com/auth/bigquery # Corresponds to the JSON property `scopes` # @return [Array] attr_accessor :scopes # Specifies whether the data source supports a user defined schedule, or # operates on the default schedule. # When set to `true`, user can override default schedule. # Corresponds to the JSON property `supportsCustomSchedule` # @return [Boolean] attr_accessor :supports_custom_schedule alias_method :supports_custom_schedule?, :supports_custom_schedule # Indicates whether the data source supports multiple transfers # to different BigQuery targets. # Corresponds to the JSON property `supportsMultipleTransfers` # @return [Boolean] attr_accessor :supports_multiple_transfers alias_method :supports_multiple_transfers?, :supports_multiple_transfers # Transfer type. Currently supports only batch transfers, # which are transfers that use the BigQuery batch APIs (load or # query) to ingest the data. # Corresponds to the JSON property `transferType` # @return [String] attr_accessor :transfer_type # The number of seconds to wait for an update from the data source # before BigQuery marks the transfer as failed. # Corresponds to the JSON property `updateDeadlineSeconds` # @return [Fixnum] attr_accessor :update_deadline_seconds def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @authorization_type = args[:authorization_type] if args.key?(:authorization_type) @client_id = args[:client_id] if args.key?(:client_id) @data_refresh_type = args[:data_refresh_type] if args.key?(:data_refresh_type) @data_source_id = args[:data_source_id] if args.key?(:data_source_id) @default_data_refresh_window_days = args[:default_data_refresh_window_days] if args.key?(:default_data_refresh_window_days) @default_schedule = args[:default_schedule] if args.key?(:default_schedule) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @help_url = args[:help_url] if args.key?(:help_url) @manual_runs_disabled = args[:manual_runs_disabled] if args.key?(:manual_runs_disabled) @minimum_schedule_interval = args[:minimum_schedule_interval] if args.key?(:minimum_schedule_interval) @name = args[:name] if args.key?(:name) @parameters = args[:parameters] if args.key?(:parameters) @scopes = args[:scopes] if args.key?(:scopes) @supports_custom_schedule = args[:supports_custom_schedule] if args.key?(:supports_custom_schedule) @supports_multiple_transfers = args[:supports_multiple_transfers] if args.key?(:supports_multiple_transfers) @transfer_type = args[:transfer_type] if args.key?(:transfer_type) @update_deadline_seconds = args[:update_deadline_seconds] if args.key?(:update_deadline_seconds) end end # Represents a data source parameter with validation rules, so that # parameters can be rendered in the UI. These parameters are given to us by # supported data sources, and include all needed information for rendering # and validation. # Thus, whoever uses this api can decide to generate either generic ui, # or custom data source specific forms. class DataSourceParameter include Google::Apis::Core::Hashable # All possible values for the parameter. # Corresponds to the JSON property `allowedValues` # @return [Array] attr_accessor :allowed_values # Parameter description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Parameter display name in the user interface. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # When parameter is a record, describes child fields. # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields # Cannot be changed after initial creation. # Corresponds to the JSON property `immutable` # @return [Boolean] attr_accessor :immutable alias_method :immutable?, :immutable # For integer and double values specifies maxminum allowed value. # Corresponds to the JSON property `maxValue` # @return [Float] attr_accessor :max_value # For integer and double values specifies minimum allowed value. # Corresponds to the JSON property `minValue` # @return [Float] attr_accessor :min_value # Parameter identifier. # Corresponds to the JSON property `paramId` # @return [String] attr_accessor :param_id # If set to true, schema should be taken from the parent with the same # parameter_id. Only applicable when parameter type is RECORD. # Corresponds to the JSON property `recurse` # @return [Boolean] attr_accessor :recurse alias_method :recurse?, :recurse # Can parameter have multiple values. # Corresponds to the JSON property `repeated` # @return [Boolean] attr_accessor :repeated alias_method :repeated?, :repeated # Is parameter required. # Corresponds to the JSON property `required` # @return [Boolean] attr_accessor :required alias_method :required?, :required # Parameter type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Description of the requirements for this field, in case the user input does # not fulfill the regex pattern or min/max values. # Corresponds to the JSON property `validationDescription` # @return [String] attr_accessor :validation_description # URL to a help document to further explain the naming requirements. # Corresponds to the JSON property `validationHelpUrl` # @return [String] attr_accessor :validation_help_url # Regular expression which can be used for parameter validation. # Corresponds to the JSON property `validationRegex` # @return [String] attr_accessor :validation_regex def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allowed_values = args[:allowed_values] if args.key?(:allowed_values) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @fields = args[:fields] if args.key?(:fields) @immutable = args[:immutable] if args.key?(:immutable) @max_value = args[:max_value] if args.key?(:max_value) @min_value = args[:min_value] if args.key?(:min_value) @param_id = args[:param_id] if args.key?(:param_id) @recurse = args[:recurse] if args.key?(:recurse) @repeated = args[:repeated] if args.key?(:repeated) @required = args[:required] if args.key?(:required) @type = args[:type] if args.key?(:type) @validation_description = args[:validation_description] if args.key?(:validation_description) @validation_help_url = args[:validation_help_url] if args.key?(:validation_help_url) @validation_regex = args[:validation_regex] if args.key?(:validation_regex) 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 # Returns list of supported data sources and their metadata. class ListDataSourcesResponse include Google::Apis::Core::Hashable # List of supported data sources and their transfer settings. # Corresponds to the JSON property `dataSources` # @return [Array] attr_accessor :data_sources # Output only. The next-pagination token. For multiple-page list results, # this token can be used as the # `ListDataSourcesRequest.page_token` # to request the next page of list 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) @data_sources = args[:data_sources] if args.key?(:data_sources) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Locations.ListLocations. class ListLocationsResponse include Google::Apis::Core::Hashable # A list of locations that matches the specified filter in the request. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # The standard List next-page token. # 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) @locations = args[:locations] if args.key?(:locations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The returned list of pipelines in the project. class ListTransferConfigsResponse include Google::Apis::Core::Hashable # Output only. The next-pagination token. For multiple-page list results, # this token can be used as the # `ListTransferConfigsRequest.page_token` # to request the next page of list results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. The stored pipeline transfer configurations. # Corresponds to the JSON property `transferConfigs` # @return [Array] attr_accessor :transfer_configs 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) @transfer_configs = args[:transfer_configs] if args.key?(:transfer_configs) end end # The returned list transfer run messages. class ListTransferLogsResponse include Google::Apis::Core::Hashable # Output only. The next-pagination token. For multiple-page list results, # this token can be used as the # `GetTransferRunLogRequest.page_token` # to request the next page of list results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. The stored pipeline transfer messages. # Corresponds to the JSON property `transferMessages` # @return [Array] attr_accessor :transfer_messages 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) @transfer_messages = args[:transfer_messages] if args.key?(:transfer_messages) end end # The returned list of pipelines in the project. class ListTransferRunsResponse include Google::Apis::Core::Hashable # Output only. The next-pagination token. For multiple-page list results, # this token can be used as the # `ListTransferRunsRequest.page_token` # to request the next page of list results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Output only. The stored pipeline transfer runs. # Corresponds to the JSON property `transferRuns` # @return [Array] attr_accessor :transfer_runs 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) @transfer_runs = args[:transfer_runs] if args.key?(:transfer_runs) end end # A resource that represents Google Cloud Platform location. class Location include Google::Apis::Core::Hashable # Cross-service attributes for the location. For example # `"cloud.googleapis.com/region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The canonical id for this location. For example: `"us-east1"`. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # Service-specific metadata. For example the available capacity at the given # location. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # Resource name for the location, which may vary between implementations. # For example: `"projects/example-project/locations/us-east1"` # 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) @labels = args[:labels] if args.key?(:labels) @location_id = args[:location_id] if args.key?(:location_id) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) end end # A request to schedule transfer runs for a time range. class ScheduleTransferRunsRequest include Google::Apis::Core::Hashable # End time of the range of transfer runs. For example, # `"2017-05-30T00:00:00+00:00"`. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Start time of the range of transfer runs. For example, # `"2017-05-25T00:00:00+00:00"`. # 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 # A response to schedule transfer runs for a time range. class ScheduleTransferRunsResponse include Google::Apis::Core::Hashable # The transfer runs that were scheduled. # Corresponds to the JSON property `runs` # @return [Array] attr_accessor :runs def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @runs = args[:runs] if args.key?(:runs) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 data transfer configuration. A transfer configuration # contains all metadata needed to perform a data transfer. For example, # `destination_dataset_id` specifies where data should be stored. # When a new transfer configuration is created, the specified # `destination_dataset_id` is created when needed and shared with the # appropriate data source service account. # Next id: 21 class TransferConfig include Google::Apis::Core::Hashable # The number of days to look back to automatically refresh the data. # For example, if `data_refresh_window_days = 10`, then every day # BigQuery reingests data for [today-10, today-1], rather than ingesting data # for just [today-1]. # Only valid if the data source supports the feature. Set the value to 0 # to use the default value. # Corresponds to the JSON property `dataRefreshWindowDays` # @return [Fixnum] attr_accessor :data_refresh_window_days # Data source id. Cannot be changed once data transfer is created. # Corresponds to the JSON property `dataSourceId` # @return [String] attr_accessor :data_source_id # Output only. Region in which BigQuery dataset is located. # Corresponds to the JSON property `datasetRegion` # @return [String] attr_accessor :dataset_region # The BigQuery target dataset id. # Corresponds to the JSON property `destinationDatasetId` # @return [String] attr_accessor :destination_dataset_id # Is this config disabled. When set to true, no runs are scheduled # for a given transfer. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled alias_method :disabled?, :disabled # User specified display name for the data transfer. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The resource name of the transfer config. # Transfer config names have the form # `projects/`project_id`/transferConfigs/`config_id``. # Where `config_id` is usually a uuid, even though it is not # guaranteed or required. The name is ignored when creating a transfer # config. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. Next time when data transfer will run. # Corresponds to the JSON property `nextRunTime` # @return [String] attr_accessor :next_run_time # Data transfer specific parameters. # Corresponds to the JSON property `params` # @return [Hash] attr_accessor :params # Data transfer schedule. # If the data source does not support a custom schedule, this should be # empty. If it is empty, the default value for the data source will be # used. # The specified times are in UTC. # Examples of valid format: # `1st,3rd monday of month 15:30`, # `every wed,fri of jan,jun 13:15`, and # `first sunday of quarter 00:00`. # See more explanation about the format here: # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with- # cron-yaml#the_schedule_format # NOTE: the granularity should be at least 8 hours, or less frequent. # Corresponds to the JSON property `schedule` # @return [String] attr_accessor :schedule # Output only. State of the most recently updated transfer run. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. Data transfer modification time. Ignored by server on input. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Output only. Unique ID of the user on whose behalf transfer is done. # Applicable only to data sources that do not support service accounts. # When set to 0, the data source service account credentials are used. # May be negative. Note, that this identifier is not stable. # It may change over time even for the same user. # Corresponds to the JSON property `userId` # @return [Fixnum] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data_refresh_window_days = args[:data_refresh_window_days] if args.key?(:data_refresh_window_days) @data_source_id = args[:data_source_id] if args.key?(:data_source_id) @dataset_region = args[:dataset_region] if args.key?(:dataset_region) @destination_dataset_id = args[:destination_dataset_id] if args.key?(:destination_dataset_id) @disabled = args[:disabled] if args.key?(:disabled) @display_name = args[:display_name] if args.key?(:display_name) @name = args[:name] if args.key?(:name) @next_run_time = args[:next_run_time] if args.key?(:next_run_time) @params = args[:params] if args.key?(:params) @schedule = args[:schedule] if args.key?(:schedule) @state = args[:state] if args.key?(:state) @update_time = args[:update_time] if args.key?(:update_time) @user_id = args[:user_id] if args.key?(:user_id) end end # Represents a user facing message for a particular data transfer run. class TransferMessage include Google::Apis::Core::Hashable # Message text. # Corresponds to the JSON property `messageText` # @return [String] attr_accessor :message_text # Time when message was logged. # Corresponds to the JSON property `messageTime` # @return [String] attr_accessor :message_time # Message severity. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @message_text = args[:message_text] if args.key?(:message_text) @message_time = args[:message_time] if args.key?(:message_time) @severity = args[:severity] if args.key?(:severity) end end # Represents a data transfer run. # Next id: 27 class TransferRun include Google::Apis::Core::Hashable # Output only. Data source id. # Corresponds to the JSON property `dataSourceId` # @return [String] attr_accessor :data_source_id # Output only. The BigQuery target dataset id. # Corresponds to the JSON property `destinationDatasetId` # @return [String] attr_accessor :destination_dataset_id # Output only. Time when transfer run ended. # Parameter ignored by server for input requests. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `errorStatus` # @return [Google::Apis::BigquerydatatransferV1::Status] attr_accessor :error_status # The resource name of the transfer run. # Transfer run names have the form # `projects/`project_id`/locations/`location`/transferConfigs/`config_id`/runs/` # run_id``. # The name is ignored when creating a transfer run. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. Data transfer specific parameters. # Corresponds to the JSON property `params` # @return [Hash] attr_accessor :params # For batch transfer runs, specifies the date and time that # data should be ingested. # Corresponds to the JSON property `runTime` # @return [String] attr_accessor :run_time # Output only. Describes the schedule of this transfer run if it was # created as part of a regular schedule. For batch transfer runs that are # scheduled manually, this is empty. # NOTE: the system might choose to delay the schedule depending on the # current load, so `schedule_time` doesn't always matches this. # Corresponds to the JSON property `schedule` # @return [String] attr_accessor :schedule # Minimum time after which a transfer run can be started. # Corresponds to the JSON property `scheduleTime` # @return [String] attr_accessor :schedule_time # Output only. Time when transfer run was started. # Parameter ignored by server for input requests. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Data transfer run state. Ignored for input requests. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. Last time the data transfer run state was updated. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Output only. Unique ID of the user on whose behalf transfer is done. # Applicable only to data sources that do not support service accounts. # When set to 0, the data source service account credentials are used. # May be negative. Note, that this identifier is not stable. # It may change over time even for the same user. # Corresponds to the JSON property `userId` # @return [Fixnum] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @data_source_id = args[:data_source_id] if args.key?(:data_source_id) @destination_dataset_id = args[:destination_dataset_id] if args.key?(:destination_dataset_id) @end_time = args[:end_time] if args.key?(:end_time) @error_status = args[:error_status] if args.key?(:error_status) @name = args[:name] if args.key?(:name) @params = args[:params] if args.key?(:params) @run_time = args[:run_time] if args.key?(:run_time) @schedule = args[:schedule] if args.key?(:schedule) @schedule_time = args[:schedule_time] if args.key?(:schedule_time) @start_time = args[:start_time] if args.key?(:start_time) @state = args[:state] if args.key?(:state) @update_time = args[:update_time] if args.key?(:update_time) @user_id = args[:user_id] if args.key?(:user_id) end end end end end google-api-client-0.19.8/generated/google/apis/bigquerydatatransfer_v1/service.rb0000644000004100000410000022256313252673043030146 0ustar www-datawww-data# 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 BigquerydatatransferV1 # BigQuery Data Transfer API # # Transfers data from partner SaaS applications to Google BigQuery on a # scheduled, managed basis. # # @example # require 'google/apis/bigquerydatatransfer_v1' # # Bigquerydatatransfer = Google::Apis::BigquerydatatransferV1 # Alias the module # service = Bigquerydatatransfer::BigQueryDataTransferService.new # # @see https://cloud.google.com/bigquery/ class BigQueryDataTransferService < 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://bigquerydatatransfer.googleapis.com/', '') @batch_path = 'batch' end # Returns true if valid credentials exist for the given data source and # requesting user. # Some data sources doesn't support service account, so we need to talk to # them on behalf of the end user. This API just checks whether we have OAuth # token for the particular user, which is a pre-requisite before user can # create a transfer config. # @param [String] name # The data source in the form: # `projects/`project_id`/dataSources/`data_source_id`` # @param [Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest] check_valid_creds_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::BigquerydatatransferV1::CheckValidCredsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def check_project_data_source_valid_creds(name, check_valid_creds_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:checkValidCreds', options) command.request_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest::Representation command.request_object = check_valid_creds_request_object command.response_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse 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 # Retrieves a supported data source and returns its settings, # which can be used for UI rendering. # @param [String] name # The field will contain name of the resource requested, for example: # `projects/`project_id`/dataSources/`data_source_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::BigquerydatatransferV1::DataSource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::DataSource] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_data_source(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::DataSource::Representation command.response_class = Google::Apis::BigquerydatatransferV1::DataSource 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 supported data sources and returns their settings, # which can be used for UI rendering. # @param [String] parent # The BigQuery project id for which data sources should be returned. # Must be in the form: `projects/`project_id`` # @param [Fixnum] page_size # Page size. The default page size is the maximum value of 1000 results. # @param [String] page_token # Pagination token, which can be used to request a specific page # of `ListDataSourcesRequest` list results. For multiple-page # results, `ListDataSourcesResponse` outputs # a `next_page` token, which can be used as the # `page_token` value to request the next page of list results. # @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::BigquerydatatransferV1::ListDataSourcesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_data_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/dataSources', options) command.response_representation = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse 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 # Get information about a location. # @param [String] name # Resource name for the location. # @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::BigquerydatatransferV1::Location] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::Location] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::Location::Representation command.response_class = Google::Apis::BigquerydatatransferV1::Location 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 information about the supported locations for this service. # @param [String] name # The resource that owns the locations collection, if applicable. # @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::BigquerydatatransferV1::ListLocationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ListLocationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/locations', options) command.response_representation = Google::Apis::BigquerydatatransferV1::ListLocationsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ListLocationsResponse 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 # Returns true if valid credentials exist for the given data source and # requesting user. # Some data sources doesn't support service account, so we need to talk to # them on behalf of the end user. This API just checks whether we have OAuth # token for the particular user, which is a pre-requisite before user can # create a transfer config. # @param [String] name # The data source in the form: # `projects/`project_id`/dataSources/`data_source_id`` # @param [Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest] check_valid_creds_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::BigquerydatatransferV1::CheckValidCredsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def check_project_location_data_source_valid_creds(name, check_valid_creds_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:checkValidCreds', options) command.request_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest::Representation command.request_object = check_valid_creds_request_object command.response_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse 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 # Retrieves a supported data source and returns its settings, # which can be used for UI rendering. # @param [String] name # The field will contain name of the resource requested, for example: # `projects/`project_id`/dataSources/`data_source_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::BigquerydatatransferV1::DataSource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::DataSource] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_data_source(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::DataSource::Representation command.response_class = Google::Apis::BigquerydatatransferV1::DataSource 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 supported data sources and returns their settings, # which can be used for UI rendering. # @param [String] parent # The BigQuery project id for which data sources should be returned. # Must be in the form: `projects/`project_id`` # @param [Fixnum] page_size # Page size. The default page size is the maximum value of 1000 results. # @param [String] page_token # Pagination token, which can be used to request a specific page # of `ListDataSourcesRequest` list results. For multiple-page # results, `ListDataSourcesResponse` outputs # a `next_page` token, which can be used as the # `page_token` value to request the next page of list results. # @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::BigquerydatatransferV1::ListDataSourcesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_data_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/dataSources', options) command.response_representation = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse 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 # Creates a new data transfer configuration. # @param [String] parent # The BigQuery project id where the transfer configuration should be created. # Must be in the format /projects/`project_id`/locations/`location_id` # If specified location and location of the destination bigquery dataset # do not match - the request will fail. # @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object # @param [String] authorization_code # Optional OAuth2 authorization code to use with this transfer configuration. # This is required if new credentials are needed, as indicated by # `CheckValidCreds`. # In order to obtain authorization_code, please make a # request to # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=< # datatransferapiclientid>&scope=&redirect_uri= # * client_id should be OAuth client_id of BigQuery DTS API for the given # data source returned by ListDataSources method. # * data_source_scopes are the scopes returned by ListDataSources method. # * redirect_uri is an optional parameter. If not specified, then # authorization code is posted to the opener of authorization flow window. # Otherwise it will be sent to the redirect uri. A special value of # urn:ietf:wg:oauth:2.0:oob means that authorization code should be # returned in the title bar of the browser, with the page text prompting # the user to copy the code and paste it in the application. # @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::BigquerydatatransferV1::TransferConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::TransferConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_transfer_config(parent, transfer_config_object = nil, authorization_code: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/transferConfigs', options) command.request_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation command.request_object = transfer_config_object command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig command.params['parent'] = parent unless parent.nil? command.query['authorizationCode'] = authorization_code unless authorization_code.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 data transfer configuration, # including any associated transfer runs and logs. # @param [String] name # The field will contain name of the resource requested, for example: # `projects/`project_id`/transferConfigs/`config_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::BigquerydatatransferV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::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_location_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation command.response_class = Google::Apis::BigquerydatatransferV1::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 # Returns information about a data transfer config. # @param [String] name # The field will contain name of the resource requested, for example: # `projects/`project_id`/transferConfigs/`config_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::BigquerydatatransferV1::TransferConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::TransferConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig 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 information about all data transfers in the project. # @param [String] parent # The BigQuery project id for which data sources # should be returned: `projects/`project_id``. # @param [Array, String] data_source_ids # When specified, only configurations of requested data sources are returned. # @param [Fixnum] page_size # Page size. The default page size is the maximum value of 1000 results. # @param [String] page_token # Pagination token, which can be used to request a specific page # of `ListTransfersRequest` list results. For multiple-page # results, `ListTransfersResponse` outputs # a `next_page` token, which can be used as the # `page_token` value to request the next page of list results. # @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::BigquerydatatransferV1::ListTransferConfigsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_configs(parent, data_source_ids: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/transferConfigs', options) command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse command.params['parent'] = parent unless parent.nil? command.query['dataSourceIds'] = data_source_ids unless data_source_ids.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 data transfer configuration. # All fields must be set, even if they are not updated. # @param [String] name # The resource name of the transfer config. # Transfer config names have the form # `projects/`project_id`/transferConfigs/`config_id``. # Where `config_id` is usually a uuid, even though it is not # guaranteed or required. The name is ignored when creating a transfer # config. # @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object # @param [String] authorization_code # Optional OAuth2 authorization code to use with this transfer configuration. # If it is provided, the transfer configuration will be associated with the # authorizing user. # In order to obtain authorization_code, please make a # request to # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=< # datatransferapiclientid>&scope=&redirect_uri= # * client_id should be OAuth client_id of BigQuery DTS API for the given # data source returned by ListDataSources method. # * data_source_scopes are the scopes returned by ListDataSources method. # * redirect_uri is an optional parameter. If not specified, then # authorization code is posted to the opener of authorization flow window. # Otherwise it will be sent to the redirect uri. A special value of # urn:ietf:wg:oauth:2.0:oob means that authorization code should be # returned in the title bar of the browser, with the page text prompting # the user to copy the code and paste it in the application. # @param [String] update_mask # Required list of fields to be updated in this 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::BigquerydatatransferV1::TransferConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::TransferConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_transfer_config(name, transfer_config_object = nil, authorization_code: 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::BigquerydatatransferV1::TransferConfig::Representation command.request_object = transfer_config_object command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig command.params['name'] = name unless name.nil? command.query['authorizationCode'] = authorization_code unless authorization_code.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 transfer runs for a time range [start_time, end_time]. # For each date - or whatever granularity the data source supports - in the # range, one transfer run is created. # Note that runs are created per UTC time in the time range. # @param [String] parent # Transfer configuration name in the form: # `projects/`project_id`/transferConfigs/`config_id``. # @param [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest] schedule_transfer_runs_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::BigquerydatatransferV1::ScheduleTransferRunsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def schedule_project_location_transfer_config_runs(parent, schedule_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}:scheduleRuns', options) command.request_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest::Representation command.request_object = schedule_transfer_runs_request_object command.response_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse 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 the specified transfer run. # @param [String] name # The field will contain name of the resource requested, for example: # `projects/`project_id`/transferConfigs/`config_id`/runs/`run_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::BigquerydatatransferV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::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_location_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation command.response_class = Google::Apis::BigquerydatatransferV1::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 # Returns information about the particular transfer run. # @param [String] name # The field will contain name of the resource requested, for example: # `projects/`project_id`/transferConfigs/`config_id`/runs/`run_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::BigquerydatatransferV1::TransferRun] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::TransferRun] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::TransferRun::Representation command.response_class = Google::Apis::BigquerydatatransferV1::TransferRun 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 information about running and completed jobs. # @param [String] parent # Name of transfer configuration for which transfer runs should be retrieved. # Format of transfer configuration resource name is: # `projects/`project_id`/transferConfigs/`config_id``. # @param [Fixnum] page_size # Page size. The default page size is the maximum value of 1000 results. # @param [String] page_token # Pagination token, which can be used to request a specific page # of `ListTransferRunsRequest` list results. For multiple-page # results, `ListTransferRunsResponse` outputs # a `next_page` token, which can be used as the # `page_token` value to request the next page of list results. # @param [String] run_attempt # Indicates how run attempts are to be pulled. # @param [Array, String] states # When specified, only transfer runs with requested states are 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::BigquerydatatransferV1::ListTransferRunsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_config_runs(parent, page_size: nil, page_token: nil, run_attempt: nil, states: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/runs', options) command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse 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['runAttempt'] = run_attempt unless run_attempt.nil? command.query['states'] = states unless states.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 user facing log messages for the data transfer run. # @param [String] parent # Transfer run name in the form: # `projects/`project_id`/transferConfigs/`config_Id`/runs/`run_id``. # @param [Array, String] message_types # Message types to return. If not populated - INFO, WARNING and ERROR # messages are returned. # @param [Fixnum] page_size # Page size. The default page size is the maximum value of 1000 results. # @param [String] page_token # Pagination token, which can be used to request a specific page # of `ListTransferLogsRequest` list results. For multiple-page # results, `ListTransferLogsResponse` outputs # a `next_page` token, which can be used as the # `page_token` value to request the next page of list results. # @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::BigquerydatatransferV1::ListTransferLogsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_config_run_transfer_logs(parent, message_types: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/transferLogs', options) command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse command.params['parent'] = parent unless parent.nil? command.query['messageTypes'] = message_types unless message_types.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 data transfer configuration. # @param [String] parent # The BigQuery project id where the transfer configuration should be created. # Must be in the format /projects/`project_id`/locations/`location_id` # If specified location and location of the destination bigquery dataset # do not match - the request will fail. # @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object # @param [String] authorization_code # Optional OAuth2 authorization code to use with this transfer configuration. # This is required if new credentials are needed, as indicated by # `CheckValidCreds`. # In order to obtain authorization_code, please make a # request to # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=< # datatransferapiclientid>&scope=&redirect_uri= # * client_id should be OAuth client_id of BigQuery DTS API for the given # data source returned by ListDataSources method. # * data_source_scopes are the scopes returned by ListDataSources method. # * redirect_uri is an optional parameter. If not specified, then # authorization code is posted to the opener of authorization flow window. # Otherwise it will be sent to the redirect uri. A special value of # urn:ietf:wg:oauth:2.0:oob means that authorization code should be # returned in the title bar of the browser, with the page text prompting # the user to copy the code and paste it in the application. # @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::BigquerydatatransferV1::TransferConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::TransferConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_config(parent, transfer_config_object = nil, authorization_code: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/transferConfigs', options) command.request_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation command.request_object = transfer_config_object command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig command.params['parent'] = parent unless parent.nil? command.query['authorizationCode'] = authorization_code unless authorization_code.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 data transfer configuration, # including any associated transfer runs and logs. # @param [String] name # The field will contain name of the resource requested, for example: # `projects/`project_id`/transferConfigs/`config_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::BigquerydatatransferV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::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_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation command.response_class = Google::Apis::BigquerydatatransferV1::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 # Returns information about a data transfer config. # @param [String] name # The field will contain name of the resource requested, for example: # `projects/`project_id`/transferConfigs/`config_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::BigquerydatatransferV1::TransferConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::TransferConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig 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 information about all data transfers in the project. # @param [String] parent # The BigQuery project id for which data sources # should be returned: `projects/`project_id``. # @param [Array, String] data_source_ids # When specified, only configurations of requested data sources are returned. # @param [Fixnum] page_size # Page size. The default page size is the maximum value of 1000 results. # @param [String] page_token # Pagination token, which can be used to request a specific page # of `ListTransfersRequest` list results. For multiple-page # results, `ListTransfersResponse` outputs # a `next_page` token, which can be used as the # `page_token` value to request the next page of list results. # @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::BigquerydatatransferV1::ListTransferConfigsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_configs(parent, data_source_ids: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/transferConfigs', options) command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse command.params['parent'] = parent unless parent.nil? command.query['dataSourceIds'] = data_source_ids unless data_source_ids.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 data transfer configuration. # All fields must be set, even if they are not updated. # @param [String] name # The resource name of the transfer config. # Transfer config names have the form # `projects/`project_id`/transferConfigs/`config_id``. # Where `config_id` is usually a uuid, even though it is not # guaranteed or required. The name is ignored when creating a transfer # config. # @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object # @param [String] authorization_code # Optional OAuth2 authorization code to use with this transfer configuration. # If it is provided, the transfer configuration will be associated with the # authorizing user. # In order to obtain authorization_code, please make a # request to # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=< # datatransferapiclientid>&scope=&redirect_uri= # * client_id should be OAuth client_id of BigQuery DTS API for the given # data source returned by ListDataSources method. # * data_source_scopes are the scopes returned by ListDataSources method. # * redirect_uri is an optional parameter. If not specified, then # authorization code is posted to the opener of authorization flow window. # Otherwise it will be sent to the redirect uri. A special value of # urn:ietf:wg:oauth:2.0:oob means that authorization code should be # returned in the title bar of the browser, with the page text prompting # the user to copy the code and paste it in the application. # @param [String] update_mask # Required list of fields to be updated in this 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::BigquerydatatransferV1::TransferConfig] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::TransferConfig] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_config(name, transfer_config_object = nil, authorization_code: 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::BigquerydatatransferV1::TransferConfig::Representation command.request_object = transfer_config_object command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig command.params['name'] = name unless name.nil? command.query['authorizationCode'] = authorization_code unless authorization_code.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 transfer runs for a time range [start_time, end_time]. # For each date - or whatever granularity the data source supports - in the # range, one transfer run is created. # Note that runs are created per UTC time in the time range. # @param [String] parent # Transfer configuration name in the form: # `projects/`project_id`/transferConfigs/`config_id``. # @param [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest] schedule_transfer_runs_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::BigquerydatatransferV1::ScheduleTransferRunsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def schedule_project_transfer_config_runs(parent, schedule_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}:scheduleRuns', options) command.request_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest::Representation command.request_object = schedule_transfer_runs_request_object command.response_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse 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 the specified transfer run. # @param [String] name # The field will contain name of the resource requested, for example: # `projects/`project_id`/transferConfigs/`config_id`/runs/`run_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::BigquerydatatransferV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::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_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation command.response_class = Google::Apis::BigquerydatatransferV1::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 # Returns information about the particular transfer run. # @param [String] name # The field will contain name of the resource requested, for example: # `projects/`project_id`/transferConfigs/`config_id`/runs/`run_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::BigquerydatatransferV1::TransferRun] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::TransferRun] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::BigquerydatatransferV1::TransferRun::Representation command.response_class = Google::Apis::BigquerydatatransferV1::TransferRun 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 information about running and completed jobs. # @param [String] parent # Name of transfer configuration for which transfer runs should be retrieved. # Format of transfer configuration resource name is: # `projects/`project_id`/transferConfigs/`config_id``. # @param [Fixnum] page_size # Page size. The default page size is the maximum value of 1000 results. # @param [String] page_token # Pagination token, which can be used to request a specific page # of `ListTransferRunsRequest` list results. For multiple-page # results, `ListTransferRunsResponse` outputs # a `next_page` token, which can be used as the # `page_token` value to request the next page of list results. # @param [String] run_attempt # Indicates how run attempts are to be pulled. # @param [Array, String] states # When specified, only transfer runs with requested states are 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::BigquerydatatransferV1::ListTransferRunsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_config_runs(parent, page_size: nil, page_token: nil, run_attempt: nil, states: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/runs', options) command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse 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['runAttempt'] = run_attempt unless run_attempt.nil? command.query['states'] = states unless states.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 user facing log messages for the data transfer run. # @param [String] parent # Transfer run name in the form: # `projects/`project_id`/transferConfigs/`config_Id`/runs/`run_id``. # @param [Array, String] message_types # Message types to return. If not populated - INFO, WARNING and ERROR # messages are returned. # @param [Fixnum] page_size # Page size. The default page size is the maximum value of 1000 results. # @param [String] page_token # Pagination token, which can be used to request a specific page # of `ListTransferLogsRequest` list results. For multiple-page # results, `ListTransferLogsResponse` outputs # a `next_page` token, which can be used as the # `page_token` value to request the next page of list results. # @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::BigquerydatatransferV1::ListTransferLogsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_transfer_config_run_transfer_logs(parent, message_types: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/transferLogs', options) command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse::Representation command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse command.params['parent'] = parent unless parent.nil? command.query['messageTypes'] = message_types unless message_types.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 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 google-api-client-0.19.8/generated/google/apis/youtubereporting_v1.rb0000644000004100000410000000271513252673044025702 0ustar www-datawww-data# 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/youtubereporting_v1/service.rb' require 'google/apis/youtubereporting_v1/classes.rb' require 'google/apis/youtubereporting_v1/representations.rb' module Google module Apis # YouTube Reporting API # # Schedules reporting jobs containing your YouTube Analytics data and downloads # the resulting bulk data reports in the form of CSV files. # # @see https://developers.google.com/youtube/reporting/v1/reports/ module YoutubereportingV1 VERSION = 'V1' REVISION = '20180109' # View monetary and non-monetary YouTube Analytics reports for your YouTube content AUTH_YT_ANALYTICS_MONETARY_READONLY = 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly' # View YouTube Analytics reports for your YouTube content AUTH_YT_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/yt-analytics.readonly' end end end google-api-client-0.19.8/generated/google/apis/vision_v1.rb0000644000004100000410000000260713252673044023563 0ustar www-datawww-data# 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/vision_v1/service.rb' require 'google/apis/vision_v1/classes.rb' require 'google/apis/vision_v1/representations.rb' module Google module Apis # Google Cloud Vision API # # Integrates Google Vision features, including image labeling, face, logo, and # landmark detection, optical character recognition (OCR), and detection of # explicit content, into applications. # # @see https://cloud.google.com/vision/ module VisionV1 VERSION = 'V1' REVISION = '20180122' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # Apply machine learning models to understand and label images AUTH_CLOUD_VISION = 'https://www.googleapis.com/auth/cloud-vision' end end end google-api-client-0.19.8/generated/google/apis/ml_v1/0000755000004100000410000000000013252673044022332 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/ml_v1/representations.rb0000644000004100000410000005445113252673044026115 0ustar www-datawww-data# 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 MlV1 class GoogleApiHttpBody class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1HyperparameterOutputHyperparameterMetric class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1AutoScaling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1CancelJobRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1Capability class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1GetConfigResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1HyperparameterOutput class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1HyperparameterSpec class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1Job class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1ListJobsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1ListLocationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1ListModelsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1ListVersionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1Location class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1ManualScaling class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1Model class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1OperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1ParameterSpec class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1PredictRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1PredictionInput class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1PredictionOutput class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1SetDefaultVersionRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1TrainingInput class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1TrainingOutput class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleCloudMlV1Version 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 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 GoogleCloudMlV1HyperparameterOutputHyperparameterMetric # @private class Representation < Google::Apis::Core::JsonRepresentation property :objective_value, as: 'objectiveValue' property :training_step, :numeric_string => true, as: 'trainingStep' end end class GoogleCloudMlV1AutoScaling # @private class Representation < Google::Apis::Core::JsonRepresentation property :min_nodes, as: 'minNodes' end end class GoogleCloudMlV1CancelJobRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GoogleCloudMlV1Capability # @private class Representation < Google::Apis::Core::JsonRepresentation collection :available_accelerators, as: 'availableAccelerators' property :type, as: 'type' end end class GoogleCloudMlV1GetConfigResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :service_account, as: 'serviceAccount' property :service_account_project, :numeric_string => true, as: 'serviceAccountProject' end end class GoogleCloudMlV1HyperparameterOutput # @private class Representation < Google::Apis::Core::JsonRepresentation collection :all_metrics, as: 'allMetrics', class: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric, decorator: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric::Representation property :final_metric, as: 'finalMetric', class: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric, decorator: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric::Representation hash :hyperparameters, as: 'hyperparameters' property :is_trial_stopped_early, as: 'isTrialStoppedEarly' property :trial_id, as: 'trialId' end end class GoogleCloudMlV1HyperparameterSpec # @private class Representation < Google::Apis::Core::JsonRepresentation property :enable_trial_early_stopping, as: 'enableTrialEarlyStopping' property :goal, as: 'goal' property :hyperparameter_metric_tag, as: 'hyperparameterMetricTag' property :max_parallel_trials, as: 'maxParallelTrials' property :max_trials, as: 'maxTrials' collection :params, as: 'params', class: Google::Apis::MlV1::GoogleCloudMlV1ParameterSpec, decorator: Google::Apis::MlV1::GoogleCloudMlV1ParameterSpec::Representation property :resume_previous_job_id, as: 'resumePreviousJobId' end end class GoogleCloudMlV1Job # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :end_time, as: 'endTime' property :error_message, as: 'errorMessage' property :job_id, as: 'jobId' property :prediction_input, as: 'predictionInput', class: Google::Apis::MlV1::GoogleCloudMlV1PredictionInput, decorator: Google::Apis::MlV1::GoogleCloudMlV1PredictionInput::Representation property :prediction_output, as: 'predictionOutput', class: Google::Apis::MlV1::GoogleCloudMlV1PredictionOutput, decorator: Google::Apis::MlV1::GoogleCloudMlV1PredictionOutput::Representation property :start_time, as: 'startTime' property :state, as: 'state' property :training_input, as: 'trainingInput', class: Google::Apis::MlV1::GoogleCloudMlV1TrainingInput, decorator: Google::Apis::MlV1::GoogleCloudMlV1TrainingInput::Representation property :training_output, as: 'trainingOutput', class: Google::Apis::MlV1::GoogleCloudMlV1TrainingOutput, decorator: Google::Apis::MlV1::GoogleCloudMlV1TrainingOutput::Representation end end class GoogleCloudMlV1ListJobsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :jobs, as: 'jobs', class: Google::Apis::MlV1::GoogleCloudMlV1Job, decorator: Google::Apis::MlV1::GoogleCloudMlV1Job::Representation property :next_page_token, as: 'nextPageToken' end end class GoogleCloudMlV1ListLocationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :locations, as: 'locations', class: Google::Apis::MlV1::GoogleCloudMlV1Location, decorator: Google::Apis::MlV1::GoogleCloudMlV1Location::Representation property :next_page_token, as: 'nextPageToken' end end class GoogleCloudMlV1ListModelsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :models, as: 'models', class: Google::Apis::MlV1::GoogleCloudMlV1Model, decorator: Google::Apis::MlV1::GoogleCloudMlV1Model::Representation property :next_page_token, as: 'nextPageToken' end end class GoogleCloudMlV1ListVersionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :versions, as: 'versions', class: Google::Apis::MlV1::GoogleCloudMlV1Version, decorator: Google::Apis::MlV1::GoogleCloudMlV1Version::Representation end end class GoogleCloudMlV1Location # @private class Representation < Google::Apis::Core::JsonRepresentation collection :capabilities, as: 'capabilities', class: Google::Apis::MlV1::GoogleCloudMlV1Capability, decorator: Google::Apis::MlV1::GoogleCloudMlV1Capability::Representation property :name, as: 'name' end end class GoogleCloudMlV1ManualScaling # @private class Representation < Google::Apis::Core::JsonRepresentation property :nodes, as: 'nodes' end end class GoogleCloudMlV1Model # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_version, as: 'defaultVersion', class: Google::Apis::MlV1::GoogleCloudMlV1Version, decorator: Google::Apis::MlV1::GoogleCloudMlV1Version::Representation property :description, as: 'description' property :name, as: 'name' property :online_prediction_logging, as: 'onlinePredictionLogging' collection :regions, as: 'regions' end end class GoogleCloudMlV1OperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :end_time, as: 'endTime' property :is_cancellation_requested, as: 'isCancellationRequested' property :model_name, as: 'modelName' property :operation_type, as: 'operationType' property :project_number, :numeric_string => true, as: 'projectNumber' property :start_time, as: 'startTime' property :version, as: 'version', class: Google::Apis::MlV1::GoogleCloudMlV1Version, decorator: Google::Apis::MlV1::GoogleCloudMlV1Version::Representation end end class GoogleCloudMlV1ParameterSpec # @private class Representation < Google::Apis::Core::JsonRepresentation collection :categorical_values, as: 'categoricalValues' collection :discrete_values, as: 'discreteValues' property :max_value, as: 'maxValue' property :min_value, as: 'minValue' property :parameter_name, as: 'parameterName' property :scale_type, as: 'scaleType' property :type, as: 'type' end end class GoogleCloudMlV1PredictRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :http_body, as: 'httpBody', class: Google::Apis::MlV1::GoogleApiHttpBody, decorator: Google::Apis::MlV1::GoogleApiHttpBody::Representation end end class GoogleCloudMlV1PredictionInput # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_size, :numeric_string => true, as: 'batchSize' property :data_format, as: 'dataFormat' collection :input_paths, as: 'inputPaths' property :max_worker_count, :numeric_string => true, as: 'maxWorkerCount' property :model_name, as: 'modelName' property :output_path, as: 'outputPath' property :region, as: 'region' property :runtime_version, as: 'runtimeVersion' property :signature_name, as: 'signatureName' property :uri, as: 'uri' property :version_name, as: 'versionName' end end class GoogleCloudMlV1PredictionOutput # @private class Representation < Google::Apis::Core::JsonRepresentation property :error_count, :numeric_string => true, as: 'errorCount' property :node_hours, as: 'nodeHours' property :output_path, as: 'outputPath' property :prediction_count, :numeric_string => true, as: 'predictionCount' end end class GoogleCloudMlV1SetDefaultVersionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GoogleCloudMlV1TrainingInput # @private class Representation < Google::Apis::Core::JsonRepresentation collection :args, as: 'args' property :hyperparameters, as: 'hyperparameters', class: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterSpec, decorator: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterSpec::Representation property :job_dir, as: 'jobDir' property :master_type, as: 'masterType' collection :package_uris, as: 'packageUris' property :parameter_server_count, :numeric_string => true, as: 'parameterServerCount' property :parameter_server_type, as: 'parameterServerType' property :python_module, as: 'pythonModule' property :python_version, as: 'pythonVersion' property :region, as: 'region' property :runtime_version, as: 'runtimeVersion' property :scale_tier, as: 'scaleTier' property :worker_count, :numeric_string => true, as: 'workerCount' property :worker_type, as: 'workerType' end end class GoogleCloudMlV1TrainingOutput # @private class Representation < Google::Apis::Core::JsonRepresentation property :completed_trial_count, :numeric_string => true, as: 'completedTrialCount' property :consumed_ml_units, as: 'consumedMLUnits' property :is_hyperparameter_tuning_job, as: 'isHyperparameterTuningJob' collection :trials, as: 'trials', class: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutput, decorator: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutput::Representation end end class GoogleCloudMlV1Version # @private class Representation < Google::Apis::Core::JsonRepresentation property :auto_scaling, as: 'autoScaling', class: Google::Apis::MlV1::GoogleCloudMlV1AutoScaling, decorator: Google::Apis::MlV1::GoogleCloudMlV1AutoScaling::Representation property :create_time, as: 'createTime' property :deployment_uri, as: 'deploymentUri' property :description, as: 'description' property :error_message, as: 'errorMessage' property :is_default, as: 'isDefault' property :last_use_time, as: 'lastUseTime' property :manual_scaling, as: 'manualScaling', class: Google::Apis::MlV1::GoogleCloudMlV1ManualScaling, decorator: Google::Apis::MlV1::GoogleCloudMlV1ManualScaling::Representation property :name, as: 'name' property :runtime_version, as: 'runtimeVersion' property :state, as: 'state' end end class GoogleIamV1Binding # @private class Representation < Google::Apis::Core::JsonRepresentation collection :members, as: 'members' property :role, as: 'role' end end class GoogleIamV1Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :bindings, as: 'bindings', class: Google::Apis::MlV1::GoogleIamV1Binding, decorator: Google::Apis::MlV1::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::MlV1::GoogleIamV1Policy, decorator: Google::Apis::MlV1::GoogleIamV1Policy::Representation 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::MlV1::GoogleLongrunningOperation, decorator: Google::Apis::MlV1::GoogleLongrunningOperation::Representation end end class GoogleLongrunningOperation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::MlV1::GoogleRpcStatus, decorator: Google::Apis::MlV1::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 end end end google-api-client-0.19.8/generated/google/apis/ml_v1/classes.rb0000644000004100000410000021747413252673044024333 0ustar www-datawww-data# 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 MlV1 # 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 string representing the content type of the body. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # HTTP body binary data. # 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 # An observed value of a metric. class GoogleCloudMlV1HyperparameterOutputHyperparameterMetric include Google::Apis::Core::Hashable # The objective value at this training step. # Corresponds to the JSON property `objectiveValue` # @return [Float] attr_accessor :objective_value # The global training step for this metric. # Corresponds to the JSON property `trainingStep` # @return [Fixnum] attr_accessor :training_step def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @objective_value = args[:objective_value] if args.key?(:objective_value) @training_step = args[:training_step] if args.key?(:training_step) end end # Options for automatically scaling a model. class GoogleCloudMlV1AutoScaling include Google::Apis::Core::Hashable # Optional. The minimum number of nodes to allocate for this model. These # nodes are always up, starting from the time the model is deployed, so the # cost of operating this model will be at least # `rate` * `min_nodes` * number of hours since last billing cycle, # where `rate` is the cost per node-hour as documented in # [pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing), # even if no predictions are performed. There is additional cost for each # prediction performed. # Unlike manual scaling, if the load gets too heavy for the nodes # that are up, the service will automatically add nodes to handle the # increased load as well as scale back as traffic drops, always maintaining # at least `min_nodes`. You will be charged for the time in which additional # nodes are used. # If not specified, `min_nodes` defaults to 0, in which case, when traffic # to a model stops (and after a cool-down period), nodes will be shut down # and no charges will be incurred until traffic to the model resumes. # Corresponds to the JSON property `minNodes` # @return [Fixnum] attr_accessor :min_nodes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @min_nodes = args[:min_nodes] if args.key?(:min_nodes) end end # Request message for the CancelJob method. class GoogleCloudMlV1CancelJobRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # class GoogleCloudMlV1Capability include Google::Apis::Core::Hashable # Available accelerators for the capability. # Corresponds to the JSON property `availableAccelerators` # @return [Array] attr_accessor :available_accelerators # # 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) @available_accelerators = args[:available_accelerators] if args.key?(:available_accelerators) @type = args[:type] if args.key?(:type) end end # Returns service account information associated with a project. class GoogleCloudMlV1GetConfigResponse include Google::Apis::Core::Hashable # The service account Cloud ML uses to access resources in the project. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account # The project number for `service_account`. # Corresponds to the JSON property `serviceAccountProject` # @return [Fixnum] attr_accessor :service_account_project def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @service_account = args[:service_account] if args.key?(:service_account) @service_account_project = args[:service_account_project] if args.key?(:service_account_project) end end # Represents the result of a single hyperparameter tuning trial from a # training job. The TrainingOutput object that is returned on successful # completion of a training job with hyperparameter tuning includes a list # of HyperparameterOutput objects, one for each successful trial. class GoogleCloudMlV1HyperparameterOutput include Google::Apis::Core::Hashable # All recorded object metrics for this trial. This field is not currently # populated. # Corresponds to the JSON property `allMetrics` # @return [Array] attr_accessor :all_metrics # An observed value of a metric. # Corresponds to the JSON property `finalMetric` # @return [Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric] attr_accessor :final_metric # The hyperparameters given to this trial. # Corresponds to the JSON property `hyperparameters` # @return [Hash] attr_accessor :hyperparameters # True if the trial is stopped early. # Corresponds to the JSON property `isTrialStoppedEarly` # @return [Boolean] attr_accessor :is_trial_stopped_early alias_method :is_trial_stopped_early?, :is_trial_stopped_early # The trial id for these results. # Corresponds to the JSON property `trialId` # @return [String] attr_accessor :trial_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @all_metrics = args[:all_metrics] if args.key?(:all_metrics) @final_metric = args[:final_metric] if args.key?(:final_metric) @hyperparameters = args[:hyperparameters] if args.key?(:hyperparameters) @is_trial_stopped_early = args[:is_trial_stopped_early] if args.key?(:is_trial_stopped_early) @trial_id = args[:trial_id] if args.key?(:trial_id) end end # Represents a set of hyperparameters to optimize. class GoogleCloudMlV1HyperparameterSpec include Google::Apis::Core::Hashable # Optional. Indicates if the hyperparameter tuning job enables auto trial # early stopping. # Corresponds to the JSON property `enableTrialEarlyStopping` # @return [Boolean] attr_accessor :enable_trial_early_stopping alias_method :enable_trial_early_stopping?, :enable_trial_early_stopping # Required. The type of goal to use for tuning. Available types are # `MAXIMIZE` and `MINIMIZE`. # Defaults to `MAXIMIZE`. # Corresponds to the JSON property `goal` # @return [String] attr_accessor :goal # Optional. The Tensorflow summary tag name to use for optimizing trials. For # current versions of Tensorflow, this tag name should exactly match what is # shown in Tensorboard, including all scopes. For versions of Tensorflow # prior to 0.12, this should be only the tag passed to tf.Summary. # By default, "training/hptuning/metric" will be used. # Corresponds to the JSON property `hyperparameterMetricTag` # @return [String] attr_accessor :hyperparameter_metric_tag # Optional. The number of training trials to run concurrently. # You can reduce the time it takes to perform hyperparameter tuning by adding # trials in parallel. However, each trail only benefits from the information # gained in completed trials. That means that a trial does not get access to # the results of trials running at the same time, which could reduce the # quality of the overall optimization. # Each trial will use the same scale tier and machine types. # Defaults to one. # Corresponds to the JSON property `maxParallelTrials` # @return [Fixnum] attr_accessor :max_parallel_trials # Optional. How many training trials should be attempted to optimize # the specified hyperparameters. # Defaults to one. # Corresponds to the JSON property `maxTrials` # @return [Fixnum] attr_accessor :max_trials # Required. The set of parameters to tune. # Corresponds to the JSON property `params` # @return [Array] attr_accessor :params # Optional. The prior hyperparameter tuning job id that users hope to # continue with. The job id will be used to find the corresponding vizier # study guid and resume the study. # Corresponds to the JSON property `resumePreviousJobId` # @return [String] attr_accessor :resume_previous_job_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enable_trial_early_stopping = args[:enable_trial_early_stopping] if args.key?(:enable_trial_early_stopping) @goal = args[:goal] if args.key?(:goal) @hyperparameter_metric_tag = args[:hyperparameter_metric_tag] if args.key?(:hyperparameter_metric_tag) @max_parallel_trials = args[:max_parallel_trials] if args.key?(:max_parallel_trials) @max_trials = args[:max_trials] if args.key?(:max_trials) @params = args[:params] if args.key?(:params) @resume_previous_job_id = args[:resume_previous_job_id] if args.key?(:resume_previous_job_id) end end # Represents a training or prediction job. class GoogleCloudMlV1Job include Google::Apis::Core::Hashable # Output only. When the job was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Output only. When the job processing was completed. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Output only. The details of a failure or a cancellation. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message # Required. The user-specified id of the job. # Corresponds to the JSON property `jobId` # @return [String] attr_accessor :job_id # Represents input parameters for a prediction job. # Corresponds to the JSON property `predictionInput` # @return [Google::Apis::MlV1::GoogleCloudMlV1PredictionInput] attr_accessor :prediction_input # Represents results of a prediction job. # Corresponds to the JSON property `predictionOutput` # @return [Google::Apis::MlV1::GoogleCloudMlV1PredictionOutput] attr_accessor :prediction_output # Output only. When the job processing was started. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Output only. The detailed state of a job. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Represents input parameters for a training job. When using the # gcloud command to submit your training job, you can specify # the input parameters as command-line arguments and/or in a YAML configuration # file referenced from the --config command-line argument. For # details, see the guide to # submitting a training job. # Corresponds to the JSON property `trainingInput` # @return [Google::Apis::MlV1::GoogleCloudMlV1TrainingInput] attr_accessor :training_input # Represents results of a training job. Output only. # Corresponds to the JSON property `trainingOutput` # @return [Google::Apis::MlV1::GoogleCloudMlV1TrainingOutput] attr_accessor :training_output def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @end_time = args[:end_time] if args.key?(:end_time) @error_message = args[:error_message] if args.key?(:error_message) @job_id = args[:job_id] if args.key?(:job_id) @prediction_input = args[:prediction_input] if args.key?(:prediction_input) @prediction_output = args[:prediction_output] if args.key?(:prediction_output) @start_time = args[:start_time] if args.key?(:start_time) @state = args[:state] if args.key?(:state) @training_input = args[:training_input] if args.key?(:training_input) @training_output = args[:training_output] if args.key?(:training_output) end end # Response message for the ListJobs method. class GoogleCloudMlV1ListJobsResponse include Google::Apis::Core::Hashable # The list of jobs. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs # Optional. Pass this token as the `page_token` field of the request for a # subsequent call. # 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) @jobs = args[:jobs] if args.key?(:jobs) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # class GoogleCloudMlV1ListLocationsResponse include Google::Apis::Core::Hashable # Locations where at least one type of CMLE capability is available. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations # Optional. Pass this token as the `page_token` field of the request for a # subsequent call. # 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) @locations = args[:locations] if args.key?(:locations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for the ListModels method. class GoogleCloudMlV1ListModelsResponse include Google::Apis::Core::Hashable # The list of models. # Corresponds to the JSON property `models` # @return [Array] attr_accessor :models # Optional. Pass this token as the `page_token` field of the request for a # subsequent call. # 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 # Response message for the ListVersions method. class GoogleCloudMlV1ListVersionsResponse include Google::Apis::Core::Hashable # Optional. Pass this token as the `page_token` field of the request for a # subsequent call. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of versions. # Corresponds to the JSON property `versions` # @return [Array] attr_accessor :versions 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) @versions = args[:versions] if args.key?(:versions) end end # class GoogleCloudMlV1Location include Google::Apis::Core::Hashable # Capabilities available in the location. # Corresponds to the JSON property `capabilities` # @return [Array] attr_accessor :capabilities # # 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) @capabilities = args[:capabilities] if args.key?(:capabilities) @name = args[:name] if args.key?(:name) end end # Options for manually scaling a model. class GoogleCloudMlV1ManualScaling include Google::Apis::Core::Hashable # The number of nodes to allocate for this model. These nodes are always up, # starting from the time the model is deployed, so the cost of operating # this model will be proportional to `nodes` * number of hours since # last billing cycle plus the cost for each prediction performed. # Corresponds to the JSON property `nodes` # @return [Fixnum] attr_accessor :nodes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @nodes = args[:nodes] if args.key?(:nodes) end end # Represents a machine learning solution. # A model can have multiple versions, each of which is a deployed, trained # model ready to receive prediction requests. The model itself is just a # container. class GoogleCloudMlV1Model include Google::Apis::Core::Hashable # Represents a version of the model. # Each version is a trained model deployed in the cloud, ready to handle # prediction requests. A model can have multiple versions. You can get # information about all of the versions of a given model by calling # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models. # versions/list). # LINT.IfChange # Corresponds to the JSON property `defaultVersion` # @return [Google::Apis::MlV1::GoogleCloudMlV1Version] attr_accessor :default_version # Optional. The description specified for the model when it was created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Required. The name specified for the model when it was created. # The model name must be unique within the project it is created in. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. If true, enables StackDriver Logging for online prediction. # Default is false. # Corresponds to the JSON property `onlinePredictionLogging` # @return [Boolean] attr_accessor :online_prediction_logging alias_method :online_prediction_logging?, :online_prediction_logging # Optional. The list of regions where the model is going to be deployed. # Currently only one region per model is supported. # Defaults to 'us-central1' if nothing is set. # See the available regions for # ML Engine services. # Note: # * No matter where a model is deployed, it can always be accessed by # users from anywhere, both for online and batch prediction. # * The region for a batch prediction job is set by the region field when # submitting the batch prediction job and does not take its value from # this field. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_version = args[:default_version] if args.key?(:default_version) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @online_prediction_logging = args[:online_prediction_logging] if args.key?(:online_prediction_logging) @regions = args[:regions] if args.key?(:regions) end end # Represents the metadata of the long-running operation. class GoogleCloudMlV1OperationMetadata include Google::Apis::Core::Hashable # The time the operation was submitted. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The time operation processing completed. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Indicates whether a request to cancel this operation has been made. # Corresponds to the JSON property `isCancellationRequested` # @return [Boolean] attr_accessor :is_cancellation_requested alias_method :is_cancellation_requested?, :is_cancellation_requested # Contains the name of the model associated with the operation. # Corresponds to the JSON property `modelName` # @return [String] attr_accessor :model_name # The operation type. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # Contains the project number associated with the operation. # Corresponds to the JSON property `projectNumber` # @return [Fixnum] attr_accessor :project_number # The time operation processing started. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Represents a version of the model. # Each version is a trained model deployed in the cloud, ready to handle # prediction requests. A model can have multiple versions. You can get # information about all of the versions of a given model by calling # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models. # versions/list). # LINT.IfChange # Corresponds to the JSON property `version` # @return [Google::Apis::MlV1::GoogleCloudMlV1Version] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @end_time = args[:end_time] if args.key?(:end_time) @is_cancellation_requested = args[:is_cancellation_requested] if args.key?(:is_cancellation_requested) @model_name = args[:model_name] if args.key?(:model_name) @operation_type = args[:operation_type] if args.key?(:operation_type) @project_number = args[:project_number] if args.key?(:project_number) @start_time = args[:start_time] if args.key?(:start_time) @version = args[:version] if args.key?(:version) end end # Represents a single hyperparameter to optimize. class GoogleCloudMlV1ParameterSpec include Google::Apis::Core::Hashable # Required if type is `CATEGORICAL`. The list of possible categories. # Corresponds to the JSON property `categoricalValues` # @return [Array] attr_accessor :categorical_values # Required if type is `DISCRETE`. # A list of feasible points. # The list should be in strictly increasing order. For instance, this # parameter might have possible settings of 1.5, 2.5, and 4.0. This list # should not contain more than 1,000 values. # Corresponds to the JSON property `discreteValues` # @return [Array] attr_accessor :discrete_values # Required if typeis `DOUBLE` or `INTEGER`. This field # should be unset if type is `CATEGORICAL`. This value should be integers if # type is `INTEGER`. # Corresponds to the JSON property `maxValue` # @return [Float] attr_accessor :max_value # Required if type is `DOUBLE` or `INTEGER`. This field # should be unset if type is `CATEGORICAL`. This value should be integers if # type is INTEGER. # Corresponds to the JSON property `minValue` # @return [Float] attr_accessor :min_value # Required. The parameter name must be unique amongst all ParameterConfigs in # a HyperparameterSpec message. E.g., "learning_rate". # Corresponds to the JSON property `parameterName` # @return [String] attr_accessor :parameter_name # Optional. How the parameter should be scaled to the hypercube. # Leave unset for categorical parameters. # Some kind of scaling is strongly recommended for real or integral # parameters (e.g., `UNIT_LINEAR_SCALE`). # Corresponds to the JSON property `scaleType` # @return [String] attr_accessor :scale_type # Required. The type of the parameter. # 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) @categorical_values = args[:categorical_values] if args.key?(:categorical_values) @discrete_values = args[:discrete_values] if args.key?(:discrete_values) @max_value = args[:max_value] if args.key?(:max_value) @min_value = args[:min_value] if args.key?(:min_value) @parameter_name = args[:parameter_name] if args.key?(:parameter_name) @scale_type = args[:scale_type] if args.key?(:scale_type) @type = args[:type] if args.key?(:type) end end # Request for predictions to be issued against a trained model. class GoogleCloudMlV1PredictRequest include Google::Apis::Core::Hashable # 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. # Corresponds to the JSON property `httpBody` # @return [Google::Apis::MlV1::GoogleApiHttpBody] attr_accessor :http_body def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @http_body = args[:http_body] if args.key?(:http_body) end end # Represents input parameters for a prediction job. class GoogleCloudMlV1PredictionInput include Google::Apis::Core::Hashable # Optional. Number of records per batch, defaults to 64. # The service will buffer batch_size number of records in memory before # invoking one Tensorflow prediction call internally. So take the record # size and memory available into consideration when setting this parameter. # Corresponds to the JSON property `batchSize` # @return [Fixnum] attr_accessor :batch_size # Required. The format of the input data files. # Corresponds to the JSON property `dataFormat` # @return [String] attr_accessor :data_format # Required. The Google Cloud Storage location of the input data files. # May contain wildcards. # Corresponds to the JSON property `inputPaths` # @return [Array] attr_accessor :input_paths # Optional. The maximum number of workers to be used for parallel processing. # Defaults to 10 if not specified. # Corresponds to the JSON property `maxWorkerCount` # @return [Fixnum] attr_accessor :max_worker_count # Use this field if you want to use the default version for the specified # model. The string must use the following format: # `"projects/[YOUR_PROJECT]/models/[YOUR_MODEL]"` # Corresponds to the JSON property `modelName` # @return [String] attr_accessor :model_name # Required. The output Google Cloud Storage location. # Corresponds to the JSON property `outputPath` # @return [String] attr_accessor :output_path # Required. The Google Compute Engine region to run the prediction job in. # See the available regions for # ML Engine services. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # Optional. The Google Cloud ML runtime version to use for this batch # prediction. If not set, Google Cloud ML will pick the runtime version used # during the CreateVersion request for this model version, or choose the # latest stable version when model version information is not available # such as when the model is specified by uri. # Corresponds to the JSON property `runtimeVersion` # @return [String] attr_accessor :runtime_version # Optional. The name of the signature defined in the SavedModel to use for # this job. Please refer to # [SavedModel](https://tensorflow.github.io/serving/serving_basic.html) # for information about how to use signatures. # Defaults to # [DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.org/api_docs/python/ # tf/saved_model/signature_constants) # , which is "serving_default". # Corresponds to the JSON property `signatureName` # @return [String] attr_accessor :signature_name # Use this field if you want to specify a Google Cloud Storage path for # the model to use. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri # Use this field if you want to specify a version of the model to use. The # string is formatted the same way as `model_version`, with the addition # of the version information: # `"projects/[YOUR_PROJECT]/models/YOUR_MODEL/versions/[ # YOUR_VERSION]"` # 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) @batch_size = args[:batch_size] if args.key?(:batch_size) @data_format = args[:data_format] if args.key?(:data_format) @input_paths = args[:input_paths] if args.key?(:input_paths) @max_worker_count = args[:max_worker_count] if args.key?(:max_worker_count) @model_name = args[:model_name] if args.key?(:model_name) @output_path = args[:output_path] if args.key?(:output_path) @region = args[:region] if args.key?(:region) @runtime_version = args[:runtime_version] if args.key?(:runtime_version) @signature_name = args[:signature_name] if args.key?(:signature_name) @uri = args[:uri] if args.key?(:uri) @version_name = args[:version_name] if args.key?(:version_name) end end # Represents results of a prediction job. class GoogleCloudMlV1PredictionOutput include Google::Apis::Core::Hashable # The number of data instances which resulted in errors. # Corresponds to the JSON property `errorCount` # @return [Fixnum] attr_accessor :error_count # Node hours used by the batch prediction job. # Corresponds to the JSON property `nodeHours` # @return [Float] attr_accessor :node_hours # The output Google Cloud Storage location provided at the job creation time. # Corresponds to the JSON property `outputPath` # @return [String] attr_accessor :output_path # The number of generated predictions. # Corresponds to the JSON property `predictionCount` # @return [Fixnum] attr_accessor :prediction_count def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_count = args[:error_count] if args.key?(:error_count) @node_hours = args[:node_hours] if args.key?(:node_hours) @output_path = args[:output_path] if args.key?(:output_path) @prediction_count = args[:prediction_count] if args.key?(:prediction_count) end end # Request message for the SetDefaultVersion request. class GoogleCloudMlV1SetDefaultVersionRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Represents input parameters for a training job. When using the # gcloud command to submit your training job, you can specify # the input parameters as command-line arguments and/or in a YAML configuration # file referenced from the --config command-line argument. For # details, see the guide to # submitting a training job. class GoogleCloudMlV1TrainingInput include Google::Apis::Core::Hashable # Optional. Command line arguments to pass to the program. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args # Represents a set of hyperparameters to optimize. # Corresponds to the JSON property `hyperparameters` # @return [Google::Apis::MlV1::GoogleCloudMlV1HyperparameterSpec] attr_accessor :hyperparameters # Optional. A Google Cloud Storage path in which to store training outputs # and other data needed for training. This path is passed to your TensorFlow # program as the 'job_dir' command-line argument. The benefit of specifying # this field is that Cloud ML validates the path for use in training. # Corresponds to the JSON property `jobDir` # @return [String] attr_accessor :job_dir # Optional. Specifies the type of virtual machine to use for your training # job's master worker. # The following types are supported: #
#
standard
#
# A basic machine configuration suitable for training simple models with # small to moderate datasets. #
#
large_model
#
# A machine with a lot of memory, specially suited for parameter servers # when your model is large (having many hidden layers or layers with very # large numbers of nodes). #
#
complex_model_s
#
# A machine suitable for the master and workers of the cluster when your # model requires more computation than the standard machine can handle # satisfactorily. #
#
complex_model_m
#
# A machine with roughly twice the number of cores and roughly double the # memory of complex_model_s. #
#
complex_model_l
#
# A machine with roughly twice the number of cores and roughly double the # memory of complex_model_m. #
#
standard_gpu
#
# A machine equivalent to standard that # also includes a single NVIDIA Tesla K80 GPU. See more about # # using GPUs for training your model. #
#
complex_model_m_gpu
#
# A machine equivalent to # complex_model_m that also includes # four NVIDIA Tesla K80 GPUs. #
#
complex_model_l_gpu
#
# A machine equivalent to # complex_model_l that also includes # eight NVIDIA Tesla K80 GPUs. #
#
standard_p100
#
# A machine equivalent to standard that # also includes a single NVIDIA Tesla P100 GPU. The availability of these # GPUs is in the Beta launch stage. #
#
complex_model_m_p100
#
# A machine equivalent to # complex_model_m that also includes # four NVIDIA Tesla P100 GPUs. The availability of these GPUs is in # the Beta launch stage. #
#
# You must set this value when `scaleTier` is set to `CUSTOM`. # Corresponds to the JSON property `masterType` # @return [String] attr_accessor :master_type # Required. The Google Cloud Storage location of the packages with # the training program and any additional dependencies. # The maximum number of package URIs is 100. # Corresponds to the JSON property `packageUris` # @return [Array] attr_accessor :package_uris # Optional. The number of parameter server replicas to use for the training # job. Each replica in the cluster will be of the type specified in # `parameter_server_type`. # This value can only be used when `scale_tier` is set to `CUSTOM`.If you # set this value, you must also set `parameter_server_type`. # Corresponds to the JSON property `parameterServerCount` # @return [Fixnum] attr_accessor :parameter_server_count # Optional. Specifies the type of virtual machine to use for your training # job's parameter server. # The supported values are the same as those described in the entry for # `master_type`. # This value must be present when `scaleTier` is set to `CUSTOM` and # `parameter_server_count` is greater than zero. # Corresponds to the JSON property `parameterServerType` # @return [String] attr_accessor :parameter_server_type # Required. The Python module name to run after installing the packages. # Corresponds to the JSON property `pythonModule` # @return [String] attr_accessor :python_module # Optional. The version of Python used in training. If not set, the default # version is '2.7'. Python '3.5' is available when `runtime_version` is set # to '1.4' and above. Python '2.7' works with all supported runtime versions. # Corresponds to the JSON property `pythonVersion` # @return [String] attr_accessor :python_version # Required. The Google Compute Engine region to run the training job in. # See the available regions for # ML Engine services. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # Optional. The Google Cloud ML runtime version to use for training. If not # set, Google Cloud ML will choose the latest stable version. # Corresponds to the JSON property `runtimeVersion` # @return [String] attr_accessor :runtime_version # Required. Specifies the machine types, the number of replicas for workers # and parameter servers. # Corresponds to the JSON property `scaleTier` # @return [String] attr_accessor :scale_tier # Optional. The number of worker replicas to use for the training job. Each # replica in the cluster will be of the type specified in `worker_type`. # This value can only be used when `scale_tier` is set to `CUSTOM`. If you # set this value, you must also set `worker_type`. # Corresponds to the JSON property `workerCount` # @return [Fixnum] attr_accessor :worker_count # Optional. Specifies the type of virtual machine to use for your training # job's worker nodes. # The supported values are the same as those described in the entry for # `masterType`. # This value must be present when `scaleTier` is set to `CUSTOM` and # `workerCount` is greater than zero. # Corresponds to the JSON property `workerType` # @return [String] attr_accessor :worker_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @args = args[:args] if args.key?(:args) @hyperparameters = args[:hyperparameters] if args.key?(:hyperparameters) @job_dir = args[:job_dir] if args.key?(:job_dir) @master_type = args[:master_type] if args.key?(:master_type) @package_uris = args[:package_uris] if args.key?(:package_uris) @parameter_server_count = args[:parameter_server_count] if args.key?(:parameter_server_count) @parameter_server_type = args[:parameter_server_type] if args.key?(:parameter_server_type) @python_module = args[:python_module] if args.key?(:python_module) @python_version = args[:python_version] if args.key?(:python_version) @region = args[:region] if args.key?(:region) @runtime_version = args[:runtime_version] if args.key?(:runtime_version) @scale_tier = args[:scale_tier] if args.key?(:scale_tier) @worker_count = args[:worker_count] if args.key?(:worker_count) @worker_type = args[:worker_type] if args.key?(:worker_type) end end # Represents results of a training job. Output only. class GoogleCloudMlV1TrainingOutput include Google::Apis::Core::Hashable # The number of hyperparameter tuning trials that completed successfully. # Only set for hyperparameter tuning jobs. # Corresponds to the JSON property `completedTrialCount` # @return [Fixnum] attr_accessor :completed_trial_count # The amount of ML units consumed by the job. # Corresponds to the JSON property `consumedMLUnits` # @return [Float] attr_accessor :consumed_ml_units # Whether this job is a hyperparameter tuning job. # Corresponds to the JSON property `isHyperparameterTuningJob` # @return [Boolean] attr_accessor :is_hyperparameter_tuning_job alias_method :is_hyperparameter_tuning_job?, :is_hyperparameter_tuning_job # Results for individual Hyperparameter trials. # Only set for hyperparameter tuning jobs. # Corresponds to the JSON property `trials` # @return [Array] attr_accessor :trials def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @completed_trial_count = args[:completed_trial_count] if args.key?(:completed_trial_count) @consumed_ml_units = args[:consumed_ml_units] if args.key?(:consumed_ml_units) @is_hyperparameter_tuning_job = args[:is_hyperparameter_tuning_job] if args.key?(:is_hyperparameter_tuning_job) @trials = args[:trials] if args.key?(:trials) end end # Represents a version of the model. # Each version is a trained model deployed in the cloud, ready to handle # prediction requests. A model can have multiple versions. You can get # information about all of the versions of a given model by calling # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models. # versions/list). # LINT.IfChange class GoogleCloudMlV1Version include Google::Apis::Core::Hashable # Options for automatically scaling a model. # Corresponds to the JSON property `autoScaling` # @return [Google::Apis::MlV1::GoogleCloudMlV1AutoScaling] attr_accessor :auto_scaling # Output only. The time the version was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Required. The Google Cloud Storage location of the trained model used to # create the version. See the # [overview of model # deployment](/ml-engine/docs/concepts/deployment-overview) for more # information. # When passing Version to # [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models. # versions/create) # the model service uses the specified location as the source of the model. # Once deployed, the model version is hosted by the prediction service, so # this location is useful only as a historical record. # The total number of model files can't exceed 1000. # Corresponds to the JSON property `deploymentUri` # @return [String] attr_accessor :deployment_uri # Optional. The description specified for the version when it was created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Output only. The details of a failure or a cancellation. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message # Output only. If true, this version will be used to handle prediction # requests that do not specify a version. # You can change the default version by calling # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects. # models.versions/setDefault). # Corresponds to the JSON property `isDefault` # @return [Boolean] attr_accessor :is_default alias_method :is_default?, :is_default # Output only. The time the version was last used for prediction. # Corresponds to the JSON property `lastUseTime` # @return [String] attr_accessor :last_use_time # Options for manually scaling a model. # Corresponds to the JSON property `manualScaling` # @return [Google::Apis::MlV1::GoogleCloudMlV1ManualScaling] attr_accessor :manual_scaling # Required.The name specified for the version when it was created. # The version name must be unique within the model it is created in. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. The Google Cloud ML runtime version to use for this deployment. # If not set, Google Cloud ML will choose a version. # Corresponds to the JSON property `runtimeVersion` # @return [String] attr_accessor :runtime_version # Output only. The state of a version. # 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) @auto_scaling = args[:auto_scaling] if args.key?(:auto_scaling) @create_time = args[:create_time] if args.key?(:create_time) @deployment_uri = args[:deployment_uri] if args.key?(:deployment_uri) @description = args[:description] if args.key?(:description) @error_message = args[:error_message] if args.key?(:error_message) @is_default = args[:is_default] if args.key?(:is_default) @last_use_time = args[:last_use_time] if args.key?(:last_use_time) @manual_scaling = args[:manual_scaling] if args.key?(:manual_scaling) @name = args[:name] if args.key?(:name) @runtime_version = args[:runtime_version] if args.key?(:runtime_version) @state = args[:state] if args.key?(:state) end end # Associates `members` with a `role`. class GoogleIamV1Binding include Google::Apis::Core::Hashable # 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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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`. # Required # 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) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). class GoogleIamV1Policy include Google::Apis::Core::Hashable # Associates a list of `members` to a `role`. # `bindings` with no members will result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # Deprecated. # 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) @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 # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). # Corresponds to the JSON property `policy` # @return [Google::Apis::MlV1::GoogleIamV1Policy] attr_accessor :policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @policy = args[:policy] if args.key?(:policy) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::MlV1::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 have the format of `operations/some/unique/name`. # 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class 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 end end end google-api-client-0.19.8/generated/google/apis/ml_v1/service.rb0000644000004100000410000021504413252673044024325 0ustar www-datawww-data# 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 MlV1 # Google Cloud Machine Learning Engine # # An API to enable creating and using machine learning models. # # @example # require 'google/apis/ml_v1' # # Ml = Google::Apis::MlV1 # Alias the module # service = Ml::CloudMachineLearningEngineService.new # # @see https://cloud.google.com/ml/ class CloudMachineLearningEngineService < 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://ml.googleapis.com/', '') @batch_path = 'batch' end # Get the service account information associated with your project. You need # this information in order to grant the service account persmissions for # the Google Cloud Storage location where you put your model training code # for training the model with Google Cloud Machine Learning. # @param [String] name # Required. The project 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::MlV1::GoogleCloudMlV1GetConfigResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1GetConfigResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}:getConfig', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1GetConfigResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1GetConfigResponse 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 # Performs prediction on the data in the request. # Cloud ML Engine implements a custom `predict` verb on top of an HTTP POST # method.

For details of the request and response format, see the **guide # to the [predict request format](/ml-engine/docs/v1/predict-request)**. # @param [String] name # Required. The resource name of a model or a version. # Authorization: requires the `predict` permission on the specified resource. # @param [Google::Apis::MlV1::GoogleCloudMlV1PredictRequest] google_cloud_ml_v1__predict_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::MlV1::GoogleApiHttpBody] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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 predict_project(name, google_cloud_ml_v1__predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:predict', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1PredictRequest::Representation command.request_object = google_cloud_ml_v1__predict_request_object command.response_representation = Google::Apis::MlV1::GoogleApiHttpBody::Representation command.response_class = Google::Apis::MlV1::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 # Cancels a running job. # @param [String] name # Required. The name of the job to cancel. # @param [Google::Apis::MlV1::GoogleCloudMlV1CancelJobRequest] google_cloud_ml_v1__cancel_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::MlV1::GoogleProtobufEmpty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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 cancel_project_job(name, google_cloud_ml_v1__cancel_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1CancelJobRequest::Representation command.request_object = google_cloud_ml_v1__cancel_job_request_object command.response_representation = Google::Apis::MlV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::MlV1::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 # Creates a training or a batch prediction job. # @param [String] parent # Required. The project name. # @param [Google::Apis::MlV1::GoogleCloudMlV1Job] google_cloud_ml_v1__job_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::MlV1::GoogleCloudMlV1Job] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1Job] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job(parent, google_cloud_ml_v1__job_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/jobs', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Job::Representation command.request_object = google_cloud_ml_v1__job_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Job::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Job 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 # Describes a job. # @param [String] name # Required. The name of the job to get the description 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::MlV1::GoogleCloudMlV1Job] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1Job] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Job::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Job 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 access control policy for a resource. # Returns an empty policy if the resource exists and does not have a policy # set. # @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 [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::MlV1::GoogleIamV1Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_job_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) command.response_representation = Google::Apis::MlV1::GoogleIamV1Policy::Representation command.response_class = Google::Apis::MlV1::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 # Lists the jobs in the project. # If there are no jobs that match the request parameters, the list # request returns an empty response body: ``. # @param [String] parent # Required. The name of the project for which to list jobs. # @param [String] filter # Optional. Specifies the subset of jobs to retrieve. # You can filter on the value of one or more attributes of the job object. # For example, retrieve jobs with a job identifier that starts with 'census': #

gcloud ml-engine jobs list --filter='jobId:census*' #

List all failed jobs with names that start with 'rnn': #

gcloud ml-engine jobs list --filter='jobId:rnn* # AND state:FAILED' #

For more examples, see the guide to # monitoring jobs. # @param [Fixnum] page_size # Optional. The number of jobs to retrieve per "page" of results. If there # are more remaining results than this number, the response message will # contain a valid value in the `next_page_token` field. # The default value is 20, and the maximum page size is 100. # @param [String] page_token # Optional. A page token to request the next page of results. # You get the token from the `next_page_token` field of the response from # the previous call. # @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::MlV1::GoogleCloudMlV1ListJobsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1ListJobsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/jobs', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListJobsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListJobsResponse 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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @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::MlV1::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::MlV1::GoogleIamV1Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_job_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::MlV1::GoogleIamV1SetIamPolicyRequest::Representation command.request_object = google_iam_v1__set_iam_policy_request_object command.response_representation = Google::Apis::MlV1::GoogleIamV1Policy::Representation command.response_class = Google::Apis::MlV1::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 # 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. # 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. # @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::MlV1::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::MlV1::GoogleIamV1TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_job_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::MlV1::GoogleIamV1TestIamPermissionsRequest::Representation command.request_object = google_iam_v1__test_iam_permissions_request_object command.response_representation = Google::Apis::MlV1::GoogleIamV1TestIamPermissionsResponse::Representation command.response_class = Google::Apis::MlV1::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 # Get the complete list of CMLE capabilities in a location, along with their # location-specific properties. # @param [String] name # Required. The name of the location. # @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::MlV1::GoogleCloudMlV1Location] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1Location] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Location::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Location 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 locations that provides at least one type of CMLE capability. # @param [String] parent # Required. The name of the project for which available locations are to be # listed (since some locations might be whitelisted for specific projects). # @param [Fixnum] page_size # Optional. The number of locations to retrieve per "page" of results. If there # are more remaining results than this number, the response message will # contain a valid value in the `next_page_token` field. # The default value is 20, and the maximum page size is 100. # @param [String] page_token # Optional. A page token to request the next page of results. # You get the token from the `next_page_token` field of the response from # the previous call. # @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::MlV1::GoogleCloudMlV1ListLocationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1ListLocationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_locations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/locations', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListLocationsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListLocationsResponse 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 # Creates a model which will later contain one or more versions. # You must add at least one version before you can request predictions from # the model. Add versions by calling # [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models. # versions/create). # @param [String] parent # Required. The project name. # @param [Google::Apis::MlV1::GoogleCloudMlV1Model] google_cloud_ml_v1__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::MlV1::GoogleCloudMlV1Model] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1Model] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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, google_cloud_ml_v1__model_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/models', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Model::Representation command.request_object = google_cloud_ml_v1__model_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Model::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Model 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. # You can only delete a model if there are no versions in it. You can delete # versions by calling # [projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models. # versions/delete). # @param [String] name # Required. The name of the model. # @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::MlV1::GoogleLongrunningOperation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::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 information about a model, including its name, the description (if # set), and the default version (if at least one version of the model has # been deployed). # @param [String] name # Required. The name of the model. # @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::MlV1::GoogleCloudMlV1Model] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1Model] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Model::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Model 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 access control policy for a resource. # Returns an empty policy if the resource exists and does not have a policy # set. # @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 [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::MlV1::GoogleIamV1Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_model_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) command.response_representation = Google::Apis::MlV1::GoogleIamV1Policy::Representation command.response_class = Google::Apis::MlV1::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 # Lists the models in a project. # Each project can contain multiple models, and each model can have multiple # versions. # If there are no models that match the request parameters, the list request # returns an empty response body: ``. # @param [String] parent # Required. The name of the project whose models are to be listed. # @param [String] filter # Optional. Specifies the subset of models to retrieve. # @param [Fixnum] page_size # Optional. The number of models to retrieve per "page" of results. If there # are more remaining results than this number, the response message will # contain a valid value in the `next_page_token` field. # The default value is 20, and the maximum page size is 100. # @param [String] page_token # Optional. A page token to request the next page of results. # You get the token from the `next_page_token` field of the response from # the previous call. # @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::MlV1::GoogleCloudMlV1ListModelsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1ListModelsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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, 'v1/{+parent}/models', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListModelsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListModelsResponse 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 specific model resource. # Currently the only supported fields to update are `description` and # `default_version.name`. # @param [String] name # Required. The project name. # @param [Google::Apis::MlV1::GoogleCloudMlV1Model] google_cloud_ml_v1__model_object # @param [String] update_mask # Required. Specifies the path, relative to `Model`, of the field to update. # For example, to change the description of a model to "foo" and set its # default version to "version_1", the `update_mask` parameter would be # specified as `description`, `default_version.name`, and the `PATCH` # request body would specify the new value, as follows: # ` # "description": "foo", # "defaultVersion": ` # "name":"version_1" # ` # ` # Currently the supported update masks are `description` and # `default_version.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::MlV1::GoogleLongrunningOperation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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 patch_project_model(name, google_cloud_ml_v1__model_object = 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::MlV1::GoogleCloudMlV1Model::Representation command.request_object = google_cloud_ml_v1__model_object command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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 # Sets the access control policy on the specified resource. Replaces any # existing policy. # @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::MlV1::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::MlV1::GoogleIamV1Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_model_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::MlV1::GoogleIamV1SetIamPolicyRequest::Representation command.request_object = google_iam_v1__set_iam_policy_request_object command.response_representation = Google::Apis::MlV1::GoogleIamV1Policy::Representation command.response_class = Google::Apis::MlV1::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 # 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. # 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. # @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::MlV1::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::MlV1::GoogleIamV1TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_model_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::MlV1::GoogleIamV1TestIamPermissionsRequest::Representation command.request_object = google_iam_v1__test_iam_permissions_request_object command.response_representation = Google::Apis::MlV1::GoogleIamV1TestIamPermissionsResponse::Representation command.response_class = Google::Apis::MlV1::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 # Creates a new version of a model from a trained TensorFlow model. # If the version created in the cloud by this call is the first deployed # version of the specified model, it will be made the default version of the # model. When you add a version to a model that already has one or more # versions, the default version does not automatically change. If you want a # new version to be the default, you must call # [projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects. # models.versions/setDefault). # @param [String] parent # Required. The name of the model. # @param [Google::Apis::MlV1::GoogleCloudMlV1Version] google_cloud_ml_v1__version_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::MlV1::GoogleLongrunningOperation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_model_version(parent, google_cloud_ml_v1__version_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/versions', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Version::Representation command.request_object = google_cloud_ml_v1__version_object command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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 version. # Each model can have multiple versions deployed and in use at any given # time. Use this method to remove a single version. # Note: You cannot delete the version that is set as the default version # of the model unless it is the only remaining version. # @param [String] name # Required. The name of the version. You can get the names of all the # versions of a model by calling # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models. # versions/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::MlV1::GoogleLongrunningOperation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_model_version(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::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 information about a model version. # Models can have multiple versions. You can call # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models. # versions/list) # to get the same information that this method returns for all of the # versions of a model. # @param [String] name # Required. The name of the version. # @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::MlV1::GoogleCloudMlV1Version] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1Version] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_version(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Version::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Version 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 basic information about all the versions of a model. # If you expect that a model has many versions, or if you need to handle # only a limited number of results at a time, you can request that the list # be retrieved in batches (called pages). # If there are no versions that match the request parameters, the list # request returns an empty response body: ``. # @param [String] parent # Required. The name of the model for which to list the version. # @param [String] filter # Optional. Specifies the subset of versions to retrieve. # @param [Fixnum] page_size # Optional. The number of versions to retrieve per "page" of results. If # there are more remaining results than this number, the response message # will contain a valid value in the `next_page_token` field. # The default value is 20, and the maximum page size is 100. # @param [String] page_token # Optional. A page token to request the next page of results. # You get the token from the `next_page_token` field of the response from # the previous call. # @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::MlV1::GoogleCloudMlV1ListVersionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1ListVersionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_model_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/versions', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListVersionsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListVersionsResponse 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 the specified Version resource. # Currently the only supported field to update is `description`. # @param [String] name # Required. The name of the model. # @param [Google::Apis::MlV1::GoogleCloudMlV1Version] google_cloud_ml_v1__version_object # @param [String] update_mask # Required. Specifies the path, relative to `Version`, of the field to # update. Must be present and non-empty. # For example, to change the description of a version to "foo", the # `update_mask` parameter would be specified as `description`, and the # `PATCH` request body would specify the new value, as follows: # ` # "description": "foo" # ` # Currently the only supported update mask is`description`. # @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::MlV1::GoogleLongrunningOperation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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 patch_project_model_version(name, google_cloud_ml_v1__version_object = 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::MlV1::GoogleCloudMlV1Version::Representation command.request_object = google_cloud_ml_v1__version_object command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation 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 # Designates a version to be the default for the model. # The default version is used for prediction requests made against the model # that don't specify a version. # The first version to be created for a model is automatically set as the # default. You must make any subsequent changes to the default version # setting manually using this method. # @param [String] name # Required. The name of the version to make the default for the model. You # can get the names of all the versions of a model by calling # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models. # versions/list). # @param [Google::Apis::MlV1::GoogleCloudMlV1SetDefaultVersionRequest] google_cloud_ml_v1__set_default_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::MlV1::GoogleCloudMlV1Version] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::GoogleCloudMlV1Version] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_model_version_default(name, google_cloud_ml_v1__set_default_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:setDefault', options) command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1SetDefaultVersionRequest::Representation command.request_object = google_cloud_ml_v1__set_default_version_request_object command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Version::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Version 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 # Starts asynchronous cancellation on a long-running operation. The server # makes a best effort to cancel the operation, but success is not # guaranteed. If the server doesn't support this method, it returns # `google.rpc.Code.UNIMPLEMENTED`. Clients can use # Operations.GetOperation or # other methods to check whether the cancellation succeeded or whether the # operation completed despite cancellation. On successful cancellation, # the operation is not deleted; instead, it becomes an operation with # an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. # @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::MlV1::GoogleProtobufEmpty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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 cancel_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.response_representation = Google::Apis::MlV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::MlV1::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 # Deletes a long-running operation. This method indicates that the client is # no longer interested in the operation result. It does not cancel the # operation. If the server doesn't support this method, it returns # `google.rpc.Code.UNIMPLEMENTED`. # @param [String] name # The name of the operation resource 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::MlV1::GoogleProtobufEmpty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::MlV1::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 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::MlV1::GoogleLongrunningOperation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::MlV1::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::MlV1::GoogleLongrunningListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MlV1::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_project_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::MlV1::GoogleLongrunningListOperationsResponse::Representation command.response_class = Google::Apis::MlV1::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 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 google-api-client-0.19.8/generated/google/apis/drive_v3.rb0000644000004100000410000000417313252673043023366 0ustar www-datawww-data# 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/drive_v3/service.rb' require 'google/apis/drive_v3/classes.rb' require 'google/apis/drive_v3/representations.rb' module Google module Apis # Drive API # # Manages files in Drive including uploading, downloading, searching, detecting # changes, and updating sharing permissions. # # @see https://developers.google.com/drive/ module DriveV3 VERSION = 'V3' REVISION = '20180112' # View and manage the files in your Google Drive AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' # View and manage its own configuration data in your Google Drive AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata' # View and manage Google Drive files and folders that you have opened or created with this app AUTH_DRIVE_FILE = 'https://www.googleapis.com/auth/drive.file' # View and manage metadata of files in your Google Drive AUTH_DRIVE_METADATA = 'https://www.googleapis.com/auth/drive.metadata' # View metadata for files in your Google Drive AUTH_DRIVE_METADATA_READONLY = 'https://www.googleapis.com/auth/drive.metadata.readonly' # View the photos, videos and albums in your Google Photos AUTH_DRIVE_PHOTOS_READONLY = 'https://www.googleapis.com/auth/drive.photos.readonly' # View the files in your Google Drive AUTH_DRIVE_READONLY = 'https://www.googleapis.com/auth/drive.readonly' # Modify your Google Apps Script scripts' behavior AUTH_DRIVE_SCRIPTS = 'https://www.googleapis.com/auth/drive.scripts' end end end google-api-client-0.19.8/generated/google/apis/adexchangebuyer2_v2beta1/0000755000004100000410000000000013252673043026057 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb0000644000004100000410000011602313252673043031634 0ustar www-datawww-data# 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 Adexchangebuyer2V2beta1 class AbsoluteDateRange class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AddDealAssociationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AppContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuctionContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BidMetricsRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BidResponseWithoutBidsStatusRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CalloutStatusRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Client class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClientUser class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClientUserInvitation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Correction 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 CreativeDealAssociation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreativeStatusRow 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 Disapproval 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 FilterSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FilteredBidCreativeRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FilteredBidDetailRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FilteringStats class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HtmlContent 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 ImpressionMetricsRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListBidMetricsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListBidResponseErrorsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListBidResponsesWithoutBidsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListClientUserInvitationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListClientUsersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListClientsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListCreativeStatusBreakdownByCreativeResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListCreativeStatusBreakdownByDetailResponse 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 ListDealAssociationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListFilterSetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListFilteredBidRequestsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListFilteredBidsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListImpressionMetricsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLosingBidsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListNonBillableWinningBidsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LocationContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NativeContent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NonBillableWinningBidStatusRow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlatformContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RealtimeTimeRange class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Reason class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RelativeDateRange class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RemoveDealAssociationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RowDimensions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SecurityContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServingContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServingRestriction class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StopWatchingCreativeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TimeInterval class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoContent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WatchCreativeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AbsoluteDateRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_date, as: 'endDate', class: Google::Apis::Adexchangebuyer2V2beta1::Date, decorator: Google::Apis::Adexchangebuyer2V2beta1::Date::Representation property :start_date, as: 'startDate', class: Google::Apis::Adexchangebuyer2V2beta1::Date, decorator: Google::Apis::Adexchangebuyer2V2beta1::Date::Representation end end class AddDealAssociationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :association, as: 'association', class: Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation, decorator: Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation::Representation end end class AppContext # @private class Representation < Google::Apis::Core::JsonRepresentation collection :app_types, as: 'appTypes' end end class AuctionContext # @private class Representation < Google::Apis::Core::JsonRepresentation collection :auction_types, as: 'auctionTypes' end end class BidMetricsRow # @private class Representation < Google::Apis::Core::JsonRepresentation property :bids, as: 'bids', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation property :bids_in_auction, as: 'bidsInAuction', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation property :billed_impressions, as: 'billedImpressions', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation property :impressions_won, as: 'impressionsWon', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation property :measurable_impressions, as: 'measurableImpressions', 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 end end class BidResponseWithoutBidsStatusRow # @private class Representation < Google::Apis::Core::JsonRepresentation property :impression_count, as: 'impressionCount', 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 :status, as: 'status' end end class CalloutStatusRow # @private class Representation < Google::Apis::Core::JsonRepresentation property :callout_status_id, as: 'calloutStatusId' property :impression_count, as: 'impressionCount', 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 end end class Client # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_account_id, :numeric_string => true, as: 'clientAccountId' property :client_name, as: 'clientName' property :entity_id, :numeric_string => true, as: 'entityId' property :entity_name, as: 'entityName' property :entity_type, as: 'entityType' property :partner_client_id, as: 'partnerClientId' property :role, as: 'role' property :status, as: 'status' property :visible_to_seller, as: 'visibleToSeller' end end class ClientUser # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_account_id, :numeric_string => true, as: 'clientAccountId' property :email, as: 'email' property :status, as: 'status' property :user_id, :numeric_string => true, as: 'userId' end end class ClientUserInvitation # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_account_id, :numeric_string => true, as: 'clientAccountId' property :email, as: 'email' property :invitation_id, :numeric_string => true, as: 'invitationId' end end class Correction # @private class Representation < Google::Apis::Core::JsonRepresentation collection :contexts, as: 'contexts', class: Google::Apis::Adexchangebuyer2V2beta1::ServingContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::ServingContext::Representation collection :details, as: 'details' property :type, as: 'type' end end class Creative # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :ad_choices_destination_url, as: 'adChoicesDestinationUrl' property :advertiser_name, as: 'advertiserName' property :agency_id, :numeric_string => true, as: 'agencyId' property :api_update_time, as: 'apiUpdateTime' collection :attributes, as: 'attributes' collection :click_through_urls, as: 'clickThroughUrls' collection :corrections, as: 'corrections', class: Google::Apis::Adexchangebuyer2V2beta1::Correction, decorator: Google::Apis::Adexchangebuyer2V2beta1::Correction::Representation property :creative_id, as: 'creativeId' property :deals_status, as: 'dealsStatus' collection :detected_advertiser_ids, as: 'detectedAdvertiserIds' collection :detected_domains, as: 'detectedDomains' collection :detected_languages, as: 'detectedLanguages' collection :detected_product_categories, as: 'detectedProductCategories' collection :detected_sensitive_categories, as: 'detectedSensitiveCategories' property :filtering_stats, as: 'filteringStats', class: Google::Apis::Adexchangebuyer2V2beta1::FilteringStats, decorator: Google::Apis::Adexchangebuyer2V2beta1::FilteringStats::Representation property :html, as: 'html', class: Google::Apis::Adexchangebuyer2V2beta1::HtmlContent, decorator: Google::Apis::Adexchangebuyer2V2beta1::HtmlContent::Representation collection :impression_tracking_urls, as: 'impressionTrackingUrls' property :native, as: 'native', class: Google::Apis::Adexchangebuyer2V2beta1::NativeContent, decorator: Google::Apis::Adexchangebuyer2V2beta1::NativeContent::Representation property :open_auction_status, as: 'openAuctionStatus' collection :restricted_categories, as: 'restrictedCategories' collection :serving_restrictions, as: 'servingRestrictions', class: Google::Apis::Adexchangebuyer2V2beta1::ServingRestriction, decorator: Google::Apis::Adexchangebuyer2V2beta1::ServingRestriction::Representation collection :vendor_ids, as: 'vendorIds' property :version, as: 'version' property :video, as: 'video', class: Google::Apis::Adexchangebuyer2V2beta1::VideoContent, decorator: Google::Apis::Adexchangebuyer2V2beta1::VideoContent::Representation end end class CreativeDealAssociation # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' property :creative_id, as: 'creativeId' property :deals_id, as: 'dealsId' end end class CreativeStatusRow # @private class Representation < Google::Apis::Core::JsonRepresentation property :bid_count, as: 'bidCount', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation property :creative_status_id, as: 'creativeStatusId' property :row_dimensions, as: 'rowDimensions', class: Google::Apis::Adexchangebuyer2V2beta1::RowDimensions, decorator: Google::Apis::Adexchangebuyer2V2beta1::RowDimensions::Representation 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 Disapproval # @private class Representation < Google::Apis::Core::JsonRepresentation collection :details, as: 'details' property :reason, as: 'reason' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class FilterSet # @private class Representation < Google::Apis::Core::JsonRepresentation property :absolute_date_range, as: 'absoluteDateRange', class: Google::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange, decorator: Google::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange::Representation property :creative_id, as: 'creativeId' property :deal_id, :numeric_string => true, as: 'dealId' property :environment, as: 'environment' property :format, as: 'format' collection :formats, as: 'formats' property :name, as: 'name' collection :platforms, as: 'platforms' property :realtime_time_range, as: 'realtimeTimeRange', class: Google::Apis::Adexchangebuyer2V2beta1::RealtimeTimeRange, decorator: Google::Apis::Adexchangebuyer2V2beta1::RealtimeTimeRange::Representation property :relative_date_range, as: 'relativeDateRange', class: Google::Apis::Adexchangebuyer2V2beta1::RelativeDateRange, decorator: Google::Apis::Adexchangebuyer2V2beta1::RelativeDateRange::Representation collection :seller_network_ids, as: 'sellerNetworkIds' property :time_series_granularity, as: 'timeSeriesGranularity' end end class FilteredBidCreativeRow # @private class Representation < Google::Apis::Core::JsonRepresentation property :bid_count, as: 'bidCount', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation property :creative_id, as: 'creativeId' property :row_dimensions, as: 'rowDimensions', class: Google::Apis::Adexchangebuyer2V2beta1::RowDimensions, decorator: Google::Apis::Adexchangebuyer2V2beta1::RowDimensions::Representation end end class FilteredBidDetailRow # @private class Representation < Google::Apis::Core::JsonRepresentation property :bid_count, as: 'bidCount', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation property :detail_id, as: 'detailId' property :row_dimensions, as: 'rowDimensions', class: Google::Apis::Adexchangebuyer2V2beta1::RowDimensions, decorator: Google::Apis::Adexchangebuyer2V2beta1::RowDimensions::Representation end end class FilteringStats # @private class Representation < Google::Apis::Core::JsonRepresentation property :date, as: 'date', class: Google::Apis::Adexchangebuyer2V2beta1::Date, decorator: Google::Apis::Adexchangebuyer2V2beta1::Date::Representation collection :reasons, as: 'reasons', class: Google::Apis::Adexchangebuyer2V2beta1::Reason, decorator: Google::Apis::Adexchangebuyer2V2beta1::Reason::Representation end end class HtmlContent # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :snippet, as: 'snippet' property :width, as: 'width' end end class Image # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :url, as: 'url' property :width, as: 'width' end end class ImpressionMetricsRow # @private class Representation < Google::Apis::Core::JsonRepresentation property :available_impressions, as: 'availableImpressions', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation property :bid_requests, as: 'bidRequests', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation property :inventory_matches, as: 'inventoryMatches', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation property :responses_with_bids, as: 'responsesWithBids', 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 :successful_responses, as: 'successfulResponses', class: Google::Apis::Adexchangebuyer2V2beta1::MetricValue, decorator: Google::Apis::Adexchangebuyer2V2beta1::MetricValue::Representation end end class ListBidMetricsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :bid_metrics_rows, as: 'bidMetricsRows', class: Google::Apis::Adexchangebuyer2V2beta1::BidMetricsRow, decorator: Google::Apis::Adexchangebuyer2V2beta1::BidMetricsRow::Representation property :next_page_token, as: 'nextPageToken' end end class ListBidResponseErrorsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :callout_status_rows, as: 'calloutStatusRows', class: Google::Apis::Adexchangebuyer2V2beta1::CalloutStatusRow, decorator: Google::Apis::Adexchangebuyer2V2beta1::CalloutStatusRow::Representation property :next_page_token, as: 'nextPageToken' end end class ListBidResponsesWithoutBidsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :bid_response_without_bids_status_rows, as: 'bidResponseWithoutBidsStatusRows', class: Google::Apis::Adexchangebuyer2V2beta1::BidResponseWithoutBidsStatusRow, decorator: Google::Apis::Adexchangebuyer2V2beta1::BidResponseWithoutBidsStatusRow::Representation property :next_page_token, as: 'nextPageToken' end end class ListClientUserInvitationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :invitations, as: 'invitations', class: Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation, decorator: Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation property :next_page_token, as: 'nextPageToken' end end class ListClientUsersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :users, as: 'users', class: Google::Apis::Adexchangebuyer2V2beta1::ClientUser, decorator: Google::Apis::Adexchangebuyer2V2beta1::ClientUser::Representation end end class ListClientsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :clients, as: 'clients', class: Google::Apis::Adexchangebuyer2V2beta1::Client, decorator: Google::Apis::Adexchangebuyer2V2beta1::Client::Representation property :next_page_token, as: 'nextPageToken' end end class ListCreativeStatusBreakdownByCreativeResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filtered_bid_creative_rows, as: 'filteredBidCreativeRows', class: Google::Apis::Adexchangebuyer2V2beta1::FilteredBidCreativeRow, decorator: Google::Apis::Adexchangebuyer2V2beta1::FilteredBidCreativeRow::Representation property :next_page_token, as: 'nextPageToken' end end class ListCreativeStatusBreakdownByDetailResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :detail_type, as: 'detailType' collection :filtered_bid_detail_rows, as: 'filteredBidDetailRows', class: Google::Apis::Adexchangebuyer2V2beta1::FilteredBidDetailRow, decorator: Google::Apis::Adexchangebuyer2V2beta1::FilteredBidDetailRow::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::Adexchangebuyer2V2beta1::Creative, decorator: Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation property :next_page_token, as: 'nextPageToken' end end class ListDealAssociationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :associations, as: 'associations', class: Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation, decorator: Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation::Representation property :next_page_token, as: 'nextPageToken' end end class ListFilterSetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :filter_sets, as: 'filterSets', class: Google::Apis::Adexchangebuyer2V2beta1::FilterSet, decorator: Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation property :next_page_token, as: 'nextPageToken' end end class ListFilteredBidRequestsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :callout_status_rows, as: 'calloutStatusRows', class: Google::Apis::Adexchangebuyer2V2beta1::CalloutStatusRow, decorator: Google::Apis::Adexchangebuyer2V2beta1::CalloutStatusRow::Representation property :next_page_token, as: 'nextPageToken' end end class ListFilteredBidsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creative_status_rows, as: 'creativeStatusRows', class: Google::Apis::Adexchangebuyer2V2beta1::CreativeStatusRow, decorator: Google::Apis::Adexchangebuyer2V2beta1::CreativeStatusRow::Representation property :next_page_token, as: 'nextPageToken' end end class ListImpressionMetricsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :impression_metrics_rows, as: 'impressionMetricsRows', class: Google::Apis::Adexchangebuyer2V2beta1::ImpressionMetricsRow, decorator: Google::Apis::Adexchangebuyer2V2beta1::ImpressionMetricsRow::Representation property :next_page_token, as: 'nextPageToken' end end class ListLosingBidsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :creative_status_rows, as: 'creativeStatusRows', class: Google::Apis::Adexchangebuyer2V2beta1::CreativeStatusRow, decorator: Google::Apis::Adexchangebuyer2V2beta1::CreativeStatusRow::Representation property :next_page_token, as: 'nextPageToken' end end class ListNonBillableWinningBidsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :non_billable_winning_bid_status_rows, as: 'nonBillableWinningBidStatusRows', class: Google::Apis::Adexchangebuyer2V2beta1::NonBillableWinningBidStatusRow, decorator: Google::Apis::Adexchangebuyer2V2beta1::NonBillableWinningBidStatusRow::Representation end end class LocationContext # @private class Representation < Google::Apis::Core::JsonRepresentation collection :geo_criteria_ids, as: 'geoCriteriaIds' end end class MetricValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :value, :numeric_string => true, as: 'value' property :variance, :numeric_string => true, as: 'variance' end end class NativeContent # @private class Representation < Google::Apis::Core::JsonRepresentation property :advertiser_name, as: 'advertiserName' property :app_icon, as: 'appIcon', class: Google::Apis::Adexchangebuyer2V2beta1::Image, decorator: Google::Apis::Adexchangebuyer2V2beta1::Image::Representation property :body, as: 'body' property :call_to_action, as: 'callToAction' property :click_link_url, as: 'clickLinkUrl' property :click_tracking_url, as: 'clickTrackingUrl' property :headline, as: 'headline' property :image, as: 'image', class: Google::Apis::Adexchangebuyer2V2beta1::Image, decorator: Google::Apis::Adexchangebuyer2V2beta1::Image::Representation property :logo, as: 'logo', class: Google::Apis::Adexchangebuyer2V2beta1::Image, decorator: Google::Apis::Adexchangebuyer2V2beta1::Image::Representation property :price_display_text, as: 'priceDisplayText' property :star_rating, as: 'starRating' property :store_url, as: 'storeUrl' property :video_url, as: 'videoUrl' end end class NonBillableWinningBidStatusRow # @private class Representation < Google::Apis::Core::JsonRepresentation property :bid_count, as: 'bidCount', 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 :status, as: 'status' end end class PlatformContext # @private class Representation < Google::Apis::Core::JsonRepresentation collection :platforms, as: 'platforms' end end class RealtimeTimeRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :start_timestamp, as: 'startTimestamp' end end class Reason # @private class Representation < Google::Apis::Core::JsonRepresentation property :count, :numeric_string => true, as: 'count' property :status, as: 'status' end end class RelativeDateRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :duration_days, as: 'durationDays' property :offset_days, as: 'offsetDays' end end class RemoveDealAssociationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :association, as: 'association', class: Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation, decorator: Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation::Representation end end class RowDimensions # @private class Representation < Google::Apis::Core::JsonRepresentation property :time_interval, as: 'timeInterval', class: Google::Apis::Adexchangebuyer2V2beta1::TimeInterval, decorator: Google::Apis::Adexchangebuyer2V2beta1::TimeInterval::Representation end end class SecurityContext # @private class Representation < Google::Apis::Core::JsonRepresentation collection :securities, as: 'securities' end end class ServingContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :all, as: 'all' property :app_type, as: 'appType', class: Google::Apis::Adexchangebuyer2V2beta1::AppContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::AppContext::Representation property :auction_type, as: 'auctionType', class: Google::Apis::Adexchangebuyer2V2beta1::AuctionContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::AuctionContext::Representation property :location, as: 'location', class: Google::Apis::Adexchangebuyer2V2beta1::LocationContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::LocationContext::Representation property :platform, as: 'platform', class: Google::Apis::Adexchangebuyer2V2beta1::PlatformContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::PlatformContext::Representation property :security_type, as: 'securityType', class: Google::Apis::Adexchangebuyer2V2beta1::SecurityContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::SecurityContext::Representation end end class ServingRestriction # @private class Representation < Google::Apis::Core::JsonRepresentation collection :contexts, as: 'contexts', class: Google::Apis::Adexchangebuyer2V2beta1::ServingContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::ServingContext::Representation collection :disapproval_reasons, as: 'disapprovalReasons', class: Google::Apis::Adexchangebuyer2V2beta1::Disapproval, decorator: Google::Apis::Adexchangebuyer2V2beta1::Disapproval::Representation property :status, as: 'status' end end class StopWatchingCreativeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class TimeInterval # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_time, as: 'endTime' property :start_time, as: 'startTime' end end class VideoContent # @private class Representation < Google::Apis::Core::JsonRepresentation property :video_url, as: 'videoUrl' property :video_vast_xml, as: 'videoVastXml' end end class WatchCreativeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :topic, as: 'topic' end end end end end google-api-client-0.19.8/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb0000644000004100000410000026060213252673043030047 0ustar www-datawww-data# 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 Adexchangebuyer2V2beta1 # An absolute date range, specified by its start date and end date. # The supported range of dates begins 30 days before today and ends today. # Validity checked upon filter set creation. If a filter set with an absolute # date range is run at a later date more than 30 days after start_date, it will # fail. class AbsoluteDateRange include Google::Apis::Core::Hashable # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary date. Related types are google.type.TimeOfDay # and `google.protobuf.Timestamp`. # Corresponds to the JSON property `endDate` # @return [Google::Apis::Adexchangebuyer2V2beta1::Date] attr_accessor :end_date # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary date. Related types are google.type.TimeOfDay # and `google.protobuf.Timestamp`. # Corresponds to the JSON property `startDate` # @return [Google::Apis::Adexchangebuyer2V2beta1::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 # A request for associating a deal and a creative. class AddDealAssociationRequest include Google::Apis::Core::Hashable # The association between a creative and a deal. # Corresponds to the JSON property `association` # @return [Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation] attr_accessor :association def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @association = args[:association] if args.key?(:association) end end # @OutputOnly The app type the restriction applies to for mobile device. class AppContext include Google::Apis::Core::Hashable # The app types this restriction applies to. # Corresponds to the JSON property `appTypes` # @return [Array] attr_accessor :app_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @app_types = args[:app_types] if args.key?(:app_types) end end # @OutputOnly The auction type the restriction applies to. class AuctionContext include Google::Apis::Core::Hashable # The auction types this restriction applies to. # Corresponds to the JSON property `auctionTypes` # @return [Array] attr_accessor :auction_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auction_types = args[:auction_types] if args.key?(:auction_types) end end # The set of metrics that are measured in numbers of bids, representing how # many bids with the specified dimension values were considered eligible at # each stage of the bidding funnel; class BidMetricsRow include Google::Apis::Core::Hashable # 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 `bids` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bids # 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 `bidsInAuction` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bids_in_auction # 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 `billedImpressions` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :billed_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 `impressionsWon` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :impressions_won # 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 `measurableImpressions` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :measurable_impressions # 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` # @return [Google::Apis::Adexchangebuyer2V2beta1::RowDimensions] attr_accessor :row_dimensions # 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 `viewableImpressions` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :viewable_impressions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bids = args[:bids] if args.key?(:bids) @bids_in_auction = args[:bids_in_auction] if args.key?(:bids_in_auction) @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) @row_dimensions = args[:row_dimensions] if args.key?(:row_dimensions) @viewable_impressions = args[:viewable_impressions] if args.key?(:viewable_impressions) end end # The number of impressions with the specified dimension values that were # considered to have no applicable bids, as described by the specified status. class BidResponseWithoutBidsStatusRow include Google::Apis::Core::Hashable # 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 `impressionCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :impression_count # 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` # @return [Google::Apis::Adexchangebuyer2V2beta1::RowDimensions] attr_accessor :row_dimensions # The status specifying why the bid responses were considered to have no # applicable bids. # 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) @impression_count = args[:impression_count] if args.key?(:impression_count) @row_dimensions = args[:row_dimensions] if args.key?(:row_dimensions) @status = args[:status] if args.key?(:status) end end # The number of impressions with the specified dimension values where the # corresponding bid request or bid response was not successful, as described by # the specified callout status. class CalloutStatusRow include Google::Apis::Core::Hashable # The ID of the callout status. # See [callout-status-codes](https://developers.google.com/ad-exchange/rtb/ # downloads/callout-status-codes). # Corresponds to the JSON property `calloutStatusId` # @return [Fixnum] attr_accessor :callout_status_id # 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 `impressionCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :impression_count # 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` # @return [Google::Apis::Adexchangebuyer2V2beta1::RowDimensions] attr_accessor :row_dimensions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @callout_status_id = args[:callout_status_id] if args.key?(:callout_status_id) @impression_count = args[:impression_count] if args.key?(:impression_count) @row_dimensions = args[:row_dimensions] if args.key?(:row_dimensions) end end # A client resource represents a client buyer—an agency, # a brand, or an advertiser customer of the sponsor buyer. # Users associated with the client buyer have restricted access to # the Ad Exchange Marketplace and certain other sections # of the Ad Exchange Buyer UI based on the role # granted to the client buyer. # All fields are required unless otherwise specified. class Client include Google::Apis::Core::Hashable # The globally-unique numerical ID of the client. # The value of this field is ignored in create and update operations. # Corresponds to the JSON property `clientAccountId` # @return [Fixnum] attr_accessor :client_account_id # Name used to represent this client to publishers. # You may have multiple clients that map to the same entity, # but for each client the combination of `clientName` and entity # must be unique. # You can specify this field as empty. # Corresponds to the JSON property `clientName` # @return [String] attr_accessor :client_name # Numerical identifier of the client entity. # The entity can be an advertiser, a brand, or an agency. # This identifier is unique among all the entities with the same type. # A list of all known advertisers with their identifiers is available in the # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/ # advertisers.txt) # file. # A list of all known brands with their identifiers is available in the # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) # file. # A list of all known agencies with their identifiers is available in the # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies. # txt) # file. # Corresponds to the JSON property `entityId` # @return [Fixnum] attr_accessor :entity_id # The name of the entity. This field is automatically fetched based on # the type and ID. # The value of this field is ignored in create and update operations. # Corresponds to the JSON property `entityName` # @return [String] attr_accessor :entity_name # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type # Optional arbitrary unique identifier of this client buyer from the # standpoint of its Ad Exchange sponsor buyer. # This field can be used to associate a client buyer with the identifier # in the namespace of its sponsor buyer, lookup client buyers by that # identifier and verify whether an Ad Exchange counterpart of a given client # buyer already exists. # If present, must be unique among all the client buyers for its # Ad Exchange sponsor buyer. # Corresponds to the JSON property `partnerClientId` # @return [String] attr_accessor :partner_client_id # The role which is assigned to the client buyer. Each role implies a set of # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role # The status of the client buyer. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # Whether the client buyer will be visible to sellers. # Corresponds to the JSON property `visibleToSeller` # @return [Boolean] attr_accessor :visible_to_seller alias_method :visible_to_seller?, :visible_to_seller def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_account_id = args[:client_account_id] if args.key?(:client_account_id) @client_name = args[:client_name] if args.key?(:client_name) @entity_id = args[:entity_id] if args.key?(:entity_id) @entity_name = args[:entity_name] if args.key?(:entity_name) @entity_type = args[:entity_type] if args.key?(:entity_type) @partner_client_id = args[:partner_client_id] if args.key?(:partner_client_id) @role = args[:role] if args.key?(:role) @status = args[:status] if args.key?(:status) @visible_to_seller = args[:visible_to_seller] if args.key?(:visible_to_seller) end end # A client user is created under a client buyer and has restricted access to # the Ad Exchange Marketplace and certain other sections # of the Ad Exchange Buyer UI based on the role # granted to the associated client buyer. # The only way a new client user can be created is via accepting an # email invitation # (see the # accounts.clients.invitations.create # method). # All fields are required unless otherwise specified. class ClientUser include Google::Apis::Core::Hashable # Numerical account ID of the client buyer # with which the user is associated; the # buyer must be a client of the current sponsor buyer. # The value of this field is ignored in an update operation. # Corresponds to the JSON property `clientAccountId` # @return [Fixnum] attr_accessor :client_account_id # User's email address. The value of this field # is ignored in an update operation. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The status of the client user. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The unique numerical ID of the client user # that has accepted an invitation. # The value of this field is ignored in an update operation. # Corresponds to the JSON property `userId` # @return [Fixnum] attr_accessor :user_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_account_id = args[:client_account_id] if args.key?(:client_account_id) @email = args[:email] if args.key?(:email) @status = args[:status] if args.key?(:status) @user_id = args[:user_id] if args.key?(:user_id) end end # An invitation for a new client user to get access to the Ad Exchange # Buyer UI. # All fields are required unless otherwise specified. class ClientUserInvitation include Google::Apis::Core::Hashable # Numerical account ID of the client buyer # that the invited user is associated with. # The value of this field is ignored in create operations. # Corresponds to the JSON property `clientAccountId` # @return [Fixnum] attr_accessor :client_account_id # The email address to which the invitation is sent. Email # addresses should be unique among all client users under each sponsor # buyer. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The unique numerical ID of the invitation that is sent to the user. # The value of this field is ignored in create operations. # Corresponds to the JSON property `invitationId` # @return [Fixnum] attr_accessor :invitation_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_account_id = args[:client_account_id] if args.key?(:client_account_id) @email = args[:email] if args.key?(:email) @invitation_id = args[:invitation_id] if args.key?(:invitation_id) end end # @OutputOnly Shows any corrections that were applied to this creative. class Correction include Google::Apis::Core::Hashable # The contexts for the correction. # Corresponds to the JSON property `contexts` # @return [Array] attr_accessor :contexts # Additional details about what was corrected. # Corresponds to the JSON property `details` # @return [Array] attr_accessor :details # The type of correction that was applied to the creative. # 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) @contexts = args[:contexts] if args.key?(:contexts) @details = args[:details] if args.key?(:details) @type = args[:type] if args.key?(:type) end end # A creative and its classification data. class Creative include Google::Apis::Core::Hashable # The account that this creative belongs to. # Can be used to filter the response of the # creatives.list # method. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # The link to AdChoices destination page. # Corresponds to the JSON property `adChoicesDestinationUrl` # @return [String] attr_accessor :ad_choices_destination_url # The name of the company being advertised in the creative. # Corresponds to the JSON property `advertiserName` # @return [String] attr_accessor :advertiser_name # The agency ID for this creative. # Corresponds to the JSON property `agencyId` # @return [Fixnum] attr_accessor :agency_id # @OutputOnly The last update timestamp of the creative via API. # Corresponds to the JSON property `apiUpdateTime` # @return [String] attr_accessor :api_update_time # All attributes for the ads that may be shown from this creative. # Can be used to filter the response of the # creatives.list # method. # Corresponds to the JSON property `attributes` # @return [Array] attr_accessor :attributes # The set of destination URLs for the creative. # Corresponds to the JSON property `clickThroughUrls` # @return [Array] attr_accessor :click_through_urls # @OutputOnly Shows any corrections that were applied to this creative. # Corresponds to the JSON property `corrections` # @return [Array] attr_accessor :corrections # The buyer-defined creative ID of this creative. # Can be used to filter the response of the # creatives.list # method. # Corresponds to the JSON property `creativeId` # @return [String] attr_accessor :creative_id # @OutputOnly The top-level deals status of this creative. # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in # serving_restrictions will also exist. Note # that this may be nuanced with other contextual restrictions, in which case, # it may be preferable to read from serving_restrictions directly. # Can be used to filter the response of the # creatives.list # method. # Corresponds to the JSON property `dealsStatus` # @return [String] attr_accessor :deals_status # @OutputOnly Detected advertiser IDs, if any. # Corresponds to the JSON property `detectedAdvertiserIds` # @return [Array] attr_accessor :detected_advertiser_ids # @OutputOnly # The detected domains for this creative. # Corresponds to the JSON property `detectedDomains` # @return [Array] attr_accessor :detected_domains # @OutputOnly # The detected languages for this creative. The order is arbitrary. The codes # are 2 or 5 characters and are documented at # https://developers.google.com/adwords/api/docs/appendix/languagecodes. # Corresponds to the JSON property `detectedLanguages` # @return [Array] attr_accessor :detected_languages # @OutputOnly Detected product categories, if any. # See the ad-product-categories.txt file in the technical documentation # for a list of IDs. # Corresponds to the JSON property `detectedProductCategories` # @return [Array] attr_accessor :detected_product_categories # @OutputOnly Detected sensitive categories, if any. # See the ad-sensitive-categories.txt file in the technical documentation for # a list of IDs. You should use these IDs along with the # excluded-sensitive-category field in the bid request to filter your bids. # Corresponds to the JSON property `detectedSensitiveCategories` # @return [Array] attr_accessor :detected_sensitive_categories # @OutputOnly Filtering reasons for this creative during a period of a single # day (from midnight to midnight Pacific). # Corresponds to the JSON property `filteringStats` # @return [Google::Apis::Adexchangebuyer2V2beta1::FilteringStats] attr_accessor :filtering_stats # HTML content for a creative. # Corresponds to the JSON property `html` # @return [Google::Apis::Adexchangebuyer2V2beta1::HtmlContent] attr_accessor :html # The set of URLs to be called to record an impression. # Corresponds to the JSON property `impressionTrackingUrls` # @return [Array] attr_accessor :impression_tracking_urls # Native content for a creative. # Corresponds to the JSON property `native` # @return [Google::Apis::Adexchangebuyer2V2beta1::NativeContent] attr_accessor :native # @OutputOnly The top-level open auction status of this creative. # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in # serving_restrictions will also exist. Note # that this may be nuanced with other contextual restrictions, in which case, # it may be preferable to read from serving_restrictions directly. # Can be used to filter the response of the # creatives.list # method. # Corresponds to the JSON property `openAuctionStatus` # @return [String] attr_accessor :open_auction_status # All restricted categories for the ads that may be shown from this creative. # Corresponds to the JSON property `restrictedCategories` # @return [Array] attr_accessor :restricted_categories # @OutputOnly The granular status of this ad in specific contexts. # A context here relates to where something ultimately serves (for example, # a physical location, a platform, an HTTPS vs HTTP request, or the type # of auction). # Corresponds to the JSON property `servingRestrictions` # @return [Array] attr_accessor :serving_restrictions # All vendor IDs for the ads that may be shown from this creative. # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt # for possible values. # Corresponds to the JSON property `vendorIds` # @return [Array] attr_accessor :vendor_ids # @OutputOnly The version of this creative. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version # Video content for a creative. # Corresponds to the JSON property `video` # @return [Google::Apis::Adexchangebuyer2V2beta1::VideoContent] attr_accessor :video def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @ad_choices_destination_url = args[:ad_choices_destination_url] if args.key?(:ad_choices_destination_url) @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name) @agency_id = args[:agency_id] if args.key?(:agency_id) @api_update_time = args[:api_update_time] if args.key?(:api_update_time) @attributes = args[:attributes] if args.key?(:attributes) @click_through_urls = args[:click_through_urls] if args.key?(:click_through_urls) @corrections = args[:corrections] if args.key?(:corrections) @creative_id = args[:creative_id] if args.key?(:creative_id) @deals_status = args[:deals_status] if args.key?(:deals_status) @detected_advertiser_ids = args[:detected_advertiser_ids] if args.key?(:detected_advertiser_ids) @detected_domains = args[:detected_domains] if args.key?(:detected_domains) @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @detected_product_categories = args[:detected_product_categories] if args.key?(:detected_product_categories) @detected_sensitive_categories = args[:detected_sensitive_categories] if args.key?(:detected_sensitive_categories) @filtering_stats = args[:filtering_stats] if args.key?(:filtering_stats) @html = args[:html] if args.key?(:html) @impression_tracking_urls = args[:impression_tracking_urls] if args.key?(:impression_tracking_urls) @native = args[:native] if args.key?(:native) @open_auction_status = args[:open_auction_status] if args.key?(:open_auction_status) @restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories) @serving_restrictions = args[:serving_restrictions] if args.key?(:serving_restrictions) @vendor_ids = args[:vendor_ids] if args.key?(:vendor_ids) @version = args[:version] if args.key?(:version) @video = args[:video] if args.key?(:video) end end # The association between a creative and a deal. class CreativeDealAssociation include Google::Apis::Core::Hashable # The account the creative belongs to. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # The ID of the creative associated with the deal. # Corresponds to the JSON property `creativeId` # @return [String] attr_accessor :creative_id # The externalDealId for the deal associated with the creative. # Corresponds to the JSON property `dealsId` # @return [String] attr_accessor :deals_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @creative_id = args[:creative_id] if args.key?(:creative_id) @deals_id = args[:deals_id] if args.key?(:deals_id) end end # The number of bids with the specified dimension values that did not win the # auction (either were filtered pre-auction or lost the auction), as described # by the specified creative status. class CreativeStatusRow include Google::Apis::Core::Hashable # 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 `bidCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bid_count # The ID of the creative status. # See [creative-status-codes](https://developers.google.com/ad-exchange/rtb/ # downloads/creative-status-codes). # Corresponds to the JSON property `creativeStatusId` # @return [Fixnum] attr_accessor :creative_status_id # 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` # @return [Google::Apis::Adexchangebuyer2V2beta1::RowDimensions] attr_accessor :row_dimensions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bid_count = args[:bid_count] if args.key?(:bid_count) @creative_status_id = args[:creative_status_id] if args.key?(:creative_status_id) @row_dimensions = args[:row_dimensions] if args.key?(:row_dimensions) end end # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary 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/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. # 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 # @OutputOnly The reason and details for a disapproval. class Disapproval include Google::Apis::Core::Hashable # Additional details about the reason for disapproval. # Corresponds to the JSON property `details` # @return [Array] attr_accessor :details # The categorized reason for disapproval. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @details = args[:details] if args.key?(:details) @reason = args[:reason] if args.key?(:reason) 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 set of filters that is applied to a request for data. # Within a filter set, an AND operation is performed across the filters # represented by each field. An OR operation is performed across the filters # represented by the multiple values of a repeated field. E.g. # "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR # seller_network_id=56)" class FilterSet include Google::Apis::Core::Hashable # An absolute date range, specified by its start date and end date. # The supported range of dates begins 30 days before today and ends today. # Validity checked upon filter set creation. If a filter set with an absolute # date range is run at a later date more than 30 days after start_date, it will # fail. # Corresponds to the JSON property `absoluteDateRange` # @return [Google::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange] attr_accessor :absolute_date_range # The ID of the creative on which to filter; optional. This field may be set # only for a filter set that accesses account-level troubleshooting data, # i.e. one whose name matches the `bidders/*/accounts/*/filterSets/*` # pattern. # Corresponds to the JSON property `creativeId` # @return [String] attr_accessor :creative_id # The ID of the deal on which to filter; optional. This field may be set # only for a filter set that accesses account-level troubleshooting data, # i.e. one whose name matches the `bidders/*/accounts/*/filterSets/*` # pattern. # Corresponds to the JSON property `dealId` # @return [Fixnum] attr_accessor :deal_id # The environment on which to filter; optional. # Corresponds to the JSON property `environment` # @return [String] attr_accessor :environment # DEPRECATED: use repeated formats field instead. # The format on which to filter; optional. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # The list of formats on which to filter; may be empty. The filters # represented by multiple formats are ORed together (i.e. if non-empty, # results must match any one of the formats). # Corresponds to the JSON property `formats` # @return [Array] attr_accessor :formats # A user-defined name of the filter set. Filter set names must be unique # globally and match one of the patterns: # - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting # data) # - `bidders/*/accounts/*/filterSets/*` (for accessing account-level # troubleshooting data) # This field is required in create operations. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The list of platforms on which to filter; may be empty. The filters # represented by multiple platforms are ORed together (i.e. if non-empty, # results must match any one of the platforms). # Corresponds to the JSON property `platforms` # @return [Array] attr_accessor :platforms # An open-ended realtime time range specified by the start timestamp. # For filter sets that specify a realtime time range RTB metrics continue to # be aggregated throughout the lifetime of the filter set. # Corresponds to the JSON property `realtimeTimeRange` # @return [Google::Apis::Adexchangebuyer2V2beta1::RealtimeTimeRange] attr_accessor :realtime_time_range # A relative date range, specified by an offset and a duration. # The supported range of dates begins 30 days before today and ends today. # I.e. the limits for these values are: # offset_days >= 0 # duration_days >= 1 # offset_days + duration_days <= 30 # Corresponds to the JSON property `relativeDateRange` # @return [Google::Apis::Adexchangebuyer2V2beta1::RelativeDateRange] attr_accessor :relative_date_range # The list of IDs of the seller (publisher) networks on which to filter; # may be empty. The filters represented by multiple seller network IDs are # ORed together (i.e. if non-empty, results must match any one of the # publisher networks). # See [seller-network-ids](https://developers.google.com/ad-exchange/rtb/ # downloads/seller-network-ids) # file for the set of existing seller network IDs. # Corresponds to the JSON property `sellerNetworkIds` # @return [Array] attr_accessor :seller_network_ids # The granularity of time intervals if a time series breakdown is desired; # optional. # Corresponds to the JSON property `timeSeriesGranularity` # @return [String] attr_accessor :time_series_granularity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @absolute_date_range = args[:absolute_date_range] if args.key?(:absolute_date_range) @creative_id = args[:creative_id] if args.key?(:creative_id) @deal_id = args[:deal_id] if args.key?(:deal_id) @environment = args[:environment] if args.key?(:environment) @format = args[:format] if args.key?(:format) @formats = args[:formats] if args.key?(:formats) @name = args[:name] if args.key?(:name) @platforms = args[:platforms] if args.key?(:platforms) @realtime_time_range = args[:realtime_time_range] if args.key?(:realtime_time_range) @relative_date_range = args[:relative_date_range] if args.key?(:relative_date_range) @seller_network_ids = args[:seller_network_ids] if args.key?(:seller_network_ids) @time_series_granularity = args[:time_series_granularity] if args.key?(:time_series_granularity) end end # The number of filtered bids with the specified dimension values that have the # specified creative. class FilteredBidCreativeRow include Google::Apis::Core::Hashable # 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 `bidCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bid_count # The ID of the creative. # Corresponds to the JSON property `creativeId` # @return [String] attr_accessor :creative_id # 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` # @return [Google::Apis::Adexchangebuyer2V2beta1::RowDimensions] attr_accessor :row_dimensions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bid_count = args[:bid_count] if args.key?(:bid_count) @creative_id = args[:creative_id] if args.key?(:creative_id) @row_dimensions = args[:row_dimensions] if args.key?(:row_dimensions) end end # The number of filtered bids with the specified dimension values, among those # filtered due to the requested filtering reason (i.e. creative status), that # have the specified detail. class FilteredBidDetailRow include Google::Apis::Core::Hashable # 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 `bidCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bid_count # The ID of the detail. The associated value can be looked up in the # dictionary file corresponding to the DetailType in the response message. # Corresponds to the JSON property `detailId` # @return [Fixnum] attr_accessor :detail_id # 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` # @return [Google::Apis::Adexchangebuyer2V2beta1::RowDimensions] attr_accessor :row_dimensions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bid_count = args[:bid_count] if args.key?(:bid_count) @detail_id = args[:detail_id] if args.key?(:detail_id) @row_dimensions = args[:row_dimensions] if args.key?(:row_dimensions) end end # @OutputOnly Filtering reasons for this creative during a period of a single # day (from midnight to midnight Pacific). class FilteringStats include Google::Apis::Core::Hashable # Represents a whole calendar date, e.g. date of birth. The time of day and # time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. The day may be 0 to # represent a year and month where the day is not significant, e.g. credit card # expiration date. The year may be 0 to represent a month and day independent # of year, e.g. anniversary date. Related types are google.type.TimeOfDay # and `google.protobuf.Timestamp`. # Corresponds to the JSON property `date` # @return [Google::Apis::Adexchangebuyer2V2beta1::Date] attr_accessor :date # The set of filtering reasons for this date. # Corresponds to the JSON property `reasons` # @return [Array] attr_accessor :reasons def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @date = args[:date] if args.key?(:date) @reasons = args[:reasons] if args.key?(:reasons) end end # HTML content for a creative. class HtmlContent include Google::Apis::Core::Hashable # The height of the HTML snippet in pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # The HTML snippet that displays the ad when inserted in the web page. # Corresponds to the JSON property `snippet` # @return [String] attr_accessor :snippet # The width of the HTML snippet in pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @snippet = args[:snippet] if args.key?(:snippet) @width = args[:width] if args.key?(:width) end end # An image resource. You may provide a larger image than was requested, # so long as the aspect ratio is preserved. class Image include Google::Apis::Core::Hashable # Image height in pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height # The URL of the image. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Image width in pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @height = args[:height] if args.key?(:height) @url = args[:url] if args.key?(:url) @width = args[:width] if args.key?(:width) end end # The set of metrics that are measured in numbers of impressions, representing # how many impressions with the specified dimension values were considered # eligible at each stage of the bidding funnel. class ImpressionMetricsRow include Google::Apis::Core::Hashable # 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 `availableImpressions` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :available_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 `bidRequests` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bid_requests # 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 `inventoryMatches` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :inventory_matches # 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 `responsesWithBids` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :responses_with_bids # 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` # @return [Google::Apis::Adexchangebuyer2V2beta1::RowDimensions] attr_accessor :row_dimensions # 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 `successfulResponses` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :successful_responses def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @available_impressions = args[:available_impressions] if args.key?(:available_impressions) @bid_requests = args[:bid_requests] if args.key?(:bid_requests) @inventory_matches = args[:inventory_matches] if args.key?(:inventory_matches) @responses_with_bids = args[:responses_with_bids] if args.key?(:responses_with_bids) @row_dimensions = args[:row_dimensions] if args.key?(:row_dimensions) @successful_responses = args[:successful_responses] if args.key?(:successful_responses) end end # Response message for listing the metrics that are measured in number of bids. class ListBidMetricsResponse include Google::Apis::Core::Hashable # List of rows, each containing a set of bid metrics. # Corresponds to the JSON property `bidMetricsRows` # @return [Array] attr_accessor :bid_metrics_rows # A token to retrieve the next page of results. # Pass this value in the # ListBidMetricsRequest.pageToken # field in the subsequent call to the bidMetrics.list # 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) @bid_metrics_rows = args[:bid_metrics_rows] if args.key?(:bid_metrics_rows) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for listing all reasons that bid responses resulted in an # error. class ListBidResponseErrorsResponse include Google::Apis::Core::Hashable # List of rows, with counts of bid responses aggregated by callout status. # Corresponds to the JSON property `calloutStatusRows` # @return [Array] attr_accessor :callout_status_rows # A token to retrieve the next page of results. # Pass this value in the # ListBidResponseErrorsRequest.pageToken # field in the subsequent call to the bidResponseErrors.list # 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) @callout_status_rows = args[:callout_status_rows] if args.key?(:callout_status_rows) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for listing all reasons that bid responses were considered # to have no applicable bids. class ListBidResponsesWithoutBidsResponse include Google::Apis::Core::Hashable # List of rows, with counts of bid responses without bids aggregated by # status. # Corresponds to the JSON property `bidResponseWithoutBidsStatusRows` # @return [Array] attr_accessor :bid_response_without_bids_status_rows # A token to retrieve the next page of results. # Pass this value in the # ListBidResponsesWithoutBidsRequest.pageToken # field in the subsequent call to the bidResponsesWithoutBids.list # 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) @bid_response_without_bids_status_rows = args[:bid_response_without_bids_status_rows] if args.key?(:bid_response_without_bids_status_rows) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # class ListClientUserInvitationsResponse include Google::Apis::Core::Hashable # The returned list of client users. # Corresponds to the JSON property `invitations` # @return [Array] attr_accessor :invitations # A token to retrieve the next page of results. # Pass this value in the # ListClientUserInvitationsRequest.pageToken # field in the subsequent call to the # clients.invitations.list # 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) @invitations = args[:invitations] if args.key?(:invitations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # class ListClientUsersResponse include Google::Apis::Core::Hashable # A token to retrieve the next page of results. # Pass this value in the # ListClientUsersRequest.pageToken # field in the subsequent call to the # clients.invitations.list # method to retrieve the next # page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The returned list of client users. # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users 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) @users = args[:users] if args.key?(:users) end end # class ListClientsResponse include Google::Apis::Core::Hashable # The returned list of clients. # Corresponds to the JSON property `clients` # @return [Array] attr_accessor :clients # A token to retrieve the next page of results. # Pass this value in the # ListClientsRequest.pageToken # field in the subsequent call to the # accounts.clients.list 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) @clients = args[:clients] if args.key?(:clients) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for listing all creatives associated with a given filtered # bid reason. class ListCreativeStatusBreakdownByCreativeResponse include Google::Apis::Core::Hashable # List of rows, with counts of bids with a given creative status aggregated # by creative. # Corresponds to the JSON property `filteredBidCreativeRows` # @return [Array] attr_accessor :filtered_bid_creative_rows # A token to retrieve the next page of results. # Pass this value in the # ListCreativeStatusBreakdownByCreativeRequest.pageToken # field in the subsequent call to the filteredBids.creatives.list # 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) @filtered_bid_creative_rows = args[:filtered_bid_creative_rows] if args.key?(:filtered_bid_creative_rows) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for listing all details associated with a given filtered bid # reason. class ListCreativeStatusBreakdownByDetailResponse include Google::Apis::Core::Hashable # The type of detail that the detail IDs represent. # Corresponds to the JSON property `detailType` # @return [String] attr_accessor :detail_type # List of rows, with counts of bids with a given creative status aggregated # by detail. # Corresponds to the JSON property `filteredBidDetailRows` # @return [Array] attr_accessor :filtered_bid_detail_rows # A token to retrieve the next page of results. # Pass this value in the # ListCreativeStatusBreakdownByDetailRequest.pageToken # field in the subsequent call to the filteredBids.details.list # 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) @detail_type = args[:detail_type] if args.key?(:detail_type) @filtered_bid_detail_rows = args[:filtered_bid_detail_rows] if args.key?(:filtered_bid_detail_rows) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # A response for listing creatives. class ListCreativesResponse include Google::Apis::Core::Hashable # The list of creatives. # 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 # ListCreativesRequest.page_token # field in the subsequent call to `ListCreatives` 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) @creatives = args[:creatives] if args.key?(:creatives) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # A response for listing creative and deal associations class ListDealAssociationsResponse include Google::Apis::Core::Hashable # The list of associations. # Corresponds to the JSON property `associations` # @return [Array] attr_accessor :associations # A token to retrieve the next page of results. # Pass this value in the # ListDealAssociationsRequest.page_token # field in the subsequent call to 'ListDealAssociation' 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) @associations = args[:associations] if args.key?(:associations) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for listing filter sets. class ListFilterSetsResponse include Google::Apis::Core::Hashable # The filter sets belonging to the buyer. # Corresponds to the JSON property `filterSets` # @return [Array] attr_accessor :filter_sets # A token to retrieve the next page of results. # Pass this value in the # ListFilterSetsRequest.pageToken # field in the subsequent call to the # accounts.filterSets.list # 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) @filter_sets = args[:filter_sets] if args.key?(:filter_sets) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for listing all reasons that bid requests were filtered and # not sent to the buyer. class ListFilteredBidRequestsResponse include Google::Apis::Core::Hashable # List of rows, with counts of filtered bid requests aggregated by callout # status. # Corresponds to the JSON property `calloutStatusRows` # @return [Array] attr_accessor :callout_status_rows # A token to retrieve the next page of results. # Pass this value in the # ListFilteredBidRequestsRequest.pageToken # field in the subsequent call to the filteredBidRequests.list # 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) @callout_status_rows = args[:callout_status_rows] if args.key?(:callout_status_rows) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for listing all reasons that bids were filtered from the # auction. class ListFilteredBidsResponse include Google::Apis::Core::Hashable # List of rows, with counts of filtered bids aggregated by filtering reason # (i.e. creative status). # Corresponds to the JSON property `creativeStatusRows` # @return [Array] attr_accessor :creative_status_rows # A token to retrieve the next page of results. # Pass this value in the # ListFilteredBidsRequest.pageToken # field in the subsequent call to the filteredBids.list # 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) @creative_status_rows = args[:creative_status_rows] if args.key?(:creative_status_rows) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for listing the metrics that are measured in number of # impressions. class ListImpressionMetricsResponse include Google::Apis::Core::Hashable # List of rows, each containing a set of impression metrics. # Corresponds to the JSON property `impressionMetricsRows` # @return [Array] attr_accessor :impression_metrics_rows # A token to retrieve the next page of results. # Pass this value in the # ListImpressionMetricsRequest.pageToken # field in the subsequent call to the impressionMetrics.list # 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) @impression_metrics_rows = args[:impression_metrics_rows] if args.key?(:impression_metrics_rows) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for listing all reasons that bids lost in the auction. class ListLosingBidsResponse include Google::Apis::Core::Hashable # List of rows, with counts of losing bids aggregated by loss reason (i.e. # creative status). # Corresponds to the JSON property `creativeStatusRows` # @return [Array] attr_accessor :creative_status_rows # A token to retrieve the next page of results. # Pass this value in the # ListLosingBidsRequest.pageToken # field in the subsequent call to the losingBids.list # 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) @creative_status_rows = args[:creative_status_rows] if args.key?(:creative_status_rows) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for listing all reasons for which a buyer was not billed for # a winning bid. class ListNonBillableWinningBidsResponse include Google::Apis::Core::Hashable # A token to retrieve the next page of results. # Pass this value in the # ListNonBillableWinningBidsRequest.pageToken # field in the subsequent call to the nonBillableWinningBids.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # List of rows, with counts of bids not billed aggregated by reason. # Corresponds to the JSON property `nonBillableWinningBidStatusRows` # @return [Array] attr_accessor :non_billable_winning_bid_status_rows 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) @non_billable_winning_bid_status_rows = args[:non_billable_winning_bid_status_rows] if args.key?(:non_billable_winning_bid_status_rows) end end # @OutputOnly The Geo criteria the restriction applies to. class LocationContext include Google::Apis::Core::Hashable # IDs representing the geo location for this context. # Please refer to the # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table. # csv) # file for different geo criteria IDs. # Corresponds to the JSON property `geoCriteriaIds` # @return [Array] attr_accessor :geo_criteria_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @geo_criteria_ids = args[:geo_criteria_ids] if args.key?(:geo_criteria_ids) end end # A metric value, with an expected value and a variance; represents a count # that may be either exact or estimated (i.e. when sampled). class MetricValue include Google::Apis::Core::Hashable # The expected value of the metric. # Corresponds to the JSON property `value` # @return [Fixnum] attr_accessor :value # The variance (i.e. square of the standard deviation) of the metric value. # If value is exact, variance is 0. # Can be used to calculate margin of error as a percentage of value, using # the following formula, where Z is the standard constant that depends on the # desired size of the confidence interval (e.g. for 90% confidence interval, # use Z = 1.645): # marginOfError = 100 * Z * sqrt(variance) / value # Corresponds to the JSON property `variance` # @return [Fixnum] attr_accessor :variance def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @value = args[:value] if args.key?(:value) @variance = args[:variance] if args.key?(:variance) end end # Native content for a creative. class NativeContent include Google::Apis::Core::Hashable # The name of the advertiser or sponsor, to be displayed in the ad creative. # Corresponds to the JSON property `advertiserName` # @return [String] attr_accessor :advertiser_name # An image resource. You may provide a larger image than was requested, # so long as the aspect ratio is preserved. # Corresponds to the JSON property `appIcon` # @return [Google::Apis::Adexchangebuyer2V2beta1::Image] attr_accessor :app_icon # A long description of the ad. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body # A label for the button that the user is supposed to click. # Corresponds to the JSON property `callToAction` # @return [String] attr_accessor :call_to_action # The URL that the browser/SDK will load when the user clicks the ad. # Corresponds to the JSON property `clickLinkUrl` # @return [String] attr_accessor :click_link_url # The URL to use for click tracking. # Corresponds to the JSON property `clickTrackingUrl` # @return [String] attr_accessor :click_tracking_url # A short title for the ad. # Corresponds to the JSON property `headline` # @return [String] attr_accessor :headline # An image resource. You may provide a larger image than was requested, # so long as the aspect ratio is preserved. # Corresponds to the JSON property `image` # @return [Google::Apis::Adexchangebuyer2V2beta1::Image] attr_accessor :image # An image resource. You may provide a larger image than was requested, # so long as the aspect ratio is preserved. # Corresponds to the JSON property `logo` # @return [Google::Apis::Adexchangebuyer2V2beta1::Image] attr_accessor :logo # The price of the promoted app including currency info. # Corresponds to the JSON property `priceDisplayText` # @return [String] attr_accessor :price_display_text # The app rating in the app store. Must be in the range [0-5]. # Corresponds to the JSON property `starRating` # @return [Float] attr_accessor :star_rating # The URL to the app store to purchase/download the promoted app. # Corresponds to the JSON property `storeUrl` # @return [String] attr_accessor :store_url # The URL to fetch a native video ad. # Corresponds to the JSON property `videoUrl` # @return [String] attr_accessor :video_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name) @app_icon = args[:app_icon] if args.key?(:app_icon) @body = args[:body] if args.key?(:body) @call_to_action = args[:call_to_action] if args.key?(:call_to_action) @click_link_url = args[:click_link_url] if args.key?(:click_link_url) @click_tracking_url = args[:click_tracking_url] if args.key?(:click_tracking_url) @headline = args[:headline] if args.key?(:headline) @image = args[:image] if args.key?(:image) @logo = args[:logo] if args.key?(:logo) @price_display_text = args[:price_display_text] if args.key?(:price_display_text) @star_rating = args[:star_rating] if args.key?(:star_rating) @store_url = args[:store_url] if args.key?(:store_url) @video_url = args[:video_url] if args.key?(:video_url) end end # The number of winning bids with the specified dimension values for which the # buyer was not billed, as described by the specified status. class NonBillableWinningBidStatusRow include Google::Apis::Core::Hashable # 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 `bidCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bid_count # 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` # @return [Google::Apis::Adexchangebuyer2V2beta1::RowDimensions] attr_accessor :row_dimensions # The status specifying why the winning bids were not billed. # 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) @bid_count = args[:bid_count] if args.key?(:bid_count) @row_dimensions = args[:row_dimensions] if args.key?(:row_dimensions) @status = args[:status] if args.key?(:status) end end # @OutputOnly The type of platform the restriction applies to. class PlatformContext include Google::Apis::Core::Hashable # The platforms this restriction applies to. # Corresponds to the JSON property `platforms` # @return [Array] attr_accessor :platforms def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @platforms = args[:platforms] if args.key?(:platforms) end end # An open-ended realtime time range specified by the start timestamp. # For filter sets that specify a realtime time range RTB metrics continue to # be aggregated throughout the lifetime of the filter set. class RealtimeTimeRange include Google::Apis::Core::Hashable # The start timestamp of the real-time RTB metrics aggregation. # Corresponds to the JSON property `startTimestamp` # @return [String] attr_accessor :start_timestamp def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @start_timestamp = args[:start_timestamp] if args.key?(:start_timestamp) end end # A specific filtering status and how many times it occurred. class Reason include Google::Apis::Core::Hashable # The number of times the creative was filtered for the status. The # count is aggregated across all publishers on the exchange. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # The filtering status code. Please refer to the # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb- # dictionaries/creative-status-codes.txt) # file for different statuses. # Corresponds to the JSON property `status` # @return [Fixnum] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @count = args[:count] if args.key?(:count) @status = args[:status] if args.key?(:status) end end # A relative date range, specified by an offset and a duration. # The supported range of dates begins 30 days before today and ends today. # I.e. the limits for these values are: # offset_days >= 0 # duration_days >= 1 # offset_days + duration_days <= 30 class RelativeDateRange include Google::Apis::Core::Hashable # The number of days in the requested date range. E.g. for a range spanning # today, 1. For a range spanning the last 7 days, 7. # Corresponds to the JSON property `durationDays` # @return [Fixnum] attr_accessor :duration_days # The end date of the filter set, specified as the number of days before # today. E.g. for a range where the last date is today, 0. # Corresponds to the JSON property `offsetDays` # @return [Fixnum] attr_accessor :offset_days def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @duration_days = args[:duration_days] if args.key?(:duration_days) @offset_days = args[:offset_days] if args.key?(:offset_days) end end # A request for removing the association between a deal and a creative. class RemoveDealAssociationRequest include Google::Apis::Core::Hashable # The association between a creative and a deal. # Corresponds to the JSON property `association` # @return [Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation] attr_accessor :association def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @association = args[:association] if args.key?(:association) end end # A response may include multiple rows, breaking down along various dimensions. # Encapsulates the values of all dimensions for a given row. class RowDimensions include Google::Apis::Core::Hashable # An interval of time, with an absolute start and end. # Corresponds to the JSON property `timeInterval` # @return [Google::Apis::Adexchangebuyer2V2beta1::TimeInterval] attr_accessor :time_interval def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @time_interval = args[:time_interval] if args.key?(:time_interval) end end # @OutputOnly A security context. class SecurityContext include Google::Apis::Core::Hashable # The security types in this context. # Corresponds to the JSON property `securities` # @return [Array] attr_accessor :securities def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @securities = args[:securities] if args.key?(:securities) end end # The serving context for this restriction. class ServingContext include Google::Apis::Core::Hashable # Matches all contexts. # Corresponds to the JSON property `all` # @return [String] attr_accessor :all # @OutputOnly The app type the restriction applies to for mobile device. # Corresponds to the JSON property `appType` # @return [Google::Apis::Adexchangebuyer2V2beta1::AppContext] attr_accessor :app_type # @OutputOnly The auction type the restriction applies to. # Corresponds to the JSON property `auctionType` # @return [Google::Apis::Adexchangebuyer2V2beta1::AuctionContext] attr_accessor :auction_type # @OutputOnly The Geo criteria the restriction applies to. # Corresponds to the JSON property `location` # @return [Google::Apis::Adexchangebuyer2V2beta1::LocationContext] attr_accessor :location # @OutputOnly The type of platform the restriction applies to. # Corresponds to the JSON property `platform` # @return [Google::Apis::Adexchangebuyer2V2beta1::PlatformContext] attr_accessor :platform # @OutputOnly A security context. # Corresponds to the JSON property `securityType` # @return [Google::Apis::Adexchangebuyer2V2beta1::SecurityContext] attr_accessor :security_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @all = args[:all] if args.key?(:all) @app_type = args[:app_type] if args.key?(:app_type) @auction_type = args[:auction_type] if args.key?(:auction_type) @location = args[:location] if args.key?(:location) @platform = args[:platform] if args.key?(:platform) @security_type = args[:security_type] if args.key?(:security_type) end end # @OutputOnly A representation of the status of an ad in a # specific context. A context here relates to where something ultimately serves # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, # or the type of auction). class ServingRestriction include Google::Apis::Core::Hashable # The contexts for the restriction. # Corresponds to the JSON property `contexts` # @return [Array] attr_accessor :contexts # Any disapprovals bound to this restriction. # Only present if status=DISAPPROVED. # Can be used to filter the response of the # creatives.list # method. # Corresponds to the JSON property `disapprovalReasons` # @return [Array] attr_accessor :disapproval_reasons # The status of the creative in this context (for example, it has been # explicitly disapproved or is pending 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) @contexts = args[:contexts] if args.key?(:contexts) @disapproval_reasons = args[:disapproval_reasons] if args.key?(:disapproval_reasons) @status = args[:status] if args.key?(:status) end end # A request for stopping notifications for changes to creative Status. class StopWatchingCreativeRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # An interval of time, with an absolute start and end. class TimeInterval include Google::Apis::Core::Hashable # The timestamp marking the end of the range (exclusive) for which data is # included. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # The timestamp marking the start of the range (inclusive) for which data is # included. # 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 # Video content for a creative. class VideoContent include Google::Apis::Core::Hashable # The URL to fetch a video ad. # Corresponds to the JSON property `videoUrl` # @return [String] attr_accessor :video_url # The contents of a VAST document for a video ad. # This document should conform to the VAST 2.0 or 3.0 standard. # Corresponds to the JSON property `videoVastXml` # @return [String] attr_accessor :video_vast_xml def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @video_url = args[:video_url] if args.key?(:video_url) @video_vast_xml = args[:video_vast_xml] if args.key?(:video_vast_xml) end end # A request for watching changes to creative Status. class WatchCreativeRequest include Google::Apis::Core::Hashable # The Pub/Sub topic to publish notifications to. # This topic must already exist and must give permission to # ad-exchange-buyside-reports@google.com to write to the topic. # This should be the full resource name in # "projects/`project_id`/topics/`topic_id`" format. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @topic = args[:topic] if args.key?(:topic) end end end end end google-api-client-0.19.8/generated/google/apis/adexchangebuyer2_v2beta1/service.rb0000644000004100000410000042363413252673043030060 0ustar www-datawww-data# 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 Adexchangebuyer2V2beta1 # Ad Exchange Buyer API II # # Accesses the latest features for managing Ad Exchange accounts, Real-Time # Bidding configurations and auction metrics, and Marketplace programmatic deals. # # @example # require 'google/apis/adexchangebuyer2_v2beta1' # # Adexchangebuyer2 = Google::Apis::Adexchangebuyer2V2beta1 # Alias the module # service = Adexchangebuyer2::AdExchangeBuyerIIService.new # # @see https://developers.google.com/ad-exchange/buyer-rest/reference/rest/ class AdExchangeBuyerIIService < 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://adexchangebuyer.googleapis.com/', '') @batch_path = 'batch' end # Creates a new client buyer. # @param [Fixnum] account_id # Unique numerical account ID for the buyer of which the client buyer # is a customer; the sponsor buyer to create a client for. (required) # @param [Google::Apis::Adexchangebuyer2V2beta1::Client] client_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::Adexchangebuyer2V2beta1::Client] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::Client] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_client(account_id, client_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/clients', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation command.request_object = client_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Client command.params['accountId'] = account_id unless account_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 client buyer with a given client account ID. # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [Fixnum] client_account_id # Numerical account ID of the client buyer to retrieve. (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::Adexchangebuyer2V2beta1::Client] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::Client] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_client(account_id, client_account_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Client command.params['accountId'] = account_id unless account_id.nil? command.params['clientAccountId'] = client_account_id unless client_account_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 all the clients for the current sponsor buyer. # @param [Fixnum] account_id # Unique numerical account ID of the sponsor buyer to list the clients for. # @param [Fixnum] page_size # Requested page size. The server may return fewer clients than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListClientsResponse.nextPageToken # returned from the previous call to the # accounts.clients.list method. # @param [String] partner_client_id # Optional unique identifier (from the standpoint of an Ad Exchange sponsor # buyer partner) of the client to return. # If specified, at most one client will be returned 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::Adexchangebuyer2V2beta1::ListClientsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_clients(account_id, page_size: nil, page_token: nil, partner_client_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse command.params['accountId'] = account_id unless account_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['partnerClientId'] = partner_client_id unless partner_client_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 client buyer. # @param [Fixnum] account_id # Unique numerical account ID for the buyer of which the client buyer # is a customer; the sponsor buyer to update a client for. (required) # @param [Fixnum] client_account_id # Unique numerical account ID of the client to update. (required) # @param [Google::Apis::Adexchangebuyer2V2beta1::Client] client_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::Adexchangebuyer2V2beta1::Client] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::Client] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_client(account_id, client_account_id, client_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation command.request_object = client_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Client command.params['accountId'] = account_id unless account_id.nil? command.params['clientAccountId'] = client_account_id unless client_account_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 and sends out an email invitation to access # an Ad Exchange client buyer account. # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [Fixnum] client_account_id # Numerical account ID of the client buyer that the user # should be associated with. (required) # @param [Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation] client_user_invitation_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::Adexchangebuyer2V2beta1::ClientUserInvitation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_client_invitation(account_id, client_account_id, client_user_invitation_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation command.request_object = client_user_invitation_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation command.params['accountId'] = account_id unless account_id.nil? command.params['clientAccountId'] = client_account_id unless client_account_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 an existing client user invitation. # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [Fixnum] client_account_id # Numerical account ID of the client buyer that the user invitation # to be retrieved is associated with. (required) # @param [Fixnum] invitation_id # Numerical identifier of the user invitation to retrieve. (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::Adexchangebuyer2V2beta1::ClientUserInvitation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_client_invitation(account_id, client_account_id, invitation_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation command.params['accountId'] = account_id unless account_id.nil? command.params['clientAccountId'] = client_account_id unless client_account_id.nil? command.params['invitationId'] = invitation_id unless invitation_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 all the client users invitations for a client # with a given account ID. # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [String] client_account_id # Numerical account ID of the client buyer to list invitations for. # (required) # You must either specify a string representation of a # numerical account identifier or the `-` character # to list all the invitations for all the clients # of a given sponsor buyer. # @param [Fixnum] page_size # Requested page size. Server may return fewer clients than requested. # If unspecified, server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListClientUserInvitationsResponse.nextPageToken # returned from the previous call to the # clients.invitations.list # method. # @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::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_client_invitations(account_id, client_account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse command.params['accountId'] = account_id unless account_id.nil? command.params['clientAccountId'] = client_account_id unless client_account_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 # Retrieves an existing client user. # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [Fixnum] client_account_id # Numerical account ID of the client buyer # that the user to be retrieved is associated with. (required) # @param [Fixnum] user_id # Numerical identifier of the user to retrieve. (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::Adexchangebuyer2V2beta1::ClientUser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ClientUser] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_client_user(account_id, client_account_id, user_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUser::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUser command.params['accountId'] = account_id unless account_id.nil? command.params['clientAccountId'] = client_account_id unless client_account_id.nil? command.params['userId'] = user_id unless user_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 all the known client users for a specified # sponsor buyer account ID. # @param [Fixnum] account_id # Numerical account ID of the sponsor buyer of the client to list users for. # (required) # @param [String] client_account_id # The account ID of the client buyer to list users for. (required) # You must specify either a string representation of a # numerical account identifier or the `-` character # to list all the client users for all the clients # of a given sponsor buyer. # @param [Fixnum] page_size # Requested page size. The server may return fewer clients than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListClientUsersResponse.nextPageToken # returned from the previous call to the # accounts.clients.users.list method. # @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::Adexchangebuyer2V2beta1::ListClientUsersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListClientUsersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_client_users(account_id, client_account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/users', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientUsersResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientUsersResponse command.params['accountId'] = account_id unless account_id.nil? command.params['clientAccountId'] = client_account_id unless client_account_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 client user. # Only the user status can be changed on update. # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [Fixnum] client_account_id # Numerical account ID of the client buyer that the user to be retrieved # is associated with. (required) # @param [Fixnum] user_id # Numerical identifier of the user to retrieve. (required) # @param [Google::Apis::Adexchangebuyer2V2beta1::ClientUser] client_user_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::Adexchangebuyer2V2beta1::ClientUser] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ClientUser] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_client_user(account_id, client_account_id, user_id, client_user_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUser::Representation command.request_object = client_user_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUser::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUser command.params['accountId'] = account_id unless account_id.nil? command.params['clientAccountId'] = client_account_id unless client_account_id.nil? command.params['userId'] = user_id unless user_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 creative. # @param [String] account_id # The account that this creative belongs to. # Can be used to filter the response of the # creatives.list # method. # @param [Google::Apis::Adexchangebuyer2V2beta1::Creative] creative_object # @param [String] account_id1 # The account the creative belongs to. # @param [String] duplicate_id_mode # Indicates if multiple creatives can share an ID or not. Default is # NO_DUPLICATES (one ID per creative). # @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::Adexchangebuyer2V2beta1::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::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_account_creative(account_id, creative_object = nil, account_id1: nil, duplicate_id_mode: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Creative command.params['accountId'] = account_id unless account_id.nil? command.query['accountId1'] = account_id1 unless account_id1.nil? command.query['duplicateIdMode'] = duplicate_id_mode unless duplicate_id_mode.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 [String] account_id # The account the creative belongs to. # @param [String] creative_id # The ID of the creative to retrieve. # @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::Adexchangebuyer2V2beta1::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::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_account_creative(account_id, creative_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/creatives/{creativeId}', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Creative command.params['accountId'] = account_id unless account_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. # @param [String] account_id # The account to list the creatives from. # Specify "-" to list all creatives the current user has access to. # @param [Fixnum] page_size # Requested page size. The server may return fewer creatives than requested # (due to timeout constraint) even if more are available via another call. # If unspecified, server will pick an appropriate default. # Acceptable values are 1 to 1000, inclusive. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListCreativesResponse.next_page_token # returned from the previous call to 'ListCreatives' method. # @param [String] query # An optional query string to filter creatives. If no filter is specified, # all active creatives will be returned. # Supported queries are: #

    #
  • accountId=account_id_string #
  • creativeId=creative_id_string #
  • dealsStatus: `approved, conditionally_approved, disapproved, # not_checked` #
  • openAuctionStatus: `approved, conditionally_approved, disapproved, # not_checked` #
  • attribute: `a numeric attribute from the list of attributes` #
  • disapprovalReason: `a reason from # DisapprovalReason` #
# Example: 'accountId=12345 AND (dealsStatus:disapproved AND # disapprovalReason:unacceptable_content) OR attribute:47' # @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::Adexchangebuyer2V2beta1::ListCreativesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::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_account_creatives(account_id, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/creatives', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativesResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativesResponse command.params['accountId'] = account_id unless account_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.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 # Stops watching a creative. Will stop push notifications being sent to the # topics when the creative changes status. # @param [String] account_id # The account of the creative to stop notifications for. # @param [String] creative_id # The creative ID of the creative to stop notifications for. # Specify "-" to specify stopping account level notifications. # @param [Google::Apis::Adexchangebuyer2V2beta1::StopWatchingCreativeRequest] stop_watching_creative_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::Adexchangebuyer2V2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::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 stop_watching_creative(account_id, creative_id, stop_watching_creative_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::StopWatchingCreativeRequest::Representation command.request_object = stop_watching_creative_request_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty command.params['accountId'] = account_id unless account_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 # Updates a creative. # @param [String] account_id # The account that this creative belongs to. # Can be used to filter the response of the # creatives.list # method. # @param [String] creative_id # The buyer-defined creative ID of this creative. # Can be used to filter the response of the # creatives.list # method. # @param [Google::Apis::Adexchangebuyer2V2beta1::Creative] creative_object # @param [String] account_id1 # The account the creative belongs to. # @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::Adexchangebuyer2V2beta1::Creative] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::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 update_account_creative(account_id, creative_id, creative_object = nil, account_id1: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v2beta1/accounts/{accountId}/creatives/{creativeId}', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation command.request_object = creative_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Creative command.params['accountId'] = account_id unless account_id.nil? command.params['creativeId'] = creative_id unless creative_id.nil? command.query['accountId1'] = account_id1 unless account_id1.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Watches a creative. Will result in push notifications being sent to the # topic when the creative changes status. # @param [String] account_id # The account of the creative to watch. # @param [String] creative_id # The creative ID to watch for status changes. # Specify "-" to watch all creatives under the above account. # If both creative-level and account-level notifications are # sent, only a single notification will be sent to the # creative-level notification topic. # @param [Google::Apis::Adexchangebuyer2V2beta1::WatchCreativeRequest] watch_creative_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::Adexchangebuyer2V2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::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 watch_creative(account_id, creative_id, watch_creative_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}:watch', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::WatchCreativeRequest::Representation command.request_object = watch_creative_request_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty command.params['accountId'] = account_id unless account_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 # Associate an existing deal with a creative. # @param [String] account_id # The account the creative belongs to. # @param [String] creative_id # The ID of the creative associated with the deal. # @param [Google::Apis::Adexchangebuyer2V2beta1::AddDealAssociationRequest] add_deal_association_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::Adexchangebuyer2V2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::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 add_deal_association(account_id, creative_id, add_deal_association_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::AddDealAssociationRequest::Representation command.request_object = add_deal_association_request_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty command.params['accountId'] = account_id unless account_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 # List all creative-deal associations. # @param [String] account_id # The account to list the associations from. # Specify "-" to list all creatives the current user has access to. # @param [String] creative_id # The creative ID to list the associations from. # Specify "-" to list all creatives under the above account. # @param [Fixnum] page_size # Requested page size. Server may return fewer associations than requested. # If unspecified, server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListDealAssociationsResponse.next_page_token # returned from the previous call to 'ListDealAssociations' method. # @param [String] query # An optional query string to filter deal associations. If no filter is # specified, all associations will be returned. # Supported queries are: #
    #
  • accountId=account_id_string #
  • creativeId=creative_id_string #
  • dealsId=deals_id_string #
  • dealsStatus:`approved, conditionally_approved, disapproved, # not_checked` #
  • openAuctionStatus:`approved, conditionally_approved, disapproved, # not_checked` #
# Example: 'dealsId=12345 AND dealsStatus:disapproved' # @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::Adexchangebuyer2V2beta1::ListDealAssociationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListDealAssociationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_creative_deal_associations(account_id, creative_id, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListDealAssociationsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListDealAssociationsResponse command.params['accountId'] = account_id unless account_id.nil? command.params['creativeId'] = creative_id unless creative_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.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 # Remove the association between a deal and a creative. # @param [String] account_id # The account the creative belongs to. # @param [String] creative_id # The ID of the creative associated with the deal. # @param [Google::Apis::Adexchangebuyer2V2beta1::RemoveDealAssociationRequest] remove_deal_association_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::Adexchangebuyer2V2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::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 remove_deal_association(account_id, creative_id, remove_deal_association_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::RemoveDealAssociationRequest::Representation command.request_object = remove_deal_association_request_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty command.params['accountId'] = account_id unless account_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 # Creates the specified filter set for the account with the given account ID. # @param [String] owner_name # Name of the owner (bidder or account) of the filter set to be created. # For example: # - For a bidder-level filter set for bidder 123: `bidders/123` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456` # @param [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] filter_set_object # @param [Boolean] is_transient # Whether the filter set is transient, or should be persisted indefinitely. # By default, filter sets are not transient. # If transient, it will be available for at least 1 hour after creation. # @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::Adexchangebuyer2V2beta1::FilterSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set(owner_name, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+ownerName}/filterSets', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation command.request_object = filter_set_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet command.params['ownerName'] = owner_name unless owner_name.nil? command.query['isTransient'] = is_transient unless is_transient.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 requested filter set from the account with the given account # ID. # @param [String] name # Full name of the resource to delete. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @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::Adexchangebuyer2V2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::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_bidder_account_filter_set(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+name}', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::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 # Retrieves the requested filter set for the account with the given account # ID. # @param [String] name # Full name of the resource being requested. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @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::Adexchangebuyer2V2beta1::FilterSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+name}', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet 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 filter sets for the account with the given account ID. # @param [String] owner_name # Name of the owner (bidder or account) of the filter sets to be listed. # For example: # - For a bidder-level filter set for bidder 123: `bidders/123` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListFilterSetsResponse.nextPageToken # returned from the previous call to the # accounts.filterSets.list # method. # @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::Adexchangebuyer2V2beta1::ListFilterSetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_sets(owner_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+ownerName}/filterSets', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse command.params['ownerName'] = owner_name unless owner_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 # Lists all metrics that are measured in terms of number of bids. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListBidMetricsResponse.nextPageToken # returned from the previous call to the bidMetrics.list # method. # @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::Adexchangebuyer2V2beta1::ListBidMetricsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set_bid_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidMetrics', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all errors that occurred in bid responses, with the number of bid # responses affected for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListBidResponseErrorsResponse.nextPageToken # returned from the previous call to the bidResponseErrors.list # method. # @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::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set_bid_response_errors(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponseErrors', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all reasons for which bid responses were considered to have no # applicable bids, with the number of bid responses affected for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListBidResponsesWithoutBidsResponse.nextPageToken # returned from the previous call to the bidResponsesWithoutBids.list # method. # @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::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set_bid_responses_without_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponsesWithoutBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all reasons that caused a bid request not to be sent for an # impression, with the number of bid requests not sent for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListFilteredBidRequestsResponse.nextPageToken # returned from the previous call to the filteredBidRequests.list # method. # @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::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set_filtered_bid_requests(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBidRequests', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all reasons for which bids were filtered, with the number of bids # filtered for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListFilteredBidsResponse.nextPageToken # returned from the previous call to the filteredBids.list # method. # @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::Adexchangebuyer2V2beta1::ListFilteredBidsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set_filtered_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all creatives associated with a specific reason for which bids were # filtered, with the number of bids filtered for each creative. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] creative_status_id # The ID of the creative status for which to retrieve a breakdown by # creative. # See # [creative-status-codes](https://developers.google.com/ad-exchange/rtb/ # downloads/creative-status-codes). # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListCreativeStatusBreakdownByCreativeResponse.nextPageToken # returned from the previous call to the filteredBids.creatives.list # method. # @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::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set_filtered_bid_creatives(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.params['creativeStatusId'] = creative_status_id unless creative_status_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 # List all details associated with a specific reason for which bids were # filtered, with the number of bids filtered for each detail. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] creative_status_id # The ID of the creative status for which to retrieve a breakdown by detail. # See # [creative-status-codes](https://developers.google.com/ad-exchange/rtb/ # downloads/creative-status-codes). # Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListCreativeStatusBreakdownByDetailResponse.nextPageToken # returned from the previous call to the filteredBids.details.list # method. # @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::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set_filtered_bid_details(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.params['creativeStatusId'] = creative_status_id unless creative_status_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 # Lists all metrics that are measured in terms of number of impressions. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListImpressionMetricsResponse.nextPageToken # returned from the previous call to the impressionMetrics.list # method. # @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::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set_impression_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/impressionMetrics', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all reasons for which bids lost in the auction, with the number of # bids that lost for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListLosingBidsResponse.nextPageToken # returned from the previous call to the losingBids.list # method. # @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::Adexchangebuyer2V2beta1::ListLosingBidsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set_losing_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/losingBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all reasons for which winning bids were not billable, with the number # of bids not billed for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListNonBillableWinningBidsResponse.nextPageToken # returned from the previous call to the nonBillableWinningBids.list # method. # @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::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_account_filter_set_non_billable_winning_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/nonBillableWinningBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 the specified filter set for the account with the given account ID. # @param [String] owner_name # Name of the owner (bidder or account) of the filter set to be created. # For example: # - For a bidder-level filter set for bidder 123: `bidders/123` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456` # @param [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] filter_set_object # @param [Boolean] is_transient # Whether the filter set is transient, or should be persisted indefinitely. # By default, filter sets are not transient. # If transient, it will be available for at least 1 hour after creation. # @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::Adexchangebuyer2V2beta1::FilterSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set(owner_name, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+ownerName}/filterSets', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation command.request_object = filter_set_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet command.params['ownerName'] = owner_name unless owner_name.nil? command.query['isTransient'] = is_transient unless is_transient.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 requested filter set from the account with the given account # ID. # @param [String] name # Full name of the resource to delete. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @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::Adexchangebuyer2V2beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::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_bidder_filter_set(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+name}', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::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 # Retrieves the requested filter set for the account with the given account # ID. # @param [String] name # Full name of the resource being requested. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @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::Adexchangebuyer2V2beta1::FilterSet] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+name}', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet 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 filter sets for the account with the given account ID. # @param [String] owner_name # Name of the owner (bidder or account) of the filter sets to be listed. # For example: # - For a bidder-level filter set for bidder 123: `bidders/123` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListFilterSetsResponse.nextPageToken # returned from the previous call to the # accounts.filterSets.list # method. # @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::Adexchangebuyer2V2beta1::ListFilterSetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_sets(owner_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+ownerName}/filterSets', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse command.params['ownerName'] = owner_name unless owner_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 # Lists all metrics that are measured in terms of number of bids. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListBidMetricsResponse.nextPageToken # returned from the previous call to the bidMetrics.list # method. # @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::Adexchangebuyer2V2beta1::ListBidMetricsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set_bid_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidMetrics', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all errors that occurred in bid responses, with the number of bid # responses affected for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListBidResponseErrorsResponse.nextPageToken # returned from the previous call to the bidResponseErrors.list # method. # @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::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set_bid_response_errors(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponseErrors', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all reasons for which bid responses were considered to have no # applicable bids, with the number of bid responses affected for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListBidResponsesWithoutBidsResponse.nextPageToken # returned from the previous call to the bidResponsesWithoutBids.list # method. # @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::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set_bid_responses_without_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponsesWithoutBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all reasons that caused a bid request not to be sent for an # impression, with the number of bid requests not sent for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListFilteredBidRequestsResponse.nextPageToken # returned from the previous call to the filteredBidRequests.list # method. # @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::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set_filtered_bid_requests(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBidRequests', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all reasons for which bids were filtered, with the number of bids # filtered for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListFilteredBidsResponse.nextPageToken # returned from the previous call to the filteredBids.list # method. # @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::Adexchangebuyer2V2beta1::ListFilteredBidsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set_filtered_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all creatives associated with a specific reason for which bids were # filtered, with the number of bids filtered for each creative. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] creative_status_id # The ID of the creative status for which to retrieve a breakdown by # creative. # See # [creative-status-codes](https://developers.google.com/ad-exchange/rtb/ # downloads/creative-status-codes). # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListCreativeStatusBreakdownByCreativeResponse.nextPageToken # returned from the previous call to the filteredBids.creatives.list # method. # @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::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set_filtered_bid_creatives(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.params['creativeStatusId'] = creative_status_id unless creative_status_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 # List all details associated with a specific reason for which bids were # filtered, with the number of bids filtered for each detail. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] creative_status_id # The ID of the creative status for which to retrieve a breakdown by detail. # See # [creative-status-codes](https://developers.google.com/ad-exchange/rtb/ # downloads/creative-status-codes). # Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListCreativeStatusBreakdownByDetailResponse.nextPageToken # returned from the previous call to the filteredBids.details.list # method. # @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::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set_filtered_bid_details(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.params['creativeStatusId'] = creative_status_id unless creative_status_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 # Lists all metrics that are measured in terms of number of impressions. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListImpressionMetricsResponse.nextPageToken # returned from the previous call to the impressionMetrics.list # method. # @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::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set_impression_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/impressionMetrics', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all reasons for which bids lost in the auction, with the number of # bids that lost for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListLosingBidsResponse.nextPageToken # returned from the previous call to the losingBids.list # method. # @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::Adexchangebuyer2V2beta1::ListLosingBidsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set_losing_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/losingBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 # List all reasons for which winning bids were not billable, with the number # of bids not billed for each reason. # @param [String] filter_set_name # Name of the filter set that should be applied to the requested metrics. # For example: # - For a bidder-level filter set for bidder 123: # `bidders/123/filterSets/abc` # - For an account-level filter set for the buyer account representing bidder # 123: `bidders/123/accounts/123/filterSets/abc` # - For an account-level filter set for the child seat buyer account 456 # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. # Typically, this is the value of # ListNonBillableWinningBidsResponse.nextPageToken # returned from the previous call to the nonBillableWinningBids.list # method. # @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::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_bidder_filter_set_non_billable_winning_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+filterSetName}/nonBillableWinningBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse command.params['filterSetName'] = filter_set_name unless filter_set_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 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 google-api-client-0.19.8/generated/google/apis/cloudresourcemanager_v1/0000755000004100000410000000000013252673043026132 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/cloudresourcemanager_v1/representations.rb0000644000004100000410000005342213252673043031712 0ustar www-datawww-data# 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 CloudresourcemanagerV1 class Ancestor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuditLogConfig 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 BooleanConstraint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BooleanPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClearOrgPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Constraint 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 FolderOperation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FolderOperationError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetAncestryRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetAncestryResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetEffectiveOrgPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetOrgPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Lien class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAvailableOrgPolicyConstraintsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAvailableOrgPolicyConstraintsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListConstraint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLiensResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOrgPoliciesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOrgPoliciesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListProjectsResponse 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 OrgPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Organization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrganizationOwner class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Policy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Project class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProjectCreationStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RestoreDefault class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchOrganizationsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchOrganizationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetOrgPolicyRequest 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 TestIamPermissionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestIamPermissionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UndeleteProjectRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Ancestor # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource_id, as: 'resourceId', class: Google::Apis::CloudresourcemanagerV1::ResourceId, decorator: Google::Apis::CloudresourcemanagerV1::ResourceId::Representation end end class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::CloudresourcemanagerV1::AuditLogConfig, decorator: Google::Apis::CloudresourcemanagerV1::AuditLogConfig::Representation property :service, as: 'service' end end class AuditLogConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :exempted_members, as: 'exemptedMembers' property :log_type, as: 'logType' end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation collection :members, as: 'members' property :role, as: 'role' end end class BooleanConstraint # @private class Representation < Google::Apis::Core::JsonRepresentation end end class BooleanPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :enforced, as: 'enforced' end end class ClearOrgPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :constraint, as: 'constraint' property :etag, :base64 => true, as: 'etag' end end class Constraint # @private class Representation < Google::Apis::Core::JsonRepresentation property :boolean_constraint, as: 'booleanConstraint', class: Google::Apis::CloudresourcemanagerV1::BooleanConstraint, decorator: Google::Apis::CloudresourcemanagerV1::BooleanConstraint::Representation property :constraint_default, as: 'constraintDefault' property :description, as: 'description' property :display_name, as: 'displayName' property :list_constraint, as: 'listConstraint', class: Google::Apis::CloudresourcemanagerV1::ListConstraint, decorator: Google::Apis::CloudresourcemanagerV1::ListConstraint::Representation property :name, as: 'name' property :version, as: 'version' end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class FolderOperation # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination_parent, as: 'destinationParent' property :display_name, as: 'displayName' property :operation_type, as: 'operationType' property :source_parent, as: 'sourceParent' end end class FolderOperationError # @private class Representation < Google::Apis::Core::JsonRepresentation property :error_message_id, as: 'errorMessageId' end end class GetAncestryRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GetAncestryResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :ancestor, as: 'ancestor', class: Google::Apis::CloudresourcemanagerV1::Ancestor, decorator: Google::Apis::CloudresourcemanagerV1::Ancestor::Representation end end class GetEffectiveOrgPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :constraint, as: 'constraint' end end class GetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GetOrgPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :constraint, as: 'constraint' end end class Lien # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :name, as: 'name' property :origin, as: 'origin' property :parent, as: 'parent' property :reason, as: 'reason' collection :restrictions, as: 'restrictions' end end class ListAvailableOrgPolicyConstraintsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' end end class ListAvailableOrgPolicyConstraintsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :constraints, as: 'constraints', class: Google::Apis::CloudresourcemanagerV1::Constraint, decorator: Google::Apis::CloudresourcemanagerV1::Constraint::Representation property :next_page_token, as: 'nextPageToken' end end class ListConstraint # @private class Representation < Google::Apis::Core::JsonRepresentation property :suggested_value, as: 'suggestedValue' end end class ListLiensResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :liens, as: 'liens', class: Google::Apis::CloudresourcemanagerV1::Lien, decorator: Google::Apis::CloudresourcemanagerV1::Lien::Representation property :next_page_token, as: 'nextPageToken' end end class ListOrgPoliciesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' end end class ListOrgPoliciesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :policies, as: 'policies', class: Google::Apis::CloudresourcemanagerV1::OrgPolicy, decorator: Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation end end class ListPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :all_values, as: 'allValues' collection :allowed_values, as: 'allowedValues' collection :denied_values, as: 'deniedValues' property :inherit_from_parent, as: 'inheritFromParent' property :suggested_value, as: 'suggestedValue' end end class ListProjectsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :projects, as: 'projects', class: Google::Apis::CloudresourcemanagerV1::Project, decorator: Google::Apis::CloudresourcemanagerV1::Project::Representation end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::CloudresourcemanagerV1::Status, decorator: Google::Apis::CloudresourcemanagerV1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class OrgPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :boolean_policy, as: 'booleanPolicy', class: Google::Apis::CloudresourcemanagerV1::BooleanPolicy, decorator: Google::Apis::CloudresourcemanagerV1::BooleanPolicy::Representation property :constraint, as: 'constraint' property :etag, :base64 => true, as: 'etag' property :list_policy, as: 'listPolicy', class: Google::Apis::CloudresourcemanagerV1::ListPolicy, decorator: Google::Apis::CloudresourcemanagerV1::ListPolicy::Representation property :restore_default, as: 'restoreDefault', class: Google::Apis::CloudresourcemanagerV1::RestoreDefault, decorator: Google::Apis::CloudresourcemanagerV1::RestoreDefault::Representation property :update_time, as: 'updateTime' property :version, as: 'version' end end class Organization # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_time, as: 'creationTime' property :display_name, as: 'displayName' property :lifecycle_state, as: 'lifecycleState' property :name, as: 'name' property :owner, as: 'owner', class: Google::Apis::CloudresourcemanagerV1::OrganizationOwner, decorator: Google::Apis::CloudresourcemanagerV1::OrganizationOwner::Representation end end class OrganizationOwner # @private class Representation < Google::Apis::Core::JsonRepresentation property :directory_customer_id, as: 'directoryCustomerId' end end class Policy # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audit_configs, as: 'auditConfigs', class: Google::Apis::CloudresourcemanagerV1::AuditConfig, decorator: Google::Apis::CloudresourcemanagerV1::AuditConfig::Representation collection :bindings, as: 'bindings', class: Google::Apis::CloudresourcemanagerV1::Binding, decorator: Google::Apis::CloudresourcemanagerV1::Binding::Representation property :etag, :base64 => true, as: 'etag' property :version, as: 'version' end end class Project # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' hash :labels, as: 'labels' property :lifecycle_state, as: 'lifecycleState' property :name, as: 'name' property :parent, as: 'parent', class: Google::Apis::CloudresourcemanagerV1::ResourceId, decorator: Google::Apis::CloudresourcemanagerV1::ResourceId::Representation property :project_id, as: 'projectId' property :project_number, :numeric_string => true, as: 'projectNumber' end end class ProjectCreationStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :gettable, as: 'gettable' property :ready, as: 'ready' end end class ResourceId # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :type, as: 'type' end end class RestoreDefault # @private class Representation < Google::Apis::Core::JsonRepresentation end end class SearchOrganizationsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :filter, as: 'filter' property :page_size, as: 'pageSize' property :page_token, as: 'pageToken' end end class SearchOrganizationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :organizations, as: 'organizations', class: Google::Apis::CloudresourcemanagerV1::Organization, decorator: Google::Apis::CloudresourcemanagerV1::Organization::Representation end end class SetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :policy, as: 'policy', class: Google::Apis::CloudresourcemanagerV1::Policy, decorator: Google::Apis::CloudresourcemanagerV1::Policy::Representation property :update_mask, as: 'updateMask' end end class SetOrgPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :policy, as: 'policy', class: Google::Apis::CloudresourcemanagerV1::OrgPolicy, decorator: Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation 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 TestIamPermissionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class TestIamPermissionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :permissions, as: 'permissions' end end class UndeleteProjectRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end end end end google-api-client-0.19.8/generated/google/apis/cloudresourcemanager_v1/classes.rb0000644000004100000410000021577413252673043030134 0ustar www-datawww-data# 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 CloudresourcemanagerV1 # Identifying information for a single ancestor of a project. class Ancestor include Google::Apis::Core::Hashable # A container to reference an id for any resource type. A `resource` in Google # Cloud Platform is a generic term for something you (a developer) may want to # interact with through one of our API's. Some examples are an App Engine app, # a Compute Engine instance, a Cloud SQL database, and so on. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::CloudresourcemanagerV1::ResourceId] attr_accessor :resource_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource_id = args[:resource_id] if args.key?(:resource_id) 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:foo@gmail.com" # ] # `, # ` # "log_type": "DATA_WRITE", # `, # ` # "log_type": "ADMIN_READ", # ` # ] # `, # ` # "service": "fooservice.googleapis.com" # "audit_log_configs": [ # ` # "log_type": "DATA_READ", # `, # ` # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:bar@gmail.com" # ] # ` # ] # ` # ] # ` # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and # bar@gmail.com from DATA_WRITE logging. class AuditConfig include Google::Apis::Core::Hashable # The configuration for logging of each type of permission. # Next ID: 4 # 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:foo@gmail.com" # ] # `, # ` # "log_type": "DATA_WRITE", # ` # ] # ` # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # foo@gmail.com from DATA_READ logging. class AuditLogConfig include Google::Apis::Core::Hashable # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. # Corresponds to the JSON property `exemptedMembers` # @return [Array] 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 Binding include Google::Apis::Core::Hashable # 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@gmail.com` or `joe@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`. # * `domain:`domain``: A Google Apps domain name 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`. # Required # 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) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end # A `Constraint` that is either enforced or not. # For example a constraint `constraints/compute.disableSerialPortAccess`. # If it is enforced on a VM instance, serial port connections will not be # opened to that instance. class BooleanConstraint include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Used in `policy_type` to specify how `boolean_policy` will behave at this # resource. class BooleanPolicy include Google::Apis::Core::Hashable # If `true`, then the `Policy` is enforced. If `false`, then any # configuration is acceptable. # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess` # with `constraint_default` set to `ALLOW`. A `Policy` for that # `Constraint` exhibits the following behavior: # - If the `Policy` at this resource has enforced set to `false`, serial # port connection attempts will be allowed. # - If the `Policy` at this resource has enforced set to `true`, serial # port connection attempts will be refused. # - If the `Policy` at this resource is `RestoreDefault`, serial port # connection attempts will be allowed. # - If no `Policy` is set at this resource or anywhere higher in the # resource hierarchy, serial port connection attempts will be allowed. # - If no `Policy` is set at this resource, but one exists higher in the # resource hierarchy, the behavior is as if the`Policy` were set at # this resource. # The following examples demonstrate the different possible layerings: # Example 1 (nearest `Constraint` wins): # `organizations/foo` has a `Policy` with: # `enforced: false` # `projects/bar` has no `Policy` set. # The constraint at `projects/bar` and `organizations/foo` will not be # enforced. # Example 2 (enforcement gets replaced): # `organizations/foo` has a `Policy` with: # `enforced: false` # `projects/bar` has a `Policy` with: # `enforced: true` # The constraint at `organizations/foo` is not enforced. # The constraint at `projects/bar` is enforced. # Example 3 (RestoreDefault): # `organizations/foo` has a `Policy` with: # `enforced: true` # `projects/bar` has a `Policy` with: # `RestoreDefault: ``` # The constraint at `organizations/foo` is enforced. # The constraint at `projects/bar` is not enforced, because # `constraint_default` for the `Constraint` is `ALLOW`. # Corresponds to the JSON property `enforced` # @return [Boolean] attr_accessor :enforced alias_method :enforced?, :enforced def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enforced = args[:enforced] if args.key?(:enforced) end end # The request sent to the ClearOrgPolicy method. class ClearOrgPolicyRequest include Google::Apis::Core::Hashable # Name of the `Constraint` of the `Policy` to clear. # Corresponds to the JSON property `constraint` # @return [String] attr_accessor :constraint # The current version, for concurrency control. Not sending an `etag` # will cause the `Policy` to be cleared blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @constraint = args[:constraint] if args.key?(:constraint) @etag = args[:etag] if args.key?(:etag) end end # A `Constraint` describes a way in which a resource's configuration can be # restricted. For example, it controls which cloud services can be activated # across an organization, or whether a Compute Engine instance can have # serial port connections established. `Constraints` can be configured by the # organization's policy adminstrator to fit the needs of the organzation by # setting Policies for `Constraints` at different locations in the # organization's resource hierarchy. Policies are inherited down the resource # hierarchy from higher levels, but can also be overridden. For details about # the inheritance rules please read about # Policies. # `Constraints` have a default behavior determined by the `constraint_default` # field, which is the enforcement behavior that is used in the absence of a # `Policy` being defined or inherited for the resource in question. class Constraint include Google::Apis::Core::Hashable # A `Constraint` that is either enforced or not. # For example a constraint `constraints/compute.disableSerialPortAccess`. # If it is enforced on a VM instance, serial port connections will not be # opened to that instance. # Corresponds to the JSON property `booleanConstraint` # @return [Google::Apis::CloudresourcemanagerV1::BooleanConstraint] attr_accessor :boolean_constraint # The evaluation behavior of this constraint in the absense of 'Policy'. # Corresponds to the JSON property `constraintDefault` # @return [String] attr_accessor :constraint_default # Detailed description of what this `Constraint` controls as well as how and # where it is enforced. # Mutable. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The human readable name. # Mutable. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # A `Constraint` that allows or disallows a list of string values, which are # configured by an Organization's policy administrator with a `Policy`. # Corresponds to the JSON property `listConstraint` # @return [Google::Apis::CloudresourcemanagerV1::ListConstraint] attr_accessor :list_constraint # Immutable value, required to globally be unique. For example, # `constraints/serviceuser.services` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Version of the `Constraint`. Default version is 0; # 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) @boolean_constraint = args[:boolean_constraint] if args.key?(:boolean_constraint) @constraint_default = args[:constraint_default] if args.key?(:constraint_default) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @list_constraint = args[:list_constraint] if args.key?(:list_constraint) @name = args[:name] if args.key?(:name) @version = args[:version] if args.key?(:version) 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 # Metadata describing a long running folder operation class FolderOperation include Google::Apis::Core::Hashable # The resource name of the folder or organization we are either creating # the folder under or moving the folder to. # Corresponds to the JSON property `destinationParent` # @return [String] attr_accessor :destination_parent # The display name of the folder. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The type of this operation. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # The resource name of the folder's parent. # Only applicable when the operation_type is MOVE. # Corresponds to the JSON property `sourceParent` # @return [String] attr_accessor :source_parent def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @destination_parent = args[:destination_parent] if args.key?(:destination_parent) @display_name = args[:display_name] if args.key?(:display_name) @operation_type = args[:operation_type] if args.key?(:operation_type) @source_parent = args[:source_parent] if args.key?(:source_parent) end end # A classification of the Folder Operation error. class FolderOperationError include Google::Apis::Core::Hashable # The type of operation error experienced. # Corresponds to the JSON property `errorMessageId` # @return [String] attr_accessor :error_message_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_message_id = args[:error_message_id] if args.key?(:error_message_id) end end # The request sent to the # GetAncestry # method. class GetAncestryRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Response from the GetAncestry method. class GetAncestryResponse include Google::Apis::Core::Hashable # Ancestors are ordered from bottom to top of the resource hierarchy. The # first ancestor is the project itself, followed by the project's parent, # etc. # Corresponds to the JSON property `ancestor` # @return [Array] attr_accessor :ancestor def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ancestor = args[:ancestor] if args.key?(:ancestor) end end # The request sent to the GetEffectiveOrgPolicy method. class GetEffectiveOrgPolicyRequest include Google::Apis::Core::Hashable # The name of the `Constraint` to compute the effective `Policy`. # Corresponds to the JSON property `constraint` # @return [String] attr_accessor :constraint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @constraint = args[:constraint] if args.key?(:constraint) end end # Request message for `GetIamPolicy` method. class GetIamPolicyRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The request sent to the GetOrgPolicy method. class GetOrgPolicyRequest include Google::Apis::Core::Hashable # Name of the `Constraint` to get the `Policy`. # Corresponds to the JSON property `constraint` # @return [String] attr_accessor :constraint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @constraint = args[:constraint] if args.key?(:constraint) end end # A Lien represents an encumbrance on the actions that can be performed on a # resource. class Lien include Google::Apis::Core::Hashable # The creation time of this Lien. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # A system-generated unique identifier for this Lien. # Example: `liens/1234abcd` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A stable, user-visible/meaningful string identifying the origin of the # Lien, intended to be inspected programmatically. Maximum length of 200 # characters. # Example: 'compute.googleapis.com' # Corresponds to the JSON property `origin` # @return [String] attr_accessor :origin # A reference to the resource this Lien is attached to. The server will # validate the parent against those for which Liens are supported. # Example: `projects/1234` # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent # Concise user-visible strings indicating why an action cannot be performed # on a resource. Maximum lenth of 200 characters. # Example: 'Holds production API key' # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The types of operations which should be blocked as a result of this Lien. # Each value should correspond to an IAM permission. The server will # validate the permissions against those for which Liens are supported. # An empty list is meaningless and will be rejected. # Example: ['resourcemanager.projects.delete'] # Corresponds to the JSON property `restrictions` # @return [Array] attr_accessor :restrictions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @name = args[:name] if args.key?(:name) @origin = args[:origin] if args.key?(:origin) @parent = args[:parent] if args.key?(:parent) @reason = args[:reason] if args.key?(:reason) @restrictions = args[:restrictions] if args.key?(:restrictions) end end # The request sent to the [ListAvailableOrgPolicyConstraints] # google.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method. class ListAvailableOrgPolicyConstraintsRequest include Google::Apis::Core::Hashable # Size of the pages to be returned. This is currently unsupported and will # be ignored. The server may at any point start using this field to limit # page size. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # Page token used to retrieve the next page. This is currently unsupported # and will be ignored. The server may at any point start using this field. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) end end # The response returned from the ListAvailableOrgPolicyConstraints method. # Returns all `Constraints` that could be set at this level of the hierarchy # (contrast with the response from `ListPolicies`, which returns all policies # which are set). class ListAvailableOrgPolicyConstraintsResponse include Google::Apis::Core::Hashable # The collection of constraints that are settable on the request resource. # Corresponds to the JSON property `constraints` # @return [Array] attr_accessor :constraints # Page token used to retrieve the next page. This is currently not used. # 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) @constraints = args[:constraints] if args.key?(:constraints) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # A `Constraint` that allows or disallows a list of string values, which are # configured by an Organization's policy administrator with a `Policy`. class ListConstraint include Google::Apis::Core::Hashable # Optional. The Google Cloud Console will try to default to a configuration # that matches the value specified in this `Constraint`. # Corresponds to the JSON property `suggestedValue` # @return [String] attr_accessor :suggested_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @suggested_value = args[:suggested_value] if args.key?(:suggested_value) end end # The response message for Liens.ListLiens. class ListLiensResponse include Google::Apis::Core::Hashable # A list of Liens. # Corresponds to the JSON property `liens` # @return [Array] attr_accessor :liens # 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) @liens = args[:liens] if args.key?(:liens) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The request sent to the ListOrgPolicies method. class ListOrgPoliciesRequest include Google::Apis::Core::Hashable # Size of the pages to be returned. This is currently unsupported and will # be ignored. The server may at any point start using this field to limit # page size. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # Page token used to retrieve the next page. This is currently unsupported # and will be ignored. The server may at any point start using this field. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) end end # The response returned from the ListOrgPolicies method. It will be empty # if no `Policies` are set on the resource. class ListOrgPoliciesResponse include Google::Apis::Core::Hashable # Page token used to retrieve the next page. This is currently not used, but # the server may at any point start supplying a valid token. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The `Policies` that are set on the resource. It will be empty if no # `Policies` are set. # Corresponds to the JSON property `policies` # @return [Array] attr_accessor :policies 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) @policies = args[:policies] if args.key?(:policies) end end # Used in `policy_type` to specify how `list_policy` behaves at this # resource. # A `ListPolicy` can define specific values that are allowed or denied by # setting either the `allowed_values` or `denied_values` fields. It can also # be used to allow or deny all values, by setting the `all_values` field. If # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values` # or `denied_values` must be set (attempting to set both or neither will # result in a failed request). If `all_values` is set to either `ALLOW` or # `DENY`, `allowed_values` and `denied_values` must be unset. class ListPolicy include Google::Apis::Core::Hashable # The policy all_values state. # Corresponds to the JSON property `allValues` # @return [String] attr_accessor :all_values # List of values allowed at this resource. Can only be set if no values # are set for `denied_values` and `all_values` is set to # `ALL_VALUES_UNSPECIFIED`. # Corresponds to the JSON property `allowedValues` # @return [Array] attr_accessor :allowed_values # List of values denied at this resource. Can only be set if no values are # set for `allowed_values` and `all_values` is set to # `ALL_VALUES_UNSPECIFIED`. # Corresponds to the JSON property `deniedValues` # @return [Array] attr_accessor :denied_values # Determines the inheritance behavior for this `Policy`. # By default, a `ListPolicy` set at a resource supercedes any `Policy` set # anywhere up the resource hierarchy. However, if `inherit_from_parent` is # set to `true`, then the values from the effective `Policy` of the parent # resource are inherited, meaning the values set in this `Policy` are # added to the values inherited up the hierarchy. # Setting `Policy` hierarchies that inherit both allowed values and denied # values isn't recommended in most circumstances to keep the configuration # simple and understandable. However, it is possible to set a `Policy` with # `allowed_values` set that inherits a `Policy` with `denied_values` set. # In this case, the values that are allowed must be in `allowed_values` and # not present in `denied_values`. # For example, suppose you have a `Constraint` # `constraints/serviceuser.services`, which has a `constraint_type` of # `list_constraint`, and with `constraint_default` set to `ALLOW`. # Suppose that at the Organization level, a `Policy` is applied that # restricts the allowed API activations to ``E1`, `E2``. Then, if a # `Policy` is applied to a project below the Organization that has # `inherit_from_parent` set to `false` and field all_values set to DENY, # then an attempt to activate any API will be denied. # The following examples demonstrate different possible layerings: # Example 1 (no inherited values): # `organizations/foo` has a `Policy` with values: # `allowed_values: “E1” allowed_values:”E2”` # ``projects/bar`` has `inherit_from_parent` `false` and values: # `allowed_values: "E3" allowed_values: "E4"` # The accepted values at `organizations/foo` are `E1`, `E2`. # The accepted values at `projects/bar` are `E3`, and `E4`. # Example 2 (inherited values): # `organizations/foo` has a `Policy` with values: # `allowed_values: “E1” allowed_values:”E2”` # `projects/bar` has a `Policy` with values: # `value: “E3” value: ”E4” inherit_from_parent: true` # The accepted values at `organizations/foo` are `E1`, `E2`. # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. # Example 3 (inheriting both allowed and denied values): # `organizations/foo` has a `Policy` with values: # `allowed_values: "E1" allowed_values: "E2"` # `projects/bar` has a `Policy` with: # `denied_values: "E1"` # The accepted values at `organizations/foo` are `E1`, `E2`. # The value accepted at `projects/bar` is `E2`. # Example 4 (RestoreDefault): # `organizations/foo` has a `Policy` with values: # `allowed_values: “E1” allowed_values:”E2”` # `projects/bar` has a `Policy` with values: # `RestoreDefault: ``` # The accepted values at `organizations/foo` are `E1`, `E2`. # The accepted values at `projects/bar` are either all or none depending on # the value of `constraint_default` (if `ALLOW`, all; if # `DENY`, none). # Example 5 (no policy inherits parent policy): # `organizations/foo` has no `Policy` set. # `projects/bar` has no `Policy` set. # The accepted values at both levels are either all or none depending on # the value of `constraint_default` (if `ALLOW`, all; if # `DENY`, none). # Example 6 (ListConstraint allowing all): # `organizations/foo` has a `Policy` with values: # `allowed_values: “E1” allowed_values: ”E2”` # `projects/bar` has a `Policy` with: # `all: ALLOW` # The accepted values at `organizations/foo` are `E1`, E2`. # Any value is accepted at `projects/bar`. # Example 7 (ListConstraint allowing none): # `organizations/foo` has a `Policy` with values: # `allowed_values: “E1” allowed_values: ”E2”` # `projects/bar` has a `Policy` with: # `all: DENY` # The accepted values at `organizations/foo` are `E1`, E2`. # No value is accepted at `projects/bar`. # Corresponds to the JSON property `inheritFromParent` # @return [Boolean] attr_accessor :inherit_from_parent alias_method :inherit_from_parent?, :inherit_from_parent # Optional. The Google Cloud Console will try to default to a configuration # that matches the value specified in this `Policy`. If `suggested_value` # is not set, it will inherit the value specified higher in the hierarchy, # unless `inherit_from_parent` is `false`. # Corresponds to the JSON property `suggestedValue` # @return [String] attr_accessor :suggested_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @all_values = args[:all_values] if args.key?(:all_values) @allowed_values = args[:allowed_values] if args.key?(:allowed_values) @denied_values = args[:denied_values] if args.key?(:denied_values) @inherit_from_parent = args[:inherit_from_parent] if args.key?(:inherit_from_parent) @suggested_value = args[:suggested_value] if args.key?(:suggested_value) end end # A page of the response received from the # ListProjects # method. # A paginated response where more pages are available has # `next_page_token` set. This token can be used in a subsequent request to # retrieve the next request page. class ListProjectsResponse include Google::Apis::Core::Hashable # Pagination token. # If the result set is too large to fit in a single response, this token # is returned. It encodes the position of the current result cursor. # Feeding this value into a new list request with the `page_token` parameter # gives the next page of the results. # When `next_page_token` is not filled in, there is no next page and # the list returned is the last page in the result set. # Pagination tokens have a limited lifetime. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of Projects that matched the list filter. This list can # be paginated. # Corresponds to the JSON property `projects` # @return [Array] attr_accessor :projects 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) @projects = args[:projects] if args.key?(:projects) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::CloudresourcemanagerV1::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 have the format of `operations/some/unique/name`. # 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 # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # for configurations of Cloud Platform resources. class OrgPolicy include Google::Apis::Core::Hashable # Used in `policy_type` to specify how `boolean_policy` will behave at this # resource. # Corresponds to the JSON property `booleanPolicy` # @return [Google::Apis::CloudresourcemanagerV1::BooleanPolicy] attr_accessor :boolean_policy # The name of the `Constraint` the `Policy` is configuring, for example, # `constraints/serviceuser.services`. # Immutable after creation. # Corresponds to the JSON property `constraint` # @return [String] attr_accessor :constraint # An opaque tag indicating the current version of the `Policy`, used for # concurrency control. # When the `Policy` is returned from either a `GetPolicy` or a # `ListOrgPolicy` request, this `etag` indicates the version of the current # `Policy` to use when executing a read-modify-write loop. # When the `Policy` is returned from a `GetEffectivePolicy` request, the # `etag` will be unset. # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value # that was returned from a `GetOrgPolicy` request as part of a # read-modify-write loop for concurrency control. Not setting the `etag`in a # `SetOrgPolicy` request will result in an unconditional write of the # `Policy`. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # Used in `policy_type` to specify how `list_policy` behaves at this # resource. # A `ListPolicy` can define specific values that are allowed or denied by # setting either the `allowed_values` or `denied_values` fields. It can also # be used to allow or deny all values, by setting the `all_values` field. If # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values` # or `denied_values` must be set (attempting to set both or neither will # result in a failed request). If `all_values` is set to either `ALLOW` or # `DENY`, `allowed_values` and `denied_values` must be unset. # Corresponds to the JSON property `listPolicy` # @return [Google::Apis::CloudresourcemanagerV1::ListPolicy] attr_accessor :list_policy # Ignores policies set above this resource and restores the # `constraint_default` enforcement behavior of the specific `Constraint` at # this resource. # Suppose that `constraint_default` is set to `ALLOW` for the # `Constraint` `constraints/serviceuser.services`. Suppose that organization # foo.com sets a `Policy` at their Organization resource node that restricts # the allowed service activations to deny all service activations. They # could then set a `Policy` with the `policy_type` `restore_default` on # several experimental projects, restoring the `constraint_default` # enforcement of the `Constraint` for only those projects, allowing those # projects to have all services activated. # Corresponds to the JSON property `restoreDefault` # @return [Google::Apis::CloudresourcemanagerV1::RestoreDefault] attr_accessor :restore_default # The time stamp the `Policy` was previously updated. This is set by the # server, not specified by the caller, and represents the last time a call to # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will # be ignored. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Version of the `Policy`. Default version is 0; # 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) @boolean_policy = args[:boolean_policy] if args.key?(:boolean_policy) @constraint = args[:constraint] if args.key?(:constraint) @etag = args[:etag] if args.key?(:etag) @list_policy = args[:list_policy] if args.key?(:list_policy) @restore_default = args[:restore_default] if args.key?(:restore_default) @update_time = args[:update_time] if args.key?(:update_time) @version = args[:version] if args.key?(:version) end end # The root node in the resource hierarchy to which a particular entity's # (e.g., company) resources belong. class Organization include Google::Apis::Core::Hashable # Timestamp when the Organization was created. Assigned by the server. # @OutputOnly # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time # A human-readable string that refers to the Organization in the # GCP Console UI. This string is set by the server and cannot be # changed. The string will be set to the primary domain (for example, # "google.com") of the G Suite customer that owns the organization. # @OutputOnly # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The organization's current lifecycle state. Assigned by the server. # @OutputOnly # Corresponds to the JSON property `lifecycleState` # @return [String] attr_accessor :lifecycle_state # Output Only. The resource name of the organization. This is the # organization's relative path in the API. Its format is # "organizations/[organization_id]". For example, "organizations/1234". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The entity that owns an Organization. The lifetime of the Organization and # all of its descendants are bound to the `OrganizationOwner`. If the # `OrganizationOwner` is deleted, the Organization and all its descendants will # be deleted. # Corresponds to the JSON property `owner` # @return [Google::Apis::CloudresourcemanagerV1::OrganizationOwner] attr_accessor :owner def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_time = args[:creation_time] if args.key?(:creation_time) @display_name = args[:display_name] if args.key?(:display_name) @lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state) @name = args[:name] if args.key?(:name) @owner = args[:owner] if args.key?(:owner) end end # The entity that owns an Organization. The lifetime of the Organization and # all of its descendants are bound to the `OrganizationOwner`. If the # `OrganizationOwner` is deleted, the Organization and all its descendants will # be deleted. class OrganizationOwner include Google::Apis::Core::Hashable # The Google for Work customer id used in the Directory API. # Corresponds to the JSON property `directoryCustomerId` # @return [String] attr_accessor :directory_customer_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @directory_customer_id = args[:directory_customer_id] if args.key?(:directory_customer_id) end end # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). class Policy include Google::Apis::Core::Hashable # Specifies cloud audit logging configuration for this policy. # Corresponds to the JSON property `auditConfigs` # @return [Array] attr_accessor :audit_configs # Associates a list of `members` to a `role`. # `bindings` with no members will result in an error. # 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. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag # Deprecated. # 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 # A Project is a high-level Google Cloud Platform entity. It is a # container for ACLs, APIs, App Engine Apps, VMs, and other # Google Cloud Platform resources. class Project include Google::Apis::Core::Hashable # Creation time. # Read-only. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The labels associated with this Project. # Label keys must be between 1 and 63 characters long and must conform # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. # Label values must be between 0 and 63 characters long and must conform # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. # No more than 256 labels can be associated with a given resource. # Clients should store labels in a representation such as JSON that does not # depend on specific characters being disallowed. # Example: "environment" : "dev" # Read-write. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The Project lifecycle state. # Read-only. # Corresponds to the JSON property `lifecycleState` # @return [String] attr_accessor :lifecycle_state # The user-assigned display name of the Project. # It must be 4 to 30 characters. # Allowed characters are: lowercase and uppercase letters, numbers, # hyphen, single-quote, double-quote, space, and exclamation point. # Example: My Project # Read-write. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A container to reference an id for any resource type. A `resource` in Google # Cloud Platform is a generic term for something you (a developer) may want to # interact with through one of our API's. Some examples are an App Engine app, # a Compute Engine instance, a Cloud SQL database, and so on. # Corresponds to the JSON property `parent` # @return [Google::Apis::CloudresourcemanagerV1::ResourceId] attr_accessor :parent # The unique, user-assigned ID of the Project. # It must be 6 to 30 lowercase letters, digits, or hyphens. # It must start with a letter. # Trailing hyphens are prohibited. # Example: tokyo-rain-123 # Read-only after creation. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The number uniquely identifying the project. # Example: 415104041262 # Read-only. # Corresponds to the JSON property `projectNumber` # @return [Fixnum] attr_accessor :project_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @labels = args[:labels] if args.key?(:labels) @lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state) @name = args[:name] if args.key?(:name) @parent = args[:parent] if args.key?(:parent) @project_id = args[:project_id] if args.key?(:project_id) @project_number = args[:project_number] if args.key?(:project_number) end end # A status object which is used as the `metadata` field for the Operation # returned by CreateProject. It provides insight for when significant phases of # Project creation have completed. class ProjectCreationStatus include Google::Apis::Core::Hashable # Creation time of the project creation workflow. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # True if the project can be retrieved using GetProject. No other operations # on the project are guaranteed to work until the project creation is # complete. # Corresponds to the JSON property `gettable` # @return [Boolean] attr_accessor :gettable alias_method :gettable?, :gettable # True if the project creation process is complete. # Corresponds to the JSON property `ready` # @return [Boolean] attr_accessor :ready alias_method :ready?, :ready def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @gettable = args[:gettable] if args.key?(:gettable) @ready = args[:ready] if args.key?(:ready) end end # A container to reference an id for any resource type. A `resource` in Google # Cloud Platform is a generic term for something you (a developer) may want to # interact with through one of our API's. Some examples are an App Engine app, # a Compute Engine instance, a Cloud SQL database, and so on. class ResourceId include Google::Apis::Core::Hashable # Required field for the type-specific id. This should correspond to the id # used in the type-specific API's. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Required field representing the resource type this id is for. # At present, the valid types are: "organization" # 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) @id = args[:id] if args.key?(:id) @type = args[:type] if args.key?(:type) end end # Ignores policies set above this resource and restores the # `constraint_default` enforcement behavior of the specific `Constraint` at # this resource. # Suppose that `constraint_default` is set to `ALLOW` for the # `Constraint` `constraints/serviceuser.services`. Suppose that organization # foo.com sets a `Policy` at their Organization resource node that restricts # the allowed service activations to deny all service activations. They # could then set a `Policy` with the `policy_type` `restore_default` on # several experimental projects, restoring the `constraint_default` # enforcement of the `Constraint` for only those projects, allowing those # projects to have all services activated. class RestoreDefault include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The request sent to the `SearchOrganizations` method. class SearchOrganizationsRequest include Google::Apis::Core::Hashable # An optional query string used to filter the Organizations to return in # the response. Filter rules are case-insensitive. # Organizations may be filtered by `owner.directoryCustomerId` or by # `domain`, where the domain is a Google for Work domain, for example: # |Filter|Description| # |------|-----------| # |owner.directorycustomerid:123456789|Organizations with # `owner.directory_customer_id` equal to `123456789`.| # |domain:google.com|Organizations corresponding to the domain `google.com`.| # This field is optional. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # The maximum number of Organizations to return in the response. # This field is optional. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # A pagination token returned from a previous call to `SearchOrganizations` # that indicates from where listing should continue. # This field is optional. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filter = args[:filter] if args.key?(:filter) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) end end # The response returned from the `SearchOrganizations` method. class SearchOrganizationsResponse include Google::Apis::Core::Hashable # A pagination token to be used to retrieve the next page of results. If the # result is too large to fit within the page size specified in the request, # this field will be set with a token that can be used to fetch the next page # of results. If this field is empty, it indicates that this response # contains the last page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of Organizations that matched the search query, possibly # paginated. # 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) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @organizations = args[:organizations] if args.key?(:organizations) end end # Request message for `SetIamPolicy` method. class SetIamPolicyRequest include Google::Apis::Core::Hashable # Defines an Identity and Access Management (IAM) policy. It is used to # specify access control policies for Cloud Platform resources. # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # **Example** # ` # "bindings": [ # ` # "role": "roles/owner", # "members": [ # "user:mike@example.com", # "group:admins@example.com", # "domain:google.com", # "serviceAccount:my-other-app@appspot.gserviceaccount.com", # ] # `, # ` # "role": "roles/viewer", # "members": ["user:sean@example.com"] # ` # ] # ` # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam/docs). # Corresponds to the JSON property `policy` # @return [Google::Apis::CloudresourcemanagerV1::Policy] attr_accessor :policy # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: # paths: "bindings, etag" # This field is only used by Cloud IAM. # 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 # The request sent to the SetOrgPolicyRequest method. class SetOrgPolicyRequest include Google::Apis::Core::Hashable # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # for configurations of Cloud Platform resources. # Corresponds to the JSON property `policy` # @return [Google::Apis::CloudresourcemanagerV1::OrgPolicy] attr_accessor :policy def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @policy = args[:policy] if args.key?(:policy) 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 # Request message for `TestIamPermissions` method. class TestIamPermissionsRequest include Google::Apis::Core::Hashable # The set of permissions to check for the `resource`. Permissions with # wildcards (such as '*' or 'storage.*') are not allowed. For more # information see # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @permissions = args[:permissions] if args.key?(:permissions) end end # Response message for `TestIamPermissions` method. class TestIamPermissionsResponse include Google::Apis::Core::Hashable # A subset of `TestPermissionsRequest.permissions` that the caller is # allowed. # Corresponds to the JSON property `permissions` # @return [Array] 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 request sent to the UndeleteProject # method. class UndeleteProjectRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end end end end google-api-client-0.19.8/generated/google/apis/cloudresourcemanager_v1/service.rb0000644000004100000410000027013313252673043030125 0ustar www-datawww-data# 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 CloudresourcemanagerV1 # Google Cloud Resource Manager API # # The Google Cloud Resource Manager API provides methods for creating, reading, # and updating project metadata. # # @example # require 'google/apis/cloudresourcemanager_v1' # # Cloudresourcemanager = Google::Apis::CloudresourcemanagerV1 # Alias the module # service = Cloudresourcemanager::CloudResourceManagerService.new # # @see https://cloud.google.com/resource-manager class CloudResourceManagerService < 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://cloudresourcemanager.googleapis.com/', '') @batch_path = 'batch' end # Clears a `Policy` from a resource. # @param [String] resource # Name of the resource for the `Policy` to clear. # @param [Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest] clear_org_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::CloudresourcemanagerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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 clear_folder_org_policy(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:clearOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest::Representation command.request_object = clear_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Empty 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 # Gets the effective `Policy` on a resource. This is the result of merging # `Policies` in the resource hierarchy. The returned `Policy` will not have # an `etag`set because it is a computed `Policy` across multiple resources. # @param [String] resource # The name of the resource to start computing the effective `Policy`. # @param [Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest] get_effective_org_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::CloudresourcemanagerV1::OrgPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::OrgPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_folder_effective_org_policy(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getEffectiveOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest::Representation command.request_object = get_effective_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy 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 # Gets a `Policy` on a resource. # If no `Policy` is set on the resource, a `Policy` is returned with default # values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The # `etag` value can be used with `SetOrgPolicy()` to create or update a # `Policy` during read-modify-write. # @param [String] resource # Name of the resource the `Policy` is set on. # @param [Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest] get_org_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::CloudresourcemanagerV1::OrgPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::OrgPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_folder_org_policy(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest::Representation command.request_object = get_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy 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 # Lists `Constraints` that could be applied on the specified resource. # @param [String] resource # Name of the resource to list `Constraints` for. # @param [Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest] list_available_org_policy_constraints_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::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_folder_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:listAvailableOrgPolicyConstraints', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest::Representation command.request_object = list_available_org_policy_constraints_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse 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 # Lists all the `Policies` set for a particular resource. # @param [String] resource # Name of the resource to list Policies for. # @param [Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest] list_org_policies_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::CloudresourcemanagerV1::ListOrgPoliciesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_folder_org_policies(resource, list_org_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:listOrgPolicies', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest::Representation command.request_object = list_org_policies_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse 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 # Updates the specified `Policy` on the resource. Creates a new `Policy` for # that `Constraint` on the resource if one does not exist. # Not supplying an `etag` on the request `Policy` results in an unconditional # write of the `Policy`. # @param [String] resource # Resource name of the resource to attach the `Policy`. # @param [Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest] set_org_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::CloudresourcemanagerV1::OrgPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::OrgPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_folder_org_policy(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest::Representation command.request_object = set_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy 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 # Create a Lien which applies to the resource denoted by the `parent` field. # Callers of this method will require permission on the `parent` resource. # For example, applying to `projects/1234` requires permission # `resourcemanager.projects.updateLiens`. # NOTE: Some resources may limit the number of Liens which may be applied. # @param [Google::Apis::CloudresourcemanagerV1::Lien] lien_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::CloudresourcemanagerV1::Lien] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::Lien] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_lien(lien_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/liens', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::Lien::Representation command.request_object = lien_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Lien::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Lien 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 Lien by `name`. # Callers of this method will require permission on the `parent` resource. # For example, a Lien with a `parent` of `projects/1234` requires permission # `resourcemanager.projects.updateLiens`. # @param [String] name # The name/identifier of the Lien 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::CloudresourcemanagerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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_lien(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::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 # List all Liens applied to the `parent` resource. # Callers of this method will require permission on the `parent` resource. # For example, a Lien with a `parent` of `projects/1234` requires permission # `resourcemanager.projects.get`. # @param [Fixnum] page_size # The maximum number of items to return. This is a suggestion for the server. # @param [String] page_token # The `next_page_token` value returned from a previous List request, if any. # @param [String] parent # The name of the resource to list all attached Liens. # For example, `projects/1234`. # @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::CloudresourcemanagerV1::ListLiensResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::ListLiensResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_liens(page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/liens', options) command.response_representation = Google::Apis::CloudresourcemanagerV1::ListLiensResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::ListLiensResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? 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 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::CloudresourcemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudresourcemanagerV1::Operation::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::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 # Clears a `Policy` from a resource. # @param [String] resource # Name of the resource for the `Policy` to clear. # @param [Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest] clear_org_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::CloudresourcemanagerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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 clear_organization_org_policy(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:clearOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest::Representation command.request_object = clear_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Empty 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 # Fetches an Organization resource identified by the specified resource name. # @param [String] name # The resource name of the Organization to fetch, e.g. "organizations/1234". # @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::CloudresourcemanagerV1::Organization] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::Organization] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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::CloudresourcemanagerV1::Organization::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Organization 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 effective `Policy` on a resource. This is the result of merging # `Policies` in the resource hierarchy. The returned `Policy` will not have # an `etag`set because it is a computed `Policy` across multiple resources. # @param [String] resource # The name of the resource to start computing the effective `Policy`. # @param [Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest] get_effective_org_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::CloudresourcemanagerV1::OrgPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::OrgPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_effective_org_policy(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getEffectiveOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest::Representation command.request_object = get_effective_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy 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 # Gets the access control policy for an Organization resource. May be empty # if no such policy or resource exists. The `resource` field should be the # organization's resource name, e.g. "organizations/123". # Authorization requires the Google IAM permission # `resourcemanager.organizations.getIamPolicy` on the specified organization # @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 [Google::Apis::CloudresourcemanagerV1::GetIamPolicyRequest] get_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::CloudresourcemanagerV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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_organization_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Policy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Policy 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 # Gets a `Policy` on a resource. # If no `Policy` is set on the resource, a `Policy` is returned with default # values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The # `etag` value can be used with `SetOrgPolicy()` to create or update a # `Policy` during read-modify-write. # @param [String] resource # Name of the resource the `Policy` is set on. # @param [Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest] get_org_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::CloudresourcemanagerV1::OrgPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::OrgPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_org_policy(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest::Representation command.request_object = get_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy 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 # Lists `Constraints` that could be applied on the specified resource. # @param [String] resource # Name of the resource to list `Constraints` for. # @param [Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest] list_available_org_policy_constraints_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::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:listAvailableOrgPolicyConstraints', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest::Representation command.request_object = list_available_org_policy_constraints_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse 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 # Lists all the `Policies` set for a particular resource. # @param [String] resource # Name of the resource to list Policies for. # @param [Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest] list_org_policies_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::CloudresourcemanagerV1::ListOrgPoliciesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_org_policies(resource, list_org_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:listOrgPolicies', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest::Representation command.request_object = list_org_policies_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse 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 # Searches Organization resources that are visible to the user and satisfy # the specified filter. This method returns Organizations in an unspecified # order. New Organizations do not necessarily appear at the end of the # results. # Search will only return organizations on which the user has the permission # `resourcemanager.organizations.get` # @param [Google::Apis::CloudresourcemanagerV1::SearchOrganizationsRequest] search_organizations_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::CloudresourcemanagerV1::SearchOrganizationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::SearchOrganizationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def search_organizations(search_organizations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/organizations:search', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::SearchOrganizationsRequest::Representation command.request_object = search_organizations_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::SearchOrganizationsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::SearchOrganizationsResponse 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 access control policy on an Organization resource. Replaces any # existing policy. The `resource` field should be the organization's resource # name, e.g. "organizations/123". # Authorization requires the Google IAM permission # `resourcemanager.organizations.setIamPolicy` on the specified organization # @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::CloudresourcemanagerV1::SetIamPolicyRequest] 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::CloudresourcemanagerV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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_organization_iam_policy(resource, 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::CloudresourcemanagerV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Policy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Policy 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 # Updates the specified `Policy` on the resource. Creates a new `Policy` for # that `Constraint` on the resource if one does not exist. # Not supplying an `etag` on the request `Policy` results in an unconditional # write of the `Policy`. # @param [String] resource # Resource name of the resource to attach the `Policy`. # @param [Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest] set_org_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::CloudresourcemanagerV1::OrgPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::OrgPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_org_policy(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest::Representation command.request_object = set_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy 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 # Returns permissions that a caller has on the specified Organization. # The `resource` field should be the organization's resource name, # e.g. "organizations/123". # There are no permissions required for making this API call. # @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::CloudresourcemanagerV1::TestIamPermissionsRequest] 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::CloudresourcemanagerV1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_iam_permissions(resource, 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::CloudresourcemanagerV1::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse 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 # Clears a `Policy` from a resource. # @param [String] resource # Name of the resource for the `Policy` to clear. # @param [Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest] clear_org_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::CloudresourcemanagerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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 clear_project_org_policy(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:clearOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest::Representation command.request_object = clear_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Empty 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 # Request that a new Project be created. The result is an Operation which # can be used to track the creation process. It is automatically deleted # after a few hours, so there is no need to call DeleteOperation. # Our SLO permits Project creation to take up to 30 seconds at the 90th # percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile # latency. 95th percentile latency is around 11 seconds. We recommend # polling at the 5th second with an exponential backoff. # Authorization requires the Google IAM permission # `resourcemanager.projects.create` on the specified parent for the new # project. # @param [Google::Apis::CloudresourcemanagerV1::Project] project_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::CloudresourcemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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(project_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation command.request_object = project_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Operation::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Operation command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Marks the Project identified by the specified # `project_id` (for example, `my-project-123`) for deletion. # This method will only affect the Project if the following criteria are met: # + The Project does not have a billing account associated with it. # + The Project has a lifecycle state of # ACTIVE. # This method changes the Project's lifecycle state from # ACTIVE # to DELETE_REQUESTED. # The deletion starts at an unspecified time, # at which point the Project is no longer accessible. # Until the deletion completes, you can check the lifecycle state # checked by retrieving the Project with GetProject, # and the Project remains visible to ListProjects. # However, you cannot update the project. # After the deletion completes, the Project is not retrievable by # the GetProject and # ListProjects methods. # The caller must have modify permissions for this Project. # @param [String] project_id # The Project ID (for example, `foo-bar-123`). # 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::CloudresourcemanagerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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(project_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/projects/{projectId}', options) command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Empty 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 # Retrieves the Project identified by the specified # `project_id` (for example, `my-project-123`). # The caller must have read permissions for this Project. # @param [String] project_id # The Project ID (for example, `my-project-123`). # 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::CloudresourcemanagerV1::Project] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::Project] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(project_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{projectId}', options) command.response_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Project 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 # Gets a list of ancestors in the resource hierarchy for the Project # identified by the specified `project_id` (for example, `my-project-123`). # The caller must have read permissions for this Project. # @param [String] project_id # The Project ID (for example, `my-project-123`). # Required. # @param [Google::Apis::CloudresourcemanagerV1::GetAncestryRequest] get_ancestry_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::CloudresourcemanagerV1::GetAncestryResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::GetAncestryResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_ancestry(project_id, get_ancestry_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{projectId}:getAncestry', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::GetAncestryRequest::Representation command.request_object = get_ancestry_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::GetAncestryResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::GetAncestryResponse 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 # Gets the effective `Policy` on a resource. This is the result of merging # `Policies` in the resource hierarchy. The returned `Policy` will not have # an `etag`set because it is a computed `Policy` across multiple resources. # @param [String] resource # The name of the resource to start computing the effective `Policy`. # @param [Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest] get_effective_org_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::CloudresourcemanagerV1::OrgPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::OrgPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_effective_org_policy(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getEffectiveOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest::Representation command.request_object = get_effective_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy 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 # Returns the IAM access control policy for the specified Project. # Permission is denied if the policy or the resource does not exist. # Authorization requires the Google IAM permission # `resourcemanager.projects.getIamPolicy` on the project. # For additional information about resource structure and identification, # see [Resource Names](/apis/design/resource_names). # @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 [Google::Apis::CloudresourcemanagerV1::GetIamPolicyRequest] get_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::CloudresourcemanagerV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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_project_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{resource}:getIamPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Policy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Policy 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 # Gets a `Policy` on a resource. # If no `Policy` is set on the resource, a `Policy` is returned with default # values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The # `etag` value can be used with `SetOrgPolicy()` to create or update a # `Policy` during read-modify-write. # @param [String] resource # Name of the resource the `Policy` is set on. # @param [Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest] get_org_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::CloudresourcemanagerV1::OrgPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::OrgPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_org_policy(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest::Representation command.request_object = get_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy 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 # Lists Projects that are visible to the user and satisfy the # specified filter. This method returns Projects in an unspecified order. # This method is eventually consistent with project mutations; this means # that a newly created project may not appear in the results or recent # updates to an existing project may not be reflected in the results. To # retrieve the latest state of a project, use the # GetProject method. # @param [String] filter # An expression for filtering the results of the request. Filter rules are # case insensitive. The fields eligible for filtering are: # + `name` # + `id` # + labels.key where *key* is the name of a label # Some examples of using labels as filters: # |Filter|Description| # |------|-----------| # |name:how*|The project's name starts with "how".| # |name:Howl|The project's name is `Howl` or `howl`.| # |name:HOWL|Equivalent to above.| # |NAME:howl|Equivalent to above.| # |labels.color:*|The project has the label `color`.| # |labels.color:red|The project's label `color` has the value `red`.| # |labels.color:red labels.size:big|The project's label `color` has the # value `red` and its label `size` has the value `big`. # If you specify a filter that has both `parent.type` and `parent.id`, then # the `resourcemanager.projects.list` permission is checked on the parent. # If the user has this permission, all projects under the parent will be # returned after remaining filters have been applied. If the user lacks this # permission, then all projects for which the user has the # `resourcemanager.projects.get` permission will be returned after remaining # filters have been applied. If no filter is specified, the call will return # projects for which the user has `resourcemanager.projects.get` permissions. # Optional. # @param [Fixnum] page_size # The maximum number of Projects to return in the response. # The server can return fewer Projects than requested. # If unspecified, server picks an appropriate default. # Optional. # @param [String] page_token # A pagination token returned from a previous call to ListProjects # that indicates from where listing should continue. # 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::CloudresourcemanagerV1::ListProjectsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::ListProjectsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_projects(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects', options) command.response_representation = Google::Apis::CloudresourcemanagerV1::ListProjectsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::ListProjectsResponse 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 # Lists `Constraints` that could be applied on the specified resource. # @param [String] resource # Name of the resource to list `Constraints` for. # @param [Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest] list_available_org_policy_constraints_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::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:listAvailableOrgPolicyConstraints', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest::Representation command.request_object = list_available_org_policy_constraints_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse 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 # Lists all the `Policies` set for a particular resource. # @param [String] resource # Name of the resource to list Policies for. # @param [Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest] list_org_policies_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::CloudresourcemanagerV1::ListOrgPoliciesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_org_policies(resource, list_org_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:listOrgPolicies', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest::Representation command.request_object = list_org_policies_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse 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 # Sets the IAM access control policy for the specified Project. Overwrites # any existing policy. # The following constraints apply when using `setIamPolicy()`: # + Project does not support `allUsers` and `allAuthenticatedUsers` as # `members` in a `Binding` of a `Policy`. # + The owner role can be granted only to `user` and `serviceAccount`. # + Service accounts can be made owners of a project directly # without any restrictions. However, to be added as an owner, a user must be # invited via Cloud Platform console and must accept the invitation. # + A user cannot be granted the owner role using `setIamPolicy()`. The user # must be granted the owner role using the Cloud Platform Console and must # explicitly accept the invitation. # + Invitations to grant the owner role cannot be sent using # `setIamPolicy()`; # they must be sent only using the Cloud Platform Console. # + Membership changes that leave the project without any owners that have # accepted the Terms of Service (ToS) will be rejected. # + If the project is not part of an organization, there must be at least # one owner who has accepted the Terms of Service (ToS) agreement in the # policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner # from the policy will fail. This restriction also applies to legacy # projects that no longer have owners who have accepted the ToS. Edits to # IAM policies will be rejected until the lack of a ToS-accepting owner is # rectified. # + This method will replace the existing policy, and cannot be used to # append additional IAM settings. # Note: Removing service accounts from policies or changing their roles # can render services completely inoperable. It is important to understand # how the service account is being used before removing or updating its # roles. # Authorization requires the Google IAM permission # `resourcemanager.projects.setIamPolicy` on the project # @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::CloudresourcemanagerV1::SetIamPolicyRequest] 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::CloudresourcemanagerV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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_project_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{resource}:setIamPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Policy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Policy 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 # Updates the specified `Policy` on the resource. Creates a new `Policy` for # that `Constraint` on the resource if one does not exist. # Not supplying an `etag` on the request `Policy` results in an unconditional # write of the `Policy`. # @param [String] resource # Resource name of the resource to attach the `Policy`. # @param [Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest] set_org_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::CloudresourcemanagerV1::OrgPolicy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::OrgPolicy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_org_policy(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setOrgPolicy', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest::Representation command.request_object = set_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy 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 # Returns permissions that a caller has on the specified Project. # There are no permissions required for making this API call. # @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::CloudresourcemanagerV1::TestIamPermissionsRequest] 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::CloudresourcemanagerV1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{resource}:testIamPermissions', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse 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 # Restores the Project identified by the specified # `project_id` (for example, `my-project-123`). # You can only use this method for a Project that has a lifecycle state of # DELETE_REQUESTED. # After deletion starts, the Project cannot be restored. # The caller must have modify permissions for this Project. # @param [String] project_id # The project ID (for example, `foo-bar-123`). # Required. # @param [Google::Apis::CloudresourcemanagerV1::UndeleteProjectRequest] undelete_project_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::CloudresourcemanagerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::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 undelete_project(project_id, undelete_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{projectId}:undelete', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::UndeleteProjectRequest::Representation command.request_object = undelete_project_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Empty 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 # Updates the attributes of the Project identified by the specified # `project_id` (for example, `my-project-123`). # The caller must have modify permissions for this Project. # @param [String] project_id # The project ID (for example, `my-project-123`). # Required. # @param [Google::Apis::CloudresourcemanagerV1::Project] project_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::CloudresourcemanagerV1::Project] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudresourcemanagerV1::Project] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project(project_id, project_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/projects/{projectId}', options) command.request_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation command.request_object = project_object command.response_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Project 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 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 google-api-client-0.19.8/generated/google/apis/youtubereporting_v1/0000755000004100000410000000000013252673044025350 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/youtubereporting_v1/representations.rb0000644000004100000410000003552213252673044031131 0ustar www-datawww-data# 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 YoutubereportingV1 class Empty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataBlobstore2Info class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataCompositeMedia class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataContentTypeInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataDiffChecksumsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataDiffDownloadResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataDiffUploadRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataDiffUploadResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataDiffVersionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataDownloadParameters class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataMedia class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GdataObjectId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Job class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListJobsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListReportTypesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListReportsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Report class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ReportType 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 GdataBlobstore2Info # @private class Representation < Google::Apis::Core::JsonRepresentation property :blob_generation, :numeric_string => true, as: 'blobGeneration' property :blob_id, as: 'blobId' property :download_read_handle, :base64 => true, as: 'downloadReadHandle' property :read_token, as: 'readToken' property :upload_metadata_container, :base64 => true, as: 'uploadMetadataContainer' end end class GdataCompositeMedia # @private class Representation < Google::Apis::Core::JsonRepresentation property :blob_ref, :base64 => true, as: 'blobRef' property :blobstore2_info, as: 'blobstore2Info', class: Google::Apis::YoutubereportingV1::GdataBlobstore2Info, decorator: Google::Apis::YoutubereportingV1::GdataBlobstore2Info::Representation property :cosmo_binary_reference, :base64 => true, as: 'cosmoBinaryReference' property :crc32c_hash, as: 'crc32cHash' property :inline, :base64 => true, as: 'inline' property :length, :numeric_string => true, as: 'length' property :md5_hash, :base64 => true, as: 'md5Hash' property :object_id_prop, as: 'objectId', class: Google::Apis::YoutubereportingV1::GdataObjectId, decorator: Google::Apis::YoutubereportingV1::GdataObjectId::Representation property :path, as: 'path' property :reference_type, as: 'referenceType' property :sha1_hash, :base64 => true, as: 'sha1Hash' end end class GdataContentTypeInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :best_guess, as: 'bestGuess' property :from_bytes, as: 'fromBytes' property :from_file_name, as: 'fromFileName' property :from_header, as: 'fromHeader' property :from_url_path, as: 'fromUrlPath' end end class GdataDiffChecksumsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :checksums_location, as: 'checksumsLocation', class: Google::Apis::YoutubereportingV1::GdataCompositeMedia, decorator: Google::Apis::YoutubereportingV1::GdataCompositeMedia::Representation property :chunk_size_bytes, :numeric_string => true, as: 'chunkSizeBytes' property :object_location, as: 'objectLocation', class: Google::Apis::YoutubereportingV1::GdataCompositeMedia, decorator: Google::Apis::YoutubereportingV1::GdataCompositeMedia::Representation property :object_size_bytes, :numeric_string => true, as: 'objectSizeBytes' property :object_version, as: 'objectVersion' end end class GdataDiffDownloadResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_location, as: 'objectLocation', class: Google::Apis::YoutubereportingV1::GdataCompositeMedia, decorator: Google::Apis::YoutubereportingV1::GdataCompositeMedia::Representation end end class GdataDiffUploadRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :checksums_info, as: 'checksumsInfo', class: Google::Apis::YoutubereportingV1::GdataCompositeMedia, decorator: Google::Apis::YoutubereportingV1::GdataCompositeMedia::Representation property :object_info, as: 'objectInfo', class: Google::Apis::YoutubereportingV1::GdataCompositeMedia, decorator: Google::Apis::YoutubereportingV1::GdataCompositeMedia::Representation property :object_version, as: 'objectVersion' end end class GdataDiffUploadResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_version, as: 'objectVersion' property :original_object, as: 'originalObject', class: Google::Apis::YoutubereportingV1::GdataCompositeMedia, decorator: Google::Apis::YoutubereportingV1::GdataCompositeMedia::Representation end end class GdataDiffVersionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :object_size_bytes, :numeric_string => true, as: 'objectSizeBytes' property :object_version, as: 'objectVersion' end end class GdataDownloadParameters # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_gzip_compression, as: 'allowGzipCompression' property :ignore_range, as: 'ignoreRange' end end class GdataMedia # @private class Representation < Google::Apis::Core::JsonRepresentation property :algorithm, as: 'algorithm' property :bigstore_object_ref, :base64 => true, as: 'bigstoreObjectRef' property :blob_ref, :base64 => true, as: 'blobRef' property :blobstore2_info, as: 'blobstore2Info', class: Google::Apis::YoutubereportingV1::GdataBlobstore2Info, decorator: Google::Apis::YoutubereportingV1::GdataBlobstore2Info::Representation collection :composite_media, as: 'compositeMedia', class: Google::Apis::YoutubereportingV1::GdataCompositeMedia, decorator: Google::Apis::YoutubereportingV1::GdataCompositeMedia::Representation property :content_type, as: 'contentType' property :content_type_info, as: 'contentTypeInfo', class: Google::Apis::YoutubereportingV1::GdataContentTypeInfo, decorator: Google::Apis::YoutubereportingV1::GdataContentTypeInfo::Representation property :cosmo_binary_reference, :base64 => true, as: 'cosmoBinaryReference' property :crc32c_hash, as: 'crc32cHash' property :diff_checksums_response, as: 'diffChecksumsResponse', class: Google::Apis::YoutubereportingV1::GdataDiffChecksumsResponse, decorator: Google::Apis::YoutubereportingV1::GdataDiffChecksumsResponse::Representation property :diff_download_response, as: 'diffDownloadResponse', class: Google::Apis::YoutubereportingV1::GdataDiffDownloadResponse, decorator: Google::Apis::YoutubereportingV1::GdataDiffDownloadResponse::Representation property :diff_upload_request, as: 'diffUploadRequest', class: Google::Apis::YoutubereportingV1::GdataDiffUploadRequest, decorator: Google::Apis::YoutubereportingV1::GdataDiffUploadRequest::Representation property :diff_upload_response, as: 'diffUploadResponse', class: Google::Apis::YoutubereportingV1::GdataDiffUploadResponse, decorator: Google::Apis::YoutubereportingV1::GdataDiffUploadResponse::Representation property :diff_version_response, as: 'diffVersionResponse', class: Google::Apis::YoutubereportingV1::GdataDiffVersionResponse, decorator: Google::Apis::YoutubereportingV1::GdataDiffVersionResponse::Representation property :download_parameters, as: 'downloadParameters', class: Google::Apis::YoutubereportingV1::GdataDownloadParameters, decorator: Google::Apis::YoutubereportingV1::GdataDownloadParameters::Representation property :filename, as: 'filename' property :hash_prop, as: 'hash' property :hash_verified, as: 'hashVerified' property :inline, :base64 => true, as: 'inline' property :is_potential_retry, as: 'isPotentialRetry' property :length, :numeric_string => true, as: 'length' property :md5_hash, :base64 => true, as: 'md5Hash' property :media_id, :base64 => true, as: 'mediaId' property :object_id_prop, as: 'objectId', class: Google::Apis::YoutubereportingV1::GdataObjectId, decorator: Google::Apis::YoutubereportingV1::GdataObjectId::Representation property :path, as: 'path' property :reference_type, as: 'referenceType' property :sha1_hash, :base64 => true, as: 'sha1Hash' property :sha256_hash, :base64 => true, as: 'sha256Hash' property :timestamp, :numeric_string => true, as: 'timestamp' property :token, as: 'token' end end class GdataObjectId # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket_name, as: 'bucketName' property :generation, :numeric_string => true, as: 'generation' property :object_name, as: 'objectName' end end class Job # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :expire_time, as: 'expireTime' property :id, as: 'id' property :name, as: 'name' property :report_type_id, as: 'reportTypeId' property :system_managed, as: 'systemManaged' end end class ListJobsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :jobs, as: 'jobs', class: Google::Apis::YoutubereportingV1::Job, decorator: Google::Apis::YoutubereportingV1::Job::Representation property :next_page_token, as: 'nextPageToken' end end class ListReportTypesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :report_types, as: 'reportTypes', class: Google::Apis::YoutubereportingV1::ReportType, decorator: Google::Apis::YoutubereportingV1::ReportType::Representation end end class ListReportsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :reports, as: 'reports', class: Google::Apis::YoutubereportingV1::Report, decorator: Google::Apis::YoutubereportingV1::Report::Representation end end class Report # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :download_url, as: 'downloadUrl' property :end_time, as: 'endTime' property :id, as: 'id' property :job_expire_time, as: 'jobExpireTime' property :job_id, as: 'jobId' property :start_time, as: 'startTime' end end class ReportType # @private class Representation < Google::Apis::Core::JsonRepresentation property :deprecate_time, as: 'deprecateTime' property :id, as: 'id' property :name, as: 'name' property :system_managed, as: 'systemManaged' end end end end end google-api-client-0.19.8/generated/google/apis/youtubereporting_v1/classes.rb0000644000004100000410000007440113252673044027340 0ustar www-datawww-data# 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 YoutubereportingV1 # 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 # gdata class GdataBlobstore2Info include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `blobGeneration` # @return [Fixnum] attr_accessor :blob_generation # gdata # Corresponds to the JSON property `blobId` # @return [String] attr_accessor :blob_id # gdata # Corresponds to the JSON property `downloadReadHandle` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :download_read_handle # gdata # Corresponds to the JSON property `readToken` # @return [String] attr_accessor :read_token # gdata # Corresponds to the JSON property `uploadMetadataContainer` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :upload_metadata_container def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @blob_generation = args[:blob_generation] if args.key?(:blob_generation) @blob_id = args[:blob_id] if args.key?(:blob_id) @download_read_handle = args[:download_read_handle] if args.key?(:download_read_handle) @read_token = args[:read_token] if args.key?(:read_token) @upload_metadata_container = args[:upload_metadata_container] if args.key?(:upload_metadata_container) end end # gdata class GdataCompositeMedia include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `blobRef` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :blob_ref # gdata # Corresponds to the JSON property `blobstore2Info` # @return [Google::Apis::YoutubereportingV1::GdataBlobstore2Info] attr_accessor :blobstore2_info # gdata # Corresponds to the JSON property `cosmoBinaryReference` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :cosmo_binary_reference # gdata # Corresponds to the JSON property `crc32cHash` # @return [Fixnum] attr_accessor :crc32c_hash # gdata # Corresponds to the JSON property `inline` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :inline # gdata # Corresponds to the JSON property `length` # @return [Fixnum] attr_accessor :length # gdata # Corresponds to the JSON property `md5Hash` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :md5_hash # gdata # Corresponds to the JSON property `objectId` # @return [Google::Apis::YoutubereportingV1::GdataObjectId] attr_accessor :object_id_prop # gdata # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # gdata # Corresponds to the JSON property `referenceType` # @return [String] attr_accessor :reference_type # gdata # Corresponds to the JSON property `sha1Hash` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :sha1_hash def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @blob_ref = args[:blob_ref] if args.key?(:blob_ref) @blobstore2_info = args[:blobstore2_info] if args.key?(:blobstore2_info) @cosmo_binary_reference = args[:cosmo_binary_reference] if args.key?(:cosmo_binary_reference) @crc32c_hash = args[:crc32c_hash] if args.key?(:crc32c_hash) @inline = args[:inline] if args.key?(:inline) @length = args[:length] if args.key?(:length) @md5_hash = args[:md5_hash] if args.key?(:md5_hash) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @path = args[:path] if args.key?(:path) @reference_type = args[:reference_type] if args.key?(:reference_type) @sha1_hash = args[:sha1_hash] if args.key?(:sha1_hash) end end # gdata class GdataContentTypeInfo include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `bestGuess` # @return [String] attr_accessor :best_guess # gdata # Corresponds to the JSON property `fromBytes` # @return [String] attr_accessor :from_bytes # gdata # Corresponds to the JSON property `fromFileName` # @return [String] attr_accessor :from_file_name # gdata # Corresponds to the JSON property `fromHeader` # @return [String] attr_accessor :from_header # gdata # Corresponds to the JSON property `fromUrlPath` # @return [String] attr_accessor :from_url_path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @best_guess = args[:best_guess] if args.key?(:best_guess) @from_bytes = args[:from_bytes] if args.key?(:from_bytes) @from_file_name = args[:from_file_name] if args.key?(:from_file_name) @from_header = args[:from_header] if args.key?(:from_header) @from_url_path = args[:from_url_path] if args.key?(:from_url_path) end end # gdata class GdataDiffChecksumsResponse include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `checksumsLocation` # @return [Google::Apis::YoutubereportingV1::GdataCompositeMedia] attr_accessor :checksums_location # gdata # Corresponds to the JSON property `chunkSizeBytes` # @return [Fixnum] attr_accessor :chunk_size_bytes # gdata # Corresponds to the JSON property `objectLocation` # @return [Google::Apis::YoutubereportingV1::GdataCompositeMedia] attr_accessor :object_location # gdata # Corresponds to the JSON property `objectSizeBytes` # @return [Fixnum] attr_accessor :object_size_bytes # gdata # Corresponds to the JSON property `objectVersion` # @return [String] attr_accessor :object_version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @checksums_location = args[:checksums_location] if args.key?(:checksums_location) @chunk_size_bytes = args[:chunk_size_bytes] if args.key?(:chunk_size_bytes) @object_location = args[:object_location] if args.key?(:object_location) @object_size_bytes = args[:object_size_bytes] if args.key?(:object_size_bytes) @object_version = args[:object_version] if args.key?(:object_version) end end # gdata class GdataDiffDownloadResponse include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `objectLocation` # @return [Google::Apis::YoutubereportingV1::GdataCompositeMedia] attr_accessor :object_location def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_location = args[:object_location] if args.key?(:object_location) end end # gdata class GdataDiffUploadRequest include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `checksumsInfo` # @return [Google::Apis::YoutubereportingV1::GdataCompositeMedia] attr_accessor :checksums_info # gdata # Corresponds to the JSON property `objectInfo` # @return [Google::Apis::YoutubereportingV1::GdataCompositeMedia] attr_accessor :object_info # gdata # Corresponds to the JSON property `objectVersion` # @return [String] attr_accessor :object_version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @checksums_info = args[:checksums_info] if args.key?(:checksums_info) @object_info = args[:object_info] if args.key?(:object_info) @object_version = args[:object_version] if args.key?(:object_version) end end # gdata class GdataDiffUploadResponse include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `objectVersion` # @return [String] attr_accessor :object_version # gdata # Corresponds to the JSON property `originalObject` # @return [Google::Apis::YoutubereportingV1::GdataCompositeMedia] attr_accessor :original_object def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_version = args[:object_version] if args.key?(:object_version) @original_object = args[:original_object] if args.key?(:original_object) end end # gdata class GdataDiffVersionResponse include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `objectSizeBytes` # @return [Fixnum] attr_accessor :object_size_bytes # gdata # Corresponds to the JSON property `objectVersion` # @return [String] attr_accessor :object_version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @object_size_bytes = args[:object_size_bytes] if args.key?(:object_size_bytes) @object_version = args[:object_version] if args.key?(:object_version) end end # gdata class GdataDownloadParameters include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `allowGzipCompression` # @return [Boolean] attr_accessor :allow_gzip_compression alias_method :allow_gzip_compression?, :allow_gzip_compression # gdata # Corresponds to the JSON property `ignoreRange` # @return [Boolean] attr_accessor :ignore_range alias_method :ignore_range?, :ignore_range def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allow_gzip_compression = args[:allow_gzip_compression] if args.key?(:allow_gzip_compression) @ignore_range = args[:ignore_range] if args.key?(:ignore_range) end end # gdata class GdataMedia include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `algorithm` # @return [String] attr_accessor :algorithm # gdata # Corresponds to the JSON property `bigstoreObjectRef` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :bigstore_object_ref # gdata # Corresponds to the JSON property `blobRef` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :blob_ref # gdata # Corresponds to the JSON property `blobstore2Info` # @return [Google::Apis::YoutubereportingV1::GdataBlobstore2Info] attr_accessor :blobstore2_info # gdata # Corresponds to the JSON property `compositeMedia` # @return [Array] attr_accessor :composite_media # gdata # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # gdata # Corresponds to the JSON property `contentTypeInfo` # @return [Google::Apis::YoutubereportingV1::GdataContentTypeInfo] attr_accessor :content_type_info # gdata # Corresponds to the JSON property `cosmoBinaryReference` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :cosmo_binary_reference # gdata # Corresponds to the JSON property `crc32cHash` # @return [Fixnum] attr_accessor :crc32c_hash # gdata # Corresponds to the JSON property `diffChecksumsResponse` # @return [Google::Apis::YoutubereportingV1::GdataDiffChecksumsResponse] attr_accessor :diff_checksums_response # gdata # Corresponds to the JSON property `diffDownloadResponse` # @return [Google::Apis::YoutubereportingV1::GdataDiffDownloadResponse] attr_accessor :diff_download_response # gdata # Corresponds to the JSON property `diffUploadRequest` # @return [Google::Apis::YoutubereportingV1::GdataDiffUploadRequest] attr_accessor :diff_upload_request # gdata # Corresponds to the JSON property `diffUploadResponse` # @return [Google::Apis::YoutubereportingV1::GdataDiffUploadResponse] attr_accessor :diff_upload_response # gdata # Corresponds to the JSON property `diffVersionResponse` # @return [Google::Apis::YoutubereportingV1::GdataDiffVersionResponse] attr_accessor :diff_version_response # gdata # Corresponds to the JSON property `downloadParameters` # @return [Google::Apis::YoutubereportingV1::GdataDownloadParameters] attr_accessor :download_parameters # gdata # Corresponds to the JSON property `filename` # @return [String] attr_accessor :filename # gdata # Corresponds to the JSON property `hash` # @return [String] attr_accessor :hash_prop # gdata # Corresponds to the JSON property `hashVerified` # @return [Boolean] attr_accessor :hash_verified alias_method :hash_verified?, :hash_verified # gdata # Corresponds to the JSON property `inline` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :inline # gdata # Corresponds to the JSON property `isPotentialRetry` # @return [Boolean] attr_accessor :is_potential_retry alias_method :is_potential_retry?, :is_potential_retry # gdata # Corresponds to the JSON property `length` # @return [Fixnum] attr_accessor :length # gdata # Corresponds to the JSON property `md5Hash` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :md5_hash # gdata # Corresponds to the JSON property `mediaId` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :media_id # gdata # Corresponds to the JSON property `objectId` # @return [Google::Apis::YoutubereportingV1::GdataObjectId] attr_accessor :object_id_prop # gdata # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # gdata # Corresponds to the JSON property `referenceType` # @return [String] attr_accessor :reference_type # gdata # Corresponds to the JSON property `sha1Hash` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :sha1_hash # gdata # Corresponds to the JSON property `sha256Hash` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :sha256_hash # gdata # Corresponds to the JSON property `timestamp` # @return [Fixnum] attr_accessor :timestamp # gdata # Corresponds to the JSON property `token` # @return [String] attr_accessor :token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @algorithm = args[:algorithm] if args.key?(:algorithm) @bigstore_object_ref = args[:bigstore_object_ref] if args.key?(:bigstore_object_ref) @blob_ref = args[:blob_ref] if args.key?(:blob_ref) @blobstore2_info = args[:blobstore2_info] if args.key?(:blobstore2_info) @composite_media = args[:composite_media] if args.key?(:composite_media) @content_type = args[:content_type] if args.key?(:content_type) @content_type_info = args[:content_type_info] if args.key?(:content_type_info) @cosmo_binary_reference = args[:cosmo_binary_reference] if args.key?(:cosmo_binary_reference) @crc32c_hash = args[:crc32c_hash] if args.key?(:crc32c_hash) @diff_checksums_response = args[:diff_checksums_response] if args.key?(:diff_checksums_response) @diff_download_response = args[:diff_download_response] if args.key?(:diff_download_response) @diff_upload_request = args[:diff_upload_request] if args.key?(:diff_upload_request) @diff_upload_response = args[:diff_upload_response] if args.key?(:diff_upload_response) @diff_version_response = args[:diff_version_response] if args.key?(:diff_version_response) @download_parameters = args[:download_parameters] if args.key?(:download_parameters) @filename = args[:filename] if args.key?(:filename) @hash_prop = args[:hash_prop] if args.key?(:hash_prop) @hash_verified = args[:hash_verified] if args.key?(:hash_verified) @inline = args[:inline] if args.key?(:inline) @is_potential_retry = args[:is_potential_retry] if args.key?(:is_potential_retry) @length = args[:length] if args.key?(:length) @md5_hash = args[:md5_hash] if args.key?(:md5_hash) @media_id = args[:media_id] if args.key?(:media_id) @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) @path = args[:path] if args.key?(:path) @reference_type = args[:reference_type] if args.key?(:reference_type) @sha1_hash = args[:sha1_hash] if args.key?(:sha1_hash) @sha256_hash = args[:sha256_hash] if args.key?(:sha256_hash) @timestamp = args[:timestamp] if args.key?(:timestamp) @token = args[:token] if args.key?(:token) end end # gdata class GdataObjectId include Google::Apis::Core::Hashable # gdata # Corresponds to the JSON property `bucketName` # @return [String] attr_accessor :bucket_name # gdata # Corresponds to the JSON property `generation` # @return [Fixnum] attr_accessor :generation # gdata # Corresponds to the JSON property `objectName` # @return [String] attr_accessor :object_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bucket_name = args[:bucket_name] if args.key?(:bucket_name) @generation = args[:generation] if args.key?(:generation) @object_name = args[:object_name] if args.key?(:object_name) end end # A job creating reports of a specific type. class Job include Google::Apis::Core::Hashable # The creation date/time of the job. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The date/time when this job will expire/expired. After a job expired, no # new reports are generated. # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time # The server-generated ID of the job (max. 40 characters). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The name of the job (max. 100 characters). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The type of reports this job creates. Corresponds to the ID of a # ReportType. # Corresponds to the JSON property `reportTypeId` # @return [String] attr_accessor :report_type_id # True if this a system-managed job that cannot be modified by the user; # otherwise false. # Corresponds to the JSON property `systemManaged` # @return [Boolean] attr_accessor :system_managed alias_method :system_managed?, :system_managed def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @expire_time = args[:expire_time] if args.key?(:expire_time) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @report_type_id = args[:report_type_id] if args.key?(:report_type_id) @system_managed = args[:system_managed] if args.key?(:system_managed) end end # Response message for ReportingService.ListJobs. class ListJobsResponse include Google::Apis::Core::Hashable # The list of jobs. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs # A token to retrieve next page of results. # Pass this value in the # ListJobsRequest.page_token # field in the subsequent call to `ListJobs` 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) @jobs = args[:jobs] if args.key?(:jobs) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Response message for ReportingService.ListReportTypes. class ListReportTypesResponse include Google::Apis::Core::Hashable # A token to retrieve next page of results. # Pass this value in the # ListReportTypesRequest.page_token # field in the subsequent call to `ListReportTypes` method to retrieve the next # page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of report types. # Corresponds to the JSON property `reportTypes` # @return [Array] attr_accessor :report_types 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) @report_types = args[:report_types] if args.key?(:report_types) end end # Response message for ReportingService.ListReports. class ListReportsResponse include Google::Apis::Core::Hashable # A token to retrieve next page of results. # Pass this value in the # ListReportsRequest.page_token # field in the subsequent call to `ListReports` method to retrieve the next # page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of report types. # Corresponds to the JSON property `reports` # @return [Array] attr_accessor :reports 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) @reports = args[:reports] if args.key?(:reports) end end # A report's metadata including the URL from which the report itself can be # downloaded. class Report include Google::Apis::Core::Hashable # The date/time when this report was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The URL from which the report can be downloaded (max. 1000 characters). # Corresponds to the JSON property `downloadUrl` # @return [String] attr_accessor :download_url # The end of the time period that the report instance covers. The value is # exclusive. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # The server-generated ID of the report. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The date/time when the job this report belongs to will expire/expired. # Corresponds to the JSON property `jobExpireTime` # @return [String] attr_accessor :job_expire_time # The ID of the job that created this report. # Corresponds to the JSON property `jobId` # @return [String] attr_accessor :job_id # The start of the time period that the report instance covers. The value is # 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) @create_time = args[:create_time] if args.key?(:create_time) @download_url = args[:download_url] if args.key?(:download_url) @end_time = args[:end_time] if args.key?(:end_time) @id = args[:id] if args.key?(:id) @job_expire_time = args[:job_expire_time] if args.key?(:job_expire_time) @job_id = args[:job_id] if args.key?(:job_id) @start_time = args[:start_time] if args.key?(:start_time) end end # A report type. class ReportType include Google::Apis::Core::Hashable # The date/time when this report type was/will be deprecated. # Corresponds to the JSON property `deprecateTime` # @return [String] attr_accessor :deprecate_time # The ID of the report type (max. 100 characters). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The name of the report type (max. 100 characters). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # True if this a system-managed report type; otherwise false. Reporting jobs # for system-managed report types are created automatically and can thus not # be used in the `CreateJob` method. # Corresponds to the JSON property `systemManaged` # @return [Boolean] attr_accessor :system_managed alias_method :system_managed?, :system_managed def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deprecate_time = args[:deprecate_time] if args.key?(:deprecate_time) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @system_managed = args[:system_managed] if args.key?(:system_managed) end end end end end google-api-client-0.19.8/generated/google/apis/youtubereporting_v1/service.rb0000644000004100000410000005461613252673044027351 0ustar www-datawww-data# 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 YoutubereportingV1 # YouTube Reporting API # # Schedules reporting jobs containing your YouTube Analytics data and downloads # the resulting bulk data reports in the form of CSV files. # # @example # require 'google/apis/youtubereporting_v1' # # Youtubereporting = Google::Apis::YoutubereportingV1 # Alias the module # service = Youtubereporting::YouTubeReportingService.new # # @see https://developers.google.com/youtube/reporting/v1/reports/ class YouTubeReportingService < 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://youtubereporting.googleapis.com/', '') @batch_path = 'batch' end # Creates a job and returns it. # @param [Google::Apis::YoutubereportingV1::Job] job_object # @param [String] on_behalf_of_content_owner # The content owner's external ID on which behalf the user is acting on. If # not set, the user is acting for himself (his own 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::YoutubereportingV1::Job] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubereportingV1::Job] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job(job_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/jobs', options) command.request_representation = Google::Apis::YoutubereportingV1::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::YoutubereportingV1::Job::Representation command.response_class = Google::Apis::YoutubereportingV1::Job command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 job. # @param [String] job_id # The ID of the job to delete. # @param [String] on_behalf_of_content_owner # The content owner's external ID on which behalf the user is acting on. If # not set, the user is acting for himself (his own 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::YoutubereportingV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubereportingV1::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_job(job_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/jobs/{jobId}', options) command.response_representation = Google::Apis::YoutubereportingV1::Empty::Representation command.response_class = Google::Apis::YoutubereportingV1::Empty command.params['jobId'] = job_id unless job_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 job. # @param [String] job_id # The ID of the job to retrieve. # @param [String] on_behalf_of_content_owner # The content owner's external ID on which behalf the user is acting on. If # not set, the user is acting for himself (his own 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::YoutubereportingV1::Job] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubereportingV1::Job] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job(job_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/jobs/{jobId}', options) command.response_representation = Google::Apis::YoutubereportingV1::Job::Representation command.response_class = Google::Apis::YoutubereportingV1::Job command.params['jobId'] = job_id unless job_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 jobs. # @param [Boolean] include_system_managed # If set to true, also system-managed jobs will be returned; otherwise only # user-created jobs will be returned. System-managed jobs can neither be # modified nor deleted. # @param [String] on_behalf_of_content_owner # The content owner's external ID on which behalf the user is acting on. If # not set, the user is acting for himself (his own channel). # @param [Fixnum] page_size # Requested page size. Server may return fewer jobs than requested. # If unspecified, server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. Typically, # this is the value of # ListReportTypesResponse.next_page_token # returned in response to the previous call to the `ListJobs` method. # @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::YoutubereportingV1::ListJobsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubereportingV1::ListJobsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_jobs(include_system_managed: nil, on_behalf_of_content_owner: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/jobs', options) command.response_representation = Google::Apis::YoutubereportingV1::ListJobsResponse::Representation command.response_class = Google::Apis::YoutubereportingV1::ListJobsResponse command.query['includeSystemManaged'] = include_system_managed unless include_system_managed.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 the metadata of a specific report. # @param [String] job_id # The ID of the job. # @param [String] report_id # The ID of the report to retrieve. # @param [String] on_behalf_of_content_owner # The content owner's external ID on which behalf the user is acting on. If # not set, the user is acting for himself (his own 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::YoutubereportingV1::Report] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubereportingV1::Report] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job_report(job_id, report_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/jobs/{jobId}/reports/{reportId}', options) command.response_representation = Google::Apis::YoutubereportingV1::Report::Representation command.response_class = Google::Apis::YoutubereportingV1::Report command.params['jobId'] = job_id unless job_id.nil? command.params['reportId'] = report_id unless report_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 reports created by a specific job. # Returns NOT_FOUND if the job does not exist. # @param [String] job_id # The ID of the job. # @param [String] created_after # If set, only reports created after the specified date/time are returned. # @param [String] on_behalf_of_content_owner # The content owner's external ID on which behalf the user is acting on. If # not set, the user is acting for himself (his own channel). # @param [Fixnum] page_size # Requested page size. Server may return fewer report types than requested. # If unspecified, server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. Typically, # this is the value of # ListReportsResponse.next_page_token # returned in response to the previous call to the `ListReports` method. # @param [String] start_time_at_or_after # If set, only reports whose start time is greater than or equal the # specified date/time are returned. # @param [String] start_time_before # If set, only reports whose start time is smaller than the specified # date/time are 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::YoutubereportingV1::ListReportsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubereportingV1::ListReportsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_job_reports(job_id, created_after: nil, on_behalf_of_content_owner: nil, page_size: nil, page_token: nil, start_time_at_or_after: nil, start_time_before: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/jobs/{jobId}/reports', options) command.response_representation = Google::Apis::YoutubereportingV1::ListReportsResponse::Representation command.response_class = Google::Apis::YoutubereportingV1::ListReportsResponse command.params['jobId'] = job_id unless job_id.nil? command.query['createdAfter'] = created_after unless created_after.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['startTimeAtOrAfter'] = start_time_at_or_after unless start_time_at_or_after.nil? command.query['startTimeBefore'] = start_time_before unless start_time_before.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Method for media download. Download is supported # on the URI `/v1/media/`+name`?alt=media`. # @param [String] resource_name # Name of the media that is being downloaded. # @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] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::YoutubereportingV1::GdataMedia] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubereportingV1::GdataMedia] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'v1/media/{+resourceName}', options) else command = make_download_command(:get, 'v1/media/{+resourceName}', options) command.download_dest = download_dest end command.response_representation = Google::Apis::YoutubereportingV1::GdataMedia::Representation command.response_class = Google::Apis::YoutubereportingV1::GdataMedia command.params['resourceName'] = resource_name unless resource_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 report types. # @param [Boolean] include_system_managed # If set to true, also system-managed report types will be returned; # otherwise only the report types that can be used to create new reporting # jobs will be returned. # @param [String] on_behalf_of_content_owner # The content owner's external ID on which behalf the user is acting on. If # not set, the user is acting for himself (his own channel). # @param [Fixnum] page_size # Requested page size. Server may return fewer report types than requested. # If unspecified, server will pick an appropriate default. # @param [String] page_token # A token identifying a page of results the server should return. Typically, # this is the value of # ListReportTypesResponse.next_page_token # returned in response to the previous call to the `ListReportTypes` method. # @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::YoutubereportingV1::ListReportTypesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::YoutubereportingV1::ListReportTypesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_report_types(include_system_managed: nil, on_behalf_of_content_owner: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/reportTypes', options) command.response_representation = Google::Apis::YoutubereportingV1::ListReportTypesResponse::Representation command.response_class = Google::Apis::YoutubereportingV1::ListReportTypesResponse command.query['includeSystemManaged'] = include_system_managed unless include_system_managed.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.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 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 google-api-client-0.19.8/generated/google/apis/mirror_v1/0000755000004100000410000000000013252673044023234 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/mirror_v1/representations.rb0000644000004100000410000003311013252673044027004 0ustar www-datawww-data# 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 MirrorV1 class Account class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Attachment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAttachmentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthToken class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Command class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Contact class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListContactsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Location class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLocationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MenuItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MenuValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Notification class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NotificationConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Setting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Subscription class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListSubscriptionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TimelineItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListTimelineResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserAction class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Account # @private class Representation < Google::Apis::Core::JsonRepresentation collection :auth_tokens, as: 'authTokens', class: Google::Apis::MirrorV1::AuthToken, decorator: Google::Apis::MirrorV1::AuthToken::Representation collection :features, as: 'features' property :password, as: 'password' collection :user_data, as: 'userData', class: Google::Apis::MirrorV1::UserData, decorator: Google::Apis::MirrorV1::UserData::Representation end end class Attachment # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_type, as: 'contentType' property :content_url, as: 'contentUrl' property :id, as: 'id' property :is_processing_content, as: 'isProcessingContent' end end class ListAttachmentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::MirrorV1::Attachment, decorator: Google::Apis::MirrorV1::Attachment::Representation property :kind, as: 'kind' end end class AuthToken # @private class Representation < Google::Apis::Core::JsonRepresentation property :auth_token, as: 'authToken' property :type, as: 'type' end end class Command # @private class Representation < Google::Apis::Core::JsonRepresentation property :type, as: 'type' end end class Contact # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accept_commands, as: 'acceptCommands', class: Google::Apis::MirrorV1::Command, decorator: Google::Apis::MirrorV1::Command::Representation collection :accept_types, as: 'acceptTypes' property :display_name, as: 'displayName' property :id, as: 'id' collection :image_urls, as: 'imageUrls' property :kind, as: 'kind' property :phone_number, as: 'phoneNumber' property :priority, as: 'priority' collection :sharing_features, as: 'sharingFeatures' property :source, as: 'source' property :speakable_name, as: 'speakableName' property :type, as: 'type' end end class ListContactsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::MirrorV1::Contact, decorator: Google::Apis::MirrorV1::Contact::Representation property :kind, as: 'kind' end end class Location # @private class Representation < Google::Apis::Core::JsonRepresentation property :accuracy, as: 'accuracy' property :address, as: 'address' property :display_name, as: 'displayName' property :id, as: 'id' property :kind, as: 'kind' property :latitude, as: 'latitude' property :longitude, as: 'longitude' property :timestamp, as: 'timestamp', type: DateTime end end class ListLocationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::MirrorV1::Location, decorator: Google::Apis::MirrorV1::Location::Representation property :kind, as: 'kind' end end class MenuItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' property :contextual_command, as: 'contextual_command' property :id, as: 'id' property :payload, as: 'payload' property :remove_when_selected, as: 'removeWhenSelected' collection :values, as: 'values', class: Google::Apis::MirrorV1::MenuValue, decorator: Google::Apis::MirrorV1::MenuValue::Representation end end class MenuValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :display_name, as: 'displayName' property :icon_url, as: 'iconUrl' property :state, as: 'state' end end class Notification # @private class Representation < Google::Apis::Core::JsonRepresentation property :collection, as: 'collection' property :item_id, as: 'itemId' property :operation, as: 'operation' collection :user_actions, as: 'userActions', class: Google::Apis::MirrorV1::UserAction, decorator: Google::Apis::MirrorV1::UserAction::Representation property :user_token, as: 'userToken' property :verify_token, as: 'verifyToken' end end class NotificationConfig # @private class Representation < Google::Apis::Core::JsonRepresentation property :delivery_time, as: 'deliveryTime', type: DateTime property :level, as: 'level' end end class Setting # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :kind, as: 'kind' property :value, as: 'value' end end class Subscription # @private class Representation < Google::Apis::Core::JsonRepresentation property :callback_url, as: 'callbackUrl' property :collection, as: 'collection' property :id, as: 'id' property :kind, as: 'kind' property :notification, as: 'notification', class: Google::Apis::MirrorV1::Notification, decorator: Google::Apis::MirrorV1::Notification::Representation collection :operation, as: 'operation' property :updated, as: 'updated', type: DateTime property :user_token, as: 'userToken' property :verify_token, as: 'verifyToken' end end class ListSubscriptionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::MirrorV1::Subscription, decorator: Google::Apis::MirrorV1::Subscription::Representation property :kind, as: 'kind' end end class TimelineItem # @private class Representation < Google::Apis::Core::JsonRepresentation collection :attachments, as: 'attachments', class: Google::Apis::MirrorV1::Attachment, decorator: Google::Apis::MirrorV1::Attachment::Representation property :bundle_id, as: 'bundleId' property :canonical_url, as: 'canonicalUrl' property :created, as: 'created', type: DateTime property :creator, as: 'creator', class: Google::Apis::MirrorV1::Contact, decorator: Google::Apis::MirrorV1::Contact::Representation property :display_time, as: 'displayTime', type: DateTime property :etag, as: 'etag' property :html, as: 'html' property :id, as: 'id' property :in_reply_to, as: 'inReplyTo' property :is_bundle_cover, as: 'isBundleCover' property :is_deleted, as: 'isDeleted' property :is_pinned, as: 'isPinned' property :kind, as: 'kind' property :location, as: 'location', class: Google::Apis::MirrorV1::Location, decorator: Google::Apis::MirrorV1::Location::Representation collection :menu_items, as: 'menuItems', class: Google::Apis::MirrorV1::MenuItem, decorator: Google::Apis::MirrorV1::MenuItem::Representation property :notification, as: 'notification', class: Google::Apis::MirrorV1::NotificationConfig, decorator: Google::Apis::MirrorV1::NotificationConfig::Representation property :pin_score, as: 'pinScore' collection :recipients, as: 'recipients', class: Google::Apis::MirrorV1::Contact, decorator: Google::Apis::MirrorV1::Contact::Representation property :self_link, as: 'selfLink' property :source_item_id, as: 'sourceItemId' property :speakable_text, as: 'speakableText' property :speakable_type, as: 'speakableType' property :text, as: 'text' property :title, as: 'title' property :updated, as: 'updated', type: DateTime end end class ListTimelineResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::MirrorV1::TimelineItem, decorator: Google::Apis::MirrorV1::TimelineItem::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' end end class UserAction # @private class Representation < Google::Apis::Core::JsonRepresentation property :payload, as: 'payload' property :type, as: 'type' end end class UserData # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end end end end google-api-client-0.19.8/generated/google/apis/mirror_v1/classes.rb0000644000004100000410000012567113252673044025232 0ustar www-datawww-data# 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 MirrorV1 # Represents an account passed into the Account Manager on Glass. class Account include Google::Apis::Core::Hashable # # Corresponds to the JSON property `authTokens` # @return [Array] attr_accessor :auth_tokens # # Corresponds to the JSON property `features` # @return [Array] attr_accessor :features # # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # # Corresponds to the JSON property `userData` # @return [Array] attr_accessor :user_data def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auth_tokens = args[:auth_tokens] if args.key?(:auth_tokens) @features = args[:features] if args.key?(:features) @password = args[:password] if args.key?(:password) @user_data = args[:user_data] if args.key?(:user_data) end end # Represents media content, such as a photo, that can be attached to a timeline # item. class Attachment include Google::Apis::Core::Hashable # The MIME type of the attachment. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # The URL for the content. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url # The ID of the attachment. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Indicates that the contentUrl is not available because the attachment content # is still being processed. If the caller wishes to retrieve the content, it # should try again later. # Corresponds to the JSON property `isProcessingContent` # @return [Boolean] attr_accessor :is_processing_content alias_method :is_processing_content?, :is_processing_content def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_type = args[:content_type] if args.key?(:content_type) @content_url = args[:content_url] if args.key?(:content_url) @id = args[:id] if args.key?(:id) @is_processing_content = args[:is_processing_content] if args.key?(:is_processing_content) end end # A list of Attachments. This is the response from the server to GET requests on # the attachments collection. class ListAttachmentsResponse include Google::Apis::Core::Hashable # The list of attachments. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of resource. This is always mirror#attachmentsList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class AuthToken include Google::Apis::Core::Hashable # # Corresponds to the JSON property `authToken` # @return [String] attr_accessor :auth_token # # 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) @auth_token = args[:auth_token] if args.key?(:auth_token) @type = args[:type] if args.key?(:type) end end # A single menu command that is part of a Contact. class Command include Google::Apis::Core::Hashable # The type of operation this command corresponds to. Allowed values are: # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech # from the "Take a note" voice menu command. # - POST_AN_UPDATE - Shares a timeline item with the transcription of user # speech from the "Post an update" voice menu command. # 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) @type = args[:type] if args.key?(:type) end end # A person or group that can be used as a creator or a contact. class Contact include Google::Apis::Core::Hashable # A list of voice menu commands that a contact can handle. Glass shows up to # three contacts for each voice menu command. If there are more than that, the # three contacts with the highest priority are shown for that particular command. # Corresponds to the JSON property `acceptCommands` # @return [Array] attr_accessor :accept_commands # A list of MIME types that a contact supports. The contact will be shown to the # user if any of its acceptTypes matches any of the types of the attachments on # the item. If no acceptTypes are given, the contact will be shown for all items. # Corresponds to the JSON property `acceptTypes` # @return [Array] attr_accessor :accept_types # The name to display for this contact. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # An ID for this contact. This is generated by the application and is treated as # an opaque token. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Set of image URLs to display for a contact. Most contacts will have a single # image, but a "group" contact may include up to 8 image URLs and they will be # resized and cropped into a mosaic on the client. # Corresponds to the JSON property `imageUrls` # @return [Array] attr_accessor :image_urls # The type of resource. This is always mirror#contact. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Primary phone number for the contact. This can be a fully-qualified number, # with country calling code and area code, or a local number. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number # Priority for the contact to determine ordering in a list of contacts. Contacts # with higher priorities will be shown before ones with lower priorities. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority # A list of sharing features that a contact can handle. Allowed values are: # - ADD_CAPTION # Corresponds to the JSON property `sharingFeatures` # @return [Array] attr_accessor :sharing_features # The ID of the application that created this contact. This is populated by the # API # Corresponds to the JSON property `source` # @return [String] attr_accessor :source # Name of this contact as it should be pronounced. If this contact's name must # be spoken as part of a voice disambiguation menu, this name is used as the # expected pronunciation. This is useful for contact names with unpronounceable # characters or whose display spelling is otherwise not phonetic. # Corresponds to the JSON property `speakableName` # @return [String] attr_accessor :speakable_name # The type for this contact. This is used for sorting in UIs. Allowed values are: # # - INDIVIDUAL - Represents a single person. This is the default. # - GROUP - Represents more than a single person. # 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) @accept_commands = args[:accept_commands] if args.key?(:accept_commands) @accept_types = args[:accept_types] if args.key?(:accept_types) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @image_urls = args[:image_urls] if args.key?(:image_urls) @kind = args[:kind] if args.key?(:kind) @phone_number = args[:phone_number] if args.key?(:phone_number) @priority = args[:priority] if args.key?(:priority) @sharing_features = args[:sharing_features] if args.key?(:sharing_features) @source = args[:source] if args.key?(:source) @speakable_name = args[:speakable_name] if args.key?(:speakable_name) @type = args[:type] if args.key?(:type) end end # A list of Contacts representing contacts. This is the response from the server # to GET requests on the contacts collection. class ListContactsResponse include Google::Apis::Core::Hashable # Contact list. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of resource. This is always mirror#contacts. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # A geographic location that can be associated with a timeline item. class Location include Google::Apis::Core::Hashable # The accuracy of the location fix in meters. # Corresponds to the JSON property `accuracy` # @return [Float] attr_accessor :accuracy # The full address of the location. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # The name to be displayed. This may be a business name or a user-defined place, # such as "Home". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The ID of the location. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of resource. This is always mirror#location. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The latitude, in degrees. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude # The longitude, in degrees. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude # The time at which this location was captured, formatted according to RFC 3339. # Corresponds to the JSON property `timestamp` # @return [DateTime] attr_accessor :timestamp def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accuracy = args[:accuracy] if args.key?(:accuracy) @address = args[:address] if args.key?(:address) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @latitude = args[:latitude] if args.key?(:latitude) @longitude = args[:longitude] if args.key?(:longitude) @timestamp = args[:timestamp] if args.key?(:timestamp) end end # A list of Locations. This is the response from the server to GET requests on # the locations collection. class ListLocationsResponse include Google::Apis::Core::Hashable # The list of locations. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of resource. This is always mirror#locationsList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # A custom menu item that can be presented to the user by a timeline item. class MenuItem include Google::Apis::Core::Hashable # Controls the behavior when the user picks the menu option. Allowed values are: # # - CUSTOM - Custom action set by the service. When the user selects this # menuItem, the API triggers a notification to your callbackUrl with the # userActions.type set to CUSTOM and the userActions.payload set to the ID of # this menu item. This is the default value. # - Built-in actions: # - REPLY - Initiate a reply to the timeline item using the voice recording UI. # The creator attribute must be set in the timeline item for this menu to be # available. # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients # will be added to the reply item. # - DELETE - Delete the timeline item. # - SHARE - Share the timeline item with the available contacts. # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is # not set, read the text field; if none of those fields are set, this menu item # is ignored. # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a # menu item (currently, only transcribed text from voice input is supported). # Subscribe to notifications when users invoke this menu item to receive the # timeline item ID. Retrieve the media from the timeline item in the payload # property. # - VOICE_CALL - Initiate a phone call using the timeline item's creator. # phoneNumber attribute as recipient. # - NAVIGATE - Navigate to the timeline item's location. # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. # - OPEN_URI - Open the payload of the menu item in the browser. # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: # - If the creator.phoneNumber is set and Glass is connected to an Android phone, # the message is an SMS. # - Otherwise, if the creator.email is set, the message is an email. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). # The voice label for this command will be displayed in the voice menu and the # touch label will be displayed in the touch menu. Note that the default menu # value's display name will be overriden if you specify this property. Values # that do not correspond to a ContextualMenus.Command name will be ignored. # Corresponds to the JSON property `contextual_command` # @return [String] attr_accessor :contextual_command # The ID for this menu item. This is generated by the application and is treated # as an opaque token. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # A generic payload whose meaning changes depending on this MenuItem's action. # - When the action is OPEN_URI, the payload is the URL of the website to view. # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of # a user's speech input # Corresponds to the JSON property `payload` # @return [String] attr_accessor :payload # If set to true on a CUSTOM menu item, that item will be removed from the menu # after it is selected. # Corresponds to the JSON property `removeWhenSelected` # @return [Boolean] attr_accessor :remove_when_selected alias_method :remove_when_selected?, :remove_when_selected # For CUSTOM items, a list of values controlling the appearance of the menu item # in each of its states. A value for the DEFAULT state must be provided. If the # PENDING or CONFIRMED states are missing, they will not be shown. # 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) @action = args[:action] if args.key?(:action) @contextual_command = args[:contextual_command] if args.key?(:contextual_command) @id = args[:id] if args.key?(:id) @payload = args[:payload] if args.key?(:payload) @remove_when_selected = args[:remove_when_selected] if args.key?(:remove_when_selected) @values = args[:values] if args.key?(:values) end end # A single value that is part of a MenuItem. class MenuValue include Google::Apis::Core::Hashable # The name to display for the menu item. If you specify this property for a # built-in menu item, the default contextual voice command for that menu item is # not shown. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # URL of an icon to display with the menu item. # Corresponds to the JSON property `iconUrl` # @return [String] attr_accessor :icon_url # The state that this value applies to. Allowed values are: # - DEFAULT - Default value shown when displayed in the menuItems list. # - PENDING - Value shown when the menuItem has been selected by the user but # can still be cancelled. # - CONFIRMED - Value shown when the menuItem has been selected by the user and # can no longer be cancelled. # 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) @display_name = args[:display_name] if args.key?(:display_name) @icon_url = args[:icon_url] if args.key?(:icon_url) @state = args[:state] if args.key?(:state) end end # A notification delivered by the API. class Notification include Google::Apis::Core::Hashable # The collection that generated the notification. # Corresponds to the JSON property `collection` # @return [String] attr_accessor :collection # The ID of the item that generated the notification. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id # The type of operation that generated the notification. # Corresponds to the JSON property `operation` # @return [String] attr_accessor :operation # A list of actions taken by the user that triggered the notification. # Corresponds to the JSON property `userActions` # @return [Array] attr_accessor :user_actions # The user token provided by the service when it subscribed for notifications. # Corresponds to the JSON property `userToken` # @return [String] attr_accessor :user_token # The secret verify token provided by the service when it subscribed for # notifications. # Corresponds to the JSON property `verifyToken` # @return [String] attr_accessor :verify_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @collection = args[:collection] if args.key?(:collection) @item_id = args[:item_id] if args.key?(:item_id) @operation = args[:operation] if args.key?(:operation) @user_actions = args[:user_actions] if args.key?(:user_actions) @user_token = args[:user_token] if args.key?(:user_token) @verify_token = args[:verify_token] if args.key?(:verify_token) end end # Controls how notifications for a timeline item are presented to the user. class NotificationConfig include Google::Apis::Core::Hashable # The time at which the notification should be delivered. # Corresponds to the JSON property `deliveryTime` # @return [DateTime] attr_accessor :delivery_time # Describes how important the notification is. Allowed values are: # - DEFAULT - Notifications of default importance. A chime will be played to # alert users. # Corresponds to the JSON property `level` # @return [String] attr_accessor :level def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @delivery_time = args[:delivery_time] if args.key?(:delivery_time) @level = args[:level] if args.key?(:level) end end # A setting for Glass. class Setting include Google::Apis::Core::Hashable # The setting's ID. The following IDs are valid: # - locale - The key to the user’s language/locale (BCP 47 identifier) that # Glassware should use to render localized content. # - timezone - The key to the user’s current time zone region as defined in the # tz database. Example: America/Los_Angeles. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of resource. This is always mirror#setting. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The setting value, as a string. # 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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @value = args[:value] if args.key?(:value) end end # A subscription to events on a collection. class Subscription include Google::Apis::Core::Hashable # The URL where notifications should be delivered (must start with https://). # Corresponds to the JSON property `callbackUrl` # @return [String] attr_accessor :callback_url # The collection to subscribe to. Allowed values are: # - timeline - Changes in the timeline including insertion, deletion, and # updates. # - locations - Location updates. # - settings - Settings updates. # Corresponds to the JSON property `collection` # @return [String] attr_accessor :collection # The ID of the subscription. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The type of resource. This is always mirror#subscription. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A notification delivered by the API. # Corresponds to the JSON property `notification` # @return [Google::Apis::MirrorV1::Notification] attr_accessor :notification # A list of operations that should be subscribed to. An empty list indicates # that all operations on the collection should be subscribed to. Allowed values # are: # - UPDATE - The item has been updated. # - INSERT - A new item has been inserted. # - DELETE - The item has been deleted. # - MENU_ACTION - A custom menu item has been triggered by the user. # Corresponds to the JSON property `operation` # @return [Array] attr_accessor :operation # The time at which this subscription was last modified, formatted according to # RFC 3339. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated # An opaque token sent to the subscriber in notifications so that it can # determine the ID of the user. # Corresponds to the JSON property `userToken` # @return [String] attr_accessor :user_token # A secret token sent to the subscriber in notifications so that it can verify # that the notification was generated by Google. # Corresponds to the JSON property `verifyToken` # @return [String] attr_accessor :verify_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @callback_url = args[:callback_url] if args.key?(:callback_url) @collection = args[:collection] if args.key?(:collection) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @notification = args[:notification] if args.key?(:notification) @operation = args[:operation] if args.key?(:operation) @updated = args[:updated] if args.key?(:updated) @user_token = args[:user_token] if args.key?(:user_token) @verify_token = args[:verify_token] if args.key?(:verify_token) end end # A list of Subscriptions. This is the response from the server to GET requests # on the subscription collection. class ListSubscriptionsResponse include Google::Apis::Core::Hashable # The list of subscriptions. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of resource. This is always mirror#subscriptionsList. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # Each item in the user's timeline is represented as a TimelineItem JSON # structure, described below. class TimelineItem include Google::Apis::Core::Hashable # A list of media attachments associated with this item. As a convenience, you # can refer to attachments in your HTML payloads with the attachment or cid # scheme. For example: # - attachment: where attachment_index # is the 0-based index of this array. # - cid: where attachment_id is the ID of the # attachment. # Corresponds to the JSON property `attachments` # @return [Array] attr_accessor :attachments # The bundle ID for this item. Services can specify a bundleId to group many # items together. They appear under a single top-level item on the device. # Corresponds to the JSON property `bundleId` # @return [String] attr_accessor :bundle_id # A canonical URL pointing to the canonical/high quality version of the data # represented by the timeline item. # Corresponds to the JSON property `canonicalUrl` # @return [String] attr_accessor :canonical_url # The time at which this item was created, formatted according to RFC 3339. # Corresponds to the JSON property `created` # @return [DateTime] attr_accessor :created # A person or group that can be used as a creator or a contact. # Corresponds to the JSON property `creator` # @return [Google::Apis::MirrorV1::Contact] attr_accessor :creator # The time that should be displayed when this item is viewed in the timeline, # formatted according to RFC 3339. This user's timeline is sorted # chronologically on display time, so this will also determine where the item is # displayed in the timeline. If not set by the service, the display time # defaults to the updated time. # Corresponds to the JSON property `displayTime` # @return [DateTime] attr_accessor :display_time # ETag for this item. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # HTML content for this item. If both text and html are provided for an item, # the html will be rendered in the timeline. # Allowed HTML elements - You can use these elements in your timeline cards. # # - Headers: h1, h2, h3, h4, h5, h6 # - Images: img # - Lists: li, ol, ul # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, # nav, section, summary, time # - Structural: blockquote, br, div, hr, p, span # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup # - Tables: table, tbody, td, tfoot, th, thead, tr # Blocked HTML elements: These elements and their contents are removed from HTML # payloads. # # - Document headers: head, title # - Embeds: audio, embed, object, source, video # - Frames: frame, frameset # - Scripting: applet, script # Other elements: Any elements that aren't listed are removed, but their # contents are preserved. # Corresponds to the JSON property `html` # @return [String] attr_accessor :html # The ID of the timeline item. This is unique within a user's timeline. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # If this item was generated as a reply to another item, this field will be set # to the ID of the item being replied to. This can be used to attach a reply to # the appropriate conversation or post. # Corresponds to the JSON property `inReplyTo` # @return [String] attr_accessor :in_reply_to # Whether this item is a bundle cover. # If an item is marked as a bundle cover, it will be the entry point to the # bundle of items that have the same bundleId as that item. It will be shown # only on the main timeline — not within the opened bundle. # On the main timeline, items that are shown are: # - Items that have isBundleCover set to true # - Items that do not have a bundleId In a bundle sub-timeline, items that are # shown are: # - Items that have the bundleId in question AND isBundleCover set to false # Corresponds to the JSON property `isBundleCover` # @return [Boolean] attr_accessor :is_bundle_cover alias_method :is_bundle_cover?, :is_bundle_cover # When true, indicates this item is deleted, and only the ID property is set. # Corresponds to the JSON property `isDeleted` # @return [Boolean] attr_accessor :is_deleted alias_method :is_deleted?, :is_deleted # When true, indicates this item is pinned, which means it's grouped alongside " # active" items like navigation and hangouts, on the opposite side of the home # screen from historical (non-pinned) timeline items. You can allow the user to # toggle the value of this property with the TOGGLE_PINNED built-in menu item. # Corresponds to the JSON property `isPinned` # @return [Boolean] attr_accessor :is_pinned alias_method :is_pinned?, :is_pinned # The type of resource. This is always mirror#timelineItem. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A geographic location that can be associated with a timeline item. # Corresponds to the JSON property `location` # @return [Google::Apis::MirrorV1::Location] attr_accessor :location # A list of menu items that will be presented to the user when this item is # selected in the timeline. # Corresponds to the JSON property `menuItems` # @return [Array] attr_accessor :menu_items # Controls how notifications for a timeline item are presented to the user. # Corresponds to the JSON property `notification` # @return [Google::Apis::MirrorV1::NotificationConfig] attr_accessor :notification # For pinned items, this determines the order in which the item is displayed in # the timeline, with a higher score appearing closer to the clock. Note: setting # this field is currently not supported. # Corresponds to the JSON property `pinScore` # @return [Fixnum] attr_accessor :pin_score # A list of users or groups that this item has been shared with. # Corresponds to the JSON property `recipients` # @return [Array] attr_accessor :recipients # A URL that can be used to retrieve this item. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link # Opaque string you can use to map a timeline item to data in your own service. # Corresponds to the JSON property `sourceItemId` # @return [String] attr_accessor :source_item_id # The speakable version of the content of this item. Along with the READ_ALOUD # menu item, use this field to provide text that would be clearer when read # aloud, or to provide extended information to what is displayed visually on # Glass. # Glassware should also specify the speakableType field, which will be spoken # before this text in cases where the additional context is useful, for example # when the user requests that the item be read aloud following a notification. # Corresponds to the JSON property `speakableText` # @return [String] attr_accessor :speakable_text # A speakable description of the type of this item. This will be announced to # the user prior to reading the content of the item in cases where the # additional context is useful, for example when the user requests that the item # be read aloud following a notification. # This should be a short, simple noun phrase such as "Email", "Text message", or # "Daily Planet News Update". # Glassware are encouraged to populate this field for every timeline item, even # if the item does not contain speakableText or text so that the user can learn # the type of the item without looking at the screen. # Corresponds to the JSON property `speakableType` # @return [String] attr_accessor :speakable_type # Text content of this item. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text # The title of this item. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The time at which this item was last modified, formatted according to RFC 3339. # Corresponds to the JSON property `updated` # @return [DateTime] attr_accessor :updated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @attachments = args[:attachments] if args.key?(:attachments) @bundle_id = args[:bundle_id] if args.key?(:bundle_id) @canonical_url = args[:canonical_url] if args.key?(:canonical_url) @created = args[:created] if args.key?(:created) @creator = args[:creator] if args.key?(:creator) @display_time = args[:display_time] if args.key?(:display_time) @etag = args[:etag] if args.key?(:etag) @html = args[:html] if args.key?(:html) @id = args[:id] if args.key?(:id) @in_reply_to = args[:in_reply_to] if args.key?(:in_reply_to) @is_bundle_cover = args[:is_bundle_cover] if args.key?(:is_bundle_cover) @is_deleted = args[:is_deleted] if args.key?(:is_deleted) @is_pinned = args[:is_pinned] if args.key?(:is_pinned) @kind = args[:kind] if args.key?(:kind) @location = args[:location] if args.key?(:location) @menu_items = args[:menu_items] if args.key?(:menu_items) @notification = args[:notification] if args.key?(:notification) @pin_score = args[:pin_score] if args.key?(:pin_score) @recipients = args[:recipients] if args.key?(:recipients) @self_link = args[:self_link] if args.key?(:self_link) @source_item_id = args[:source_item_id] if args.key?(:source_item_id) @speakable_text = args[:speakable_text] if args.key?(:speakable_text) @speakable_type = args[:speakable_type] if args.key?(:speakable_type) @text = args[:text] if args.key?(:text) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) end end # A list of timeline items. This is the response from the server to GET requests # on the timeline collection. class ListTimelineResponse include Google::Apis::Core::Hashable # Items in the timeline. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The type of resource. This is always mirror#timeline. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The next page token. Provide this as the pageToken parameter in the request 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) @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) end end # Represents an action taken by the user that triggered a notification. class UserAction include Google::Apis::Core::Hashable # An optional payload for the action. # For actions of type CUSTOM, this is the ID of the custom menu item that was # selected. # Corresponds to the JSON property `payload` # @return [String] attr_accessor :payload # The type of action. The value of this can be: # - SHARE - the user shared an item. # - REPLY - the user replied to an item. # - REPLY_ALL - the user replied to all recipients of an item. # - CUSTOM - the user selected a custom menu item on the timeline item. # - DELETE - the user deleted the item. # - PIN - the user pinned the item. # - UNPIN - the user unpinned the item. # - LAUNCH - the user initiated a voice command. In the future, additional # types may be added. UserActions with unrecognized types should be ignored. # 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) @payload = args[:payload] if args.key?(:payload) @type = args[:type] if args.key?(:type) end end # class UserData include Google::Apis::Core::Hashable # # Corresponds to the JSON property `key` # @return [String] attr_accessor :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 end google-api-client-0.19.8/generated/google/apis/mirror_v1/service.rb0000644000004100000410000015553613252673044025240 0ustar www-datawww-data# 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 MirrorV1 # Google Mirror API # # Interacts with Glass users via the timeline. # # @example # require 'google/apis/mirror_v1' # # Mirror = Google::Apis::MirrorV1 # Alias the module # service = Mirror::MirrorService.new # # @see https://developers.google.com/glass class MirrorService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'mirror/v1/') @batch_path = 'batch/mirror/v1' end # Inserts a new account for a user # @param [String] user_token # The ID for the user. # @param [String] account_type # Account type to be passed to Android Account Manager. # @param [String] account_name # The name of the account to be passed to the Android Account Manager. # @param [Google::Apis::MirrorV1::Account] account_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(user_token, account_type, account_name, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/{userToken}/{accountType}/{accountName}', options) command.request_representation = Google::Apis::MirrorV1::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::MirrorV1::Account::Representation command.response_class = Google::Apis::MirrorV1::Account command.params['userToken'] = user_token unless user_token.nil? command.params['accountType'] = account_type unless account_type.nil? command.params['accountName'] = account_name unless account_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 # Deletes a contact. # @param [String] id # The ID of the contact. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_contact(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'contacts/{id}', options) command.params['id'] = id unless 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 single contact by ID. # @param [String] id # The ID of the contact. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::Contact] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Contact] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_contact(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'contacts/{id}', options) command.response_representation = Google::Apis::MirrorV1::Contact::Representation command.response_class = Google::Apis::MirrorV1::Contact command.params['id'] = id unless 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 # Inserts a new contact. # @param [Google::Apis::MirrorV1::Contact] contact_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::Contact] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Contact] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_contact(contact_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'contacts', options) command.request_representation = Google::Apis::MirrorV1::Contact::Representation command.request_object = contact_object command.response_representation = Google::Apis::MirrorV1::Contact::Representation command.response_class = Google::Apis::MirrorV1::Contact 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 contacts for the authenticated user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::ListContactsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::ListContactsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_contacts(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'contacts', options) command.response_representation = Google::Apis::MirrorV1::ListContactsResponse::Representation command.response_class = Google::Apis::MirrorV1::ListContactsResponse 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 a contact in place. This method supports patch semantics. # @param [String] id # The ID of the contact. # @param [Google::Apis::MirrorV1::Contact] contact_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::Contact] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Contact] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_contact(id, contact_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'contacts/{id}', options) command.request_representation = Google::Apis::MirrorV1::Contact::Representation command.request_object = contact_object command.response_representation = Google::Apis::MirrorV1::Contact::Representation command.response_class = Google::Apis::MirrorV1::Contact command.params['id'] = id unless 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 a contact in place. # @param [String] id # The ID of the contact. # @param [Google::Apis::MirrorV1::Contact] contact_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::Contact] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Contact] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_contact(id, contact_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'contacts/{id}', options) command.request_representation = Google::Apis::MirrorV1::Contact::Representation command.request_object = contact_object command.response_representation = Google::Apis::MirrorV1::Contact::Representation command.response_class = Google::Apis::MirrorV1::Contact command.params['id'] = id unless 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 single location by ID. # @param [String] id # The ID of the location or latest for the last known location. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::Location] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Location] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_location(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'locations/{id}', options) command.response_representation = Google::Apis::MirrorV1::Location::Representation command.response_class = Google::Apis::MirrorV1::Location command.params['id'] = id unless 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 locations for the user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::ListLocationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::ListLocationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_locations(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'locations', options) command.response_representation = Google::Apis::MirrorV1::ListLocationsResponse::Representation command.response_class = Google::Apis::MirrorV1::ListLocationsResponse 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 single setting by ID. # @param [String] id # The ID of the setting. The following IDs are valid: # - locale - The key to the user’s language/locale (BCP 47 identifier) that # Glassware should use to render localized content. # - timezone - The key to the user’s current time zone region as defined in the # tz database. Example: America/Los_Angeles. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::Setting] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Setting] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_setting(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'settings/{id}', options) command.response_representation = Google::Apis::MirrorV1::Setting::Representation command.response_class = Google::Apis::MirrorV1::Setting command.params['id'] = id unless 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 a subscription. # @param [String] id # The ID of the subscription. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_subscription(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'subscriptions/{id}', options) command.params['id'] = id unless 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 subscription. # @param [Google::Apis::MirrorV1::Subscription] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::Subscription] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Subscription] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subscription(subscription_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'subscriptions', options) command.request_representation = Google::Apis::MirrorV1::Subscription::Representation command.request_object = subscription_object command.response_representation = Google::Apis::MirrorV1::Subscription::Representation command.response_class = Google::Apis::MirrorV1::Subscription 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 subscriptions for the authenticated user and service. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::ListSubscriptionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::ListSubscriptionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subscriptions(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'subscriptions', options) command.response_representation = Google::Apis::MirrorV1::ListSubscriptionsResponse::Representation command.response_class = Google::Apis::MirrorV1::ListSubscriptionsResponse 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 subscription in place. # @param [String] id # The ID of the subscription. # @param [Google::Apis::MirrorV1::Subscription] 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::Subscription] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Subscription] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_subscription(id, subscription_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'subscriptions/{id}', options) command.request_representation = Google::Apis::MirrorV1::Subscription::Representation command.request_object = subscription_object command.response_representation = Google::Apis::MirrorV1::Subscription::Representation command.response_class = Google::Apis::MirrorV1::Subscription command.params['id'] = id unless 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 a timeline item. # @param [String] id # The ID of the timeline item. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_timeline(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'timeline/{id}', options) command.params['id'] = id unless 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 single timeline item by ID. # @param [String] id # The ID of the timeline item. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::TimelineItem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::TimelineItem] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_timeline(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'timeline/{id}', options) command.response_representation = Google::Apis::MirrorV1::TimelineItem::Representation command.response_class = Google::Apis::MirrorV1::TimelineItem command.params['id'] = id unless 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 # Inserts a new item into the timeline. # @param [Google::Apis::MirrorV1::TimelineItem] timeline_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::MirrorV1::TimelineItem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::TimelineItem] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_timeline(timeline_item_object = 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, 'timeline', options) else command = make_upload_command(:post, 'timeline', options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::MirrorV1::TimelineItem::Representation command.request_object = timeline_item_object command.response_representation = Google::Apis::MirrorV1::TimelineItem::Representation command.response_class = Google::Apis::MirrorV1::TimelineItem 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 timeline items for the authenticated user. # @param [String] bundle_id # If provided, only items with the given bundleId will be returned. # @param [Boolean] include_deleted # If true, tombstone records for deleted items will be returned. # @param [Fixnum] max_results # The maximum number of items to include in the response, used for paging. # @param [String] order_by # Controls the order in which timeline items are returned. # @param [String] page_token # Token for the page of results to return. # @param [Boolean] pinned_only # If true, only pinned items will be returned. # @param [String] source_item_id # If provided, only items with the given sourceItemId 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::ListTimelineResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::ListTimelineResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_timelines(bundle_id: nil, include_deleted: nil, max_results: nil, order_by: nil, page_token: nil, pinned_only: nil, source_item_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'timeline', options) command.response_representation = Google::Apis::MirrorV1::ListTimelineResponse::Representation command.response_class = Google::Apis::MirrorV1::ListTimelineResponse command.query['bundleId'] = bundle_id unless bundle_id.nil? command.query['includeDeleted'] = include_deleted unless include_deleted.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['pinnedOnly'] = pinned_only unless pinned_only.nil? command.query['sourceItemId'] = source_item_id unless source_item_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 a timeline item in place. This method supports patch semantics. # @param [String] id # The ID of the timeline item. # @param [Google::Apis::MirrorV1::TimelineItem] timeline_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::TimelineItem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::TimelineItem] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_timeline(id, timeline_item_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'timeline/{id}', options) command.request_representation = Google::Apis::MirrorV1::TimelineItem::Representation command.request_object = timeline_item_object command.response_representation = Google::Apis::MirrorV1::TimelineItem::Representation command.response_class = Google::Apis::MirrorV1::TimelineItem command.params['id'] = id unless 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 a timeline item in place. # @param [String] id # The ID of the timeline item. # @param [Google::Apis::MirrorV1::TimelineItem] timeline_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::MirrorV1::TimelineItem] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::TimelineItem] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_timeline(id, timeline_item_object = 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(:put, 'timeline/{id}', options) else command = make_upload_command(:put, 'timeline/{id}', options) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::MirrorV1::TimelineItem::Representation command.request_object = timeline_item_object command.response_representation = Google::Apis::MirrorV1::TimelineItem::Representation command.response_class = Google::Apis::MirrorV1::TimelineItem command.params['id'] = id unless 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 attachment from a timeline item. # @param [String] item_id # The ID of the timeline item the attachment belongs to. # @param [String] attachment_id # The ID of the attachment. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_timeline_attachment(item_id, attachment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'timeline/{itemId}/attachments/{attachmentId}', options) command.params['itemId'] = item_id unless item_id.nil? command.params['attachmentId'] = attachment_id unless attachment_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 attachment on a timeline item by item ID and attachment ID. # @param [String] item_id # The ID of the timeline item the attachment belongs to. # @param [String] attachment_id # The ID of the attachment. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [IO, String] download_dest # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::Attachment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Attachment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_timeline_attachment(item_id, attachment_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) if download_dest.nil? command = make_simple_command(:get, 'timeline/{itemId}/attachments/{attachmentId}', options) else command = make_download_command(:get, 'timeline/{itemId}/attachments/{attachmentId}', options) command.download_dest = download_dest end command.response_representation = Google::Apis::MirrorV1::Attachment::Representation command.response_class = Google::Apis::MirrorV1::Attachment command.params['itemId'] = item_id unless item_id.nil? command.params['attachmentId'] = attachment_id unless attachment_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 # Adds a new attachment to a timeline item. # @param [String] item_id # The ID of the timeline item the attachment belongs to. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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::MirrorV1::Attachment] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::Attachment] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_timeline_attachment(item_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, 'timeline/{itemId}/attachments', options) else command = make_upload_command(:post, 'timeline/{itemId}/attachments', options) command.upload_source = upload_source command.upload_content_type = content_type end command.response_representation = Google::Apis::MirrorV1::Attachment::Representation command.response_class = Google::Apis::MirrorV1::Attachment command.params['itemId'] = item_id unless item_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 a list of attachments for a timeline item. # @param [String] item_id # The ID of the timeline item whose attachments should be listed. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::MirrorV1::ListAttachmentsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::MirrorV1::ListAttachmentsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_timeline_attachments(item_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'timeline/{itemId}/attachments', options) command.response_representation = Google::Apis::MirrorV1::ListAttachmentsResponse::Representation command.response_class = Google::Apis::MirrorV1::ListAttachmentsResponse command.params['itemId'] = item_id unless item_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 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 end end google-api-client-0.19.8/generated/google/apis/cloudshell_v1/0000755000004100000410000000000013252673043024057 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/cloudshell_v1/representations.rb0000644000004100000410000001215313252673043027633 0ustar www-datawww-data# 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 CloudshellV1 class CancelOperationRequest 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 Environment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse 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 PublicKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StartEnvironmentMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class StartEnvironmentResponse 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 CancelOperationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Environment # @private class Representation < Google::Apis::Core::JsonRepresentation property :docker_image, as: 'dockerImage' property :id, as: 'id' property :name, as: 'name' collection :public_keys, as: 'publicKeys', class: Google::Apis::CloudshellV1::PublicKey, decorator: Google::Apis::CloudshellV1::PublicKey::Representation property :ssh_host, as: 'sshHost' property :ssh_port, as: 'sshPort' property :ssh_username, as: 'sshUsername' property :state, as: 'state' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::CloudshellV1::Operation, decorator: Google::Apis::CloudshellV1::Operation::Representation end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::CloudshellV1::Status, decorator: Google::Apis::CloudshellV1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class PublicKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :format, as: 'format' property :key, :base64 => true, as: 'key' property :name, as: 'name' end end class StartEnvironmentMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :state, as: 'state' end end class StartEnvironmentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :environment, as: 'environment', class: Google::Apis::CloudshellV1::Environment, decorator: Google::Apis::CloudshellV1::Environment::Representation 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 google-api-client-0.19.8/generated/google/apis/cloudshell_v1/classes.rb0000644000004100000410000004372413252673043026053 0ustar www-datawww-data# 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 CloudshellV1 # The request message for Operations.CancelOperation. class CancelOperationRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) 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 Cloud Shell environment, which is defined as the combination of a Docker # image specifying what is installed on the environment and a home directory # containing the user's data that will remain across sessions. Each user has a # single environment with the ID "default". class Environment include Google::Apis::Core::Hashable # Required. Full path to the Docker image used to run this environment, e.g. # "gcr.io/dev-con/cloud-devshell:latest". # Corresponds to the JSON property `dockerImage` # @return [String] attr_accessor :docker_image # Output only. The environment's identifier, which is always "default". # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Output only. Full name of this resource, in the format # `users/`owner_email`/environments/`environment_id``. ``owner_email`` is the # email address of the user to whom this environment belongs, and # ``environment_id`` is the identifier of this environment. For example, # `users/someone@example.com/environments/default`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. Public keys associated with the environment. Clients can # connect to this environment via SSH only if they possess a private key # corresponding to at least one of these public keys. Keys can be added to or # removed from the environment using the CreatePublicKey and DeletePublicKey # methods. # Corresponds to the JSON property `publicKeys` # @return [Array] attr_accessor :public_keys # Output only. Host to which clients can connect to initiate SSH sessions # with the environment. # Corresponds to the JSON property `sshHost` # @return [String] attr_accessor :ssh_host # Output only. Port to which clients can connect to initiate SSH sessions # with the environment. # Corresponds to the JSON property `sshPort` # @return [Fixnum] attr_accessor :ssh_port # Output only. Username that clients should use when initiating SSH sessions # with the environment. # Corresponds to the JSON property `sshUsername` # @return [String] attr_accessor :ssh_username # Output only. Current execution state of this environment. # 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) @docker_image = args[:docker_image] if args.key?(:docker_image) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @public_keys = args[:public_keys] if args.key?(:public_keys) @ssh_host = args[:ssh_host] if args.key?(:ssh_host) @ssh_port = args[:ssh_port] if args.key?(:ssh_port) @ssh_username = args[:ssh_username] if args.key?(:ssh_username) @state = args[:state] if args.key?(:state) end end # The response message for Operations.ListOperations. class ListOperationsResponse 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 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. # Corresponds to the JSON property `error` # @return [Google::Apis::CloudshellV1::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 have the format of `operations/some/unique/name`. # 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 public SSH key, corresponding to a private SSH key held by the client. class PublicKey include Google::Apis::Core::Hashable # Required. Format of this key's content. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # Required. Content of this key. # Corresponds to the JSON property `key` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :key # Output only. Full name of this resource, in the format # `users/`owner_email`/environments/`environment_id`/publicKeys/`key_id``. # ``owner_email`` is the email address of the user to whom the key belongs. # ``environment_id`` is the identifier of the environment to which the key # grants access. ``key_id`` is the unique identifier of the key. For example, # `users/someone@example.com/environments/default/publicKeys/myKey`. # 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) @format = args[:format] if args.key?(:format) @key = args[:key] if args.key?(:key) @name = args[:name] if args.key?(:name) end end # Message included in the metadata field of operations returned from # StartEnvironment. class StartEnvironmentMetadata include Google::Apis::Core::Hashable # Current state of the environment being started. # 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) @state = args[:state] if args.key?(:state) end end # Message included in the response field of operations returned from # StartEnvironment once the # operation is complete. class StartEnvironmentResponse include Google::Apis::Core::Hashable # A Cloud Shell environment, which is defined as the combination of a Docker # image specifying what is installed on the environment and a home directory # containing the user's data that will remain across sessions. Each user has a # single environment with the ID "default". # Corresponds to the JSON property `environment` # @return [Google::Apis::CloudshellV1::Environment] 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 # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` that can be used for common error conditions. # # Language mapping # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # Other uses # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # Example uses of this error model include: # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting. # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status 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 google-api-client-0.19.8/generated/google/apis/cloudshell_v1/service.rb0000644000004100000410000002652713252673043026060 0ustar www-datawww-data# 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 CloudshellV1 # Cloud Shell API # # Allows users to start, configure, and connect to interactive shell sessions # running in the cloud. # # @example # require 'google/apis/cloudshell_v1' # # Cloudshell = Google::Apis::CloudshellV1 # Alias the module # service = Cloudshell::CloudShellService.new # # @see https://cloud.google.com/shell/docs/ class CloudShellService < 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://cloudshell.googleapis.com/', '') @batch_path = 'batch' end # Starts asynchronous cancellation on a long-running operation. The server # makes a best effort to cancel the operation, but success is not # guaranteed. If the server doesn't support this method, it returns # `google.rpc.Code.UNIMPLEMENTED`. Clients can use # Operations.GetOperation or # other methods to check whether the cancellation succeeded or whether the # operation completed despite cancellation. On successful cancellation, # the operation is not deleted; instead, it becomes an operation with # an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. # @param [Google::Apis::CloudshellV1::CancelOperationRequest] cancel_operation_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::CloudshellV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudshellV1::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 cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.request_representation = Google::Apis::CloudshellV1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::CloudshellV1::Empty::Representation command.response_class = Google::Apis::CloudshellV1::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 # Deletes a long-running operation. This method indicates that the client is # no longer interested in the operation result. It does not cancel the # operation. If the server doesn't support this method, it returns # `google.rpc.Code.UNIMPLEMENTED`. # @param [String] name # The name of the operation resource 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::CloudshellV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudshellV1::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_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudshellV1::Empty::Representation command.response_class = Google::Apis::CloudshellV1::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 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::CloudshellV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudshellV1::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_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudshellV1::Operation::Representation command.response_class = Google::Apis::CloudshellV1::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 # 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::CloudshellV1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CloudshellV1::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_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}', options) command.response_representation = Google::Apis::CloudshellV1::ListOperationsResponse::Representation command.response_class = Google::Apis::CloudshellV1::ListOperationsResponse 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 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 google-api-client-0.19.8/generated/google/apis/taskqueue_v1beta1/0000755000004100000410000000000013252673044024646 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/taskqueue_v1beta1/representations.rb0000644000004100000410000001046213252673044030423 0ustar www-datawww-data# 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 TaskqueueV1beta1 class Task class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TaskQueue class Representation < Google::Apis::Core::JsonRepresentation; end class Acl class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Stats class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class Tasks class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Tasks2 class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Task # @private class Representation < Google::Apis::Core::JsonRepresentation property :enqueue_timestamp, :numeric_string => true, as: 'enqueueTimestamp' property :id, as: 'id' property :kind, as: 'kind' property :lease_timestamp, :numeric_string => true, as: 'leaseTimestamp' property :payload_base64, as: 'payloadBase64' property :queue_name, as: 'queueName' end end class TaskQueue # @private class Representation < Google::Apis::Core::JsonRepresentation property :acl, as: 'acl', class: Google::Apis::TaskqueueV1beta1::TaskQueue::Acl, decorator: Google::Apis::TaskqueueV1beta1::TaskQueue::Acl::Representation property :id, as: 'id' property :kind, as: 'kind' property :max_leases, as: 'maxLeases' property :stats, as: 'stats', class: Google::Apis::TaskqueueV1beta1::TaskQueue::Stats, decorator: Google::Apis::TaskqueueV1beta1::TaskQueue::Stats::Representation end class Acl # @private class Representation < Google::Apis::Core::JsonRepresentation collection :admin_emails, as: 'adminEmails' collection :consumer_emails, as: 'consumerEmails' collection :producer_emails, as: 'producerEmails' end end class Stats # @private class Representation < Google::Apis::Core::JsonRepresentation property :leased_last_hour, :numeric_string => true, as: 'leasedLastHour' property :leased_last_minute, :numeric_string => true, as: 'leasedLastMinute' property :oldest_task, :numeric_string => true, as: 'oldestTask' property :total_tasks, as: 'totalTasks' end end end class Tasks # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::TaskqueueV1beta1::Task, decorator: Google::Apis::TaskqueueV1beta1::Task::Representation property :kind, as: 'kind' end end class Tasks2 # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::TaskqueueV1beta1::Task, decorator: Google::Apis::TaskqueueV1beta1::Task::Representation property :kind, as: 'kind' end end end end end google-api-client-0.19.8/generated/google/apis/taskqueue_v1beta1/classes.rb0000644000004100000410000002076413252673044026641 0ustar www-datawww-data# 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 TaskqueueV1beta1 # class Task include Google::Apis::Core::Hashable # Time (in seconds since the epoch) at which the task was enqueued. # Corresponds to the JSON property `enqueueTimestamp` # @return [Fixnum] attr_accessor :enqueue_timestamp # Name of the task. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of object returned, in this case set to task. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Time (in seconds since the epoch) at which the task lease will expire. This # value is 0 if the task isnt currently leased out to a worker. # Corresponds to the JSON property `leaseTimestamp` # @return [Fixnum] attr_accessor :lease_timestamp # A bag of bytes which is the task payload. The payload on the JSON side is # always Base64 encoded. # Corresponds to the JSON property `payloadBase64` # @return [String] attr_accessor :payload_base64 # Name of the queue that the task is in. # Corresponds to the JSON property `queueName` # @return [String] attr_accessor :queue_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enqueue_timestamp = args[:enqueue_timestamp] if args.key?(:enqueue_timestamp) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @lease_timestamp = args[:lease_timestamp] if args.key?(:lease_timestamp) @payload_base64 = args[:payload_base64] if args.key?(:payload_base64) @queue_name = args[:queue_name] if args.key?(:queue_name) end end # class TaskQueue include Google::Apis::Core::Hashable # ACLs that are applicable to this TaskQueue object. # Corresponds to the JSON property `acl` # @return [Google::Apis::TaskqueueV1beta1::TaskQueue::Acl] attr_accessor :acl # Name of the taskqueue. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The kind of REST object returned, in this case taskqueue. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The number of times we should lease out tasks before giving up on them. If # unset we lease them out forever until a worker deletes the task. # Corresponds to the JSON property `maxLeases` # @return [Fixnum] attr_accessor :max_leases # Statistics for the TaskQueue object in question. # Corresponds to the JSON property `stats` # @return [Google::Apis::TaskqueueV1beta1::TaskQueue::Stats] attr_accessor :stats def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @acl = args[:acl] if args.key?(:acl) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @max_leases = args[:max_leases] if args.key?(:max_leases) @stats = args[:stats] if args.key?(:stats) end # ACLs that are applicable to this TaskQueue object. class Acl include Google::Apis::Core::Hashable # Email addresses of users who are "admins" of the TaskQueue. This means they # can control the queue, eg set ACLs for the queue. # Corresponds to the JSON property `adminEmails` # @return [Array] attr_accessor :admin_emails # Email addresses of users who can "consume" tasks from the TaskQueue. This # means they can Dequeue and Delete tasks from the queue. # Corresponds to the JSON property `consumerEmails` # @return [Array] attr_accessor :consumer_emails # Email addresses of users who can "produce" tasks into the TaskQueue. This # means they can Insert tasks into the queue. # Corresponds to the JSON property `producerEmails` # @return [Array] attr_accessor :producer_emails def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @admin_emails = args[:admin_emails] if args.key?(:admin_emails) @consumer_emails = args[:consumer_emails] if args.key?(:consumer_emails) @producer_emails = args[:producer_emails] if args.key?(:producer_emails) end end # Statistics for the TaskQueue object in question. class Stats include Google::Apis::Core::Hashable # Number of tasks leased in the last hour. # Corresponds to the JSON property `leasedLastHour` # @return [Fixnum] attr_accessor :leased_last_hour # Number of tasks leased in the last minute. # Corresponds to the JSON property `leasedLastMinute` # @return [Fixnum] attr_accessor :leased_last_minute # The timestamp (in seconds since the epoch) of the oldest unfinished task. # Corresponds to the JSON property `oldestTask` # @return [Fixnum] attr_accessor :oldest_task # Number of tasks in the queue. # Corresponds to the JSON property `totalTasks` # @return [Fixnum] attr_accessor :total_tasks def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @leased_last_hour = args[:leased_last_hour] if args.key?(:leased_last_hour) @leased_last_minute = args[:leased_last_minute] if args.key?(:leased_last_minute) @oldest_task = args[:oldest_task] if args.key?(:oldest_task) @total_tasks = args[:total_tasks] if args.key?(:total_tasks) end end end # class Tasks include Google::Apis::Core::Hashable # The actual list of tasks returned as a result of the lease operation. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of object returned, a list of tasks. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end # class Tasks2 include Google::Apis::Core::Hashable # The actual list of tasks currently active in the TaskQueue. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # The kind of object returned, a list of tasks. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end end end end google-api-client-0.19.8/generated/google/apis/taskqueue_v1beta1/service.rb0000644000004100000410000003363113252673044026641 0ustar www-datawww-data# 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 TaskqueueV1beta1 # TaskQueue API # # Accesses a Google App Engine Pull Task Queue over REST. # # @example # require 'google/apis/taskqueue_v1beta1' # # Taskqueue = Google::Apis::TaskqueueV1beta1 # Alias the module # service = Taskqueue::TaskqueueService.new # # @see https://developers.google.com/appengine/docs/python/taskqueue/rest class TaskqueueService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'taskqueue/v1beta1/projects/') @batch_path = 'batch/taskqueue/v1beta1' end # Get detailed information about a TaskQueue. # @param [String] project # The project under which the queue lies. # @param [String] taskqueue # The id of the taskqueue to get the properties of. # @param [Boolean] get_stats # Whether to get stats. 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TaskqueueV1beta1::TaskQueue] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TaskqueueV1beta1::TaskQueue] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_taskqueue(project, taskqueue, get_stats: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/taskqueues/{taskqueue}', options) command.response_representation = Google::Apis::TaskqueueV1beta1::TaskQueue::Representation command.response_class = Google::Apis::TaskqueueV1beta1::TaskQueue command.params['project'] = project unless project.nil? command.params['taskqueue'] = taskqueue unless taskqueue.nil? command.query['getStats'] = get_stats unless get_stats.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 a task from a TaskQueue. # @param [String] project # The project under which the queue lies. # @param [String] taskqueue # The taskqueue to delete a task from. # @param [String] task # The id of the task 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_task(project, taskqueue, task, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/taskqueues/{taskqueue}/tasks/{task}', options) command.params['project'] = project unless project.nil? command.params['taskqueue'] = taskqueue unless taskqueue.nil? command.params['task'] = task unless task.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 # Get a particular task from a TaskQueue. # @param [String] project # The project under which the queue lies. # @param [String] taskqueue # The taskqueue in which the task belongs. # @param [String] task # The task to get properties 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TaskqueueV1beta1::Task] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TaskqueueV1beta1::Task] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_task(project, taskqueue, task, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/taskqueues/{taskqueue}/tasks/{task}', options) command.response_representation = Google::Apis::TaskqueueV1beta1::Task::Representation command.response_class = Google::Apis::TaskqueueV1beta1::Task command.params['project'] = project unless project.nil? command.params['taskqueue'] = taskqueue unless taskqueue.nil? command.params['task'] = task unless task.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 # Lease 1 or more tasks from a TaskQueue. # @param [String] project # The project under which the queue lies. # @param [String] taskqueue # The taskqueue to lease a task from. # @param [Fixnum] num_tasks # The number of tasks to lease. # @param [Fixnum] lease_secs # The lease in seconds. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TaskqueueV1beta1::Tasks] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TaskqueueV1beta1::Tasks] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def lease_task(project, taskqueue, num_tasks, lease_secs, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/taskqueues/{taskqueue}/tasks/lease', options) command.response_representation = Google::Apis::TaskqueueV1beta1::Tasks::Representation command.response_class = Google::Apis::TaskqueueV1beta1::Tasks command.params['project'] = project unless project.nil? command.params['taskqueue'] = taskqueue unless taskqueue.nil? command.query['leaseSecs'] = lease_secs unless lease_secs.nil? command.query['numTasks'] = num_tasks unless num_tasks.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 Tasks in a TaskQueue # @param [String] project # The project under which the queue lies. # @param [String] taskqueue # The id of the taskqueue to list tasks 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::TaskqueueV1beta1::Tasks2] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TaskqueueV1beta1::Tasks2] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_tasks(project, taskqueue, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/taskqueues/{taskqueue}/tasks', options) command.response_representation = Google::Apis::TaskqueueV1beta1::Tasks2::Representation command.response_class = Google::Apis::TaskqueueV1beta1::Tasks2 command.params['project'] = project unless project.nil? command.params['taskqueue'] = taskqueue unless taskqueue.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 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 end end google-api-client-0.19.8/generated/google/apis/webfonts_v1/0000755000004100000410000000000013252673044023551 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/webfonts_v1/representations.rb0000644000004100000410000000371613252673044027332 0ustar www-datawww-data# 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 WebfontsV1 class Webfont class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WebfontList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Webfont # @private class Representation < Google::Apis::Core::JsonRepresentation property :category, as: 'category' property :family, as: 'family' hash :files, as: 'files' property :kind, as: 'kind' property :last_modified, as: 'lastModified', type: Date collection :subsets, as: 'subsets' collection :variants, as: 'variants' property :version, as: 'version' end end class WebfontList # @private class Representation < Google::Apis::Core::JsonRepresentation collection :items, as: 'items', class: Google::Apis::WebfontsV1::Webfont, decorator: Google::Apis::WebfontsV1::Webfont::Representation property :kind, as: 'kind' end end end end end google-api-client-0.19.8/generated/google/apis/webfonts_v1/classes.rb0000644000004100000410000000726713252673044025547 0ustar www-datawww-data# 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 WebfontsV1 # class Webfont include Google::Apis::Core::Hashable # The category of the font. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category # The name of the font. # Corresponds to the JSON property `family` # @return [String] attr_accessor :family # The font files (with all supported scripts) for each one of the available # variants, as a key : value map. # Corresponds to the JSON property `files` # @return [Hash] attr_accessor :files # This kind represents a webfont object in the webfonts service. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The date (format "yyyy-MM-dd") the font was modified for the last time. # Corresponds to the JSON property `lastModified` # @return [Date] attr_accessor :last_modified # The scripts supported by the font. # Corresponds to the JSON property `subsets` # @return [Array] attr_accessor :subsets # The available variants for the font. # Corresponds to the JSON property `variants` # @return [Array] attr_accessor :variants # The font version. # 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) @category = args[:category] if args.key?(:category) @family = args[:family] if args.key?(:family) @files = args[:files] if args.key?(:files) @kind = args[:kind] if args.key?(:kind) @last_modified = args[:last_modified] if args.key?(:last_modified) @subsets = args[:subsets] if args.key?(:subsets) @variants = args[:variants] if args.key?(:variants) @version = args[:version] if args.key?(:version) end end # class WebfontList include Google::Apis::Core::Hashable # The list of fonts currently served by the Google Fonts API. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # This kind represents a list of webfont objects in the webfonts service. # 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) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end end end end google-api-client-0.19.8/generated/google/apis/webfonts_v1/service.rb0000644000004100000410000001072613252673044025544 0ustar www-datawww-data# 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 WebfontsV1 # Google Fonts Developer API # # Accesses the metadata for all families served by Google Fonts, providing a # list of families currently available (including available styles and a list of # supported script subsets). # # @example # require 'google/apis/webfonts_v1' # # Webfonts = Google::Apis::WebfontsV1 # Alias the module # service = Webfonts::WebfontsService.new # # @see https://developers.google.com/fonts/docs/developer_api class WebfontsService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'webfonts/v1/') @batch_path = 'batch/webfonts/v1' end # Retrieves the list of fonts currently served by the Google Fonts Developer API # @param [String] sort # Enables sorting of 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::WebfontsV1::WebfontList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::WebfontsV1::WebfontList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_webfonts(sort: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'webfonts', options) command.response_representation = Google::Apis::WebfontsV1::WebfontList::Representation command.response_class = Google::Apis::WebfontsV1::WebfontList command.query['sort'] = sort unless sort.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 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 end end google-api-client-0.19.8/generated/google/apis/content_v2/0000755000004100000410000000000013252673043023374 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/content_v2/representations.rb0000644000004100000410000037525213252673043027164 0ustar www-datawww-data# 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 ContentV2 class Account class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountAdwordsLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountGoogleMyBusinessLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountIdentifier class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountStatusAccountLevelIssue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountStatusDataQualityIssue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountStatusExampleItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountTax class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountTaxTaxRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountUser class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountYouTubeChannelLink class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountsAuthInfoResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountsClaimWebsiteResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchAccountsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountsBatchRequestEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchAccountsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountsBatchResponseEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAccountsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchAccountStatusesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountStatusesBatchRequestEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchAccountStatusesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountStatusesBatchResponseEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAccountStatusesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchAccountTaxRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountTaxBatchRequestEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchAccountTaxResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccountTaxBatchResponseEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAccountTaxResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CarrierRate class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CarriersCarrier class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Datafeed class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatafeedFetchSchedule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatafeedFormat class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatafeedStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatafeedStatusError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatafeedStatusExample class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatafeedTarget class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchDatafeedsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatafeedsBatchRequestEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchDatafeedsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatafeedsBatchResponseEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDatafeedsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchDatafeedStatusesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatafeedStatusesBatchRequestEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchDatafeedStatusesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DatafeedStatusesBatchResponseEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListDatafeedStatusesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeliveryTime class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Errors class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Headers class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HolidayCutoff class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HolidaysHoliday class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Installment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Inventory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchInventoryRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InventoryBatchRequestEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchInventoryResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InventoryBatchResponseEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InventoryPickup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetInventoryRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetInventoryResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LocationIdSet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LoyaltyPoints class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Order class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderAddress class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderCancellation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderCustomer class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderDeliveryDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderLineItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderLineItemProduct class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderLineItemProductVariantAttribute class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderLineItemReturnInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderLineItemShippingDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderLineItemShippingDetailsMethod class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderMerchantProvidedAnnotation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderPaymentMethod class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderPromotion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderPromotionBenefit class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderRefund class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderReturn class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderShipment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrderShipmentLineItemShipment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersAcknowledgeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersAcknowledgeResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersAdvanceTestOrderResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCancelLineItemRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCancelLineItemResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCancelRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCancelResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCreateTestOrderRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCreateTestOrderResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryCancel class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryCancelLineItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryInStoreRefundLineItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryRefund class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryRejectReturnLineItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryReturnLineItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryReturnRefundLineItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntrySetLineItemMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryShipLineItems class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchRequestEntryUpdateShipment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersCustomBatchResponseEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersGetByMerchantOrderIdResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersGetTestOrderTemplateResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersInStoreRefundLineItemRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersInStoreRefundLineItemResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersRefundRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersRefundResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersRejectReturnLineItemRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersRejectReturnLineItemResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersReturnLineItemRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersReturnLineItemResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersReturnRefundLineItemRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersReturnRefundLineItemResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersSetLineItemMetadataRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersSetLineItemMetadataResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersShipLineItemsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersShipLineItemsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersUpdateLineItemShippingDetailsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersUpdateLineItemShippingDetailsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersUpdateMerchantOrderIdRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersUpdateMerchantOrderIdResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersUpdateShipmentRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OrdersUpdateShipmentResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PostalCodeGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PostalCodeRange 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 Product class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductAspect class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductCustomAttribute class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductCustomGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductDestination class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductShipping class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductShippingDimension class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductShippingWeight class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductStatusDataQualityIssue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductStatusDestinationStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductStatusItemLevelIssue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductTax class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductUnitPricingBaseMeasure class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductUnitPricingMeasure class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchProductsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductsBatchRequestEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchProductsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductsBatchResponseEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListProductsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchProductStatusesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductStatusesBatchRequestEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchProductStatusesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ProductStatusesBatchResponseEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListProductStatusesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RateGroup class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Row class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Service class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShippingSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShippingsettingsCustomBatchRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShippingsettingsCustomBatchRequestEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShippingsettingsCustomBatchResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShippingsettingsCustomBatchResponseEntry class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShippingsettingsGetSupportedCarriersResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShippingsettingsGetSupportedHolidaysResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ShippingsettingsListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Table class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestOrder class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestOrderCustomer class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestOrderLineItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestOrderLineItemProduct class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class TestOrderPaymentMethod class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Value class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Weight class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Account # @private class Representation < Google::Apis::Core::JsonRepresentation property :adult_content, as: 'adultContent' collection :adwords_links, as: 'adwordsLinks', class: Google::Apis::ContentV2::AccountAdwordsLink, decorator: Google::Apis::ContentV2::AccountAdwordsLink::Representation property :google_my_business_link, as: 'googleMyBusinessLink', class: Google::Apis::ContentV2::AccountGoogleMyBusinessLink, decorator: Google::Apis::ContentV2::AccountGoogleMyBusinessLink::Representation property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :reviews_url, as: 'reviewsUrl' property :seller_id, as: 'sellerId' collection :users, as: 'users', class: Google::Apis::ContentV2::AccountUser, decorator: Google::Apis::ContentV2::AccountUser::Representation property :website_url, as: 'websiteUrl' collection :youtube_channel_links, as: 'youtubeChannelLinks', class: Google::Apis::ContentV2::AccountYouTubeChannelLink, decorator: Google::Apis::ContentV2::AccountYouTubeChannelLink::Representation end end class AccountAdwordsLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :adwords_id, :numeric_string => true, as: 'adwordsId' property :status, as: 'status' end end class AccountGoogleMyBusinessLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :gmb_email, as: 'gmbEmail' property :status, as: 'status' end end class AccountIdentifier # @private class Representation < Google::Apis::Core::JsonRepresentation property :aggregator_id, :numeric_string => true, as: 'aggregatorId' property :merchant_id, :numeric_string => true, as: 'merchantId' end end class AccountStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, as: 'accountId' collection :account_level_issues, as: 'accountLevelIssues', class: Google::Apis::ContentV2::AccountStatusAccountLevelIssue, decorator: Google::Apis::ContentV2::AccountStatusAccountLevelIssue::Representation collection :data_quality_issues, as: 'dataQualityIssues', class: Google::Apis::ContentV2::AccountStatusDataQualityIssue, decorator: Google::Apis::ContentV2::AccountStatusDataQualityIssue::Representation property :kind, as: 'kind' property :website_claimed, as: 'websiteClaimed' end end class AccountStatusAccountLevelIssue # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' property :detail, as: 'detail' property :id, as: 'id' property :severity, as: 'severity' property :title, as: 'title' end end class AccountStatusDataQualityIssue # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' property :detail, as: 'detail' property :displayed_value, as: 'displayedValue' collection :example_items, as: 'exampleItems', class: Google::Apis::ContentV2::AccountStatusExampleItem, decorator: Google::Apis::ContentV2::AccountStatusExampleItem::Representation property :id, as: 'id' property :last_checked, as: 'lastChecked' property :location, as: 'location' property :num_items, as: 'numItems' property :severity, as: 'severity' property :submitted_value, as: 'submittedValue' end end class AccountStatusExampleItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :item_id, as: 'itemId' property :link, as: 'link' property :submitted_value, as: 'submittedValue' property :title, as: 'title' property :value_on_landing_page, as: 'valueOnLandingPage' end end class AccountTax # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :kind, as: 'kind' collection :rules, as: 'rules', class: Google::Apis::ContentV2::AccountTaxTaxRule, decorator: Google::Apis::ContentV2::AccountTaxTaxRule::Representation end end class AccountTaxTaxRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' property :location_id, :numeric_string => true, as: 'locationId' property :rate_percent, as: 'ratePercent' property :shipping_taxed, as: 'shippingTaxed' property :use_global_rate, as: 'useGlobalRate' end end class AccountUser # @private class Representation < Google::Apis::Core::JsonRepresentation property :admin, as: 'admin' property :email_address, as: 'emailAddress' end end class AccountYouTubeChannelLink # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :status, as: 'status' end end class AccountsAuthInfoResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :account_identifiers, as: 'accountIdentifiers', class: Google::Apis::ContentV2::AccountIdentifier, decorator: Google::Apis::ContentV2::AccountIdentifier::Representation property :kind, as: 'kind' end end class AccountsClaimWebsiteResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' end end class BatchAccountsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::AccountsBatchRequestEntry, decorator: Google::Apis::ContentV2::AccountsBatchRequestEntry::Representation end end class AccountsBatchRequestEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :account, as: 'account', class: Google::Apis::ContentV2::Account, decorator: Google::Apis::ContentV2::Account::Representation property :account_id, :numeric_string => true, as: 'accountId' property :batch_id, as: 'batchId' property :force, as: 'force' property :merchant_id, :numeric_string => true, as: 'merchantId' property :request_method, as: 'method' property :overwrite, as: 'overwrite' end end class BatchAccountsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::AccountsBatchResponseEntry, decorator: Google::Apis::ContentV2::AccountsBatchResponseEntry::Representation property :kind, as: 'kind' end end class AccountsBatchResponseEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :account, as: 'account', class: Google::Apis::ContentV2::Account, decorator: Google::Apis::ContentV2::Account::Representation property :batch_id, as: 'batchId' property :errors, as: 'errors', class: Google::Apis::ContentV2::Errors, decorator: Google::Apis::ContentV2::Errors::Representation property :kind, as: 'kind' end end class ListAccountsResponse # @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::Account, decorator: Google::Apis::ContentV2::Account::Representation end end class BatchAccountStatusesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::AccountStatusesBatchRequestEntry, decorator: Google::Apis::ContentV2::AccountStatusesBatchRequestEntry::Representation end end class AccountStatusesBatchRequestEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :batch_id, as: 'batchId' property :merchant_id, :numeric_string => true, as: 'merchantId' property :request_method, as: 'method' end end class BatchAccountStatusesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::AccountStatusesBatchResponseEntry, decorator: Google::Apis::ContentV2::AccountStatusesBatchResponseEntry::Representation property :kind, as: 'kind' end end class AccountStatusesBatchResponseEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_status, as: 'accountStatus', class: Google::Apis::ContentV2::AccountStatus, decorator: Google::Apis::ContentV2::AccountStatus::Representation property :batch_id, as: 'batchId' property :errors, as: 'errors', class: Google::Apis::ContentV2::Errors, decorator: Google::Apis::ContentV2::Errors::Representation end end class ListAccountStatusesResponse # @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::AccountStatus, decorator: Google::Apis::ContentV2::AccountStatus::Representation end end class BatchAccountTaxRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::AccountTaxBatchRequestEntry, decorator: Google::Apis::ContentV2::AccountTaxBatchRequestEntry::Representation end end class AccountTaxBatchRequestEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :account_tax, as: 'accountTax', class: Google::Apis::ContentV2::AccountTax, decorator: Google::Apis::ContentV2::AccountTax::Representation property :batch_id, as: 'batchId' property :merchant_id, :numeric_string => true, as: 'merchantId' property :request_method, as: 'method' end end class BatchAccountTaxResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::AccountTaxBatchResponseEntry, decorator: Google::Apis::ContentV2::AccountTaxBatchResponseEntry::Representation property :kind, as: 'kind' end end class AccountTaxBatchResponseEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_tax, as: 'accountTax', class: Google::Apis::ContentV2::AccountTax, decorator: Google::Apis::ContentV2::AccountTax::Representation property :batch_id, as: 'batchId' property :errors, as: 'errors', class: Google::Apis::ContentV2::Errors, decorator: Google::Apis::ContentV2::Errors::Representation property :kind, as: 'kind' end end class ListAccountTaxResponse # @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::AccountTax, decorator: Google::Apis::ContentV2::AccountTax::Representation end end class CarrierRate # @private class Representation < Google::Apis::Core::JsonRepresentation property :carrier_name, as: 'carrierName' property :carrier_service, as: 'carrierService' property :flat_adjustment, as: 'flatAdjustment', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :name, as: 'name' property :origin_postal_code, as: 'originPostalCode' property :percentage_adjustment, as: 'percentageAdjustment' end end class CarriersCarrier # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' property :name, as: 'name' collection :services, as: 'services' end end class Datafeed # @private class Representation < Google::Apis::Core::JsonRepresentation property :attribute_language, as: 'attributeLanguage' property :content_language, as: 'contentLanguage' property :content_type, as: 'contentType' property :fetch_schedule, as: 'fetchSchedule', class: Google::Apis::ContentV2::DatafeedFetchSchedule, decorator: Google::Apis::ContentV2::DatafeedFetchSchedule::Representation property :file_name, as: 'fileName' property :format, as: 'format', class: Google::Apis::ContentV2::DatafeedFormat, decorator: Google::Apis::ContentV2::DatafeedFormat::Representation property :id, :numeric_string => true, as: 'id' collection :intended_destinations, as: 'intendedDestinations' property :kind, as: 'kind' property :name, as: 'name' property :target_country, as: 'targetCountry' collection :targets, as: 'targets', class: Google::Apis::ContentV2::DatafeedTarget, decorator: Google::Apis::ContentV2::DatafeedTarget::Representation end end class DatafeedFetchSchedule # @private class Representation < Google::Apis::Core::JsonRepresentation property :day_of_month, as: 'dayOfMonth' property :fetch_url, as: 'fetchUrl' property :hour, as: 'hour' property :minute_of_hour, as: 'minuteOfHour' property :password, as: 'password' property :paused, as: 'paused' property :time_zone, as: 'timeZone' property :username, as: 'username' property :weekday, as: 'weekday' end end class DatafeedFormat # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_delimiter, as: 'columnDelimiter' property :file_encoding, as: 'fileEncoding' property :quoting_mode, as: 'quotingMode' end end class DatafeedStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' property :datafeed_id, :numeric_string => true, as: 'datafeedId' collection :errors, as: 'errors', class: Google::Apis::ContentV2::DatafeedStatusError, decorator: Google::Apis::ContentV2::DatafeedStatusError::Representation property :items_total, :numeric_string => true, as: 'itemsTotal' property :items_valid, :numeric_string => true, as: 'itemsValid' property :kind, as: 'kind' property :language, as: 'language' property :last_upload_date, as: 'lastUploadDate' property :processing_status, as: 'processingStatus' collection :warnings, as: 'warnings', class: Google::Apis::ContentV2::DatafeedStatusError, decorator: Google::Apis::ContentV2::DatafeedStatusError::Representation end end class DatafeedStatusError # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :count, :numeric_string => true, as: 'count' collection :examples, as: 'examples', class: Google::Apis::ContentV2::DatafeedStatusExample, decorator: Google::Apis::ContentV2::DatafeedStatusExample::Representation property :message, as: 'message' end end class DatafeedStatusExample # @private class Representation < Google::Apis::Core::JsonRepresentation property :item_id, as: 'itemId' property :line_number, :numeric_string => true, as: 'lineNumber' property :value, as: 'value' end end class DatafeedTarget # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' collection :excluded_destinations, as: 'excludedDestinations' collection :included_destinations, as: 'includedDestinations' property :language, as: 'language' end end class BatchDatafeedsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::DatafeedsBatchRequestEntry, decorator: Google::Apis::ContentV2::DatafeedsBatchRequestEntry::Representation end end class DatafeedsBatchRequestEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :datafeed, as: 'datafeed', class: Google::Apis::ContentV2::Datafeed, decorator: Google::Apis::ContentV2::Datafeed::Representation property :datafeed_id, :numeric_string => true, as: 'datafeedId' property :merchant_id, :numeric_string => true, as: 'merchantId' property :request_method, as: 'method' end end class BatchDatafeedsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::DatafeedsBatchResponseEntry, decorator: Google::Apis::ContentV2::DatafeedsBatchResponseEntry::Representation property :kind, as: 'kind' end end class DatafeedsBatchResponseEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :datafeed, as: 'datafeed', class: Google::Apis::ContentV2::Datafeed, decorator: Google::Apis::ContentV2::Datafeed::Representation property :errors, as: 'errors', class: Google::Apis::ContentV2::Errors, decorator: Google::Apis::ContentV2::Errors::Representation end end class ListDatafeedsResponse # @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::Datafeed, decorator: Google::Apis::ContentV2::Datafeed::Representation end end class BatchDatafeedStatusesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::DatafeedStatusesBatchRequestEntry, decorator: Google::Apis::ContentV2::DatafeedStatusesBatchRequestEntry::Representation end end class DatafeedStatusesBatchRequestEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :country, as: 'country' property :datafeed_id, :numeric_string => true, as: 'datafeedId' property :language, as: 'language' property :merchant_id, :numeric_string => true, as: 'merchantId' property :request_method, as: 'method' end end class BatchDatafeedStatusesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::DatafeedStatusesBatchResponseEntry, decorator: Google::Apis::ContentV2::DatafeedStatusesBatchResponseEntry::Representation property :kind, as: 'kind' end end class DatafeedStatusesBatchResponseEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :datafeed_status, as: 'datafeedStatus', class: Google::Apis::ContentV2::DatafeedStatus, decorator: Google::Apis::ContentV2::DatafeedStatus::Representation property :errors, as: 'errors', class: Google::Apis::ContentV2::Errors, decorator: Google::Apis::ContentV2::Errors::Representation end end class ListDatafeedStatusesResponse # @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::DatafeedStatus, decorator: Google::Apis::ContentV2::DatafeedStatus::Representation end end class DeliveryTime # @private class Representation < Google::Apis::Core::JsonRepresentation collection :holiday_cutoffs, as: 'holidayCutoffs', class: Google::Apis::ContentV2::HolidayCutoff, decorator: Google::Apis::ContentV2::HolidayCutoff::Representation property :max_transit_time_in_days, as: 'maxTransitTimeInDays' property :min_transit_time_in_days, as: 'minTransitTimeInDays' end end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :domain, as: 'domain' property :message, as: 'message' property :reason, as: 'reason' end end class Errors # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :errors, as: 'errors', class: Google::Apis::ContentV2::Error, decorator: Google::Apis::ContentV2::Error::Representation property :message, as: 'message' end end class Headers # @private class Representation < Google::Apis::Core::JsonRepresentation collection :locations, as: 'locations', class: Google::Apis::ContentV2::LocationIdSet, decorator: Google::Apis::ContentV2::LocationIdSet::Representation collection :number_of_items, as: 'numberOfItems' collection :postal_code_group_names, as: 'postalCodeGroupNames' collection :prices, as: 'prices', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation collection :weights, as: 'weights', class: Google::Apis::ContentV2::Weight, decorator: Google::Apis::ContentV2::Weight::Representation end end class HolidayCutoff # @private class Representation < Google::Apis::Core::JsonRepresentation property :deadline_date, as: 'deadlineDate' property :deadline_hour, as: 'deadlineHour' property :deadline_timezone, as: 'deadlineTimezone' property :holiday_id, as: 'holidayId' property :visible_from_date, as: 'visibleFromDate' end end class HolidaysHoliday # @private class Representation < Google::Apis::Core::JsonRepresentation property :country_code, as: 'countryCode' property :date, as: 'date' property :delivery_guarantee_date, as: 'deliveryGuaranteeDate' property :delivery_guarantee_hour, :numeric_string => true, as: 'deliveryGuaranteeHour' property :id, as: 'id' property :type, as: 'type' end end class Installment # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :months, :numeric_string => true, as: 'months' end end class Inventory # @private class Representation < Google::Apis::Core::JsonRepresentation property :availability, as: 'availability' property :installment, as: 'installment', class: Google::Apis::ContentV2::Installment, decorator: Google::Apis::ContentV2::Installment::Representation property :kind, as: 'kind' property :loyalty_points, as: 'loyaltyPoints', class: Google::Apis::ContentV2::LoyaltyPoints, decorator: Google::Apis::ContentV2::LoyaltyPoints::Representation property :pickup, as: 'pickup', class: Google::Apis::ContentV2::InventoryPickup, decorator: Google::Apis::ContentV2::InventoryPickup::Representation property :price, as: 'price', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :quantity, as: 'quantity' property :sale_price, as: 'salePrice', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :sale_price_effective_date, as: 'salePriceEffectiveDate' property :sell_on_google_quantity, as: 'sellOnGoogleQuantity' end end class BatchInventoryRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::InventoryBatchRequestEntry, decorator: Google::Apis::ContentV2::InventoryBatchRequestEntry::Representation end end class InventoryBatchRequestEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :inventory, as: 'inventory', class: Google::Apis::ContentV2::Inventory, decorator: Google::Apis::ContentV2::Inventory::Representation property :merchant_id, :numeric_string => true, as: 'merchantId' property :product_id, as: 'productId' property :store_code, as: 'storeCode' end end class BatchInventoryResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::InventoryBatchResponseEntry, decorator: Google::Apis::ContentV2::InventoryBatchResponseEntry::Representation property :kind, as: 'kind' end end class InventoryBatchResponseEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :errors, as: 'errors', class: Google::Apis::ContentV2::Errors, decorator: Google::Apis::ContentV2::Errors::Representation property :kind, as: 'kind' end end class InventoryPickup # @private class Representation < Google::Apis::Core::JsonRepresentation property :pickup_method, as: 'pickupMethod' property :pickup_sla, as: 'pickupSla' end end class SetInventoryRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :availability, as: 'availability' property :installment, as: 'installment', class: Google::Apis::ContentV2::Installment, decorator: Google::Apis::ContentV2::Installment::Representation property :loyalty_points, as: 'loyaltyPoints', class: Google::Apis::ContentV2::LoyaltyPoints, decorator: Google::Apis::ContentV2::LoyaltyPoints::Representation property :pickup, as: 'pickup', class: Google::Apis::ContentV2::InventoryPickup, decorator: Google::Apis::ContentV2::InventoryPickup::Representation property :price, as: 'price', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :quantity, as: 'quantity' property :sale_price, as: 'salePrice', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :sale_price_effective_date, as: 'salePriceEffectiveDate' property :sell_on_google_quantity, as: 'sellOnGoogleQuantity' end end class SetInventoryResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' end end class LocationIdSet # @private class Representation < Google::Apis::Core::JsonRepresentation collection :location_ids, as: 'locationIds' end end class LoyaltyPoints # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :points_value, :numeric_string => true, as: 'pointsValue' property :ratio, as: 'ratio' end end class Order # @private class Representation < Google::Apis::Core::JsonRepresentation property :acknowledged, as: 'acknowledged' property :channel_type, as: 'channelType' property :customer, as: 'customer', class: Google::Apis::ContentV2::OrderCustomer, decorator: Google::Apis::ContentV2::OrderCustomer::Representation property :delivery_details, as: 'deliveryDetails', class: Google::Apis::ContentV2::OrderDeliveryDetails, decorator: Google::Apis::ContentV2::OrderDeliveryDetails::Representation property :id, as: 'id' property :kind, as: 'kind' collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2::OrderLineItem, decorator: Google::Apis::ContentV2::OrderLineItem::Representation property :merchant_id, :numeric_string => true, as: 'merchantId' property :merchant_order_id, as: 'merchantOrderId' property :net_amount, as: 'netAmount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :payment_method, as: 'paymentMethod', class: Google::Apis::ContentV2::OrderPaymentMethod, decorator: Google::Apis::ContentV2::OrderPaymentMethod::Representation property :payment_status, as: 'paymentStatus' property :placed_date, as: 'placedDate' collection :promotions, as: 'promotions', class: Google::Apis::ContentV2::OrderPromotion, decorator: Google::Apis::ContentV2::OrderPromotion::Representation collection :refunds, as: 'refunds', class: Google::Apis::ContentV2::OrderRefund, decorator: Google::Apis::ContentV2::OrderRefund::Representation collection :shipments, as: 'shipments', class: Google::Apis::ContentV2::OrderShipment, decorator: Google::Apis::ContentV2::OrderShipment::Representation property :shipping_cost, as: 'shippingCost', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :shipping_cost_tax, as: 'shippingCostTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :shipping_option, as: 'shippingOption' property :status, as: 'status' end end class OrderAddress # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' collection :full_address, as: 'fullAddress' property :is_post_office_box, as: 'isPostOfficeBox' property :locality, as: 'locality' property :postal_code, as: 'postalCode' property :recipient_name, as: 'recipientName' property :region, as: 'region' collection :street_address, as: 'streetAddress' end end class OrderCancellation # @private class Representation < Google::Apis::Core::JsonRepresentation property :actor, as: 'actor' property :creation_date, as: 'creationDate' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrderCustomer # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' property :explicit_marketing_preference, as: 'explicitMarketingPreference' property :full_name, as: 'fullName' end end class OrderDeliveryDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address', class: Google::Apis::ContentV2::OrderAddress, decorator: Google::Apis::ContentV2::OrderAddress::Representation property :phone_number, as: 'phoneNumber' end end class OrderLineItem # @private class Representation < Google::Apis::Core::JsonRepresentation collection :annotations, as: 'annotations', class: Google::Apis::ContentV2::OrderMerchantProvidedAnnotation, decorator: Google::Apis::ContentV2::OrderMerchantProvidedAnnotation::Representation collection :cancellations, as: 'cancellations', class: Google::Apis::ContentV2::OrderCancellation, decorator: Google::Apis::ContentV2::OrderCancellation::Representation property :id, as: 'id' property :price, as: 'price', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :product, as: 'product', class: Google::Apis::ContentV2::OrderLineItemProduct, decorator: Google::Apis::ContentV2::OrderLineItemProduct::Representation property :quantity_canceled, as: 'quantityCanceled' property :quantity_delivered, as: 'quantityDelivered' property :quantity_ordered, as: 'quantityOrdered' property :quantity_pending, as: 'quantityPending' property :quantity_returned, as: 'quantityReturned' property :quantity_shipped, as: 'quantityShipped' property :return_info, as: 'returnInfo', class: Google::Apis::ContentV2::OrderLineItemReturnInfo, decorator: Google::Apis::ContentV2::OrderLineItemReturnInfo::Representation collection :returns, as: 'returns', class: Google::Apis::ContentV2::OrderReturn, decorator: Google::Apis::ContentV2::OrderReturn::Representation property :shipping_details, as: 'shippingDetails', class: Google::Apis::ContentV2::OrderLineItemShippingDetails, decorator: Google::Apis::ContentV2::OrderLineItemShippingDetails::Representation property :tax, as: 'tax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation end end class OrderLineItemProduct # @private class Representation < Google::Apis::Core::JsonRepresentation property :brand, as: 'brand' property :channel, as: 'channel' property :condition, as: 'condition' property :content_language, as: 'contentLanguage' property :gtin, as: 'gtin' property :id, as: 'id' property :image_link, as: 'imageLink' property :item_group_id, as: 'itemGroupId' property :mpn, as: 'mpn' property :offer_id, as: 'offerId' property :price, as: 'price', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :shown_image, as: 'shownImage' property :target_country, as: 'targetCountry' property :title, as: 'title' collection :variant_attributes, as: 'variantAttributes', class: Google::Apis::ContentV2::OrderLineItemProductVariantAttribute, decorator: Google::Apis::ContentV2::OrderLineItemProductVariantAttribute::Representation end end class OrderLineItemProductVariantAttribute # @private class Representation < Google::Apis::Core::JsonRepresentation property :dimension, as: 'dimension' property :value, as: 'value' end end class OrderLineItemReturnInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :days_to_return, as: 'daysToReturn' property :is_returnable, as: 'isReturnable' property :policy_url, as: 'policyUrl' end end class OrderLineItemShippingDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :deliver_by_date, as: 'deliverByDate' property :method_prop, as: 'method', class: Google::Apis::ContentV2::OrderLineItemShippingDetailsMethod, decorator: Google::Apis::ContentV2::OrderLineItemShippingDetailsMethod::Representation property :ship_by_date, as: 'shipByDate' end end class OrderLineItemShippingDetailsMethod # @private class Representation < Google::Apis::Core::JsonRepresentation property :carrier, as: 'carrier' property :max_days_in_transit, as: 'maxDaysInTransit' property :method_name, as: 'methodName' property :min_days_in_transit, as: 'minDaysInTransit' end end class OrderMerchantProvidedAnnotation # @private class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key' property :value, as: 'value' end end class OrderPaymentMethod # @private class Representation < Google::Apis::Core::JsonRepresentation property :billing_address, as: 'billingAddress', class: Google::Apis::ContentV2::OrderAddress, decorator: Google::Apis::ContentV2::OrderAddress::Representation property :expiration_month, as: 'expirationMonth' property :expiration_year, as: 'expirationYear' property :last_four_digits, as: 'lastFourDigits' property :phone_number, as: 'phoneNumber' property :type, as: 'type' end end class OrderPromotion # @private class Representation < Google::Apis::Core::JsonRepresentation collection :benefits, as: 'benefits', class: Google::Apis::ContentV2::OrderPromotionBenefit, decorator: Google::Apis::ContentV2::OrderPromotionBenefit::Representation property :effective_dates, as: 'effectiveDates' property :generic_redemption_code, as: 'genericRedemptionCode' property :id, as: 'id' property :long_title, as: 'longTitle' property :product_applicability, as: 'productApplicability' property :redemption_channel, as: 'redemptionChannel' end end class OrderPromotionBenefit # @private class Representation < Google::Apis::Core::JsonRepresentation property :discount, as: 'discount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation collection :offer_ids, as: 'offerIds' property :sub_type, as: 'subType' property :tax_impact, as: 'taxImpact', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :type, as: 'type' end end class OrderRefund # @private class Representation < Google::Apis::Core::JsonRepresentation property :actor, as: 'actor' property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :creation_date, as: 'creationDate' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrderReturn # @private class Representation < Google::Apis::Core::JsonRepresentation property :actor, as: 'actor' property :creation_date, as: 'creationDate' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrderShipment # @private class Representation < Google::Apis::Core::JsonRepresentation property :carrier, as: 'carrier' property :creation_date, as: 'creationDate' property :delivery_date, as: 'deliveryDate' property :id, as: 'id' collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2::OrderShipmentLineItemShipment, decorator: Google::Apis::ContentV2::OrderShipmentLineItemShipment::Representation property :status, as: 'status' property :tracking_id, as: 'trackingId' end end class OrderShipmentLineItemShipment # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' property :product_id, as: 'productId' property :quantity, as: 'quantity' end end class OrdersAcknowledgeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :operation_id, as: 'operationId' end end class OrdersAcknowledgeResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersAdvanceTestOrderResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' end end class OrdersCancelLineItemRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersCancelLineItemResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersCancelRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :operation_id, as: 'operationId' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersCancelResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersCreateTestOrderRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :template_name, as: 'templateName' property :test_order, as: 'testOrder', class: Google::Apis::ContentV2::TestOrder, decorator: Google::Apis::ContentV2::TestOrder::Representation end end class OrdersCreateTestOrderResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :order_id, as: 'orderId' end end class OrdersCustomBatchRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntry, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntry::Representation end end class OrdersCustomBatchRequestEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :cancel, as: 'cancel', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancel, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancel::Representation property :cancel_line_item, as: 'cancelLineItem', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancelLineItem, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancelLineItem::Representation property :in_store_refund_line_item, as: 'inStoreRefundLineItem', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryInStoreRefundLineItem, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryInStoreRefundLineItem::Representation property :merchant_id, :numeric_string => true, as: 'merchantId' property :merchant_order_id, as: 'merchantOrderId' property :method_prop, as: 'method' property :operation_id, as: 'operationId' property :order_id, as: 'orderId' property :refund, as: 'refund', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryRefund, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryRefund::Representation property :reject_return_line_item, as: 'rejectReturnLineItem', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryRejectReturnLineItem, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryRejectReturnLineItem::Representation property :return_line_item, as: 'returnLineItem', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryReturnLineItem, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryReturnLineItem::Representation property :return_refund_line_item, as: 'returnRefundLineItem', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryReturnRefundLineItem, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryReturnRefundLineItem::Representation property :set_line_item_metadata, as: 'setLineItemMetadata', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntrySetLineItemMetadata, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntrySetLineItemMetadata::Representation property :ship_line_items, as: 'shipLineItems', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryShipLineItems, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryShipLineItems::Representation property :update_line_item_shipping_details, as: 'updateLineItemShippingDetails', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails::Representation property :update_shipment, as: 'updateShipment', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryUpdateShipment, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryUpdateShipment::Representation end end class OrdersCustomBatchRequestEntryCancel # @private class Representation < Google::Apis::Core::JsonRepresentation property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersCustomBatchRequestEntryCancelLineItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :line_item_id, as: 'lineItemId' property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersCustomBatchRequestEntryInStoreRefundLineItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :line_item_id, as: 'lineItemId' property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersCustomBatchRequestEntryRefund # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersCustomBatchRequestEntryRejectReturnLineItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersCustomBatchRequestEntryReturnLineItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersCustomBatchRequestEntryReturnRefundLineItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :line_item_id, as: 'lineItemId' property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersCustomBatchRequestEntrySetLineItemMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation collection :annotations, as: 'annotations', class: Google::Apis::ContentV2::OrderMerchantProvidedAnnotation, decorator: Google::Apis::ContentV2::OrderMerchantProvidedAnnotation::Representation property :line_item_id, as: 'lineItemId' property :product_id, as: 'productId' end end class OrdersCustomBatchRequestEntryShipLineItems # @private class Representation < Google::Apis::Core::JsonRepresentation property :carrier, as: 'carrier' collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2::OrderShipmentLineItemShipment, decorator: Google::Apis::ContentV2::OrderShipmentLineItemShipment::Representation property :shipment_id, as: 'shipmentId' collection :shipment_infos, as: 'shipmentInfos', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo::Representation property :tracking_id, as: 'trackingId' end end class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :carrier, as: 'carrier' property :shipment_id, as: 'shipmentId' property :tracking_id, as: 'trackingId' end end class OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :deliver_by_date, as: 'deliverByDate' property :line_item_id, as: 'lineItemId' property :product_id, as: 'productId' property :ship_by_date, as: 'shipByDate' end end class OrdersCustomBatchRequestEntryUpdateShipment # @private class Representation < Google::Apis::Core::JsonRepresentation property :carrier, as: 'carrier' property :shipment_id, as: 'shipmentId' property :status, as: 'status' property :tracking_id, as: 'trackingId' end end class OrdersCustomBatchResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::OrdersCustomBatchResponseEntry, decorator: Google::Apis::ContentV2::OrdersCustomBatchResponseEntry::Representation property :kind, as: 'kind' end end class OrdersCustomBatchResponseEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :errors, as: 'errors', class: Google::Apis::ContentV2::Errors, decorator: Google::Apis::ContentV2::Errors::Representation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' property :order, as: 'order', class: Google::Apis::ContentV2::Order, decorator: Google::Apis::ContentV2::Order::Representation end end class OrdersGetByMerchantOrderIdResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :order, as: 'order', class: Google::Apis::ContentV2::Order, decorator: Google::Apis::ContentV2::Order::Representation end end class OrdersGetTestOrderTemplateResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :template, as: 'template', class: Google::Apis::ContentV2::TestOrder, decorator: Google::Apis::ContentV2::TestOrder::Representation end end class OrdersInStoreRefundLineItemRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersInStoreRefundLineItemResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersListResponse # @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::Order, decorator: Google::Apis::ContentV2::Order::Representation end end class OrdersRefundRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :operation_id, as: 'operationId' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersRefundResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersRejectReturnLineItemRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersRejectReturnLineItemResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersReturnLineItemRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersReturnLineItemResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersReturnRefundLineItemRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' end end class OrdersReturnRefundLineItemResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersSetLineItemMetadataRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :annotations, as: 'annotations', class: Google::Apis::ContentV2::OrderMerchantProvidedAnnotation, decorator: Google::Apis::ContentV2::OrderMerchantProvidedAnnotation::Representation property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' property :product_id, as: 'productId' end end class OrdersSetLineItemMetadataResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersShipLineItemsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :carrier, as: 'carrier' collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2::OrderShipmentLineItemShipment, decorator: Google::Apis::ContentV2::OrderShipmentLineItemShipment::Representation property :operation_id, as: 'operationId' property :shipment_id, as: 'shipmentId' collection :shipment_infos, as: 'shipmentInfos', class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo, decorator: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo::Representation property :tracking_id, as: 'trackingId' end end class OrdersShipLineItemsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersUpdateLineItemShippingDetailsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :deliver_by_date, as: 'deliverByDate' property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' property :product_id, as: 'productId' property :ship_by_date, as: 'shipByDate' end end class OrdersUpdateLineItemShippingDetailsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersUpdateMerchantOrderIdRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :merchant_order_id, as: 'merchantOrderId' property :operation_id, as: 'operationId' end end class OrdersUpdateMerchantOrderIdResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class OrdersUpdateShipmentRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :carrier, as: 'carrier' property :operation_id, as: 'operationId' property :shipment_id, as: 'shipmentId' property :status, as: 'status' property :tracking_id, as: 'trackingId' end end class OrdersUpdateShipmentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :execution_status, as: 'executionStatus' property :kind, as: 'kind' end end class PostalCodeGroup # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' property :name, as: 'name' collection :postal_code_ranges, as: 'postalCodeRanges', class: Google::Apis::ContentV2::PostalCodeRange, decorator: Google::Apis::ContentV2::PostalCodeRange::Representation end end class PostalCodeRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :postal_code_range_begin, as: 'postalCodeRangeBegin' property :postal_code_range_end, as: 'postalCodeRangeEnd' end end class Price # @private class Representation < Google::Apis::Core::JsonRepresentation property :currency, as: 'currency' property :value, as: 'value' end end class Product # @private class Representation < Google::Apis::Core::JsonRepresentation collection :additional_image_links, as: 'additionalImageLinks' collection :additional_product_types, as: 'additionalProductTypes' property :adult, as: 'adult' property :adwords_grouping, as: 'adwordsGrouping' collection :adwords_labels, as: 'adwordsLabels' property :adwords_redirect, as: 'adwordsRedirect' property :age_group, as: 'ageGroup' collection :aspects, as: 'aspects', class: Google::Apis::ContentV2::ProductAspect, decorator: Google::Apis::ContentV2::ProductAspect::Representation property :availability, as: 'availability' property :availability_date, as: 'availabilityDate' property :brand, as: 'brand' property :channel, as: 'channel' property :color, as: 'color' property :condition, as: 'condition' property :content_language, as: 'contentLanguage' collection :custom_attributes, as: 'customAttributes', class: Google::Apis::ContentV2::ProductCustomAttribute, decorator: Google::Apis::ContentV2::ProductCustomAttribute::Representation collection :custom_groups, as: 'customGroups', class: Google::Apis::ContentV2::ProductCustomGroup, decorator: Google::Apis::ContentV2::ProductCustomGroup::Representation property :custom_label0, as: 'customLabel0' property :custom_label1, as: 'customLabel1' property :custom_label2, as: 'customLabel2' property :custom_label3, as: 'customLabel3' property :custom_label4, as: 'customLabel4' property :description, as: 'description' collection :destinations, as: 'destinations', class: Google::Apis::ContentV2::ProductDestination, decorator: Google::Apis::ContentV2::ProductDestination::Representation property :display_ads_id, as: 'displayAdsId' property :display_ads_link, as: 'displayAdsLink' collection :display_ads_similar_ids, as: 'displayAdsSimilarIds' property :display_ads_title, as: 'displayAdsTitle' property :display_ads_value, as: 'displayAdsValue' property :energy_efficiency_class, as: 'energyEfficiencyClass' property :expiration_date, as: 'expirationDate' property :gender, as: 'gender' property :google_product_category, as: 'googleProductCategory' property :gtin, as: 'gtin' property :id, as: 'id' property :identifier_exists, as: 'identifierExists' property :image_link, as: 'imageLink' property :installment, as: 'installment', class: Google::Apis::ContentV2::Installment, decorator: Google::Apis::ContentV2::Installment::Representation property :is_bundle, as: 'isBundle' property :item_group_id, as: 'itemGroupId' property :kind, as: 'kind' property :link, as: 'link' property :loyalty_points, as: 'loyaltyPoints', class: Google::Apis::ContentV2::LoyaltyPoints, decorator: Google::Apis::ContentV2::LoyaltyPoints::Representation property :material, as: 'material' property :max_handling_time, :numeric_string => true, as: 'maxHandlingTime' property :min_handling_time, :numeric_string => true, as: 'minHandlingTime' property :mobile_link, as: 'mobileLink' property :mpn, as: 'mpn' property :multipack, :numeric_string => true, as: 'multipack' property :offer_id, as: 'offerId' property :online_only, as: 'onlineOnly' property :pattern, as: 'pattern' property :price, as: 'price', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :product_type, as: 'productType' collection :promotion_ids, as: 'promotionIds' property :sale_price, as: 'salePrice', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :sale_price_effective_date, as: 'salePriceEffectiveDate' property :sell_on_google_quantity, :numeric_string => true, as: 'sellOnGoogleQuantity' collection :shipping, as: 'shipping', class: Google::Apis::ContentV2::ProductShipping, decorator: Google::Apis::ContentV2::ProductShipping::Representation property :shipping_height, as: 'shippingHeight', class: Google::Apis::ContentV2::ProductShippingDimension, decorator: Google::Apis::ContentV2::ProductShippingDimension::Representation property :shipping_label, as: 'shippingLabel' property :shipping_length, as: 'shippingLength', class: Google::Apis::ContentV2::ProductShippingDimension, decorator: Google::Apis::ContentV2::ProductShippingDimension::Representation property :shipping_weight, as: 'shippingWeight', class: Google::Apis::ContentV2::ProductShippingWeight, decorator: Google::Apis::ContentV2::ProductShippingWeight::Representation property :shipping_width, as: 'shippingWidth', class: Google::Apis::ContentV2::ProductShippingDimension, decorator: Google::Apis::ContentV2::ProductShippingDimension::Representation property :size_system, as: 'sizeSystem' property :size_type, as: 'sizeType' collection :sizes, as: 'sizes' property :target_country, as: 'targetCountry' collection :taxes, as: 'taxes', class: Google::Apis::ContentV2::ProductTax, decorator: Google::Apis::ContentV2::ProductTax::Representation property :title, as: 'title' property :unit_pricing_base_measure, as: 'unitPricingBaseMeasure', class: Google::Apis::ContentV2::ProductUnitPricingBaseMeasure, decorator: Google::Apis::ContentV2::ProductUnitPricingBaseMeasure::Representation property :unit_pricing_measure, as: 'unitPricingMeasure', class: Google::Apis::ContentV2::ProductUnitPricingMeasure, decorator: Google::Apis::ContentV2::ProductUnitPricingMeasure::Representation collection :validated_destinations, as: 'validatedDestinations' collection :warnings, as: 'warnings', class: Google::Apis::ContentV2::Error, decorator: Google::Apis::ContentV2::Error::Representation end end class ProductAspect # @private class Representation < Google::Apis::Core::JsonRepresentation property :aspect_name, as: 'aspectName' property :destination_name, as: 'destinationName' property :intention, as: 'intention' end end class ProductCustomAttribute # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :type, as: 'type' property :unit, as: 'unit' property :value, as: 'value' end end class ProductCustomGroup # @private class Representation < Google::Apis::Core::JsonRepresentation collection :attributes, as: 'attributes', class: Google::Apis::ContentV2::ProductCustomAttribute, decorator: Google::Apis::ContentV2::ProductCustomAttribute::Representation property :name, as: 'name' end end class ProductDestination # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination_name, as: 'destinationName' property :intention, as: 'intention' end end class ProductShipping # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' property :location_group_name, as: 'locationGroupName' property :location_id, :numeric_string => true, as: 'locationId' property :postal_code, as: 'postalCode' property :price, as: 'price', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :region, as: 'region' property :service, as: 'service' end end class ProductShippingDimension # @private class Representation < Google::Apis::Core::JsonRepresentation property :unit, as: 'unit' property :value, as: 'value' end end class ProductShippingWeight # @private class Representation < Google::Apis::Core::JsonRepresentation property :unit, as: 'unit' property :value, as: 'value' end end class ProductStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_date, as: 'creationDate' collection :data_quality_issues, as: 'dataQualityIssues', class: Google::Apis::ContentV2::ProductStatusDataQualityIssue, decorator: Google::Apis::ContentV2::ProductStatusDataQualityIssue::Representation collection :destination_statuses, as: 'destinationStatuses', class: Google::Apis::ContentV2::ProductStatusDestinationStatus, decorator: Google::Apis::ContentV2::ProductStatusDestinationStatus::Representation property :google_expiration_date, as: 'googleExpirationDate' collection :item_level_issues, as: 'itemLevelIssues', class: Google::Apis::ContentV2::ProductStatusItemLevelIssue, decorator: Google::Apis::ContentV2::ProductStatusItemLevelIssue::Representation property :kind, as: 'kind' property :last_update_date, as: 'lastUpdateDate' property :link, as: 'link' property :product, as: 'product', class: Google::Apis::ContentV2::Product, decorator: Google::Apis::ContentV2::Product::Representation property :product_id, as: 'productId' property :title, as: 'title' end end class ProductStatusDataQualityIssue # @private class Representation < Google::Apis::Core::JsonRepresentation property :detail, as: 'detail' property :fetch_status, as: 'fetchStatus' property :id, as: 'id' property :location, as: 'location' property :severity, as: 'severity' property :timestamp, as: 'timestamp' property :value_on_landing_page, as: 'valueOnLandingPage' property :value_provided, as: 'valueProvided' end end class ProductStatusDestinationStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :approval_pending, as: 'approvalPending' property :approval_status, as: 'approvalStatus' property :destination, as: 'destination' property :intention, as: 'intention' end end class ProductStatusItemLevelIssue # @private class Representation < Google::Apis::Core::JsonRepresentation property :attribute_name, as: 'attributeName' property :code, as: 'code' property :destination, as: 'destination' property :resolution, as: 'resolution' property :servability, as: 'servability' end end class ProductTax # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' property :location_id, :numeric_string => true, as: 'locationId' property :postal_code, as: 'postalCode' property :rate, as: 'rate' property :region, as: 'region' property :tax_ship, as: 'taxShip' end end class ProductUnitPricingBaseMeasure # @private class Representation < Google::Apis::Core::JsonRepresentation property :unit, as: 'unit' property :value, :numeric_string => true, as: 'value' end end class ProductUnitPricingMeasure # @private class Representation < Google::Apis::Core::JsonRepresentation property :unit, as: 'unit' property :value, as: 'value' end end class BatchProductsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::ProductsBatchRequestEntry, decorator: Google::Apis::ContentV2::ProductsBatchRequestEntry::Representation end end class ProductsBatchRequestEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :merchant_id, :numeric_string => true, as: 'merchantId' property :request_method, as: 'method' property :product, as: 'product', class: Google::Apis::ContentV2::Product, decorator: Google::Apis::ContentV2::Product::Representation property :product_id, as: 'productId' end end class BatchProductsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::ProductsBatchResponseEntry, decorator: Google::Apis::ContentV2::ProductsBatchResponseEntry::Representation property :kind, as: 'kind' end end class ProductsBatchResponseEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :errors, as: 'errors', class: Google::Apis::ContentV2::Errors, decorator: Google::Apis::ContentV2::Errors::Representation property :kind, as: 'kind' property :product, as: 'product', class: Google::Apis::ContentV2::Product, decorator: Google::Apis::ContentV2::Product::Representation end end class ListProductsResponse # @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::Product, decorator: Google::Apis::ContentV2::Product::Representation end end class BatchProductStatusesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::ProductStatusesBatchRequestEntry, decorator: Google::Apis::ContentV2::ProductStatusesBatchRequestEntry::Representation end end class ProductStatusesBatchRequestEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :include_attributes, as: 'includeAttributes' property :merchant_id, :numeric_string => true, as: 'merchantId' property :request_method, as: 'method' property :product_id, as: 'productId' end end class BatchProductStatusesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::ProductStatusesBatchResponseEntry, decorator: Google::Apis::ContentV2::ProductStatusesBatchResponseEntry::Representation property :kind, as: 'kind' end end class ProductStatusesBatchResponseEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :errors, as: 'errors', class: Google::Apis::ContentV2::Errors, decorator: Google::Apis::ContentV2::Errors::Representation property :kind, as: 'kind' property :product_status, as: 'productStatus', class: Google::Apis::ContentV2::ProductStatus, decorator: Google::Apis::ContentV2::ProductStatus::Representation end end class ListProductStatusesResponse # @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::ProductStatus, decorator: Google::Apis::ContentV2::ProductStatus::Representation end end class RateGroup # @private class Representation < Google::Apis::Core::JsonRepresentation collection :applicable_shipping_labels, as: 'applicableShippingLabels' collection :carrier_rates, as: 'carrierRates', class: Google::Apis::ContentV2::CarrierRate, decorator: Google::Apis::ContentV2::CarrierRate::Representation property :main_table, as: 'mainTable', class: Google::Apis::ContentV2::Table, decorator: Google::Apis::ContentV2::Table::Representation property :single_value, as: 'singleValue', class: Google::Apis::ContentV2::Value, decorator: Google::Apis::ContentV2::Value::Representation collection :subtables, as: 'subtables', class: Google::Apis::ContentV2::Table, decorator: Google::Apis::ContentV2::Table::Representation end end class Row # @private class Representation < Google::Apis::Core::JsonRepresentation collection :cells, as: 'cells', class: Google::Apis::ContentV2::Value, decorator: Google::Apis::ContentV2::Value::Representation end end class Service # @private class Representation < Google::Apis::Core::JsonRepresentation property :active, as: 'active' property :currency, as: 'currency' property :delivery_country, as: 'deliveryCountry' property :delivery_time, as: 'deliveryTime', class: Google::Apis::ContentV2::DeliveryTime, decorator: Google::Apis::ContentV2::DeliveryTime::Representation property :minimum_order_value, as: 'minimumOrderValue', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :name, as: 'name' collection :rate_groups, as: 'rateGroups', class: Google::Apis::ContentV2::RateGroup, decorator: Google::Apis::ContentV2::RateGroup::Representation end end class ShippingSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' collection :postal_code_groups, as: 'postalCodeGroups', class: Google::Apis::ContentV2::PostalCodeGroup, decorator: Google::Apis::ContentV2::PostalCodeGroup::Representation collection :services, as: 'services', class: Google::Apis::ContentV2::Service, decorator: Google::Apis::ContentV2::Service::Representation end end class ShippingsettingsCustomBatchRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::ShippingsettingsCustomBatchRequestEntry, decorator: Google::Apis::ContentV2::ShippingsettingsCustomBatchRequestEntry::Representation end end class ShippingsettingsCustomBatchRequestEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_id, :numeric_string => true, as: 'accountId' property :batch_id, as: 'batchId' property :merchant_id, :numeric_string => true, as: 'merchantId' property :method_prop, as: 'method' property :shipping_settings, as: 'shippingSettings', class: Google::Apis::ContentV2::ShippingSettings, decorator: Google::Apis::ContentV2::ShippingSettings::Representation end end class ShippingsettingsCustomBatchResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :entries, as: 'entries', class: Google::Apis::ContentV2::ShippingsettingsCustomBatchResponseEntry, decorator: Google::Apis::ContentV2::ShippingsettingsCustomBatchResponseEntry::Representation property :kind, as: 'kind' end end class ShippingsettingsCustomBatchResponseEntry # @private class Representation < Google::Apis::Core::JsonRepresentation property :batch_id, as: 'batchId' property :errors, as: 'errors', class: Google::Apis::ContentV2::Errors, decorator: Google::Apis::ContentV2::Errors::Representation property :kind, as: 'kind' property :shipping_settings, as: 'shippingSettings', class: Google::Apis::ContentV2::ShippingSettings, decorator: Google::Apis::ContentV2::ShippingSettings::Representation end end class ShippingsettingsGetSupportedCarriersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :carriers, as: 'carriers', class: Google::Apis::ContentV2::CarriersCarrier, decorator: Google::Apis::ContentV2::CarriersCarrier::Representation property :kind, as: 'kind' end end class ShippingsettingsGetSupportedHolidaysResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :holidays, as: 'holidays', class: Google::Apis::ContentV2::HolidaysHoliday, decorator: Google::Apis::ContentV2::HolidaysHoliday::Representation property :kind, as: 'kind' end end class ShippingsettingsListResponse # @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::ShippingSettings, decorator: Google::Apis::ContentV2::ShippingSettings::Representation end end class Table # @private class Representation < Google::Apis::Core::JsonRepresentation property :column_headers, as: 'columnHeaders', class: Google::Apis::ContentV2::Headers, decorator: Google::Apis::ContentV2::Headers::Representation property :name, as: 'name' property :row_headers, as: 'rowHeaders', class: Google::Apis::ContentV2::Headers, decorator: Google::Apis::ContentV2::Headers::Representation collection :rows, as: 'rows', class: Google::Apis::ContentV2::Row, decorator: Google::Apis::ContentV2::Row::Representation end end class TestOrder # @private class Representation < Google::Apis::Core::JsonRepresentation property :customer, as: 'customer', class: Google::Apis::ContentV2::TestOrderCustomer, decorator: Google::Apis::ContentV2::TestOrderCustomer::Representation property :kind, as: 'kind' collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2::TestOrderLineItem, decorator: Google::Apis::ContentV2::TestOrderLineItem::Representation property :notification_mode, as: 'notificationMode' property :payment_method, as: 'paymentMethod', class: Google::Apis::ContentV2::TestOrderPaymentMethod, decorator: Google::Apis::ContentV2::TestOrderPaymentMethod::Representation property :predefined_delivery_address, as: 'predefinedDeliveryAddress' collection :promotions, as: 'promotions', class: Google::Apis::ContentV2::OrderPromotion, decorator: Google::Apis::ContentV2::OrderPromotion::Representation property :shipping_cost, as: 'shippingCost', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :shipping_cost_tax, as: 'shippingCostTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :shipping_option, as: 'shippingOption' end end class TestOrderCustomer # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' property :explicit_marketing_preference, as: 'explicitMarketingPreference' property :full_name, as: 'fullName' end end class TestOrderLineItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :product, as: 'product', class: Google::Apis::ContentV2::TestOrderLineItemProduct, decorator: Google::Apis::ContentV2::TestOrderLineItemProduct::Representation property :quantity_ordered, as: 'quantityOrdered' property :return_info, as: 'returnInfo', class: Google::Apis::ContentV2::OrderLineItemReturnInfo, decorator: Google::Apis::ContentV2::OrderLineItemReturnInfo::Representation property :shipping_details, as: 'shippingDetails', class: Google::Apis::ContentV2::OrderLineItemShippingDetails, decorator: Google::Apis::ContentV2::OrderLineItemShippingDetails::Representation property :unit_tax, as: 'unitTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation end end class TestOrderLineItemProduct # @private class Representation < Google::Apis::Core::JsonRepresentation property :brand, as: 'brand' property :channel, as: 'channel' property :condition, as: 'condition' property :content_language, as: 'contentLanguage' property :gtin, as: 'gtin' property :image_link, as: 'imageLink' property :item_group_id, as: 'itemGroupId' property :mpn, as: 'mpn' property :offer_id, as: 'offerId' property :price, as: 'price', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :target_country, as: 'targetCountry' property :title, as: 'title' collection :variant_attributes, as: 'variantAttributes', class: Google::Apis::ContentV2::OrderLineItemProductVariantAttribute, decorator: Google::Apis::ContentV2::OrderLineItemProductVariantAttribute::Representation end end class TestOrderPaymentMethod # @private class Representation < Google::Apis::Core::JsonRepresentation property :expiration_month, as: 'expirationMonth' property :expiration_year, as: 'expirationYear' property :last_four_digits, as: 'lastFourDigits' property :predefined_billing_address, as: 'predefinedBillingAddress' property :type, as: 'type' end end class Value # @private class Representation < Google::Apis::Core::JsonRepresentation property :carrier_rate_name, as: 'carrierRateName' property :flat_rate, as: 'flatRate', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation property :no_shipping, as: 'noShipping' property :price_percentage, as: 'pricePercentage' property :subtable_name, as: 'subtableName' end end class Weight # @private class Representation < Google::Apis::Core::JsonRepresentation property :unit, as: 'unit' property :value, as: 'value' end end end end end google-api-client-0.19.8/generated/google/apis/content_v2/classes.rb0000644000004100000410000106351113252673043025365 0ustar www-datawww-data# 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 ContentV2 # Account data. class Account include Google::Apis::Core::Hashable # Indicates whether the merchant sells adult content. # Corresponds to the JSON property `adultContent` # @return [Boolean] attr_accessor :adult_content 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 # 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` # @return [Array] attr_accessor :adwords_links # The GMB account which is linked or in the process of being linked with the # Merchant Center accounnt. # Corresponds to the JSON property `googleMyBusinessLink` # @return [Google::Apis::ContentV2::AccountGoogleMyBusinessLink] attr_accessor :google_my_business_link # Merchant Center account ID. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "content# # account". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Display name for the account. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # URL for individual seller reviews, i.e., reviews for each child account. # Corresponds to the JSON property `reviewsUrl` # @return [String] attr_accessor :reviews_url # Client-specific, locally-unique, internal ID for the child account. # Corresponds to the JSON property `sellerId` # @return [String] attr_accessor :seller_id # Users with access to the account. Every account (except for subaccounts) must # have at least one admin user. # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users # The merchant's website. # Corresponds to the JSON property `websiteUrl` # @return [String] 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. # Corresponds to the JSON property `youtubeChannelLinks` # @return [Array] attr_accessor :youtube_channel_links def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @adult_content = args[:adult_content] if args.key?(:adult_content) @adwords_links = args[:adwords_links] if args.key?(:adwords_links) @google_my_business_link = args[:google_my_business_link] if args.key?(:google_my_business_link) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @reviews_url = args[:reviews_url] if args.key?(:reviews_url) @seller_id = args[:seller_id] if args.key?(:seller_id) @users = args[:users] if args.key?(:users) @website_url = args[:website_url] if args.key?(:website_url) @youtube_channel_links = args[:youtube_channel_links] if args.key?(:youtube_channel_links) end end # class AccountAdwordsLink include Google::Apis::Core::Hashable # Customer ID of the AdWords account. # Corresponds to the JSON property `adwordsId` # @return [Fixnum] attr_accessor :adwords_id # 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 # 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` # @return [String] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @adwords_id = args[:adwords_id] if args.key?(:adwords_id) @status = args[:status] if args.key?(:status) end end # class AccountGoogleMyBusinessLink include Google::Apis::Core::Hashable # The GMB email address. # Corresponds to the JSON property `gmbEmail` # @return [String] attr_accessor :gmb_email # Status of the link between this Merchant Center account and the GMB account. # 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) @gmb_email = args[:gmb_email] if args.key?(:gmb_email) @status = args[:status] if args.key?(:status) end end # class AccountIdentifier include Google::Apis::Core::Hashable # The aggregator ID, set for aggregators and subaccounts (in that case, it # represents the aggregator of the subaccount). # Corresponds to the JSON property `aggregatorId` # @return [Fixnum] attr_accessor :aggregator_id # The merchant account ID, set for individual accounts and subaccounts. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aggregator_id = args[:aggregator_id] if args.key?(:aggregator_id) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) end end # The status of an account, i.e., information about its products, which is # computed offline and not returned immediately at insertion time. class AccountStatus include Google::Apis::Core::Hashable # The ID of the account for which the status is reported. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id # A list of account level issues. # Corresponds to the JSON property `accountLevelIssues` # @return [Array] attr_accessor :account_level_issues # A list of data quality issues. # Corresponds to the JSON property `dataQualityIssues` # @return [Array] attr_accessor :data_quality_issues # Identifies what kind of resource this is. Value: the fixed string "content# # accountStatus". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Whether the account's website is claimed or not. # Corresponds to the JSON property `websiteClaimed` # @return [Boolean] attr_accessor :website_claimed alias_method :website_claimed?, :website_claimed def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @account_level_issues = args[:account_level_issues] if args.key?(:account_level_issues) @data_quality_issues = args[:data_quality_issues] if args.key?(:data_quality_issues) @kind = args[:kind] if args.key?(:kind) @website_claimed = args[:website_claimed] if args.key?(:website_claimed) end end # class AccountStatusAccountLevelIssue include Google::Apis::Core::Hashable # Country for which this issue is reported. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # Additional details about the issue. # Corresponds to the JSON property `detail` # @return [String] attr_accessor :detail # Issue identifier. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Severity of the issue. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity # Short description of the issue. # 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) @country = args[:country] if args.key?(:country) @detail = args[:detail] if args.key?(:detail) @id = args[:id] if args.key?(:id) @severity = args[:severity] if args.key?(:severity) @title = args[:title] if args.key?(:title) end end # class AccountStatusDataQualityIssue include Google::Apis::Core::Hashable # Country for which this issue is reported. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # A more detailed description of the issue. # Corresponds to the JSON property `detail` # @return [String] attr_accessor :detail # Actual value displayed on the landing page. # Corresponds to the JSON property `displayedValue` # @return [String] attr_accessor :displayed_value # Example items featuring the issue. # Corresponds to the JSON property `exampleItems` # @return [Array] attr_accessor :example_items # Issue identifier. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Last time the account was checked for this issue. # Corresponds to the JSON property `lastChecked` # @return [String] attr_accessor :last_checked # The attribute name that is relevant for the issue. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # Number of items in the account found to have the said issue. # Corresponds to the JSON property `numItems` # @return [Fixnum] attr_accessor :num_items # Severity of the problem. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity # Submitted value that causes the issue. # Corresponds to the JSON property `submittedValue` # @return [String] attr_accessor :submitted_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country = args[:country] if args.key?(:country) @detail = args[:detail] if args.key?(:detail) @displayed_value = args[:displayed_value] if args.key?(:displayed_value) @example_items = args[:example_items] if args.key?(:example_items) @id = args[:id] if args.key?(:id) @last_checked = args[:last_checked] if args.key?(:last_checked) @location = args[:location] if args.key?(:location) @num_items = args[:num_items] if args.key?(:num_items) @severity = args[:severity] if args.key?(:severity) @submitted_value = args[:submitted_value] if args.key?(:submitted_value) end end # An example of an item that has poor data quality. An item value on the landing # page differs from what is submitted, or conflicts with a policy. class AccountStatusExampleItem include Google::Apis::Core::Hashable # Unique item ID as specified in the uploaded product data. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id # Landing page of the item. # Corresponds to the JSON property `link` # @return [String] attr_accessor :link # The item value that was submitted. # Corresponds to the JSON property `submittedValue` # @return [String] attr_accessor :submitted_value # Title of the item. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The actual value on the landing page. # Corresponds to the JSON property `valueOnLandingPage` # @return [String] attr_accessor :value_on_landing_page def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @item_id = args[:item_id] if args.key?(:item_id) @link = args[:link] if args.key?(:link) @submitted_value = args[:submitted_value] if args.key?(:submitted_value) @title = args[:title] if args.key?(:title) @value_on_landing_page = args[:value_on_landing_page] if args.key?(:value_on_landing_page) end end # The tax settings of a merchant account. class AccountTax include Google::Apis::Core::Hashable # The ID of the account to which these account tax settings belong. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # Identifies what kind of resource this is. Value: the fixed string "content# # accountTax". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Tax rules. Updating the tax rules will enable US taxes (not reversible). # Defining no rules is equivalent to not charging tax at all. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @kind = args[:kind] if args.key?(:kind) @rules = args[:rules] if args.key?(:rules) end end # Tax calculation rule to apply in a state or province (USA only). class AccountTaxTaxRule include Google::Apis::Core::Hashable # Country code in which tax is applicable. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # State (or province) is which the tax is applicable, described by its location # id (also called criteria id). # Corresponds to the JSON property `locationId` # @return [Fixnum] attr_accessor :location_id # Explicit tax rate in percent, represented as a floating point number without # the percentage character. Must not be negative. # Corresponds to the JSON property `ratePercent` # @return [String] attr_accessor :rate_percent # If true, shipping charges are also taxed. # Corresponds to the JSON property `shippingTaxed` # @return [Boolean] attr_accessor :shipping_taxed alias_method :shipping_taxed?, :shipping_taxed # Whether the tax rate is taken from a global tax table or specified explicitly. # Corresponds to the JSON property `useGlobalRate` # @return [Boolean] attr_accessor :use_global_rate alias_method :use_global_rate?, :use_global_rate def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country = args[:country] if args.key?(:country) @location_id = args[:location_id] if args.key?(:location_id) @rate_percent = args[:rate_percent] if args.key?(:rate_percent) @shipping_taxed = args[:shipping_taxed] if args.key?(:shipping_taxed) @use_global_rate = args[:use_global_rate] if args.key?(:use_global_rate) end end # class AccountUser include Google::Apis::Core::Hashable # Whether user is an admin. # Corresponds to the JSON property `admin` # @return [Boolean] attr_accessor :admin alias_method :admin?, :admin # User's email address. # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @admin = args[:admin] if args.key?(:admin) @email_address = args[:email_address] if args.key?(:email_address) end end # class AccountYouTubeChannelLink include Google::Apis::Core::Hashable # Channel ID. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # 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 # 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` # @return [String] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel_id = args[:channel_id] if args.key?(:channel_id) @status = args[:status] if args.key?(:status) end end # class AccountsAuthInfoResponse include Google::Apis::Core::Hashable # The account identifiers corresponding to the authenticated user. # - For an individual account: only the merchant ID is defined # - For an aggregator: only the aggregator ID is defined # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are # defined. # Corresponds to the JSON property `accountIdentifiers` # @return [Array] attr_accessor :account_identifiers # Identifies what kind of resource this is. Value: the fixed string "content# # accountsAuthInfoResponse". # 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) @account_identifiers = args[:account_identifiers] if args.key?(:account_identifiers) @kind = args[:kind] if args.key?(:kind) end end # class AccountsClaimWebsiteResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # accountsClaimWebsiteResponse". # 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) @kind = args[:kind] if args.key?(:kind) end end # class BatchAccountsRequest include Google::Apis::Core::Hashable # The request entries to be processed in the batch. # 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) @entries = args[:entries] if args.key?(:entries) end end # A batch entry encoding a single non-batch accounts request. class AccountsBatchRequestEntry include Google::Apis::Core::Hashable # Account data. # Corresponds to the JSON property `account` # @return [Google::Apis::ContentV2::Account] attr_accessor :account # The ID of the targeted account. Only defined if the method is get, delete or # claimwebsite. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # Whether the account should be deleted if the account has offers. Only # applicable if the method is delete. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force alias_method :force?, :force # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method # 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] attr_accessor :overwrite alias_method :overwrite?, :overwrite def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account = args[:account] if args.key?(:account) @account_id = args[:account_id] if args.key?(:account_id) @batch_id = args[:batch_id] if args.key?(:batch_id) @force = args[:force] if args.key?(:force) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @request_method = args[:request_method] if args.key?(:request_method) @overwrite = args[:overwrite] if args.key?(:overwrite) end end # class BatchAccountsResponse include Google::Apis::Core::Hashable # The result of the execution of the batch requests. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Identifies what kind of resource this is. Value: the fixed string "content# # accountsCustomBatchResponse". # 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) @entries = args[:entries] if args.key?(:entries) @kind = args[:kind] if args.key?(:kind) end end # A batch entry encoding a single non-batch accounts response. class AccountsBatchResponseEntry include Google::Apis::Core::Hashable # Account data. # Corresponds to the JSON property `account` # @return [Google::Apis::ContentV2::Account] attr_accessor :account # The ID of the request entry this entry responds to. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors # Identifies what kind of resource this is. Value: the fixed string "content# # accountsCustomBatchResponseEntry". # 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) @account = args[:account] if args.key?(:account) @batch_id = args[:batch_id] if args.key?(:batch_id) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) end end # class ListAccountsResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # accountsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token for the retrieval of the next page of accounts. # 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 BatchAccountStatusesRequest include Google::Apis::Core::Hashable # The request entries to be processed in the batch. # 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) @entries = args[:entries] if args.key?(:entries) end end # A batch entry encoding a single non-batch accountstatuses request. class AccountStatusesBatchRequestEntry include Google::Apis::Core::Hashable # The ID of the (sub-)account whose status to get. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # The method (get). # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @batch_id = args[:batch_id] if args.key?(:batch_id) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @request_method = args[:request_method] if args.key?(:request_method) end end # class BatchAccountStatusesResponse include Google::Apis::Core::Hashable # The result of the execution of the batch requests. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Identifies what kind of resource this is. Value: the fixed string "content# # accountstatusesCustomBatchResponse". # 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) @entries = args[:entries] if args.key?(:entries) @kind = args[:kind] if args.key?(:kind) end end # A batch entry encoding a single non-batch accountstatuses response. class AccountStatusesBatchResponseEntry include Google::Apis::Core::Hashable # The status of an account, i.e., information about its products, which is # computed offline and not returned immediately at insertion time. # Corresponds to the JSON property `accountStatus` # @return [Google::Apis::ContentV2::AccountStatus] attr_accessor :account_status # The ID of the request entry this entry responds to. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_status = args[:account_status] if args.key?(:account_status) @batch_id = args[:batch_id] if args.key?(:batch_id) @errors = args[:errors] if args.key?(:errors) end end # class ListAccountStatusesResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # accountstatusesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token for the retrieval of the next page of account statuses. # 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 BatchAccountTaxRequest include Google::Apis::Core::Hashable # The request entries to be processed in the batch. # 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) @entries = args[:entries] if args.key?(:entries) end end # A batch entry encoding a single non-batch accounttax request. class AccountTaxBatchRequestEntry include Google::Apis::Core::Hashable # The ID of the account for which to get/update account tax settings. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # The tax settings of a merchant account. # Corresponds to the JSON property `accountTax` # @return [Google::Apis::ContentV2::AccountTax] attr_accessor :account_tax # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @account_tax = args[:account_tax] if args.key?(:account_tax) @batch_id = args[:batch_id] if args.key?(:batch_id) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @request_method = args[:request_method] if args.key?(:request_method) end end # class BatchAccountTaxResponse include Google::Apis::Core::Hashable # The result of the execution of the batch requests. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Identifies what kind of resource this is. Value: the fixed string "content# # accounttaxCustomBatchResponse". # 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) @entries = args[:entries] if args.key?(:entries) @kind = args[:kind] if args.key?(:kind) end end # A batch entry encoding a single non-batch accounttax response. class AccountTaxBatchResponseEntry include Google::Apis::Core::Hashable # The tax settings of a merchant account. # Corresponds to the JSON property `accountTax` # @return [Google::Apis::ContentV2::AccountTax] attr_accessor :account_tax # The ID of the request entry this entry responds to. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors # Identifies what kind of resource this is. Value: the fixed string "content# # accounttaxCustomBatchResponseEntry". # 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) @account_tax = args[:account_tax] if args.key?(:account_tax) @batch_id = args[:batch_id] if args.key?(:batch_id) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) end end # class ListAccountTaxResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # accounttaxListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token for the retrieval of the next page of account tax settings. # 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 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. # 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. # 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. # Corresponds to the JSON property `flatAdjustment` # @return [Google::Apis::ContentV2::Price] attr_accessor :flat_adjustment # Name of the carrier rate. Must be unique per rate group. Required. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Shipping origin for this carrier rate. Required. # Corresponds to the JSON property `originPostalCode` # @return [String] 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 # rate by 3%. Optional. # Corresponds to the JSON property `percentageAdjustment` # @return [String] attr_accessor :percentage_adjustment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @carrier_name = args[:carrier_name] if args.key?(:carrier_name) @carrier_service = args[:carrier_service] if args.key?(:carrier_service) @flat_adjustment = args[:flat_adjustment] if args.key?(:flat_adjustment) @name = args[:name] if args.key?(:name) @origin_postal_code = args[:origin_postal_code] if args.key?(:origin_postal_code) @percentage_adjustment = args[:percentage_adjustment] if args.key?(:percentage_adjustment) end end # class CarriersCarrier include Google::Apis::Core::Hashable # The CLDR country code of the carrier (e.g., "US"). Always present. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # 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 # least one service. # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country = args[:country] if args.key?(:country) @name = args[:name] if args.key?(:name) @services = args[:services] if args.key?(:services) end end # Datafeed configuration data. class Datafeed include Google::Apis::Core::Hashable # The two-letter ISO 639-1 language in which the attributes are defined in the # data feed. # Corresponds to the JSON property `attributeLanguage` # @return [String] 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. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language # The type of data feed. For product inventory feeds, only feeds for local # stores, not online stores, are supported. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # The required fields vary based on the frequency of fetching. For a monthly # fetch schedule, day_of_month and hour are required. For a weekly fetch # schedule, weekday and hour are required. For a daily fetch schedule, only hour # is required. # Corresponds to the JSON property `fetchSchedule` # @return [Google::Apis::ContentV2::DatafeedFetchSchedule] attr_accessor :fetch_schedule # The filename of the feed. All feeds must have a unique file name. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name # Format of the feed file. # Corresponds to the JSON property `format` # @return [Google::Apis::ContentV2::DatafeedFormat] attr_accessor :format # The ID of the data feed. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [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". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A descriptive name of the data feed. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [DEPRECATED] Please use targets[].country instead. The country where the items # in the feed will be included in the search index, represented as a CLDR # territory code. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country # The targets this feed should apply to (country, language, destinations). # 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) @attribute_language = args[:attribute_language] if args.key?(:attribute_language) @content_language = args[:content_language] if args.key?(:content_language) @content_type = args[:content_type] if args.key?(:content_type) @fetch_schedule = args[:fetch_schedule] if args.key?(:fetch_schedule) @file_name = args[:file_name] if args.key?(:file_name) @format = args[:format] if args.key?(:format) @id = args[:id] if args.key?(:id) @intended_destinations = args[:intended_destinations] if args.key?(:intended_destinations) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @target_country = args[:target_country] if args.key?(:target_country) @targets = args[:targets] if args.key?(:targets) end end # The required fields vary based on the frequency of fetching. For a monthly # fetch schedule, day_of_month and hour are required. For a weekly fetch # schedule, weekday and hour are required. For a daily fetch schedule, only hour # is required. class DatafeedFetchSchedule include Google::Apis::Core::Hashable # The day of the month the feed file should be fetched (1-31). # Corresponds to the JSON property `dayOfMonth` # @return [Fixnum] attr_accessor :day_of_month # The URL where the feed file can be fetched. Google Merchant Center will # support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP # protocols, so the value will need to be a valid link using one of those four # protocols. # Corresponds to the JSON property `fetchUrl` # @return [String] attr_accessor :fetch_url # The hour of the day the feed file should be fetched (0-23). # Corresponds to the JSON property `hour` # @return [Fixnum] attr_accessor :hour # The minute of the hour the feed file should be fetched (0-59). Read-only. # Corresponds to the JSON property `minuteOfHour` # @return [Fixnum] attr_accessor :minute_of_hour # An optional password for fetch_url. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # Whether the scheduled fetch is paused or not. # Corresponds to the JSON property `paused` # @return [Boolean] attr_accessor :paused alias_method :paused?, :paused # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone # An optional user name for fetch_url. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username # The day of the week the feed file should be fetched. # Corresponds to the JSON property `weekday` # @return [String] attr_accessor :weekday def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @day_of_month = args[:day_of_month] if args.key?(:day_of_month) @fetch_url = args[:fetch_url] if args.key?(:fetch_url) @hour = args[:hour] if args.key?(:hour) @minute_of_hour = args[:minute_of_hour] if args.key?(:minute_of_hour) @password = args[:password] if args.key?(:password) @paused = args[:paused] if args.key?(:paused) @time_zone = args[:time_zone] if args.key?(:time_zone) @username = args[:username] if args.key?(:username) @weekday = args[:weekday] if args.key?(:weekday) end end # class DatafeedFormat include Google::Apis::Core::Hashable # Delimiter for the separation of values in a delimiter-separated values feed. # If not specified, the delimiter will be auto-detected. Ignored for non-DSV # data feeds. # Corresponds to the JSON property `columnDelimiter` # @return [String] attr_accessor :column_delimiter # Character encoding scheme of the data feed. If not specified, the encoding # will be auto-detected. # Corresponds to the JSON property `fileEncoding` # @return [String] attr_accessor :file_encoding # Specifies how double quotes are interpreted. If not specified, the mode will # be auto-detected. Ignored for non-DSV data feeds. # Corresponds to the JSON property `quotingMode` # @return [String] attr_accessor :quoting_mode def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_delimiter = args[:column_delimiter] if args.key?(:column_delimiter) @file_encoding = args[:file_encoding] if args.key?(:file_encoding) @quoting_mode = args[:quoting_mode] if args.key?(:quoting_mode) end end # The status of a datafeed, i.e., the result of the last retrieval of the # datafeed computed asynchronously when the feed processing is finished. class DatafeedStatus include Google::Apis::Core::Hashable # The country for which the status is reported, represented as a CLDR territory # code. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # The ID of the feed for which the status is reported. # Corresponds to the JSON property `datafeedId` # @return [Fixnum] attr_accessor :datafeed_id # The list of errors occurring in the feed. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # The number of items in the feed that were processed. # Corresponds to the JSON property `itemsTotal` # @return [Fixnum] attr_accessor :items_total # The number of items in the feed that were valid. # Corresponds to the JSON property `itemsValid` # @return [Fixnum] attr_accessor :items_valid # Identifies what kind of resource this is. Value: the fixed string "content# # datafeedStatus". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The two-letter ISO 639-1 language for which the status is reported. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # The last date at which the feed was uploaded. # Corresponds to the JSON property `lastUploadDate` # @return [String] attr_accessor :last_upload_date # The processing status of the feed. # Corresponds to the JSON property `processingStatus` # @return [String] attr_accessor :processing_status # The list of errors occurring in the feed. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country = args[:country] if args.key?(:country) @datafeed_id = args[:datafeed_id] if args.key?(:datafeed_id) @errors = args[:errors] if args.key?(:errors) @items_total = args[:items_total] if args.key?(:items_total) @items_valid = args[:items_valid] if args.key?(:items_valid) @kind = args[:kind] if args.key?(:kind) @language = args[:language] if args.key?(:language) @last_upload_date = args[:last_upload_date] if args.key?(:last_upload_date) @processing_status = args[:processing_status] if args.key?(:processing_status) @warnings = args[:warnings] if args.key?(:warnings) end end # An error occurring in the feed, like "invalid price". class DatafeedStatusError include Google::Apis::Core::Hashable # The code of the error, e.g., "validation/invalid_value". # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # The number of occurrences of the error in the feed. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # A list of example occurrences of the error, grouped by product. # Corresponds to the JSON property `examples` # @return [Array] attr_accessor :examples # The error message, e.g., "Invalid price". # 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) @count = args[:count] if args.key?(:count) @examples = args[:examples] if args.key?(:examples) @message = args[:message] if args.key?(:message) end end # An example occurrence for a particular error. class DatafeedStatusExample include Google::Apis::Core::Hashable # The ID of the example item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id # Line number in the data feed where the example is found. # Corresponds to the JSON property `lineNumber` # @return [Fixnum] attr_accessor :line_number # The problematic 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) @item_id = args[:item_id] if args.key?(:item_id) @line_number = args[:line_number] if args.key?(:line_number) @value = args[:value] if args.key?(:value) end end # class DatafeedTarget include Google::Apis::Core::Hashable # The country where the items in the feed will be included in the search index, # represented as a CLDR territory code. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # The list of destinations to exclude for this target (corresponds to unchecked # check boxes in Merchant Center). # Corresponds to the JSON property `excludedDestinations` # @return [Array] attr_accessor :excluded_destinations # 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 the excluded_destination field. # Corresponds to the JSON property `includedDestinations` # @return [Array] 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. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country = args[:country] if args.key?(:country) @excluded_destinations = args[:excluded_destinations] if args.key?(:excluded_destinations) @included_destinations = args[:included_destinations] if args.key?(:included_destinations) @language = args[:language] if args.key?(:language) end end # class BatchDatafeedsRequest include Google::Apis::Core::Hashable # The request entries to be processed in the batch. # 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) @entries = args[:entries] if args.key?(:entries) end end # A batch entry encoding a single non-batch datafeeds request. class DatafeedsBatchRequestEntry include Google::Apis::Core::Hashable # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # Datafeed configuration data. # Corresponds to the JSON property `datafeed` # @return [Google::Apis::ContentV2::Datafeed] attr_accessor :datafeed # The ID of the data feed to get or delete. # Corresponds to the JSON property `datafeedId` # @return [Fixnum] attr_accessor :datafeed_id # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @datafeed = args[:datafeed] if args.key?(:datafeed) @datafeed_id = args[:datafeed_id] if args.key?(:datafeed_id) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @request_method = args[:request_method] if args.key?(:request_method) end end # class BatchDatafeedsResponse include Google::Apis::Core::Hashable # The result of the execution of the batch requests. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Identifies what kind of resource this is. Value: the fixed string "content# # datafeedsCustomBatchResponse". # 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) @entries = args[:entries] if args.key?(:entries) @kind = args[:kind] if args.key?(:kind) end end # A batch entry encoding a single non-batch datafeeds response. class DatafeedsBatchResponseEntry include Google::Apis::Core::Hashable # The ID of the request entry this entry responds to. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # Datafeed configuration data. # Corresponds to the JSON property `datafeed` # @return [Google::Apis::ContentV2::Datafeed] attr_accessor :datafeed # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @datafeed = args[:datafeed] if args.key?(:datafeed) @errors = args[:errors] if args.key?(:errors) end end # class ListDatafeedsResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # datafeedsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token for the retrieval of the next page of datafeeds. # 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 BatchDatafeedStatusesRequest include Google::Apis::Core::Hashable # The request entries to be processed in the batch. # 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) @entries = args[:entries] if args.key?(:entries) end end # A batch entry encoding a single non-batch datafeedstatuses request. class DatafeedStatusesBatchRequestEntry include Google::Apis::Core::Hashable # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # The country for which to get the datafeed status. If this parameter is # provided then language must also be provided. Note that for multi-target # datafeeds this parameter is required. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # The ID of the data feed to get. # Corresponds to the JSON property `datafeedId` # @return [Fixnum] attr_accessor :datafeed_id # The language for which to get the datafeed status. If this parameter is # provided then country must also be provided. Note that for multi-target # datafeeds this parameter is required. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @country = args[:country] if args.key?(:country) @datafeed_id = args[:datafeed_id] if args.key?(:datafeed_id) @language = args[:language] if args.key?(:language) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @request_method = args[:request_method] if args.key?(:request_method) end end # class BatchDatafeedStatusesResponse include Google::Apis::Core::Hashable # The result of the execution of the batch requests. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Identifies what kind of resource this is. Value: the fixed string "content# # datafeedstatusesCustomBatchResponse". # 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) @entries = args[:entries] if args.key?(:entries) @kind = args[:kind] if args.key?(:kind) end end # A batch entry encoding a single non-batch datafeedstatuses response. class DatafeedStatusesBatchResponseEntry include Google::Apis::Core::Hashable # The ID of the request entry this entry responds to. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # The status of a datafeed, i.e., the result of the last retrieval of the # datafeed computed asynchronously when the feed processing is finished. # Corresponds to the JSON property `datafeedStatus` # @return [Google::Apis::ContentV2::DatafeedStatus] attr_accessor :datafeed_status # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @datafeed_status = args[:datafeed_status] if args.key?(:datafeed_status) @errors = args[:errors] if args.key?(:errors) end end # class ListDatafeedStatusesResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # datafeedstatusesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token for the retrieval of the next page of datafeed statuses. # 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 DeliveryTime include Google::Apis::Core::Hashable # Holiday cutoff definitions. If configured, they specify order cutoff times for # holiday-specific shipping. # Corresponds to the JSON property `holidayCutoffs` # @return [Array] attr_accessor :holiday_cutoffs # 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. Required. # Corresponds to the JSON property `maxTransitTimeInDays` # @return [Fixnum] attr_accessor :max_transit_time_in_days # Minimum number of business days that is spent in transit. 0 means same day # delivery, 1 means next day delivery. Required. # Corresponds to the JSON property `minTransitTimeInDays` # @return [Fixnum] attr_accessor :min_transit_time_in_days def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @holiday_cutoffs = args[:holiday_cutoffs] if args.key?(:holiday_cutoffs) @max_transit_time_in_days = args[:max_transit_time_in_days] if args.key?(:max_transit_time_in_days) @min_transit_time_in_days = args[:min_transit_time_in_days] if args.key?(:min_transit_time_in_days) end end # An error returned by the API. class Error include Google::Apis::Core::Hashable # The domain of the error. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # A description of the error. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message # The error code. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @domain = args[:domain] if args.key?(:domain) @message = args[:message] if args.key?(:message) @reason = args[:reason] if args.key?(:reason) end end # A list of errors returned by a failed batch entry. class Errors include Google::Apis::Core::Hashable # The HTTP status of the first error in errors. # Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code # A list of errors. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors # The message of the first error in errors. # 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) @errors = args[:errors] if args.key?(:errors) @message = args[:message] if args.key?(:message) end end # A non-empty list of row or column headers for a table. Exactly one of prices, # weights, numItems, postalCodeGroupNames, or locations must be set. class Headers include Google::Apis::Core::Hashable # A list of location ID sets. Must be non-empty. Can only be set if all other # fields are not set. # Corresponds to the JSON property `locations` # @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 # 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. # 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 # 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. # Corresponds to the JSON property `weights` # @return [Array] attr_accessor :weights def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @locations = args[:locations] if args.key?(:locations) @number_of_items = args[:number_of_items] if args.key?(:number_of_items) @postal_code_group_names = args[:postal_code_group_names] if args.key?(:postal_code_group_names) @prices = args[:prices] if args.key?(:prices) @weights = args[:weights] if args.key?(:weights) end end # class HolidayCutoff include Google::Apis::Core::Hashable # Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th # November 2016. Required. # Corresponds to the JSON property `deadlineDate` # @return [String] attr_accessor :deadline_date # Hour of the day on the deadline date until which the order has to be placed to # qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., # 12 (noon), 13, ..., 23. Required. # Corresponds to the JSON property `deadlineHour` # @return [Fixnum] attr_accessor :deadline_hour # Timezone identifier for the deadline hour. A list of identifiers can be found # in the AdWords API documentation. E.g. "Europe/Zurich". Required. # Corresponds to the JSON property `deadlineTimezone` # @return [String] attr_accessor :deadline_timezone # Unique identifier for the holiday. Required. # Corresponds to the JSON property `holidayId` # @return [String] attr_accessor :holiday_id # Date on which the deadline will become visible to consumers in ISO 8601 format. # E.g. "2016-10-31" for 31st October 2016. Required. # Corresponds to the JSON property `visibleFromDate` # @return [String] attr_accessor :visible_from_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deadline_date = args[:deadline_date] if args.key?(:deadline_date) @deadline_hour = args[:deadline_hour] if args.key?(:deadline_hour) @deadline_timezone = args[:deadline_timezone] if args.key?(:deadline_timezone) @holiday_id = args[:holiday_id] if args.key?(:holiday_id) @visible_from_date = args[:visible_from_date] if args.key?(:visible_from_date) end end # class HolidaysHoliday include Google::Apis::Core::Hashable # The CLDR territory code of the country in which the holiday is available. E.g. # "US", "DE", "GB". A holiday cutoff can only be configured in a shipping # settings service with matching delivery country. Always present. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code # Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. # Always present. # Corresponds to the JSON property `date` # @return [String] attr_accessor :date # Date on which the order has to arrive at the customer's, in ISO 8601 format. E. # g. "2016-12-24" for 24th December 2016. Always present. # Corresponds to the JSON property `deliveryGuaranteeDate` # @return [String] attr_accessor :delivery_guarantee_date # Hour of the day in the delivery location's timezone on the guaranteed delivery # date by which the order has to arrive at the customer's. Possible values are: # 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present. # Corresponds to the JSON property `deliveryGuaranteeHour` # @return [Fixnum] attr_accessor :delivery_guarantee_hour # Unique identifier for the holiday to be used when configuring holiday cutoffs. # Always present. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The holiday type. Always present. # 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) @country_code = args[:country_code] if args.key?(:country_code) @date = args[:date] if args.key?(:date) @delivery_guarantee_date = args[:delivery_guarantee_date] if args.key?(:delivery_guarantee_date) @delivery_guarantee_hour = args[:delivery_guarantee_hour] if args.key?(:delivery_guarantee_hour) @id = args[:id] if args.key?(:id) @type = args[:type] if args.key?(:type) end end # class Installment include Google::Apis::Core::Hashable # The amount the buyer has to pay per month. # Corresponds to the JSON property `amount` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount # The number of installments the buyer has to pay. # Corresponds to the JSON property `months` # @return [Fixnum] attr_accessor :months def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @amount = args[:amount] if args.key?(:amount) @months = args[:months] if args.key?(:months) end end # class Inventory include Google::Apis::Core::Hashable # The availability of the product. # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability # Number and amount of installments to pay for an item. Brazil only. # Corresponds to the JSON property `installment` # @return [Google::Apis::ContentV2::Installment] attr_accessor :installment # Identifies what kind of resource this is. Value: the fixed string "content# # inventory". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Loyalty points that users receive after purchasing the item. Japan only. # Corresponds to the JSON property `loyaltyPoints` # @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". # Corresponds to the JSON property `pickup` # @return [Google::Apis::ContentV2::InventoryPickup] attr_accessor :pickup # The price of the product. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price # The quantity of the product. Must be equal to or greater than zero. Supported # only for local products. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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] attr_accessor :sale_price # A date range represented by a pair of ISO 8601 dates separated by a space, # comma, or slash. Both dates might be specified as 'null' if undecided. # Corresponds to the JSON property `salePriceEffectiveDate` # @return [String] attr_accessor :sale_price_effective_date # The quantity of the product that is reserved for sell-on-google ads. Supported # only for online products. # Corresponds to the JSON property `sellOnGoogleQuantity` # @return [Fixnum] attr_accessor :sell_on_google_quantity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @availability = args[:availability] if args.key?(:availability) @installment = args[:installment] if args.key?(:installment) @kind = args[:kind] if args.key?(:kind) @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points) @pickup = args[:pickup] if args.key?(:pickup) @price = args[:price] if args.key?(:price) @quantity = args[:quantity] if args.key?(:quantity) @sale_price = args[:sale_price] if args.key?(:sale_price) @sale_price_effective_date = args[:sale_price_effective_date] if args.key?(:sale_price_effective_date) @sell_on_google_quantity = args[:sell_on_google_quantity] if args.key?(:sell_on_google_quantity) end end # class BatchInventoryRequest include Google::Apis::Core::Hashable # The request entries to be processed in the batch. # 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) @entries = args[:entries] if args.key?(:entries) end end # A batch entry encoding a single non-batch inventory request. class InventoryBatchRequestEntry include Google::Apis::Core::Hashable # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # Price and availability of the product. # Corresponds to the JSON property `inventory` # @return [Google::Apis::ContentV2::Inventory] attr_accessor :inventory # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # The ID of the product for which to update price and availability. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # 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] attr_accessor :store_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @inventory = args[:inventory] if args.key?(:inventory) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @product_id = args[:product_id] if args.key?(:product_id) @store_code = args[:store_code] if args.key?(:store_code) end end # class BatchInventoryResponse include Google::Apis::Core::Hashable # The result of the execution of the batch requests. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Identifies what kind of resource this is. Value: the fixed string "content# # inventoryCustomBatchResponse". # 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) @entries = args[:entries] if args.key?(:entries) @kind = args[:kind] if args.key?(:kind) end end # A batch entry encoding a single non-batch inventory response. class InventoryBatchResponseEntry include Google::Apis::Core::Hashable # The ID of the request entry this entry responds to. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors # Identifies what kind of resource this is. Value: the fixed string "content# # inventoryCustomBatchResponseEntry". # 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) @batch_id = args[:batch_id] if args.key?(:batch_id) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) end end # class InventoryPickup include Google::Apis::Core::Hashable # 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. # 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. # Corresponds to the JSON property `pickupSla` # @return [String] attr_accessor :pickup_sla def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @pickup_method = args[:pickup_method] if args.key?(:pickup_method) @pickup_sla = args[:pickup_sla] if args.key?(:pickup_sla) end end # class SetInventoryRequest include Google::Apis::Core::Hashable # The availability of the product. # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability # Number and amount of installments to pay for an item. Brazil only. # Corresponds to the JSON property `installment` # @return [Google::Apis::ContentV2::Installment] attr_accessor :installment # Loyalty points that users receive after purchasing the item. Japan only. # Corresponds to the JSON property `loyaltyPoints` # @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". # Corresponds to the JSON property `pickup` # @return [Google::Apis::ContentV2::InventoryPickup] attr_accessor :pickup # The price of the product. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price # The quantity of the product. Must be equal to or greater than zero. Supported # only for local products. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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] attr_accessor :sale_price # A date range represented by a pair of ISO 8601 dates separated by a space, # comma, or slash. Both dates might be specified as 'null' if undecided. # Corresponds to the JSON property `salePriceEffectiveDate` # @return [String] attr_accessor :sale_price_effective_date # The quantity of the product that is reserved for sell-on-google ads. Supported # only for online products. # Corresponds to the JSON property `sellOnGoogleQuantity` # @return [Fixnum] attr_accessor :sell_on_google_quantity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @availability = args[:availability] if args.key?(:availability) @installment = args[:installment] if args.key?(:installment) @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points) @pickup = args[:pickup] if args.key?(:pickup) @price = args[:price] if args.key?(:price) @quantity = args[:quantity] if args.key?(:quantity) @sale_price = args[:sale_price] if args.key?(:sale_price) @sale_price_effective_date = args[:sale_price_effective_date] if args.key?(:sale_price_effective_date) @sell_on_google_quantity = args[:sell_on_google_quantity] if args.key?(:sell_on_google_quantity) end end # class SetInventoryResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # inventorySetResponse". # 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) @kind = args[:kind] if args.key?(:kind) end end # class LocationIdSet include Google::Apis::Core::Hashable # A non-empty list of location IDs. They must all be of the same location type ( # e.g., state). # Corresponds to the JSON property `locationIds` # @return [Array] attr_accessor :location_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @location_ids = args[:location_ids] if args.key?(:location_ids) end end # class LoyaltyPoints include Google::Apis::Core::Hashable # Name of loyalty points program. It is recommended to limit the name to 12 full- # width characters or 24 Roman characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The retailer's loyalty points in absolute value. # Corresponds to the JSON property `pointsValue` # @return [Fixnum] attr_accessor :points_value # The ratio of a point when converted to currency. Google assumes currency based # on Merchant Center settings. If ratio is left out, it defaults to 1.0. # Corresponds to the JSON property `ratio` # @return [Float] attr_accessor :ratio def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @points_value = args[:points_value] if args.key?(:points_value) @ratio = args[:ratio] if args.key?(:ratio) end end # class Order include Google::Apis::Core::Hashable # Whether the order was acknowledged. # Corresponds to the JSON property `acknowledged` # @return [Boolean] attr_accessor :acknowledged alias_method :acknowledged?, :acknowledged # The channel type of the order: "purchaseOnGoogle" or "googleExpress". # Corresponds to the JSON property `channelType` # @return [String] attr_accessor :channel_type # The details of the customer who placed the order. # Corresponds to the JSON property `customer` # @return [Google::Apis::ContentV2::OrderCustomer] attr_accessor :customer # The details for the delivery. # Corresponds to the JSON property `deliveryDetails` # @return [Google::Apis::ContentV2::OrderDeliveryDetails] attr_accessor :delivery_details # The REST id of the order. Globally unique. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "content# # order". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Line items that are ordered. # Corresponds to the JSON property `lineItems` # @return [Array] attr_accessor :line_items # # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # Merchant-provided id of the order. # Corresponds to the JSON property `merchantOrderId` # @return [String] attr_accessor :merchant_order_id # The net amount for the order. For example, if an order was originally for a # grand total of $100 and a refund was issued for $20, the net amount will be $ # 80. # Corresponds to the JSON property `netAmount` # @return [Google::Apis::ContentV2::Price] attr_accessor :net_amount # The details of the payment method. # Corresponds to the JSON property `paymentMethod` # @return [Google::Apis::ContentV2::OrderPaymentMethod] attr_accessor :payment_method # The status of the payment. # Corresponds to the JSON property `paymentStatus` # @return [String] attr_accessor :payment_status # The date when the order was placed, in ISO 8601 format. # Corresponds to the JSON property `placedDate` # @return [String] attr_accessor :placed_date # The details of the merchant provided promotions applied to the order. More # details about the program are here. # Corresponds to the JSON property `promotions` # @return [Array] attr_accessor :promotions # Refunds for the order. # Corresponds to the JSON property `refunds` # @return [Array] attr_accessor :refunds # Shipments of the order. # Corresponds to the JSON property `shipments` # @return [Array] attr_accessor :shipments # The total cost of shipping for all items. # Corresponds to the JSON property `shippingCost` # @return [Google::Apis::ContentV2::Price] attr_accessor :shipping_cost # The tax for the total shipping cost. # Corresponds to the JSON property `shippingCostTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :shipping_cost_tax # The requested shipping option. # Corresponds to the JSON property `shippingOption` # @return [String] attr_accessor :shipping_option # The status of the order. # 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) @acknowledged = args[:acknowledged] if args.key?(:acknowledged) @channel_type = args[:channel_type] if args.key?(:channel_type) @customer = args[:customer] if args.key?(:customer) @delivery_details = args[:delivery_details] if args.key?(:delivery_details) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @line_items = args[:line_items] if args.key?(:line_items) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id) @net_amount = args[:net_amount] if args.key?(:net_amount) @payment_method = args[:payment_method] if args.key?(:payment_method) @payment_status = args[:payment_status] if args.key?(:payment_status) @placed_date = args[:placed_date] if args.key?(:placed_date) @promotions = args[:promotions] if args.key?(:promotions) @refunds = args[:refunds] if args.key?(:refunds) @shipments = args[:shipments] if args.key?(:shipments) @shipping_cost = args[:shipping_cost] if args.key?(:shipping_cost) @shipping_cost_tax = args[:shipping_cost_tax] if args.key?(:shipping_cost_tax) @shipping_option = args[:shipping_option] if args.key?(:shipping_option) @status = args[:status] if args.key?(:status) end end # class OrderAddress include Google::Apis::Core::Hashable # CLDR country code (e.g. "US"). # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # Strings representing the lines of the printed label for mailing the order, for # example: # John Smith # 1600 Amphitheatre Parkway # Mountain View, CA, 94043 # United States # Corresponds to the JSON property `fullAddress` # @return [Array] attr_accessor :full_address # Whether the address is a post office box. # Corresponds to the JSON property `isPostOfficeBox` # @return [Boolean] attr_accessor :is_post_office_box alias_method :is_post_office_box?, :is_post_office_box # City, town or commune. May also include dependent localities or sublocalities ( # e.g. neighborhoods or suburbs). # Corresponds to the JSON property `locality` # @return [String] attr_accessor :locality # Postal Code or ZIP (e.g. "94043"). # Corresponds to the JSON property `postalCode` # @return [String] attr_accessor :postal_code # Name of the recipient. # Corresponds to the JSON property `recipientName` # @return [String] attr_accessor :recipient_name # Top-level administrative subdivision of the country (e.g. "CA"). # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # Street-level part of the address. # Corresponds to the JSON property `streetAddress` # @return [Array] attr_accessor :street_address def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country = args[:country] if args.key?(:country) @full_address = args[:full_address] if args.key?(:full_address) @is_post_office_box = args[:is_post_office_box] if args.key?(:is_post_office_box) @locality = args[:locality] if args.key?(:locality) @postal_code = args[:postal_code] if args.key?(:postal_code) @recipient_name = args[:recipient_name] if args.key?(:recipient_name) @region = args[:region] if args.key?(:region) @street_address = args[:street_address] if args.key?(:street_address) end end # class OrderCancellation include Google::Apis::Core::Hashable # The actor that created the cancellation. # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor # Date on which the cancellation has been created, in ISO 8601 format. # Corresponds to the JSON property `creationDate` # @return [String] attr_accessor :creation_date # The quantity that was canceled. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # The reason for the cancellation. Orders that are cancelled with a noInventory # reason will lead to the removal of the product from POG until you make an # update to that product. This will not affect your Shopping ads. # 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) @actor = args[:actor] if args.key?(:actor) @creation_date = args[:creation_date] if args.key?(:creation_date) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrderCustomer include Google::Apis::Core::Hashable # Email address of the customer. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # If set, this indicates the user explicitly chose to opt in or out of providing # marketing rights to the merchant. If unset, this indicates the user has # already made this choice in a previous purchase, and was thus not shown the # marketing right opt in/out checkbox during the checkout flow. # Corresponds to the JSON property `explicitMarketingPreference` # @return [Boolean] attr_accessor :explicit_marketing_preference alias_method :explicit_marketing_preference?, :explicit_marketing_preference # Full name of the customer. # Corresponds to the JSON property `fullName` # @return [String] attr_accessor :full_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) @explicit_marketing_preference = args[:explicit_marketing_preference] if args.key?(:explicit_marketing_preference) @full_name = args[:full_name] if args.key?(:full_name) end end # class OrderDeliveryDetails include Google::Apis::Core::Hashable # The delivery address # Corresponds to the JSON property `address` # @return [Google::Apis::ContentV2::OrderAddress] attr_accessor :address # The phone number of the person receiving the delivery. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @address = args[:address] if args.key?(:address) @phone_number = args[:phone_number] if args.key?(:phone_number) end end # class OrderLineItem include Google::Apis::Core::Hashable # Annotations that are attached to the line item. # Corresponds to the JSON property `annotations` # @return [Array] attr_accessor :annotations # Cancellations of the line item. # Corresponds to the JSON property `cancellations` # @return [Array] attr_accessor :cancellations # The id of the line item. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Total price for the line item. For example, if two items for $10 are purchased, # the total price will be $20. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price # Product data from the time of the order placement. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2::OrderLineItemProduct] attr_accessor :product # Number of items canceled. # Corresponds to the JSON property `quantityCanceled` # @return [Fixnum] attr_accessor :quantity_canceled # Number of items delivered. # Corresponds to the JSON property `quantityDelivered` # @return [Fixnum] attr_accessor :quantity_delivered # Number of items ordered. # Corresponds to the JSON property `quantityOrdered` # @return [Fixnum] attr_accessor :quantity_ordered # Number of items pending. # Corresponds to the JSON property `quantityPending` # @return [Fixnum] attr_accessor :quantity_pending # Number of items returned. # Corresponds to the JSON property `quantityReturned` # @return [Fixnum] attr_accessor :quantity_returned # Number of items shipped. # Corresponds to the JSON property `quantityShipped` # @return [Fixnum] attr_accessor :quantity_shipped # Details of the return policy for the line item. # Corresponds to the JSON property `returnInfo` # @return [Google::Apis::ContentV2::OrderLineItemReturnInfo] attr_accessor :return_info # Returns of the line item. # Corresponds to the JSON property `returns` # @return [Array] attr_accessor :returns # Details of the requested shipping for the line item. # Corresponds to the JSON property `shippingDetails` # @return [Google::Apis::ContentV2::OrderLineItemShippingDetails] attr_accessor :shipping_details # Total tax amount for the line item. For example, if two items are purchased, # and each have a cost tax of $2, the total tax amount will be $4. # Corresponds to the JSON property `tax` # @return [Google::Apis::ContentV2::Price] attr_accessor :tax def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @annotations = args[:annotations] if args.key?(:annotations) @cancellations = args[:cancellations] if args.key?(:cancellations) @id = args[:id] if args.key?(:id) @price = args[:price] if args.key?(:price) @product = args[:product] if args.key?(:product) @quantity_canceled = args[:quantity_canceled] if args.key?(:quantity_canceled) @quantity_delivered = args[:quantity_delivered] if args.key?(:quantity_delivered) @quantity_ordered = args[:quantity_ordered] if args.key?(:quantity_ordered) @quantity_pending = args[:quantity_pending] if args.key?(:quantity_pending) @quantity_returned = args[:quantity_returned] if args.key?(:quantity_returned) @quantity_shipped = args[:quantity_shipped] if args.key?(:quantity_shipped) @return_info = args[:return_info] if args.key?(:return_info) @returns = args[:returns] if args.key?(:returns) @shipping_details = args[:shipping_details] if args.key?(:shipping_details) @tax = args[:tax] if args.key?(:tax) end end # class OrderLineItemProduct include Google::Apis::Core::Hashable # Brand of the item. # Corresponds to the JSON property `brand` # @return [String] attr_accessor :brand # The item's channel (online or local). # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel # Condition or state of the item. # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition # The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language # Global Trade Item Number (GTIN) of the item. # Corresponds to the JSON property `gtin` # @return [String] attr_accessor :gtin # The REST id of the product. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # URL of an image of the item. # Corresponds to the JSON property `imageLink` # @return [String] attr_accessor :image_link # Shared identifier for all variants of the same product. # Corresponds to the JSON property `itemGroupId` # @return [String] attr_accessor :item_group_id # Manufacturer Part Number (MPN) of the item. # Corresponds to the JSON property `mpn` # @return [String] attr_accessor :mpn # An identifier of the item. # Corresponds to the JSON property `offerId` # @return [String] attr_accessor :offer_id # Price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price # URL to the cached image shown to the user when order was placed. # Corresponds to the JSON property `shownImage` # @return [String] attr_accessor :shown_image # The CLDR territory code of the target country of the product. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country # The title of the product. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Variant attributes for the item. These are dimensions of the product, such as # color, gender, material, pattern, and size. You can find a comprehensive list # of variant attributes here. # Corresponds to the JSON property `variantAttributes` # @return [Array] attr_accessor :variant_attributes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @brand = args[:brand] if args.key?(:brand) @channel = args[:channel] if args.key?(:channel) @condition = args[:condition] if args.key?(:condition) @content_language = args[:content_language] if args.key?(:content_language) @gtin = args[:gtin] if args.key?(:gtin) @id = args[:id] if args.key?(:id) @image_link = args[:image_link] if args.key?(:image_link) @item_group_id = args[:item_group_id] if args.key?(:item_group_id) @mpn = args[:mpn] if args.key?(:mpn) @offer_id = args[:offer_id] if args.key?(:offer_id) @price = args[:price] if args.key?(:price) @shown_image = args[:shown_image] if args.key?(:shown_image) @target_country = args[:target_country] if args.key?(:target_country) @title = args[:title] if args.key?(:title) @variant_attributes = args[:variant_attributes] if args.key?(:variant_attributes) end end # class OrderLineItemProductVariantAttribute include Google::Apis::Core::Hashable # The dimension of the variant. # Corresponds to the JSON property `dimension` # @return [String] attr_accessor :dimension # The value for the dimension. # 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) @dimension = args[:dimension] if args.key?(:dimension) @value = args[:value] if args.key?(:value) end end # class OrderLineItemReturnInfo include Google::Apis::Core::Hashable # How many days later the item can be returned. # Corresponds to the JSON property `daysToReturn` # @return [Fixnum] attr_accessor :days_to_return # Whether the item is returnable. # Corresponds to the JSON property `isReturnable` # @return [Boolean] attr_accessor :is_returnable alias_method :is_returnable?, :is_returnable # URL of the item return policy. # Corresponds to the JSON property `policyUrl` # @return [String] attr_accessor :policy_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @days_to_return = args[:days_to_return] if args.key?(:days_to_return) @is_returnable = args[:is_returnable] if args.key?(:is_returnable) @policy_url = args[:policy_url] if args.key?(:policy_url) end end # class OrderLineItemShippingDetails include Google::Apis::Core::Hashable # The delivery by date, in ISO 8601 format. # Corresponds to the JSON property `deliverByDate` # @return [String] attr_accessor :deliver_by_date # Details of the shipping method. # Corresponds to the JSON property `method` # @return [Google::Apis::ContentV2::OrderLineItemShippingDetailsMethod] attr_accessor :method_prop # The ship by date, in ISO 8601 format. # Corresponds to the JSON property `shipByDate` # @return [String] attr_accessor :ship_by_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deliver_by_date = args[:deliver_by_date] if args.key?(:deliver_by_date) @method_prop = args[:method_prop] if args.key?(:method_prop) @ship_by_date = args[:ship_by_date] if args.key?(:ship_by_date) end end # class OrderLineItemShippingDetailsMethod include Google::Apis::Core::Hashable # 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 # Maximum transit time. # Corresponds to the JSON property `maxDaysInTransit` # @return [Fixnum] attr_accessor :max_days_in_transit # The name of the shipping method. # Corresponds to the JSON property `methodName` # @return [String] attr_accessor :method_name # Minimum transit time. # Corresponds to the JSON property `minDaysInTransit` # @return [Fixnum] attr_accessor :min_days_in_transit def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @carrier = args[:carrier] if args.key?(:carrier) @max_days_in_transit = args[:max_days_in_transit] if args.key?(:max_days_in_transit) @method_name = args[:method_name] if args.key?(:method_name) @min_days_in_transit = args[:min_days_in_transit] if args.key?(:min_days_in_transit) end end # class OrderMerchantProvidedAnnotation include Google::Apis::Core::Hashable # Key for additional merchant provided (as key-value pairs) annotation about the # line item. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # Value for additional merchant provided (as key-value pairs) annotation about # the line item. # 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 OrderPaymentMethod include Google::Apis::Core::Hashable # The billing address. # Corresponds to the JSON property `billingAddress` # @return [Google::Apis::ContentV2::OrderAddress] attr_accessor :billing_address # The card expiration month (January = 1, February = 2 etc.). # Corresponds to the JSON property `expirationMonth` # @return [Fixnum] attr_accessor :expiration_month # The card expiration year (4-digit, e.g. 2015). # Corresponds to the JSON property `expirationYear` # @return [Fixnum] attr_accessor :expiration_year # The last four digits of the card number. # Corresponds to the JSON property `lastFourDigits` # @return [String] attr_accessor :last_four_digits # The billing phone number. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number # The type of instrument. # Acceptable values are: # - "AMEX" # - "DISCOVER" # - "JCB" # - "MASTERCARD" # - "UNIONPAY" # - "VISA" # - "" # 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) @billing_address = args[:billing_address] if args.key?(:billing_address) @expiration_month = args[:expiration_month] if args.key?(:expiration_month) @expiration_year = args[:expiration_year] if args.key?(:expiration_year) @last_four_digits = args[:last_four_digits] if args.key?(:last_four_digits) @phone_number = args[:phone_number] if args.key?(:phone_number) @type = args[:type] if args.key?(:type) end end # class OrderPromotion include Google::Apis::Core::Hashable # # Corresponds to the JSON property `benefits` # @return [Array] attr_accessor :benefits # The date and time frame when the promotion is active and ready for validation # review. Note that the promotion live time may be delayed for a few hours due # to the validation review. # Start date and end date are separated by a forward slash (/). The start date # is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time # of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an # expression of the time zone for the sale. The end date is in the same format. # Corresponds to the JSON property `effectiveDates` # @return [String] attr_accessor :effective_dates # Optional. The text code that corresponds to the promotion when applied on the # retailer?s website. # Corresponds to the JSON property `genericRedemptionCode` # @return [String] attr_accessor :generic_redemption_code # The unique ID of the promotion. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The full title of the promotion. # Corresponds to the JSON property `longTitle` # @return [String] attr_accessor :long_title # Whether the promotion is applicable to all products or only specific products. # Corresponds to the JSON property `productApplicability` # @return [String] attr_accessor :product_applicability # Indicates that the promotion is valid online. # Corresponds to the JSON property `redemptionChannel` # @return [String] attr_accessor :redemption_channel def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @benefits = args[:benefits] if args.key?(:benefits) @effective_dates = args[:effective_dates] if args.key?(:effective_dates) @generic_redemption_code = args[:generic_redemption_code] if args.key?(:generic_redemption_code) @id = args[:id] if args.key?(:id) @long_title = args[:long_title] if args.key?(:long_title) @product_applicability = args[:product_applicability] if args.key?(:product_applicability) @redemption_channel = args[:redemption_channel] if args.key?(:redemption_channel) end end # class OrderPromotionBenefit include Google::Apis::Core::Hashable # The discount in the order price when the promotion is applied. # Corresponds to the JSON property `discount` # @return [Google::Apis::ContentV2::Price] attr_accessor :discount # The OfferId(s) that were purchased in this order and map to this specific # benefit of the promotion. # Corresponds to the JSON property `offerIds` # @return [Array] attr_accessor :offer_ids # Further describes the benefit of the promotion. Note that we will expand on # this enumeration as we support new promotion sub-types. # Corresponds to the JSON property `subType` # @return [String] attr_accessor :sub_type # The impact on tax when the promotion is applied. # Corresponds to the JSON property `taxImpact` # @return [Google::Apis::ContentV2::Price] attr_accessor :tax_impact # Describes whether the promotion applies to products (e.g. 20% off) or to # shipping (e.g. Free Shipping). # 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) @discount = args[:discount] if args.key?(:discount) @offer_ids = args[:offer_ids] if args.key?(:offer_ids) @sub_type = args[:sub_type] if args.key?(:sub_type) @tax_impact = args[:tax_impact] if args.key?(:tax_impact) @type = args[:type] if args.key?(:type) end end # class OrderRefund include Google::Apis::Core::Hashable # The actor that created the refund. # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor # The amount that is refunded. # Corresponds to the JSON property `amount` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount # Date on which the item has been created, in ISO 8601 format. # Corresponds to the JSON property `creationDate` # @return [String] attr_accessor :creation_date # The reason for the refund. # 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) @actor = args[:actor] if args.key?(:actor) @amount = args[:amount] if args.key?(:amount) @creation_date = args[:creation_date] if args.key?(:creation_date) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrderReturn include Google::Apis::Core::Hashable # The actor that created the refund. # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor # Date on which the item has been created, in ISO 8601 format. # Corresponds to the JSON property `creationDate` # @return [String] attr_accessor :creation_date # Quantity that is returned. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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) @actor = args[:actor] if args.key?(:actor) @creation_date = args[:creation_date] if args.key?(:creation_date) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrderShipment include Google::Apis::Core::Hashable # The carrier handling the shipment. # Acceptable values are: # - "gsx" # - "ups" # - "usps" # - "fedex" # - "dhl" # - "ecourier" # - "cxt" # - "google" # - "ontrac" # - "emsy" # - "ont" # - "deliv" # - "dynamex" # - "lasership" # - "mpx" # - "uds" # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Date on which the shipment has been created, in ISO 8601 format. # Corresponds to the JSON property `creationDate` # @return [String] attr_accessor :creation_date # Date on which the shipment has been delivered, in ISO 8601 format. Present # only if status is delievered # Corresponds to the JSON property `deliveryDate` # @return [String] attr_accessor :delivery_date # The id of the shipment. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The line items that are shipped. # Corresponds to the JSON property `lineItems` # @return [Array] attr_accessor :line_items # The status of the shipment. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The tracking id for the shipment. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @carrier = args[:carrier] if args.key?(:carrier) @creation_date = args[:creation_date] if args.key?(:creation_date) @delivery_date = args[:delivery_date] if args.key?(:delivery_date) @id = args[:id] if args.key?(:id) @line_items = args[:line_items] if args.key?(:line_items) @status = args[:status] if args.key?(:status) @tracking_id = args[:tracking_id] if args.key?(:tracking_id) end end # class OrderShipmentLineItemShipment include Google::Apis::Core::Hashable # The id of the line item that is shipped. Either lineItemId or productId is # required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the product to ship. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity that is shipped. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) end end # class OrdersAcknowledgeRequest include Google::Apis::Core::Hashable # The ID of the operation. Unique across all operations for a given order. # 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 OrdersAcknowledgeResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersAcknowledgeResponse". # 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 OrdersAdvanceTestOrderResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # ordersAdvanceTestOrderResponse". # 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) @kind = args[:kind] if args.key?(:kind) end end # class OrdersCancelLineItemRequest include Google::Apis::Core::Hashable # Amount to refund for the cancelation. Optional. If not set, Google will # calculate the default based on the price and tax of the items involved. The # amount must not be larger than the net amount left on the order. # Corresponds to the JSON property `amount` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount # Amount to refund for the cancelation. Optional. If not set, Google will # calculate the default based on the price and tax of the items involved. The # amount must not be larger than the net amount left on the order. # Corresponds to the JSON property `amountPretax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_pretax # Tax amount that correspond to cancellation amount in amountPretax. # Corresponds to the JSON property `amountTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_tax # The ID of the line item to cancel. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The ID of the product to cancel. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity to cancel. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # The reason for the cancellation. # 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) @amount = args[:amount] if args.key?(:amount) @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersCancelLineItemResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersCancelLineItemResponse". # 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 OrdersCancelRequest include Google::Apis::Core::Hashable # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The reason for the cancellation. # 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) @operation_id = args[:operation_id] if args.key?(:operation_id) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersCancelResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersCancelResponse". # 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 OrdersCreateTestOrderRequest include Google::Apis::Core::Hashable # 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. # Corresponds to the JSON property `templateName` # @return [String] attr_accessor :template_name # The test order to create. # Corresponds to the JSON property `testOrder` # @return [Google::Apis::ContentV2::TestOrder] attr_accessor :test_order def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @template_name = args[:template_name] if args.key?(:template_name) @test_order = args[:test_order] if args.key?(:test_order) end end # class OrdersCreateTestOrderResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # ordersCreateTestOrderResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The ID of the newly created test order. # Corresponds to the JSON property `orderId` # @return [String] attr_accessor :order_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @order_id = args[:order_id] if args.key?(:order_id) end end # class OrdersCustomBatchRequest include Google::Apis::Core::Hashable # The request entries to be processed in the batch. # 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) @entries = args[:entries] if args.key?(:entries) end end # class OrdersCustomBatchRequestEntry include Google::Apis::Core::Hashable # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # Required for cancel method. # Corresponds to the JSON property `cancel` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancel] attr_accessor :cancel # Required for cancelLineItem method. # Corresponds to the JSON property `cancelLineItem` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancelLineItem] attr_accessor :cancel_line_item # Required for inStoreReturnLineItem method. # Corresponds to the JSON property `inStoreRefundLineItem` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryInStoreRefundLineItem] attr_accessor :in_store_refund_line_item # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # 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 to apply. # 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. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # 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. # Corresponds to the JSON property `refund` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryRefund] attr_accessor :refund # 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. # Corresponds to the JSON property `returnLineItem` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryReturnLineItem] attr_accessor :return_line_item # 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. # Corresponds to the JSON property `setLineItemMetadata` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntrySetLineItemMetadata] attr_accessor :set_line_item_metadata # Required for shipLineItems method. # Corresponds to the JSON property `shipLineItems` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryShipLineItems] attr_accessor :ship_line_items # 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. # Corresponds to the JSON property `updateShipment` # @return [Google::Apis::ContentV2::OrdersCustomBatchRequestEntryUpdateShipment] attr_accessor :update_shipment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @cancel = args[:cancel] if args.key?(:cancel) @cancel_line_item = args[:cancel_line_item] if args.key?(:cancel_line_item) @in_store_refund_line_item = args[:in_store_refund_line_item] if args.key?(:in_store_refund_line_item) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id) @method_prop = args[:method_prop] if args.key?(:method_prop) @operation_id = args[:operation_id] if args.key?(:operation_id) @order_id = args[:order_id] if args.key?(:order_id) @refund = args[:refund] if args.key?(:refund) @reject_return_line_item = args[:reject_return_line_item] if args.key?(:reject_return_line_item) @return_line_item = args[:return_line_item] if args.key?(:return_line_item) @return_refund_line_item = args[:return_refund_line_item] if args.key?(:return_refund_line_item) @set_line_item_metadata = args[:set_line_item_metadata] if args.key?(:set_line_item_metadata) @ship_line_items = args[:ship_line_items] if args.key?(:ship_line_items) @update_line_item_shipping_details = args[:update_line_item_shipping_details] if args.key?(:update_line_item_shipping_details) @update_shipment = args[:update_shipment] if args.key?(:update_shipment) end end # class OrdersCustomBatchRequestEntryCancel include Google::Apis::Core::Hashable # The reason for the cancellation. # 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 OrdersCustomBatchRequestEntryCancelLineItem include Google::Apis::Core::Hashable # Amount to refund for the cancelation. Optional. If not set, Google will # calculate the default based on the price and tax of the items involved. The # amount must not be larger than the net amount left on the order. # Corresponds to the JSON property `amount` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount # Amount to refund for the cancelation. Optional. If not set, Google will # calculate the default based on the price and tax of the items involved. The # amount must not be larger than the net amount left on the order. # Corresponds to the JSON property `amountPretax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_pretax # Tax amount that correspond to cancellation amount in amountPretax. # Corresponds to the JSON property `amountTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_tax # The ID of the line item to cancel. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the product to cancel. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity to cancel. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # The reason for the cancellation. # 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) @amount = args[:amount] if args.key?(:amount) @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersCustomBatchRequestEntryInStoreRefundLineItem include Google::Apis::Core::Hashable # The amount that is refunded. Required. # Corresponds to the JSON property `amountPretax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_pretax # Tax amount that correspond to refund amount in amountPretax. Required. # Corresponds to the JSON property `amountTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_tax # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the product to return. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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) @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersCustomBatchRequestEntryRefund include Google::Apis::Core::Hashable # The amount that is refunded. # Corresponds to the JSON property `amount` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount # The amount that is refunded. Either amount or amountPretax and amountTax # should be filled. # Corresponds to the JSON property `amountPretax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_pretax # Tax amount that correspond to refund amount in amountPretax. # Corresponds to the JSON property `amountTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_tax # The reason for the refund. # 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) @amount = args[:amount] if args.key?(:amount) @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersCustomBatchRequestEntryRejectReturnLineItem include Google::Apis::Core::Hashable # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the product to return. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersCustomBatchRequestEntryReturnLineItem include Google::Apis::Core::Hashable # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the product to return. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity to return. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersCustomBatchRequestEntryReturnRefundLineItem include Google::Apis::Core::Hashable # The amount that is refunded. Optional, but if filled then both amountPretax # and amountTax must be set. # Corresponds to the JSON property `amountPretax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_pretax # Tax amount that correspond to refund amount in amountPretax. # Corresponds to the JSON property `amountTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_tax # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the product to return. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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) @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersCustomBatchRequestEntrySetLineItemMetadata include Google::Apis::Core::Hashable # # Corresponds to the JSON property `annotations` # @return [Array] attr_accessor :annotations # The ID of the line item to set metadata. Either lineItemId or productId is # required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the product to set metadata. This is the REST ID used in the # products service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @annotations = args[:annotations] if args.key?(:annotations) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @product_id = args[:product_id] if args.key?(:product_id) end end # class OrdersCustomBatchRequestEntryShipLineItems 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. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Line items to ship. # Corresponds to the JSON property `lineItems` # @return [Array] attr_accessor :line_items # Deprecated. Please use shipmentInfo instead. The ID of the shipment. # Corresponds to the JSON property `shipmentId` # @return [String] attr_accessor :shipment_id # Shipment information. This field is repeated because a single line item can be # shipped in several packages (and have several tracking IDs). # Corresponds to the JSON property `shipmentInfos` # @return [Array] attr_accessor :shipment_infos # Deprecated. Please use shipmentInfo instead. The tracking id for the shipment. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @carrier = args[:carrier] if args.key?(:carrier) @line_items = args[:line_items] if args.key?(:line_items) @shipment_id = args[:shipment_id] if args.key?(:shipment_id) @shipment_infos = args[:shipment_infos] if args.key?(:shipment_infos) @tracking_id = args[:tracking_id] if args.key?(:tracking_id) end end # class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo include Google::Apis::Core::Hashable # 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] attr_accessor :carrier # The ID of the shipment. # Corresponds to the JSON property `shipmentId` # @return [String] attr_accessor :shipment_id # The tracking id for the shipment. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @carrier = args[:carrier] if args.key?(:carrier) @shipment_id = args[:shipment_id] if args.key?(:shipment_id) @tracking_id = args[:tracking_id] if args.key?(:tracking_id) end end # class OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails include Google::Apis::Core::Hashable # Updated delivery by date, in ISO 8601 format. If not specified only ship by # date is updated. # Corresponds to the JSON property `deliverByDate` # @return [String] attr_accessor :deliver_by_date # The ID of the line item to set metadata. Either lineItemId or productId is # required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the product to set metadata. This is the REST ID used in the # products service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Updated ship by date, in ISO 8601 format. If not specified only deliver by # date is updated. # Corresponds to the JSON property `shipByDate` # @return [String] attr_accessor :ship_by_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deliver_by_date = args[:deliver_by_date] if args.key?(:deliver_by_date) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @product_id = args[:product_id] if args.key?(:product_id) @ship_by_date = args[:ship_by_date] if args.key?(:ship_by_date) end end # 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. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # The ID of the shipment. # Corresponds to the JSON property `shipmentId` # @return [String] attr_accessor :shipment_id # New status for the shipment. Not updated if missing. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The tracking id for the shipment. Not updated if missing. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @carrier = args[:carrier] if args.key?(:carrier) @shipment_id = args[:shipment_id] if args.key?(:shipment_id) @status = args[:status] if args.key?(:status) @tracking_id = args[:tracking_id] if args.key?(:tracking_id) end end # class OrdersCustomBatchResponse include Google::Apis::Core::Hashable # The result of the execution of the batch requests. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Identifies what kind of resource this is. Value: the fixed string "content# # ordersCustomBatchResponse". # 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) @entries = args[:entries] if args.key?(:entries) @kind = args[:kind] if args.key?(:kind) end end # class OrdersCustomBatchResponseEntry include Google::Apis::Core::Hashable # The ID of the request entry this entry responds to. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors # The status of the execution. Only defined if the method is not get or # getByMerchantOrderId and if the request was successful. # 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". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The retrieved order. Only defined if the method is get and if the request was # successful. # Corresponds to the JSON property `order` # @return [Google::Apis::ContentV2::Order] attr_accessor :order def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @errors = args[:errors] if args.key?(:errors) @execution_status = args[:execution_status] if args.key?(:execution_status) @kind = args[:kind] if args.key?(:kind) @order = args[:order] if args.key?(:order) end end # class OrdersGetByMerchantOrderIdResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # ordersGetByMerchantOrderIdResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The requested order. # Corresponds to the JSON property `order` # @return [Google::Apis::ContentV2::Order] attr_accessor :order def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @order = args[:order] if args.key?(:order) end end # class OrdersGetTestOrderTemplateResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # ordersGetTestOrderTemplateResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The requested test order template. # Corresponds to the JSON property `template` # @return [Google::Apis::ContentV2::TestOrder] attr_accessor :template def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @template = args[:template] if args.key?(:template) end end # class OrdersInStoreRefundLineItemRequest include Google::Apis::Core::Hashable # The amount that is refunded. Required. # Corresponds to the JSON property `amountPretax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_pretax # Tax amount that correspond to refund amount in amountPretax. Required. # Corresponds to the JSON property `amountTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_tax # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The ID of the product to return. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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) @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersInStoreRefundLineItemResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersInStoreRefundLineItemResponse". # 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 OrdersListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # ordersListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token for the retrieval of the next page of orders. # 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 OrdersRefundRequest include Google::Apis::Core::Hashable # The amount that is refunded. # Corresponds to the JSON property `amount` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount # The amount that is refunded. Either amount or amountPretax and amountTax # should be filled. # Corresponds to the JSON property `amountPretax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_pretax # Tax amount that correspond to refund amount in amountPretax. # Corresponds to the JSON property `amountTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_tax # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The reason for the refund. # 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) @amount = args[:amount] if args.key?(:amount) @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @operation_id = args[:operation_id] if args.key?(:operation_id) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersRefundResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersRefundResponse". # 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 OrdersRejectReturnLineItemRequest include Google::Apis::Core::Hashable # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The ID of the product to return. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersRejectReturnLineItemResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersRejectReturnLineItemResponse". # 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 OrdersReturnLineItemRequest include Google::Apis::Core::Hashable # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The ID of the product to return. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity to return. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersReturnLineItemResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersReturnLineItemResponse". # 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 OrdersReturnRefundLineItemRequest include Google::Apis::Core::Hashable # The amount that is refunded. Optional, but if filled then both amountPretax # and amountTax must be set. # Corresponds to the JSON property `amountPretax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_pretax # Tax amount that correspond to refund amount in amountPretax. # Corresponds to the JSON property `amountTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_tax # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The ID of the product to return. This is the REST ID used in the products # service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity # 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) @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end # class OrdersReturnRefundLineItemResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersReturnRefundLineItemResponse". # 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 OrdersSetLineItemMetadataRequest include Google::Apis::Core::Hashable # # Corresponds to the JSON property `annotations` # @return [Array] attr_accessor :annotations # The ID of the line item to set metadata. Either lineItemId or productId is # required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The ID of the product to set metadata. This is the REST ID used in the # products service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @annotations = args[:annotations] if args.key?(:annotations) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) @product_id = args[:product_id] if args.key?(:product_id) end end # class OrdersSetLineItemMetadataResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersSetLineItemMetadataResponse". # 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 OrdersShipLineItemsRequest 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. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Line items to ship. # Corresponds to the JSON property `lineItems` # @return [Array] attr_accessor :line_items # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # Deprecated. Please use shipmentInfo instead. The ID of the shipment. # Corresponds to the JSON property `shipmentId` # @return [String] attr_accessor :shipment_id # Shipment information. This field is repeated because a single line item can be # shipped in several packages (and have several tracking IDs). # Corresponds to the JSON property `shipmentInfos` # @return [Array] attr_accessor :shipment_infos # Deprecated. Please use shipmentInfo instead. The tracking id for the shipment. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @carrier = args[:carrier] if args.key?(:carrier) @line_items = args[:line_items] if args.key?(:line_items) @operation_id = args[:operation_id] if args.key?(:operation_id) @shipment_id = args[:shipment_id] if args.key?(:shipment_id) @shipment_infos = args[:shipment_infos] if args.key?(:shipment_infos) @tracking_id = args[:tracking_id] if args.key?(:tracking_id) end end # class OrdersShipLineItemsResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersShipLineItemsResponse". # 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 OrdersUpdateLineItemShippingDetailsRequest include Google::Apis::Core::Hashable # Updated delivery by date, in ISO 8601 format. If not specified only ship by # date is updated. # Corresponds to the JSON property `deliverByDate` # @return [String] attr_accessor :deliver_by_date # The ID of the line item to set metadata. Either lineItemId or productId is # required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The ID of the product to set metadata. This is the REST ID used in the # products service. Either lineItemId or productId is required. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Updated ship by date, in ISO 8601 format. If not specified only deliver by # date is updated. # Corresponds to the JSON property `shipByDate` # @return [String] attr_accessor :ship_by_date def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deliver_by_date = args[:deliver_by_date] if args.key?(:deliver_by_date) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) @product_id = args[:product_id] if args.key?(:product_id) @ship_by_date = args[:ship_by_date] if args.key?(:ship_by_date) end end # class OrdersUpdateLineItemShippingDetailsResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersUpdateLineItemShippingDetailsResponse". # 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 OrdersUpdateMerchantOrderIdRequest include Google::Apis::Core::Hashable # The merchant order id to be assigned to the order. Must be unique per merchant. # Corresponds to the JSON property `merchantOrderId` # @return [String] attr_accessor :merchant_order_id # The ID of the operation. Unique across all operations for a given order. # 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) @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id) @operation_id = args[:operation_id] if args.key?(:operation_id) end end # class OrdersUpdateMerchantOrderIdResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersUpdateMerchantOrderIdResponse". # 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 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. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # The ID of the shipment. # Corresponds to the JSON property `shipmentId` # @return [String] attr_accessor :shipment_id # New status for the shipment. Not updated if missing. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The tracking id for the shipment. Not updated if missing. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @carrier = args[:carrier] if args.key?(:carrier) @operation_id = args[:operation_id] if args.key?(:operation_id) @shipment_id = args[:shipment_id] if args.key?(:shipment_id) @status = args[:status] if args.key?(:status) @tracking_id = args[:tracking_id] if args.key?(:tracking_id) end end # class OrdersUpdateShipmentResponse include Google::Apis::Core::Hashable # The status of the execution. # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# # ordersUpdateShipmentResponse". # 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 PostalCodeGroup include Google::Apis::Core::Hashable # The CLDR territory code of the country the postal code group applies to. # Required. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # The name of the postal code group, referred to in headers. Required. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A range of postal codes. Required. # Corresponds to the JSON property `postalCodeRanges` # @return [Array] attr_accessor :postal_code_ranges def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country = args[:country] if args.key?(:country) @name = args[:name] if args.key?(:name) @postal_code_ranges = args[:postal_code_ranges] if args.key?(:postal_code_ranges) end end # 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. # 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. # Corresponds to the JSON property `postalCodeRangeEnd` # @return [String] attr_accessor :postal_code_range_end def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @postal_code_range_begin = args[:postal_code_range_begin] if args.key?(:postal_code_range_begin) @postal_code_range_end = args[:postal_code_range_end] if args.key?(:postal_code_range_end) end end # class Price include Google::Apis::Core::Hashable # The currency of the price. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency # The price represented as a number. # 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) @currency = args[:currency] if args.key?(:currency) @value = args[:value] if args.key?(:value) end end # Product data. class Product include Google::Apis::Core::Hashable # Additional URLs of images of the item. # Corresponds to the JSON property `additionalImageLinks` # @return [Array] attr_accessor :additional_image_links # Additional categories of the item (formatted as in products feed specification) # . # Corresponds to the JSON property `additionalProductTypes` # @return [Array] attr_accessor :additional_product_types # Set to true if the item is targeted towards adults. # Corresponds to the JSON property `adult` # @return [Boolean] attr_accessor :adult alias_method :adult?, :adult # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. # Corresponds to the JSON property `adwordsGrouping` # @return [String] attr_accessor :adwords_grouping # Similar to adwords_grouping, but only works on CPC. # Corresponds to the JSON property `adwordsLabels` # @return [Array] attr_accessor :adwords_labels # Allows advertisers to override the item URL when the product is shown within # the context of Product Ads. # Corresponds to the JSON property `adwordsRedirect` # @return [String] attr_accessor :adwords_redirect # Target age group of the item. # Corresponds to the JSON property `ageGroup` # @return [String] attr_accessor :age_group # Specifies the intended aspects for the product. # Corresponds to the JSON property `aspects` # @return [Array] attr_accessor :aspects # Availability status of the item. # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability # The day a pre-ordered product becomes available for delivery, in ISO 8601 # format. # Corresponds to the JSON property `availabilityDate` # @return [String] attr_accessor :availability_date # Brand of the item. # Corresponds to the JSON property `brand` # @return [String] attr_accessor :brand # The item's channel (online or local). # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel # Color of the item. # Corresponds to the JSON property `color` # @return [String] attr_accessor :color # Condition or state of the item. # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition # The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language # 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", "type": "text", "value": "regular" `). This is useful # for submitting attributes not explicitly exposed by the API. # Corresponds to the JSON property `customAttributes` # @return [Array] attr_accessor :custom_attributes # A list of custom (merchant-provided) custom attribute groups. # Corresponds to the JSON property `customGroups` # @return [Array] attr_accessor :custom_groups # Custom label 0 for custom grouping of items in a Shopping campaign. # Corresponds to the JSON property `customLabel0` # @return [String] attr_accessor :custom_label0 # Custom label 1 for custom grouping of items in a Shopping campaign. # Corresponds to the JSON property `customLabel1` # @return [String] attr_accessor :custom_label1 # Custom label 2 for custom grouping of items in a Shopping campaign. # Corresponds to the JSON property `customLabel2` # @return [String] attr_accessor :custom_label2 # Custom label 3 for custom grouping of items in a Shopping campaign. # Corresponds to the JSON property `customLabel3` # @return [String] attr_accessor :custom_label3 # Custom label 4 for custom grouping of items in a Shopping campaign. # Corresponds to the JSON property `customLabel4` # @return [String] attr_accessor :custom_label4 # Description of the item. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Specifies the intended destinations for the product. # Corresponds to the JSON property `destinations` # @return [Array] attr_accessor :destinations # An identifier for an item for dynamic remarketing campaigns. # Corresponds to the JSON property `displayAdsId` # @return [String] attr_accessor :display_ads_id # URL directly to your item's landing page for dynamic remarketing campaigns. # Corresponds to the JSON property `displayAdsLink` # @return [String] attr_accessor :display_ads_link # Advertiser-specified recommendations. # Corresponds to the JSON property `displayAdsSimilarIds` # @return [Array] attr_accessor :display_ads_similar_ids # Title of an item for dynamic remarketing campaigns. # Corresponds to the JSON property `displayAdsTitle` # @return [String] attr_accessor :display_ads_title # Offer margin for dynamic remarketing campaigns. # Corresponds to the JSON property `displayAdsValue` # @return [Float] attr_accessor :display_ads_value # The energy efficiency class as defined in EU directive 2010/30/EU. # 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. # Corresponds to the JSON property `expirationDate` # @return [String] attr_accessor :expiration_date # Target gender of the item. # Corresponds to the JSON property `gender` # @return [String] attr_accessor :gender # Google's category of the item (see Google product taxonomy). # Corresponds to the JSON property `googleProductCategory` # @return [String] attr_accessor :google_product_category # Global Trade Item Number (GTIN) of the item. # Corresponds to the JSON property `gtin` # @return [String] attr_accessor :gtin # The REST id of the product. Content API methods that operate on products take # 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` # @return [String] attr_accessor :id # False when the item does not have unique product identifiers appropriate to # its category, such as GTIN, MPN, and brand. Required according to the Unique # Product Identifier Rules for all target countries except for Canada. # Corresponds to the JSON property `identifierExists` # @return [Boolean] attr_accessor :identifier_exists alias_method :identifier_exists?, :identifier_exists # URL of an image of the item. # Corresponds to the JSON property `imageLink` # @return [String] attr_accessor :image_link # Number and amount of installments to pay for an item. Brazil only. # Corresponds to the JSON property `installment` # @return [Google::Apis::ContentV2::Installment] attr_accessor :installment # Whether the item is a merchant-defined bundle. A bundle is a custom grouping # of different products sold by a merchant for a single price. # Corresponds to the JSON property `isBundle` # @return [Boolean] attr_accessor :is_bundle alias_method :is_bundle?, :is_bundle # Shared identifier for all variants of the same product. # Corresponds to the JSON property `itemGroupId` # @return [String] attr_accessor :item_group_id # Identifies what kind of resource this is. Value: the fixed string "content# # product". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # URL directly linking to your item's page on your website. # Corresponds to the JSON property `link` # @return [String] attr_accessor :link # Loyalty points that users receive after purchasing the item. Japan only. # Corresponds to the JSON property `loyaltyPoints` # @return [Google::Apis::ContentV2::LoyaltyPoints] attr_accessor :loyalty_points # The material of which the item is made. # Corresponds to the JSON property `material` # @return [String] attr_accessor :material # Maximal product handling time (in business days). # Corresponds to the JSON property `maxHandlingTime` # @return [Fixnum] attr_accessor :max_handling_time # Minimal product handling time (in business days). # Corresponds to the JSON property `minHandlingTime` # @return [Fixnum] attr_accessor :min_handling_time # Link to a mobile-optimized version of the landing page. # Corresponds to the JSON property `mobileLink` # @return [String] attr_accessor :mobile_link # Manufacturer Part Number (MPN) of the item. # Corresponds to the JSON property `mpn` # @return [String] attr_accessor :mpn # The number of identical products in a merchant-defined multipack. # Corresponds to the JSON property `multipack` # @return [Fixnum] attr_accessor :multipack # A unique identifier for the item. Leading and trailing whitespaces are # stripped and multiple whitespaces are replaced by a single whitespace upon # submission. Only valid unicode characters are accepted. See the products feed # specification for details. # Note: Content API methods that operate on products take the REST id of the # product, not this identifier. # Corresponds to the JSON property `offerId` # @return [String] attr_accessor :offer_id # Whether an item is available for purchase only online. # Corresponds to the JSON property `onlineOnly` # @return [Boolean] attr_accessor :online_only alias_method :online_only?, :online_only # The item's pattern (e.g. polka dots). # Corresponds to the JSON property `pattern` # @return [String] attr_accessor :pattern # Price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price # Your category of the item (formatted as in products feed specification). # Corresponds to the JSON property `productType` # @return [String] attr_accessor :product_type # The unique ID of a promotion. # Corresponds to the JSON property `promotionIds` # @return [Array] attr_accessor :promotion_ids # Advertised sale price of the item. # Corresponds to the JSON property `salePrice` # @return [Google::Apis::ContentV2::Price] attr_accessor :sale_price # Date range during which the item is on sale (see products feed specification). # Corresponds to the JSON property `salePriceEffectiveDate` # @return [String] attr_accessor :sale_price_effective_date # The quantity of the product that is reserved for sell-on-google ads. # Corresponds to the JSON property `sellOnGoogleQuantity` # @return [Fixnum] attr_accessor :sell_on_google_quantity # Shipping rules. # Corresponds to the JSON property `shipping` # @return [Array] attr_accessor :shipping # Height of the item for shipping. # Corresponds to the JSON property `shippingHeight` # @return [Google::Apis::ContentV2::ProductShippingDimension] attr_accessor :shipping_height # The shipping label of the product, used to group product in account-level # shipping rules. # Corresponds to the JSON property `shippingLabel` # @return [String] attr_accessor :shipping_label # Length of the item for shipping. # Corresponds to the JSON property `shippingLength` # @return [Google::Apis::ContentV2::ProductShippingDimension] attr_accessor :shipping_length # Weight of the item for shipping. # Corresponds to the JSON property `shippingWeight` # @return [Google::Apis::ContentV2::ProductShippingWeight] attr_accessor :shipping_weight # Width of the item for shipping. # Corresponds to the JSON property `shippingWidth` # @return [Google::Apis::ContentV2::ProductShippingDimension] attr_accessor :shipping_width # System in which the size is specified. Recommended for apparel items. # Corresponds to the JSON property `sizeSystem` # @return [String] attr_accessor :size_system # The cut of the item. Recommended for apparel items. # Corresponds to the JSON property `sizeType` # @return [String] attr_accessor :size_type # Size of the item. # Corresponds to the JSON property `sizes` # @return [Array] attr_accessor :sizes # The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country # Tax information. # Corresponds to the JSON property `taxes` # @return [Array] attr_accessor :taxes # Title of the item. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The preference of the denominator of the unit price. # Corresponds to the JSON property `unitPricingBaseMeasure` # @return [Google::Apis::ContentV2::ProductUnitPricingBaseMeasure] attr_accessor :unit_pricing_base_measure # The measure and dimension of an item. # Corresponds to the JSON property `unitPricingMeasure` # @return [Google::Apis::ContentV2::ProductUnitPricingMeasure] attr_accessor :unit_pricing_measure # The read-only list of intended destinations which passed validation. # Corresponds to the JSON property `validatedDestinations` # @return [Array] attr_accessor :validated_destinations # Read-only warnings. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @additional_image_links = args[:additional_image_links] if args.key?(:additional_image_links) @additional_product_types = args[:additional_product_types] if args.key?(:additional_product_types) @adult = args[:adult] if args.key?(:adult) @adwords_grouping = args[:adwords_grouping] if args.key?(:adwords_grouping) @adwords_labels = args[:adwords_labels] if args.key?(:adwords_labels) @adwords_redirect = args[:adwords_redirect] if args.key?(:adwords_redirect) @age_group = args[:age_group] if args.key?(:age_group) @aspects = args[:aspects] if args.key?(:aspects) @availability = args[:availability] if args.key?(:availability) @availability_date = args[:availability_date] if args.key?(:availability_date) @brand = args[:brand] if args.key?(:brand) @channel = args[:channel] if args.key?(:channel) @color = args[:color] if args.key?(:color) @condition = args[:condition] if args.key?(:condition) @content_language = args[:content_language] if args.key?(:content_language) @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes) @custom_groups = args[:custom_groups] if args.key?(:custom_groups) @custom_label0 = args[:custom_label0] if args.key?(:custom_label0) @custom_label1 = args[:custom_label1] if args.key?(:custom_label1) @custom_label2 = args[:custom_label2] if args.key?(:custom_label2) @custom_label3 = args[:custom_label3] if args.key?(:custom_label3) @custom_label4 = args[:custom_label4] if args.key?(:custom_label4) @description = args[:description] if args.key?(:description) @destinations = args[:destinations] if args.key?(:destinations) @display_ads_id = args[:display_ads_id] if args.key?(:display_ads_id) @display_ads_link = args[:display_ads_link] if args.key?(:display_ads_link) @display_ads_similar_ids = args[:display_ads_similar_ids] if args.key?(:display_ads_similar_ids) @display_ads_title = args[:display_ads_title] if args.key?(:display_ads_title) @display_ads_value = args[:display_ads_value] if args.key?(:display_ads_value) @energy_efficiency_class = args[:energy_efficiency_class] if args.key?(:energy_efficiency_class) @expiration_date = args[:expiration_date] if args.key?(:expiration_date) @gender = args[:gender] if args.key?(:gender) @google_product_category = args[:google_product_category] if args.key?(:google_product_category) @gtin = args[:gtin] if args.key?(:gtin) @id = args[:id] if args.key?(:id) @identifier_exists = args[:identifier_exists] if args.key?(:identifier_exists) @image_link = args[:image_link] if args.key?(:image_link) @installment = args[:installment] if args.key?(:installment) @is_bundle = args[:is_bundle] if args.key?(:is_bundle) @item_group_id = args[:item_group_id] if args.key?(:item_group_id) @kind = args[:kind] if args.key?(:kind) @link = args[:link] if args.key?(:link) @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points) @material = args[:material] if args.key?(:material) @max_handling_time = args[:max_handling_time] if args.key?(:max_handling_time) @min_handling_time = args[:min_handling_time] if args.key?(:min_handling_time) @mobile_link = args[:mobile_link] if args.key?(:mobile_link) @mpn = args[:mpn] if args.key?(:mpn) @multipack = args[:multipack] if args.key?(:multipack) @offer_id = args[:offer_id] if args.key?(:offer_id) @online_only = args[:online_only] if args.key?(:online_only) @pattern = args[:pattern] if args.key?(:pattern) @price = args[:price] if args.key?(:price) @product_type = args[:product_type] if args.key?(:product_type) @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids) @sale_price = args[:sale_price] if args.key?(:sale_price) @sale_price_effective_date = args[:sale_price_effective_date] if args.key?(:sale_price_effective_date) @sell_on_google_quantity = args[:sell_on_google_quantity] if args.key?(:sell_on_google_quantity) @shipping = args[:shipping] if args.key?(:shipping) @shipping_height = args[:shipping_height] if args.key?(:shipping_height) @shipping_label = args[:shipping_label] if args.key?(:shipping_label) @shipping_length = args[:shipping_length] if args.key?(:shipping_length) @shipping_weight = args[:shipping_weight] if args.key?(:shipping_weight) @shipping_width = args[:shipping_width] if args.key?(:shipping_width) @size_system = args[:size_system] if args.key?(:size_system) @size_type = args[:size_type] if args.key?(:size_type) @sizes = args[:sizes] if args.key?(:sizes) @target_country = args[:target_country] if args.key?(:target_country) @taxes = args[:taxes] if args.key?(:taxes) @title = args[:title] if args.key?(:title) @unit_pricing_base_measure = args[:unit_pricing_base_measure] if args.key?(:unit_pricing_base_measure) @unit_pricing_measure = args[:unit_pricing_measure] if args.key?(:unit_pricing_measure) @validated_destinations = args[:validated_destinations] if args.key?(:validated_destinations) @warnings = args[:warnings] if args.key?(:warnings) end end # class ProductAspect include Google::Apis::Core::Hashable # The name of the aspect. # Corresponds to the JSON property `aspectName` # @return [String] attr_accessor :aspect_name # The name of the destination. Leave out to apply to all destinations. # Corresponds to the JSON property `destinationName` # @return [String] attr_accessor :destination_name # Whether the aspect is required, excluded or should be validated. # Corresponds to the JSON property `intention` # @return [String] attr_accessor :intention def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aspect_name = args[:aspect_name] if args.key?(:aspect_name) @destination_name = args[:destination_name] if args.key?(:destination_name) @intention = args[:intention] if args.key?(:intention) end end # class ProductCustomAttribute include Google::Apis::Core::Hashable # The name of the attribute. Underscores will be replaced by spaces upon # insertion. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The type of the attribute. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Free-form unit of the attribute. Unit can only be used for values of type INT # or FLOAT. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # The 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) @type = args[:type] if args.key?(:type) @unit = args[:unit] if args.key?(:unit) @value = args[:value] if args.key?(:value) end end # class ProductCustomGroup include Google::Apis::Core::Hashable # The sub-attributes. # Corresponds to the JSON property `attributes` # @return [Array] attr_accessor :attributes # The name of the group. Underscores will be replaced by spaces upon insertion. # 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) @name = args[:name] if args.key?(:name) end end # class ProductDestination include Google::Apis::Core::Hashable # The name of the destination. # Corresponds to the JSON property `destinationName` # @return [String] attr_accessor :destination_name # Whether the destination is required, excluded or should be validated. # Corresponds to the JSON property `intention` # @return [String] attr_accessor :intention def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @destination_name = args[:destination_name] if args.key?(:destination_name) @intention = args[:intention] if args.key?(:intention) end end # class ProductShipping include Google::Apis::Core::Hashable # The CLDR territory code of the country to which an item will ship. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # The location where the shipping is applicable, represented by a location group # name. # Corresponds to the JSON property `locationGroupName` # @return [String] attr_accessor :location_group_name # The numeric id of a location that the shipping rate applies to as defined in # the AdWords API. # Corresponds to the JSON property `locationId` # @return [Fixnum] attr_accessor :location_id # The postal code range that the shipping rate applies to, represented by a # postal code, a postal code prefix followed by a * wildcard, a range between # two postal codes or two postal code prefixes of equal length. # Corresponds to the JSON property `postalCode` # @return [String] attr_accessor :postal_code # Fixed shipping price, represented as a number. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price # The geographic region to which a shipping rate applies. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # A free-form description of the service class or delivery speed. # 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) @country = args[:country] if args.key?(:country) @location_group_name = args[:location_group_name] if args.key?(:location_group_name) @location_id = args[:location_id] if args.key?(:location_id) @postal_code = args[:postal_code] if args.key?(:postal_code) @price = args[:price] if args.key?(:price) @region = args[:region] if args.key?(:region) @service = args[:service] if args.key?(:service) end end # class ProductShippingDimension include Google::Apis::Core::Hashable # The unit of value. # Acceptable values are: # - "cm" # - "in" # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # The dimension of the product used to calculate the shipping cost of the item. # 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) @unit = args[:unit] if args.key?(:unit) @value = args[:value] if args.key?(:value) end end # class ProductShippingWeight include Google::Apis::Core::Hashable # The unit of value. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # The weight of the product used to calculate the shipping cost of the item. # 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) @unit = args[:unit] if args.key?(:unit) @value = args[:value] if args.key?(:value) end end # The status of a product, i.e., information about a product computed # asynchronously by the data quality analysis. class ProductStatus include Google::Apis::Core::Hashable # Date on which the item has been created, in ISO 8601 format. # Corresponds to the JSON property `creationDate` # @return [String] attr_accessor :creation_date # A list of data quality issues associated with the product. # Corresponds to the JSON property `dataQualityIssues` # @return [Array] attr_accessor :data_quality_issues # The intended destinations for the product. # Corresponds to the JSON property `destinationStatuses` # @return [Array] attr_accessor :destination_statuses # Date on which the item expires in Google Shopping, in ISO 8601 format. # Corresponds to the JSON property `googleExpirationDate` # @return [String] attr_accessor :google_expiration_date # A list of all issues associated with the product. # Corresponds to the JSON property `itemLevelIssues` # @return [Array] attr_accessor :item_level_issues # Identifies what kind of resource this is. Value: the fixed string "content# # productStatus". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Date on which the item has been last updated, in ISO 8601 format. # Corresponds to the JSON property `lastUpdateDate` # @return [String] attr_accessor :last_update_date # The link to the product. # Corresponds to the JSON property `link` # @return [String] attr_accessor :link # Product data. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2::Product] attr_accessor :product # The id of the product for which status is reported. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # The title of the product. # 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) @creation_date = args[:creation_date] if args.key?(:creation_date) @data_quality_issues = args[:data_quality_issues] if args.key?(:data_quality_issues) @destination_statuses = args[:destination_statuses] if args.key?(:destination_statuses) @google_expiration_date = args[:google_expiration_date] if args.key?(:google_expiration_date) @item_level_issues = args[:item_level_issues] if args.key?(:item_level_issues) @kind = args[:kind] if args.key?(:kind) @last_update_date = args[:last_update_date] if args.key?(:last_update_date) @link = args[:link] if args.key?(:link) @product = args[:product] if args.key?(:product) @product_id = args[:product_id] if args.key?(:product_id) @title = args[:title] if args.key?(:title) end end # class ProductStatusDataQualityIssue include Google::Apis::Core::Hashable # A more detailed error string. # Corresponds to the JSON property `detail` # @return [String] attr_accessor :detail # The fetch status for landing_page_errors. # Corresponds to the JSON property `fetchStatus` # @return [String] attr_accessor :fetch_status # The id of the data quality issue. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # The attribute name that is relevant for the issue. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # The severity of the data quality issue. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity # The time stamp of the data quality issue. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp # The value of that attribute that was found on the landing page # Corresponds to the JSON property `valueOnLandingPage` # @return [String] attr_accessor :value_on_landing_page # The value the attribute had at time of evaluation. # Corresponds to the JSON property `valueProvided` # @return [String] attr_accessor :value_provided def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @detail = args[:detail] if args.key?(:detail) @fetch_status = args[:fetch_status] if args.key?(:fetch_status) @id = args[:id] if args.key?(:id) @location = args[:location] if args.key?(:location) @severity = args[:severity] if args.key?(:severity) @timestamp = args[:timestamp] if args.key?(:timestamp) @value_on_landing_page = args[:value_on_landing_page] if args.key?(:value_on_landing_page) @value_provided = args[:value_provided] if args.key?(:value_provided) end end # class ProductStatusDestinationStatus include Google::Apis::Core::Hashable # Whether the approval status might change due to further processing. # Corresponds to the JSON property `approvalPending` # @return [Boolean] attr_accessor :approval_pending alias_method :approval_pending?, :approval_pending # The destination's approval status. # Corresponds to the JSON property `approvalStatus` # @return [String] attr_accessor :approval_status # The name of the destination # Corresponds to the JSON property `destination` # @return [String] attr_accessor :destination # Provided for backward compatibility only. Always set to "required". # Corresponds to the JSON property `intention` # @return [String] attr_accessor :intention def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @approval_pending = args[:approval_pending] if args.key?(:approval_pending) @approval_status = args[:approval_status] if args.key?(:approval_status) @destination = args[:destination] if args.key?(:destination) @intention = args[:intention] if args.key?(:intention) end end # class ProductStatusItemLevelIssue include Google::Apis::Core::Hashable # The attribute's name, if the issue is caused by a single attribute. # Corresponds to the JSON property `attributeName` # @return [String] attr_accessor :attribute_name # The error code of the issue. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # The destination the issue applies to. # Corresponds to the JSON property `destination` # @return [String] attr_accessor :destination # Whether the issue can be resolved by the merchant. # Corresponds to the JSON property `resolution` # @return [String] attr_accessor :resolution # How this issue affects serving of the offer. # Corresponds to the JSON property `servability` # @return [String] attr_accessor :servability def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @attribute_name = args[:attribute_name] if args.key?(:attribute_name) @code = args[:code] if args.key?(:code) @destination = args[:destination] if args.key?(:destination) @resolution = args[:resolution] if args.key?(:resolution) @servability = args[:servability] if args.key?(:servability) end end # class ProductTax include Google::Apis::Core::Hashable # The country within which the item is taxed, specified as a CLDR territory code. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # The numeric id of a location that the tax rate applies to as defined in the # AdWords API. # Corresponds to the JSON property `locationId` # @return [Fixnum] attr_accessor :location_id # The postal code range that the tax rate applies to, represented by a ZIP code, # a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP # code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*. # Corresponds to the JSON property `postalCode` # @return [String] attr_accessor :postal_code # The percentage of tax rate that applies to the item price. # Corresponds to the JSON property `rate` # @return [Float] attr_accessor :rate # The geographic region to which the tax rate applies. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # Set to true if tax is charged on shipping. # Corresponds to the JSON property `taxShip` # @return [Boolean] attr_accessor :tax_ship alias_method :tax_ship?, :tax_ship def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country = args[:country] if args.key?(:country) @location_id = args[:location_id] if args.key?(:location_id) @postal_code = args[:postal_code] if args.key?(:postal_code) @rate = args[:rate] if args.key?(:rate) @region = args[:region] if args.key?(:region) @tax_ship = args[:tax_ship] if args.key?(:tax_ship) end end # class ProductUnitPricingBaseMeasure include Google::Apis::Core::Hashable # The unit of the denominator. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # The denominator of the unit price. # Corresponds to the JSON property `value` # @return [Fixnum] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @unit = args[:unit] if args.key?(:unit) @value = args[:value] if args.key?(:value) end end # class ProductUnitPricingMeasure include Google::Apis::Core::Hashable # The unit of the measure. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # The measure of an item. # 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) @unit = args[:unit] if args.key?(:unit) @value = args[:value] if args.key?(:value) end end # class BatchProductsRequest include Google::Apis::Core::Hashable # The request entries to be processed in the batch. # 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) @entries = args[:entries] if args.key?(:entries) end end # A batch entry encoding a single non-batch products request. class ProductsBatchRequestEntry include Google::Apis::Core::Hashable # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method # Product data. # 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. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @request_method = args[:request_method] if args.key?(:request_method) @product = args[:product] if args.key?(:product) @product_id = args[:product_id] if args.key?(:product_id) end end # class BatchProductsResponse include Google::Apis::Core::Hashable # The result of the execution of the batch requests. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Identifies what kind of resource this is. Value: the fixed string "content# # productsCustomBatchResponse". # 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) @entries = args[:entries] if args.key?(:entries) @kind = args[:kind] if args.key?(:kind) end end # A batch entry encoding a single non-batch products response. class ProductsBatchResponseEntry include Google::Apis::Core::Hashable # The ID of the request entry this entry responds to. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors # Identifies what kind of resource this is. Value: the fixed string "content# # productsCustomBatchResponseEntry". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Product data. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2::Product] attr_accessor :product def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) @product = args[:product] if args.key?(:product) end end # class ListProductsResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # productsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token for the retrieval of the next page of products. # 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 BatchProductStatusesRequest include Google::Apis::Core::Hashable # The request entries to be processed in the batch. # 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) @entries = args[:entries] if args.key?(:entries) end end # A batch entry encoding a single non-batch productstatuses request. class ProductStatusesBatchRequestEntry include Google::Apis::Core::Hashable # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # # Corresponds to the JSON property `includeAttributes` # @return [Boolean] attr_accessor :include_attributes alias_method :include_attributes?, :include_attributes # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method # The ID of the product whose status to get. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @include_attributes = args[:include_attributes] if args.key?(:include_attributes) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @request_method = args[:request_method] if args.key?(:request_method) @product_id = args[:product_id] if args.key?(:product_id) end end # class BatchProductStatusesResponse include Google::Apis::Core::Hashable # The result of the execution of the batch requests. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Identifies what kind of resource this is. Value: the fixed string "content# # productstatusesCustomBatchResponse". # 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) @entries = args[:entries] if args.key?(:entries) @kind = args[:kind] if args.key?(:kind) end end # A batch entry encoding a single non-batch productstatuses response. class ProductStatusesBatchResponseEntry include Google::Apis::Core::Hashable # The ID of the request entry this entry responds to. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors # Identifies what kind of resource this is. Value: the fixed string "content# # productstatusesCustomBatchResponseEntry". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The status of a product, i.e., information about a product computed # asynchronously by the data quality analysis. # Corresponds to the JSON property `productStatus` # @return [Google::Apis::ContentV2::ProductStatus] attr_accessor :product_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) @product_status = args[:product_status] if args.key?(:product_status) end end # class ListProductStatusesResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # productstatusesListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token for the retrieval of the next page of products statuses. # 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 RateGroup include Google::Apis::Core::Hashable # A list of shipping labels defining the products to which this rate group # applies to. This is a disjunction: only one of the labels has to match for the # rate group to apply. May only be empty for the last rate group of a service. # Required. # Corresponds to the JSON property `applicableShippingLabels` # @return [Array] attr_accessor :applicable_shipping_labels # 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. # Corresponds to the JSON property `mainTable` # @return [Google::Apis::ContentV2::Table] attr_accessor :main_table # 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. # 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. # Corresponds to the JSON property `subtables` # @return [Array] attr_accessor :subtables def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @applicable_shipping_labels = args[:applicable_shipping_labels] if args.key?(:applicable_shipping_labels) @carrier_rates = args[:carrier_rates] if args.key?(:carrier_rates) @main_table = args[:main_table] if args.key?(:main_table) @single_value = args[:single_value] if args.key?(:single_value) @subtables = args[:subtables] if args.key?(:subtables) end end # 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 # tables. Required. # Corresponds to the JSON property `cells` # @return [Array] attr_accessor :cells def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cells = args[:cells] if args.key?(:cells) end end # class Service include Google::Apis::Core::Hashable # A boolean exposing the active status of the shipping service. Required. # Corresponds to the JSON property `active` # @return [Boolean] attr_accessor :active alias_method :active?, :active # The CLDR code of the currency to which this service applies. Must match that # of the prices in rate groups. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency # The CLDR territory code of the country to which the service applies. Required. # Corresponds to the JSON property `deliveryCountry` # @return [String] attr_accessor :delivery_country # Time spent in various aspects from order to the delivery of the product. # Required. # Corresponds to the JSON property `deliveryTime` # @return [Google::Apis::ContentV2::DeliveryTime] attr_accessor :delivery_time # 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. # Corresponds to the JSON property `minimumOrderValue` # @return [Google::Apis::ContentV2::Price] attr_accessor :minimum_order_value # Free-form name of the service. Must be unique within target account. Required. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # 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. # Corresponds to the JSON property `rateGroups` # @return [Array] attr_accessor :rate_groups def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @active = args[:active] if args.key?(:active) @currency = args[:currency] if args.key?(:currency) @delivery_country = args[:delivery_country] if args.key?(:delivery_country) @delivery_time = args[:delivery_time] if args.key?(:delivery_time) @minimum_order_value = args[:minimum_order_value] if args.key?(:minimum_order_value) @name = args[:name] if args.key?(:name) @rate_groups = args[:rate_groups] if args.key?(:rate_groups) end end # The merchant account's shipping settings. class ShippingSettings include Google::Apis::Core::Hashable # The ID of the account to which these account shipping settings belong. Ignored # upon update, always present in get request responses. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # 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 # The target account's list of services. Optional. # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @postal_code_groups = args[:postal_code_groups] if args.key?(:postal_code_groups) @services = args[:services] if args.key?(:services) end end # class ShippingsettingsCustomBatchRequest include Google::Apis::Core::Hashable # The request entries to be processed in the batch. # 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) @entries = args[:entries] if args.key?(:entries) end end # A batch entry encoding a single non-batch shippingsettings request. class ShippingsettingsCustomBatchRequestEntry include Google::Apis::Core::Hashable # The ID of the account for which to get/update account shipping settings. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id # # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # The merchant account's shipping settings. # Corresponds to the JSON property `shippingSettings` # @return [Google::Apis::ContentV2::ShippingSettings] attr_accessor :shipping_settings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @batch_id = args[:batch_id] if args.key?(:batch_id) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @method_prop = args[:method_prop] if args.key?(:method_prop) @shipping_settings = args[:shipping_settings] if args.key?(:shipping_settings) end end # class ShippingsettingsCustomBatchResponse include Google::Apis::Core::Hashable # The result of the execution of the batch requests. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # Identifies what kind of resource this is. Value: the fixed string "content# # shippingsettingsCustomBatchResponse". # 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) @entries = args[:entries] if args.key?(:entries) @kind = args[:kind] if args.key?(:kind) end end # A batch entry encoding a single non-batch shipping settings response. class ShippingsettingsCustomBatchResponseEntry include Google::Apis::Core::Hashable # The ID of the request entry to which this entry responds. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors # Identifies what kind of resource this is. Value: the fixed string "content# # shippingsettingsCustomBatchResponseEntry". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The merchant account's shipping settings. # Corresponds to the JSON property `shippingSettings` # @return [Google::Apis::ContentV2::ShippingSettings] attr_accessor :shipping_settings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch_id = args[:batch_id] if args.key?(:batch_id) @errors = args[:errors] if args.key?(:errors) @kind = args[:kind] if args.key?(:kind) @shipping_settings = args[:shipping_settings] if args.key?(:shipping_settings) end end # class ShippingsettingsGetSupportedCarriersResponse include Google::Apis::Core::Hashable # A list of supported carriers. May be empty. # Corresponds to the JSON property `carriers` # @return [Array] attr_accessor :carriers # Identifies what kind of resource this is. Value: the fixed string "content# # shippingsettingsGetSupportedCarriersResponse". # 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) @carriers = args[:carriers] if args.key?(:carriers) @kind = args[:kind] if args.key?(:kind) end end # class ShippingsettingsGetSupportedHolidaysResponse include Google::Apis::Core::Hashable # A list of holidays applicable for delivery guarantees. May be empty. # Corresponds to the JSON property `holidays` # @return [Array] attr_accessor :holidays # Identifies what kind of resource this is. Value: the fixed string "content# # shippingsettingsGetSupportedHolidaysResponse". # 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) @holidays = args[:holidays] if args.key?(:holidays) @kind = args[:kind] if args.key?(:kind) end end # class ShippingsettingsListResponse include Google::Apis::Core::Hashable # Identifies what kind of resource this is. Value: the fixed string "content# # shippingsettingsListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token for the retrieval of the next page of shipping settings. # 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 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 locations must be set. # Corresponds to the JSON property `columnHeaders` # @return [Google::Apis::ContentV2::Headers] attr_accessor :column_headers # Name of the table. Required for subtables, ignored for the main table. # Corresponds to the JSON property `name` # @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 locations 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. # Corresponds to the JSON property `rows` # @return [Array] attr_accessor :rows def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @column_headers = args[:column_headers] if args.key?(:column_headers) @name = args[:name] if args.key?(:name) @row_headers = args[:row_headers] if args.key?(:row_headers) @rows = args[:rows] if args.key?(:rows) end end # class TestOrder include Google::Apis::Core::Hashable # The details of the customer who placed the order. # Corresponds to the JSON property `customer` # @return [Google::Apis::ContentV2::TestOrderCustomer] attr_accessor :customer # Identifies what kind of resource this is. Value: the fixed string "content# # testOrder". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Line items that are ordered. At least one line item must be provided. # Corresponds to the JSON property `lineItems` # @return [Array] attr_accessor :line_items # Determines if test order must be pulled by merchant or pushed to merchant via # push integration. # Corresponds to the JSON property `notificationMode` # @return [String] attr_accessor :notification_mode # The details of the payment method. # Corresponds to the JSON property `paymentMethod` # @return [Google::Apis::ContentV2::TestOrderPaymentMethod] attr_accessor :payment_method # Identifier of one of the predefined delivery addresses for the delivery. # Corresponds to the JSON property `predefinedDeliveryAddress` # @return [String] attr_accessor :predefined_delivery_address # The details of the merchant provided promotions applied to the order. More # details about the program are here. # Corresponds to the JSON property `promotions` # @return [Array] attr_accessor :promotions # The total cost of shipping for all items. # Corresponds to the JSON property `shippingCost` # @return [Google::Apis::ContentV2::Price] attr_accessor :shipping_cost # The tax for the total shipping cost. # Corresponds to the JSON property `shippingCostTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :shipping_cost_tax # The requested shipping option. # Corresponds to the JSON property `shippingOption` # @return [String] attr_accessor :shipping_option def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @customer = args[:customer] if args.key?(:customer) @kind = args[:kind] if args.key?(:kind) @line_items = args[:line_items] if args.key?(:line_items) @notification_mode = args[:notification_mode] if args.key?(:notification_mode) @payment_method = args[:payment_method] if args.key?(:payment_method) @predefined_delivery_address = args[:predefined_delivery_address] if args.key?(:predefined_delivery_address) @promotions = args[:promotions] if args.key?(:promotions) @shipping_cost = args[:shipping_cost] if args.key?(:shipping_cost) @shipping_cost_tax = args[:shipping_cost_tax] if args.key?(:shipping_cost_tax) @shipping_option = args[:shipping_option] if args.key?(:shipping_option) end end # class TestOrderCustomer include Google::Apis::Core::Hashable # Email address of the customer. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # If set, this indicates the user explicitly chose to opt in or out of providing # marketing rights to the merchant. If unset, this indicates the user has # already made this choice in a previous purchase, and was thus not shown the # marketing right opt in/out checkbox during the checkout flow. Optional. # Corresponds to the JSON property `explicitMarketingPreference` # @return [Boolean] attr_accessor :explicit_marketing_preference alias_method :explicit_marketing_preference?, :explicit_marketing_preference # Full name of the customer. # Corresponds to the JSON property `fullName` # @return [String] attr_accessor :full_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) @explicit_marketing_preference = args[:explicit_marketing_preference] if args.key?(:explicit_marketing_preference) @full_name = args[:full_name] if args.key?(:full_name) end end # class TestOrderLineItem include Google::Apis::Core::Hashable # Product data from the time of the order placement. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2::TestOrderLineItemProduct] attr_accessor :product # Number of items ordered. # Corresponds to the JSON property `quantityOrdered` # @return [Fixnum] attr_accessor :quantity_ordered # Details of the return policy for the line item. # Corresponds to the JSON property `returnInfo` # @return [Google::Apis::ContentV2::OrderLineItemReturnInfo] attr_accessor :return_info # Details of the requested shipping for the line item. # Corresponds to the JSON property `shippingDetails` # @return [Google::Apis::ContentV2::OrderLineItemShippingDetails] attr_accessor :shipping_details # Unit tax for the line item. # Corresponds to the JSON property `unitTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :unit_tax def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @product = args[:product] if args.key?(:product) @quantity_ordered = args[:quantity_ordered] if args.key?(:quantity_ordered) @return_info = args[:return_info] if args.key?(:return_info) @shipping_details = args[:shipping_details] if args.key?(:shipping_details) @unit_tax = args[:unit_tax] if args.key?(:unit_tax) end end # class TestOrderLineItemProduct include Google::Apis::Core::Hashable # Brand of the item. # Corresponds to the JSON property `brand` # @return [String] attr_accessor :brand # The item's channel. # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel # Condition or state of the item. # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition # The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language # Global Trade Item Number (GTIN) of the item. Optional. # Corresponds to the JSON property `gtin` # @return [String] attr_accessor :gtin # URL of an image of the item. # Corresponds to the JSON property `imageLink` # @return [String] attr_accessor :image_link # Shared identifier for all variants of the same product. Optional. # Corresponds to the JSON property `itemGroupId` # @return [String] attr_accessor :item_group_id # Manufacturer Part Number (MPN) of the item. Optional. # Corresponds to the JSON property `mpn` # @return [String] attr_accessor :mpn # An identifier of the item. # Corresponds to the JSON property `offerId` # @return [String] attr_accessor :offer_id # The price for the product. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price # The CLDR territory code of the target country of the product. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country # The title of the product. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Variant attributes for the item. Optional. # Corresponds to the JSON property `variantAttributes` # @return [Array] attr_accessor :variant_attributes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @brand = args[:brand] if args.key?(:brand) @channel = args[:channel] if args.key?(:channel) @condition = args[:condition] if args.key?(:condition) @content_language = args[:content_language] if args.key?(:content_language) @gtin = args[:gtin] if args.key?(:gtin) @image_link = args[:image_link] if args.key?(:image_link) @item_group_id = args[:item_group_id] if args.key?(:item_group_id) @mpn = args[:mpn] if args.key?(:mpn) @offer_id = args[:offer_id] if args.key?(:offer_id) @price = args[:price] if args.key?(:price) @target_country = args[:target_country] if args.key?(:target_country) @title = args[:title] if args.key?(:title) @variant_attributes = args[:variant_attributes] if args.key?(:variant_attributes) end end # class TestOrderPaymentMethod include Google::Apis::Core::Hashable # The card expiration month (January = 1, February = 2 etc.). # Corresponds to the JSON property `expirationMonth` # @return [Fixnum] attr_accessor :expiration_month # The card expiration year (4-digit, e.g. 2015). # Corresponds to the JSON property `expirationYear` # @return [Fixnum] attr_accessor :expiration_year # The last four digits of the card number. # Corresponds to the JSON property `lastFourDigits` # @return [String] attr_accessor :last_four_digits # The billing address. # 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. # 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) @expiration_month = args[:expiration_month] if args.key?(:expiration_month) @expiration_year = args[:expiration_year] if args.key?(:expiration_year) @last_four_digits = args[:last_four_digits] if args.key?(:last_four_digits) @predefined_billing_address = args[:predefined_billing_address] if args.key?(:predefined_billing_address) @type = args[:type] if args.key?(:type) end 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. class Value include Google::Apis::Core::Hashable # The name of a carrier rate referring to a carrier rate defined in the same # rate group. Can only be set if all other fields are not set. # Corresponds to the JSON property `carrierRateName` # @return [String] attr_accessor :carrier_rate_name # A flat rate. Can only be set if all other fields are not set. # Corresponds to the JSON property `flatRate` # @return [Google::Apis::ContentV2::Price] attr_accessor :flat_rate # If true, then the product can't ship. Must be true when set, can only be set # if all other fields are not set. # Corresponds to the JSON property `noShipping` # @return [Boolean] 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. # Corresponds to the JSON property `pricePercentage` # @return [String] attr_accessor :price_percentage # The name of a subtable. Can only be set in table cells (i.e., not for single # values), and only if all other fields are not set. # Corresponds to the JSON property `subtableName` # @return [String] attr_accessor :subtable_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @carrier_rate_name = args[:carrier_rate_name] if args.key?(:carrier_rate_name) @flat_rate = args[:flat_rate] if args.key?(:flat_rate) @no_shipping = args[:no_shipping] if args.key?(:no_shipping) @price_percentage = args[:price_percentage] if args.key?(:price_percentage) @subtable_name = args[:subtable_name] if args.key?(:subtable_name) end end # class Weight include Google::Apis::Core::Hashable # The weight unit. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # The weight represented as a number. # 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) @unit = args[:unit] if args.key?(:unit) @value = args[:value] if args.key?(:value) end end end end end google-api-client-0.19.8/generated/google/apis/content_v2/service.rb0000644000004100000410000052231313252673043025367 0ustar www-datawww-data# 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 ContentV2 # Content API for Shopping # # Manages product items, inventory, and Merchant Center accounts for Google # Shopping. # # @example # require 'google/apis/content_v2' # # Content = Google::Apis::ContentV2 # Alias the module # service = Content::ShoppingContentService.new # # @see https://developers.google.com/shopping-content class ShoppingContentService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'content/v2/') @batch_path = 'batch/content/v2' end # Returns information about the authenticated user. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::AccountsAuthInfoResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::AccountsAuthInfoResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_authinfo(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'accounts/authinfo', options) command.response_representation = Google::Apis::ContentV2::AccountsAuthInfoResponse::Representation command.response_class = Google::Apis::ContentV2::AccountsAuthInfoResponse 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 # 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. # @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 # with a claim from this account. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::AccountsClaimWebsiteResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::AccountsClaimWebsiteResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def claimwebsite_account(merchant_id, account_id, overwrite: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/accounts/{accountId}/claimwebsite', options) command.response_representation = Google::Apis::ContentV2::AccountsClaimWebsiteResponse::Representation command.response_class = Google::Apis::ContentV2::AccountsClaimWebsiteResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_id.nil? command.query['overwrite'] = overwrite unless overwrite.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, inserts, updates, and deletes multiple Merchant Center (sub-) # accounts in a single request. # @param [Google::Apis::ContentV2::BatchAccountsRequest] batch_accounts_request_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::BatchAccountsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::BatchAccountsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(batch_accounts_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounts/batch', options) command.request_representation = Google::Apis::ContentV2::BatchAccountsRequest::Representation command.request_object = batch_accounts_request_object command.response_representation = Google::Apis::ContentV2::BatchAccountsResponse::Representation command.response_class = Google::Apis::ContentV2::BatchAccountsResponse command.query['dryRun'] = dry_run unless dry_run.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 a Merchant Center sub-account. # @param [Fixnum] merchant_id # The ID of the managing account. This 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 [Boolean] dry_run # Flag to run the request in dry-run mode. # @param [Boolean] force # Flag to delete sub-accounts with products. The default value 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_account(merchant_id, account_id, dry_run: nil, force: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{merchantId}/accounts/{accountId}', options) command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_id.nil? command.query['dryRun'] = dry_run unless dry_run.nil? command.query['force'] = force unless force.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 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. # @param [Fixnum] account_id # The ID of the account. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/accounts/{accountId}', options) command.response_representation = Google::Apis::ContentV2::Account::Representation command.response_class = Google::Apis::ContentV2::Account command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_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 Merchant Center sub-account. # @param [Fixnum] merchant_id # The ID of the managing account. This must be a multi-client account. # @param [Google::Apis::ContentV2::Account] account_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(merchant_id, account_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/accounts', options) command.request_representation = Google::Apis::ContentV2::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::ContentV2::Account::Representation command.response_class = Google::Apis::ContentV2::Account command.params['merchantId'] = merchant_id unless merchant_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 sub-accounts in your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the managing account. This must be a multi-client account. # @param [Fixnum] max_results # The maximum number of accounts to return in the response, used for paging. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ListAccountsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ListAccountsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_accounts(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/accounts', options) command.response_representation = Google::Apis::ContentV2::ListAccountsResponse::Representation command.response_class = Google::Apis::ContentV2::ListAccountsResponse 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['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 a Merchant Center account. This method supports patch semantics. # @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. # @param [Fixnum] account_id # The ID of the account. # @param [Google::Apis::ContentV2::Account] account_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(merchant_id, account_id, account_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{merchantId}/accounts/{accountId}', options) command.request_representation = Google::Apis::ContentV2::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::ContentV2::Account::Representation command.response_class = Google::Apis::ContentV2::Account command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 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. # @param [Fixnum] account_id # The ID of the account. # @param [Google::Apis::ContentV2::Account] account_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Account] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Account] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account(merchant_id, account_id, account_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{merchantId}/accounts/{accountId}', options) command.request_representation = Google::Apis::ContentV2::Account::Representation command.request_object = account_object command.response_representation = Google::Apis::ContentV2::Account::Representation command.response_class = Google::Apis::ContentV2::Account command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 [Google::Apis::ContentV2::BatchAccountStatusesRequest] batch_account_statuses_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::BatchAccountStatusesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::BatchAccountStatusesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_status(batch_account_statuses_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accountstatuses/batch', options) command.request_representation = Google::Apis::ContentV2::BatchAccountStatusesRequest::Representation command.request_object = batch_account_statuses_request_object command.response_representation = Google::Apis::ContentV2::BatchAccountStatusesResponse::Representation command.response_class = Google::Apis::ContentV2::BatchAccountStatusesResponse 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 the status of 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. # @param [Fixnum] account_id # The ID of the account. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::AccountStatus] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::AccountStatus] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_status(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/accountstatuses/{accountId}', options) command.response_representation = Google::Apis::ContentV2::AccountStatus::Representation command.response_class = Google::Apis::ContentV2::AccountStatus command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_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 statuses of the sub-accounts in your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the managing account. This must be a multi-client account. # @param [Fixnum] max_results # The maximum number of account statuses to return in the response, used for # paging. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ListAccountStatusesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ListAccountStatusesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_statuses(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/accountstatuses', options) command.response_representation = Google::Apis::ContentV2::ListAccountStatusesResponse::Representation command.response_class = Google::Apis::ContentV2::ListAccountStatusesResponse 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['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 tax settings of multiple accounts in a single request. # @param [Google::Apis::ContentV2::BatchAccountTaxRequest] batch_account_tax_request_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::BatchAccountTaxResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::BatchAccountTaxResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_tax(batch_account_tax_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'accounttax/batch', options) command.request_representation = Google::Apis::ContentV2::BatchAccountTaxRequest::Representation command.request_object = batch_account_tax_request_object command.response_representation = Google::Apis::ContentV2::BatchAccountTaxResponse::Representation command.response_class = Google::Apis::ContentV2::BatchAccountTaxResponse command.query['dryRun'] = dry_run unless dry_run.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 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. # @param [Fixnum] account_id # The ID of the account for which to get/update account tax settings. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::AccountTax] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::AccountTax] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_tax(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/accounttax/{accountId}', options) command.response_representation = Google::Apis::ContentV2::AccountTax::Representation command.response_class = Google::Apis::ContentV2::AccountTax command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_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 tax settings of the sub-accounts in your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the managing account. This must be a multi-client account. # @param [Fixnum] max_results # The maximum number of tax settings to return in the response, used for paging. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ListAccountTaxResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ListAccountTaxResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_taxes(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/accounttax', options) command.response_representation = Google::Apis::ContentV2::ListAccountTaxResponse::Representation command.response_class = Google::Apis::ContentV2::ListAccountTaxResponse 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['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 tax settings of the account. This method supports patch semantics. # @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. # @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 # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::AccountTax] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::AccountTax] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_tax(merchant_id, account_id, account_tax_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{merchantId}/accounttax/{accountId}', options) command.request_representation = Google::Apis::ContentV2::AccountTax::Representation command.request_object = account_tax_object command.response_representation = Google::Apis::ContentV2::AccountTax::Representation command.response_class = Google::Apis::ContentV2::AccountTax command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 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. # @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 # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::AccountTax] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::AccountTax] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_account_tax(merchant_id, account_id, account_tax_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{merchantId}/accounttax/{accountId}', options) command.request_representation = Google::Apis::ContentV2::AccountTax::Representation command.request_object = account_tax_object command.response_representation = Google::Apis::ContentV2::AccountTax::Representation command.response_class = Google::Apis::ContentV2::AccountTax command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 [Google::Apis::ContentV2::BatchDatafeedsRequest] batch_datafeeds_request_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::BatchDatafeedsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::BatchDatafeedsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_datafeed(batch_datafeeds_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'datafeeds/batch', options) command.request_representation = Google::Apis::ContentV2::BatchDatafeedsRequest::Representation command.request_object = batch_datafeeds_request_object command.response_representation = Google::Apis::ContentV2::BatchDatafeedsResponse::Representation command.response_class = Google::Apis::ContentV2::BatchDatafeedsResponse command.query['dryRun'] = dry_run unless dry_run.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 a datafeed configuration from your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that manages the datafeed. This account cannot be a # multi-client account. # @param [Fixnum] datafeed_id # The ID of the datafeed. # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_datafeed(merchant_id, datafeed_id, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{merchantId}/datafeeds/{datafeedId}', options) command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['datafeedId'] = datafeed_id unless datafeed_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 datafeed configuration from your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that manages the datafeed. This account cannot be a # multi-client account. # @param [Fixnum] datafeed_id # The ID of the datafeed. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Datafeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Datafeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_datafeed(merchant_id, datafeed_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/datafeeds/{datafeedId}', options) command.response_representation = Google::Apis::ContentV2::Datafeed::Representation command.response_class = Google::Apis::ContentV2::Datafeed command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['datafeedId'] = datafeed_id unless datafeed_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 # Registers a datafeed configuration with your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that manages the datafeed. This account cannot be a # multi-client account. # @param [Google::Apis::ContentV2::Datafeed] datafeed_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Datafeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Datafeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_datafeed(merchant_id, datafeed_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/datafeeds', options) command.request_representation = Google::Apis::ContentV2::Datafeed::Representation command.request_object = datafeed_object command.response_representation = Google::Apis::ContentV2::Datafeed::Representation command.response_class = Google::Apis::ContentV2::Datafeed command.params['merchantId'] = merchant_id unless merchant_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 configurations for datafeeds in your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that manages the datafeeds. This account cannot be a # multi-client account. # @param [Fixnum] max_results # The maximum number of products to return in the response, used for paging. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ListDatafeedsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ListDatafeedsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_datafeeds(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/datafeeds', options) command.response_representation = Google::Apis::ContentV2::ListDatafeedsResponse::Representation command.response_class = Google::Apis::ContentV2::ListDatafeedsResponse 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['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 a datafeed configuration of your Merchant Center account. This method # supports patch semantics. # @param [Fixnum] merchant_id # The ID of the account that manages the datafeed. This account cannot be a # multi-client account. # @param [Fixnum] datafeed_id # The ID of the datafeed. # @param [Google::Apis::ContentV2::Datafeed] datafeed_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Datafeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Datafeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_datafeed(merchant_id, datafeed_id, datafeed_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{merchantId}/datafeeds/{datafeedId}', options) command.request_representation = Google::Apis::ContentV2::Datafeed::Representation command.request_object = datafeed_object command.response_representation = Google::Apis::ContentV2::Datafeed::Representation command.response_class = Google::Apis::ContentV2::Datafeed command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['datafeedId'] = datafeed_id unless datafeed_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 a datafeed configuration of your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that manages the datafeed. This account cannot be a # multi-client account. # @param [Fixnum] datafeed_id # The ID of the datafeed. # @param [Google::Apis::ContentV2::Datafeed] datafeed_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Datafeed] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Datafeed] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_datafeed(merchant_id, datafeed_id, datafeed_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{merchantId}/datafeeds/{datafeedId}', options) command.request_representation = Google::Apis::ContentV2::Datafeed::Representation command.request_object = datafeed_object command.response_representation = Google::Apis::ContentV2::Datafeed::Representation command.response_class = Google::Apis::ContentV2::Datafeed command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['datafeedId'] = datafeed_id unless datafeed_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 [Google::Apis::ContentV2::BatchDatafeedStatusesRequest] batch_datafeed_statuses_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::BatchDatafeedStatusesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::BatchDatafeedStatusesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_datafeed_status(batch_datafeed_statuses_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'datafeedstatuses/batch', options) command.request_representation = Google::Apis::ContentV2::BatchDatafeedStatusesRequest::Representation command.request_object = batch_datafeed_statuses_request_object command.response_representation = Google::Apis::ContentV2::BatchDatafeedStatusesResponse::Representation command.response_class = Google::Apis::ContentV2::BatchDatafeedStatusesResponse 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 the status of a datafeed from your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that manages the datafeed. This account cannot be a # multi-client account. # @param [Fixnum] datafeed_id # The ID of the datafeed. # @param [String] country # The country for which to get the datafeed status. If this parameter is # provided then language must also be provided. Note that this parameter is # required for feeds targeting multiple countries and languages, since a feed # may have a different status for each target. # @param [String] language # The language for which to get the datafeed status. If this parameter is # provided then country must also be provided. Note that this parameter is # required for feeds targeting multiple countries and languages, since a feed # may have a different status for each target. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::DatafeedStatus] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::DatafeedStatus] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_datafeed_status(merchant_id, datafeed_id, country: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/datafeedstatuses/{datafeedId}', options) command.response_representation = Google::Apis::ContentV2::DatafeedStatus::Representation command.response_class = Google::Apis::ContentV2::DatafeedStatus command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['datafeedId'] = datafeed_id unless datafeed_id.nil? command.query['country'] = country unless country.nil? command.query['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 the statuses of the datafeeds in your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that manages the datafeeds. This account cannot be a # multi-client account. # @param [Fixnum] max_results # The maximum number of products to return in the response, used for paging. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ListDatafeedStatusesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ListDatafeedStatusesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_datafeed_statuses(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/datafeedstatuses', options) command.response_representation = Google::Apis::ContentV2::ListDatafeedStatusesResponse::Representation command.response_class = Google::Apis::ContentV2::ListDatafeedStatusesResponse 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['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 price and availability for multiple products or stores in a single # request. This operation does not update the expiration date of the products. # @param [Google::Apis::ContentV2::BatchInventoryRequest] batch_inventory_request_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::BatchInventoryResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::BatchInventoryResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inventory(batch_inventory_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'inventory/batch', options) command.request_representation = Google::Apis::ContentV2::BatchInventoryRequest::Representation command.request_object = batch_inventory_request_object command.response_representation = Google::Apis::ContentV2::BatchInventoryResponse::Representation command.response_class = Google::Apis::ContentV2::BatchInventoryResponse command.query['dryRun'] = dry_run unless dry_run.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 price and availability of a product in your Merchant Center account. # @param [Fixnum] merchant_id # 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 # 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. # @param [Google::Apis::ContentV2::SetInventoryRequest] set_inventory_request_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::SetInventoryResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::SetInventoryResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inventory(merchant_id, store_code, product_id, set_inventory_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/inventory/{storeCode}/products/{productId}', options) command.request_representation = Google::Apis::ContentV2::SetInventoryRequest::Representation command.request_object = set_inventory_request_object command.response_representation = Google::Apis::ContentV2::SetInventoryResponse::Representation command.response_class = Google::Apis::ContentV2::SetInventoryResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['storeCode'] = store_code unless store_code.nil? command.params['productId'] = product_id unless product_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 # Marks an order as acknowledged. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersAcknowledgeRequest] orders_acknowledge_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersAcknowledgeResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersAcknowledgeResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order(merchant_id, order_id, orders_acknowledge_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/acknowledge', options) command.request_representation = Google::Apis::ContentV2::OrdersAcknowledgeRequest::Representation command.request_object = orders_acknowledge_request_object command.response_representation = Google::Apis::ContentV2::OrdersAcknowledgeResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersAcknowledgeResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 # 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. # @param [String] order_id # The ID of the test order to modify. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersAdvanceTestOrderResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersAdvanceTestOrderResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def advance_test_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/testorders/{orderId}/advance', options) command.response_representation = Google::Apis::ContentV2::OrdersAdvanceTestOrderResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersAdvanceTestOrderResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 # Cancels all line items in an order, making a full refund. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order to cancel. # @param [Google::Apis::ContentV2::OrdersCancelRequest] orders_cancel_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersCancelResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersCancelResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order(merchant_id, order_id, orders_cancel_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/cancel', options) command.request_representation = Google::Apis::ContentV2::OrdersCancelRequest::Representation command.request_object = orders_cancel_request_object command.response_representation = Google::Apis::ContentV2::OrdersCancelResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersCancelResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 # Cancels a line item, making a full refund. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersCancelLineItemRequest] orders_cancel_line_item_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersCancelLineItemResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersCancelLineItemResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order_line_item(merchant_id, order_id, orders_cancel_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/cancelLineItem', options) command.request_representation = Google::Apis::ContentV2::OrdersCancelLineItemRequest::Representation command.request_object = orders_cancel_line_item_request_object command.response_representation = Google::Apis::ContentV2::OrdersCancelLineItemResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersCancelLineItemResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 # Sandbox only. Creates a test order. # @param [Fixnum] merchant_id # The ID of the account that should manage the order. This cannot be a multi- # client account. # @param [Google::Apis::ContentV2::OrdersCreateTestOrderRequest] orders_create_test_order_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersCreateTestOrderResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersCreateTestOrderResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_test_order(merchant_id, orders_create_test_order_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/testorders', options) command.request_representation = Google::Apis::ContentV2::OrdersCreateTestOrderRequest::Representation command.request_object = orders_create_test_order_request_object command.response_representation = Google::Apis::ContentV2::OrdersCreateTestOrderResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersCreateTestOrderResponse command.params['merchantId'] = merchant_id unless merchant_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 or modifies multiple orders in a single request. # @param [Google::Apis::ContentV2::OrdersCustomBatchRequest] orders_custom_batch_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersCustomBatchResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersCustomBatchResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def custom_order_batch(orders_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'orders/batch', options) command.request_representation = Google::Apis::ContentV2::OrdersCustomBatchRequest::Representation command.request_object = orders_custom_batch_request_object command.response_representation = Google::Apis::ContentV2::OrdersCustomBatchResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersCustomBatchResponse 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 from 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] order_id # The ID of the order. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Order] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Order] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order(merchant_id, order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/orders/{orderId}', options) command.response_representation = Google::Apis::ContentV2::Order::Representation command.response_class = Google::Apis::ContentV2::Order command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 using merchant order id. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] merchant_order_id # The merchant order id to be looked for. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersGetByMerchantOrderIdResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersGetByMerchantOrderIdResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order_by_merchant_order_id(merchant_id, merchant_order_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/ordersbymerchantid/{merchantOrderId}', options) command.response_representation = Google::Apis::ContentV2::OrdersGetByMerchantOrderIdResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersGetByMerchantOrderIdResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['merchantOrderId'] = merchant_order_id unless merchant_order_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 # Sandbox only. Retrieves an order template that can be used to quickly create a # new order in sandbox. # @param [Fixnum] merchant_id # The ID of the account that should manage the order. This cannot be a multi- # client account. # @param [String] template_name # The name of the template to retrieve. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersGetTestOrderTemplateResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersGetTestOrderTemplateResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_test_order_template(merchant_id, template_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/testordertemplates/{templateName}', options) command.response_representation = Google::Apis::ContentV2::OrdersGetTestOrderTemplateResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersGetTestOrderTemplateResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['templateName'] = template_name unless template_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 # Notifies that item return and refund was handled directly in store. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersInStoreRefundLineItemRequest] orders_in_store_refund_line_item_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersInStoreRefundLineItemResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersInStoreRefundLineItemResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def instorerefundlineitem_order(merchant_id, order_id, orders_in_store_refund_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/inStoreRefundLineItem', options) command.request_representation = Google::Apis::ContentV2::OrdersInStoreRefundLineItemRequest::Representation command.request_object = orders_in_store_refund_line_item_request_object command.response_representation = Google::Apis::ContentV2::OrdersInStoreRefundLineItemResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersInStoreRefundLineItemResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 orders 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 [Boolean] acknowledged # 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. # @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 # orders per page. # Known issue: All List calls will return all Orders without limit regardless of # the value of this field. # @param [String] order_by # The ordering of the returned list. The only supported value are placedDate # desc and placedDate asc for now, which returns orders sorted by placement date. # "placedDate desc" stands for listing orders by placement date, from oldest to # most recent. "placedDate asc" stands for listing orders by placement date, # from most recent to oldest. In future releases we'll support other sorting # criteria. # @param [String] page_token # The token returned by the previous request. # @param [String] placed_date_end # Obtains orders placed before this date (exclusively), in ISO 8601 format. # @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. Multiple values can # be specified with comma separation. Additionally, 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 # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_orders(merchant_id, acknowledged: nil, max_results: nil, order_by: nil, page_token: nil, placed_date_end: nil, placed_date_start: nil, statuses: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/orders', options) command.response_representation = Google::Apis::ContentV2::OrdersListResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersListResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.query['acknowledged'] = acknowledged unless acknowledged.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['placedDateEnd'] = placed_date_end unless placed_date_end.nil? command.query['placedDateStart'] = placed_date_start unless placed_date_start.nil? command.query['statuses'] = statuses unless statuses.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 portion of the order, up to the full amount paid. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order to refund. # @param [Google::Apis::ContentV2::OrdersRefundRequest] orders_refund_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersRefundResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersRefundResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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(merchant_id, order_id, orders_refund_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/refund', options) command.request_representation = Google::Apis::ContentV2::OrdersRefundRequest::Representation command.request_object = orders_refund_request_object command.response_representation = Google::Apis::ContentV2::OrdersRefundResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersRefundResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 # Rejects return on an line item. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersRejectReturnLineItemRequest] orders_reject_return_line_item_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersRejectReturnLineItemResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersRejectReturnLineItemResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def rejectreturnlineitem_order(merchant_id, order_id, orders_reject_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/rejectReturnLineItem', options) command.request_representation = Google::Apis::ContentV2::OrdersRejectReturnLineItemRequest::Representation command.request_object = orders_reject_return_line_item_request_object command.response_representation = Google::Apis::ContentV2::OrdersRejectReturnLineItemResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersRejectReturnLineItemResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 a line item. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersReturnLineItemRequest] orders_return_line_item_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersReturnLineItemResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersReturnLineItemResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def return_order_line_item(merchant_id, order_id, orders_return_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/returnLineItem', options) command.request_representation = Google::Apis::ContentV2::OrdersReturnLineItemRequest::Representation command.request_object = orders_return_line_item_request_object command.response_representation = Google::Apis::ContentV2::OrdersReturnLineItemResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersReturnLineItemResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 and refunds a line item. Note that this method can only be called on # fully shipped orders. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersReturnRefundLineItemRequest] orders_return_refund_line_item_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersReturnRefundLineItemResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersReturnRefundLineItemResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def returnrefundlineitem_order(merchant_id, order_id, orders_return_refund_line_item_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/returnRefundLineItem', options) command.request_representation = Google::Apis::ContentV2::OrdersReturnRefundLineItemRequest::Representation command.request_object = orders_return_refund_line_item_request_object command.response_representation = Google::Apis::ContentV2::OrdersReturnRefundLineItemResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersReturnRefundLineItemResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 # Sets (overrides) merchant provided annotations on the line item. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersSetLineItemMetadataRequest] orders_set_line_item_metadata_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersSetLineItemMetadataResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersSetLineItemMetadataResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def setlineitemmetadata_order(merchant_id, order_id, orders_set_line_item_metadata_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/setLineItemMetadata', options) command.request_representation = Google::Apis::ContentV2::OrdersSetLineItemMetadataRequest::Representation command.request_object = orders_set_line_item_metadata_request_object command.response_representation = Google::Apis::ContentV2::OrdersSetLineItemMetadataResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersSetLineItemMetadataResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 # Marks line item(s) as shipped. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersShipLineItemsRequest] orders_ship_line_items_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersShipLineItemsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersShipLineItemsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def shiplineitems_order(merchant_id, order_id, orders_ship_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/shipLineItems', options) command.request_representation = Google::Apis::ContentV2::OrdersShipLineItemsRequest::Representation command.request_object = orders_ship_line_items_request_object command.response_representation = Google::Apis::ContentV2::OrdersShipLineItemsResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersShipLineItemsResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 ship by and delivery by dates for a line item. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersUpdateLineItemShippingDetailsRequest] orders_update_line_item_shipping_details_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersUpdateLineItemShippingDetailsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersUpdateLineItemShippingDetailsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def updatelineitemshippingdetails_order(merchant_id, order_id, orders_update_line_item_shipping_details_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/updateLineItemShippingDetails', options) command.request_representation = Google::Apis::ContentV2::OrdersUpdateLineItemShippingDetailsRequest::Representation command.request_object = orders_update_line_item_shipping_details_request_object command.response_representation = Google::Apis::ContentV2::OrdersUpdateLineItemShippingDetailsResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersUpdateLineItemShippingDetailsResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 merchant order ID for a given order. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersUpdateMerchantOrderIdRequest] orders_update_merchant_order_id_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersUpdateMerchantOrderIdResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersUpdateMerchantOrderIdResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_merchant_order_id(merchant_id, order_id, orders_update_merchant_order_id_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/updateMerchantOrderId', options) command.request_representation = Google::Apis::ContentV2::OrdersUpdateMerchantOrderIdRequest::Representation command.request_object = orders_update_merchant_order_id_request_object command.response_representation = Google::Apis::ContentV2::OrdersUpdateMerchantOrderIdResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersUpdateMerchantOrderIdResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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 a shipment's status, carrier, and/or tracking ID. # @param [Fixnum] merchant_id # The ID of the account that manages the order. This cannot be a multi-client # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersUpdateShipmentRequest] orders_update_shipment_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::OrdersUpdateShipmentResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::OrdersUpdateShipmentResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_order_shipment(merchant_id, order_id, orders_update_shipment_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/orders/{orderId}/updateShipment', options) command.request_representation = Google::Apis::ContentV2::OrdersUpdateShipmentRequest::Representation command.request_object = orders_update_shipment_request_object command.response_representation = Google::Apis::ContentV2::OrdersUpdateShipmentResponse::Representation command.response_class = Google::Apis::ContentV2::OrdersUpdateShipmentResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['orderId'] = order_id unless order_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, inserts, and deletes multiple products in a single request. # @param [Google::Apis::ContentV2::BatchProductsRequest] batch_products_request_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::BatchProductsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::BatchProductsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product(batch_products_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'products/batch', options) command.request_representation = Google::Apis::ContentV2::BatchProductsRequest::Representation command.request_object = batch_products_request_object command.response_representation = Google::Apis::ContentV2::BatchProductsResponse::Representation command.response_class = Google::Apis::ContentV2::BatchProductsResponse command.query['dryRun'] = dry_run unless dry_run.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 a product from your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that contains the product. This account cannot be a # multi-client account. # @param [String] product_id # The REST id of the product. # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_product(merchant_id, product_id, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{merchantId}/products/{productId}', options) command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['productId'] = product_id unless product_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 product from your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that contains the product. This account cannot be a # multi-client account. # @param [String] product_id # The REST id of the product. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Product] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Product] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product(merchant_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/products/{productId}', options) command.response_representation = Google::Apis::ContentV2::Product::Representation command.response_class = Google::Apis::ContentV2::Product command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['productId'] = product_id unless product_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 product to your Merchant Center account. If an item with the same # channel, contentLanguage, offerId, and targetCountry already exists, this # method updates that entry. # @param [Fixnum] merchant_id # The ID of the account that contains the product. This account cannot be a # multi-client account. # @param [Google::Apis::ContentV2::Product] product_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::Product] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::Product] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product(merchant_id, product_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{merchantId}/products', options) command.request_representation = Google::Apis::ContentV2::Product::Representation command.request_object = product_object command.response_representation = Google::Apis::ContentV2::Product::Representation command.response_class = Google::Apis::ContentV2::Product command.params['merchantId'] = merchant_id unless merchant_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 products in your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that contains the products. This account cannot be a # multi-client account. # @param [Boolean] include_invalid_inserted_items # Flag to include the invalid inserted items in the result of the list request. # By default the invalid items are not shown (the default value is false). # @param [Fixnum] max_results # The maximum number of products to return in the response, used for paging. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ListProductsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ListProductsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_products(merchant_id, include_invalid_inserted_items: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/products', options) command.response_representation = Google::Apis::ContentV2::ListProductsResponse::Representation command.response_class = Google::Apis::ContentV2::ListProductsResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.query['includeInvalidInsertedItems'] = include_invalid_inserted_items unless include_invalid_inserted_items.nil? command.query['maxResults'] = max_results unless max_results.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 # Gets the statuses of multiple products in a single request. # @param [Google::Apis::ContentV2::BatchProductStatusesRequest] batch_product_statuses_request_object # @param [Boolean] include_attributes # Flag to include full product data in the results of this request. The default # value 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::BatchProductStatusesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::BatchProductStatusesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_status(batch_product_statuses_request_object = nil, include_attributes: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'productstatuses/batch', options) command.request_representation = Google::Apis::ContentV2::BatchProductStatusesRequest::Representation command.request_object = batch_product_statuses_request_object command.response_representation = Google::Apis::ContentV2::BatchProductStatusesResponse::Representation command.response_class = Google::Apis::ContentV2::BatchProductStatusesResponse command.query['includeAttributes'] = include_attributes unless include_attributes.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 status of a product from your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that contains the product. This account cannot be a # multi-client account. # @param [String] product_id # The REST id of the product. # @param [Boolean] include_attributes # Flag to include full product data in the result of this get request. The # default value 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ProductStatus] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ProductStatus] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_status(merchant_id, product_id, include_attributes: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/productstatuses/{productId}', options) command.response_representation = Google::Apis::ContentV2::ProductStatus::Representation command.response_class = Google::Apis::ContentV2::ProductStatus command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['productId'] = product_id unless product_id.nil? command.query['includeAttributes'] = include_attributes unless include_attributes.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 statuses of the products in your Merchant Center account. # @param [Fixnum] merchant_id # The ID of the account that contains the products. This account cannot be a # multi-client account. # @param [Boolean] include_attributes # Flag to include full product data in the results of the list request. The # default value is false. # @param [Boolean] include_invalid_inserted_items # Flag to include the invalid inserted items in the result of the list request. # By default the invalid items are not shown (the default value is false). # @param [Fixnum] max_results # The maximum number of product statuses to return in the response, used for # paging. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ListProductStatusesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ListProductStatusesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_statuses(merchant_id, include_attributes: nil, include_invalid_inserted_items: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/productstatuses', options) command.response_representation = Google::Apis::ContentV2::ListProductStatusesResponse::Representation command.response_class = Google::Apis::ContentV2::ListProductStatusesResponse command.params['merchantId'] = merchant_id unless merchant_id.nil? command.query['includeAttributes'] = include_attributes unless include_attributes.nil? command.query['includeInvalidInsertedItems'] = include_invalid_inserted_items unless include_invalid_inserted_items.nil? command.query['maxResults'] = max_results unless max_results.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 # Retrieves and updates the shipping settings of multiple accounts in a single # request. # @param [Google::Apis::ContentV2::ShippingsettingsCustomBatchRequest] shippingsettings_custom_batch_request_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ShippingsettingsCustomBatchResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ShippingsettingsCustomBatchResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def custombatch_shippingsetting(shippingsettings_custom_batch_request_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'shippingsettings/batch', options) command.request_representation = Google::Apis::ContentV2::ShippingsettingsCustomBatchRequest::Representation command.request_object = shippingsettings_custom_batch_request_object command.response_representation = Google::Apis::ContentV2::ShippingsettingsCustomBatchResponse::Representation command.response_class = Google::Apis::ContentV2::ShippingsettingsCustomBatchResponse command.query['dryRun'] = dry_run unless dry_run.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 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. # @param [Fixnum] account_id # The ID of the account for which to get/update shipping settings. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ShippingSettings] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ShippingSettings] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_shippingsetting(merchant_id, account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/shippingsettings/{accountId}', options) command.response_representation = Google::Apis::ContentV2::ShippingSettings::Representation command.response_class = Google::Apis::ContentV2::ShippingSettings command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_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 supported carriers and carrier services for an account. # @param [Fixnum] merchant_id # The ID of the account for which to retrieve the supported carriers. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ShippingsettingsGetSupportedCarriersResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ShippingsettingsGetSupportedCarriersResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def getsupportedcarriers_shippingsetting(merchant_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/supportedCarriers', options) command.response_representation = Google::Apis::ContentV2::ShippingsettingsGetSupportedCarriersResponse::Representation command.response_class = Google::Apis::ContentV2::ShippingsettingsGetSupportedCarriersResponse command.params['merchantId'] = merchant_id unless merchant_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 supported holidays for an account. # @param [Fixnum] merchant_id # The ID of the account for which to retrieve the supported holidays. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ShippingsettingsGetSupportedHolidaysResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ShippingsettingsGetSupportedHolidaysResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def getsupportedholidays_shippingsetting(merchant_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/supportedHolidays', options) command.response_representation = Google::Apis::ContentV2::ShippingsettingsGetSupportedHolidaysResponse::Representation command.response_class = Google::Apis::ContentV2::ShippingsettingsGetSupportedHolidaysResponse command.params['merchantId'] = merchant_id unless merchant_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 shipping settings of the sub-accounts in your Merchant Center # account. # @param [Fixnum] merchant_id # The ID of the managing account. This must be a multi-client account. # @param [Fixnum] max_results # The maximum number of shipping settings to return in the response, used for # paging. # @param [String] page_token # The token returned by the previous 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ShippingsettingsListResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ShippingsettingsListResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_shippingsettings(merchant_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{merchantId}/shippingsettings', options) command.response_representation = Google::Apis::ContentV2::ShippingsettingsListResponse::Representation command.response_class = Google::Apis::ContentV2::ShippingsettingsListResponse 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['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 shipping settings of the account. This method supports patch # semantics. # @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. # @param [Fixnum] account_id # The ID of the account for which to get/update shipping settings. # @param [Google::Apis::ContentV2::ShippingSettings] shipping_settings_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ShippingSettings] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ShippingSettings] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_shippingsetting(merchant_id, account_id, shipping_settings_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{merchantId}/shippingsettings/{accountId}', options) command.request_representation = Google::Apis::ContentV2::ShippingSettings::Representation command.request_object = shipping_settings_object command.response_representation = Google::Apis::ContentV2::ShippingSettings::Representation command.response_class = Google::Apis::ContentV2::ShippingSettings command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 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. # @param [Fixnum] account_id # The ID of the account for which to get/update shipping settings. # @param [Google::Apis::ContentV2::ShippingSettings] shipping_settings_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ContentV2::ShippingSettings] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ContentV2::ShippingSettings] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_shippingsetting(merchant_id, account_id, shipping_settings_object = nil, dry_run: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{merchantId}/shippingsettings/{accountId}', options) command.request_representation = Google::Apis::ContentV2::ShippingSettings::Representation command.request_object = shipping_settings_object command.response_representation = Google::Apis::ContentV2::ShippingSettings::Representation command.response_class = Google::Apis::ContentV2::ShippingSettings command.params['merchantId'] = merchant_id unless merchant_id.nil? command.params['accountId'] = account_id unless account_id.nil? command.query['dryRun'] = dry_run unless dry_run.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 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 end end google-api-client-0.19.8/generated/google/apis/serviceconsumermanagement_v1.rb0000644000004100000410000000261713252673044027526 0ustar www-datawww-data# 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/serviceconsumermanagement_v1/service.rb' require 'google/apis/serviceconsumermanagement_v1/classes.rb' require 'google/apis/serviceconsumermanagement_v1/representations.rb' module Google module Apis # Service Consumer Management API # # Provides management methods for configuring service producer resources on # Google Cloud. # # @see https://cloud.google.com/service-consumer-management/docs/overview module ServiceconsumermanagementV1 VERSION = 'V1' REVISION = '20180208' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # Manage your Google API service configuration AUTH_SERVICE_MANAGEMENT = 'https://www.googleapis.com/auth/service.management' end end end google-api-client-0.19.8/generated/google/apis/clouduseraccounts_beta/0000755000004100000410000000000013252673043026053 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/clouduseraccounts_beta/representations.rb0000644000004100000410000003112113252673043031623 0ustar www-datawww-data# 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 ClouduseraccountsBeta class AuthorizedKeysView class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Group class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GroupList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GroupsAddMemberRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GroupsRemoveMemberRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinuxAccountViews class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinuxGetAuthorizedKeysViewResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinuxGetLinuxAccountViewsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinuxGroupView class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LinuxUserView class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Operation class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end class Error class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport 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 OperationList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PublicKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class User class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserList class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthorizedKeysView # @private class Representation < Google::Apis::Core::JsonRepresentation collection :keys, as: 'keys' property :sudoer, as: 'sudoer' end end class Group # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' collection :members, as: 'members' property :name, as: 'name' property :self_link, as: 'selfLink' end end class GroupList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ClouduseraccountsBeta::Group, decorator: Google::Apis::ClouduseraccountsBeta::Group::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end class GroupsAddMemberRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :users, as: 'users' end end class GroupsRemoveMemberRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :users, as: 'users' end end class LinuxAccountViews # @private class Representation < Google::Apis::Core::JsonRepresentation collection :group_views, as: 'groupViews', class: Google::Apis::ClouduseraccountsBeta::LinuxGroupView, decorator: Google::Apis::ClouduseraccountsBeta::LinuxGroupView::Representation property :kind, as: 'kind' collection :user_views, as: 'userViews', class: Google::Apis::ClouduseraccountsBeta::LinuxUserView, decorator: Google::Apis::ClouduseraccountsBeta::LinuxUserView::Representation end end class LinuxGetAuthorizedKeysViewResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource, as: 'resource', class: Google::Apis::ClouduseraccountsBeta::AuthorizedKeysView, decorator: Google::Apis::ClouduseraccountsBeta::AuthorizedKeysView::Representation end end class LinuxGetLinuxAccountViewsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource, as: 'resource', class: Google::Apis::ClouduseraccountsBeta::LinuxAccountViews, decorator: Google::Apis::ClouduseraccountsBeta::LinuxAccountViews::Representation end end class LinuxGroupView # @private class Representation < Google::Apis::Core::JsonRepresentation property :gid, as: 'gid' property :group_name, as: 'groupName' collection :members, as: 'members' end end class LinuxUserView # @private class Representation < Google::Apis::Core::JsonRepresentation property :gecos, as: 'gecos' property :gid, as: 'gid' property :home_directory, as: 'homeDirectory' property :shell, as: 'shell' property :uid, as: 'uid' property :username, as: 'username' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :client_operation_id, as: 'clientOperationId' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :end_time, as: 'endTime' property :error, as: 'error', class: Google::Apis::ClouduseraccountsBeta::Operation::Error, decorator: Google::Apis::ClouduseraccountsBeta::Operation::Error::Representation property :http_error_message, as: 'httpErrorMessage' property :http_error_status_code, as: 'httpErrorStatusCode' property :id, :numeric_string => true, as: 'id' property :insert_time, as: 'insertTime' property :kind, as: 'kind' property :name, as: 'name' property :operation_type, as: 'operationType' property :progress, as: 'progress' property :region, as: 'region' property :self_link, as: 'selfLink' property :start_time, as: 'startTime' property :status, as: 'status' property :status_message, as: 'statusMessage' property :target_id, :numeric_string => true, as: 'targetId' property :target_link, as: 'targetLink' property :user, as: 'user' collection :warnings, as: 'warnings', class: Google::Apis::ClouduseraccountsBeta::Operation::Warning, decorator: Google::Apis::ClouduseraccountsBeta::Operation::Warning::Representation property :zone, as: 'zone' end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation collection :errors, as: 'errors', class: Google::Apis::ClouduseraccountsBeta::Operation::Error::Error, decorator: Google::Apis::ClouduseraccountsBeta::Operation::Error::Error::Representation end class Error # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' property :location, as: 'location' property :message, as: 'message' end end end class Warning # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :data, as: 'data', class: Google::Apis::ClouduseraccountsBeta::Operation::Warning::Datum, decorator: Google::Apis::ClouduseraccountsBeta::Operation::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 OperationList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ClouduseraccountsBeta::Operation, decorator: Google::Apis::ClouduseraccountsBeta::Operation::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end class PublicKey # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :expiration_timestamp, as: 'expirationTimestamp' property :fingerprint, as: 'fingerprint' property :key, as: 'key' end end class User # @private class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' collection :groups, as: 'groups' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' property :owner, as: 'owner' collection :public_keys, as: 'publicKeys', class: Google::Apis::ClouduseraccountsBeta::PublicKey, decorator: Google::Apis::ClouduseraccountsBeta::PublicKey::Representation property :self_link, as: 'selfLink' end end class UserList # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::ClouduseraccountsBeta::User, decorator: Google::Apis::ClouduseraccountsBeta::User::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' end end end end end google-api-client-0.19.8/generated/google/apis/clouduseraccounts_beta/classes.rb0000644000004100000410000007710313252673043030045 0ustar www-datawww-data# 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 ClouduseraccountsBeta # A list of authorized public keys for a user account. class AuthorizedKeysView include Google::Apis::Core::Hashable # [Output Only] The list of authorized public keys in SSH format. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys # [Output Only] Whether the user has the ability to elevate on the instance that # requested the authorized keys. # Corresponds to the JSON property `sudoer` # @return [Boolean] attr_accessor :sudoer alias_method :sudoer?, :sudoer def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @keys = args[:keys] if args.key?(:keys) @sudoer = args[:sudoer] if args.key?(:sudoer) end end # A Group resource. class Group include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always clouduseraccounts#group for groups. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] A list of URLs to User resources who belong to the group. Users # may only be members of groups in the same project. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members # Name of the resource; provided by the client when the resource is created. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [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) @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) @members = args[:members] if args.key?(:members) @name = args[:name] if args.key?(:name) @self_link = args[:self_link] if args.key?(:self_link) end end # class GroupList 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 # [Output Only] A list of Group resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists # of groups. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] A token used to continue a truncated list request. # 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 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) end end # class GroupsAddMemberRequest include Google::Apis::Core::Hashable # Fully-qualified URLs of the User resources to add. # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @users = args[:users] if args.key?(:users) end end # class GroupsRemoveMemberRequest include Google::Apis::Core::Hashable # Fully-qualified URLs of the User resources to remove. # Corresponds to the JSON property `users` # @return [Array] attr_accessor :users def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @users = args[:users] if args.key?(:users) end end # A list of all Linux accounts for this project. This API is only used by # Compute Engine virtual machines to get information about user accounts for a # project or instance. Linux resources are read-only views into users and groups # managed by the Compute Engine Accounts API. class LinuxAccountViews include Google::Apis::Core::Hashable # [Output Only] A list of all groups within a project. # Corresponds to the JSON property `groupViews` # @return [Array] attr_accessor :group_views # [Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews # for Linux resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] A list of all users within a project. # Corresponds to the JSON property `userViews` # @return [Array] attr_accessor :user_views def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @group_views = args[:group_views] if args.key?(:group_views) @kind = args[:kind] if args.key?(:kind) @user_views = args[:user_views] if args.key?(:user_views) end end # class LinuxGetAuthorizedKeysViewResponse include Google::Apis::Core::Hashable # A list of authorized public keys for a user account. # Corresponds to the JSON property `resource` # @return [Google::Apis::ClouduseraccountsBeta::AuthorizedKeysView] attr_accessor :resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource = args[:resource] if args.key?(:resource) end end # class LinuxGetLinuxAccountViewsResponse include Google::Apis::Core::Hashable # A list of all Linux accounts for this project. This API is only used by # Compute Engine virtual machines to get information about user accounts for a # project or instance. Linux resources are read-only views into users and groups # managed by the Compute Engine Accounts API. # Corresponds to the JSON property `resource` # @return [Google::Apis::ClouduseraccountsBeta::LinuxAccountViews] attr_accessor :resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource = args[:resource] if args.key?(:resource) end end # A detailed view of a Linux group. class LinuxGroupView include Google::Apis::Core::Hashable # [Output Only] The Group ID. # Corresponds to the JSON property `gid` # @return [Fixnum] attr_accessor :gid # [Output Only] Group name. # Corresponds to the JSON property `groupName` # @return [String] attr_accessor :group_name # [Output Only] List of user accounts that belong to the group. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @gid = args[:gid] if args.key?(:gid) @group_name = args[:group_name] if args.key?(:group_name) @members = args[:members] if args.key?(:members) end end # A detailed view of a Linux user account. class LinuxUserView include Google::Apis::Core::Hashable # [Output Only] The GECOS (user information) entry for this account. # Corresponds to the JSON property `gecos` # @return [String] attr_accessor :gecos # [Output Only] User's default group ID. # Corresponds to the JSON property `gid` # @return [Fixnum] attr_accessor :gid # [Output Only] The path to the home directory for this account. # Corresponds to the JSON property `homeDirectory` # @return [String] attr_accessor :home_directory # [Output Only] The path to the login shell for this account. # Corresponds to the JSON property `shell` # @return [String] attr_accessor :shell # [Output Only] User ID. # Corresponds to the JSON property `uid` # @return [Fixnum] attr_accessor :uid # [Output Only] The username of the account. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @gecos = args[:gecos] if args.key?(:gecos) @gid = args[:gid] if args.key?(:gid) @home_directory = args[:home_directory] if args.key?(:home_directory) @shell = args[:shell] if args.key?(:shell) @uid = args[:uid] if args.key?(:uid) @username = args[:username] if args.key?(:username) end end # An Operation resource, used to manage asynchronous API requests. class Operation include Google::Apis::Core::Hashable # [Output Only] Reserved for future use. # Corresponds to the JSON property `clientOperationId` # @return [String] attr_accessor :client_operation_id # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # [Output Only] A textual description of the operation, which is set when the # operation is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] The time that this operation was completed. This value is in # RFC3339 text format. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # [Output Only] If errors are generated during processing of the operation, this # field will be populated. # Corresponds to the JSON property `error` # @return [Google::Apis::ClouduseraccountsBeta::Operation::Error] attr_accessor :error # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as NOT FOUND. # Corresponds to the JSON property `httpErrorMessage` # @return [String] attr_accessor :http_error_message # [Output Only] If the operation fails, this field contains the HTTP error # status code that was returned. For example, a 404 means the resource was not # found. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] attr_accessor :http_error_status_code # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] The time that this operation was requested. This value is in # RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time # [Output Only] Type of the resource. Always compute#operation for Operation # resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] Name of the resource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # [Output Only] The type of operation, such as insert, update, or delete, and so # on. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # [Output Only] An optional progress indicator that ranges from 0 to 100. There # is no requirement that this be linear or support any granularity of operations. # This should not be used to guess when the operation will be complete. This # number should monotonically increase as the operation progresses. # Corresponds to the JSON property `progress` # @return [Fixnum] attr_accessor :progress # [Output Only] The URL of the region where the operation resides. Only # available when performing regional operations. # 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 # [Output Only] The time that this operation was started by the server. This # value is in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # [Output Only] The status of the operation, which can be one of the following: # PENDING, RUNNING, or DONE. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # [Output Only] An optional textual description of the current status of the # operation. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # [Output Only] The unique target ID, which identifies a specific incarnation of # the target resource. # Corresponds to the JSON property `targetId` # @return [Fixnum] attr_accessor :target_id # [Output Only] The URL of the resource that the operation modifies. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link # [Output Only] User who requested the operation, for example: user@example.com. # Corresponds to the JSON property `user` # @return [String] attr_accessor :user # [Output Only] If warning messages are generated during processing of the # operation, this field will be populated. # Corresponds to the JSON property `warnings` # @return [Array] attr_accessor :warnings # [Output Only] The URL of the zone where the operation resides. Only available # when performing per-zone operations. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @end_time = args[:end_time] if args.key?(:end_time) @error = args[:error] if args.key?(:error) @http_error_message = args[:http_error_message] if args.key?(:http_error_message) @http_error_status_code = args[:http_error_status_code] if args.key?(:http_error_status_code) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @operation_type = args[:operation_type] if args.key?(:operation_type) @progress = args[:progress] if args.key?(:progress) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @target_id = args[:target_id] if args.key?(:target_id) @target_link = args[:target_link] if args.key?(:target_link) @user = args[:user] if args.key?(:user) @warnings = args[:warnings] if args.key?(:warnings) @zone = args[:zone] if args.key?(:zone) end # [Output Only] If errors are generated during processing of the operation, this # field will be populated. class Error include Google::Apis::Core::Hashable # [Output Only] The array of errors encountered while processing this operation. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @errors = args[:errors] if args.key?(:errors) end # class Error include Google::Apis::Core::Hashable # [Output Only] The error type identifier for this error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # [Output Only] Indicates the field in the request that caused the error. This # property is optional. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location # [Output Only] An optional, human-readable error message. # 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) @location = args[:location] if args.key?(:location) @message = args[:message] if args.key?(:message) end end end # 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 # Contains a list of Operation resources. class OperationList include Google::Apis::Core::Hashable # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # [Output Only] A list of Operation resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always compute#operations for Operations # resource. # 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 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) end end # A public key for authenticating to guests. class PublicKey include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 # text format. If not provided, the public key never expires. # Corresponds to the JSON property `expirationTimestamp` # @return [String] attr_accessor :expiration_timestamp # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 # digest of the public key. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # Public key text in SSH format, defined by RFC4253 section 6.6. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @expiration_timestamp = args[:expiration_timestamp] if args.key?(:expiration_timestamp) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @key = args[:key] if args.key?(:key) end end # A User resource. class User include Google::Apis::Core::Hashable # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] attr_accessor :creation_timestamp # An optional textual description of the resource; provided by the client when # the resource is created. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # [Output Only] A list of URLs to Group resources who contain the user. Users # are only members of groups in the same project. # Corresponds to the JSON property `groups` # @return [Array] attr_accessor :groups # [Output Only] Unique identifier for the resource; defined by the server. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # [Output Only] Type of the resource. Always clouduseraccounts#user for users. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Name of the resource; provided by the client when the resource is created. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Email address of account's owner. This account will be validated to make sure # it exists. The email can belong to any domain, but it must be tied to a Google # account. # Corresponds to the JSON property `owner` # @return [String] attr_accessor :owner # [Output Only] Public keys that this user may use to login. # Corresponds to the JSON property `publicKeys` # @return [Array] attr_accessor :public_keys # [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) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @groups = args[:groups] if args.key?(:groups) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @owner = args[:owner] if args.key?(:owner) @public_keys = args[:public_keys] if args.key?(:public_keys) @self_link = args[:self_link] if args.key?(:self_link) end end # class UserList 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 # [Output Only] A list of User resources. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # [Output Only] Type of resource. Always clouduseraccounts#userList for lists of # users. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] A token used to continue a truncated list request. # 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 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) end end end end end google-api-client-0.19.8/generated/google/apis/clouduseraccounts_beta/service.rb0000644000004100000410000015567413252673043030062 0ustar www-datawww-data# 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 ClouduseraccountsBeta # Cloud User Accounts API # # Creates and manages users and groups for accessing Google Compute Engine # virtual machines. # # @example # require 'google/apis/clouduseraccounts_beta' # # Clouduseraccounts = Google::Apis::ClouduseraccountsBeta # Alias the module # service = Clouduseraccounts::CloudUserAccountsService.new # # @see https://cloud.google.com/compute/docs/access/user-accounts/api/latest/ class CloudUserAccountsService < 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. # Overrides userIp if both are provided. attr_accessor :quota_user # @return [String] # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. attr_accessor :user_ip def initialize super('https://www.googleapis.com/', 'clouduseraccounts/beta/projects/') @batch_path = 'batch/clouduseraccounts/beta' end # Deletes the specified operation resource. # @param [String] project # Project ID for this request. # @param [String] operation # Name of the Operations resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @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_global_accounts_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/operations/{operation}', options) command.params['project'] = project unless project.nil? command.params['operation'] = operation unless operation.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 the specified operation resource. # @param [String] project # Project ID for this request. # @param [String] operation # Name of the Operations resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::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_global_accounts_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations/{operation}', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::Operation command.params['project'] = project unless project.nil? command.params['operation'] = operation unless operation.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 the list of operation resources contained within the specified # project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` # expression`. Your `expression` must be in the format: field_name # comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use filter=name ne example-instance. # Compute Engine Beta API Only: If you use filtering in the Beta API, you can # also filter on nested fields. For example, you could filter on instances that # have set the scheduling.automaticRestart field to true. In particular, use # filtering on nested fields to take advantage of instance labels to organize # and filter results based on label values. # The Beta API also supports filtering on multiple expressions by providing each # separate expression within parentheses. For example, (scheduling. # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are # treated as AND expressions, meaning that resources must match all expressions # to pass the filters. # @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. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::OperationList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::OperationList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_global_accounts_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::OperationList::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::OperationList command.params['project'] = project unless project.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['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 # Adds users to the specified group. # @param [String] project # Project ID for this request. # @param [String] group_name # Name of the group for this request. # @param [Google::Apis::ClouduseraccountsBeta::GroupsAddMemberRequest] groups_add_member_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::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 add_group_member(project, group_name, groups_add_member_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/groups/{groupName}/addMember', options) command.request_representation = Google::Apis::ClouduseraccountsBeta::GroupsAddMemberRequest::Representation command.request_object = groups_add_member_request_object command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::Operation command.params['project'] = project unless project.nil? command.params['groupName'] = group_name unless group_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 # Deletes the specified Group resource. # @param [String] project # Project ID for this request. # @param [String] group_name # Name of the Group resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::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_group(project, group_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/groups/{groupName}', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::Operation command.params['project'] = project unless project.nil? command.params['groupName'] = group_name unless group_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 # Returns the specified Group resource. # @param [String] project # Project ID for this request. # @param [String] group_name # Name of the Group resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::Group] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::Group] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_group(project, group_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/groups/{groupName}', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::Group::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::Group command.params['project'] = project unless project.nil? command.params['groupName'] = group_name unless group_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 # Creates a Group resource in the specified project using the data included in # the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ClouduseraccountsBeta::Group] group_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::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_group(project, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/groups', options) command.request_representation = Google::Apis::ClouduseraccountsBeta::Group::Representation command.request_object = group_object command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::Operation command.params['project'] = project unless project.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 the list of groups contained within the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` # expression`. Your `expression` must be in the format: field_name # comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use filter=name ne example-instance. # Compute Engine Beta API Only: If you use filtering in the Beta API, you can # also filter on nested fields. For example, you could filter on instances that # have set the scheduling.automaticRestart field to true. In particular, use # filtering on nested fields to take advantage of instance labels to organize # and filter results based on label values. # The Beta API also supports filtering on multiple expressions by providing each # separate expression within parentheses. For example, (scheduling. # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are # treated as AND expressions, meaning that resources must match all expressions # to pass the filters. # @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. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::GroupList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::GroupList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_groups(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/groups', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::GroupList::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::GroupList command.params['project'] = project unless project.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['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 # Removes users from the specified group. # @param [String] project # Project ID for this request. # @param [String] group_name # Name of the group for this request. # @param [Google::Apis::ClouduseraccountsBeta::GroupsRemoveMemberRequest] groups_remove_member_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::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 remove_group_member(project, group_name, groups_remove_member_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/groups/{groupName}/removeMember', options) command.request_representation = Google::Apis::ClouduseraccountsBeta::GroupsRemoveMemberRequest::Representation command.request_object = groups_remove_member_request_object command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::Operation command.params['project'] = project unless project.nil? command.params['groupName'] = group_name unless group_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 # Returns a list of authorized public keys for a specific user account. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [String] user # The user account for which you want to get a list of authorized public keys. # @param [String] instance # The fully-qualified URL of the virtual machine requesting the view. # @param [Boolean] login # Whether the view was requested as part of a user-initiated login. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::LinuxGetAuthorizedKeysViewResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::LinuxGetAuthorizedKeysViewResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_linux_authorized_keys_view(project, zone, user, instance, login: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/authorizedKeysView/{user}', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::LinuxGetAuthorizedKeysViewResponse::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::LinuxGetAuthorizedKeysViewResponse command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.params['user'] = user unless user.nil? command.query['instance'] = instance unless instance.nil? command.query['login'] = login unless login.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 user accounts for an instance within a specific project. # @param [String] project # Project ID for this request. # @param [String] zone # Name of the zone for this request. # @param [String] instance # The fully-qualified URL of the virtual machine requesting the views. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` # expression`. Your `expression` must be in the format: field_name # comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use filter=name ne example-instance. # Compute Engine Beta API Only: If you use filtering in the Beta API, you can # also filter on nested fields. For example, you could filter on instances that # have set the scheduling.automaticRestart field to true. In particular, use # filtering on nested fields to take advantage of instance labels to organize # and filter results based on label values. # The Beta API also supports filtering on multiple expressions by providing each # separate expression within parentheses. For example, (scheduling. # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are # treated as AND expressions, meaning that resources must match all expressions # to pass the filters. # @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. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::LinuxGetLinuxAccountViewsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::LinuxGetLinuxAccountViewsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_linux_linux_account_views(project, zone, instance, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/linuxAccountViews', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::LinuxGetLinuxAccountViewsResponse::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::LinuxGetLinuxAccountViewsResponse command.params['project'] = project unless project.nil? command.params['zone'] = zone unless zone.nil? command.query['filter'] = filter unless filter.nil? command.query['instance'] = instance unless instance.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['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 # Adds a public key to the specified User resource with the data included in the # request. # @param [String] project # Project ID for this request. # @param [String] user # Name of the user for this request. # @param [Google::Apis::ClouduseraccountsBeta::PublicKey] public_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::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 add_user_public_key(project, user, public_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/users/{user}/addPublicKey', options) command.request_representation = Google::Apis::ClouduseraccountsBeta::PublicKey::Representation command.request_object = public_key_object command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::Operation command.params['project'] = project unless project.nil? command.params['user'] = user unless user.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 User resource. # @param [String] project # Project ID for this request. # @param [String] user # Name of the user resource 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::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_user(project, user, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/users/{user}', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::Operation command.params['project'] = project unless project.nil? command.params['user'] = user unless user.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 User resource. # @param [String] project # Project ID for this request. # @param [String] user # Name of the user resource to return. # @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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::User] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::User] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user(project, user, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/users/{user}', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::User::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::User command.params['project'] = project unless project.nil? command.params['user'] = user unless user.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 User resource in the specified project using the data included in # the request. # @param [String] project # Project ID for this request. # @param [Google::Apis::ClouduseraccountsBeta::User] user_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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::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_user(project, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/users', options) command.request_representation = Google::Apis::ClouduseraccountsBeta::User::Representation command.request_object = user_object command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::Operation command.params['project'] = project unless project.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 users contained within the specified project. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` # expression`. Your `expression` must be in the format: field_name # comparison_string literal_string. # The field_name is the name of the field you want to compare. Only atomic field # types are supported (string, number, boolean). The comparison_string must be # either eq (equals) or ne (not equals). The literal_string is the string value # to filter to. The literal value must be valid for the type of field you are # filtering by (string, number, boolean). For string fields, the literal value # is interpreted as a regular expression using RE2 syntax. The literal value # must match the entire field. # For example, to filter for instances that do not have a name of example- # instance, you would use filter=name ne example-instance. # Compute Engine Beta API Only: If you use filtering in the Beta API, you can # also filter on nested fields. For example, you could filter on instances that # have set the scheduling.automaticRestart field to true. In particular, use # filtering on nested fields to take advantage of instance labels to organize # and filter results based on label values. # The Beta API also supports filtering on multiple expressions by providing each # separate expression within parentheses. For example, (scheduling. # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are # treated as AND expressions, meaning that resources must match all expressions # to pass the filters. # @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. # @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 [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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::UserList] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::UserList] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_users(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/users', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::UserList::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::UserList command.params['project'] = project unless project.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['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 # Removes the specified public key from the user. # @param [String] project # Project ID for this request. # @param [String] user # Name of the user for this request. # @param [String] fingerprint # The fingerprint of the public key to delete. Public keys are identified by # their fingerprint, which is defined by RFC4716 to be the MD5 digest of the # public 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. # Overrides userIp if both are provided. # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ClouduseraccountsBeta::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ClouduseraccountsBeta::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 remove_user_public_key(project, user, fingerprint, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/users/{user}/removePublicKey', options) command.response_representation = Google::Apis::ClouduseraccountsBeta::Operation::Representation command.response_class = Google::Apis::ClouduseraccountsBeta::Operation command.params['project'] = project unless project.nil? command.params['user'] = user unless user.nil? command.query['fingerprint'] = fingerprint unless fingerprint.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 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 end end google-api-client-0.19.8/generated/google/apis/poly_v1/0000755000004100000410000000000013252673044022705 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/poly_v1/representations.rb0000644000004100000410000001555313252673044026470 0ustar www-datawww-data# 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 PolyV1 class Asset class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class File class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Format class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FormatComplexity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListAssetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLikedAssetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListUserAssetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PresentationParams class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Quaternion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UserAsset class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Asset # @private class Representation < Google::Apis::Core::JsonRepresentation property :author_name, as: 'authorName' property :create_time, as: 'createTime' property :description, as: 'description' property :display_name, as: 'displayName' collection :formats, as: 'formats', class: Google::Apis::PolyV1::Format, decorator: Google::Apis::PolyV1::Format::Representation property :is_curated, as: 'isCurated' property :license, as: 'license' property :metadata, as: 'metadata' property :name, as: 'name' property :presentation_params, as: 'presentationParams', class: Google::Apis::PolyV1::PresentationParams, decorator: Google::Apis::PolyV1::PresentationParams::Representation property :thumbnail, as: 'thumbnail', class: Google::Apis::PolyV1::File, decorator: Google::Apis::PolyV1::File::Representation property :update_time, as: 'updateTime' property :visibility, as: 'visibility' end end class File # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_type, as: 'contentType' property :relative_path, as: 'relativePath' property :url, as: 'url' end end class Format # @private class Representation < Google::Apis::Core::JsonRepresentation property :format_complexity, as: 'formatComplexity', class: Google::Apis::PolyV1::FormatComplexity, decorator: Google::Apis::PolyV1::FormatComplexity::Representation property :format_type, as: 'formatType' collection :resources, as: 'resources', class: Google::Apis::PolyV1::File, decorator: Google::Apis::PolyV1::File::Representation property :root, as: 'root', class: Google::Apis::PolyV1::File, decorator: Google::Apis::PolyV1::File::Representation end end class FormatComplexity # @private class Representation < Google::Apis::Core::JsonRepresentation property :lod_hint, as: 'lodHint' property :triangle_count, :numeric_string => true, as: 'triangleCount' end end class ListAssetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :assets, as: 'assets', class: Google::Apis::PolyV1::Asset, decorator: Google::Apis::PolyV1::Asset::Representation property :next_page_token, as: 'nextPageToken' property :total_size, as: 'totalSize' end end class ListLikedAssetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :assets, as: 'assets', class: Google::Apis::PolyV1::Asset, decorator: Google::Apis::PolyV1::Asset::Representation property :next_page_token, as: 'nextPageToken' property :total_size, as: 'totalSize' end end class ListUserAssetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' property :total_size, as: 'totalSize' collection :user_assets, as: 'userAssets', class: Google::Apis::PolyV1::UserAsset, decorator: Google::Apis::PolyV1::UserAsset::Representation end end class PresentationParams # @private class Representation < Google::Apis::Core::JsonRepresentation property :color_space, as: 'colorSpace' property :orienting_rotation, as: 'orientingRotation', class: Google::Apis::PolyV1::Quaternion, decorator: Google::Apis::PolyV1::Quaternion::Representation end end class Quaternion # @private class Representation < Google::Apis::Core::JsonRepresentation property :w, as: 'w' property :x, as: 'x' property :y, as: 'y' property :z, as: 'z' end end class UserAsset # @private class Representation < Google::Apis::Core::JsonRepresentation property :asset, as: 'asset', class: Google::Apis::PolyV1::Asset, decorator: Google::Apis::PolyV1::Asset::Representation end end end end end google-api-client-0.19.8/generated/google/apis/poly_v1/classes.rb0000644000004100000410000004071213252673044024673 0ustar www-datawww-data# 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 PolyV1 # Represents and describes an asset in the Poly library. An asset is a 3D model # or scene created using [Tilt Brush](//www.tiltbrush.com), # [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file # that can be upload to Poly. class Asset include Google::Apis::Core::Hashable # The author's publicly visible name. Use this name when giving credit to the # author. For more information, see [Licensing](/poly/discover/licensing). # Corresponds to the JSON property `authorName` # @return [String] attr_accessor :author_name # For published assets, the time when the asset was published. # For unpublished assets, the time when the asset was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # The human-readable description, set by the asset's author. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The human-readable name, set by the asset's author. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # A list of Formats where each # format describes one representation of the asset. # Corresponds to the JSON property `formats` # @return [Array] attr_accessor :formats # Whether this asset has been curated by the Poly team. # Corresponds to the JSON property `isCurated` # @return [Boolean] attr_accessor :is_curated alias_method :is_curated?, :is_curated # The license under which the author has made the asset available # for use, if any. # Corresponds to the JSON property `license` # @return [String] attr_accessor :license # Application-defined opaque metadata for this asset. This field is only # returned when querying for the signed-in user's own assets, not for public # assets. This string is limited to 1K chars. It is up to the creator of # the asset to define the format for this string (for example, JSON). # Corresponds to the JSON property `metadata` # @return [String] attr_accessor :metadata # The unique identifier for the asset in the form: # `assets/`ASSET_ID``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Hints for displaying the asset, based on information available when the asset # was uploaded. # Corresponds to the JSON property `presentationParams` # @return [Google::Apis::PolyV1::PresentationParams] attr_accessor :presentation_params # Represents a file in Poly, which can be a root, # resource, or thumbnail file. # Corresponds to the JSON property `thumbnail` # @return [Google::Apis::PolyV1::File] attr_accessor :thumbnail # The time when the asset was last modified. For published assets, whose # contents are immutable, the update time changes only when metadata # properties, such as visibility, are updated. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # The visibility of the asset and who can access it. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @author_name = args[:author_name] if args.key?(:author_name) @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) @formats = args[:formats] if args.key?(:formats) @is_curated = args[:is_curated] if args.key?(:is_curated) @license = args[:license] if args.key?(:license) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @presentation_params = args[:presentation_params] if args.key?(:presentation_params) @thumbnail = args[:thumbnail] if args.key?(:thumbnail) @update_time = args[:update_time] if args.key?(:update_time) @visibility = args[:visibility] if args.key?(:visibility) end end # Represents a file in Poly, which can be a root, # resource, or thumbnail file. class File include Google::Apis::Core::Hashable # The MIME content-type, such as `image/png`. # For more information, see # [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/ # MIME_types). # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # The path of the resource file relative to the root file. # For root or thumbnail files, this is just the filename. # Corresponds to the JSON property `relativePath` # @return [String] attr_accessor :relative_path # The URL where the file data can be retrieved. # 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) @content_type = args[:content_type] if args.key?(:content_type) @relative_path = args[:relative_path] if args.key?(:relative_path) @url = args[:url] if args.key?(:url) end end # The same asset can be represented in different formats, for example, # a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its # corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file # with its corresponding .glb binary data. A format refers to a specific # representation of an asset and contains all information needed to # retrieve and describe this representation. class Format include Google::Apis::Core::Hashable # Information on the complexity of this Format. # Corresponds to the JSON property `formatComplexity` # @return [Google::Apis::PolyV1::FormatComplexity] attr_accessor :format_complexity # A short string that identifies the format type of this representation. # Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`. # Corresponds to the JSON property `formatType` # @return [String] attr_accessor :format_type # A list of dependencies of the root element. May include, but is not # limited to, materials, textures, and shader programs. # Corresponds to the JSON property `resources` # @return [Array] attr_accessor :resources # Represents a file in Poly, which can be a root, # resource, or thumbnail file. # Corresponds to the JSON property `root` # @return [Google::Apis::PolyV1::File] attr_accessor :root def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @format_complexity = args[:format_complexity] if args.key?(:format_complexity) @format_type = args[:format_type] if args.key?(:format_type) @resources = args[:resources] if args.key?(:resources) @root = args[:root] if args.key?(:root) end end # Information on the complexity of this Format. class FormatComplexity include Google::Apis::Core::Hashable # A non-negative integer that represents the level of detail (LOD) of this # format relative to other formats of the same asset with the same # format_type. # This hint allows you to sort formats from the most-detailed (0) to # least-detailed (integers greater than 0). # Corresponds to the JSON property `lodHint` # @return [Fixnum] attr_accessor :lod_hint # The estimated number of triangles. # Corresponds to the JSON property `triangleCount` # @return [Fixnum] attr_accessor :triangle_count def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @lod_hint = args[:lod_hint] if args.key?(:lod_hint) @triangle_count = args[:triangle_count] if args.key?(:triangle_count) end end # A response message from a request to list. class ListAssetsResponse include Google::Apis::Core::Hashable # A list of assets that match the criteria specified in the request. # Corresponds to the JSON property `assets` # @return [Array] attr_accessor :assets # The continuation token for retrieving the next page. If empty, # indicates that there are no more pages. To get the next page, submit the # same request specifying this value as the # page_token. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The total number of assets in the list, without pagination. # Corresponds to the JSON property `totalSize` # @return [Fixnum] attr_accessor :total_size def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @assets = args[:assets] if args.key?(:assets) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @total_size = args[:total_size] if args.key?(:total_size) end end # A response message from a request to list. class ListLikedAssetsResponse include Google::Apis::Core::Hashable # A list of assets that match the criteria specified in the request. # Corresponds to the JSON property `assets` # @return [Array] attr_accessor :assets # The continuation token for retrieving the next page. If empty, # indicates that there are no more pages. To get the next page, submit the # same request specifying this value as the # page_token. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The total number of assets in the list, without pagination. # Corresponds to the JSON property `totalSize` # @return [Fixnum] attr_accessor :total_size def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @assets = args[:assets] if args.key?(:assets) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @total_size = args[:total_size] if args.key?(:total_size) end end # A response message from a request to list. class ListUserAssetsResponse include Google::Apis::Core::Hashable # The continuation token for retrieving the next page. If empty, # indicates that there are no more pages. To get the next page, submit the # same request specifying this value as the # page_token. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The total number of assets in the list, without pagination. # Corresponds to the JSON property `totalSize` # @return [Fixnum] attr_accessor :total_size # A list of UserAssets matching the request. # Corresponds to the JSON property `userAssets` # @return [Array] attr_accessor :user_assets 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) @total_size = args[:total_size] if args.key?(:total_size) @user_assets = args[:user_assets] if args.key?(:user_assets) end end # Hints for displaying the asset, based on information available when the asset # was uploaded. class PresentationParams include Google::Apis::Core::Hashable # The materials' diffuse/albedo color. This does not apply to vertex colors # or texture maps. # Corresponds to the JSON property `colorSpace` # @return [String] attr_accessor :color_space # A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the # response you see "w: 1" and nothing else this is the default value of # [0, 0, 0, 1] where x,y, and z are 0. # Corresponds to the JSON property `orientingRotation` # @return [Google::Apis::PolyV1::Quaternion] attr_accessor :orienting_rotation def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @color_space = args[:color_space] if args.key?(:color_space) @orienting_rotation = args[:orienting_rotation] if args.key?(:orienting_rotation) end end # A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the # response you see "w: 1" and nothing else this is the default value of # [0, 0, 0, 1] where x,y, and z are 0. class Quaternion include Google::Apis::Core::Hashable # The scalar component. # Corresponds to the JSON property `w` # @return [Float] attr_accessor :w # The x component. # Corresponds to the JSON property `x` # @return [Float] attr_accessor :x # The y component. # Corresponds to the JSON property `y` # @return [Float] attr_accessor :y # The z component. # Corresponds to the JSON property `z` # @return [Float] attr_accessor :z def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @w = args[:w] if args.key?(:w) @x = args[:x] if args.key?(:x) @y = args[:y] if args.key?(:y) @z = args[:z] if args.key?(:z) end end # Data about the user's asset. class UserAsset include Google::Apis::Core::Hashable # Represents and describes an asset in the Poly library. An asset is a 3D model # or scene created using [Tilt Brush](//www.tiltbrush.com), # [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file # that can be upload to Poly. # Corresponds to the JSON property `asset` # @return [Google::Apis::PolyV1::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 end end end google-api-client-0.19.8/generated/google/apis/poly_v1/service.rb0000644000004100000410000003536413252673044024705 0ustar www-datawww-data# 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 PolyV1 # Poly API # # The Poly API provides read-only access to assets hosted on poly.google.com. # # @example # require 'google/apis/poly_v1' # # Poly = Google::Apis::PolyV1 # Alias the module # service = Poly::PolyServiceService.new # # @see https://developers.google.com/poly/ class PolyServiceService < 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://poly.googleapis.com/', '') @batch_path = 'batch' end # Returns detailed information about an asset given its name. # PRIVATE assets are returned only if # the currently authenticated user (via OAuth token) is the author of the asset. # @param [String] name # Required. An asset's name in the form `assets/`ASSET_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::PolyV1::Asset] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PolyV1::Asset] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_asset(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::PolyV1::Asset::Representation command.response_class = Google::Apis::PolyV1::Asset 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 public, remixable assets. These are assets with an access level of # PUBLIC and published under the # CC-By license. # @param [String] category # Filter assets based on the specified category. Supported values are: # `animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, ` # scenes`, # `technology`, and `transport`. # @param [Boolean] curated # Return only assets that have been curated by the Poly team. # @param [String] format # Return only assets with the matching format. Acceptable values are: # `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`. # @param [String] keywords # One or more search terms to be matched against all text that Poly has # indexed for assets, which includes display_name, # description, and tags. Multiple keywords should be # separated by spaces. # @param [String] max_complexity # Returns assets that are of the specified complexity or less. Defaults to # COMPLEX. For example, a request for # MEDIUM assets also includes # SIMPLE assets. # @param [String] order_by # Specifies an ordering for assets. Acceptable values are: # `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets # based on a combination of popularity and other features. # @param [Fixnum] page_size # The maximum number of assets to be returned. This value must be between `1` # and `100`. Defaults to `20`. # @param [String] page_token # Specifies a continuation token from a previous search whose results were # split into multiple pages. To get the next page, submit the same request # specifying the value from next_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::PolyV1::ListAssetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PolyV1::ListAssetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_assets(category: nil, curated: nil, format: nil, keywords: nil, max_complexity: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/assets', options) command.response_representation = Google::Apis::PolyV1::ListAssetsResponse::Representation command.response_class = Google::Apis::PolyV1::ListAssetsResponse command.query['category'] = category unless category.nil? command.query['curated'] = curated unless curated.nil? command.query['format'] = format unless format.nil? command.query['keywords'] = keywords unless keywords.nil? command.query['maxComplexity'] = max_complexity unless max_complexity.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 # Lists assets authored by the given user. Only the value 'me', representing # the currently-authenticated user, is supported. May include assets with an # access level of PRIVATE or # UNLISTED and assets which are # All Rights Reserved for the # currently-authenticated user. # @param [String] name # A valid user id. Currently, only the special value 'me', representing the # currently-authenticated user is supported. To use 'me', you must pass # an OAuth token with the request. # @param [String] format # Return only assets with the matching format. Acceptable values are: # `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`. # @param [String] order_by # Specifies an ordering for assets. Acceptable values are: # `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets # based on a combination of popularity and other features. # @param [Fixnum] page_size # The maximum number of assets to be returned. This value must be between `1` # and `100`. Defaults to `20`. # @param [String] page_token # Specifies a continuation token from a previous search whose results were # split into multiple pages. To get the next page, submit the same request # specifying the value from # next_page_token. # @param [String] visibility # The visibility of the assets to be returned. # Defaults to VISIBILITY_UNSPECIFIED which returns all assets. # @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::PolyV1::ListUserAssetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PolyV1::ListUserAssetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_assets(name, format: nil, order_by: nil, page_size: nil, page_token: nil, visibility: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/assets', options) command.response_representation = Google::Apis::PolyV1::ListUserAssetsResponse::Representation command.response_class = Google::Apis::PolyV1::ListUserAssetsResponse command.params['name'] = name unless name.nil? command.query['format'] = format unless format.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['visibility'] = visibility unless visibility.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 assets that the user has liked. Only the value 'me', representing # the currently-authenticated user, is supported. May include assets with an # access level of UNLISTED. # @param [String] name # A valid user id. Currently, only the special value 'me', representing the # currently-authenticated user is supported. To use 'me', you must pass # an OAuth token with the request. # @param [String] format # Return only assets with the matching format. Acceptable values are: # `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`. # @param [String] order_by # Specifies an ordering for assets. Acceptable values are: # `BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which # ranks assets based on how recently they were liked. # @param [Fixnum] page_size # The maximum number of assets to be returned. This value must be between `1` # and `100`. Defaults to `20`. # @param [String] page_token # Specifies a continuation token from a previous search whose results were # split into multiple pages. To get the next page, submit the same request # specifying the value from # next_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::PolyV1::ListLikedAssetsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::PolyV1::ListLikedAssetsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_user_likedassets(name, format: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/likedassets', options) command.response_representation = Google::Apis::PolyV1::ListLikedAssetsResponse::Representation command.response_class = Google::Apis::PolyV1::ListLikedAssetsResponse command.params['name'] = name unless name.nil? command.query['format'] = format unless format.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 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 google-api-client-0.19.8/generated/google/apis/appengine_v1beta4.rb0000644000004100000410000000301313252673043025131 0ustar www-datawww-data# 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/appengine_v1beta4/service.rb' require 'google/apis/appengine_v1beta4/classes.rb' require 'google/apis/appengine_v1beta4/representations.rb' module Google module Apis # Google App Engine Admin API # # The App Engine Admin API enables developers to provision and manage their App # Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta4 VERSION = 'V1beta4' REVISION = '20180209' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' end end end google-api-client-0.19.8/generated/google/apis/appengine_v1beta5.rb0000644000004100000410000000301313252673043025132 0ustar www-datawww-data# 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/appengine_v1beta5/service.rb' require 'google/apis/appengine_v1beta5/classes.rb' require 'google/apis/appengine_v1beta5/representations.rb' module Google module Apis # Google App Engine Admin API # # The App Engine Admin API enables developers to provision and manage their App # Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta5 VERSION = 'V1beta5' REVISION = '20180209' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' end end end google-api-client-0.19.8/generated/google/apis/deploymentmanager_alpha.rb0000644000004100000410000000344413252673043026525 0ustar www-datawww-data# 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/deploymentmanager_alpha/service.rb' require 'google/apis/deploymentmanager_alpha/classes.rb' require 'google/apis/deploymentmanager_alpha/representations.rb' module Google module Apis # Google Cloud Deployment Manager Alpha API # # The Deployment Manager API allows users to declaratively configure, deploy and # run complex solutions on the Google Cloud Platform. # # @see https://cloud.google.com/deployment-manager/ module DeploymentmanagerAlpha VERSION = 'Alpha' REVISION = '20180214' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' # View and manage your Google Cloud Platform management resources and deployment status information AUTH_NDEV_CLOUDMAN = 'https://www.googleapis.com/auth/ndev.cloudman' # View your Google Cloud Platform management resources and deployment status information AUTH_NDEV_CLOUDMAN_READONLY = 'https://www.googleapis.com/auth/ndev.cloudman.readonly' end end end google-api-client-0.19.8/generated/google/apis/youtube_v3/0000755000004100000410000000000013252673044023420 5ustar www-datawww-datagoogle-api-client-0.19.8/generated/google/apis/youtube_v3/representations.rb0000644000004100000410000041567213252673044027211 0ustar www-datawww-data# 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 YoutubeV3 class AccessPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Activity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsBulletin class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsChannelItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsComment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsFavorite class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsLike class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsPlaylistItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsPromotedItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsRecommendation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsSocial class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsSubscription class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivityContentDetailsUpload class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListActivitiesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ActivitySnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Caption class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListCaptionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CaptionSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CdnSettings 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 ChannelAuditDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelBannerResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelBrandingSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end class RelatedPlaylists class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end include Google::Apis::Core::JsonObjectSupport end class ChannelContentOwnerDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelConversionPing class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelConversionPings 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 ChannelLocalization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelProfileDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelSection class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelSectionContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListChannelSectionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelSectionLocalization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelSectionSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelSectionTargeting class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelStatistics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ChannelTopicDetails 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 ListCommentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CommentSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CommentThread class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListCommentThreadsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CommentThreadReplies class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CommentThreadSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContentRating class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FanFundingEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FanFundingEventListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class FanFundingEventSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GeoPoint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GuideCategory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListGuideCategoriesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GuideCategorySnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class I18nLanguage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListI18nLanguagesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class I18nLanguageSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class I18nRegion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListI18nRegionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class I18nRegionSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImageSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class IngestionInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InvideoBranding class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InvideoPosition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InvideoPromotion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class InvideoTiming class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LanguageTag class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveBroadcast class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveBroadcastContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLiveBroadcastsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveBroadcastSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveBroadcastStatistics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveBroadcastStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatBan class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatBanSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatFanFundingEventDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatMessage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatMessageAuthorDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatMessageDeletedDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatMessageListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatMessageRetractedDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatMessageSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatModerator class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatModeratorListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatModeratorSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatPollClosedDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatPollEditedDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatPollItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatPollOpenedDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatPollVotedDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatSuperChatDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatTextMessageDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveChatUserBannedMessageDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveStream class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveStreamConfigurationIssue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveStreamContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveStreamHealthStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListLiveStreamsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveStreamSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LiveStreamStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LocalizedProperty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LocalizedString class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MonitorStreamInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Nonprofit class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NonprofitId 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 Playlist class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlaylistContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlaylistItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlaylistItemContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPlaylistItemsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlaylistItemSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlaylistItemStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListPlaylistResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlaylistLocalization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlaylistPlayer class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlaylistSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PlaylistStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PromotedItem class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PromotedItemId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PropertyValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ResourceId class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchListsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchResult class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SearchResultSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Sponsor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SponsorListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SponsorSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Subscription class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SubscriptionContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListSubscriptionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SubscriptionSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SubscriptionSubscriberSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SuperChatEvent class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SuperChatEventListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SuperChatEventSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Thumbnail class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ThumbnailDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SetThumbnailResponse 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 Video class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoAbuseReport class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoAbuseReportReason class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListVideoAbuseReportReasonResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoAbuseReportReasonSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoAbuseReportSecondaryReason class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoAgeGating class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoCategory class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListVideoCategoryResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoCategorySnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoContentDetailsRegionRestriction class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoFileDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoFileDetailsAudioStream class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoFileDetailsVideoStream class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetVideoRatingResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListVideosResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoLiveStreamingDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoLocalization class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoMonetizationDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoPlayer class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoProcessingDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoProcessingDetailsProcessingProgress class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoProjectDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoRating class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoRecordingDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoSnippet class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoStatistics class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoStatus class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoSuggestions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoSuggestionsTagSuggestion class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class VideoTopicDetails class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class WatchSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AccessPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :allowed, as: 'allowed' collection :exception, as: 'exception' end end class Activity # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeV3::ActivityContentDetails, decorator: Google::Apis::YoutubeV3::ActivityContentDetails::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::ActivitySnippet, decorator: Google::Apis::YoutubeV3::ActivitySnippet::Representation end end class ActivityContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :bulletin, as: 'bulletin', class: Google::Apis::YoutubeV3::ActivityContentDetailsBulletin, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsBulletin::Representation property :channel_item, as: 'channelItem', class: Google::Apis::YoutubeV3::ActivityContentDetailsChannelItem, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsChannelItem::Representation property :comment, as: 'comment', class: Google::Apis::YoutubeV3::ActivityContentDetailsComment, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsComment::Representation property :favorite, as: 'favorite', class: Google::Apis::YoutubeV3::ActivityContentDetailsFavorite, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsFavorite::Representation property :like, as: 'like', class: Google::Apis::YoutubeV3::ActivityContentDetailsLike, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsLike::Representation property :playlist_item, as: 'playlistItem', class: Google::Apis::YoutubeV3::ActivityContentDetailsPlaylistItem, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsPlaylistItem::Representation property :promoted_item, as: 'promotedItem', class: Google::Apis::YoutubeV3::ActivityContentDetailsPromotedItem, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsPromotedItem::Representation property :recommendation, as: 'recommendation', class: Google::Apis::YoutubeV3::ActivityContentDetailsRecommendation, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsRecommendation::Representation property :social, as: 'social', class: Google::Apis::YoutubeV3::ActivityContentDetailsSocial, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsSocial::Representation property :subscription, as: 'subscription', class: Google::Apis::YoutubeV3::ActivityContentDetailsSubscription, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsSubscription::Representation property :upload, as: 'upload', class: Google::Apis::YoutubeV3::ActivityContentDetailsUpload, decorator: Google::Apis::YoutubeV3::ActivityContentDetailsUpload::Representation end end class ActivityContentDetailsBulletin # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation end end class ActivityContentDetailsChannelItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation end end class ActivityContentDetailsComment # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation end end class ActivityContentDetailsFavorite # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation end end class ActivityContentDetailsLike # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation end end class ActivityContentDetailsPlaylistItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :playlist_id, as: 'playlistId' property :playlist_item_id, as: 'playlistItemId' property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation end end class ActivityContentDetailsPromotedItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :ad_tag, as: 'adTag' property :click_tracking_url, as: 'clickTrackingUrl' property :creative_view_url, as: 'creativeViewUrl' property :cta_type, as: 'ctaType' property :custom_cta_button_text, as: 'customCtaButtonText' property :description_text, as: 'descriptionText' property :destination_url, as: 'destinationUrl' collection :forecasting_url, as: 'forecastingUrl' collection :impression_url, as: 'impressionUrl' property :video_id, as: 'videoId' end end class ActivityContentDetailsRecommendation # @private class Representation < Google::Apis::Core::JsonRepresentation property :reason, as: 'reason' property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation property :seed_resource_id, as: 'seedResourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation end end class ActivityContentDetailsSocial # @private class Representation < Google::Apis::Core::JsonRepresentation property :author, as: 'author' property :image_url, as: 'imageUrl' property :reference_url, as: 'referenceUrl' property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation property :type, as: 'type' end end class ActivityContentDetailsSubscription # @private class Representation < Google::Apis::Core::JsonRepresentation property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation end end class ActivityContentDetailsUpload # @private class Representation < Google::Apis::Core::JsonRepresentation property :video_id, as: 'videoId' end end class ListActivitiesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::Activity, decorator: Google::Apis::YoutubeV3::Activity::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class ActivitySnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :channel_title, as: 'channelTitle' property :description, as: 'description' property :group_id, as: 'groupId' property :published_at, as: 'publishedAt', type: DateTime property :thumbnails, as: 'thumbnails', class: Google::Apis::YoutubeV3::ThumbnailDetails, decorator: Google::Apis::YoutubeV3::ThumbnailDetails::Representation property :title, as: 'title' property :type, as: 'type' end end class Caption # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::CaptionSnippet, decorator: Google::Apis::YoutubeV3::CaptionSnippet::Representation end end class ListCaptionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::Caption, decorator: Google::Apis::YoutubeV3::Caption::Representation property :kind, as: 'kind' property :visitor_id, as: 'visitorId' end end class CaptionSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :audio_track_type, as: 'audioTrackType' property :failure_reason, as: 'failureReason' property :is_auto_synced, as: 'isAutoSynced' property :is_cc, as: 'isCC' property :is_draft, as: 'isDraft' property :is_easy_reader, as: 'isEasyReader' property :is_large, as: 'isLarge' property :language, as: 'language' property :last_updated, as: 'lastUpdated', type: DateTime property :name, as: 'name' property :status, as: 'status' property :track_kind, as: 'trackKind' property :video_id, as: 'videoId' end end class CdnSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :format, as: 'format' property :frame_rate, as: 'frameRate' property :ingestion_info, as: 'ingestionInfo', class: Google::Apis::YoutubeV3::IngestionInfo, decorator: Google::Apis::YoutubeV3::IngestionInfo::Representation property :ingestion_type, as: 'ingestionType' property :resolution, as: 'resolution' end end class Channel # @private class Representation < Google::Apis::Core::JsonRepresentation property :audit_details, as: 'auditDetails', class: Google::Apis::YoutubeV3::ChannelAuditDetails, decorator: Google::Apis::YoutubeV3::ChannelAuditDetails::Representation property :branding_settings, as: 'brandingSettings', class: Google::Apis::YoutubeV3::ChannelBrandingSettings, decorator: Google::Apis::YoutubeV3::ChannelBrandingSettings::Representation property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeV3::ChannelContentDetails, decorator: Google::Apis::YoutubeV3::ChannelContentDetails::Representation property :content_owner_details, as: 'contentOwnerDetails', class: Google::Apis::YoutubeV3::ChannelContentOwnerDetails, decorator: Google::Apis::YoutubeV3::ChannelContentOwnerDetails::Representation property :conversion_pings, as: 'conversionPings', class: Google::Apis::YoutubeV3::ChannelConversionPings, decorator: Google::Apis::YoutubeV3::ChannelConversionPings::Representation property :etag, as: 'etag' property :id, as: 'id' property :invideo_promotion, as: 'invideoPromotion', class: Google::Apis::YoutubeV3::InvideoPromotion, decorator: Google::Apis::YoutubeV3::InvideoPromotion::Representation property :kind, as: 'kind' hash :localizations, as: 'localizations', class: Google::Apis::YoutubeV3::ChannelLocalization, decorator: Google::Apis::YoutubeV3::ChannelLocalization::Representation property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::ChannelSnippet, decorator: Google::Apis::YoutubeV3::ChannelSnippet::Representation property :statistics, as: 'statistics', class: Google::Apis::YoutubeV3::ChannelStatistics, decorator: Google::Apis::YoutubeV3::ChannelStatistics::Representation property :status, as: 'status', class: Google::Apis::YoutubeV3::ChannelStatus, decorator: Google::Apis::YoutubeV3::ChannelStatus::Representation property :topic_details, as: 'topicDetails', class: Google::Apis::YoutubeV3::ChannelTopicDetails, decorator: Google::Apis::YoutubeV3::ChannelTopicDetails::Representation end end class ChannelAuditDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :community_guidelines_good_standing, as: 'communityGuidelinesGoodStanding' property :content_id_claims_good_standing, as: 'contentIdClaimsGoodStanding' property :copyright_strikes_good_standing, as: 'copyrightStrikesGoodStanding' property :overall_good_standing, as: 'overallGoodStanding' end end class ChannelBannerResource # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :kind, as: 'kind' property :url, as: 'url' end end class ChannelBrandingSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel, as: 'channel', class: Google::Apis::YoutubeV3::ChannelSettings, decorator: Google::Apis::YoutubeV3::ChannelSettings::Representation collection :hints, as: 'hints', class: Google::Apis::YoutubeV3::PropertyValue, decorator: Google::Apis::YoutubeV3::PropertyValue::Representation property :image, as: 'image', class: Google::Apis::YoutubeV3::ImageSettings, decorator: Google::Apis::YoutubeV3::ImageSettings::Representation property :watch, as: 'watch', class: Google::Apis::YoutubeV3::WatchSettings, decorator: Google::Apis::YoutubeV3::WatchSettings::Representation end end class ChannelContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :related_playlists, as: 'relatedPlaylists', class: Google::Apis::YoutubeV3::ChannelContentDetails::RelatedPlaylists, decorator: Google::Apis::YoutubeV3::ChannelContentDetails::RelatedPlaylists::Representation end class RelatedPlaylists # @private class Representation < Google::Apis::Core::JsonRepresentation property :favorites, as: 'favorites' property :likes, as: 'likes' property :uploads, as: 'uploads' property :watch_history, as: 'watchHistory' property :watch_later, as: 'watchLater' end end end class ChannelContentOwnerDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_owner, as: 'contentOwner' property :time_linked, as: 'timeLinked', type: DateTime end end class ChannelConversionPing # @private class Representation < Google::Apis::Core::JsonRepresentation property :context, as: 'context' property :conversion_url, as: 'conversionUrl' end end class ChannelConversionPings # @private class Representation < Google::Apis::Core::JsonRepresentation collection :pings, as: 'pings', class: Google::Apis::YoutubeV3::ChannelConversionPing, decorator: Google::Apis::YoutubeV3::ChannelConversionPing::Representation end end class ListChannelsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::Channel, decorator: Google::Apis::YoutubeV3::Channel::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class ChannelLocalization # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :title, as: 'title' end end class ChannelProfileDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :channel_url, as: 'channelUrl' property :display_name, as: 'displayName' property :profile_image_url, as: 'profileImageUrl' end end class ChannelSection # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeV3::ChannelSectionContentDetails, decorator: Google::Apis::YoutubeV3::ChannelSectionContentDetails::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' hash :localizations, as: 'localizations', class: Google::Apis::YoutubeV3::ChannelSectionLocalization, decorator: Google::Apis::YoutubeV3::ChannelSectionLocalization::Representation property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::ChannelSectionSnippet, decorator: Google::Apis::YoutubeV3::ChannelSectionSnippet::Representation property :targeting, as: 'targeting', class: Google::Apis::YoutubeV3::ChannelSectionTargeting, decorator: Google::Apis::YoutubeV3::ChannelSectionTargeting::Representation end end class ChannelSectionContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation collection :channels, as: 'channels' collection :playlists, as: 'playlists' end end class ListChannelSectionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::ChannelSection, decorator: Google::Apis::YoutubeV3::ChannelSection::Representation property :kind, as: 'kind' property :visitor_id, as: 'visitorId' end end class ChannelSectionLocalization # @private class Representation < Google::Apis::Core::JsonRepresentation property :title, as: 'title' end end class ChannelSectionSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :default_language, as: 'defaultLanguage' property :localized, as: 'localized', class: Google::Apis::YoutubeV3::ChannelSectionLocalization, decorator: Google::Apis::YoutubeV3::ChannelSectionLocalization::Representation property :position, as: 'position' property :style, as: 'style' property :title, as: 'title' property :type, as: 'type' end end class ChannelSectionTargeting # @private class Representation < Google::Apis::Core::JsonRepresentation collection :countries, as: 'countries' collection :languages, as: 'languages' collection :regions, as: 'regions' end end class ChannelSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' property :default_language, as: 'defaultLanguage' property :default_tab, as: 'defaultTab' property :description, as: 'description' property :featured_channels_title, as: 'featuredChannelsTitle' collection :featured_channels_urls, as: 'featuredChannelsUrls' property :keywords, as: 'keywords' property :moderate_comments, as: 'moderateComments' property :profile_color, as: 'profileColor' property :show_browse_view, as: 'showBrowseView' property :show_related_channels, as: 'showRelatedChannels' property :title, as: 'title' property :tracking_analytics_account_id, as: 'trackingAnalyticsAccountId' property :unsubscribed_trailer, as: 'unsubscribedTrailer' end end class ChannelSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :country, as: 'country' property :custom_url, as: 'customUrl' property :default_language, as: 'defaultLanguage' property :description, as: 'description' property :localized, as: 'localized', class: Google::Apis::YoutubeV3::ChannelLocalization, decorator: Google::Apis::YoutubeV3::ChannelLocalization::Representation property :published_at, as: 'publishedAt', type: DateTime property :thumbnails, as: 'thumbnails', class: Google::Apis::YoutubeV3::ThumbnailDetails, decorator: Google::Apis::YoutubeV3::ThumbnailDetails::Representation property :title, as: 'title' end end class ChannelStatistics # @private class Representation < Google::Apis::Core::JsonRepresentation property :comment_count, :numeric_string => true, as: 'commentCount' property :hidden_subscriber_count, as: 'hiddenSubscriberCount' property :subscriber_count, :numeric_string => true, as: 'subscriberCount' property :video_count, :numeric_string => true, as: 'videoCount' property :view_count, :numeric_string => true, as: 'viewCount' end end class ChannelStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :is_linked, as: 'isLinked' property :long_uploads_status, as: 'longUploadsStatus' property :privacy_status, as: 'privacyStatus' end end class ChannelTopicDetails # @private class Representation < Google::Apis::Core::JsonRepresentation collection :topic_categories, as: 'topicCategories' collection :topic_ids, as: 'topicIds' end end class Comment # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::CommentSnippet, decorator: Google::Apis::YoutubeV3::CommentSnippet::Representation end end class ListCommentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::Comment, decorator: Google::Apis::YoutubeV3::Comment::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class CommentSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :author_channel_id, as: 'authorChannelId' property :author_channel_url, as: 'authorChannelUrl' property :author_display_name, as: 'authorDisplayName' property :author_profile_image_url, as: 'authorProfileImageUrl' property :can_rate, as: 'canRate' property :channel_id, as: 'channelId' property :like_count, as: 'likeCount' property :moderation_status, as: 'moderationStatus' property :parent_id, as: 'parentId' property :published_at, as: 'publishedAt', type: DateTime property :text_display, as: 'textDisplay' property :text_original, as: 'textOriginal' property :updated_at, as: 'updatedAt', type: DateTime property :video_id, as: 'videoId' property :viewer_rating, as: 'viewerRating' end end class CommentThread # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :replies, as: 'replies', class: Google::Apis::YoutubeV3::CommentThreadReplies, decorator: Google::Apis::YoutubeV3::CommentThreadReplies::Representation property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::CommentThreadSnippet, decorator: Google::Apis::YoutubeV3::CommentThreadSnippet::Representation end end class ListCommentThreadsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::CommentThread, decorator: Google::Apis::YoutubeV3::CommentThread::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class CommentThreadReplies # @private class Representation < Google::Apis::Core::JsonRepresentation collection :comments, as: 'comments', class: Google::Apis::YoutubeV3::Comment, decorator: Google::Apis::YoutubeV3::Comment::Representation end end class CommentThreadSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :can_reply, as: 'canReply' property :channel_id, as: 'channelId' property :is_public, as: 'isPublic' property :top_level_comment, as: 'topLevelComment', class: Google::Apis::YoutubeV3::Comment, decorator: Google::Apis::YoutubeV3::Comment::Representation property :total_reply_count, as: 'totalReplyCount' property :video_id, as: 'videoId' end end class ContentRating # @private class Representation < Google::Apis::Core::JsonRepresentation property :acb_rating, as: 'acbRating' property :agcom_rating, as: 'agcomRating' property :anatel_rating, as: 'anatelRating' property :bbfc_rating, as: 'bbfcRating' property :bfvc_rating, as: 'bfvcRating' property :bmukk_rating, as: 'bmukkRating' property :catv_rating, as: 'catvRating' property :catvfr_rating, as: 'catvfrRating' property :cbfc_rating, as: 'cbfcRating' property :ccc_rating, as: 'cccRating' property :cce_rating, as: 'cceRating' property :chfilm_rating, as: 'chfilmRating' property :chvrs_rating, as: 'chvrsRating' property :cicf_rating, as: 'cicfRating' property :cna_rating, as: 'cnaRating' property :cnc_rating, as: 'cncRating' property :csa_rating, as: 'csaRating' property :cscf_rating, as: 'cscfRating' property :czfilm_rating, as: 'czfilmRating' property :djctq_rating, as: 'djctqRating' collection :djctq_rating_reasons, as: 'djctqRatingReasons' property :ecbmct_rating, as: 'ecbmctRating' property :eefilm_rating, as: 'eefilmRating' property :egfilm_rating, as: 'egfilmRating' property :eirin_rating, as: 'eirinRating' property :fcbm_rating, as: 'fcbmRating' property :fco_rating, as: 'fcoRating' property :fmoc_rating, as: 'fmocRating' property :fpb_rating, as: 'fpbRating' collection :fpb_rating_reasons, as: 'fpbRatingReasons' property :fsk_rating, as: 'fskRating' property :grfilm_rating, as: 'grfilmRating' property :icaa_rating, as: 'icaaRating' property :ifco_rating, as: 'ifcoRating' property :ilfilm_rating, as: 'ilfilmRating' property :incaa_rating, as: 'incaaRating' property :kfcb_rating, as: 'kfcbRating' property :kijkwijzer_rating, as: 'kijkwijzerRating' property :kmrb_rating, as: 'kmrbRating' property :lsf_rating, as: 'lsfRating' property :mccaa_rating, as: 'mccaaRating' property :mccyp_rating, as: 'mccypRating' property :mcst_rating, as: 'mcstRating' property :mda_rating, as: 'mdaRating' property :medietilsynet_rating, as: 'medietilsynetRating' property :meku_rating, as: 'mekuRating' property :mena_mpaa_rating, as: 'menaMpaaRating' property :mibac_rating, as: 'mibacRating' property :moc_rating, as: 'mocRating' property :moctw_rating, as: 'moctwRating' property :mpaa_rating, as: 'mpaaRating' property :mpaat_rating, as: 'mpaatRating' property :mtrcb_rating, as: 'mtrcbRating' property :nbc_rating, as: 'nbcRating' property :nbcpl_rating, as: 'nbcplRating' property :nfrc_rating, as: 'nfrcRating' property :nfvcb_rating, as: 'nfvcbRating' property :nkclv_rating, as: 'nkclvRating' property :oflc_rating, as: 'oflcRating' property :pefilm_rating, as: 'pefilmRating' property :rcnof_rating, as: 'rcnofRating' property :resorteviolencia_rating, as: 'resorteviolenciaRating' property :rtc_rating, as: 'rtcRating' property :rte_rating, as: 'rteRating' property :russia_rating, as: 'russiaRating' property :skfilm_rating, as: 'skfilmRating' property :smais_rating, as: 'smaisRating' property :smsa_rating, as: 'smsaRating' property :tvpg_rating, as: 'tvpgRating' property :yt_rating, as: 'ytRating' end end class FanFundingEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::FanFundingEventSnippet, decorator: Google::Apis::YoutubeV3::FanFundingEventSnippet::Representation end end class FanFundingEventListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::FanFundingEvent, decorator: Google::Apis::YoutubeV3::FanFundingEvent::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class FanFundingEventSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount_micros, :numeric_string => true, as: 'amountMicros' property :channel_id, as: 'channelId' property :comment_text, as: 'commentText' property :created_at, as: 'createdAt', type: DateTime property :currency, as: 'currency' property :display_string, as: 'displayString' property :supporter_details, as: 'supporterDetails', class: Google::Apis::YoutubeV3::ChannelProfileDetails, decorator: Google::Apis::YoutubeV3::ChannelProfileDetails::Representation end end class GeoPoint # @private class Representation < Google::Apis::Core::JsonRepresentation property :altitude, as: 'altitude' property :latitude, as: 'latitude' property :longitude, as: 'longitude' end end class GuideCategory # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::GuideCategorySnippet, decorator: Google::Apis::YoutubeV3::GuideCategorySnippet::Representation end end class ListGuideCategoriesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::GuideCategory, decorator: Google::Apis::YoutubeV3::GuideCategory::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class GuideCategorySnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :title, as: 'title' end end class I18nLanguage # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::I18nLanguageSnippet, decorator: Google::Apis::YoutubeV3::I18nLanguageSnippet::Representation end end class ListI18nLanguagesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::I18nLanguage, decorator: Google::Apis::YoutubeV3::I18nLanguage::Representation property :kind, as: 'kind' property :visitor_id, as: 'visitorId' end end class I18nLanguageSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :hl, as: 'hl' property :name, as: 'name' end end class I18nRegion # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::I18nRegionSnippet, decorator: Google::Apis::YoutubeV3::I18nRegionSnippet::Representation end end class ListI18nRegionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::I18nRegion, decorator: Google::Apis::YoutubeV3::I18nRegion::Representation property :kind, as: 'kind' property :visitor_id, as: 'visitorId' end end class I18nRegionSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :gl, as: 'gl' property :name, as: 'name' end end class ImageSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :background_image_url, as: 'backgroundImageUrl', class: Google::Apis::YoutubeV3::LocalizedProperty, decorator: Google::Apis::YoutubeV3::LocalizedProperty::Representation property :banner_external_url, as: 'bannerExternalUrl' property :banner_image_url, as: 'bannerImageUrl' property :banner_mobile_extra_hd_image_url, as: 'bannerMobileExtraHdImageUrl' property :banner_mobile_hd_image_url, as: 'bannerMobileHdImageUrl' property :banner_mobile_image_url, as: 'bannerMobileImageUrl' property :banner_mobile_low_image_url, as: 'bannerMobileLowImageUrl' property :banner_mobile_medium_hd_image_url, as: 'bannerMobileMediumHdImageUrl' property :banner_tablet_extra_hd_image_url, as: 'bannerTabletExtraHdImageUrl' property :banner_tablet_hd_image_url, as: 'bannerTabletHdImageUrl' property :banner_tablet_image_url, as: 'bannerTabletImageUrl' property :banner_tablet_low_image_url, as: 'bannerTabletLowImageUrl' property :banner_tv_high_image_url, as: 'bannerTvHighImageUrl' property :banner_tv_image_url, as: 'bannerTvImageUrl' property :banner_tv_low_image_url, as: 'bannerTvLowImageUrl' property :banner_tv_medium_image_url, as: 'bannerTvMediumImageUrl' property :large_branded_banner_image_imap_script, as: 'largeBrandedBannerImageImapScript', class: Google::Apis::YoutubeV3::LocalizedProperty, decorator: Google::Apis::YoutubeV3::LocalizedProperty::Representation property :large_branded_banner_image_url, as: 'largeBrandedBannerImageUrl', class: Google::Apis::YoutubeV3::LocalizedProperty, decorator: Google::Apis::YoutubeV3::LocalizedProperty::Representation property :small_branded_banner_image_imap_script, as: 'smallBrandedBannerImageImapScript', class: Google::Apis::YoutubeV3::LocalizedProperty, decorator: Google::Apis::YoutubeV3::LocalizedProperty::Representation property :small_branded_banner_image_url, as: 'smallBrandedBannerImageUrl', class: Google::Apis::YoutubeV3::LocalizedProperty, decorator: Google::Apis::YoutubeV3::LocalizedProperty::Representation property :tracking_image_url, as: 'trackingImageUrl' property :watch_icon_image_url, as: 'watchIconImageUrl' end end class IngestionInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :backup_ingestion_address, as: 'backupIngestionAddress' property :ingestion_address, as: 'ingestionAddress' property :stream_name, as: 'streamName' end end class InvideoBranding # @private class Representation < Google::Apis::Core::JsonRepresentation property :image_bytes, :base64 => true, as: 'imageBytes' property :image_url, as: 'imageUrl' property :position, as: 'position', class: Google::Apis::YoutubeV3::InvideoPosition, decorator: Google::Apis::YoutubeV3::InvideoPosition::Representation property :target_channel_id, as: 'targetChannelId' property :timing, as: 'timing', class: Google::Apis::YoutubeV3::InvideoTiming, decorator: Google::Apis::YoutubeV3::InvideoTiming::Representation end end class InvideoPosition # @private class Representation < Google::Apis::Core::JsonRepresentation property :corner_position, as: 'cornerPosition' property :type, as: 'type' end end class InvideoPromotion # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_timing, as: 'defaultTiming', class: Google::Apis::YoutubeV3::InvideoTiming, decorator: Google::Apis::YoutubeV3::InvideoTiming::Representation collection :items, as: 'items', class: Google::Apis::YoutubeV3::PromotedItem, decorator: Google::Apis::YoutubeV3::PromotedItem::Representation property :position, as: 'position', class: Google::Apis::YoutubeV3::InvideoPosition, decorator: Google::Apis::YoutubeV3::InvideoPosition::Representation property :use_smart_timing, as: 'useSmartTiming' end end class InvideoTiming # @private class Representation < Google::Apis::Core::JsonRepresentation property :duration_ms, :numeric_string => true, as: 'durationMs' property :offset_ms, :numeric_string => true, as: 'offsetMs' property :type, as: 'type' end end class LanguageTag # @private class Representation < Google::Apis::Core::JsonRepresentation property :value, as: 'value' end end class LiveBroadcast # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeV3::LiveBroadcastContentDetails, decorator: Google::Apis::YoutubeV3::LiveBroadcastContentDetails::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::LiveBroadcastSnippet, decorator: Google::Apis::YoutubeV3::LiveBroadcastSnippet::Representation property :statistics, as: 'statistics', class: Google::Apis::YoutubeV3::LiveBroadcastStatistics, decorator: Google::Apis::YoutubeV3::LiveBroadcastStatistics::Representation property :status, as: 'status', class: Google::Apis::YoutubeV3::LiveBroadcastStatus, decorator: Google::Apis::YoutubeV3::LiveBroadcastStatus::Representation end end class LiveBroadcastContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :bound_stream_id, as: 'boundStreamId' property :bound_stream_last_update_time_ms, as: 'boundStreamLastUpdateTimeMs', type: DateTime property :closed_captions_type, as: 'closedCaptionsType' property :enable_auto_start, as: 'enableAutoStart' property :enable_closed_captions, as: 'enableClosedCaptions' property :enable_content_encryption, as: 'enableContentEncryption' property :enable_dvr, as: 'enableDvr' property :enable_embed, as: 'enableEmbed' property :enable_low_latency, as: 'enableLowLatency' property :latency_preference, as: 'latencyPreference' property :mesh, :base64 => true, as: 'mesh' property :monitor_stream, as: 'monitorStream', class: Google::Apis::YoutubeV3::MonitorStreamInfo, decorator: Google::Apis::YoutubeV3::MonitorStreamInfo::Representation property :projection, as: 'projection' property :record_from_start, as: 'recordFromStart' property :start_with_slate, as: 'startWithSlate' end end class ListLiveBroadcastsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::LiveBroadcast, decorator: Google::Apis::YoutubeV3::LiveBroadcast::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class LiveBroadcastSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :actual_end_time, as: 'actualEndTime', type: DateTime property :actual_start_time, as: 'actualStartTime', type: DateTime property :channel_id, as: 'channelId' property :description, as: 'description' property :is_default_broadcast, as: 'isDefaultBroadcast' property :live_chat_id, as: 'liveChatId' property :published_at, as: 'publishedAt', type: DateTime property :scheduled_end_time, as: 'scheduledEndTime', type: DateTime property :scheduled_start_time, as: 'scheduledStartTime', type: DateTime property :thumbnails, as: 'thumbnails', class: Google::Apis::YoutubeV3::ThumbnailDetails, decorator: Google::Apis::YoutubeV3::ThumbnailDetails::Representation property :title, as: 'title' end end class LiveBroadcastStatistics # @private class Representation < Google::Apis::Core::JsonRepresentation property :concurrent_viewers, :numeric_string => true, as: 'concurrentViewers' property :total_chat_count, :numeric_string => true, as: 'totalChatCount' end end class LiveBroadcastStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :life_cycle_status, as: 'lifeCycleStatus' property :live_broadcast_priority, as: 'liveBroadcastPriority' property :privacy_status, as: 'privacyStatus' property :recording_status, as: 'recordingStatus' end end class LiveChatBan # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::LiveChatBanSnippet, decorator: Google::Apis::YoutubeV3::LiveChatBanSnippet::Representation end end class LiveChatBanSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :ban_duration_seconds, :numeric_string => true, as: 'banDurationSeconds' property :banned_user_details, as: 'bannedUserDetails', class: Google::Apis::YoutubeV3::ChannelProfileDetails, decorator: Google::Apis::YoutubeV3::ChannelProfileDetails::Representation property :live_chat_id, as: 'liveChatId' property :type, as: 'type' end end class LiveChatFanFundingEventDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount_display_string, as: 'amountDisplayString' property :amount_micros, :numeric_string => true, as: 'amountMicros' property :currency, as: 'currency' property :user_comment, as: 'userComment' end end class LiveChatMessage # @private class Representation < Google::Apis::Core::JsonRepresentation property :author_details, as: 'authorDetails', class: Google::Apis::YoutubeV3::LiveChatMessageAuthorDetails, decorator: Google::Apis::YoutubeV3::LiveChatMessageAuthorDetails::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::LiveChatMessageSnippet, decorator: Google::Apis::YoutubeV3::LiveChatMessageSnippet::Representation end end class LiveChatMessageAuthorDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :channel_url, as: 'channelUrl' property :display_name, as: 'displayName' property :is_chat_moderator, as: 'isChatModerator' property :is_chat_owner, as: 'isChatOwner' property :is_chat_sponsor, as: 'isChatSponsor' property :is_verified, as: 'isVerified' property :profile_image_url, as: 'profileImageUrl' end end class LiveChatMessageDeletedDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :deleted_message_id, as: 'deletedMessageId' end end class LiveChatMessageListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::LiveChatMessage, decorator: Google::Apis::YoutubeV3::LiveChatMessage::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :offline_at, as: 'offlineAt', type: DateTime property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :polling_interval_millis, as: 'pollingIntervalMillis' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class LiveChatMessageRetractedDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :retracted_message_id, as: 'retractedMessageId' end end class LiveChatMessageSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :author_channel_id, as: 'authorChannelId' property :display_message, as: 'displayMessage' property :fan_funding_event_details, as: 'fanFundingEventDetails', class: Google::Apis::YoutubeV3::LiveChatFanFundingEventDetails, decorator: Google::Apis::YoutubeV3::LiveChatFanFundingEventDetails::Representation property :has_display_content, as: 'hasDisplayContent' property :live_chat_id, as: 'liveChatId' property :message_deleted_details, as: 'messageDeletedDetails', class: Google::Apis::YoutubeV3::LiveChatMessageDeletedDetails, decorator: Google::Apis::YoutubeV3::LiveChatMessageDeletedDetails::Representation property :message_retracted_details, as: 'messageRetractedDetails', class: Google::Apis::YoutubeV3::LiveChatMessageRetractedDetails, decorator: Google::Apis::YoutubeV3::LiveChatMessageRetractedDetails::Representation property :poll_closed_details, as: 'pollClosedDetails', class: Google::Apis::YoutubeV3::LiveChatPollClosedDetails, decorator: Google::Apis::YoutubeV3::LiveChatPollClosedDetails::Representation property :poll_edited_details, as: 'pollEditedDetails', class: Google::Apis::YoutubeV3::LiveChatPollEditedDetails, decorator: Google::Apis::YoutubeV3::LiveChatPollEditedDetails::Representation property :poll_opened_details, as: 'pollOpenedDetails', class: Google::Apis::YoutubeV3::LiveChatPollOpenedDetails, decorator: Google::Apis::YoutubeV3::LiveChatPollOpenedDetails::Representation property :poll_voted_details, as: 'pollVotedDetails', class: Google::Apis::YoutubeV3::LiveChatPollVotedDetails, decorator: Google::Apis::YoutubeV3::LiveChatPollVotedDetails::Representation property :published_at, as: 'publishedAt', type: DateTime property :super_chat_details, as: 'superChatDetails', class: Google::Apis::YoutubeV3::LiveChatSuperChatDetails, decorator: Google::Apis::YoutubeV3::LiveChatSuperChatDetails::Representation property :text_message_details, as: 'textMessageDetails', class: Google::Apis::YoutubeV3::LiveChatTextMessageDetails, decorator: Google::Apis::YoutubeV3::LiveChatTextMessageDetails::Representation property :type, as: 'type' property :user_banned_details, as: 'userBannedDetails', class: Google::Apis::YoutubeV3::LiveChatUserBannedMessageDetails, decorator: Google::Apis::YoutubeV3::LiveChatUserBannedMessageDetails::Representation end end class LiveChatModerator # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::LiveChatModeratorSnippet, decorator: Google::Apis::YoutubeV3::LiveChatModeratorSnippet::Representation end end class LiveChatModeratorListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::LiveChatModerator, decorator: Google::Apis::YoutubeV3::LiveChatModerator::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class LiveChatModeratorSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :live_chat_id, as: 'liveChatId' property :moderator_details, as: 'moderatorDetails', class: Google::Apis::YoutubeV3::ChannelProfileDetails, decorator: Google::Apis::YoutubeV3::ChannelProfileDetails::Representation end end class LiveChatPollClosedDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :poll_id, as: 'pollId' end end class LiveChatPollEditedDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::YoutubeV3::LiveChatPollItem, decorator: Google::Apis::YoutubeV3::LiveChatPollItem::Representation property :prompt, as: 'prompt' end end class LiveChatPollItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :item_id, as: 'itemId' end end class LiveChatPollOpenedDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' collection :items, as: 'items', class: Google::Apis::YoutubeV3::LiveChatPollItem, decorator: Google::Apis::YoutubeV3::LiveChatPollItem::Representation property :prompt, as: 'prompt' end end class LiveChatPollVotedDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :item_id, as: 'itemId' property :poll_id, as: 'pollId' end end class LiveChatSuperChatDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount_display_string, as: 'amountDisplayString' property :amount_micros, :numeric_string => true, as: 'amountMicros' property :currency, as: 'currency' property :tier, as: 'tier' property :user_comment, as: 'userComment' end end class LiveChatTextMessageDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :message_text, as: 'messageText' end end class LiveChatUserBannedMessageDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :ban_duration_seconds, :numeric_string => true, as: 'banDurationSeconds' property :ban_type, as: 'banType' property :banned_user_details, as: 'bannedUserDetails', class: Google::Apis::YoutubeV3::ChannelProfileDetails, decorator: Google::Apis::YoutubeV3::ChannelProfileDetails::Representation end end class LiveStream # @private class Representation < Google::Apis::Core::JsonRepresentation property :cdn, as: 'cdn', class: Google::Apis::YoutubeV3::CdnSettings, decorator: Google::Apis::YoutubeV3::CdnSettings::Representation property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeV3::LiveStreamContentDetails, decorator: Google::Apis::YoutubeV3::LiveStreamContentDetails::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::LiveStreamSnippet, decorator: Google::Apis::YoutubeV3::LiveStreamSnippet::Representation property :status, as: 'status', class: Google::Apis::YoutubeV3::LiveStreamStatus, decorator: Google::Apis::YoutubeV3::LiveStreamStatus::Representation end end class LiveStreamConfigurationIssue # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :reason, as: 'reason' property :severity, as: 'severity' property :type, as: 'type' end end class LiveStreamContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :closed_captions_ingestion_url, as: 'closedCaptionsIngestionUrl' property :is_reusable, as: 'isReusable' end end class LiveStreamHealthStatus # @private class Representation < Google::Apis::Core::JsonRepresentation collection :configuration_issues, as: 'configurationIssues', class: Google::Apis::YoutubeV3::LiveStreamConfigurationIssue, decorator: Google::Apis::YoutubeV3::LiveStreamConfigurationIssue::Representation property :last_update_time_seconds, :numeric_string => true, as: 'lastUpdateTimeSeconds' property :status, as: 'status' end end class ListLiveStreamsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::LiveStream, decorator: Google::Apis::YoutubeV3::LiveStream::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class LiveStreamSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :description, as: 'description' property :is_default_stream, as: 'isDefaultStream' property :published_at, as: 'publishedAt', type: DateTime property :title, as: 'title' end end class LiveStreamStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :health_status, as: 'healthStatus', class: Google::Apis::YoutubeV3::LiveStreamHealthStatus, decorator: Google::Apis::YoutubeV3::LiveStreamHealthStatus::Representation property :stream_status, as: 'streamStatus' end end class LocalizedProperty # @private class Representation < Google::Apis::Core::JsonRepresentation property :default, as: 'default' property :default_language, as: 'defaultLanguage', class: Google::Apis::YoutubeV3::LanguageTag, decorator: Google::Apis::YoutubeV3::LanguageTag::Representation collection :localized, as: 'localized', class: Google::Apis::YoutubeV3::LocalizedString, decorator: Google::Apis::YoutubeV3::LocalizedString::Representation end end class LocalizedString # @private class Representation < Google::Apis::Core::JsonRepresentation property :language, as: 'language' property :value, as: 'value' end end class MonitorStreamInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :broadcast_stream_delay_ms, as: 'broadcastStreamDelayMs' property :embed_html, as: 'embedHtml' property :enable_monitor_stream, as: 'enableMonitorStream' end end class Nonprofit # @private class Representation < Google::Apis::Core::JsonRepresentation property :nonprofit_id, as: 'nonprofitId', class: Google::Apis::YoutubeV3::NonprofitId, decorator: Google::Apis::YoutubeV3::NonprofitId::Representation property :nonprofit_legal_name, as: 'nonprofitLegalName' end end class NonprofitId # @private class Representation < Google::Apis::Core::JsonRepresentation property :value, as: 'value' end end class PageInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :results_per_page, as: 'resultsPerPage' property :total_results, as: 'totalResults' end end class Playlist # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeV3::PlaylistContentDetails, decorator: Google::Apis::YoutubeV3::PlaylistContentDetails::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' hash :localizations, as: 'localizations', class: Google::Apis::YoutubeV3::PlaylistLocalization, decorator: Google::Apis::YoutubeV3::PlaylistLocalization::Representation property :player, as: 'player', class: Google::Apis::YoutubeV3::PlaylistPlayer, decorator: Google::Apis::YoutubeV3::PlaylistPlayer::Representation property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::PlaylistSnippet, decorator: Google::Apis::YoutubeV3::PlaylistSnippet::Representation property :status, as: 'status', class: Google::Apis::YoutubeV3::PlaylistStatus, decorator: Google::Apis::YoutubeV3::PlaylistStatus::Representation end end class PlaylistContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :item_count, as: 'itemCount' end end class PlaylistItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeV3::PlaylistItemContentDetails, decorator: Google::Apis::YoutubeV3::PlaylistItemContentDetails::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::PlaylistItemSnippet, decorator: Google::Apis::YoutubeV3::PlaylistItemSnippet::Representation property :status, as: 'status', class: Google::Apis::YoutubeV3::PlaylistItemStatus, decorator: Google::Apis::YoutubeV3::PlaylistItemStatus::Representation end end class PlaylistItemContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :end_at, as: 'endAt' property :note, as: 'note' property :start_at, as: 'startAt' property :video_id, as: 'videoId' property :video_published_at, as: 'videoPublishedAt', type: DateTime end end class ListPlaylistItemsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::PlaylistItem, decorator: Google::Apis::YoutubeV3::PlaylistItem::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class PlaylistItemSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :channel_title, as: 'channelTitle' property :description, as: 'description' property :playlist_id, as: 'playlistId' property :position, as: 'position' property :published_at, as: 'publishedAt', type: DateTime property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation property :thumbnails, as: 'thumbnails', class: Google::Apis::YoutubeV3::ThumbnailDetails, decorator: Google::Apis::YoutubeV3::ThumbnailDetails::Representation property :title, as: 'title' end end class PlaylistItemStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :privacy_status, as: 'privacyStatus' end end class ListPlaylistResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::Playlist, decorator: Google::Apis::YoutubeV3::Playlist::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class PlaylistLocalization # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :title, as: 'title' end end class PlaylistPlayer # @private class Representation < Google::Apis::Core::JsonRepresentation property :embed_html, as: 'embedHtml' end end class PlaylistSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :channel_title, as: 'channelTitle' property :default_language, as: 'defaultLanguage' property :description, as: 'description' property :localized, as: 'localized', class: Google::Apis::YoutubeV3::PlaylistLocalization, decorator: Google::Apis::YoutubeV3::PlaylistLocalization::Representation property :published_at, as: 'publishedAt', type: DateTime collection :tags, as: 'tags' property :thumbnails, as: 'thumbnails', class: Google::Apis::YoutubeV3::ThumbnailDetails, decorator: Google::Apis::YoutubeV3::ThumbnailDetails::Representation property :title, as: 'title' end end class PlaylistStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :privacy_status, as: 'privacyStatus' end end class PromotedItem # @private class Representation < Google::Apis::Core::JsonRepresentation property :custom_message, as: 'customMessage' property :id, as: 'id', class: Google::Apis::YoutubeV3::PromotedItemId, decorator: Google::Apis::YoutubeV3::PromotedItemId::Representation property :promoted_by_content_owner, as: 'promotedByContentOwner' property :timing, as: 'timing', class: Google::Apis::YoutubeV3::InvideoTiming, decorator: Google::Apis::YoutubeV3::InvideoTiming::Representation end end class PromotedItemId # @private class Representation < Google::Apis::Core::JsonRepresentation property :recently_uploaded_by, as: 'recentlyUploadedBy' property :type, as: 'type' property :video_id, as: 'videoId' property :website_url, as: 'websiteUrl' end end class PropertyValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :property, as: 'property' property :value, as: 'value' end end class ResourceId # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :kind, as: 'kind' property :playlist_id, as: 'playlistId' property :video_id, as: 'videoId' end end class SearchListsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::SearchResult, decorator: Google::Apis::YoutubeV3::SearchResult::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :region_code, as: 'regionCode' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class SearchResult # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::SearchResultSnippet, decorator: Google::Apis::YoutubeV3::SearchResultSnippet::Representation end end class SearchResultSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :channel_title, as: 'channelTitle' property :description, as: 'description' property :live_broadcast_content, as: 'liveBroadcastContent' property :published_at, as: 'publishedAt', type: DateTime property :thumbnails, as: 'thumbnails', class: Google::Apis::YoutubeV3::ThumbnailDetails, decorator: Google::Apis::YoutubeV3::ThumbnailDetails::Representation property :title, as: 'title' end end class Sponsor # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::SponsorSnippet, decorator: Google::Apis::YoutubeV3::SponsorSnippet::Representation end end class SponsorListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::Sponsor, decorator: Google::Apis::YoutubeV3::Sponsor::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class SponsorSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :sponsor_details, as: 'sponsorDetails', class: Google::Apis::YoutubeV3::ChannelProfileDetails, decorator: Google::Apis::YoutubeV3::ChannelProfileDetails::Representation property :sponsor_since, as: 'sponsorSince', type: DateTime end end class Subscription # @private class Representation < Google::Apis::Core::JsonRepresentation property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeV3::SubscriptionContentDetails, decorator: Google::Apis::YoutubeV3::SubscriptionContentDetails::Representation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::SubscriptionSnippet, decorator: Google::Apis::YoutubeV3::SubscriptionSnippet::Representation property :subscriber_snippet, as: 'subscriberSnippet', class: Google::Apis::YoutubeV3::SubscriptionSubscriberSnippet, decorator: Google::Apis::YoutubeV3::SubscriptionSubscriberSnippet::Representation end end class SubscriptionContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :activity_type, as: 'activityType' property :new_item_count, as: 'newItemCount' property :total_item_count, as: 'totalItemCount' end end class ListSubscriptionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::Subscription, decorator: Google::Apis::YoutubeV3::Subscription::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class SubscriptionSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :channel_title, as: 'channelTitle' property :description, as: 'description' property :published_at, as: 'publishedAt', type: DateTime property :resource_id, as: 'resourceId', class: Google::Apis::YoutubeV3::ResourceId, decorator: Google::Apis::YoutubeV3::ResourceId::Representation property :thumbnails, as: 'thumbnails', class: Google::Apis::YoutubeV3::ThumbnailDetails, decorator: Google::Apis::YoutubeV3::ThumbnailDetails::Representation property :title, as: 'title' end end class SubscriptionSubscriberSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel_id, as: 'channelId' property :description, as: 'description' property :thumbnails, as: 'thumbnails', class: Google::Apis::YoutubeV3::ThumbnailDetails, decorator: Google::Apis::YoutubeV3::ThumbnailDetails::Representation property :title, as: 'title' end end class SuperChatEvent # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::SuperChatEventSnippet, decorator: Google::Apis::YoutubeV3::SuperChatEventSnippet::Representation end end class SuperChatEventListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::SuperChatEvent, decorator: Google::Apis::YoutubeV3::SuperChatEvent::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class SuperChatEventSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :amount_micros, :numeric_string => true, as: 'amountMicros' property :channel_id, as: 'channelId' property :comment_text, as: 'commentText' property :created_at, as: 'createdAt', type: DateTime property :currency, as: 'currency' property :display_string, as: 'displayString' property :is_super_chat_for_good, as: 'isSuperChatForGood' property :message_type, as: 'messageType' property :nonprofit, as: 'nonprofit', class: Google::Apis::YoutubeV3::Nonprofit, decorator: Google::Apis::YoutubeV3::Nonprofit::Representation property :supporter_details, as: 'supporterDetails', class: Google::Apis::YoutubeV3::ChannelProfileDetails, decorator: Google::Apis::YoutubeV3::ChannelProfileDetails::Representation end end class Thumbnail # @private class Representation < Google::Apis::Core::JsonRepresentation property :height, as: 'height' property :url, as: 'url' property :width, as: 'width' end end class ThumbnailDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :default, as: 'default', class: Google::Apis::YoutubeV3::Thumbnail, decorator: Google::Apis::YoutubeV3::Thumbnail::Representation property :high, as: 'high', class: Google::Apis::YoutubeV3::Thumbnail, decorator: Google::Apis::YoutubeV3::Thumbnail::Representation property :maxres, as: 'maxres', class: Google::Apis::YoutubeV3::Thumbnail, decorator: Google::Apis::YoutubeV3::Thumbnail::Representation property :medium, as: 'medium', class: Google::Apis::YoutubeV3::Thumbnail, decorator: Google::Apis::YoutubeV3::Thumbnail::Representation property :standard, as: 'standard', class: Google::Apis::YoutubeV3::Thumbnail, decorator: Google::Apis::YoutubeV3::Thumbnail::Representation end end class SetThumbnailResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::ThumbnailDetails, decorator: Google::Apis::YoutubeV3::ThumbnailDetails::Representation property :kind, as: 'kind' property :visitor_id, as: 'visitorId' end end class TokenPagination # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Video # @private class Representation < Google::Apis::Core::JsonRepresentation property :age_gating, as: 'ageGating', class: Google::Apis::YoutubeV3::VideoAgeGating, decorator: Google::Apis::YoutubeV3::VideoAgeGating::Representation property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeV3::VideoContentDetails, decorator: Google::Apis::YoutubeV3::VideoContentDetails::Representation property :etag, as: 'etag' property :file_details, as: 'fileDetails', class: Google::Apis::YoutubeV3::VideoFileDetails, decorator: Google::Apis::YoutubeV3::VideoFileDetails::Representation property :id, as: 'id' property :kind, as: 'kind' property :live_streaming_details, as: 'liveStreamingDetails', class: Google::Apis::YoutubeV3::VideoLiveStreamingDetails, decorator: Google::Apis::YoutubeV3::VideoLiveStreamingDetails::Representation hash :localizations, as: 'localizations', class: Google::Apis::YoutubeV3::VideoLocalization, decorator: Google::Apis::YoutubeV3::VideoLocalization::Representation property :monetization_details, as: 'monetizationDetails', class: Google::Apis::YoutubeV3::VideoMonetizationDetails, decorator: Google::Apis::YoutubeV3::VideoMonetizationDetails::Representation property :player, as: 'player', class: Google::Apis::YoutubeV3::VideoPlayer, decorator: Google::Apis::YoutubeV3::VideoPlayer::Representation property :processing_details, as: 'processingDetails', class: Google::Apis::YoutubeV3::VideoProcessingDetails, decorator: Google::Apis::YoutubeV3::VideoProcessingDetails::Representation property :project_details, as: 'projectDetails', class: Google::Apis::YoutubeV3::VideoProjectDetails, decorator: Google::Apis::YoutubeV3::VideoProjectDetails::Representation property :recording_details, as: 'recordingDetails', class: Google::Apis::YoutubeV3::VideoRecordingDetails, decorator: Google::Apis::YoutubeV3::VideoRecordingDetails::Representation property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::VideoSnippet, decorator: Google::Apis::YoutubeV3::VideoSnippet::Representation property :statistics, as: 'statistics', class: Google::Apis::YoutubeV3::VideoStatistics, decorator: Google::Apis::YoutubeV3::VideoStatistics::Representation property :status, as: 'status', class: Google::Apis::YoutubeV3::VideoStatus, decorator: Google::Apis::YoutubeV3::VideoStatus::Representation property :suggestions, as: 'suggestions', class: Google::Apis::YoutubeV3::VideoSuggestions, decorator: Google::Apis::YoutubeV3::VideoSuggestions::Representation property :topic_details, as: 'topicDetails', class: Google::Apis::YoutubeV3::VideoTopicDetails, decorator: Google::Apis::YoutubeV3::VideoTopicDetails::Representation end end class VideoAbuseReport # @private class Representation < Google::Apis::Core::JsonRepresentation property :comments, as: 'comments' property :language, as: 'language' property :reason_id, as: 'reasonId' property :secondary_reason_id, as: 'secondaryReasonId' property :video_id, as: 'videoId' end end class VideoAbuseReportReason # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::VideoAbuseReportReasonSnippet, decorator: Google::Apis::YoutubeV3::VideoAbuseReportReasonSnippet::Representation end end class ListVideoAbuseReportReasonResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::VideoAbuseReportReason, decorator: Google::Apis::YoutubeV3::VideoAbuseReportReason::Representation property :kind, as: 'kind' property :visitor_id, as: 'visitorId' end end class VideoAbuseReportReasonSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :label, as: 'label' collection :secondary_reasons, as: 'secondaryReasons', class: Google::Apis::YoutubeV3::VideoAbuseReportSecondaryReason, decorator: Google::Apis::YoutubeV3::VideoAbuseReportSecondaryReason::Representation end end class VideoAbuseReportSecondaryReason # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :label, as: 'label' end end class VideoAgeGating # @private class Representation < Google::Apis::Core::JsonRepresentation property :alcohol_content, as: 'alcoholContent' property :restricted, as: 'restricted' property :video_game_rating, as: 'videoGameRating' end end class VideoCategory # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::VideoCategorySnippet, decorator: Google::Apis::YoutubeV3::VideoCategorySnippet::Representation end end class ListVideoCategoryResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::VideoCategory, decorator: Google::Apis::YoutubeV3::VideoCategory::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class VideoCategorySnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :assignable, as: 'assignable' property :channel_id, as: 'channelId' property :title, as: 'title' end end class VideoContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :caption, as: 'caption' property :content_rating, as: 'contentRating', class: Google::Apis::YoutubeV3::ContentRating, decorator: Google::Apis::YoutubeV3::ContentRating::Representation property :country_restriction, as: 'countryRestriction', class: Google::Apis::YoutubeV3::AccessPolicy, decorator: Google::Apis::YoutubeV3::AccessPolicy::Representation property :definition, as: 'definition' property :dimension, as: 'dimension' property :duration, as: 'duration' property :has_custom_thumbnail, as: 'hasCustomThumbnail' property :licensed_content, as: 'licensedContent' property :projection, as: 'projection' property :region_restriction, as: 'regionRestriction', class: Google::Apis::YoutubeV3::VideoContentDetailsRegionRestriction, decorator: Google::Apis::YoutubeV3::VideoContentDetailsRegionRestriction::Representation end end class VideoContentDetailsRegionRestriction # @private class Representation < Google::Apis::Core::JsonRepresentation collection :allowed, as: 'allowed' collection :blocked, as: 'blocked' end end class VideoFileDetails # @private class Representation < Google::Apis::Core::JsonRepresentation collection :audio_streams, as: 'audioStreams', class: Google::Apis::YoutubeV3::VideoFileDetailsAudioStream, decorator: Google::Apis::YoutubeV3::VideoFileDetailsAudioStream::Representation property :bitrate_bps, :numeric_string => true, as: 'bitrateBps' property :container, as: 'container' property :creation_time, as: 'creationTime' property :duration_ms, :numeric_string => true, as: 'durationMs' property :file_name, as: 'fileName' property :file_size, :numeric_string => true, as: 'fileSize' property :file_type, as: 'fileType' collection :video_streams, as: 'videoStreams', class: Google::Apis::YoutubeV3::VideoFileDetailsVideoStream, decorator: Google::Apis::YoutubeV3::VideoFileDetailsVideoStream::Representation end end class VideoFileDetailsAudioStream # @private class Representation < Google::Apis::Core::JsonRepresentation property :bitrate_bps, :numeric_string => true, as: 'bitrateBps' property :channel_count, as: 'channelCount' property :codec, as: 'codec' property :vendor, as: 'vendor' end end class VideoFileDetailsVideoStream # @private class Representation < Google::Apis::Core::JsonRepresentation property :aspect_ratio, as: 'aspectRatio' property :bitrate_bps, :numeric_string => true, as: 'bitrateBps' property :codec, as: 'codec' property :frame_rate_fps, as: 'frameRateFps' property :height_pixels, as: 'heightPixels' property :rotation, as: 'rotation' property :vendor, as: 'vendor' property :width_pixels, as: 'widthPixels' end end class GetVideoRatingResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::VideoRating, decorator: Google::Apis::YoutubeV3::VideoRating::Representation property :kind, as: 'kind' property :visitor_id, as: 'visitorId' end end class ListVideosResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :etag, as: 'etag' property :event_id, as: 'eventId' collection :items, as: 'items', class: Google::Apis::YoutubeV3::Video, decorator: Google::Apis::YoutubeV3::Video::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :page_info, as: 'pageInfo', class: Google::Apis::YoutubeV3::PageInfo, decorator: Google::Apis::YoutubeV3::PageInfo::Representation property :prev_page_token, as: 'prevPageToken' property :token_pagination, as: 'tokenPagination', class: Google::Apis::YoutubeV3::TokenPagination, decorator: Google::Apis::YoutubeV3::TokenPagination::Representation property :visitor_id, as: 'visitorId' end end class VideoLiveStreamingDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :active_live_chat_id, as: 'activeLiveChatId' property :actual_end_time, as: 'actualEndTime', type: DateTime property :actual_start_time, as: 'actualStartTime', type: DateTime property :concurrent_viewers, :numeric_string => true, as: 'concurrentViewers' property :scheduled_end_time, as: 'scheduledEndTime', type: DateTime property :scheduled_start_time, as: 'scheduledStartTime', type: DateTime end end class VideoLocalization # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :title, as: 'title' end end class VideoMonetizationDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :access, as: 'access', class: Google::Apis::YoutubeV3::AccessPolicy, decorator: Google::Apis::YoutubeV3::AccessPolicy::Representation end end class VideoPlayer # @private class Representation < Google::Apis::Core::JsonRepresentation property :embed_height, :numeric_string => true, as: 'embedHeight' property :embed_html, as: 'embedHtml' property :embed_width, :numeric_string => true, as: 'embedWidth' end end class VideoProcessingDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :editor_suggestions_availability, as: 'editorSuggestionsAvailability' property :file_details_availability, as: 'fileDetailsAvailability' property :processing_failure_reason, as: 'processingFailureReason' property :processing_issues_availability, as: 'processingIssuesAvailability' property :processing_progress, as: 'processingProgress', class: Google::Apis::YoutubeV3::VideoProcessingDetailsProcessingProgress, decorator: Google::Apis::YoutubeV3::VideoProcessingDetailsProcessingProgress::Representation property :processing_status, as: 'processingStatus' property :tag_suggestions_availability, as: 'tagSuggestionsAvailability' property :thumbnails_availability, as: 'thumbnailsAvailability' end end class VideoProcessingDetailsProcessingProgress # @private class Representation < Google::Apis::Core::JsonRepresentation property :parts_processed, :numeric_string => true, as: 'partsProcessed' property :parts_total, :numeric_string => true, as: 'partsTotal' property :time_left_ms, :numeric_string => true, as: 'timeLeftMs' end end class VideoProjectDetails # @private class Representation < Google::Apis::Core::JsonRepresentation collection :tags, as: 'tags' end end class VideoRating # @private class Representation < Google::Apis::Core::JsonRepresentation property :rating, as: 'rating' property :video_id, as: 'videoId' end end class VideoRecordingDetails # @private class Representation < Google::Apis::Core::JsonRepresentation property :location, as: 'location', class: Google::Apis::YoutubeV3::GeoPoint, decorator: Google::Apis::YoutubeV3::GeoPoint::Representation property :location_description, as: 'locationDescription' property :recording_date, as: 'recordingDate', type: DateTime end end class VideoSnippet # @private class Representation < Google::Apis::Core::JsonRepresentation property :category_id, as: 'categoryId' property :channel_id, as: 'channelId' property :channel_title, as: 'channelTitle' property :default_audio_language, as: 'defaultAudioLanguage' property :default_language, as: 'defaultLanguage' property :description, as: 'description' property :live_broadcast_content, as: 'liveBroadcastContent' property :localized, as: 'localized', class: Google::Apis::YoutubeV3::VideoLocalization, decorator: Google::Apis::YoutubeV3::VideoLocalization::Representation property :published_at, as: 'publishedAt', type: DateTime collection :tags, as: 'tags' property :thumbnails, as: 'thumbnails', class: Google::Apis::YoutubeV3::ThumbnailDetails, decorator: Google::Apis::YoutubeV3::ThumbnailDetails::Representation property :title, as: 'title' end end class VideoStatistics # @private class Representation < Google::Apis::Core::JsonRepresentation property :comment_count, :numeric_string => true, as: 'commentCount' property :dislike_count, :numeric_string => true, as: 'dislikeCount' property :favorite_count, :numeric_string => true, as: 'favoriteCount' property :like_count, :numeric_string => true, as: 'likeCount' property :view_count, :numeric_string => true, as: 'viewCount' end end class VideoStatus # @private class Representation < Google::Apis::Core::JsonRepresentation property :embeddable, as: 'embeddable' property :failure_reason, as: 'failureReason' property :license, as: 'license' property :privacy_status, as: 'privacyStatus' property :public_stats_viewable, as: 'publicStatsViewable' property :publish_at, as: 'publishAt', type: DateTime property :rejection_reason, as: 'rejectionReason' property :upload_status, as: 'uploadStatus' end end class VideoSuggestions # @private class Representation < Google::Apis::Core::JsonRepresentation collection :editor_suggestions, as: 'editorSuggestions' collection :processing_errors, as: 'processingErrors' collection :processing_hints, as: 'processingHints' collection :processing_warnings, as: 'processingWarnings' collection :tag_suggestions, as: 'tagSuggestions', class: Google::Apis::YoutubeV3::VideoSuggestionsTagSuggestion, decorator: Google::Apis::YoutubeV3::VideoSuggestionsTagSuggestion::Representation end end class VideoSuggestionsTagSuggestion # @private class Representation < Google::Apis::Core::JsonRepresentation collection :category_restricts, as: 'categoryRestricts' property :tag, as: 'tag' end end class VideoTopicDetails # @private class Representation < Google::Apis::Core::JsonRepresentation collection :relevant_topic_ids, as: 'relevantTopicIds' collection :topic_categories, as: 'topicCategories' collection :topic_ids, as: 'topicIds' end end class WatchSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :background_color, as: 'backgroundColor' property :featured_playlist_id, as: 'featuredPlaylistId' property :text_color, as: 'textColor' end end end end end google-api-client-0.19.8/generated/google/apis/youtube_v3/classes.rb0000644000004100000410000124737613252673044025426 0ustar www-datawww-data# 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 YoutubeV3 # Rights management policy for YouTube resources. class AccessPolicy include Google::Apis::Core::Hashable # The value of allowed indicates whether the access to the policy is allowed or # denied by default. # Corresponds to the JSON property `allowed` # @return [Boolean] attr_accessor :allowed alias_method :allowed?, :allowed # A list of region codes that identify countries where the default policy do not # apply. # Corresponds to the JSON property `exception` # @return [Array] attr_accessor :exception def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allowed = args[:allowed] if args.key?(:allowed) @exception = args[:exception] if args.key?(:exception) end end # An activity resource contains information about an action that a particular # channel, or user, has taken on YouTube.The actions reported in activity feeds # include rating a video, sharing a video, marking a video as a favorite, # commenting on a video, uploading a video, and so forth. Each activity resource # identifies the type of action, the channel associated with the action, and the # resource(s) associated with the action, such as the video that was rated or # uploaded. class Activity include Google::Apis::Core::Hashable # Details about the content of an activity: the video that was shared, the # channel that was subscribed to, etc. # Corresponds to the JSON property `contentDetails` # @return [Google::Apis::YoutubeV3::ActivityContentDetails] attr_accessor :content_details # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the activity. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # activity". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Basic details about an activity, including title, description, thumbnails, # activity type and group. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::ActivitySnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_details = args[:content_details] if args.key?(:content_details) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end end # Details about the content of an activity: the video that was shared, the # channel that was subscribed to, etc. class ActivityContentDetails include Google::Apis::Core::Hashable # Details about a channel bulletin post. # Corresponds to the JSON property `bulletin` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsBulletin] attr_accessor :bulletin # Details about a resource which was added to a channel. # Corresponds to the JSON property `channelItem` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsChannelItem] attr_accessor :channel_item # Information about a resource that received a comment. # Corresponds to the JSON property `comment` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsComment] attr_accessor :comment # Information about a video that was marked as a favorite video. # Corresponds to the JSON property `favorite` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsFavorite] attr_accessor :favorite # Information about a resource that received a positive (like) rating. # Corresponds to the JSON property `like` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsLike] attr_accessor :like # Information about a new playlist item. # Corresponds to the JSON property `playlistItem` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsPlaylistItem] attr_accessor :playlist_item # Details about a resource which is being promoted. # Corresponds to the JSON property `promotedItem` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsPromotedItem] attr_accessor :promoted_item # Information that identifies the recommended resource. # Corresponds to the JSON property `recommendation` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsRecommendation] attr_accessor :recommendation # Details about a social network post. # Corresponds to the JSON property `social` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsSocial] attr_accessor :social # Information about a channel that a user subscribed to. # Corresponds to the JSON property `subscription` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsSubscription] attr_accessor :subscription # Information about the uploaded video. # Corresponds to the JSON property `upload` # @return [Google::Apis::YoutubeV3::ActivityContentDetailsUpload] attr_accessor :upload def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bulletin = args[:bulletin] if args.key?(:bulletin) @channel_item = args[:channel_item] if args.key?(:channel_item) @comment = args[:comment] if args.key?(:comment) @favorite = args[:favorite] if args.key?(:favorite) @like = args[:like] if args.key?(:like) @playlist_item = args[:playlist_item] if args.key?(:playlist_item) @promoted_item = args[:promoted_item] if args.key?(:promoted_item) @recommendation = args[:recommendation] if args.key?(:recommendation) @social = args[:social] if args.key?(:social) @subscription = args[:subscription] if args.key?(:subscription) @upload = args[:upload] if args.key?(:upload) end end # Details about a channel bulletin post. class ActivityContentDetailsBulletin include Google::Apis::Core::Hashable # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :resource_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource_id = args[:resource_id] if args.key?(:resource_id) end end # Details about a resource which was added to a channel. class ActivityContentDetailsChannelItem include Google::Apis::Core::Hashable # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :resource_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource_id = args[:resource_id] if args.key?(:resource_id) end end # Information about a resource that received a comment. class ActivityContentDetailsComment include Google::Apis::Core::Hashable # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :resource_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource_id = args[:resource_id] if args.key?(:resource_id) end end # Information about a video that was marked as a favorite video. class ActivityContentDetailsFavorite include Google::Apis::Core::Hashable # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :resource_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource_id = args[:resource_id] if args.key?(:resource_id) end end # Information about a resource that received a positive (like) rating. class ActivityContentDetailsLike include Google::Apis::Core::Hashable # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :resource_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource_id = args[:resource_id] if args.key?(:resource_id) end end # Information about a new playlist item. class ActivityContentDetailsPlaylistItem include Google::Apis::Core::Hashable # The value that YouTube uses to uniquely identify the playlist. # Corresponds to the JSON property `playlistId` # @return [String] attr_accessor :playlist_id # ID of the item within the playlist. # Corresponds to the JSON property `playlistItemId` # @return [String] attr_accessor :playlist_item_id # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :resource_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @playlist_id = args[:playlist_id] if args.key?(:playlist_id) @playlist_item_id = args[:playlist_item_id] if args.key?(:playlist_item_id) @resource_id = args[:resource_id] if args.key?(:resource_id) end end # Details about a resource which is being promoted. class ActivityContentDetailsPromotedItem include Google::Apis::Core::Hashable # The URL the client should fetch to request a promoted item. # Corresponds to the JSON property `adTag` # @return [String] attr_accessor :ad_tag # The URL the client should ping to indicate that the user clicked through on # this promoted item. # Corresponds to the JSON property `clickTrackingUrl` # @return [String] attr_accessor :click_tracking_url # The URL the client should ping to indicate that the user was shown this # promoted item. # Corresponds to the JSON property `creativeViewUrl` # @return [String] attr_accessor :creative_view_url # The type of call-to-action, a message to the user indicating action that can # be taken. # Corresponds to the JSON property `ctaType` # @return [String] attr_accessor :cta_type # The custom call-to-action button text. If specified, it will override the # default button text for the cta_type. # Corresponds to the JSON property `customCtaButtonText` # @return [String] attr_accessor :custom_cta_button_text # The text description to accompany the promoted item. # Corresponds to the JSON property `descriptionText` # @return [String] attr_accessor :description_text # The URL the client should direct the user to, if the user chooses to visit the # advertiser's website. # Corresponds to the JSON property `destinationUrl` # @return [String] attr_accessor :destination_url # The list of forecasting URLs. The client should ping all of these URLs when a # promoted item is not available, to indicate that a promoted item could have # been shown. # Corresponds to the JSON property `forecastingUrl` # @return [Array] attr_accessor :forecasting_url # The list of impression URLs. The client should ping all of these URLs to # indicate that the user was shown this promoted item. # Corresponds to the JSON property `impressionUrl` # @return [Array] attr_accessor :impression_url # The ID that YouTube uses to uniquely identify the promoted video. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ad_tag = args[:ad_tag] if args.key?(:ad_tag) @click_tracking_url = args[:click_tracking_url] if args.key?(:click_tracking_url) @creative_view_url = args[:creative_view_url] if args.key?(:creative_view_url) @cta_type = args[:cta_type] if args.key?(:cta_type) @custom_cta_button_text = args[:custom_cta_button_text] if args.key?(:custom_cta_button_text) @description_text = args[:description_text] if args.key?(:description_text) @destination_url = args[:destination_url] if args.key?(:destination_url) @forecasting_url = args[:forecasting_url] if args.key?(:forecasting_url) @impression_url = args[:impression_url] if args.key?(:impression_url) @video_id = args[:video_id] if args.key?(:video_id) end end # Information that identifies the recommended resource. class ActivityContentDetailsRecommendation include Google::Apis::Core::Hashable # The reason that the resource is recommended to the user. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :resource_id # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `seedResourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :seed_resource_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @reason = args[:reason] if args.key?(:reason) @resource_id = args[:resource_id] if args.key?(:resource_id) @seed_resource_id = args[:seed_resource_id] if args.key?(:seed_resource_id) end end # Details about a social network post. class ActivityContentDetailsSocial include Google::Apis::Core::Hashable # The author of the social network post. # Corresponds to the JSON property `author` # @return [String] attr_accessor :author # An image of the post's author. # Corresponds to the JSON property `imageUrl` # @return [String] attr_accessor :image_url # The URL of the social network post. # Corresponds to the JSON property `referenceUrl` # @return [String] attr_accessor :reference_url # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :resource_id # The name of the social network. # 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) @author = args[:author] if args.key?(:author) @image_url = args[:image_url] if args.key?(:image_url) @reference_url = args[:reference_url] if args.key?(:reference_url) @resource_id = args[:resource_id] if args.key?(:resource_id) @type = args[:type] if args.key?(:type) end end # Information about a channel that a user subscribed to. class ActivityContentDetailsSubscription include Google::Apis::Core::Hashable # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :resource_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource_id = args[:resource_id] if args.key?(:resource_id) end end # Information about the uploaded video. class ActivityContentDetailsUpload include Google::Apis::Core::Hashable # The ID that YouTube uses to uniquely identify the uploaded video. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @video_id = args[:video_id] if args.key?(:video_id) end end # class ListActivitiesResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of activities, or events, that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # activityListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # Basic details about an activity, including title, description, thumbnails, # activity type and group. class ActivitySnippet include Google::Apis::Core::Hashable # The ID that YouTube uses to uniquely identify the channel associated with the # activity. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # Channel title for the channel responsible for this activity # Corresponds to the JSON property `channelTitle` # @return [String] attr_accessor :channel_title # The description of the resource primarily associated with the activity. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The group ID associated with the activity. A group ID identifies user events # that are associated with the same user and resource. For example, if a user # rates a video and marks the same video as a favorite, the entries for those # events would have the same group ID in the user's activity feed. In your user # interface, you can avoid repetition by grouping events with the same groupId # value. # Corresponds to the JSON property `groupId` # @return [String] attr_accessor :group_id # The date and time that the video was uploaded. The value is specified in ISO # 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `publishedAt` # @return [DateTime] attr_accessor :published_at # Internal representation of thumbnails for a YouTube resource. # Corresponds to the JSON property `thumbnails` # @return [Google::Apis::YoutubeV3::ThumbnailDetails] attr_accessor :thumbnails # The title of the resource primarily associated with the activity. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The type of activity that the resource describes. # 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) @channel_id = args[:channel_id] if args.key?(:channel_id) @channel_title = args[:channel_title] if args.key?(:channel_title) @description = args[:description] if args.key?(:description) @group_id = args[:group_id] if args.key?(:group_id) @published_at = args[:published_at] if args.key?(:published_at) @thumbnails = args[:thumbnails] if args.key?(:thumbnails) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) end end # A caption resource represents a YouTube caption track. A caption track is # associated with exactly one YouTube video. class Caption include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the caption track. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # caption". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Basic details about a caption track, such as its language and name. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::CaptionSnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end end # class ListCaptionsResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of captions that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # captionListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_id) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # Basic details about a caption track, such as its language and name. class CaptionSnippet include Google::Apis::Core::Hashable # The type of audio track associated with the caption track. # Corresponds to the JSON property `audioTrackType` # @return [String] attr_accessor :audio_track_type # The reason that YouTube failed to process the caption track. This property is # only present if the state property's value is failed. # Corresponds to the JSON property `failureReason` # @return [String] attr_accessor :failure_reason # Indicates whether YouTube synchronized the caption track to the audio track in # the video. The value will be true if a sync was explicitly requested when the # caption track was uploaded. For example, when calling the captions.insert or # captions.update methods, you can set the sync parameter to true to instruct # YouTube to sync the uploaded track to the video. If the value is false, # YouTube uses the time codes in the uploaded caption track to determine when to # display captions. # Corresponds to the JSON property `isAutoSynced` # @return [Boolean] attr_accessor :is_auto_synced alias_method :is_auto_synced?, :is_auto_synced # Indicates whether the track contains closed captions for the deaf and hard of # hearing. The default value is false. # Corresponds to the JSON property `isCC` # @return [Boolean] attr_accessor :is_cc alias_method :is_cc?, :is_cc # Indicates whether the caption track is a draft. If the value is true, then the # track is not publicly visible. The default value is false. # Corresponds to the JSON property `isDraft` # @return [Boolean] attr_accessor :is_draft alias_method :is_draft?, :is_draft # Indicates whether caption track is formatted for "easy reader," meaning it is # at a third-grade level for language learners. The default value is false. # Corresponds to the JSON property `isEasyReader` # @return [Boolean] attr_accessor :is_easy_reader alias_method :is_easy_reader?, :is_easy_reader # Indicates whether the caption track uses large text for the vision-impaired. # The default value is false. # Corresponds to the JSON property `isLarge` # @return [Boolean] attr_accessor :is_large alias_method :is_large?, :is_large # The language of the caption track. The property value is a BCP-47 language tag. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # The date and time when the caption track was last updated. The value is # specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `lastUpdated` # @return [DateTime] attr_accessor :last_updated # The name of the caption track. The name is intended to be visible to the user # as an option during playback. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The caption track's status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The caption track's type. # Corresponds to the JSON property `trackKind` # @return [String] attr_accessor :track_kind # The ID that YouTube uses to uniquely identify the video associated with the # caption track. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @audio_track_type = args[:audio_track_type] if args.key?(:audio_track_type) @failure_reason = args[:failure_reason] if args.key?(:failure_reason) @is_auto_synced = args[:is_auto_synced] if args.key?(:is_auto_synced) @is_cc = args[:is_cc] if args.key?(:is_cc) @is_draft = args[:is_draft] if args.key?(:is_draft) @is_easy_reader = args[:is_easy_reader] if args.key?(:is_easy_reader) @is_large = args[:is_large] if args.key?(:is_large) @language = args[:language] if args.key?(:language) @last_updated = args[:last_updated] if args.key?(:last_updated) @name = args[:name] if args.key?(:name) @status = args[:status] if args.key?(:status) @track_kind = args[:track_kind] if args.key?(:track_kind) @video_id = args[:video_id] if args.key?(:video_id) end end # Brief description of the live stream cdn settings. class CdnSettings include Google::Apis::Core::Hashable # The format of the video stream that you are sending to Youtube. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format # The frame rate of the inbound video data. # Corresponds to the JSON property `frameRate` # @return [String] attr_accessor :frame_rate # Describes information necessary for ingesting an RTMP or an HTTP stream. # Corresponds to the JSON property `ingestionInfo` # @return [Google::Apis::YoutubeV3::IngestionInfo] attr_accessor :ingestion_info # The method or protocol used to transmit the video stream. # Corresponds to the JSON property `ingestionType` # @return [String] attr_accessor :ingestion_type # The resolution of the inbound video data. # Corresponds to the JSON property `resolution` # @return [String] attr_accessor :resolution def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @format = args[:format] if args.key?(:format) @frame_rate = args[:frame_rate] if args.key?(:frame_rate) @ingestion_info = args[:ingestion_info] if args.key?(:ingestion_info) @ingestion_type = args[:ingestion_type] if args.key?(:ingestion_type) @resolution = args[:resolution] if args.key?(:resolution) end end # A channel resource contains information about a YouTube channel. class Channel include Google::Apis::Core::Hashable # The auditDetails object encapsulates channel data that is relevant for YouTube # Partners during the audit process. # Corresponds to the JSON property `auditDetails` # @return [Google::Apis::YoutubeV3::ChannelAuditDetails] attr_accessor :audit_details # Branding properties of a YouTube channel. # Corresponds to the JSON property `brandingSettings` # @return [Google::Apis::YoutubeV3::ChannelBrandingSettings] attr_accessor :branding_settings # Details about the content of a channel. # Corresponds to the JSON property `contentDetails` # @return [Google::Apis::YoutubeV3::ChannelContentDetails] attr_accessor :content_details # The contentOwnerDetails object encapsulates channel data that is relevant for # YouTube Partners linked with the channel. # Corresponds to the JSON property `contentOwnerDetails` # @return [Google::Apis::YoutubeV3::ChannelContentOwnerDetails] attr_accessor :content_owner_details # The conversionPings object encapsulates information about conversion pings # that need to be respected by the channel. # Corresponds to the JSON property `conversionPings` # @return [Google::Apis::YoutubeV3::ChannelConversionPings] attr_accessor :conversion_pings # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the channel. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Describes an invideo promotion campaign consisting of multiple promoted items. # A campaign belongs to a single channel_id. # Corresponds to the JSON property `invideoPromotion` # @return [Google::Apis::YoutubeV3::InvideoPromotion] attr_accessor :invideo_promotion # Identifies what kind of resource this is. Value: the fixed string "youtube# # channel". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Localizations for different languages # Corresponds to the JSON property `localizations` # @return [Hash] attr_accessor :localizations # Basic details about a channel, including title, description and thumbnails. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::ChannelSnippet] attr_accessor :snippet # Statistics about a channel: number of subscribers, number of videos in the # channel, etc. # Corresponds to the JSON property `statistics` # @return [Google::Apis::YoutubeV3::ChannelStatistics] attr_accessor :statistics # JSON template for the status part of a channel. # Corresponds to the JSON property `status` # @return [Google::Apis::YoutubeV3::ChannelStatus] attr_accessor :status # Freebase topic information related to the channel. # Corresponds to the JSON property `topicDetails` # @return [Google::Apis::YoutubeV3::ChannelTopicDetails] attr_accessor :topic_details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @audit_details = args[:audit_details] if args.key?(:audit_details) @branding_settings = args[:branding_settings] if args.key?(:branding_settings) @content_details = args[:content_details] if args.key?(:content_details) @content_owner_details = args[:content_owner_details] if args.key?(:content_owner_details) @conversion_pings = args[:conversion_pings] if args.key?(:conversion_pings) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @invideo_promotion = args[:invideo_promotion] if args.key?(:invideo_promotion) @kind = args[:kind] if args.key?(:kind) @localizations = args[:localizations] if args.key?(:localizations) @snippet = args[:snippet] if args.key?(:snippet) @statistics = args[:statistics] if args.key?(:statistics) @status = args[:status] if args.key?(:status) @topic_details = args[:topic_details] if args.key?(:topic_details) end end # The auditDetails object encapsulates channel data that is relevant for YouTube # Partners during the audit process. class ChannelAuditDetails include Google::Apis::Core::Hashable # Whether or not the channel respects the community guidelines. # Corresponds to the JSON property `communityGuidelinesGoodStanding` # @return [Boolean] attr_accessor :community_guidelines_good_standing alias_method :community_guidelines_good_standing?, :community_guidelines_good_standing # Whether or not the channel has any unresolved claims. # Corresponds to the JSON property `contentIdClaimsGoodStanding` # @return [Boolean] attr_accessor :content_id_claims_good_standing alias_method :content_id_claims_good_standing?, :content_id_claims_good_standing # Whether or not the channel has any copyright strikes. # Corresponds to the JSON property `copyrightStrikesGoodStanding` # @return [Boolean] attr_accessor :copyright_strikes_good_standing alias_method :copyright_strikes_good_standing?, :copyright_strikes_good_standing # Describes the general state of the channel. This field will always show if # there are any issues whatsoever with the channel. Currently this field # represents the result of the logical and operation over the community # guidelines good standing, the copyright strikes good standing and the content # ID claims good standing, but this may change in the future. # Corresponds to the JSON property `overallGoodStanding` # @return [Boolean] attr_accessor :overall_good_standing alias_method :overall_good_standing?, :overall_good_standing def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @community_guidelines_good_standing = args[:community_guidelines_good_standing] if args.key?(:community_guidelines_good_standing) @content_id_claims_good_standing = args[:content_id_claims_good_standing] if args.key?(:content_id_claims_good_standing) @copyright_strikes_good_standing = args[:copyright_strikes_good_standing] if args.key?(:copyright_strikes_good_standing) @overall_good_standing = args[:overall_good_standing] if args.key?(:overall_good_standing) end end # A channel banner returned as the response to a channel_banner.insert call. class ChannelBannerResource include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Identifies what kind of resource this is. Value: the fixed string "youtube# # channelBannerResource". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The URL of this banner 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) @etag = args[:etag] if args.key?(:etag) @kind = args[:kind] if args.key?(:kind) @url = args[:url] if args.key?(:url) end end # Branding properties of a YouTube channel. class ChannelBrandingSettings include Google::Apis::Core::Hashable # Branding properties for the channel view. # Corresponds to the JSON property `channel` # @return [Google::Apis::YoutubeV3::ChannelSettings] attr_accessor :channel # Additional experimental branding properties. # Corresponds to the JSON property `hints` # @return [Array] attr_accessor :hints # Branding properties for images associated with the channel. # Corresponds to the JSON property `image` # @return [Google::Apis::YoutubeV3::ImageSettings] attr_accessor :image # Branding properties for the watch. All deprecated. # Corresponds to the JSON property `watch` # @return [Google::Apis::YoutubeV3::WatchSettings] attr_accessor :watch def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel = args[:channel] if args.key?(:channel) @hints = args[:hints] if args.key?(:hints) @image = args[:image] if args.key?(:image) @watch = args[:watch] if args.key?(:watch) end end # Details about the content of a channel. class ChannelContentDetails include Google::Apis::Core::Hashable # # Corresponds to the JSON property `relatedPlaylists` # @return [Google::Apis::YoutubeV3::ChannelContentDetails::RelatedPlaylists] attr_accessor :related_playlists def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @related_playlists = args[:related_playlists] if args.key?(:related_playlists) end # class RelatedPlaylists include Google::Apis::Core::Hashable # The ID of the playlist that contains the channel"s favorite videos. Use the # playlistItems.insert and playlistItems.delete to add or remove items from # that list. # Corresponds to the JSON property `favorites` # @return [String] attr_accessor :favorites # The ID of the playlist that contains the channel"s liked videos. Use the # playlistItems.insert and playlistItems.delete to add or remove items from # that list. # Corresponds to the JSON property `likes` # @return [String] attr_accessor :likes # The ID of the playlist that contains the channel"s uploaded videos. Use the # videos.insert method to upload new videos and the videos.delete method to # delete previously uploaded videos. # Corresponds to the JSON property `uploads` # @return [String] attr_accessor :uploads # The ID of the playlist that contains the channel"s watch history. Use the # playlistItems.insert and playlistItems.delete to add or remove items from # that list. # Corresponds to the JSON property `watchHistory` # @return [String] attr_accessor :watch_history # The ID of the playlist that contains the channel"s watch later playlist. Use # the playlistItems.insert and playlistItems.delete to add or remove items from # that list. # Corresponds to the JSON property `watchLater` # @return [String] attr_accessor :watch_later def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @favorites = args[:favorites] if args.key?(:favorites) @likes = args[:likes] if args.key?(:likes) @uploads = args[:uploads] if args.key?(:uploads) @watch_history = args[:watch_history] if args.key?(:watch_history) @watch_later = args[:watch_later] if args.key?(:watch_later) end end end # The contentOwnerDetails object encapsulates channel data that is relevant for # YouTube Partners linked with the channel. class ChannelContentOwnerDetails include Google::Apis::Core::Hashable # The ID of the content owner linked to the channel. # Corresponds to the JSON property `contentOwner` # @return [String] attr_accessor :content_owner # The date and time of when the channel was linked to the content owner. The # value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `timeLinked` # @return [DateTime] attr_accessor :time_linked def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_owner = args[:content_owner] if args.key?(:content_owner) @time_linked = args[:time_linked] if args.key?(:time_linked) end end # Pings that the app shall fire (authenticated by biscotti cookie). Each ping # has a context, in which the app must fire the ping, and a url identifying the # ping. class ChannelConversionPing include Google::Apis::Core::Hashable # Defines the context of the ping. # Corresponds to the JSON property `context` # @return [String] attr_accessor :context # The url (without the schema) that the player shall send the ping to. It's at # caller's descretion to decide which schema to use (http vs https) Example of a # returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/ # 962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid% # 3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti # authentication (ms param in case of mobile, for example) to this ping. # Corresponds to the JSON property `conversionUrl` # @return [String] attr_accessor :conversion_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @context = args[:context] if args.key?(:context) @conversion_url = args[:conversion_url] if args.key?(:conversion_url) end end # The conversionPings object encapsulates information about conversion pings # that need to be respected by the channel. class ChannelConversionPings include Google::Apis::Core::Hashable # Pings that the app shall fire (authenticated by biscotti cookie). Each ping # has a context, in which the app must fire the ping, and a url identifying the # ping. # Corresponds to the JSON property `pings` # @return [Array] attr_accessor :pings def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @pings = args[:pings] if args.key?(:pings) end end # class ListChannelsResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of channels that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # channelListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # Channel localization setting class ChannelLocalization include Google::Apis::Core::Hashable # The localized strings for channel's description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The localized strings for channel's title. # 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 ChannelProfileDetails include Google::Apis::Core::Hashable # The YouTube channel ID. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # The channel's URL. # Corresponds to the JSON property `channelUrl` # @return [String] attr_accessor :channel_url # The channel's display name. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The channels's avatar URL. # Corresponds to the JSON property `profileImageUrl` # @return [String] attr_accessor :profile_image_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel_id = args[:channel_id] if args.key?(:channel_id) @channel_url = args[:channel_url] if args.key?(:channel_url) @display_name = args[:display_name] if args.key?(:display_name) @profile_image_url = args[:profile_image_url] if args.key?(:profile_image_url) end end # class ChannelSection include Google::Apis::Core::Hashable # Details about a channelsection, including playlists and channels. # Corresponds to the JSON property `contentDetails` # @return [Google::Apis::YoutubeV3::ChannelSectionContentDetails] attr_accessor :content_details # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the channel section. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # channelSection". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Localizations for different languages # Corresponds to the JSON property `localizations` # @return [Hash] attr_accessor :localizations # Basic details about a channel section, including title, style and position. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::ChannelSectionSnippet] attr_accessor :snippet # ChannelSection targeting setting. # Corresponds to the JSON property `targeting` # @return [Google::Apis::YoutubeV3::ChannelSectionTargeting] attr_accessor :targeting def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_details = args[:content_details] if args.key?(:content_details) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @localizations = args[:localizations] if args.key?(:localizations) @snippet = args[:snippet] if args.key?(:snippet) @targeting = args[:targeting] if args.key?(:targeting) end end # Details about a channelsection, including playlists and channels. class ChannelSectionContentDetails include Google::Apis::Core::Hashable # The channel ids for type multiple_channels. # Corresponds to the JSON property `channels` # @return [Array] attr_accessor :channels # The playlist ids for type single_playlist and multiple_playlists. For # singlePlaylist, only one playlistId is allowed. # Corresponds to the JSON property `playlists` # @return [Array] attr_accessor :playlists def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channels = args[:channels] if args.key?(:channels) @playlists = args[:playlists] if args.key?(:playlists) end end # class ListChannelSectionsResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of ChannelSections that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # channelSectionListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_id) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # ChannelSection localization setting class ChannelSectionLocalization include Google::Apis::Core::Hashable # The localized strings for channel section's title. # 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) @title = args[:title] if args.key?(:title) end end # Basic details about a channel section, including title, style and position. class ChannelSectionSnippet include Google::Apis::Core::Hashable # The ID that YouTube uses to uniquely identify the channel that published the # channel section. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # The language of the channel section's default title and description. # Corresponds to the JSON property `defaultLanguage` # @return [String] attr_accessor :default_language # ChannelSection localization setting # Corresponds to the JSON property `localized` # @return [Google::Apis::YoutubeV3::ChannelSectionLocalization] attr_accessor :localized # The position of the channel section in the channel. # Corresponds to the JSON property `position` # @return [Fixnum] attr_accessor :position # The style of the channel section. # Corresponds to the JSON property `style` # @return [String] attr_accessor :style # The channel section's title for multiple_playlists and multiple_channels. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The type of the channel section. # 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) @channel_id = args[:channel_id] if args.key?(:channel_id) @default_language = args[:default_language] if args.key?(:default_language) @localized = args[:localized] if args.key?(:localized) @position = args[:position] if args.key?(:position) @style = args[:style] if args.key?(:style) @title = args[:title] if args.key?(:title) @type = args[:type] if args.key?(:type) end end # ChannelSection targeting setting. class ChannelSectionTargeting include Google::Apis::Core::Hashable # The country the channel section is targeting. # Corresponds to the JSON property `countries` # @return [Array] attr_accessor :countries # The language the channel section is targeting. # Corresponds to the JSON property `languages` # @return [Array] attr_accessor :languages # The region the channel section is targeting. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @countries = args[:countries] if args.key?(:countries) @languages = args[:languages] if args.key?(:languages) @regions = args[:regions] if args.key?(:regions) end end # Branding properties for the channel view. class ChannelSettings include Google::Apis::Core::Hashable # The country of the channel. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # # Corresponds to the JSON property `defaultLanguage` # @return [String] attr_accessor :default_language # Which content tab users should see when viewing the channel. # Corresponds to the JSON property `defaultTab` # @return [String] attr_accessor :default_tab # Specifies the channel description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Title for the featured channels tab. # Corresponds to the JSON property `featuredChannelsTitle` # @return [String] attr_accessor :featured_channels_title # The list of featured channels. # Corresponds to the JSON property `featuredChannelsUrls` # @return [Array] attr_accessor :featured_channels_urls # Lists keywords associated with the channel, comma-separated. # Corresponds to the JSON property `keywords` # @return [String] attr_accessor :keywords # Whether user-submitted comments left on the channel page need to be approved # by the channel owner to be publicly visible. # Corresponds to the JSON property `moderateComments` # @return [Boolean] attr_accessor :moderate_comments alias_method :moderate_comments?, :moderate_comments # A prominent color that can be rendered on this channel page. # Corresponds to the JSON property `profileColor` # @return [String] attr_accessor :profile_color # Whether the tab to browse the videos should be displayed. # Corresponds to the JSON property `showBrowseView` # @return [Boolean] attr_accessor :show_browse_view alias_method :show_browse_view?, :show_browse_view # Whether related channels should be proposed. # Corresponds to the JSON property `showRelatedChannels` # @return [Boolean] attr_accessor :show_related_channels alias_method :show_related_channels?, :show_related_channels # Specifies the channel title. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # The ID for a Google Analytics account to track and measure traffic to the # channels. # Corresponds to the JSON property `trackingAnalyticsAccountId` # @return [String] attr_accessor :tracking_analytics_account_id # The trailer of the channel, for users that are not subscribers. # Corresponds to the JSON property `unsubscribedTrailer` # @return [String] attr_accessor :unsubscribed_trailer def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @country = args[:country] if args.key?(:country) @default_language = args[:default_language] if args.key?(:default_language) @default_tab = args[:default_tab] if args.key?(:default_tab) @description = args[:description] if args.key?(:description) @featured_channels_title = args[:featured_channels_title] if args.key?(:featured_channels_title) @featured_channels_urls = args[:featured_channels_urls] if args.key?(:featured_channels_urls) @keywords = args[:keywords] if args.key?(:keywords) @moderate_comments = args[:moderate_comments] if args.key?(:moderate_comments) @profile_color = args[:profile_color] if args.key?(:profile_color) @show_browse_view = args[:show_browse_view] if args.key?(:show_browse_view) @show_related_channels = args[:show_related_channels] if args.key?(:show_related_channels) @title = args[:title] if args.key?(:title) @tracking_analytics_account_id = args[:tracking_analytics_account_id] if args.key?(:tracking_analytics_account_id) @unsubscribed_trailer = args[:unsubscribed_trailer] if args.key?(:unsubscribed_trailer) end end # Basic details about a channel, including title, description and thumbnails. class ChannelSnippet include Google::Apis::Core::Hashable # The country of the channel. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # The custom url of the channel. # Corresponds to the JSON property `customUrl` # @return [String] attr_accessor :custom_url # The language of the channel's default title and description. # Corresponds to the JSON property `defaultLanguage` # @return [String] attr_accessor :default_language # The description of the channel. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Channel localization setting # Corresponds to the JSON property `localized` # @return [Google::Apis::YoutubeV3::ChannelLocalization] attr_accessor :localized # The date and time that the channel was created. The value is specified in ISO # 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `publishedAt` # @return [DateTime] attr_accessor :published_at # Internal representation of thumbnails for a YouTube resource. # Corresponds to the JSON property `thumbnails` # @return [Google::Apis::YoutubeV3::ThumbnailDetails] attr_accessor :thumbnails # The channel's title. # 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) @country = args[:country] if args.key?(:country) @custom_url = args[:custom_url] if args.key?(:custom_url) @default_language = args[:default_language] if args.key?(:default_language) @description = args[:description] if args.key?(:description) @localized = args[:localized] if args.key?(:localized) @published_at = args[:published_at] if args.key?(:published_at) @thumbnails = args[:thumbnails] if args.key?(:thumbnails) @title = args[:title] if args.key?(:title) end end # Statistics about a channel: number of subscribers, number of videos in the # channel, etc. class ChannelStatistics include Google::Apis::Core::Hashable # The number of comments for the channel. # Corresponds to the JSON property `commentCount` # @return [Fixnum] attr_accessor :comment_count # Whether or not the number of subscribers is shown for this user. # Corresponds to the JSON property `hiddenSubscriberCount` # @return [Boolean] attr_accessor :hidden_subscriber_count alias_method :hidden_subscriber_count?, :hidden_subscriber_count # The number of subscribers that the channel has. # Corresponds to the JSON property `subscriberCount` # @return [Fixnum] attr_accessor :subscriber_count # The number of videos uploaded to the channel. # Corresponds to the JSON property `videoCount` # @return [Fixnum] attr_accessor :video_count # The number of times the channel has been viewed. # Corresponds to the JSON property `viewCount` # @return [Fixnum] attr_accessor :view_count def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @comment_count = args[:comment_count] if args.key?(:comment_count) @hidden_subscriber_count = args[:hidden_subscriber_count] if args.key?(:hidden_subscriber_count) @subscriber_count = args[:subscriber_count] if args.key?(:subscriber_count) @video_count = args[:video_count] if args.key?(:video_count) @view_count = args[:view_count] if args.key?(:view_count) end end # JSON template for the status part of a channel. class ChannelStatus include Google::Apis::Core::Hashable # If true, then the user is linked to either a YouTube username or G+ account. # Otherwise, the user doesn't have a public YouTube identity. # Corresponds to the JSON property `isLinked` # @return [Boolean] attr_accessor :is_linked alias_method :is_linked?, :is_linked # The long uploads status of this channel. See # Corresponds to the JSON property `longUploadsStatus` # @return [String] attr_accessor :long_uploads_status # Privacy status of the channel. # Corresponds to the JSON property `privacyStatus` # @return [String] attr_accessor :privacy_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @is_linked = args[:is_linked] if args.key?(:is_linked) @long_uploads_status = args[:long_uploads_status] if args.key?(:long_uploads_status) @privacy_status = args[:privacy_status] if args.key?(:privacy_status) end end # Freebase topic information related to the channel. class ChannelTopicDetails include Google::Apis::Core::Hashable # A list of Wikipedia URLs that describe the channel's content. # Corresponds to the JSON property `topicCategories` # @return [Array] attr_accessor :topic_categories # A list of Freebase topic IDs associated with the channel. You can retrieve # information about each topic using the Freebase Topic API. # Corresponds to the JSON property `topicIds` # @return [Array] attr_accessor :topic_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @topic_categories = args[:topic_categories] if args.key?(:topic_categories) @topic_ids = args[:topic_ids] if args.key?(:topic_ids) end end # A comment represents a single YouTube comment. class Comment include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the comment. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # comment". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Basic details about a comment, such as its author and text. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::CommentSnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end end # class ListCommentsResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of comments that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # commentListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # Basic details about a comment, such as its author and text. class CommentSnippet include Google::Apis::Core::Hashable # The id of the author's YouTube channel, if any. # Corresponds to the JSON property `authorChannelId` # @return [Object] attr_accessor :author_channel_id # Link to the author's YouTube channel, if any. # Corresponds to the JSON property `authorChannelUrl` # @return [String] attr_accessor :author_channel_url # The name of the user who posted the comment. # Corresponds to the JSON property `authorDisplayName` # @return [String] attr_accessor :author_display_name # The URL for the avatar of the user who posted the comment. # Corresponds to the JSON property `authorProfileImageUrl` # @return [String] attr_accessor :author_profile_image_url # Whether the current viewer can rate this comment. # Corresponds to the JSON property `canRate` # @return [Boolean] attr_accessor :can_rate alias_method :can_rate?, :can_rate # The id of the corresponding YouTube channel. In case of a channel comment this # is the channel the comment refers to. In case of a video comment it's the # video's channel. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # The total number of likes this comment has received. # Corresponds to the JSON property `likeCount` # @return [Fixnum] attr_accessor :like_count # The comment's moderation status. Will not be set if the comments were # requested through the id filter. # Corresponds to the JSON property `moderationStatus` # @return [String] attr_accessor :moderation_status # The unique id of the parent comment, only set for replies. # Corresponds to the JSON property `parentId` # @return [String] attr_accessor :parent_id # The date and time when the comment was orignally published. The value is # specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `publishedAt` # @return [DateTime] attr_accessor :published_at # The comment's text. The format is either plain text or HTML dependent on what # has been requested. Even the plain text representation may differ from the # text originally posted in that it may replace video links with video titles # etc. # Corresponds to the JSON property `textDisplay` # @return [String] attr_accessor :text_display # The comment's original raw text as initially posted or last updated. The # original text will only be returned if it is accessible to the viewer, which # is only guaranteed if the viewer is the comment's author. # Corresponds to the JSON property `textOriginal` # @return [String] attr_accessor :text_original # The date and time when was last updated . The value is specified in ISO 8601 ( # YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `updatedAt` # @return [DateTime] attr_accessor :updated_at # The ID of the video the comment refers to, if any. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id # The rating the viewer has given to this comment. For the time being this will # never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may # change in the future. # Corresponds to the JSON property `viewerRating` # @return [String] attr_accessor :viewer_rating def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @author_channel_id = args[:author_channel_id] if args.key?(:author_channel_id) @author_channel_url = args[:author_channel_url] if args.key?(:author_channel_url) @author_display_name = args[:author_display_name] if args.key?(:author_display_name) @author_profile_image_url = args[:author_profile_image_url] if args.key?(:author_profile_image_url) @can_rate = args[:can_rate] if args.key?(:can_rate) @channel_id = args[:channel_id] if args.key?(:channel_id) @like_count = args[:like_count] if args.key?(:like_count) @moderation_status = args[:moderation_status] if args.key?(:moderation_status) @parent_id = args[:parent_id] if args.key?(:parent_id) @published_at = args[:published_at] if args.key?(:published_at) @text_display = args[:text_display] if args.key?(:text_display) @text_original = args[:text_original] if args.key?(:text_original) @updated_at = args[:updated_at] if args.key?(:updated_at) @video_id = args[:video_id] if args.key?(:video_id) @viewer_rating = args[:viewer_rating] if args.key?(:viewer_rating) end end # A comment thread represents information that applies to a top level comment # and all its replies. It can also include the top level comment itself and some # of the replies. class CommentThread include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the comment thread. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # commentThread". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Comments written in (direct or indirect) reply to the top level comment. # Corresponds to the JSON property `replies` # @return [Google::Apis::YoutubeV3::CommentThreadReplies] attr_accessor :replies # Basic details about a comment thread. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::CommentThreadSnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @replies = args[:replies] if args.key?(:replies) @snippet = args[:snippet] if args.key?(:snippet) end end # class ListCommentThreadsResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of comment threads that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # commentThreadListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # Comments written in (direct or indirect) reply to the top level comment. class CommentThreadReplies include Google::Apis::Core::Hashable # A limited number of replies. Unless the number of replies returned equals # total_reply_count in the snippet the returned replies are only a subset of the # total number of replies. # Corresponds to the JSON property `comments` # @return [Array] attr_accessor :comments def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @comments = args[:comments] if args.key?(:comments) end end # Basic details about a comment thread. class CommentThreadSnippet include Google::Apis::Core::Hashable # Whether the current viewer of the thread can reply to it. This is viewer # specific - other viewers may see a different value for this field. # Corresponds to the JSON property `canReply` # @return [Boolean] attr_accessor :can_reply alias_method :can_reply?, :can_reply # The YouTube channel the comments in the thread refer to or the channel with # the video the comments refer to. If video_id isn't set the comments refer to # the channel itself. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # Whether the thread (and therefore all its comments) is visible to all YouTube # users. # Corresponds to the JSON property `isPublic` # @return [Boolean] attr_accessor :is_public alias_method :is_public?, :is_public # A comment represents a single YouTube comment. # Corresponds to the JSON property `topLevelComment` # @return [Google::Apis::YoutubeV3::Comment] attr_accessor :top_level_comment # The total number of replies (not including the top level comment). # Corresponds to the JSON property `totalReplyCount` # @return [Fixnum] attr_accessor :total_reply_count # The ID of the video the comments refer to, if any. No video_id implies a # channel discussion comment. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @can_reply = args[:can_reply] if args.key?(:can_reply) @channel_id = args[:channel_id] if args.key?(:channel_id) @is_public = args[:is_public] if args.key?(:is_public) @top_level_comment = args[:top_level_comment] if args.key?(:top_level_comment) @total_reply_count = args[:total_reply_count] if args.key?(:total_reply_count) @video_id = args[:video_id] if args.key?(:video_id) end end # Ratings schemes. The country-specific ratings are mostly for movies and shows. # NEXT_ID: 71 class ContentRating include Google::Apis::Core::Hashable # The video's Australian Classification Board (ACB) or Australian Communications # and Media Authority (ACMA) rating. ACMA ratings are used to classify children' # s television programming. # Corresponds to the JSON property `acbRating` # @return [String] attr_accessor :acb_rating # The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni ( # AGCOM). # Corresponds to the JSON property `agcomRating` # @return [String] attr_accessor :agcom_rating # The video's Anatel (Asociación Nacional de Televisión) rating for Chilean # television. # Corresponds to the JSON property `anatelRating` # @return [String] attr_accessor :anatel_rating # The video's British Board of Film Classification (BBFC) rating. # Corresponds to the JSON property `bbfcRating` # @return [String] attr_accessor :bbfc_rating # The video's rating from Thailand's Board of Film and Video Censors. # Corresponds to the JSON property `bfvcRating` # @return [String] attr_accessor :bfvc_rating # The video's rating from the Austrian Board of Media Classification ( # Bundesministerium für Unterricht, Kunst und Kultur). # Corresponds to the JSON property `bmukkRating` # @return [String] attr_accessor :bmukk_rating # Rating system for Canadian TV - Canadian TV Classification System The video's # rating from the Canadian Radio-Television and Telecommunications Commission ( # CRTC) for Canadian English-language broadcasts. For more information, see the # Canadian Broadcast Standards Council website. # Corresponds to the JSON property `catvRating` # @return [String] attr_accessor :catv_rating # The video's rating from the Canadian Radio-Television and Telecommunications # Commission (CRTC) for Canadian French-language broadcasts. For more # information, see the Canadian Broadcast Standards Council website. # Corresponds to the JSON property `catvfrRating` # @return [String] attr_accessor :catvfr_rating # The video's Central Board of Film Certification (CBFC - India) rating. # Corresponds to the JSON property `cbfcRating` # @return [String] attr_accessor :cbfc_rating # The video's Consejo de Calificación Cinematográfica (Chile) rating. # Corresponds to the JSON property `cccRating` # @return [String] attr_accessor :ccc_rating # The video's rating from Portugal's Comissão de Classificação de Espect´culos. # Corresponds to the JSON property `cceRating` # @return [String] attr_accessor :cce_rating # The video's rating in Switzerland. # Corresponds to the JSON property `chfilmRating` # @return [String] attr_accessor :chfilm_rating # The video's Canadian Home Video Rating System (CHVRS) rating. # Corresponds to the JSON property `chvrsRating` # @return [String] attr_accessor :chvrs_rating # The video's rating from the Commission de Contrôle des Films (Belgium). # Corresponds to the JSON property `cicfRating` # @return [String] attr_accessor :cicf_rating # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA). # Corresponds to the JSON property `cnaRating` # @return [String] attr_accessor :cna_rating # Rating system in France - Commission de classification cinematographique # Corresponds to the JSON property `cncRating` # @return [String] attr_accessor :cnc_rating # The video's rating from France's Conseil supérieur de l?audiovisuel, which # rates broadcast content. # Corresponds to the JSON property `csaRating` # @return [String] attr_accessor :csa_rating # The video's rating from Luxembourg's Commission de surveillance de la # classification des films (CSCF). # Corresponds to the JSON property `cscfRating` # @return [String] attr_accessor :cscf_rating # The video's rating in the Czech Republic. # Corresponds to the JSON property `czfilmRating` # @return [String] attr_accessor :czfilm_rating # The video's Departamento de Justiça, Classificação, Qualificação e Títulos ( # DJCQT - Brazil) rating. # Corresponds to the JSON property `djctqRating` # @return [String] attr_accessor :djctq_rating # Reasons that explain why the video received its DJCQT (Brazil) rating. # Corresponds to the JSON property `djctqRatingReasons` # @return [Array] attr_accessor :djctq_rating_reasons # Rating system in Turkey - Evaluation and Classification Board of the Ministry # of Culture and Tourism # Corresponds to the JSON property `ecbmctRating` # @return [String] attr_accessor :ecbmct_rating # The video's rating in Estonia. # Corresponds to the JSON property `eefilmRating` # @return [String] attr_accessor :eefilm_rating # The video's rating in Egypt. # Corresponds to the JSON property `egfilmRating` # @return [String] attr_accessor :egfilm_rating # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. # Corresponds to the JSON property `eirinRating` # @return [String] attr_accessor :eirin_rating # The video's rating from Malaysia's Film Censorship Board. # Corresponds to the JSON property `fcbmRating` # @return [String] attr_accessor :fcbm_rating # The video's rating from Hong Kong's Office for Film, Newspaper and Article # Administration. # Corresponds to the JSON property `fcoRating` # @return [String] attr_accessor :fco_rating # This property has been deprecated. Use the contentDetails.contentRating. # cncRating instead. # Corresponds to the JSON property `fmocRating` # @return [String] attr_accessor :fmoc_rating # The video's rating from South Africa's Film and Publication Board. # Corresponds to the JSON property `fpbRating` # @return [String] attr_accessor :fpb_rating # Reasons that explain why the video received its FPB (South Africa) rating. # Corresponds to the JSON property `fpbRatingReasons` # @return [Array] attr_accessor :fpb_rating_reasons # The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) # rating. # Corresponds to the JSON property `fskRating` # @return [String] attr_accessor :fsk_rating # The video's rating in Greece. # Corresponds to the JSON property `grfilmRating` # @return [String] attr_accessor :grfilm_rating # The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - # Spain) rating. # Corresponds to the JSON property `icaaRating` # @return [String] attr_accessor :icaa_rating # The video's Irish Film Classification Office (IFCO - Ireland) rating. See the # IFCO website for more information. # Corresponds to the JSON property `ifcoRating` # @return [String] attr_accessor :ifco_rating # The video's rating in Israel. # Corresponds to the JSON property `ilfilmRating` # @return [String] attr_accessor :ilfilm_rating # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - # Argentina) rating. # Corresponds to the JSON property `incaaRating` # @return [String] attr_accessor :incaa_rating # The video's rating from the Kenya Film Classification Board. # Corresponds to the JSON property `kfcbRating` # @return [String] attr_accessor :kfcb_rating # voor de Classificatie van Audiovisuele Media (Netherlands). # Corresponds to the JSON property `kijkwijzerRating` # @return [String] attr_accessor :kijkwijzer_rating # The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos # in South Korea. # Corresponds to the JSON property `kmrbRating` # @return [String] attr_accessor :kmrb_rating # The video's rating from Indonesia's Lembaga Sensor Film. # Corresponds to the JSON property `lsfRating` # @return [String] attr_accessor :lsf_rating # The video's rating from Malta's Film Age-Classification Board. # Corresponds to the JSON property `mccaaRating` # @return [String] attr_accessor :mccaa_rating # The video's rating from the Danish Film Institute's (Det Danske Filminstitut) # Media Council for Children and Young People. # Corresponds to the JSON property `mccypRating` # @return [String] attr_accessor :mccyp_rating # The video's rating system for Vietnam - MCST # Corresponds to the JSON property `mcstRating` # @return [String] attr_accessor :mcst_rating # The video's rating from Singapore's Media Development Authority (MDA) and, # specifically, it's Board of Film Censors (BFC). # Corresponds to the JSON property `mdaRating` # @return [String] attr_accessor :mda_rating # The video's rating from Medietilsynet, the Norwegian Media Authority. # Corresponds to the JSON property `medietilsynetRating` # @return [String] attr_accessor :medietilsynet_rating # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti ( # National Audiovisual Institute). # Corresponds to the JSON property `mekuRating` # @return [String] attr_accessor :meku_rating # The rating system for MENA countries, a clone of MPAA. It is needed to # Corresponds to the JSON property `menaMpaaRating` # @return [String] attr_accessor :mena_mpaa_rating # The video's rating from the Ministero dei Beni e delle Attività Culturali e # del Turismo (Italy). # Corresponds to the JSON property `mibacRating` # @return [String] attr_accessor :mibac_rating # The video's Ministerio de Cultura (Colombia) rating. # Corresponds to the JSON property `mocRating` # @return [String] attr_accessor :moc_rating # The video's rating from Taiwan's Ministry of Culture (文化部). # Corresponds to the JSON property `moctwRating` # @return [String] attr_accessor :moctw_rating # The video's Motion Picture Association of America (MPAA) rating. # Corresponds to the JSON property `mpaaRating` # @return [String] attr_accessor :mpaa_rating # The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/ # md/ratings/v2.3/html/US_MPAAT_Ratings.html. # Corresponds to the JSON property `mpaatRating` # @return [String] attr_accessor :mpaat_rating # The video's rating from the Movie and Television Review and Classification # Board (Philippines). # Corresponds to the JSON property `mtrcbRating` # @return [String] attr_accessor :mtrcb_rating # The video's rating from the Maldives National Bureau of Classification. # Corresponds to the JSON property `nbcRating` # @return [String] attr_accessor :nbc_rating # The video's rating in Poland. # Corresponds to the JSON property `nbcplRating` # @return [String] attr_accessor :nbcpl_rating # The video's rating from the Bulgarian National Film Center. # Corresponds to the JSON property `nfrcRating` # @return [String] attr_accessor :nfrc_rating # The video's rating from Nigeria's National Film and Video Censors Board. # Corresponds to the JSON property `nfvcbRating` # @return [String] attr_accessor :nfvcb_rating # The video's rating from the Nacionãlais Kino centrs (National Film Centre of # Latvia). # Corresponds to the JSON property `nkclvRating` # @return [String] attr_accessor :nkclv_rating # The video's Office of Film and Literature Classification (OFLC - New Zealand) # rating. # Corresponds to the JSON property `oflcRating` # @return [String] attr_accessor :oflc_rating # The video's rating in Peru. # Corresponds to the JSON property `pefilmRating` # @return [String] attr_accessor :pefilm_rating # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee # of the National Office of Film. # Corresponds to the JSON property `rcnofRating` # @return [String] attr_accessor :rcnof_rating # The video's rating in Venezuela. # Corresponds to the JSON property `resorteviolenciaRating` # @return [String] attr_accessor :resorteviolencia_rating # The video's General Directorate of Radio, Television and Cinematography ( # Mexico) rating. # Corresponds to the JSON property `rtcRating` # @return [String] attr_accessor :rtc_rating # The video's rating from Ireland's Raidió Teilifís Éireann. # Corresponds to the JSON property `rteRating` # @return [String] attr_accessor :rte_rating # The video's National Film Registry of the Russian Federation (MKRF - Russia) # rating. # Corresponds to the JSON property `russiaRating` # @return [String] attr_accessor :russia_rating # The video's rating in Slovakia. # Corresponds to the JSON property `skfilmRating` # @return [String] attr_accessor :skfilm_rating # The video's rating in Iceland. # Corresponds to the JSON property `smaisRating` # @return [String] attr_accessor :smais_rating # The video's rating from Statens medieråd (Sweden's National Media Council). # Corresponds to the JSON property `smsaRating` # @return [String] attr_accessor :smsa_rating # The video's TV Parental Guidelines (TVPG) rating. # Corresponds to the JSON property `tvpgRating` # @return [String] attr_accessor :tvpg_rating # A rating that YouTube uses to identify age-restricted content. # Corresponds to the JSON property `ytRating` # @return [String] attr_accessor :yt_rating def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @acb_rating = args[:acb_rating] if args.key?(:acb_rating) @agcom_rating = args[:agcom_rating] if args.key?(:agcom_rating) @anatel_rating = args[:anatel_rating] if args.key?(:anatel_rating) @bbfc_rating = args[:bbfc_rating] if args.key?(:bbfc_rating) @bfvc_rating = args[:bfvc_rating] if args.key?(:bfvc_rating) @bmukk_rating = args[:bmukk_rating] if args.key?(:bmukk_rating) @catv_rating = args[:catv_rating] if args.key?(:catv_rating) @catvfr_rating = args[:catvfr_rating] if args.key?(:catvfr_rating) @cbfc_rating = args[:cbfc_rating] if args.key?(:cbfc_rating) @ccc_rating = args[:ccc_rating] if args.key?(:ccc_rating) @cce_rating = args[:cce_rating] if args.key?(:cce_rating) @chfilm_rating = args[:chfilm_rating] if args.key?(:chfilm_rating) @chvrs_rating = args[:chvrs_rating] if args.key?(:chvrs_rating) @cicf_rating = args[:cicf_rating] if args.key?(:cicf_rating) @cna_rating = args[:cna_rating] if args.key?(:cna_rating) @cnc_rating = args[:cnc_rating] if args.key?(:cnc_rating) @csa_rating = args[:csa_rating] if args.key?(:csa_rating) @cscf_rating = args[:cscf_rating] if args.key?(:cscf_rating) @czfilm_rating = args[:czfilm_rating] if args.key?(:czfilm_rating) @djctq_rating = args[:djctq_rating] if args.key?(:djctq_rating) @djctq_rating_reasons = args[:djctq_rating_reasons] if args.key?(:djctq_rating_reasons) @ecbmct_rating = args[:ecbmct_rating] if args.key?(:ecbmct_rating) @eefilm_rating = args[:eefilm_rating] if args.key?(:eefilm_rating) @egfilm_rating = args[:egfilm_rating] if args.key?(:egfilm_rating) @eirin_rating = args[:eirin_rating] if args.key?(:eirin_rating) @fcbm_rating = args[:fcbm_rating] if args.key?(:fcbm_rating) @fco_rating = args[:fco_rating] if args.key?(:fco_rating) @fmoc_rating = args[:fmoc_rating] if args.key?(:fmoc_rating) @fpb_rating = args[:fpb_rating] if args.key?(:fpb_rating) @fpb_rating_reasons = args[:fpb_rating_reasons] if args.key?(:fpb_rating_reasons) @fsk_rating = args[:fsk_rating] if args.key?(:fsk_rating) @grfilm_rating = args[:grfilm_rating] if args.key?(:grfilm_rating) @icaa_rating = args[:icaa_rating] if args.key?(:icaa_rating) @ifco_rating = args[:ifco_rating] if args.key?(:ifco_rating) @ilfilm_rating = args[:ilfilm_rating] if args.key?(:ilfilm_rating) @incaa_rating = args[:incaa_rating] if args.key?(:incaa_rating) @kfcb_rating = args[:kfcb_rating] if args.key?(:kfcb_rating) @kijkwijzer_rating = args[:kijkwijzer_rating] if args.key?(:kijkwijzer_rating) @kmrb_rating = args[:kmrb_rating] if args.key?(:kmrb_rating) @lsf_rating = args[:lsf_rating] if args.key?(:lsf_rating) @mccaa_rating = args[:mccaa_rating] if args.key?(:mccaa_rating) @mccyp_rating = args[:mccyp_rating] if args.key?(:mccyp_rating) @mcst_rating = args[:mcst_rating] if args.key?(:mcst_rating) @mda_rating = args[:mda_rating] if args.key?(:mda_rating) @medietilsynet_rating = args[:medietilsynet_rating] if args.key?(:medietilsynet_rating) @meku_rating = args[:meku_rating] if args.key?(:meku_rating) @mena_mpaa_rating = args[:mena_mpaa_rating] if args.key?(:mena_mpaa_rating) @mibac_rating = args[:mibac_rating] if args.key?(:mibac_rating) @moc_rating = args[:moc_rating] if args.key?(:moc_rating) @moctw_rating = args[:moctw_rating] if args.key?(:moctw_rating) @mpaa_rating = args[:mpaa_rating] if args.key?(:mpaa_rating) @mpaat_rating = args[:mpaat_rating] if args.key?(:mpaat_rating) @mtrcb_rating = args[:mtrcb_rating] if args.key?(:mtrcb_rating) @nbc_rating = args[:nbc_rating] if args.key?(:nbc_rating) @nbcpl_rating = args[:nbcpl_rating] if args.key?(:nbcpl_rating) @nfrc_rating = args[:nfrc_rating] if args.key?(:nfrc_rating) @nfvcb_rating = args[:nfvcb_rating] if args.key?(:nfvcb_rating) @nkclv_rating = args[:nkclv_rating] if args.key?(:nkclv_rating) @oflc_rating = args[:oflc_rating] if args.key?(:oflc_rating) @pefilm_rating = args[:pefilm_rating] if args.key?(:pefilm_rating) @rcnof_rating = args[:rcnof_rating] if args.key?(:rcnof_rating) @resorteviolencia_rating = args[:resorteviolencia_rating] if args.key?(:resorteviolencia_rating) @rtc_rating = args[:rtc_rating] if args.key?(:rtc_rating) @rte_rating = args[:rte_rating] if args.key?(:rte_rating) @russia_rating = args[:russia_rating] if args.key?(:russia_rating) @skfilm_rating = args[:skfilm_rating] if args.key?(:skfilm_rating) @smais_rating = args[:smais_rating] if args.key?(:smais_rating) @smsa_rating = args[:smsa_rating] if args.key?(:smsa_rating) @tvpg_rating = args[:tvpg_rating] if args.key?(:tvpg_rating) @yt_rating = args[:yt_rating] if args.key?(:yt_rating) end end # A fanFundingEvent resource represents a fan funding event on a YouTube channel. # Fan funding events occur when a user gives one-time monetary support to the # channel owner. class FanFundingEvent include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube assigns to uniquely identify the fan funding event. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # fanFundingEvent". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The snippet object contains basic details about the fan funding event. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::FanFundingEventSnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end end # class FanFundingEventListResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of fan funding events that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # fanFundingEventListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # class FanFundingEventSnippet include Google::Apis::Core::Hashable # The amount of funding in micros of fund_currency. e.g., 1 is represented # Corresponds to the JSON property `amountMicros` # @return [Fixnum] attr_accessor :amount_micros # Channel id where the funding event occurred. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # The text contents of the comment left by the user. # Corresponds to the JSON property `commentText` # @return [String] attr_accessor :comment_text # The date and time when the funding occurred. The value is specified in ISO # 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `createdAt` # @return [DateTime] attr_accessor :created_at # The currency in which the fund was made. ISO 4217. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency # A rendered string that displays the fund amount and currency (e.g., "$1.00"). # The string is rendered for the given language. # Corresponds to the JSON property `displayString` # @return [String] attr_accessor :display_string # Details about the supporter. Only filled if the event was made public by the # user. # Corresponds to the JSON property `supporterDetails` # @return [Google::Apis::YoutubeV3::ChannelProfileDetails] attr_accessor :supporter_details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @amount_micros = args[:amount_micros] if args.key?(:amount_micros) @channel_id = args[:channel_id] if args.key?(:channel_id) @comment_text = args[:comment_text] if args.key?(:comment_text) @created_at = args[:created_at] if args.key?(:created_at) @currency = args[:currency] if args.key?(:currency) @display_string = args[:display_string] if args.key?(:display_string) @supporter_details = args[:supporter_details] if args.key?(:supporter_details) end end # Geographical coordinates of a point, in WGS84. class GeoPoint include Google::Apis::Core::Hashable # Altitude above the reference ellipsoid, in meters. # Corresponds to the JSON property `altitude` # @return [Float] attr_accessor :altitude # Latitude in degrees. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude # Longitude in degrees. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @altitude = args[:altitude] if args.key?(:altitude) @latitude = args[:latitude] if args.key?(:latitude) @longitude = args[:longitude] if args.key?(:longitude) end end # A guideCategory resource identifies a category that YouTube algorithmically # assigns based on a channel's content or other indicators, such as the channel' # s popularity. The list is similar to video categories, with the difference # being that a video's uploader can assign a video category but only YouTube can # assign a channel category. class GuideCategory include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the guide category. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # guideCategory". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Basic details about a guide category. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::GuideCategorySnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end end # class ListGuideCategoriesResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of categories that can be associated with YouTube channels. In this map, # the category ID is the map key, and its value is the corresponding # guideCategory resource. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # guideCategoryListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # Basic details about a guide category. class GuideCategorySnippet include Google::Apis::Core::Hashable # # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # Description of the guide category. # 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) @channel_id = args[:channel_id] if args.key?(:channel_id) @title = args[:title] if args.key?(:title) end end # An i18nLanguage resource identifies a UI language currently supported by # YouTube. class I18nLanguage include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the i18n language. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # i18nLanguage". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Basic details about an i18n language, such as language code and human-readable # name. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::I18nLanguageSnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end end # class ListI18nLanguagesResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of supported i18n languages. In this map, the i18n language ID is the # map key, and its value is the corresponding i18nLanguage resource. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # i18nLanguageListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_id) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # Basic details about an i18n language, such as language code and human-readable # name. class I18nLanguageSnippet include Google::Apis::Core::Hashable # A short BCP-47 code that uniquely identifies a language. # Corresponds to the JSON property `hl` # @return [String] attr_accessor :hl # The human-readable name of the language in the language itself. # 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) @hl = args[:hl] if args.key?(:hl) @name = args[:name] if args.key?(:name) end end # A i18nRegion resource identifies a region where YouTube is available. class I18nRegion include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the i18n region. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # i18nRegion". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Basic details about an i18n region, such as region code and human-readable # name. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::I18nRegionSnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end end # class ListI18nRegionsResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of regions where YouTube is available. In this map, the i18n region ID # is the map key, and its value is the corresponding i18nRegion resource. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # i18nRegionListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_id) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # Basic details about an i18n region, such as region code and human-readable # name. class I18nRegionSnippet include Google::Apis::Core::Hashable # The region code as a 2-letter ISO country code. # Corresponds to the JSON property `gl` # @return [String] attr_accessor :gl # The human-readable name of the region. # 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) @gl = args[:gl] if args.key?(:gl) @name = args[:name] if args.key?(:name) end end # Branding properties for images associated with the channel. class ImageSettings include Google::Apis::Core::Hashable # The URL for the background image shown on the video watch page. The image # should be 1200px by 615px, with a maximum file size of 128k. # Corresponds to the JSON property `backgroundImageUrl` # @return [Google::Apis::YoutubeV3::LocalizedProperty] attr_accessor :background_image_url # This is used only in update requests; if it's set, we use this URL to generate # all of the above banner URLs. # Corresponds to the JSON property `bannerExternalUrl` # @return [String] attr_accessor :banner_external_url # Banner image. Desktop size (1060x175). # Corresponds to the JSON property `bannerImageUrl` # @return [String] attr_accessor :banner_image_url # Banner image. Mobile size high resolution (1440x395). # Corresponds to the JSON property `bannerMobileExtraHdImageUrl` # @return [String] attr_accessor :banner_mobile_extra_hd_image_url # Banner image. Mobile size high resolution (1280x360). # Corresponds to the JSON property `bannerMobileHdImageUrl` # @return [String] attr_accessor :banner_mobile_hd_image_url # Banner image. Mobile size (640x175). # Corresponds to the JSON property `bannerMobileImageUrl` # @return [String] attr_accessor :banner_mobile_image_url # Banner image. Mobile size low resolution (320x88). # Corresponds to the JSON property `bannerMobileLowImageUrl` # @return [String] attr_accessor :banner_mobile_low_image_url # Banner image. Mobile size medium/high resolution (960x263). # Corresponds to the JSON property `bannerMobileMediumHdImageUrl` # @return [String] attr_accessor :banner_mobile_medium_hd_image_url # Banner image. Tablet size extra high resolution (2560x424). # Corresponds to the JSON property `bannerTabletExtraHdImageUrl` # @return [String] attr_accessor :banner_tablet_extra_hd_image_url # Banner image. Tablet size high resolution (2276x377). # Corresponds to the JSON property `bannerTabletHdImageUrl` # @return [String] attr_accessor :banner_tablet_hd_image_url # Banner image. Tablet size (1707x283). # Corresponds to the JSON property `bannerTabletImageUrl` # @return [String] attr_accessor :banner_tablet_image_url # Banner image. Tablet size low resolution (1138x188). # Corresponds to the JSON property `bannerTabletLowImageUrl` # @return [String] attr_accessor :banner_tablet_low_image_url # Banner image. TV size high resolution (1920x1080). # Corresponds to the JSON property `bannerTvHighImageUrl` # @return [String] attr_accessor :banner_tv_high_image_url # Banner image. TV size extra high resolution (2120x1192). # Corresponds to the JSON property `bannerTvImageUrl` # @return [String] attr_accessor :banner_tv_image_url # Banner image. TV size low resolution (854x480). # Corresponds to the JSON property `bannerTvLowImageUrl` # @return [String] attr_accessor :banner_tv_low_image_url # Banner image. TV size medium resolution (1280x720). # Corresponds to the JSON property `bannerTvMediumImageUrl` # @return [String] attr_accessor :banner_tv_medium_image_url # The image map script for the large banner image. # Corresponds to the JSON property `largeBrandedBannerImageImapScript` # @return [Google::Apis::YoutubeV3::LocalizedProperty] attr_accessor :large_branded_banner_image_imap_script # The URL for the 854px by 70px image that appears below the video player in the # expanded video view of the video watch page. # Corresponds to the JSON property `largeBrandedBannerImageUrl` # @return [Google::Apis::YoutubeV3::LocalizedProperty] attr_accessor :large_branded_banner_image_url # The image map script for the small banner image. # Corresponds to the JSON property `smallBrandedBannerImageImapScript` # @return [Google::Apis::YoutubeV3::LocalizedProperty] attr_accessor :small_branded_banner_image_imap_script # The URL for the 640px by 70px banner image that appears below the video player # in the default view of the video watch page. # Corresponds to the JSON property `smallBrandedBannerImageUrl` # @return [Google::Apis::YoutubeV3::LocalizedProperty] attr_accessor :small_branded_banner_image_url # The URL for a 1px by 1px tracking pixel that can be used to collect statistics # for views of the channel or video pages. # Corresponds to the JSON property `trackingImageUrl` # @return [String] attr_accessor :tracking_image_url # The URL for the image that appears above the top-left corner of the video # player. This is a 25-pixel-high image with a flexible width that cannot exceed # 170 pixels. # Corresponds to the JSON property `watchIconImageUrl` # @return [String] attr_accessor :watch_icon_image_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @background_image_url = args[:background_image_url] if args.key?(:background_image_url) @banner_external_url = args[:banner_external_url] if args.key?(:banner_external_url) @banner_image_url = args[:banner_image_url] if args.key?(:banner_image_url) @banner_mobile_extra_hd_image_url = args[:banner_mobile_extra_hd_image_url] if args.key?(:banner_mobile_extra_hd_image_url) @banner_mobile_hd_image_url = args[:banner_mobile_hd_image_url] if args.key?(:banner_mobile_hd_image_url) @banner_mobile_image_url = args[:banner_mobile_image_url] if args.key?(:banner_mobile_image_url) @banner_mobile_low_image_url = args[:banner_mobile_low_image_url] if args.key?(:banner_mobile_low_image_url) @banner_mobile_medium_hd_image_url = args[:banner_mobile_medium_hd_image_url] if args.key?(:banner_mobile_medium_hd_image_url) @banner_tablet_extra_hd_image_url = args[:banner_tablet_extra_hd_image_url] if args.key?(:banner_tablet_extra_hd_image_url) @banner_tablet_hd_image_url = args[:banner_tablet_hd_image_url] if args.key?(:banner_tablet_hd_image_url) @banner_tablet_image_url = args[:banner_tablet_image_url] if args.key?(:banner_tablet_image_url) @banner_tablet_low_image_url = args[:banner_tablet_low_image_url] if args.key?(:banner_tablet_low_image_url) @banner_tv_high_image_url = args[:banner_tv_high_image_url] if args.key?(:banner_tv_high_image_url) @banner_tv_image_url = args[:banner_tv_image_url] if args.key?(:banner_tv_image_url) @banner_tv_low_image_url = args[:banner_tv_low_image_url] if args.key?(:banner_tv_low_image_url) @banner_tv_medium_image_url = args[:banner_tv_medium_image_url] if args.key?(:banner_tv_medium_image_url) @large_branded_banner_image_imap_script = args[:large_branded_banner_image_imap_script] if args.key?(:large_branded_banner_image_imap_script) @large_branded_banner_image_url = args[:large_branded_banner_image_url] if args.key?(:large_branded_banner_image_url) @small_branded_banner_image_imap_script = args[:small_branded_banner_image_imap_script] if args.key?(:small_branded_banner_image_imap_script) @small_branded_banner_image_url = args[:small_branded_banner_image_url] if args.key?(:small_branded_banner_image_url) @tracking_image_url = args[:tracking_image_url] if args.key?(:tracking_image_url) @watch_icon_image_url = args[:watch_icon_image_url] if args.key?(:watch_icon_image_url) end end # Describes information necessary for ingesting an RTMP or an HTTP stream. class IngestionInfo include Google::Apis::Core::Hashable # The backup ingestion URL that you should use to stream video to YouTube. You # have the option of simultaneously streaming the content that you are sending # to the ingestionAddress to this URL. # Corresponds to the JSON property `backupIngestionAddress` # @return [String] attr_accessor :backup_ingestion_address # The primary ingestion URL that you should use to stream video to YouTube. You # must stream video to this URL. # Depending on which application or tool you use to encode your video stream, # you may need to enter the stream URL and stream name separately or you may # need to concatenate them in the following format: # STREAM_URL/STREAM_NAME # Corresponds to the JSON property `ingestionAddress` # @return [String] attr_accessor :ingestion_address # The HTTP or RTMP stream name that YouTube assigns to the video stream. # Corresponds to the JSON property `streamName` # @return [String] attr_accessor :stream_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @backup_ingestion_address = args[:backup_ingestion_address] if args.key?(:backup_ingestion_address) @ingestion_address = args[:ingestion_address] if args.key?(:ingestion_address) @stream_name = args[:stream_name] if args.key?(:stream_name) end end # class InvideoBranding include Google::Apis::Core::Hashable # # Corresponds to the JSON property `imageBytes` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :image_bytes # # Corresponds to the JSON property `imageUrl` # @return [String] attr_accessor :image_url # Describes the spatial position of a visual widget inside a video. It is a # union of various position types, out of which only will be set one. # Corresponds to the JSON property `position` # @return [Google::Apis::YoutubeV3::InvideoPosition] attr_accessor :position # # Corresponds to the JSON property `targetChannelId` # @return [String] attr_accessor :target_channel_id # Describes a temporal position of a visual widget inside a video. # Corresponds to the JSON property `timing` # @return [Google::Apis::YoutubeV3::InvideoTiming] attr_accessor :timing def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @image_bytes = args[:image_bytes] if args.key?(:image_bytes) @image_url = args[:image_url] if args.key?(:image_url) @position = args[:position] if args.key?(:position) @target_channel_id = args[:target_channel_id] if args.key?(:target_channel_id) @timing = args[:timing] if args.key?(:timing) end end # Describes the spatial position of a visual widget inside a video. It is a # union of various position types, out of which only will be set one. class InvideoPosition include Google::Apis::Core::Hashable # Describes in which corner of the video the visual widget will appear. # Corresponds to the JSON property `cornerPosition` # @return [String] attr_accessor :corner_position # Defines the position 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) @corner_position = args[:corner_position] if args.key?(:corner_position) @type = args[:type] if args.key?(:type) end end # Describes an invideo promotion campaign consisting of multiple promoted items. # A campaign belongs to a single channel_id. class InvideoPromotion include Google::Apis::Core::Hashable # Describes a temporal position of a visual widget inside a video. # Corresponds to the JSON property `defaultTiming` # @return [Google::Apis::YoutubeV3::InvideoTiming] attr_accessor :default_timing # List of promoted items in decreasing priority. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Describes the spatial position of a visual widget inside a video. It is a # union of various position types, out of which only will be set one. # Corresponds to the JSON property `position` # @return [Google::Apis::YoutubeV3::InvideoPosition] attr_accessor :position # Indicates whether the channel's promotional campaign uses "smart timing." This # feature attempts to show promotions at a point in the video when they are more # likely to be clicked and less likely to disrupt the viewing experience. This # feature also picks up a single promotion to show on each video. # Corresponds to the JSON property `useSmartTiming` # @return [Boolean] attr_accessor :use_smart_timing alias_method :use_smart_timing?, :use_smart_timing def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_timing = args[:default_timing] if args.key?(:default_timing) @items = args[:items] if args.key?(:items) @position = args[:position] if args.key?(:position) @use_smart_timing = args[:use_smart_timing] if args.key?(:use_smart_timing) end end # Describes a temporal position of a visual widget inside a video. class InvideoTiming include Google::Apis::Core::Hashable # Defines the duration in milliseconds for which the promotion should be # displayed. If missing, the client should use the default. # Corresponds to the JSON property `durationMs` # @return [Fixnum] attr_accessor :duration_ms # Defines the time at which the promotion will appear. Depending on the value of # type the value of the offsetMs field will represent a time offset from the # start or from the end of the video, expressed in milliseconds. # Corresponds to the JSON property `offsetMs` # @return [Fixnum] attr_accessor :offset_ms # Describes a timing type. If the value is offsetFromStart, then the offsetMs # field represents an offset from the start of the video. If the value is # offsetFromEnd, then the offsetMs field represents an offset from the end of # the video. # 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) @duration_ms = args[:duration_ms] if args.key?(:duration_ms) @offset_ms = args[:offset_ms] if args.key?(:offset_ms) @type = args[:type] if args.key?(:type) end end # class LanguageTag include Google::Apis::Core::Hashable # # 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 liveBroadcast resource represents an event that will be streamed, via live # video, on YouTube. class LiveBroadcast include Google::Apis::Core::Hashable # Detailed settings of a broadcast. # Corresponds to the JSON property `contentDetails` # @return [Google::Apis::YoutubeV3::LiveBroadcastContentDetails] attr_accessor :content_details # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube assigns to uniquely identify the broadcast. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # liveBroadcast". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The snippet object contains basic details about the event, including its title, # description, start time, and end time. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::LiveBroadcastSnippet] attr_accessor :snippet # Statistics about the live broadcast. These represent a snapshot of the values # at the time of the request. Statistics are only returned for live broadcasts. # Corresponds to the JSON property `statistics` # @return [Google::Apis::YoutubeV3::LiveBroadcastStatistics] attr_accessor :statistics # The status object contains information about the event's status. # Corresponds to the JSON property `status` # @return [Google::Apis::YoutubeV3::LiveBroadcastStatus] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_details = args[:content_details] if args.key?(:content_details) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) @statistics = args[:statistics] if args.key?(:statistics) @status = args[:status] if args.key?(:status) end end # Detailed settings of a broadcast. class LiveBroadcastContentDetails include Google::Apis::Core::Hashable # This value uniquely identifies the live stream bound to the broadcast. # Corresponds to the JSON property `boundStreamId` # @return [String] attr_accessor :bound_stream_id # The date and time that the live stream referenced by boundStreamId was last # updated. # Corresponds to the JSON property `boundStreamLastUpdateTimeMs` # @return [DateTime] attr_accessor :bound_stream_last_update_time_ms # # Corresponds to the JSON property `closedCaptionsType` # @return [String] attr_accessor :closed_captions_type # This setting indicates whether auto start is enabled for this broadcast. # Corresponds to the JSON property `enableAutoStart` # @return [Boolean] attr_accessor :enable_auto_start alias_method :enable_auto_start?, :enable_auto_start # This setting indicates whether HTTP POST closed captioning is enabled for this # broadcast. The ingestion URL of the closed captions is returned through the # liveStreams API. This is mutually exclusive with using the # closed_captions_type property, and is equivalent to setting # closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. # Corresponds to the JSON property `enableClosedCaptions` # @return [Boolean] attr_accessor :enable_closed_captions alias_method :enable_closed_captions?, :enable_closed_captions # This setting indicates whether YouTube should enable content encryption for # the broadcast. # Corresponds to the JSON property `enableContentEncryption` # @return [Boolean] attr_accessor :enable_content_encryption alias_method :enable_content_encryption?, :enable_content_encryption # This setting determines whether viewers can access DVR controls while watching # the video. DVR controls enable the viewer to control the video playback # experience by pausing, rewinding, or fast forwarding content. The default # value for this property is true. # Important: You must set the value to true and also set the enableArchive # property's value to true if you want to make playback available immediately # after the broadcast ends. # Corresponds to the JSON property `enableDvr` # @return [Boolean] attr_accessor :enable_dvr alias_method :enable_dvr?, :enable_dvr # This setting indicates whether the broadcast video can be played in an # embedded player. If you choose to archive the video (using the enableArchive # property), this setting will also apply to the archived video. # Corresponds to the JSON property `enableEmbed` # @return [Boolean] attr_accessor :enable_embed alias_method :enable_embed?, :enable_embed # Indicates whether this broadcast has low latency enabled. # Corresponds to the JSON property `enableLowLatency` # @return [Boolean] attr_accessor :enable_low_latency alias_method :enable_low_latency?, :enable_low_latency # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL # should match enable_low_latency=false LATENCY_LOW should match # enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency # omitted. # Corresponds to the JSON property `latencyPreference` # @return [String] attr_accessor :latency_preference # # Corresponds to the JSON property `mesh` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :mesh # Settings and Info of the monitor stream # Corresponds to the JSON property `monitorStream` # @return [Google::Apis::YoutubeV3::MonitorStreamInfo] attr_accessor :monitor_stream # The projection format of this broadcast. This defaults to rectangular. # Corresponds to the JSON property `projection` # @return [String] attr_accessor :projection # Automatically start recording after the event goes live. The default value for # this property is true. # Important: You must also set the enableDvr property's value to true if you # want the playback to be available immediately after the broadcast ends. If you # set this property's value to true but do not also set the enableDvr property # to true, there may be a delay of around one day before the archived video will # be available for playback. # Corresponds to the JSON property `recordFromStart` # @return [Boolean] attr_accessor :record_from_start alias_method :record_from_start?, :record_from_start # This setting indicates whether the broadcast should automatically begin with # an in-stream slate when you update the broadcast's status to live. After # updating the status, you then need to send a liveCuepoints.insert request that # sets the cuepoint's eventState to end to remove the in-stream slate and make # your broadcast stream visible to viewers. # Corresponds to the JSON property `startWithSlate` # @return [Boolean] attr_accessor :start_with_slate alias_method :start_with_slate?, :start_with_slate def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @bound_stream_id = args[:bound_stream_id] if args.key?(:bound_stream_id) @bound_stream_last_update_time_ms = args[:bound_stream_last_update_time_ms] if args.key?(:bound_stream_last_update_time_ms) @closed_captions_type = args[:closed_captions_type] if args.key?(:closed_captions_type) @enable_auto_start = args[:enable_auto_start] if args.key?(:enable_auto_start) @enable_closed_captions = args[:enable_closed_captions] if args.key?(:enable_closed_captions) @enable_content_encryption = args[:enable_content_encryption] if args.key?(:enable_content_encryption) @enable_dvr = args[:enable_dvr] if args.key?(:enable_dvr) @enable_embed = args[:enable_embed] if args.key?(:enable_embed) @enable_low_latency = args[:enable_low_latency] if args.key?(:enable_low_latency) @latency_preference = args[:latency_preference] if args.key?(:latency_preference) @mesh = args[:mesh] if args.key?(:mesh) @monitor_stream = args[:monitor_stream] if args.key?(:monitor_stream) @projection = args[:projection] if args.key?(:projection) @record_from_start = args[:record_from_start] if args.key?(:record_from_start) @start_with_slate = args[:start_with_slate] if args.key?(:start_with_slate) end end # class ListLiveBroadcastsResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of broadcasts that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # liveBroadcastListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # class LiveBroadcastSnippet include Google::Apis::Core::Hashable # The date and time that the broadcast actually ended. This information is only # available once the broadcast's state is complete. The value is specified in # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `actualEndTime` # @return [DateTime] attr_accessor :actual_end_time # The date and time that the broadcast actually started. This information is # only available once the broadcast's state is live. The value is specified in # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `actualStartTime` # @return [DateTime] attr_accessor :actual_start_time # The ID that YouTube uses to uniquely identify the channel that is publishing # the broadcast. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # The broadcast's description. As with the title, you can set this field by # modifying the broadcast resource or by setting the description field of the # corresponding video resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # # Corresponds to the JSON property `isDefaultBroadcast` # @return [Boolean] attr_accessor :is_default_broadcast alias_method :is_default_broadcast?, :is_default_broadcast # The id of the live chat for this broadcast. # Corresponds to the JSON property `liveChatId` # @return [String] attr_accessor :live_chat_id # The date and time that the broadcast was added to YouTube's live broadcast # schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `publishedAt` # @return [DateTime] attr_accessor :published_at # The date and time that the broadcast is scheduled to end. The value is # specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `scheduledEndTime` # @return [DateTime] attr_accessor :scheduled_end_time # The date and time that the broadcast is scheduled to start. The value is # specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `scheduledStartTime` # @return [DateTime] attr_accessor :scheduled_start_time # Internal representation of thumbnails for a YouTube resource. # Corresponds to the JSON property `thumbnails` # @return [Google::Apis::YoutubeV3::ThumbnailDetails] attr_accessor :thumbnails # The broadcast's title. Note that the broadcast represents exactly one YouTube # video. You can set this field by modifying the broadcast resource or by # setting the title field of the corresponding video resource. # 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) @actual_end_time = args[:actual_end_time] if args.key?(:actual_end_time) @actual_start_time = args[:actual_start_time] if args.key?(:actual_start_time) @channel_id = args[:channel_id] if args.key?(:channel_id) @description = args[:description] if args.key?(:description) @is_default_broadcast = args[:is_default_broadcast] if args.key?(:is_default_broadcast) @live_chat_id = args[:live_chat_id] if args.key?(:live_chat_id) @published_at = args[:published_at] if args.key?(:published_at) @scheduled_end_time = args[:scheduled_end_time] if args.key?(:scheduled_end_time) @scheduled_start_time = args[:scheduled_start_time] if args.key?(:scheduled_start_time) @thumbnails = args[:thumbnails] if args.key?(:thumbnails) @title = args[:title] if args.key?(:title) end end # Statistics about the live broadcast. These represent a snapshot of the values # at the time of the request. Statistics are only returned for live broadcasts. class LiveBroadcastStatistics include Google::Apis::Core::Hashable # The number of viewers currently watching the broadcast. The property and its # value will be present if the broadcast has current viewers and the broadcast # owner has not hidden the viewcount for the video. Note that YouTube stops # tracking the number of concurrent viewers for a broadcast when the broadcast # ends. So, this property would not identify the number of viewers watching an # archived video of a live broadcast that already ended. # Corresponds to the JSON property `concurrentViewers` # @return [Fixnum] attr_accessor :concurrent_viewers # The total number of live chat messages currently on the broadcast. The # property and its value will be present if the broadcast is public, has the # live chat feature enabled, and has at least one message. Note that this field # will not be filled after the broadcast ends. So this property would not # identify the number of chat messages for an archived video of a completed live # broadcast. # Corresponds to the JSON property `totalChatCount` # @return [Fixnum] attr_accessor :total_chat_count def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @concurrent_viewers = args[:concurrent_viewers] if args.key?(:concurrent_viewers) @total_chat_count = args[:total_chat_count] if args.key?(:total_chat_count) end end # class LiveBroadcastStatus include Google::Apis::Core::Hashable # The broadcast's status. The status can be updated using the API's # liveBroadcasts.transition method. # Corresponds to the JSON property `lifeCycleStatus` # @return [String] attr_accessor :life_cycle_status # Priority of the live broadcast event (internal state). # Corresponds to the JSON property `liveBroadcastPriority` # @return [String] attr_accessor :live_broadcast_priority # The broadcast's privacy status. Note that the broadcast represents exactly one # YouTube video, so the privacy settings are identical to those supported for # videos. In addition, you can set this field by modifying the broadcast # resource or by setting the privacyStatus field of the corresponding video # resource. # Corresponds to the JSON property `privacyStatus` # @return [String] attr_accessor :privacy_status # The broadcast's recording status. # Corresponds to the JSON property `recordingStatus` # @return [String] attr_accessor :recording_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @life_cycle_status = args[:life_cycle_status] if args.key?(:life_cycle_status) @live_broadcast_priority = args[:live_broadcast_priority] if args.key?(:live_broadcast_priority) @privacy_status = args[:privacy_status] if args.key?(:privacy_status) @recording_status = args[:recording_status] if args.key?(:recording_status) end end # A liveChatBan resource represents a ban for a YouTube live chat. class LiveChatBan include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube assigns to uniquely identify the ban. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # liveChatBan". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The snippet object contains basic details about the ban. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::LiveChatBanSnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end end # class LiveChatBanSnippet include Google::Apis::Core::Hashable # The duration of a ban, only filled if the ban has type TEMPORARY. # Corresponds to the JSON property `banDurationSeconds` # @return [Fixnum] attr_accessor :ban_duration_seconds # # Corresponds to the JSON property `bannedUserDetails` # @return [Google::Apis::YoutubeV3::ChannelProfileDetails] attr_accessor :banned_user_details # The chat this ban is pertinent to. # Corresponds to the JSON property `liveChatId` # @return [String] attr_accessor :live_chat_id # The type of ban. # 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) @ban_duration_seconds = args[:ban_duration_seconds] if args.key?(:ban_duration_seconds) @banned_user_details = args[:banned_user_details] if args.key?(:banned_user_details) @live_chat_id = args[:live_chat_id] if args.key?(:live_chat_id) @type = args[:type] if args.key?(:type) end end # class LiveChatFanFundingEventDetails include Google::Apis::Core::Hashable # A rendered string that displays the fund amount and currency to the user. # Corresponds to the JSON property `amountDisplayString` # @return [String] attr_accessor :amount_display_string # The amount of the fund. # Corresponds to the JSON property `amountMicros` # @return [Fixnum] attr_accessor :amount_micros # The currency in which the fund was made. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency # The comment added by the user to this fan funding event. # Corresponds to the JSON property `userComment` # @return [String] attr_accessor :user_comment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @amount_display_string = args[:amount_display_string] if args.key?(:amount_display_string) @amount_micros = args[:amount_micros] if args.key?(:amount_micros) @currency = args[:currency] if args.key?(:currency) @user_comment = args[:user_comment] if args.key?(:user_comment) end end # A liveChatMessage resource represents a chat message in a YouTube Live Chat. class LiveChatMessage include Google::Apis::Core::Hashable # The authorDetails object contains basic details about the user that posted # this message. # Corresponds to the JSON property `authorDetails` # @return [Google::Apis::YoutubeV3::LiveChatMessageAuthorDetails] attr_accessor :author_details # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube assigns to uniquely identify the message. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # liveChatMessage". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The snippet object contains basic details about the message. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::LiveChatMessageSnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @author_details = args[:author_details] if args.key?(:author_details) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end end # class LiveChatMessageAuthorDetails include Google::Apis::Core::Hashable # The YouTube channel ID. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # The channel's URL. # Corresponds to the JSON property `channelUrl` # @return [String] attr_accessor :channel_url # The channel's display name. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Whether the author is a moderator of the live chat. # Corresponds to the JSON property `isChatModerator` # @return [Boolean] attr_accessor :is_chat_moderator alias_method :is_chat_moderator?, :is_chat_moderator # Whether the author is the owner of the live chat. # Corresponds to the JSON property `isChatOwner` # @return [Boolean] attr_accessor :is_chat_owner alias_method :is_chat_owner?, :is_chat_owner # Whether the author is a sponsor of the live chat. # Corresponds to the JSON property `isChatSponsor` # @return [Boolean] attr_accessor :is_chat_sponsor alias_method :is_chat_sponsor?, :is_chat_sponsor # Whether the author's identity has been verified by YouTube. # Corresponds to the JSON property `isVerified` # @return [Boolean] attr_accessor :is_verified alias_method :is_verified?, :is_verified # The channels's avatar URL. # Corresponds to the JSON property `profileImageUrl` # @return [String] attr_accessor :profile_image_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @channel_id = args[:channel_id] if args.key?(:channel_id) @channel_url = args[:channel_url] if args.key?(:channel_url) @display_name = args[:display_name] if args.key?(:display_name) @is_chat_moderator = args[:is_chat_moderator] if args.key?(:is_chat_moderator) @is_chat_owner = args[:is_chat_owner] if args.key?(:is_chat_owner) @is_chat_sponsor = args[:is_chat_sponsor] if args.key?(:is_chat_sponsor) @is_verified = args[:is_verified] if args.key?(:is_verified) @profile_image_url = args[:profile_image_url] if args.key?(:profile_image_url) end end # class LiveChatMessageDeletedDetails include Google::Apis::Core::Hashable # # Corresponds to the JSON property `deletedMessageId` # @return [String] attr_accessor :deleted_message_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deleted_message_id = args[:deleted_message_id] if args.key?(:deleted_message_id) end end # class LiveChatMessageListResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of live chat messages. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # liveChatMessageListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The date and time when the underlying stream went offline. The value is # specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `offlineAt` # @return [DateTime] attr_accessor :offline_at # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # The amount of time the client should wait before polling again. # Corresponds to the JSON property `pollingIntervalMillis` # @return [Fixnum] attr_accessor :polling_interval_millis # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @offline_at = args[:offline_at] if args.key?(:offline_at) @page_info = args[:page_info] if args.key?(:page_info) @polling_interval_millis = args[:polling_interval_millis] if args.key?(:polling_interval_millis) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # class LiveChatMessageRetractedDetails include Google::Apis::Core::Hashable # # Corresponds to the JSON property `retractedMessageId` # @return [String] attr_accessor :retracted_message_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @retracted_message_id = args[:retracted_message_id] if args.key?(:retracted_message_id) end end # class LiveChatMessageSnippet include Google::Apis::Core::Hashable # The ID of the user that authored this message, this field is not always filled. # textMessageEvent - the user that wrote the message fanFundingEvent - the user # that funded the broadcast newSponsorEvent - the user that just became a # sponsor messageDeletedEvent - the moderator that took the action # messageRetractedEvent - the author that retracted their message # userBannedEvent - the moderator that took the action superChatEvent - the user # that made the purchase # Corresponds to the JSON property `authorChannelId` # @return [String] attr_accessor :author_channel_id # Contains a string that can be displayed to the user. If this field is not # present the message is silent, at the moment only messages of type TOMBSTONE # and CHAT_ENDED_EVENT are silent. # Corresponds to the JSON property `displayMessage` # @return [String] attr_accessor :display_message # Details about the funding event, this is only set if the type is ' # fanFundingEvent'. # Corresponds to the JSON property `fanFundingEventDetails` # @return [Google::Apis::YoutubeV3::LiveChatFanFundingEventDetails] attr_accessor :fan_funding_event_details # Whether the message has display content that should be displayed to users. # Corresponds to the JSON property `hasDisplayContent` # @return [Boolean] attr_accessor :has_display_content alias_method :has_display_content?, :has_display_content # # Corresponds to the JSON property `liveChatId` # @return [String] attr_accessor :live_chat_id # # Corresponds to the JSON property `messageDeletedDetails` # @return [Google::Apis::YoutubeV3::LiveChatMessageDeletedDetails] attr_accessor :message_deleted_details # # Corresponds to the JSON property `messageRetractedDetails` # @return [Google::Apis::YoutubeV3::LiveChatMessageRetractedDetails] attr_accessor :message_retracted_details # # Corresponds to the JSON property `pollClosedDetails` # @return [Google::Apis::YoutubeV3::LiveChatPollClosedDetails] attr_accessor :poll_closed_details # # Corresponds to the JSON property `pollEditedDetails` # @return [Google::Apis::YoutubeV3::LiveChatPollEditedDetails] attr_accessor :poll_edited_details # # Corresponds to the JSON property `pollOpenedDetails` # @return [Google::Apis::YoutubeV3::LiveChatPollOpenedDetails] attr_accessor :poll_opened_details # # Corresponds to the JSON property `pollVotedDetails` # @return [Google::Apis::YoutubeV3::LiveChatPollVotedDetails] attr_accessor :poll_voted_details # The date and time when the message was orignally published. The value is # specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `publishedAt` # @return [DateTime] attr_accessor :published_at # Details about the Super Chat event, this is only set if the type is ' # superChatEvent'. # Corresponds to the JSON property `superChatDetails` # @return [Google::Apis::YoutubeV3::LiveChatSuperChatDetails] attr_accessor :super_chat_details # Details about the text message, this is only set if the type is ' # textMessageEvent'. # Corresponds to the JSON property `textMessageDetails` # @return [Google::Apis::YoutubeV3::LiveChatTextMessageDetails] attr_accessor :text_message_details # The type of message, this will always be present, it determines the contents # of the message as well as which fields will be present. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # # Corresponds to the JSON property `userBannedDetails` # @return [Google::Apis::YoutubeV3::LiveChatUserBannedMessageDetails] attr_accessor :user_banned_details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @author_channel_id = args[:author_channel_id] if args.key?(:author_channel_id) @display_message = args[:display_message] if args.key?(:display_message) @fan_funding_event_details = args[:fan_funding_event_details] if args.key?(:fan_funding_event_details) @has_display_content = args[:has_display_content] if args.key?(:has_display_content) @live_chat_id = args[:live_chat_id] if args.key?(:live_chat_id) @message_deleted_details = args[:message_deleted_details] if args.key?(:message_deleted_details) @message_retracted_details = args[:message_retracted_details] if args.key?(:message_retracted_details) @poll_closed_details = args[:poll_closed_details] if args.key?(:poll_closed_details) @poll_edited_details = args[:poll_edited_details] if args.key?(:poll_edited_details) @poll_opened_details = args[:poll_opened_details] if args.key?(:poll_opened_details) @poll_voted_details = args[:poll_voted_details] if args.key?(:poll_voted_details) @published_at = args[:published_at] if args.key?(:published_at) @super_chat_details = args[:super_chat_details] if args.key?(:super_chat_details) @text_message_details = args[:text_message_details] if args.key?(:text_message_details) @type = args[:type] if args.key?(:type) @user_banned_details = args[:user_banned_details] if args.key?(:user_banned_details) end end # A liveChatModerator resource represents a moderator for a YouTube live chat. A # chat moderator has the ability to ban/unban users from a chat, remove message, # etc. class LiveChatModerator include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube assigns to uniquely identify the moderator. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # liveChatModerator". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The snippet object contains basic details about the moderator. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::LiveChatModeratorSnippet] attr_accessor :snippet def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) end end # class LiveChatModeratorListResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of moderators that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # liveChatModeratorListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # class LiveChatModeratorSnippet include Google::Apis::Core::Hashable # The ID of the live chat this moderator can act on. # Corresponds to the JSON property `liveChatId` # @return [String] attr_accessor :live_chat_id # Details about the moderator. # Corresponds to the JSON property `moderatorDetails` # @return [Google::Apis::YoutubeV3::ChannelProfileDetails] attr_accessor :moderator_details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @live_chat_id = args[:live_chat_id] if args.key?(:live_chat_id) @moderator_details = args[:moderator_details] if args.key?(:moderator_details) end end # class LiveChatPollClosedDetails include Google::Apis::Core::Hashable # The id of the poll that was closed. # Corresponds to the JSON property `pollId` # @return [String] attr_accessor :poll_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @poll_id = args[:poll_id] if args.key?(:poll_id) end end # class LiveChatPollEditedDetails include Google::Apis::Core::Hashable # # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # # Corresponds to the JSON property `prompt` # @return [String] attr_accessor :prompt 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) @prompt = args[:prompt] if args.key?(:prompt) end end # class LiveChatPollItem include Google::Apis::Core::Hashable # Plain text description of the item. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @item_id = args[:item_id] if args.key?(:item_id) end end # class LiveChatPollOpenedDetails include Google::Apis::Core::Hashable # # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # # Corresponds to the JSON property `prompt` # @return [String] attr_accessor :prompt 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) @prompt = args[:prompt] if args.key?(:prompt) end end # class LiveChatPollVotedDetails include Google::Apis::Core::Hashable # The poll item the user chose. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id # The poll the user voted on. # Corresponds to the JSON property `pollId` # @return [String] attr_accessor :poll_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @item_id = args[:item_id] if args.key?(:item_id) @poll_id = args[:poll_id] if args.key?(:poll_id) end end # class LiveChatSuperChatDetails include Google::Apis::Core::Hashable # A rendered string that displays the fund amount and currency to the user. # Corresponds to the JSON property `amountDisplayString` # @return [String] attr_accessor :amount_display_string # The amount purchased by the user, in micros (1,750,000 micros = 1.75). # Corresponds to the JSON property `amountMicros` # @return [Fixnum] attr_accessor :amount_micros # The currency in which the purchase was made. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency # The tier in which the amount belongs to. Lower amounts belong to lower tiers. # Starts at 1. # Corresponds to the JSON property `tier` # @return [Fixnum] attr_accessor :tier # The comment added by the user to this Super Chat event. # Corresponds to the JSON property `userComment` # @return [String] attr_accessor :user_comment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @amount_display_string = args[:amount_display_string] if args.key?(:amount_display_string) @amount_micros = args[:amount_micros] if args.key?(:amount_micros) @currency = args[:currency] if args.key?(:currency) @tier = args[:tier] if args.key?(:tier) @user_comment = args[:user_comment] if args.key?(:user_comment) end end # class LiveChatTextMessageDetails include Google::Apis::Core::Hashable # The user's message. # Corresponds to the JSON property `messageText` # @return [String] attr_accessor :message_text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @message_text = args[:message_text] if args.key?(:message_text) end end # class LiveChatUserBannedMessageDetails include Google::Apis::Core::Hashable # The duration of the ban. This property is only present if the banType is # temporary. # Corresponds to the JSON property `banDurationSeconds` # @return [Fixnum] attr_accessor :ban_duration_seconds # The type of ban. # Corresponds to the JSON property `banType` # @return [String] attr_accessor :ban_type # The details of the user that was banned. # Corresponds to the JSON property `bannedUserDetails` # @return [Google::Apis::YoutubeV3::ChannelProfileDetails] attr_accessor :banned_user_details def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ban_duration_seconds = args[:ban_duration_seconds] if args.key?(:ban_duration_seconds) @ban_type = args[:ban_type] if args.key?(:ban_type) @banned_user_details = args[:banned_user_details] if args.key?(:banned_user_details) end end # A live stream describes a live ingestion point. class LiveStream include Google::Apis::Core::Hashable # Brief description of the live stream cdn settings. # Corresponds to the JSON property `cdn` # @return [Google::Apis::YoutubeV3::CdnSettings] attr_accessor :cdn # Detailed settings of a stream. # Corresponds to the JSON property `contentDetails` # @return [Google::Apis::YoutubeV3::LiveStreamContentDetails] attr_accessor :content_details # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube assigns to uniquely identify the stream. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # liveStream". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The snippet object contains basic details about the stream, including its # channel, title, and description. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::LiveStreamSnippet] attr_accessor :snippet # Brief description of the live stream status. # Corresponds to the JSON property `status` # @return [Google::Apis::YoutubeV3::LiveStreamStatus] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cdn = args[:cdn] if args.key?(:cdn) @content_details = args[:content_details] if args.key?(:content_details) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) @status = args[:status] if args.key?(:status) end end # class LiveStreamConfigurationIssue include Google::Apis::Core::Hashable # The long-form description of the issue and how to resolve it. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The short-form reason for this issue. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # How severe this issue is to the stream. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity # The kind of error happening. # 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) @description = args[:description] if args.key?(:description) @reason = args[:reason] if args.key?(:reason) @severity = args[:severity] if args.key?(:severity) @type = args[:type] if args.key?(:type) end end # Detailed settings of a stream. class LiveStreamContentDetails include Google::Apis::Core::Hashable # The ingestion URL where the closed captions of this stream are sent. # Corresponds to the JSON property `closedCaptionsIngestionUrl` # @return [String] attr_accessor :closed_captions_ingestion_url # Indicates whether the stream is reusable, which means that it can be bound to # multiple broadcasts. It is common for broadcasters to reuse the same stream # for many different broadcasts if those broadcasts occur at different times. # If you set this value to false, then the stream will not be reusable, which # means that it can only be bound to one broadcast. Non-reusable streams differ # from reusable streams in the following ways: # - A non-reusable stream can only be bound to one broadcast. # - A non-reusable stream might be deleted by an automated process after the # broadcast ends. # - The liveStreams.list method does not list non-reusable streams if you call # the method and set the mine parameter to true. The only way to use that method # to retrieve the resource for a non-reusable stream is to use the id parameter # to identify the stream. # Corresponds to the JSON property `isReusable` # @return [Boolean] attr_accessor :is_reusable alias_method :is_reusable?, :is_reusable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @closed_captions_ingestion_url = args[:closed_captions_ingestion_url] if args.key?(:closed_captions_ingestion_url) @is_reusable = args[:is_reusable] if args.key?(:is_reusable) end end # class LiveStreamHealthStatus include Google::Apis::Core::Hashable # The configurations issues on this stream # Corresponds to the JSON property `configurationIssues` # @return [Array] attr_accessor :configuration_issues # The last time this status was updated (in seconds) # Corresponds to the JSON property `lastUpdateTimeSeconds` # @return [Fixnum] attr_accessor :last_update_time_seconds # The status code of this stream # 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) @configuration_issues = args[:configuration_issues] if args.key?(:configuration_issues) @last_update_time_seconds = args[:last_update_time_seconds] if args.key?(:last_update_time_seconds) @status = args[:status] if args.key?(:status) end end # class ListLiveStreamsResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of live streams that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # liveStreamListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # class LiveStreamSnippet include Google::Apis::Core::Hashable # The ID that YouTube uses to uniquely identify the channel that is transmitting # the stream. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # The stream's description. The value cannot be longer than 10000 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # # Corresponds to the JSON property `isDefaultStream` # @return [Boolean] attr_accessor :is_default_stream alias_method :is_default_stream?, :is_default_stream # The date and time that the stream was created. The value is specified in ISO # 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `publishedAt` # @return [DateTime] attr_accessor :published_at # The stream's title. The value must be between 1 and 128 characters long. # 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) @channel_id = args[:channel_id] if args.key?(:channel_id) @description = args[:description] if args.key?(:description) @is_default_stream = args[:is_default_stream] if args.key?(:is_default_stream) @published_at = args[:published_at] if args.key?(:published_at) @title = args[:title] if args.key?(:title) end end # Brief description of the live stream status. class LiveStreamStatus include Google::Apis::Core::Hashable # The health status of the stream. # Corresponds to the JSON property `healthStatus` # @return [Google::Apis::YoutubeV3::LiveStreamHealthStatus] attr_accessor :health_status # # Corresponds to the JSON property `streamStatus` # @return [String] attr_accessor :stream_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @health_status = args[:health_status] if args.key?(:health_status) @stream_status = args[:stream_status] if args.key?(:stream_status) end end # class LocalizedProperty include Google::Apis::Core::Hashable # # Corresponds to the JSON property `default` # @return [String] attr_accessor :default # The language of the default property. # Corresponds to the JSON property `defaultLanguage` # @return [Google::Apis::YoutubeV3::LanguageTag] attr_accessor :default_language # # Corresponds to the JSON property `localized` # @return [Array] attr_accessor :localized def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default = args[:default] if args.key?(:default) @default_language = args[:default_language] if args.key?(:default_language) @localized = args[:localized] if args.key?(:localized) end end # class LocalizedString include Google::Apis::Core::Hashable # # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # # 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) @language = args[:language] if args.key?(:language) @value = args[:value] if args.key?(:value) end end # Settings and Info of the monitor stream class MonitorStreamInfo include Google::Apis::Core::Hashable # If you have set the enableMonitorStream property to true, then this property # determines the length of the live broadcast delay. # Corresponds to the JSON property `broadcastStreamDelayMs` # @return [Fixnum] attr_accessor :broadcast_stream_delay_ms # HTML code that embeds a player that plays the monitor stream. # Corresponds to the JSON property `embedHtml` # @return [String] attr_accessor :embed_html # This value determines whether the monitor stream is enabled for the broadcast. # If the monitor stream is enabled, then YouTube will broadcast the event # content on a special stream intended only for the broadcaster's consumption. # The broadcaster can use the stream to review the event content and also to # identify the optimal times to insert cuepoints. # You need to set this value to true if you intend to have a broadcast delay for # your event. # Note: This property cannot be updated once the broadcast is in the testing or # live state. # Corresponds to the JSON property `enableMonitorStream` # @return [Boolean] attr_accessor :enable_monitor_stream alias_method :enable_monitor_stream?, :enable_monitor_stream def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @broadcast_stream_delay_ms = args[:broadcast_stream_delay_ms] if args.key?(:broadcast_stream_delay_ms) @embed_html = args[:embed_html] if args.key?(:embed_html) @enable_monitor_stream = args[:enable_monitor_stream] if args.key?(:enable_monitor_stream) end end # Nonprofit information. class Nonprofit include Google::Apis::Core::Hashable # Id of the nonprofit. # Corresponds to the JSON property `nonprofitId` # @return [Google::Apis::YoutubeV3::NonprofitId] attr_accessor :nonprofit_id # Legal name of the nonprofit. # Corresponds to the JSON property `nonprofitLegalName` # @return [String] attr_accessor :nonprofit_legal_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @nonprofit_id = args[:nonprofit_id] if args.key?(:nonprofit_id) @nonprofit_legal_name = args[:nonprofit_legal_name] if args.key?(:nonprofit_legal_name) end end # class NonprofitId include Google::Apis::Core::Hashable # # 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 # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. class PageInfo include Google::Apis::Core::Hashable # The number of results included in the API response. # Corresponds to the JSON property `resultsPerPage` # @return [Fixnum] attr_accessor :results_per_page # The total number of results in the result set. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @results_per_page = args[:results_per_page] if args.key?(:results_per_page) @total_results = args[:total_results] if args.key?(:total_results) end end # A playlist resource represents a YouTube playlist. A playlist is a collection # of videos that can be viewed sequentially and shared with other users. A # playlist can contain up to 200 videos, and YouTube does not limit the number # of playlists that each user creates. By default, playlists are publicly # visible to other users, but playlists can be public or private. # YouTube also uses playlists to identify special collections of videos for a # channel, such as: # - uploaded videos # - favorite videos # - positively rated (liked) videos # - watch history # - watch later To be more specific, these lists are associated with a channel, # which is a collection of a person, group, or company's videos, playlists, and # other YouTube information. You can retrieve the playlist IDs for each of these # lists from the channel resource for a given channel. # You can then use the playlistItems.list method to retrieve any of those # lists. You can also add or remove items from those lists by calling the # playlistItems.insert and playlistItems.delete methods. class Playlist include Google::Apis::Core::Hashable # The contentDetails object contains information like video count. # Corresponds to the JSON property `contentDetails` # @return [Google::Apis::YoutubeV3::PlaylistContentDetails] attr_accessor :content_details # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the playlist. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # playlist". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Localizations for different languages # Corresponds to the JSON property `localizations` # @return [Hash] attr_accessor :localizations # The player object contains information that you would use to play the playlist # in an embedded player. # Corresponds to the JSON property `player` # @return [Google::Apis::YoutubeV3::PlaylistPlayer] attr_accessor :player # Basic details about a playlist, including title, description and thumbnails. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::PlaylistSnippet] attr_accessor :snippet # The status object contains status information for the playlist. # Corresponds to the JSON property `status` # @return [Google::Apis::YoutubeV3::PlaylistStatus] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_details = args[:content_details] if args.key?(:content_details) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @localizations = args[:localizations] if args.key?(:localizations) @player = args[:player] if args.key?(:player) @snippet = args[:snippet] if args.key?(:snippet) @status = args[:status] if args.key?(:status) end end # class PlaylistContentDetails include Google::Apis::Core::Hashable # The number of videos in the playlist. # Corresponds to the JSON property `itemCount` # @return [Fixnum] attr_accessor :item_count def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @item_count = args[:item_count] if args.key?(:item_count) end end # A playlistItem resource identifies another resource, such as a video, that is # included in a playlist. In addition, the playlistItem resource contains # details about the included resource that pertain specifically to how that # resource is used in that playlist. # YouTube uses playlists to identify special collections of videos for a channel, # such as: # - uploaded videos # - favorite videos # - positively rated (liked) videos # - watch history # - watch later To be more specific, these lists are associated with a channel, # which is a collection of a person, group, or company's videos, playlists, and # other YouTube information. # You can retrieve the playlist IDs for each of these lists from the channel # resource for a given channel. You can then use the playlistItems.list # method to retrieve any of those lists. You can also add or remove items from # those lists by calling the playlistItems.insert and playlistItems.delete # methods. For example, if a user gives a positive rating to a video, you would # insert that video into the liked videos playlist for that user's channel. class PlaylistItem include Google::Apis::Core::Hashable # The contentDetails object is included in the resource if the included item is # a YouTube video. The object contains additional information about the video. # Corresponds to the JSON property `contentDetails` # @return [Google::Apis::YoutubeV3::PlaylistItemContentDetails] attr_accessor :content_details # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The ID that YouTube uses to uniquely identify the playlist item. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies what kind of resource this is. Value: the fixed string "youtube# # playlistItem". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Basic details about a playlist, including title, description and thumbnails. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::PlaylistItemSnippet] attr_accessor :snippet # Information about the playlist item's privacy status. # Corresponds to the JSON property `status` # @return [Google::Apis::YoutubeV3::PlaylistItemStatus] attr_accessor :status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_details = args[:content_details] if args.key?(:content_details) @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @snippet = args[:snippet] if args.key?(:snippet) @status = args[:status] if args.key?(:status) end end # class PlaylistItemContentDetails include Google::Apis::Core::Hashable # The time, measured in seconds from the start of the video, when the video # should stop playing. (The playlist owner can specify the times when the video # should start and stop playing when the video is played in the context of the # playlist.) By default, assume that the video.endTime is the end of the video. # Corresponds to the JSON property `endAt` # @return [String] attr_accessor :end_at # A user-generated note for this item. # Corresponds to the JSON property `note` # @return [String] attr_accessor :note # The time, measured in seconds from the start of the video, when the video # should start playing. (The playlist owner can specify the times when the video # should start and stop playing when the video is played in the context of the # playlist.) The default value is 0. # Corresponds to the JSON property `startAt` # @return [String] attr_accessor :start_at # The ID that YouTube uses to uniquely identify a video. To retrieve the video # resource, set the id query parameter to this value in your API request. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id # The date and time that the video was published to YouTube. The value is # specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `videoPublishedAt` # @return [DateTime] attr_accessor :video_published_at def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_at = args[:end_at] if args.key?(:end_at) @note = args[:note] if args.key?(:note) @start_at = args[:start_at] if args.key?(:start_at) @video_id = args[:video_id] if args.key?(:video_id) @video_published_at = args[:video_published_at] if args.key?(:video_published_at) end end # class ListPlaylistItemsResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of playlist items that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # playlistItemListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # Basic details about a playlist, including title, description and thumbnails. class PlaylistItemSnippet include Google::Apis::Core::Hashable # The ID that YouTube uses to uniquely identify the user that added the item to # the playlist. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id # Channel title for the channel that the playlist item belongs to. # Corresponds to the JSON property `channelTitle` # @return [String] attr_accessor :channel_title # The item's description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The ID that YouTube uses to uniquely identify the playlist that the playlist # item is in. # Corresponds to the JSON property `playlistId` # @return [String] attr_accessor :playlist_id # The order in which the item appears in the playlist. The value uses a zero- # based index, so the first item has a position of 0, the second item has a # position of 1, and so forth. # Corresponds to the JSON property `position` # @return [Fixnum] attr_accessor :position # The date and time that the item was added to the playlist. The value is # specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `publishedAt` # @return [DateTime] attr_accessor :published_at # A resource id is a generic reference that points to another YouTube resource. # Corresponds to the JSON property `resourceId` # @return [Google::Apis::YoutubeV3::ResourceId] attr_accessor :resource_id # Internal representation of thumbnails for a YouTube resource. # Corresponds to the JSON property `thumbnails` # @return [Google::Apis::YoutubeV3::ThumbnailDetails] attr_accessor :thumbnails # The item's title. # 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) @channel_id = args[:channel_id] if args.key?(:channel_id) @channel_title = args[:channel_title] if args.key?(:channel_title) @description = args[:description] if args.key?(:description) @playlist_id = args[:playlist_id] if args.key?(:playlist_id) @position = args[:position] if args.key?(:position) @published_at = args[:published_at] if args.key?(:published_at) @resource_id = args[:resource_id] if args.key?(:resource_id) @thumbnails = args[:thumbnails] if args.key?(:thumbnails) @title = args[:title] if args.key?(:title) end end # Information about the playlist item's privacy status. class PlaylistItemStatus include Google::Apis::Core::Hashable # This resource's privacy status. # Corresponds to the JSON property `privacyStatus` # @return [String] attr_accessor :privacy_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @privacy_status = args[:privacy_status] if args.key?(:privacy_status) end end # class ListPlaylistResponse include Google::Apis::Core::Hashable # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Serialized EventId of the request which produced this response. # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # A list of playlists that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Identifies what kind of resource this is. Value: the fixed string "youtube# # playlistListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The token that can be used as the value of the pageToken parameter to retrieve # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # Paging details for lists of resources, including total number of items # available and number of resources returned in a single page. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info # The token that can be used as the value of the pageToken parameter to retrieve # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token # Stub token pagination template to suppress results. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @etag = args[:etag] if args.key?(:etag) @event_id = args[:event_id] if args.key?(:event_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) @page_info = args[:page_info] if args.key?(:page_info) @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @visitor_id = args[:visitor_id] if args.key?(:visitor_id) end end # Playlist localization setting class PlaylistLocalization include Google::Apis::Core::Hashable # The localized strings for playlist's description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The localized strings for playlist's title. # 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 PlaylistPlayer include Google::Apis::Core::Hashable # An